feat: Switch babel to typescript (#61)

Author: mykola-mokhnach

.eslintrc.json

@@ -1,11 +1,22 @@
 {
-  "extends": "@appium/eslint-config-appium",
+  "extends": ["@appium/eslint-config-appium-ts"],
   "overrides": [
     {
       "files": "test/**/*.js",
       "rules": {
-        "func-names": "off"
+        "func-names": "off",
+        "@typescript-eslint/no-var-requires": "off"
+      }
+    },
+    {
+      "files": "scripts/**/*",
+      "parserOptions": {"sourceType": "script"},
+      "rules": {
+        "@typescript-eslint/no-var-requires": "off"
       }
     }
-  ]
+  ],
+  "rules": {
+    "require-await": "error"
+  }
 }

.mocharc.js

@@ -1,4 +1,4 @@
 module.exports = {
-  require: ['@babel/register'],
+  require: ['ts-node/register'],
   forbidOnly: Boolean(process.env.CI)
 };

babel.config.json

@@ -5,6 +5,7 @@ import { desiredCapConstraints } from './desired-caps';
 import commands from './commands/index';
 import { formatCapsForServer } from './utils';
 
+/** @type {import('@appium/types').RouteMatcher[]} */
 const NO_PROXY = [
   ['GET', new RegExp('^/session/[^/]+/appium')],
   ['POST', new RegExp('^/session/[^/]+/appium')],
@@ -13,7 +14,11 @@ const NO_PROXY = [
 ];
 
 class GeckoDriver extends BaseDriver {
+  /** @type {boolean} */
+  isProxyActive;
+
   constructor (opts = {}) {
+    // @ts-ignore TODO: make args typed
     super(opts);
     this.desiredCapConstraints = desiredCapConstraints;
     this.locatorStrategies = [
@@ -51,7 +56,9 @@ class GeckoDriver extends BaseDriver {
     return true;
   }
 
+  // @ts-ignore TODO: make args typed
   async createSession (...args) {
+    // @ts-ignore TODO: make args typed
     const [sessionId, caps] = await super.createSession(...args);
     this.gecko = new GeckoDriverServer(this.log, caps);
     try {
@@ -60,14 +67,14 @@ class GeckoDriver extends BaseDriver {
       await this.deleteSession();
       throw e;
     }
-    this.proxyReqRes = this.gecko.proxy.proxyReqRes.bind(this.gecko.proxy);
+    this.proxyReqRes = this.gecko.proxy?.proxyReqRes.bind(this.gecko.proxy);
     this.isProxyActive = true;
     return [sessionId, caps];
   }
 
   async deleteSession () {
     this.log.info('Ending Gecko Driver session');
-    await this.gecko.stop();
+    await this.gecko?.stop();
     this.resetState();
 
     await super.deleteSession();

lib/driver.js

@@ -27,6 +27,9 @@ const PROCESS_SPECIFIC_OPTION_NAMES_MAP = Object.freeze({
 
 
 class GeckoProxy extends JWProxy {
+  /** @type {boolean|undefined} */
+  didProcessExit;
+
   async proxyCommand (url, method, body = null) {
     if (this.didProcessExit) {
       throw new errors.InvalidContextError(
@@ -38,6 +41,21 @@ class GeckoProxy extends JWProxy {
 }
 
 class GeckoDriverProcess {
+  /** @type {boolean|undefined} */
+  noReset;
+
+  /** @type {string|undefined} */
+  verbosity;
+
+  /** @type {string|undefined} */
+  androidStorage;
+
+  /** @type {number|undefined} */
+  marionettePort;
+
+  /** @type {number|undefined} */
+  port;
+
   constructor (log, opts = {}) {
     for (const [optName, propName] of _.toPairs(PROCESS_SPECIFIC_OPTION_NAMES_MAP)) {
       this[propName] = opts[optName];
@@ -76,6 +94,7 @@ class GeckoDriverProcess {
       throw new Error(`${GD_BINARY} binary cannot be found in PATH. ` +
         `Please make sure it is present on your system`);
     }
+    /** @type {string[]} */
     const args = [];
     /* #region Options */
     switch (_.toLower(this.verbosity)) {
@@ -93,13 +112,13 @@ class GeckoDriverProcess {
         this.log.info(`'marionettePort' capability value is not provided while 'noReset' is enabled`);
         this.log.info(`Assigning 'marionettePort' to the default value (${DEFAULT_MARIONETTE_PORT})`);
       }
-      args.push('--marionette-port', this.marionettePort ?? DEFAULT_MARIONETTE_PORT);
+      args.push('--marionette-port', `${this.marionettePort ?? DEFAULT_MARIONETTE_PORT}`);
     } else if (!_.isNil(this.marionettePort)) {
-      args.push('--marionette-port', this.marionettePort);
+      args.push('--marionette-port', `${this.marionettePort}`);
     }
     /* #endregion */
 
-    args.push('-p', this.port);
+    args.push('-p', `${this.port}`);
     if (this.androidStorage) {
       args.push('--android-storage', this.androidStorage);
     }
@@ -119,14 +138,14 @@ class GeckoDriverProcess {
 
   async stop () {
     if (this.isRunning) {
-      await this.proc.stop('SIGTERM');
+      await this.proc?.stop('SIGTERM');
     }
   }
 
   async kill () {
     if (this.isRunning) {
       try {
-        await this.proc.stop('SIGKILL');
+        await this.proc?.stop('SIGKILL');
       } catch (ign) {}
     }
   }
@@ -168,17 +187,19 @@ class GeckoDriverServer {
       keepAlive: true,
     });
     this.proxy.didProcessExit = false;
-    this.process.proc.on('exit', () => {
-      this.proxy.didProcessExit = true;
+    this.process?.proc?.on('exit', () => {
+      if (this.proxy) {
+        this.proxy.didProcessExit = true;
+      }
     });
 
     try {
       await waitForCondition(async () => {
         try {
-          await this.proxy.command('/status', 'GET');
+          await this.proxy?.command('/status', 'GET');
           return true;
         } catch (err) {
-          if (this.proxy.didProcessExit) {
+          if (this.proxy?.didProcessExit) {
             throw new Error(err.message);
           }
           return false;
@@ -198,10 +219,11 @@ class GeckoDriverServer {
       }
       throw e;
     }
-    const pid = this.process.proc.pid;
+    const pid = this.process.proc?.pid;
     RUNNING_PROCESS_IDS.push(pid);
-    this.process.proc.on('exit', () => void _.pull(RUNNING_PROCESS_IDS, pid));
+    this.process.proc?.on('exit', () => void _.pull(RUNNING_PROCESS_IDS, pid));
 
+    // @ts-ignore The body is ok
     await this.proxy.command('/session', 'POST', {
       capabilities: {
         firstMatch: [{}],

lib/gecko.js

@@ -51,7 +51,6 @@
     "appium": "^2.0.0-beta.40"
   },
   "dependencies": {
-    "@babel/runtime": "^7.0.0",
     "asyncbox": "^2.0.2",
     "bluebird": "^3.5.1",
     "lodash": "^4.17.4",
@@ -60,7 +59,9 @@
     "teen_process": "^2.0.0"
   },
   "scripts": {
-    "build": "rimraf build && babel --out-dir=build/lib lib && babel --out-dir=build index.js",
+    "build": "tsc -b",
+    "clean": "npm run build -- --clean",
+    "rebuild": "npm run clean; npm run build",
     "dev": "npm run build -- --watch",
     "lint": "eslint .",
     "lint:fix": "npm run lint -- --fix",
@@ -75,30 +76,40 @@
     "precommit-lint"
   ],
   "devDependencies": {
-    "@appium/eslint-config-appium": "^6.0.0",
-    "@babel/cli": "^7.18.10",
-    "@babel/core": "^7.18.10",
-    "@babel/eslint-parser": "^7.18.9",
-    "@babel/plugin-transform-runtime": "^7.18.10",
-    "@babel/preset-env": "^7.18.10",
-    "@babel/register": "^7.18.9",
+    "@appium/eslint-config-appium": "^8.0.4",
+    "@appium/eslint-config-appium-ts": "^0.3.1",
+    "@appium/tsconfig": "^0.3.0",
+    "@appium/types": "^0.13.2",
     "@semantic-release/changelog": "^6.0.1",
     "@semantic-release/git": "^10.0.1",
-    "babel-plugin-source-map-support": "^2.2.0",
+    "@types/bluebird": "^3.5.38",
+    "@types/chai": "^4.3.5",
+    "@types/chai-as-promised": "^7.1.5",
+    "@types/lodash": "^4.14.196",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^20.4.7",
+    "@types/sinon": "^10.0.16",
+    "@types/sinon-chai": "^3.2.9",
+    "@types/teen_process": "2.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
+    "@typescript-eslint/parser": "^5.62.0",
     "chai": "^4.1.2",
     "chai-as-promised": "^7.1.1",
     "conventional-changelog-conventionalcommits": "^6.0.0",
-    "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-mocha": "^9.0.0",
-    "eslint-plugin-promise": "^6.0.0",
+    "eslint": "^8.46.0",
+    "eslint-config-prettier": "^8.9.0",
+    "eslint-import-resolver-typescript": "^3.5.5",
+    "eslint-plugin-import": "^2.28.0",
+    "eslint-plugin-mocha": "^10.1.0",
+    "eslint-plugin-promise": "^6.1.1",
     "lint-staged": "^14.0.0",
     "mocha": "^10.0.0",
     "pre-commit": "^1.1.3",
     "rimraf": "^5.0.0",
     "semantic-release": "^20.0.2",
     "sinon": "^15.0.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.1.6",
     "webdriverio": "^8.0.5"
   }
 }

package.json

@@ -15,6 +15,7 @@ const CAPS = {
 describe('Desktop Gecko Driver', function () {
   this.timeout(MOCHA_TIMEOUT);
 
+  /** @type {import('webdriverio').Browser} */
   let driver;
   beforeEach(async function () {
     driver = await remote({
@@ -32,8 +33,8 @@ describe('Desktop Gecko Driver', function () {
 
   it('should start and stop a session', async function () {
     await driver.url('https://appium.io/');
-    const button = await driver.$('#downloadLink');
-    await button.getText().should.eventually.eql('Download Appium');
+    const input = await driver.$('input[data-md-component="search-query"]');
+    (await input.isExisting()).should.be.true;
   });
 });
 

test/functional/desktop-driver-e2e-specs.js

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "@appium/tsconfig/tsconfig.json",
+  "compilerOptions": {
+    "strict": false,  // TODO: make this flag true
+    "outDir": "build",
+    "types": ["node"],
+    "checkJs": true
+  },
+  "include": [
+    "index.js",
+    "lib"
+  ]
+}