@limrun/appium-xcuitest-driver 10.4.3-lim.1

package/lib/commands/source.js

@@ -0,0 +1,131 @@
+import _ from 'lodash';
+import js2xml from 'js2xmlparser2';
+
+const APPIUM_AUT_TAG = 'AppiumAUT';
+
+/**
+ * @this {XCUITestDriver}
+ */
+export async function getPageSource() {
+  if (this.isWebContext()) {
+    const script = 'return document.documentElement.outerHTML';
+    return await this.executeAtom('execute_script', [script, []]);
+  }
+
+  const {
+    pageSourceExcludedAttributes: excludedAttributes,
+    useJSONSource
+  } = await this.settings.getSettings();
+  const hasExcludedAttributes = _.isString(excludedAttributes) && !_.isEmpty(excludedAttributes);
+  if (useJSONSource) {
+    const srcTree = await this.mobileGetSource('json', hasExcludedAttributes ? excludedAttributes : undefined);
+    return getSourceXml(getTreeForXML(srcTree));
+  }
+
+  return await this.mobileGetSource('xml', hasExcludedAttributes ? excludedAttributes : undefined);
+}
+
+/**
+ * Retrieve the source tree of the current page in XML or JSON format.
+ *
+ * @param {import('./types').SourceFormat} format - Page tree source representation format.
+ * @param {string} [excludedAttributes] A comma-separated string of attribute names to exclude from the output. Only works if `format` is `xml`.
+ * @privateRemarks Why isn't `excludedAttributes` an array?
+ * @returns {Promise<string>} The source tree of the current page in the given format.
+ * @this {XCUITestDriver}
+ */
+export async function mobileGetSource(format = 'xml', excludedAttributes) {
+  const paramsMap = {
+    format,
+    scope: APPIUM_AUT_TAG,
+  };
+  if (excludedAttributes) {
+    paramsMap.excluded_attributes = excludedAttributes;
+  }
+  const query = Object.entries(paramsMap)
+    .map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(v)}`)
+    .join('&');
+  return /** @type {string} */ (await this.proxyCommand(`/source?${query}`, 'GET'));
+}
+
+/**
+ * Will get JSON of the form:
+ *
+ * ```js
+ *   { isEnabled: '1',
+ *     isVisible: '1',
+ *     isAccessible: '1',
+ *     frame: '{{0, 0}, {375, 667}}',
+ *     children:
+ *      [ { isEnabled: '1',
+ *          isVisible: '1',
+ *          isAccessible: '1',
+ *          frame: '{{0, 0}, {375, 667}}',
+ *          children: [],
+ *          rect: { x: 0, y: 0, width: 375, height: 667 },
+ *          value: null,
+ *          label: null,
+ *          type: 'Other',
+ *          name: null,
+ *          rawIdentifier: null },
+ *     rect: { origin: { x: 0, y: 0 }, size: { width: 375, height: 667 } },
+ *     value: null,
+ *     label: 'UICatalog',
+ *     type: 'Application',
+ *     name: 'UICatalog',
+ *     rawIdentifier: null }
+ * ```
+ */
+function getTreeForXML(srcTree) {
+  function getTree(element, elementIndex, parentPath) {
+    let curPath = `${parentPath}/${elementIndex}`;
+    let rect = element.rect || {};
+    /**
+     * @privateRemarks I don't even want to try to type this right now
+     * @type {any}
+     */
+    let subtree = {
+      '@': {
+        type: `XCUIElementType${element.type}`,
+        enabled: parseInt(element.isEnabled, 10) === 1,
+        visible: parseInt(element.isVisible, 10) === 1,
+        accessible: parseInt(element.isAccessible, 10) === 1,
+        focused: parseInt(element.isFocused, 10) === 1,
+        x: rect.x,
+        y: rect.y,
+        width: rect.width,
+        height: rect.height,
+      },
+      '>': [],
+    };
+    if (element.name !== null) {
+      subtree['@'].name = element.name;
+    }
+    if (element.label !== null) {
+      subtree['@'].label = element.label;
+    }
+    if (element.value !== null) {
+      subtree['@'].value = element.value;
+    }
+    for (let i = 0; i < (element.children || []).length; i++) {
+      subtree['>'].push(getTree(element.children[i], i, curPath));
+    }
+    return {
+      [`XCUIElementType${element.type}`]: subtree,
+    };
+  }
+  let tree = getTree(srcTree, 0, '');
+  return tree;
+}
+
+function getSourceXml(jsonSource) {
+  return js2xml('AppiumAUT', jsonSource, {
+    wrapArray: {enabled: false, elementName: 'element'},
+    declaration: {include: true},
+    prettyPrinting: {indentString: '  '},
+  });
+}
+
+/**
+ * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
+ */

package/lib/commands/timeouts.js

@@ -0,0 +1,68 @@
+/**
+ * @this {XCUITestDriver}
+ */
+export async function pageLoadTimeoutW3C(ms) {
+  await this.setPageLoadTimeout(this.parseTimeoutArgument(ms));
+}
+
+/**
+ * @this {XCUITestDriver}
+ */
+export async function pageLoadTimeoutMJSONWP(ms) {
+  await this.setPageLoadTimeout(this.parseTimeoutArgument(ms));
+}
+
+/**
+ * @this {XCUITestDriver}
+ */
+export async function scriptTimeoutW3C(ms) {
+  // XXX: this is synchronous
+  await this.setAsyncScriptTimeout(this.parseTimeoutArgument(ms));
+}
+
+/**
+ * Alias for {@linkcode XCUITestDriver.scriptTimeoutW3C}.
+ *
+ * @param {number} ms - the timeout
+ * @this {XCUITestDriver}
+ * @deprecated Use {@linkcode XCUITestDriver.scriptTimeoutW3C} instead
+ */
+export async function scriptTimeoutMJSONWP(ms) {
+  await this.asyncScriptTimeout(ms);
+}
+
+/**
+ * Alias for {@linkcode XCUITestDriver.scriptTimeoutW3C}.
+ *
+ * @param {number} ms - the timeout
+ *
+ * @deprecated Use {@linkcode XCUITestDriver.scriptTimeoutW3C} instead
+ * @this {XCUITestDriver}
+ */
+export async function asyncScriptTimeout(ms) {
+  await this.scriptTimeoutW3C(ms);
+}
+
+/**
+ * @this {XCUITestDriver}
+ */
+export function setPageLoadTimeout(ms) {
+  ms = parseInt(ms, 10);
+  this.pageLoadMs = ms;
+  if (this.remote) {
+    this.remote.pageLoadMs = ms;
+  }
+  this.log.debug(`Set page load timeout to ${ms}ms`);
+}
+
+/**
+ * @this {XCUITestDriver}
+ */
+export function setAsyncScriptTimeout(ms) {
+  this.asyncWaitMs = ms;
+  this.log.debug(`Set async script timeout to ${ms}ms`);
+}
+
+/**
+ * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
+ */