#appium #mac2-driver #macos #ui-automation #screen-recording

[tgz0514]

"When using Mac2 driver with Appium for Mac UI automation testing, there's a notification banner showing 'Automation Test Running' on the screen. This banner interferes with screen recording quality. Is there a way to disable or hide this notification banner during test execution?"

[mykola-mokhnach]

I don't think it is possible to disable that banner as this is Apple's own security feature.
How do you record the screen during the test?

[Zz-vvi]

I don't think it is possible to disable that banner as this is Apple's own security feature. How do you record the screen during the test?

ffmpeg / quicktimeplayer / screencapture

[mykola-mokhnach]

I've created another PR to enable screen recording over native APIs provided by XCTest itself. I believe screen recordings made via these APIs should not show the annoying overlay

[tgz0514]

I've created another PR to enable screen recording over native APIs provided by XCTest itself. I believe screen recordings made via these APIs should not show the annoying overlay

Thank you for creating the PR for screen recording improvement. Having recordings without overlay would definitely enhance the user experience. Looking forward to trying out this native XCTest-based solution.

[mykola-mokhnach]

The PR has been merged and published in the driver version 2.1.0

[tgz0514]

The PR has been merged and published in the driver version 2.1.0
I used it as described, but it gave an error. Why?

driver.execute_script('macos: listDisplays')
{'1': {'id': 1, 'isMain': True}, '2': {'id': 2, 'isMain': False}, '3': {'id': 3, 'isMain': False}}

driver.execute_script('macos: startNativeScreenRecording',{'displayId':1})
{'uuid': 'DBF9B67F-7180-441A-B45C-CD6CB18C96CD', 'startedAt': 1738988129.5143409, 'fps': 24, 'codec': 0, 'displayId': 1}

driver.execute_script('macos: getNativeScreenRecordingInfo')
{'uuid': 'DBF9B67F-7180-441A-B45C-CD6CB18C96CD', 'startedAt': 1738988129.5143409, 'fps': 24, 'codec': 0, 'displayId': 1}

driver.execute_script('macos: stopNativeScreenRecording')
selenium.common.exceptions.WebDriverException: Message: An unknown server-side error occurred while processing the command. Original error: The screen recording identified by DBF9B67F-7180-441A-B45C-CD6CB18C96CD has not been found. Is it accessible?
Stacktrace:
UnknownError: An unknown server-side error occurred while processing the command. Original error: The screen recording identified by DBF9B67F-7180-441A-B45C-CD6CB18C96CD has not been found. Is it accessible?
at getResponseForW3CError (/opt/homebrew/lib/node_modules/appium/node_modules/@appium/base-driver/lib/protocol/errors.js:1145:9)
at asyncHandler (/opt/homebrew/lib/node_modules/appium/node_modules/@appium/base-driver/lib/protocol/protocol.js:485:57)

I hope to add a parameter to save the recorded video directly to a location that can be specified by the test machine, such as /tmp/xx.mp4

[tgz0514]

