From da4a3fc3f8b068e4abe08237b3d11124c6560e3b Mon Sep 17 00:00:00 2001 From: Mykola Mokhnach Date: Thu, 12 Sep 2024 14:30:04 +0200 Subject: [PATCH 1/5] docs: Document supported BiDi entities --- docs/reference/bidi.md | 45 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 docs/reference/bidi.md diff --git a/docs/reference/bidi.md b/docs/reference/bidi.md new file mode 100644 index 000000000..4505a63af --- /dev/null +++ b/docs/reference/bidi.md @@ -0,0 +1,45 @@ +--- +title: BiDi Protocol Support +--- + +XCUITest driver had partial support of the [BiDi Protocol](https://w3c.github.io/webdriver-bidi/) since version 7.26.0. Only events and commands mentioned below are supported. All other entities described in the spec throw not implemented errors. + +# Supported Events + +## log.entryAdded + +This event is emitted if the driver retrieves a new entry for any of the below log types. Logs collection might be disabled by the `appium:skipLogCapture` capability. + +### crashlog + +Events are emitted for both emulator and real devices. The latter only works if [py-ios-device](hhttps://github.com/YueChen-C/py-ios-device) is installed on the server host. Each event contains a particular device crash report entry. +Events are always emitted with the `NATIVE_APP` context. + +### syslog + +Events are emitted for both emulator and real devices. Each event contains a single device system log line. +Events are always emitted with the `NATIVE_APP` context. + +### safariConsole + +Events are emitted for both emulator and real devices. Each event contains a single safari console log line. +Events are always emitted with the appropriate web context name from which they were generated. +Events are only emitted if the `appium:showSafariConsoleLog` capability value is provided. + +### safariNetwork + +Events are emitted for both emulator and real devices. Each event contains a single safari network log line. +Events are always emitted with the appropriate web context name from which they were generated. +Events are only emitted if the `appium:showSafariNetworkLog` capability value is provided. + +### performance + +Events are emitted for both emulator and real devices. Each event contains a single safari performance log line. +Events are always emitted with the appropriate web context name from which they were generated. +Events are only emitted if the `appium:enablePerformanceLogging` capability value is provided. + +### server + +Events are emitted for both emulator and real devices. Each event contains a single Appium server log line. +Events are always emitted with the `NATIVE_APP` context. +Events are only emitted if the `get_server_logs` server security feature is enabled. From b25c67b95ebd6250f64d8d03f552ec6a5942e680 Mon Sep 17 00:00:00 2001 From: Mykola Mokhnach Date: Thu, 12 Sep 2024 14:32:18 +0200 Subject: [PATCH 2/5] Add TOC --- mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs.yml b/mkdocs.yml index 54731fc30..b10b0a140 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -40,6 +40,7 @@ nav: - preparation/prov-profile-generic-manual.md - Reference: - reference/scripts.md + - reference/bidi.md - Server Configuration: - reference/server-args.md - reference/security-flags.md From 4b00f7563b6f415563601b40430658e6aa77b675 Mon Sep 17 00:00:00 2001 From: Mykola Mokhnach Date: Thu, 12 Sep 2024 14:33:03 +0200 Subject: [PATCH 3/5] moar --- docs/reference/bidi.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/reference/bidi.md b/docs/reference/bidi.md index 4505a63af..727ea16c6 100644 --- a/docs/reference/bidi.md +++ b/docs/reference/bidi.md @@ -2,7 +2,9 @@ title: BiDi Protocol Support --- -XCUITest driver had partial support of the [BiDi Protocol](https://w3c.github.io/webdriver-bidi/) since version 7.26.0. Only events and commands mentioned below are supported. All other entities described in the spec throw not implemented errors. +XCUITest driver had partial support of the [BiDi Protocol](https://w3c.github.io/webdriver-bidi/) since version 7.26.0. +Only events and commands mentioned below are supported. +All other entities described in the spec throw not implemented errors. # Supported Events From 2894f208b4720042348b0922bc2b097e692f4588 Mon Sep 17 00:00:00 2001 From: Mykola Mokhnach Date: Thu, 12 Sep 2024 14:46:04 +0200 Subject: [PATCH 4/5] typo --- docs/reference/bidi.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/bidi.md b/docs/reference/bidi.md index 727ea16c6..5bd0e2c19 100644 --- a/docs/reference/bidi.md +++ b/docs/reference/bidi.md @@ -2,7 +2,7 @@ title: BiDi Protocol Support --- -XCUITest driver had partial support of the [BiDi Protocol](https://w3c.github.io/webdriver-bidi/) since version 7.26.0. +XCUITest driver has partial support of the [BiDi Protocol](https://w3c.github.io/webdriver-bidi/) since version 7.26.0. Only events and commands mentioned below are supported. All other entities described in the spec throw not implemented errors. From 312a49ff69fb3d208ca4ed369a979c670194ec51 Mon Sep 17 00:00:00 2001 From: Mykola Mokhnach Date: Thu, 12 Sep 2024 19:24:36 +0200 Subject: [PATCH 5/5] fix docs --- docs/reference/bidi.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/reference/bidi.md b/docs/reference/bidi.md index 5bd0e2c19..dbfd76915 100644 --- a/docs/reference/bidi.md +++ b/docs/reference/bidi.md @@ -14,7 +14,7 @@ This event is emitted if the driver retrieves a new entry for any of the below l ### crashlog -Events are emitted for both emulator and real devices. The latter only works if [py-ios-device](hhttps://github.com/YueChen-C/py-ios-device) is installed on the server host. Each event contains a particular device crash report entry. +Events are emitted for both emulator and real devices. The latter only works if [py-ios-device](https://github.com/YueChen-C/py-ios-device) is installed on the server host. Each event contains a particular device crash report entry. Events are always emitted with the `NATIVE_APP` context. ### syslog @@ -24,19 +24,19 @@ Events are always emitted with the `NATIVE_APP` context. ### safariConsole -Events are emitted for both emulator and real devices. Each event contains a single safari console log line. +Events are emitted for both emulator and real devices. Each event contains a single Safari console log line. Events are always emitted with the appropriate web context name from which they were generated. Events are only emitted if the `appium:showSafariConsoleLog` capability value is provided. ### safariNetwork -Events are emitted for both emulator and real devices. Each event contains a single safari network log line. +Events are emitted for both emulator and real devices. Each event contains a single Safari network log line. Events are always emitted with the appropriate web context name from which they were generated. Events are only emitted if the `appium:showSafariNetworkLog` capability value is provided. ### performance -Events are emitted for both emulator and real devices. Each event contains a single safari performance log line. +Events are emitted for both emulator and real devices. Each event contains a single Safari performance log line. Events are always emitted with the appropriate web context name from which they were generated. Events are only emitted if the `appium:enablePerformanceLogging` capability value is provided.