chore: Fix on flow type signature to pass type checking on flow >= v0.132.0

.eslintignore

@@ -1,4 +1,5 @@
 dist/
 coverage/
 artifacts/
+flow-typed/
 commitlint.config.js

.flowconfig

@@ -1,6 +1,7 @@
 [include]
 
 [libs]
+flow-typed/
 
 [options]
 module.system=node

flow-typed/README.md

@@ -0,0 +1,6 @@
+This directory contains flowtyped declarations for the npm modules that do need
+valid flow signatures to be able to flow check the modules part of this project.
+
+The declarations in this directory are not complete definitions of the type defined
+in the related modules source code, this declaration files define just as much as
+needed for the purpose of flow checking this project source code.

flow-typed/chrome-launcher.decl.js

@@ -0,0 +1,23 @@
+// flow-typed signatures for 'chrome-launcher' module.
+
+declare module "chrome-launcher" {
+  declare type LaunchOptions = {
+    enableExtensions: boolean,
+    chromePath: ?string,
+    chromeFlags: Array<string>,
+    startingUrl: ?string,
+    userDataDir: ?string,
+    ignoreDefaultFlags: boolean,
+  };
+
+  declare class Launcher {
+    static defaultFlags: () => Array<string>,
+    process: child_process$ChildProcess,
+    kill(): Promise<void>,
+  }
+
+  declare module.exports: {
+    Launcher: Class<Launcher>,
+    launch(options?: LaunchOptions): Promise<Launcher>,
+  }
+}

flow-typed/firefox-client.decl.js

@@ -0,0 +1,6 @@
+// flow-typed signatures for 'firefox-client' module.
+
+declare module "@cliqz-oss/firefox-client" {
+  declare class FirefoxClient extends event$EventEmitter {}
+  declare module.exports: Class<FirefoxClient>;
+}

flow-typed/firefox-profile.decl.js

@@ -0,0 +1,39 @@
+// flow-typed signatures for 'firefox-profile' module.
+
+declare module "firefox-profile" {
+  declare type ProfileOptions = {
+    destinationDirectory: string,
+  }
+
+  declare type ProfileCallback = 
+    (err: ?Error, profile: Profile) => void;
+
+  declare class Finder {
+    constructor(baseDir: ?string): Finder,
+    readProfiles(cb: Function): void,
+    getPath(name: string, cb: (err: ?Error, profilePath: string) => void): void,
+
+    profiles: Array<{ [key:string]: string }>, 
+
+    static locateUserDirectory(): string,
+  }
+
+  declare class FirefoxProfile {
+    constructor(opts: ?ProfileOptions): FirefoxProfile,
+
+    extensionsDir: string,
+    profileDir: string,
+    userPrefs: string,
+    defaultPreferences: { [key: string]: any },
+
+    path(): string,
+    setPreference(pref: string, value: any): void,
+    updatePreferences(): void,
+
+    static copy({profileDirectory: string}, cb: ProfileCallback): void,
+    static copyFromUserProfile({name: string}, cb: ProfileCallback): void,
+    static Finder: Class<Finder>,
+  }
+
+  declare module.exports: Class<FirefoxProfile>;
+}

flow-typed/watchpack.decl.js

@@ -0,0 +1,9 @@
+// flow-typed signatures for 'watchpack' module.
+
+declare module "watchpack" {
+  declare class Watchpack extends event$EventEmitter {
+    close(): void,
+  }
+
+  declare module.exports: Class<Watchpack>;
+}

flow-typed/ws.decl.js

@@ -0,0 +1,36 @@
+// flow-typed signatures for 'ws' module.
+
+declare module "ws" {
+  declare type ServerOptions = {
+    host: string,
+    port: number,
+  }
+
+  declare type ServerAddressInfo = {
+    address: string,
+    port: number,
+  }
+
+  declare class WebSocket extends events$EventEmitter {
+    constructor(url: string): WebSocket,
+    removeEventListener(eventName: string, cb: Function): void,
+    readyState: "CONNECTING" | "OPEN" | "CLOSING" | "CLOSED",
+    send(msg: string): void,
+    close(): void,
+
+    static OPEN: "OPEN",
+    static CLOSED: "CLOSED",
+    static CONNECTING: "CONNECTING",
+    static CLOSING: "CLOSING",
+    static Server: Class<Server>,
+  }
+
+  declare class Server extends net$Server {
+    constructor(opts?: ServerOptions, listenCb: Function): Server,
+    address(): ServerAddressInfo,
+    clients: Set<WebSocket>,
+    close(closedCb: Function): void,
+  }
+
+  declare module.exports: Class<WebSocket>;
+}

src/cmd/build.js

