fix: assign deeply cloned processArguments for starting a WDA session

[mwakizaka]

I observed the following appium server log which appium-xcuitest-driver pushes language and locale arguments when retrying /session api call to WDA.

07:24:34:138 d �[38;5;64m[XCUITestDriver@68b6 (5cc2d54a)]�[0m Sending createSession command to WDA
07:24:34:139 d �[38;5;64m[XCUITestDriver@68b6 (5cc2d54a)]�[0m Matched '/session' to command name 'createSession'
07:24:34:140 d �[38;5;64m[XCUITestDriver@68b6 (5cc2d54a)]�[0m Proxying [POST /session] to [POST http://127.0.0.1:50201/session] with body: {"capabilities":{"firstMatch":[{"bundleId":"com.trident-qa.ScrollSleuth","arguments":["-AppleLanguages","(en)","-NSLanguages","(en)","-AppleLocale","en_US"],"environment":{},"eventloopIdleDelaySec":0,"shouldWaitForQuiescence":true,"shouldUseTestManagerForVisibilityDetection":false,"maxTypingFrequency":60,"shouldUseSingletonTestManager":true,"shouldTerminateApp":true,"forceAppLaunch":true,"useNativeCachingStrategy":true,"forceSimulatorSoftwareKeyboardPresence":true}],"alwaysMatch":{}}}
07:24:34:592 i �[38;5;64m[XCUITestDriver@68b6 (5cc2d54a)]�[0m socket hang up
07:24:34:910 d �[38;5;64m[XCUITestDriver@68b6 (5cc2d54a)]�[0m Failed to create WDA session (An unknown server-side error occurred while processing the command. Original error: Could not proxy command to the remote server. Original error: socket hang up). Retrying...
07:24:35:913 d �[38;5;64m[XCUITestDriver@68b6 (5cc2d54a)]�[0m Event 'wdaSessionAttempted' logged at 1699914275912 (07:24:35 GMT+0900 (Japan Standard Time))
07:24:35:914 d �[38;5;64m[XCUITestDriver@68b6 (5cc2d54a)]�[0m Sending createSession command to WDA
07:24:35:915 d �[38;5;64m[XCUITestDriver@68b6 (5cc2d54a)]�[0m Matched '/session' to command name 'createSession'
07:24:35:917 d �[38;5;64m[XCUITestDriver@68b6 (5cc2d54a)]�[0m Proxying [POST /session] to [POST http://127.0.0.1:50201/session] with body: {"capabilities":{"firstMatch":[{"bundleId":"com.trident-qa.ScrollSleuth","arguments":["-AppleLanguages","(en)","-NSLanguages","(en)","-AppleLocale","en_US","-AppleLanguages","(en)","-NSLanguages","(en)","-AppleLocale","en_US"],"environment":{},"eventloopIdleDelaySec":0,"shouldWaitForQuiescence":true,"shouldUseTestManagerForVisibilityDetection":false,"maxTypingFrequency":60,"shouldUseSingletonTestManager":true,"shouldTerminateApp":true,"forceAppLaunch":true,"useNativeCachingStrategy":true,"forceSimulatorSoftwareKeyboardPresence":true}],"alwaysMatch":{}}}
07:24:35:921 i �[38;5;64m[XCUITestDriver@68b6 (5cc2d54a)]�[0m connect ECONNREFUSED 127.0.0.1:50201
07:24:35:924 d �[38;5;64m[XCUITestDriver@68b6 (5cc2d54a)]�[0m Failed to create WDA session (An unknown server-side error occurred while processing the command. Original error: Could not proxy command to the remote server. Original error: connect ECONNREFUSED 127.0.0.1:50201). Retrying...
07:24:36:926 d �[38;5;64m[XCUITestDriver@68b6 (5cc2d54a)]�[0m Event 'wdaSessionAttempted' logged at 1699914276925 (07:24:36 GMT+0900 (Japan Standard Time))
07:24:36:927 d �[38;5;64m[XCUITestDriver@68b6 (5cc2d54a)]�[0m Sending createSession command to WDA
07:24:36:928 d �[38;5;64m[XCUITestDriver@68b6 (5cc2d54a)]�[0m Matched '/session' to command name 'createSession'
07:24:36:930 d �[38;5;64m[XCUITestDriver@68b6 (5cc2d54a)]�[0m Proxying [POST /session] to [POST http://127.0.0.1:50201/session] with body: {"capabilities":{"firstMatch":[{"bundleId":"com.trident-qa.ScrollSleuth","arguments":["-AppleLanguages","(en)","-NSLanguages","(en)","-AppleLocale","en_US","-AppleLanguages","(en)","-NSLanguages","(en)","-AppleLocale","en_US","-AppleLanguages","(en)","-NSLanguages","(en)","-AppleLocale","en_US"],"environment":{},"eventloopIdleDelaySec":0,"shouldWaitForQuiescence":true,"shouldUseTestManagerForVisibilityDetection":false,"maxTypingFrequency":60,"shouldUseSingletonTestManager":true,"shouldTerminateApp":true,"forceAppLaunch":true,"useNativeCachingStrategy":true,"forceSimulatorSoftwareKeyboardPresence":true}],"alwaysMatch":{}}}
07:24:36:934 i �[38;5;64m[XCUITestDriver@68b6 (5cc2d54a)]�[0m connect ECONNREFUSED 127.0.0.1:50201
07:24:36:937 d �[38;5;64m[XCUITestDriver@68b6 (5cc2d54a)]�[0m Failed to create WDA session (An unknown server-side error occurred while processing the command. Original error: Could not proxy command to the remote server. Original error: connect ECONNREFUSED 127.0.0.1:50201). Retrying...

[mwakizaka]

https://github.com/appium/appium-xcuitest-driver/actions/runs/6917960477/job/18819707172?pr=2245

npm ERR! code EIDLETIMEOUT
npm ERR! Idle timeout reached for host `registry.npmjs.org:443`
npm ERR! A complete log of this run can be found in: /Users/runner/.npm/_logs/2023-11-19T02_59_54_252Z-debug-0.log

unfortunately the test failed but it does not likely relate to this PR.

[KazuCocoa]

Do you mean even when you do not set these language/locale, these were added? For example the expected value was "arguments":[],"environment":{}.

[KazuCocoa]

oo, i see.

"arguments":["-AppleLanguages","(en)","-NSLanguages","(en)","-AppleLocale","en_US"],"environment":{}
"arguments":["-AppleLanguages","(en)","-NSLanguages","(en)","-AppleLocale","en_US","-AppleLanguages","(en)","-NSLanguages","(en)","-AppleLocale","en_US"],"environment":{}
...

so keep growing the arguments

[KazuCocoa]

I think startWdaSession method side should take care of that instead of the caller. Something like:

--- a/lib/driver.js
+++ b/lib/driver.js
@@ -1343,7 +1343,7 @@ class XCUITestDriver extends BaseDriver {
   }
 
   async startWdaSession(bundleId, processArguments) {
-    const args = processArguments ? processArguments.args || [] : [];
+    const args = processArguments ? _.cloneDeep(processArguments.args) || [] : [];
     if (!_.isArray(args)) {
       throw new Error(
         `processArguments.args capability is expected to be an array. ` +
diff --git a/test/unit/language-specs.js b/test/unit/language-specs.js
index 9014b4d5..7a0e98a8 100644
--- a/test/unit/language-specs.js
+++ b/test/unit/language-specs.js
@@ -121,6 +121,7 @@ describe('language and locale', function () {
       proxySpy.calledOnce.should.be.true;
       proxySpy.firstCall.args[0].should.eql('/session');
       proxySpy.firstCall.args[1].should.eql('POST');
+      desiredCapabilities.processArguments.should.equal(processArguments);
       /** @type {any} */ (proxySpy.firstCall.args[2]).should.eql(expectedWDACapabilities);
     });
   });

then, test case can take care of it as well

[mwakizaka]

thank you! Updated based on your comment

[github-actions]

🎉 This PR is included in version 5.9.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