2025-02-08 12:16:11:629 - [154d3af1][Mac2Driver@5d3b] Encountered internal error running command: Error: The screen recording identified by DBF9B67F-7180-441A-B45C-CD6CB18C96CD has not been found. Is it accessible?
at Mac2Driver.macosStopNativeScreenRecording (.appium/node_modules/appium-mac2-driver/lib/commands/native-record-screen.ts:97:11
at Mac2Driver.executeMethod (/opt/homebrew/lib/node_modules/appium/node_modules/@appium/base-driver/lib/basedriver/commands/execute.ts:36:12)
at Mac2Driver.execute (.appium/node_modules/appium-mac2-driver/lib/commands/execute.js:16:10)
2025-02-08 12:16:11:630 - [154d3af1][HTTP] <-- POST /session/154d3af1-3eea-4475-8f23-1cad58269d9d/execute/sync 500 157 ms - 724

[mykola-mokhnach]

How do you execute your appium server? If from Terminal then make sure it has the "Full Disk Access" permission enabled in System Preferences -> Privacy & Security tab

[mykola-mokhnach]

Also make sure the appropriate screen recording is present on the local file system by executing the following command: find "$HOME/Library/Daemon Containers/" -type f -name "DBF9B67F-7180-441A-B45C-CD6CB18C96CD"

[mykola-mokhnach]

I've added an explicit comment about this requirement to the docs and improved the exception message: #331

[tgz0514]

How do you execute your appium server? If from Terminal then make sure it has the "Full Disk Access" permission enabled in System Preferences -> Privacy & Security tab

It is true.

However, after calling stopNativeScreenRecording, calling startNativeScreenRecording again will result in an error,getNativeScreenRecordingInfo return none.

UnknownError: An unknown server-side error occurred while processing the command. Original error: Error Domain=XCTDaemon.ScreenRecordingError Code=0 "Already recording, there can only be one screen recording at a time." UserInfo={NSLocalizedFailure=Failed to start screen recording., NSLocalizedFailureReason=Already recording, there can only be one screen recording at a time., NSLocalizedRecoverySuggestion=Stop the currently active screen recording first and try again.}
at errorFromW3CJsonCode (/opt/homebrew/lib/node_modules/appium/node_modules/@appium/base-driver/lib/protocol/errors.js:1112:25)
at ProxyRequestError.getActualError (/opt/homebrew/lib/node_modules/appium/node_modules/@appium/base-driver/lib/protocol/errors.js:981:14)
at WDAMacProxy.command (/opt/homebrew/lib/node_modules/appium/node_modules/@appium/base-driver/lib/jsonwp-proxy/proxy.js:348:19)
at processTicksAndRejections (node:internal/process/task_queues:95:5)
at Mac2Driver.macosStartNativeScreenRecording (/Users/tangguangzhe/.appium/node_modules/appium-mac2-driver/lib/commands/native-record-screen.ts:29:18)
at Mac2Driver.executeMethod (/opt/homebrew/lib/node_modules/appium/node_modules/@appium/base-driver/lib/basedriver/commands/execute.ts:36:12)
at Mac2Driver.execute (.appium/node_modules/appium-mac2-driver/lib/commands/execute.js:16:10)

➜ Daemon Containers ls
01B799CB-97FA-4167-960D-BEB3C35164C6 A06A5FE3-DD9C-4F90-81E3-1BD3FBB1132C
4AEC0CD8-C56A-485E-AA9B-67B4AE983F5F DB8DE649-00FD-49CE-B6E9-37EFB5E4FCFB
6D67C033-2E42-454D-8249-40AD9B60EE9A F1C1D5EF-E325-4F88-87B4-DA651B7E6631
7E1F2934-56B6-4573-8866-FCEF5B4DA679 FC972D55-D5D0-4081-9EA7-1ADA396A8A12

➜ Daemon Containers rm -rf *

startNativeScreenRecording
UnknownError: An unknown server-side error occurred while processing the command. Original error: Error Domain=XCTDaemon.ScreenRecordingError Code=7 "Failed to write file." UserInfo={NSLocalizedFailure=Failed to start screen recording., NSLocalizedFailureReason=Failed to write file., NSLocalizedRecoverySuggestion=Make sure there's enough space on the device.}
The device has sufficient disk space

[mykola-mokhnach]

startNativeScreenRecording

UnknownError: An unknown server-side error occurred while processing the command. Original error: Error Domain=XCTDaemon.ScreenRecordingError Code=7 "Failed to write file." UserInfo={NSLocalizedFailure=Failed to start screen recording., NSLocalizedFailureReason=Failed to write file., NSLocalizedRecoverySuggestion=Make sure there's enough space on the device.}
The device has sufficient disk space

This might be a valid error. Recorded videos are usually quite large and need lots of space, so be careful about the amount of space left on the home partition

[mykola-mokhnach]

UnknownError: An unknown server-side error occurred while processing the command. Original error: Error Domain=XCTDaemon.ScreenRecordingError Code=0 "Already recording, there can only be one screen recording at a time." UserInfo={NSLocalizedFailure=Failed to start screen recording., NSLocalizedFailureReason=Already recording, there can only be one screen recording at a time., NSLocalizedRecoverySuggestion=Stop the currently active screen recording first and try again.}

Please provide a proper issue report for this one including the full server log and the client code example which reproduces it.

[tgz0514]

UnknownError: An unknown server-side error occurred while processing the command. Original error: Error Domain=XCTDaemon.ScreenRecordingError Code=0 "Already recording, there can only be one screen recording at a time." UserInfo={NSLocalizedFailure=Failed to start screen recording., NSLocalizedFailureReason=Already recording, there can only be one screen recording at a time., NSLocalizedRecoverySuggestion=Stop the currently active screen recording first and try again.}

Please provide a proper issue report for this one including the full server log and the client code example which reproduces it.

Description

After completing one full recording cycle (start -> get info -> stop), attempting to start a new recording fails.

Steps to Reproduce

1. Call startNativeScreenRecording ✅ (Success)
2. Call getNativeScreenRecordingInfo ✅ (Success)
3. Call stopNativeScreenRecording ✅ (Success)
4. Call startNativeScreenRecording again ❌ (Fails)

code
`from appium import webdriver
from appium.options.common.base import AppiumOptions

options = AppiumOptions()
options.load_capabilities({
"platformName": "mac",
"appium:automationName": "mac2",
"appium:newCommandTimeout": 3600,
"appium:connectHardwareKeyboard": True
})

driver = webdriver.Remote('http://10.93.1.112:4723', options=options)

driver.execute_script('macos: startNativeScreenRecording')
driver.execute_script('macos: getNativeScreenRecordingInfo')
b_64 = driver.execute_script('macos: stopNativeScreenRecording')

driver.execute_script('macos: startNativeScreenRecording')`

appium server log

2025-02-08 19:25:46:595 - [b47a027a][HTTP] <-- POST /session/b47a027a-c14a-4fde-9991-6a457e4dfa9d/execute/sync 200 402 ms - 14168772
2025-02-08 19:35:15:770 - [b47a027a][HTTP] --> POST /session/b47a027a-c14a-4fde-9991-6a457e4dfa9d/execute/sync {"script":"macos: startNativeScreenRecording","args":[]}
2025-02-08 19:35:15:774 - [b47a027a][Mac2Driver@5eb1] Calling AppiumDriver.execute() with args: ["macos: startNativeScreenRecording",[],"b47a027a-c14a-4fde-9991-6a457e4dfa9d"]
2025-02-08 19:35:15:775 - [b47a027a][Mac2Driver@5eb1] Executing extension command 'macos: startNativeScreenRecording'
2025-02-08 19:35:15:797 - [b47a027a][WD Proxy] Proxying [POST /wda/video/start] to [POST http://127.0.0.1:10100/session/37DFABE5-D219-4162-BEBB-28846F749035/wda/video/start] with body: {}
2025-02-08 19:35:15:924 - [b47a027a][WD Proxy] Got response with status 500: {"value":{"error":"unknown error","message":"Error Domain=XCTDaemon.ScreenRecordingError Code=0 "Already recording, there can only be one screen recording at a time." UserInfo={NSLocalizedFailure=Failed to start screen recording., NSLocalizedFailureReason=Already recording, there can only be one screen recording at a time., NSLocalizedRecoverySuggestion=Stop the currently active screen recording first and try again.}","traceback":""},"sessionId":"37DFABE5-D219-4162-BEBB-28846F749035"}
2025-02-08 19:35:15:925 - [b47a027a][W3C] Matched W3C error code 'unknown error' to UnknownError
2025-02-08 19:35:15:935 - [b47a027a][Mac2Driver@5eb1] Encountered internal error running command: UnknownError: An unknown server-side error occurred while processing the command. Original error: Error Domain=XCTDaemon.ScreenRecordingError Code=0 "Already recording, there can only be one screen recording at a time." UserInfo={NSLocalizedFailure=Failed to start screen recording., NSLocalizedFailureReason=Already recording, there can only be one screen recording at a time., NSLocalizedRecoverySuggestion=Stop the currently active screen recording first and try again.}
at errorFromW3CJsonCode (/opt/homebrew/lib/node_modules/appium/node_modules/@appium/base-driver/lib/protocol/errors.js:1112:25)
at ProxyRequestError.getActualError (/opt/homebrew/lib/node_modules/appium/node_modules/@appium/base-driver/lib/protocol/errors.js:981:14)
at WDAMacProxy.command (/opt/homebrew/lib/node_modules/appium/node_modules/@appium/base-driver/lib/jsonwp-proxy/proxy.js:348:19)
at processTicksAndRejections (node:internal/process/task_queues:95:5)
at Mac2Driver.macosStartNativeScreenRecording (/Users/tangguangzhe/.appium/node_modules/appium-mac2-driver/lib/commands/native-record-screen.ts:29:18)
at Mac2Driver.executeMethod (/opt/homebrew/lib/node_modules/appium/node_modules/@appium/base-driver/lib/basedriver/commands/execute.ts:36:12)
at Mac2Driver.execute (.appium/node_modules/appium-mac2-driver/lib/commands/execute.js:16:10)
2025-02-08 19:35:15:938 - [b47a027a][HTTP] <-- POST /session/b47a027a-c14a-4fde-9991-6a457e4dfa9d/execute/sync 500 170 ms - 1908

[mykola-mokhnach]

Unfortunately I cannot reproduce the above issue locally. Please provide the full log, including the output of the previous stopNativeScreenRecording method output. Also enable xcodebuild output in capabilities (showServerLogs: true)