appium-webdriveragent 4.10.21 → 4.10.23

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [4.10.23](https://github.com/appium/WebDriverAgent/compare/v4.10.22...v4.10.23) (2023-02-05)
+
+
+### Miscellaneous Chores
+
+* bundle:tv for tvOS ([#657](https://github.com/appium/WebDriverAgent/issues/657)) ([9d2d047](https://github.com/appium/WebDriverAgent/commit/9d2d047fba57a33787c66a1e8a8449b9538c67be))
+
+## [4.10.22](https://github.com/appium/WebDriverAgent/compare/v4.10.21...v4.10.22) (2023-01-30)
+
+
+### Bug Fixes
+
+* Pull defaultAdditionalRequestParameters dynamically ([#658](https://github.com/appium/WebDriverAgent/issues/658)) ([d7c397b](https://github.com/appium/WebDriverAgent/commit/d7c397b0260a71568edd6d99ecf7b39ca3503083))
+
 ## [4.10.21](https://github.com/appium/WebDriverAgent/compare/v4.10.20...v4.10.21) (2023-01-26)
 
 

package/README.md

@@ -33,7 +33,10 @@ If you are having some issues please checkout [wiki](https://github.com/facebook
 If you want to help us out, you are more than welcome to. However please make sure you have followed the guidelines in [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Creating Bundles
-Follow [this doc](docs/CREATING_BUNDLES.md)
+
+`npm run bundle`
+
+Then, you find `WebDriverAgentRunner-Runner-sim-<version>.zip`  for iOS and `WebDriverAgentRunner-Runner-tv_sim-<version>.zip` for tvOS files in the current directory.
 
 ## License
 

package/Scripts/build-webdriveragent.js

@@ -10,7 +10,25 @@ const DERIVED_DATA_PATH = `${ROOT_DIR}/wdaBuild`;
 const WDA_BUNDLE = 'WebDriverAgentRunner-Runner.app';
 const WDA_BUNDLE_PATH = path.join(DERIVED_DATA_PATH, 'Build', 'Products', 'Debug-iphonesimulator');
 
+const WDA_BUNDLE_TV = 'WebDriverAgentRunner_tvOS-Runner.app';
+const WDA_BUNDLE_TV_PATH = path.join(DERIVED_DATA_PATH, 'Build', 'Products', 'Debug-appletvsimulator');
+
+const TARGETS = ['runner', 'tv_runner'];
+const SDKS = ['sim', 'tv_sim'];
+
 async function buildWebDriverAgent (xcodeVersion) {
+  const target = process.env.TARGET;
+  const sdk = process.env.SDK;
+
+  if (!TARGETS.includes(target)) {
+    throw Error(`Please set TARGETS environment variable from the supported targets ${JSON.stringify(TARGETS)}`);
+  }
+
+  if (!SDKS.includes(sdk)) {
+    throw Error(`Please set SDK environment variable from the supported SDKs ${JSON.stringify(SDKS)}`);
+  }
+
+
   LOG.info(`Cleaning ${DERIVED_DATA_PATH} if exists`);
   try {
     await exec('xcodebuild', ['clean', '-derivedDataPath', DERIVED_DATA_PATH, '-scheme', 'WebDriverAgentRunner'], {
@@ -25,7 +43,7 @@ async function buildWebDriverAgent (xcodeVersion) {
   // Clean and build
   try {
     await exec('/bin/bash', ['./Scripts/build.sh'], {
-      env: {TARGET: 'runner', SDK: 'sim', DERIVED_DATA_PATH},
+      env: {TARGET: target, SDK: sdk, DERIVED_DATA_PATH},
       cwd: ROOT_DIR
     });
   } catch (e) {
@@ -34,14 +52,18 @@ async function buildWebDriverAgent (xcodeVersion) {
     throw e;
   }
 
-  const zipName = `WebDriverAgentRunner-Runner-Sim-${xcodeVersion}.zip`;
-  LOG.info(`Creating ${zipName} which includes ${WDA_BUNDLE}`);
+  const isTv = target === 'tv_runner';
+  const bundle = isTv ? WDA_BUNDLE_TV : WDA_BUNDLE;
+  const bundle_path = isTv ? WDA_BUNDLE_TV_PATH : WDA_BUNDLE_PATH;
+
+  const zipName = `WebDriverAgentRunner-Runner-${sdk}-${xcodeVersion}.zip`;
+  LOG.info(`Creating ${zipName} which includes ${bundle}`);
   const appBundleZipPath = path.join(ROOT_DIR, zipName);
   await fs.rimraf(appBundleZipPath);
   LOG.info(`Created './${zipName}'`);
   try {
-    await exec('xattr', ['-cr', WDA_BUNDLE], {cwd: WDA_BUNDLE_PATH});
-    await exec('zip', ['-qr', appBundleZipPath, WDA_BUNDLE], {cwd: WDA_BUNDLE_PATH});
+    await exec('xattr', ['-cr', bundle], {cwd: bundle_path});
+    await exec('zip', ['-qr', appBundleZipPath, bundle], {cwd: bundle_path});
   } catch (e) {
     LOG.error(`===FAILED TO ZIP ARCHIVE`);
     LOG.error(e.stderr);

package/WebDriverAgentLib/Categories/XCAXClient_iOS+FBSnapshotReqParams.m

@@ -45,26 +45,18 @@ static id swizzledDefaultParameters(id self, SEL _cmd)
 {
   static dispatch_once_t onceToken;
   dispatch_once(&onceToken, ^{
-    NSMutableDictionary *params = [NSMutableDictionary dictionaryWithDictionary:original_defaultParameters(self, _cmd)];
-    [params addEntriesFromDictionary:defaultAdditionalRequestParameters];
-    defaultRequestParameters = params.copy;
+    defaultRequestParameters = original_defaultParameters(self, _cmd);
   });
-  if (nil == defaultRequestParameters) {
-    return original_defaultParameters(self, _cmd);
-  }
   NSMutableDictionary *result = [NSMutableDictionary dictionaryWithDictionary:defaultRequestParameters];
-  if (nil != customRequestParameters && customRequestParameters.count > 0) {
-    [result addEntriesFromDictionary:customRequestParameters];
-  }
+  [result addEntriesFromDictionary:defaultAdditionalRequestParameters ?: @{}];
+  [result addEntriesFromDictionary:customRequestParameters ?: @{}];
   return result.copy;
 }
 
 static id swizzledSnapshotParameters(id self, SEL _cmd)
 {
   NSDictionary *result = original_snapshotParameters(self, _cmd);
-  if (nil == defaultAdditionalRequestParameters) {
-    defaultAdditionalRequestParameters = result;
-  }
+  defaultAdditionalRequestParameters = result;
   return result;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-webdriveragent",
-  "version": "4.10.21",
+  "version": "4.10.23",
   "description": "Package bundling WebDriverAgent",
   "main": "./build/index.js",
   "scripts": {
@@ -13,7 +13,9 @@
     "prepare": "npm run build",
     "test": "mocha --exit --timeout 1m \"./test/unit/**/*-specs.js\"",
     "e2e-test": "mocha --exit --timeout 10m \"./test/functional/**/*-specs.js\"",
-    "bundle": "node ./Scripts/build-webdriveragent.js",
+    "bundle": "npm run bundle:ios && npm run bundle:tv",
+    "bundle:ios": "TARGET=runner SDK=sim node ./Scripts/build-webdriveragent.js",
+    "bundle:tv": "TARGET=tv_runner SDK=tv_sim node ./Scripts/build-webdriveragent.js",
     "fetch-prebuilt-wda": "node ./Scripts/fetch-prebuilt-wda.js"
   },
   "engines": {