Add firefox developer support (#118)

* added firefox developer support
* firefox nightly support
* Ship FF variant support as their v1.2.0 release

---------

Co-authored-by: Tim Perry <tim@httptoolkit.com>

Author: xKiian

src/interceptors/fresh-firefox.ts

@@ -20,7 +20,6 @@ import { Interceptor } from '.';
 const FIREFOX_PREF_REGEX = /\w+_pref\("([^"]+)", (.*)\);/
 
 let profileSetupBrowser: BrowserInstance | undefined;
-let browsers: _.Dictionary<BrowserInstance> = {};
 
 export const NSS_DIR = path.join(APP_ROOT, 'nss');
 
@@ -69,18 +68,26 @@ const getCertutilCommand = _.memoize(async () => {
     }
 });
 
-export class FreshFirefox implements Interceptor {
-    id = 'fresh-firefox';
-    version = '1.1.0';
+abstract class Firefox implements Interceptor {
+    readonly abstract id: string;
+    readonly abstract version: string;
+
+    protected constructor(
+        private config: HtkConfig,
+        private variantName: string,
+        private pathName: string = variantName + '-profile',
+    ) {}
+
+    private readonly activeBrowsers: _.Dictionary<BrowserInstance> = {};
 
-    constructor(private config: HtkConfig) { }
 
     isActive(proxyPort: number | string) {
-        return browsers[proxyPort] != null && !!browsers[proxyPort].pid;
+        const browser = this.activeBrowsers[proxyPort];
+        return !!browser && !!browser.pid;
     }
 
     async isActivable() {
-        const firefoxBrowser = await getBrowserDetails(this.config.configPath, 'firefox');
+        const firefoxBrowser = await getBrowserDetails(this.config.configPath, this.variantName);
 
         return !!firefoxBrowser && // Must have Firefox installed
             parseInt(firefoxBrowser.version.split('.')[0], 0) >= 58 && // Must use cert9.db
@@ -96,7 +103,7 @@ export class FreshFirefox implements Interceptor {
         const initialUrl = initialServer.url;
 
         const browser = await launchBrowser(initialUrl, {
-            browser: 'firefox',
+            browser: this.variantName,
             profile: profilePath,
             proxy: proxyPort ? `127.0.0.1:${proxyPort}` : undefined,
             prefs: _.assign(
@@ -239,18 +246,18 @@ export class FreshFirefox implements Interceptor {
     async activate(proxyPort: number) {
         if (this.isActive(proxyPort) || !!profileSetupBrowser) return;
 
-        const browserDetails = await getBrowserDetails(this.config.configPath, 'firefox');
+        const browserDetails = await getBrowserDetails(this.config.configPath, this.variantName);
         if (!browserDetails) throw new Error('Firefox could not be detected');
 
         const profilePath = await isSnap(browserDetails.command)
-            ? path.join(await getSnapConfigPath('firefox'), 'profile')
-            : path.join(this.config.configPath, 'firefox-profile');
+            ? path.join(await getSnapConfigPath(this.variantName), 'profile')
+            : path.join(this.config.configPath, this.pathName);
 
         const firefoxPrefsFile = path.join(profilePath, 'prefs.js');
 
         let existingPrefs: _.Dictionary<any> = {};
 
-        if (await canAccess(firefoxPrefsFile) === false) {
+        if (!await canAccess(firefoxPrefsFile)) {
             /*
             First time, we do a separate pre-usage startup & stop, without the proxy, for certificate setup.
             This helps avoid initial Firefox profile setup request noise, and tidies up some awkward UX where
@@ -288,10 +295,10 @@ export class FreshFirefox implements Interceptor {
             logError(e);
         });
 
-        browsers[proxyPort] = browser;
+        this.activeBrowsers[proxyPort] = browser;
         browser.process.once('close', async (exitCode) => {
             console.log('Firefox closed');
-            delete browsers[proxyPort];
+            delete this.activeBrowsers[proxyPort];
 
             // It seems maybe this can happen when firefox is just updated - it starts and
             // closes immediately, but loses some settings along the way. In that case, the 2nd
@@ -316,7 +323,7 @@ export class FreshFirefox implements Interceptor {
 
     async deactivate(proxyPort: number | string) {
         if (this.isActive(proxyPort)) {
-            const browser = browsers[proxyPort];
+            const browser = this.activeBrowsers[proxyPort];
             const closePromise = new Promise((resolve) => browser.process.once('close', resolve));
             browser.stop();
             await closePromise;
@@ -325,11 +332,41 @@ export class FreshFirefox implements Interceptor {
 
     async deactivateAll(): Promise<void> {
         await Promise.all(
-            Object.keys(browsers).map((proxyPort) => this.deactivate(proxyPort))
+            Object.keys(this.activeBrowsers).map((proxyPort) => this.deactivate(proxyPort))
         );
         if (profileSetupBrowser) {
             profileSetupBrowser.stop();
             return new Promise((resolve) => profileSetupBrowser!.process.once('close', resolve));
         }
     }
+};
+
+export class FreshFirefox extends Firefox {
+
+    id = 'fresh-firefox';
+    version = '1.2.0';
+
+    constructor(config: HtkConfig) {
+        super(config, 'firefox');
+    }
+};
+
+export class FreshFirefoxDeveloper extends Firefox {
+
+    id = 'fresh-firefox-dev';
+    version = '1.2.0';
+
+    constructor(config: HtkConfig) {
+        super(config, 'firefox-developer');
+    }
+};
+
+export class FreshFirefoxNightly extends Firefox {
+
+    id = 'fresh-firefox-nightly';
+    version = '1.2.0';
+
+    constructor(config: HtkConfig) {
+        super(config, 'firefox-nightly');
+    }
 };

src/interceptors/index.ts

@@ -4,7 +4,7 @@ import { HtkConfig } from '../config';
 import { addShutdownHandler } from '../shutdown';
 import { ErrorLike } from '../util/error';
 
-import { FreshFirefox } from './fresh-firefox';
+import { FreshFirefox, FreshFirefoxDeveloper, FreshFirefoxNightly } from './fresh-firefox';
 import {
     FreshChrome,
     ExistingChrome,
@@ -82,6 +82,8 @@ export function buildInterceptors(config: HtkConfig): _.Dictionary<Interceptor>
         new FreshOpera(config),
         new FreshBrave(config),
         new FreshFirefox(config),
+        new FreshFirefoxDeveloper(config),
+        new FreshFirefoxNightly(config),
 
         new FreshTerminalInterceptor(config),
         new ExistingTerminalInterceptor(config),

test/integration/e2e-api-test.spec.ts

@@ -264,7 +264,9 @@ describe('End-to-end server API test', function () {
             inactivable('fresh-edge-canary'),
             inactivable('fresh-opera', '1.0.3'),
             inactivable('fresh-brave'),
-            activable('fresh-firefox', '1.1.0'),
+            activable('fresh-firefox', '1.2.0'),
+            inactivable('fresh-firefox-dev', '1.2.0'),
+            inactivable('fresh-firefox-nightly', '1.2.0'),
             activable('fresh-terminal'),
             activable('existing-terminal'),
             activable('electron', '1.0.1'),