@@ -209,7 +209,9 @@ export async function defaultPackageCreator(
   // Added 'wx' flags to avoid overwriting of existing package.
   const stream = createWriteStream(extensionPath, {flags: 'wx'});
 
-  stream.write(buffer, () => stream.end());
+  stream.write(buffer, () => {
+    stream.end();
+  });
 
   try {
     await eventToPromise(stream, 'close');
@@ -224,7 +226,9 @@ export async function defaultPackageCreator(
     }
     log.info(`Destination exists, overwriting: ${extensionPath}`);
     const overwriteStream = createWriteStream(extensionPath);
-    overwriteStream.write(buffer, () => overwriteStream.end());
+    overwriteStream.write(buffer, () => {
+      overwriteStream.end();
+    });
     await eventToPromise(overwriteStream, 'close');
   }
 

src/cmd/docs.js

@@ -14,8 +14,8 @@ export type DocsOptions = {
   openUrl?: typeof open,
 }
 
-export const url = 'https://developer.mozilla.org/en-US/Add-ons' +
-  '/WebExtensions/Getting_started_with_web-ext';
+// eslint-disable-next-line max-len
+export const url = 'https://extensionworkshop.com/documentation/develop/getting-started-with-web-ext/';
 
 export default function docs(
   params: DocsParams, {openUrl = open}: DocsOptions = {}

src/cmd/sign.js

@@ -15,7 +15,8 @@ import type {ExtensionManifest} from '../util/manifest';
 
 const log = createLogger(__filename);
 
-const defaultAsyncFsReadFile = fs.readFile.bind(fs);
+const defaultAsyncFsReadFile: (string) => Promise<Buffer> =
+  fs.readFile.bind(fs);
 
 export const extensionIdFile = '.web-extension-id';
 

src/extension-runners/chromium.js

@@ -43,7 +43,7 @@ const EXCLUDED_CHROME_FLAGS = [
   '--mute-audio',
 ];
 
-export const DEFAULT_CHROME_FLAGS = ChromeLauncher.defaultFlags()
+export const DEFAULT_CHROME_FLAGS: Array<string> = ChromeLauncher.defaultFlags()
   .filter((flag) => !EXCLUDED_CHROME_FLAGS.includes(flag));
 
 /**
@@ -52,10 +52,10 @@ export const DEFAULT_CHROME_FLAGS = ChromeLauncher.defaultFlags()
 export class ChromiumExtensionRunner {
   cleanupCallbacks: Set<Function>;
   params: ChromiumExtensionRunnerParams;
-  chromiumInstance: ChromeLauncher;
+  chromiumInstance: ?ChromeLauncher;
   chromiumLaunch: typeof defaultChromiumLaunch;
   reloadManagerExtension: string;
-  wss: WebSocket.Server;
+  wss: ?WebSocket.Server;
   exiting: boolean;
   _promiseSetupDone: ?Promise<void>;
 
@@ -73,7 +73,7 @@ export class ChromiumExtensionRunner {
   /**
    * Returns the runner name.
    */
-  getName() {
+  getName(): string {
     return 'Chromium';
   }
 
@@ -241,7 +241,7 @@ export class ChromiumExtensionRunner {
     });
   }
 
-  async wssBroadcast(data: Object) {
+  async wssBroadcast(data: Object): Promise<void> {
     return new Promise((resolve) => {
       const clients = this.wss ? new Set(this.wss.clients) : new Set();
 
@@ -280,7 +280,7 @@ export class ChromiumExtensionRunner {
     });
   }
 
-  async createReloadManagerExtension() {
+  async createReloadManagerExtension(): Promise<string> {
     const tmpDir = new TempDir();
     await tmpDir.create();
     this.registerCleanup(() => tmpDir.remove());
@@ -307,6 +307,7 @@ export class ChromiumExtensionRunner {
       })
     );
 
+    // $FlowIgnore: this method is only called right after creating the server and so wss should be defined.
     const wssInfo = this.wss.address();
 
     const bgPage = `(function bgPage() {
@@ -408,7 +409,8 @@ export class ChromiumExtensionRunner {
     }
 
     if (this.wss) {
-      await new Promise((resolve) => this.wss.close(resolve));
+      await new Promise((resolve) =>
+        this.wss ? this.wss.close(resolve) : resolve());
       this.wss = null;
     }
 

src/extension-runners/firefox-android.js

@@ -89,9 +89,9 @@ export type FirefoxAndroidExtensionRunnerParams = {|
  */
 export class FirefoxAndroidExtensionRunner {
   // Wait 3s before the next unix socket discovery loop.
-  static unixSocketDiscoveryRetryInterval = 3 * 1000;
+  static unixSocketDiscoveryRetryInterval: number = 3 * 1000;
   // Wait for at most 3 minutes before giving up.
-  static unixSocketDiscoveryMaxTime = 3 * 60 * 1000;
+  static unixSocketDiscoveryMaxTime: number = 3 * 60 * 1000;
 
   params: FirefoxAndroidExtensionRunnerParams;
   adbUtils: DefaultADBUtils;
@@ -168,7 +168,7 @@ export class FirefoxAndroidExtensionRunner {
   /**
    * Returns the runner name.
    */
-  getName() {
+  getName(): string {
     return 'Firefox Android';
   }
 

src/extension-runners/firefox-desktop.js

@@ -73,7 +73,7 @@ export class FirefoxDesktopExtensionRunner {
   /**
    * Returns the runner name.
    */
-  getName() {
+  getName(): string {
     return 'Firefox Desktop';
   }
 

src/extension-runners/index.js

@@ -45,7 +45,9 @@ export type MultiExtensionRunnerParams = {|
   desktopNotifications: typeof defaultDesktopNotifications,
 |};
 
-export async function createExtensionRunner(config: ExtensionRunnerConfig) {
+export async function createExtensionRunner(
+  config: ExtensionRunnerConfig
+): Promise<IExtensionRunner> {
   switch (config.target) {
     case 'firefox-desktop': {
       // TODO: use async import instead of require - https://github.com/mozilla/web-ext/issues/1306
@@ -86,7 +88,7 @@ export class MultiExtensionRunner {
   /**
    * Returns the runner name.
    */
-  getName() {
+  getName(): string {
     return 'Multi Extension Runner';
   }
 

src/firefox/index.js

@@ -4,8 +4,7 @@ import path from 'path';
 import {promisify} from 'util';
 
 import {default as defaultFxRunner} from 'fx-runner';
-import FirefoxProfile, {copyFromUserProfile as defaultUserProfileCopier}
-  from 'firefox-profile';
+import FirefoxProfile from 'firefox-profile';
 import {fs} from 'mz';
 import eventToPromise from 'event-to-promise';
 
@@ -26,7 +25,9 @@ import type {ExtensionManifest} from '../util/manifest';
 
 const log = createLogger(__filename);
 
-const defaultAsyncFsStat = fs.stat.bind(fs);
+const defaultAsyncFsStat: typeof fs.stat = fs.stat.bind(fs);
+
+const defaultUserProfileCopier = FirefoxProfile.copyFromUserProfile;
 
 export const defaultFirefoxEnv = {
   XPCOM_DEBUG_BREAK: 'stack',

src/util/artifacts.js

@@ -7,7 +7,7 @@ import {createLogger} from './logger';
 
 const log = createLogger(__filename);
 
-const defaultAsyncFsAccess = fs.access.bind(fs);
+const defaultAsyncFsAccess: typeof fs.access = fs.access.bind(fs);
 
 type PrepareArtifactsDirOptions = {
   asyncMkdirp?: typeof defaultAsyncMkdirp,

src/util/logger.js

@@ -91,7 +91,7 @@ export class ConsoleStream {
   }
 }
 
-export const consoleStream = new ConsoleStream();
+export const consoleStream: ConsoleStream = new ConsoleStream();
 
 
 // createLogger types and implementation.

src/util/temp-dir.js

@@ -127,7 +127,7 @@ export class TempDir {
   /*
    * Remove the temp directory.
    */
-  remove() {
+  remove(): Promise<void> | void {
     if (!this._removeTempDir) {
       return;
     }

src/util/zip-dir.js

@@ -3,4 +3,7 @@ import {promisify} from 'util';
 
 import zipDirModule from 'zip-dir';
 
-export const zipDir = promisify(zipDirModule);
+type PromisedZipDir =
+  (sourceDir: string, { filter(...any): boolean }) => Promise<Buffer>;
+
+export const zipDir: PromisedZipDir = promisify(zipDirModule);

tests/functional/common.js

@@ -11,21 +11,25 @@ import * as tmpDirUtils from '../../src/util/temp-dir';
 export const withTempDir = tmpDirUtils.withTempDir;
 
 
-export const functionalTestsDir = path.resolve(__dirname);
-export const projectDir = path.join(functionalTestsDir, '..', '..');
-export const webExt = process.env.TEST_WEB_EXT_BIN ?
+export const functionalTestsDir: string = path.resolve(__dirname);
+export const projectDir: string = path.join(functionalTestsDir, '..', '..');
+export const webExt: string = process.env.TEST_WEB_EXT_BIN ?
   path.resolve(process.env.TEST_WEB_EXT_BIN) :
   path.join(projectDir, 'bin', 'web-ext');
-export const fixturesDir = path.join(functionalTestsDir, '..', 'fixtures');
-export const minimalAddonPath = path.join(fixturesDir, 'minimal-web-ext');
-export const fixtureEsmImport = path.join(fixturesDir, 'import-as-esm');
-export const fixtureCjsRequire = path.join(fixturesDir, 'require-as-cjs');
-export const fakeFirefoxPath = path.join(
+export const fixturesDir: string =
+  path.join(functionalTestsDir, '..', 'fixtures');
+export const minimalAddonPath: string =
+  path.join(fixturesDir, 'minimal-web-ext');
+export const fixtureEsmImport: string =
+  path.join(fixturesDir, 'import-as-esm');
+export const fixtureCjsRequire: string =
+  path.join(fixturesDir, 'require-as-cjs');
+export const fakeFirefoxPath: string = path.join(
   functionalTestsDir,
   process.platform === 'win32' ?
     'fake-firefox-binary.bat' : 'fake-firefox-binary.js'
 );
-export const fakeServerPath = path.join(
+export const fakeServerPath: string = path.join(
   functionalTestsDir, 'fake-amo-server.js'
 );