fix: format (#547)

* fix: format

* apply more

Author: KazuCocoa

.github/workflows/unit-test.yml

@@ -29,5 +29,7 @@ jobs:
       name: Install dev dependencies
     - run: npm run lint
       name: Run linter
+    - run: npm run format:check
+      name: Run Prettier check
     - run: npm run test
       name: Run unit tests

lib/chromedriver.ts

@@ -865,10 +865,16 @@ export class Chromedriver extends events.EventEmitter {
       `Starting ${this._desiredProtocol} Chromedriver session with capabilities: ` +
         JSON.stringify(sessionCaps, null, 2),
     );
-    const response = (await this.jwproxy.command('/session', 'POST', sessionCaps)) as NewSessionResponse;
+    const response = (await this.jwproxy.command(
+      '/session',
+      'POST',
+      sessionCaps,
+    )) as NewSessionResponse;
     this.log.prefix = generateLogPrefix(this, this.jwproxy.sessionId);
     this.changeState(Chromedriver.STATE_ONLINE);
-    return _.has(response, 'capabilities') && response.capabilities ? response.capabilities : (response as SessionCapabilities);
+    return _.has(response, 'capabilities') && response.capabilities
+      ? response.capabilities
+      : (response as SessionCapabilities);
   }
 
   private changeState(state: string): void {

lib/constants.ts

@@ -22,4 +22,3 @@ export const CPU = {
   ARM: 'arm',
 } as const;
 export const APPLE_ARM_SUFFIXES = ['64_m1', '_arm64'] as const;
-

lib/protocol-helpers.ts

@@ -9,7 +9,7 @@ const W3C_PREFIX = 'goog:';
  * @returns The W3C-formatted capability name.
  */
 export function toW3cCapName(capName: string): string {
-  return (_.isString(capName) && !capName.includes(':') && !isStandardCap(capName))
+  return _.isString(capName) && !capName.includes(':') && !isStandardCap(capName)
     ? `${W3C_PREFIX}${capName}`
     : capName;
 }
@@ -21,7 +21,11 @@ export function toW3cCapName(capName: string): string {
  * @param defaultValue - Optional default value to return if the capability is not found.
  * @returns The capability value or the default value.
  */
-export function getCapValue(allCaps: Record<string, any> = {}, rawCapName: string, defaultValue?: any): any {
+export function getCapValue(
+  allCaps: Record<string, any> = {},
+  rawCapName: string,
+  defaultValue?: any,
+): any {
   for (const [capName, capValue] of _.toPairs(allCaps)) {
     if (toW3cCapName(capName) === toW3cCapName(rawCapName)) {
       return capValue;
@@ -36,9 +40,12 @@ export function getCapValue(allCaps: Record<string, any> = {}, rawCapName: strin
  * @returns A new object with W3C-formatted capability names.
  */
 export function toW3cCapNames(originalCaps: Record<string, any> = {}): Record<string, any> {
-  return _.reduce(originalCaps, (acc, value, key) => {
-    acc[toW3cCapName(key)] = value;
-    return acc;
-  }, {} as Record<string, any>);
+  return _.reduce(
+    originalCaps,
+    (acc, value, key) => {
+      acc[toW3cCapName(key)] = value;
+      return acc;
+    },
+    {} as Record<string, any>,
+  );
 }
-

lib/storage-client/chromelabs.ts

@@ -17,7 +17,7 @@ const log = logger.getLogger('ChromedriverChromelabsStorageClient');
  * @throws {Error} if the JSON cannot be parsed or has an unsupported format
  */
 export function parseKnownGoodVersionsWithDownloadsJson(
-  jsonStr: string
+  jsonStr: string,
 ): ChromedriverDetailsMapping {
   let json: KnownGoodVersionsJson;
   try {
@@ -83,7 +83,7 @@ export function parseKnownGoodVersionsWithDownloadsJson(
       const osNameMatch = /^[a-z]+/i.exec(downloadEntry.platform);
       if (!osNameMatch) {
         log.debug(
-          `The entry '${downloadEntry.url}' does not contain valid platform name. Skipping it`
+          `The entry '${downloadEntry.url}' does not contain valid platform name. Skipping it`,
         );
         continue;
       }

lib/storage-client/googleapis.ts

@@ -3,13 +3,7 @@ import {select as xpathSelect} from 'xpath';
 import {util, logger} from '@appium/support';
 import {retrieveData} from '../utils';
 import B from 'bluebird';
-import {
-  STORAGE_REQ_TIMEOUT_MS,
-  GOOGLEAPIS_CDN,
-  ARCH,
-  CPU,
-  APPLE_ARM_SUFFIXES,
-} from '../constants';
+import {STORAGE_REQ_TIMEOUT_MS, GOOGLEAPIS_CDN, ARCH, CPU, APPLE_ARM_SUFFIXES} from '../constants';
 import {DOMParser} from '@xmldom/xmldom';
 import path from 'node:path';
 import type {
@@ -32,7 +26,7 @@ const MAX_PARALLEL_DOWNLOADS = 5;
 export function findChildNode(
   parent: Node | Attr,
   childName: string | null = null,
-  text: string | null = null
+  text: string | null = null,
 ): Node | Attr | null {
   if (!childName && !text) {
     return null;
@@ -94,7 +88,7 @@ export function parseNotes(content: string): AdditionalDriverDetails {
  */
 export async function parseGoogleapiStorageXml(
   xml: string,
-  shouldParseNotes = true
+  shouldParseNotes = true,
 ): Promise<ChromedriverDetailsMapping> {
   const doc = new DOMParser().parseFromString(xml, 'text/xml');
   const driverNodes = xpathSelect(`//*[local-name(.)='Contents']`, doc) as Array<Node | Attr>;
@@ -142,7 +136,7 @@ export async function parseGoogleapiStorageXml(
     const notesPath = `${cdInfo.version}/notes.txt`;
     const isNotesPresent = !!driverNodes.reduce(
       (acc, node) => Boolean(acc || findChildNode(node, 'Key', notesPath)),
-      false
+      false,
     );
     if (!isNotesPresent) {
       cdInfo.minBrowserVersion = null;
@@ -155,7 +149,7 @@ export async function parseGoogleapiStorageXml(
     }
 
     const promise = B.resolve(
-      retrieveAdditionalDriverInfo(key, `${GOOGLEAPIS_CDN}/${notesPath}`, cdInfo)
+      retrieveAdditionalDriverInfo(key, `${GOOGLEAPIS_CDN}/${notesPath}`, cdInfo),
     );
     promises.push(promise);
     chunk.push(promise);
@@ -182,21 +176,21 @@ async function retrieveAdditionalDriverInfo(
   driverKey: string,
   notesUrl: string,
   infoDict: ChromedriverDetails,
-  timeout = STORAGE_REQ_TIMEOUT_MS
+  timeout = STORAGE_REQ_TIMEOUT_MS,
 ): Promise<void> {
   const notes = await retrieveData(
     notesUrl,
     {
       'user-agent': 'appium',
       accept: '*/*',
     },
-    {timeout}
+    {timeout},
   );
   const {minBrowserVersion} = parseNotes(notes);
   if (!minBrowserVersion) {
     log.debug(
       `The driver '${driverKey}' does not contain valid release notes at ${notesUrl}. ` +
-        `Skipping it`
+        `Skipping it`,
     );
     return;
   }

lib/storage-client/storage-client.ts

@@ -1,10 +1,4 @@
-import {
-  getChromedriverDir,
-  retrieveData,
-  getOsInfo,
-  convertToInt,
-  getCpuType,
-} from '../utils';
+import {getChromedriverDir, retrieveData, getOsInfo, convertToInt, getCpuType} from '../utils';
 import _ from 'lodash';
 import B from 'bluebird';
 import path from 'node:path';
@@ -19,7 +13,10 @@ import {
   CPU,
 } from '../constants';
 import {parseGoogleapiStorageXml} from './googleapis';
-import {parseKnownGoodVersionsWithDownloadsJson, parseLatestKnownGoodVersionsJson} from './chromelabs';
+import {
+  parseKnownGoodVersionsWithDownloadsJson,
+  parseLatestKnownGoodVersionsJson,
+} from './chromelabs';
 import {compareVersions} from 'compare-versions';
 import * as semver from 'semver';
 import type {
@@ -77,23 +74,26 @@ export class ChromedriverStorageClient {
    * @returns Promise<ChromedriverDetailsMapping>
    */
   async retrieveMapping(shouldParseNotes = true): Promise<ChromedriverDetailsMapping> {
-    const retrieveResponseSafely = async ({url, accept}: StorageInfo): Promise<string | undefined> => {
+    const retrieveResponseSafely = async ({
+      url,
+      accept,
+    }: StorageInfo): Promise<string | undefined> => {
       try {
         return await retrieveData(
           url,
           {
             'user-agent': USER_AGENT,
             accept: `${accept}, */*`,
           },
-          {timeout: this.timeout}
+          {timeout: this.timeout},
         );
       } catch (e) {
         const err = e as Error;
         log.debug(err.stack);
         log.warn(
           `Cannot retrieve Chromedrivers info from ${url}. ` +
             `Make sure this URL is accessible from your network. ` +
-            `Original error: ${err.message}`
+            `Original error: ${err.message}`,
         );
       }
     };
@@ -105,7 +105,7 @@ export class ChromedriverStorageClient {
         `Cannot retrieve the information about available Chromedrivers from ` +
           `${STORAGE_INFOS.map(({url}) => url)}. Please make sure these URLs are available ` +
           `within your local network, check Appium server logs and/or ` +
-          `consult the driver troubleshooting guide.`
+          `consult the driver troubleshooting guide.`,
       );
     }
     this.mapping = xmlStr ? await parseGoogleapiStorageXml(xmlStr, shouldParseNotes) : {};
@@ -137,7 +137,7 @@ export class ChromedriverStorageClient {
     }
     log.debug(
       `Got ${util.pluralize('driver', driversToSync.length, true)} to sync: ` +
-        JSON.stringify(driversToSync, null, 2)
+        JSON.stringify(driversToSync, null, 2),
     );
 
     const synchronizedDrivers: string[] = [];
@@ -151,7 +151,7 @@ export class ChromedriverStorageClient {
             if (await this.retrieveDriver(idx, driverKey, archivesRoot, !_.isEmpty(opts))) {
               synchronizedDrivers.push(driverKey);
             }
-          })()
+          })(),
         );
         promises.push(promise);
         chunk.push(promise);
@@ -167,7 +167,7 @@ export class ChromedriverStorageClient {
     if (!_.isEmpty(synchronizedDrivers)) {
       log.info(
         `Successfully synchronized ` +
-          `${util.pluralize('chromedriver', synchronizedDrivers.length, true)}`
+          `${util.pluralize('chromedriver', synchronizedDrivers.length, true)}`,
       );
     } else {
       log.info(`No chromedrivers were synchronized`);
@@ -190,14 +190,14 @@ export class ChromedriverStorageClient {
           'user-agent': USER_AGENT,
           accept: `application/json, */*`,
         },
-        {timeout: STORAGE_REQ_TIMEOUT_MS}
+        {timeout: STORAGE_REQ_TIMEOUT_MS},
       );
     } catch (e) {
       const err = e as Error;
       throw new Error(
         `Cannot fetch the latest Chromedriver version. ` +
           `Make sure you can access ${CHROME_FOR_TESTING_LAST_GOOD_VERSIONS} from your machine or provide a mirror by setting ` +
-          `a custom value to CHROMELABS_URL environment variable. Original error: ${err.message}`
+          `a custom value to CHROMELABS_URL environment variable. Original error: ${err.message}`,
       );
     }
     return parseLatestKnownGoodVersionsJson(jsonStr);
@@ -219,7 +219,7 @@ export class ChromedriverStorageClient {
       // Handle only selected versions if requested
       log.debug(`Selecting chromedrivers whose versions match to ${versions}`);
       driversToSync = driversToSync.filter((cdName) =>
-        versions.includes(`${this.mapping[cdName].version}`)
+        versions.includes(`${this.mapping[cdName].version}`),
       );
 
       log.debug(`Got ${util.pluralize('item', driversToSync.length, true)}`);
@@ -232,14 +232,14 @@ export class ChromedriverStorageClient {
     if (minBrowserVersionInt !== null) {
       // Only select drivers that support the current browser whose major version number equals to `minBrowserVersion`
       log.debug(
-        `Selecting chromedrivers whose minimum supported browser version matches to ${minBrowserVersionInt}`
+        `Selecting chromedrivers whose minimum supported browser version matches to ${minBrowserVersionInt}`,
       );
       let closestMatchedVersionNumber = 0;
       // Select the newest available and compatible chromedriver
       for (const cdName of driversToSync) {
         const currentMinBrowserVersion = parseInt(
           String(this.mapping[cdName].minBrowserVersion),
-          10
+          10,
         );
         if (
           !Number.isNaN(currentMinBrowserVersion) &&
@@ -252,7 +252,7 @@ export class ChromedriverStorageClient {
       driversToSync = driversToSync.filter(
         (cdName) =>
           `${this.mapping[cdName].minBrowserVersion}` ===
-          `${closestMatchedVersionNumber > 0 ? closestMatchedVersionNumber : minBrowserVersionInt}`
+          `${closestMatchedVersionNumber > 0 ? closestMatchedVersionNumber : minBrowserVersionInt}`,
       );
 
       log.debug(`Got ${util.pluralize('item', driversToSync.length, true)}`);
@@ -261,7 +261,7 @@ export class ChromedriverStorageClient {
       }
       log.debug(
         `Will select candidate ${util.pluralize('driver', driversToSync.length)} ` +
-          `versioned as '${_.uniq(driversToSync.map((cdName) => this.mapping[cdName].version))}'`
+          `versioned as '${_.uniq(driversToSync.map((cdName) => this.mapping[cdName].version))}'`,
       );
     }
 
@@ -277,7 +277,7 @@ export class ChromedriverStorageClient {
             name,
             arch: ARCH.X86,
             cpu,
-          })
+          }),
         );
       }
       if (_.isEmpty(result) && name === OS.MAC && cpu === CPU.ARM) {
@@ -287,7 +287,7 @@ export class ChromedriverStorageClient {
             name,
             arch,
             cpu: CPU.INTEL,
-          })
+          }),
         );
       }
       driversToSync = result;
@@ -328,7 +328,7 @@ export class ChromedriverStorageClient {
           selectedVersions.add(sortedVersions[0]);
         }
         driversToSync = driversToSync.filter((cdName) =>
-          selectedVersions.has(this.mapping[cdName].version)
+          selectedVersions.has(this.mapping[cdName].version),
         );
       }
     }
@@ -378,7 +378,7 @@ export class ChromedriverStorageClient {
     index: number,
     driverKey: string,
     archivesRoot: string,
-    isStrict = false
+    isStrict = false,
   ): Promise<boolean> {
     const {url, etag, version} = this.mapping[driverKey];
     const archivePath = path.resolve(archivesRoot, `${index}.zip`);
@@ -437,11 +437,11 @@ export class ChromedriverStorageClient {
         tmpRoot,
         true,
         (itemPath, isDirectory) =>
-          !isDirectory && _.toLower(path.parse(itemPath).name) === 'chromedriver'
+          !isDirectory && _.toLower(path.parse(itemPath).name) === 'chromedriver',
       );
       if (!chromedriverPath) {
         throw new Error(
-          'The archive was unzipped properly, but we could not find any chromedriver executable'
+          'The archive was unzipped properly, but we could not find any chromedriver executable',
         );
       }
       log.debug(`Moving the extracted '${path.basename(chromedriverPath)}' to '${dst}'`);
@@ -453,4 +453,3 @@ export class ChromedriverStorageClient {
     }
   }
 }
-