Improve types

appium · Oct 13, 2023 · 893af96 · 893af96
1 parent 1c8a251
commit 893af96
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 7 deletions.
diff --git a/lib/css-converter.js b/lib/css-converter.js
@@ -46,6 +46,7 @@ const ALL_ATTRS = [
   ...STR_ATTRS,
 ];
 
+/** @type {[string, string[]][]} */
 const ATTRIBUTE_ALIASES = [
   [RESOURCE_ID, ['id']],
   ['description', [
@@ -78,10 +79,12 @@ function toSnakeCase (str) {
  * @returns {string} Either 'true' or 'false'. If value is empty, return 'true'
  */
 function requireBoolean (css) {
+  // @ts-ignore Attributes should exist
   const val = _.toLower((css.value ?? css.argument)?.value) || 'true'; // an omitted boolean attribute means 'true' (e.g.: input[checked] means checked is true)
   if (['true', 'false'].includes(val)) {
     return val;
   }
+  // @ts-ignore The attribute should exist
   throw new Error(`'${css.name}' must be true, false or empty. Found '${css.value}'`);
 }
 
@@ -149,6 +152,7 @@ class CssConverter {
    * @returns {string} CSS attribute parsed as UiSelector
    */
   parseAttr (cssAttr) {
+    // @ts-ignore Value should be present
     const attrValue = cssAttr.value?.value;
     if (!_.isString(attrValue) && !_.isEmpty(attrValue)) {
       throw new Error(`'${cssAttr.name}=${attrValue}' is an invalid attribute. ` +
@@ -205,9 +209,10 @@ class CssConverter {
    * Convert a CSS pseudo class to a UiSelector
    *
    * @param {import('css-selector-parser').AstPseudoClass} cssPseudo CSS Pseudo class
-   * @returns {string?} Pseudo selector parsed as UiSelector
+   * @returns {string|null|undefined} Pseudo selector parsed as UiSelector
    */
   parsePseudo (cssPseudo) {
+    // @ts-ignore The attribute should exist
     const argValue = cssPseudo.argument?.value;
     if (!_.isString(argValue) && !_.isEmpty(argValue)) {
       throw new Error(`'${cssPseudo.name}=${argValue}'. ` +
@@ -236,6 +241,7 @@ class CssConverter {
     }
 
     let uiAutomatorSelector = 'new UiSelector()';
+    // @ts-ignore the attribute should exist
     const tagName = cssRule.tag?.name;
     if (tagName && tagName !== '*') {
       let androidClass = [tagName];
@@ -248,9 +254,11 @@ class CssConverter {
         uiAutomatorSelector += `.classNameMatches("${tagName}")`;
       }
     } else if (!_.isEmpty(cssRule.classNames)) {
+      // @ts-ignore the attribute should exist
       uiAutomatorSelector += `.classNameMatches("${cssRule.classNames.join('\\.')}")`;
     }
     if (!_.isEmpty(cssRule.ids)) {
+      // @ts-ignore The attribute should exist
       uiAutomatorSelector += `.resourceId("${this.formatIdLocator(cssRule.ids[0])}")`;
     }
     if (cssRule.attributes) {

diff --git a/lib/uiautomator2.js b/lib/uiautomator2.js
@@ -24,6 +24,9 @@ const INSTRUMENTATION_TARGET = `${SERVER_TEST_PACKAGE_ID}/androidx.test.runner.A
 const instrumentationLogger = logger.getLogger('Instrumentation');
 
 class UIA2Proxy extends JWProxy {
+  /** @type {boolean} */
+  didInstrumentationExit;
+
   async proxyCommand (url, method, body = null) {
     if (this.didInstrumentationExit) {
       throw new errors.InvalidContextError(
@@ -36,6 +39,21 @@ class UIA2Proxy extends JWProxy {
 }
 
 class UiAutomator2Server {
+  /** @type {string} */
+  host;
+
+  /** @type {number} */
+  systemPort;
+
+  /** @type {import('appium-adb').ADB} */
+  adb;
+
+  /** @type {boolean} */
+  disableWindowAnimation;
+
+  /** @type {boolean|undefined} */
+  disableSuppressAccessibilityService;
+
   constructor (log, opts = {}) {
     for (let req of REQD_PARAMS) {
       if (!opts || !util.hasValue(opts[req])) {
@@ -192,6 +210,7 @@ class UiAutomator2Server {
         intervalMs: 1000,
       });
     } catch (err) {
+      // @ts-ignore It is ok if the attribute does not exist
       this.log.error(`Unable to find instrumentation target '${INSTRUMENTATION_TARGET}': ${(pmError || {}).message}`);
       if (pmOutput) {
         this.log.debug('Available targets:');
@@ -271,10 +290,10 @@ class UiAutomator2Server {
       cmd.push('--no-window-animation');
     }
     if (_.isBoolean(this.disableSuppressAccessibilityService)) {
-      cmd.push('-e', 'DISABLE_SUPPRESS_ACCESSIBILITY_SERVICES', this.disableSuppressAccessibilityService);
+      cmd.push('-e', 'DISABLE_SUPPRESS_ACCESSIBILITY_SERVICES', `${this.disableSuppressAccessibilityService}`);
     }
     // Disable Google analytics to prevent possible fatal exception
-    cmd.push('-e', 'disableAnalytics', true);
+    cmd.push('-e', 'disableAnalytics', 'true');
     cmd.push(INSTRUMENTATION_TARGET);
     const instrumentationProcess = this.adb.createSubProcess(['shell', ...cmd]);
     instrumentationProcess.on('output', (stdout, stderr) => {

diff --git a/lib/utils.js b/lib/utils.js
@@ -4,12 +4,12 @@ import { errors } from 'appium/driver';
 /**
  * Assert the presence of particular keys in the given object
  *
- * @template {Object} T
+ * @template {Record<string, any>} T
  * @param {string|string[]} argNames one or more key names
  * @param {T} opts the object to check
  * @returns {T} the same given object
  */
-export function requireArgs (argNames, opts = {}) {
+export function requireArgs (argNames, opts) {
   for (const argName of (_.isArray(argNames) ? argNames : [argNames])) {
     if (!_.has(opts, argName)) {
       throw new errors.InvalidArgumentError(`'${argName}' argument must be provided`);

diff --git a/tsconfig.json b/tsconfig.json
@@ -3,8 +3,9 @@
   "extends": "@appium/tsconfig/tsconfig.json",
   "compilerOptions": {
     "outDir": "build",
-    "strict": true,
+    "strict": false,
+    "checkJs": true,
     "types": ["node", "mocha", "sinon-chai", "chai-as-promised"]
   },
-  "include": ["lib", "test", "index.js"]
+  "include": ["lib", "index.js"]
 }