Refactor duplicated promisified fs wrappers into shared utils

pimterry · pimterry · commit 624c3211c4d1 · 2020-02-17T15:02:27.000+01:00
diff --git a/src/api-server.ts b/src/api-server.ts
@@ -10,7 +10,8 @@ import { Request, Response } from 'express';
 import { HtkConfig } from './config';
 import { reportError, addBreadcrumb } from './error-tracking';
 import { buildInterceptors, Interceptor } from './interceptors';
-import { ALLOWED_ORIGINS, delay } from './util';
+import { ALLOWED_ORIGINS } from './constants';
+import { delay } from './util';
 
 const packageJson = require('../package.json');
 
diff --git a/src/browsers.ts b/src/browsers.ts
@@ -7,10 +7,8 @@ import * as getBrowserLauncherCb from '@httptoolkit/browser-launcher';
 import { LaunchOptions, BrowserInstance, Browser } from '@httptoolkit/browser-launcher';
 
 import { reportError } from './error-tracking';
+import { readFile, statFile, deleteFile } from './util';
 
-const statFile = promisify(fs.stat);
-const readFile = promisify(fs.readFile);
-const deleteFile = promisify(fs.unlink);
 const getBrowserLauncher = promisify(getBrowserLauncherCb);
 
 const browserConfigPath = (configPath: string) => path.join(configPath, 'browsers.json');
diff --git a/src/cert-check-server.ts b/src/cert-check-server.ts
@@ -1,11 +1,7 @@
-import { promisify } from 'util';
-import * as fs from 'fs';
-
 import { getLocal, Mockttp } from 'mockttp';
 
 import { HttpsPathOptions } from 'mockttp/dist/util/tls';
-
-const readFile = promisify(fs.readFile);
+import { readFile } from './util';
 
 export class CertCheckServer {
 
diff --git a/src/commands/start.ts b/src/commands/start.ts
@@ -2,7 +2,7 @@
 type ErrorTrackingModule = typeof import('../error-tracking');
 type IndexTypeModule = typeof import('../index');
 
-import { IS_PROD_BUILD } from '../util';
+import { IS_PROD_BUILD } from '../constants';
 
 function maybeBundleImport<T>(moduleName: string): T {
     if (IS_PROD_BUILD || process.env.OCLIF_TS_NODE === '0') {
diff --git a/src/constants.ts b/src/constants.ts
@@ -0,0 +1,19 @@
+export const IS_PROD_BUILD = !!process.env.HTTPTOOLKIT_SERVER_BINPATH;
+
+export const ALLOWED_ORIGINS = IS_PROD_BUILD
+    ? [
+        // Prod builds only allow HTTPS app.httptoolkit.tech usage. This
+        // ensures that no other sites/apps can communicate with your server
+        // whilst you have the app open. If they could (requires an HTTP mitm),
+        // they would be able to start proxies & interceptors.
+        /^https:\/\/app\.httptoolkit\.tech$/
+    ]
+    : [
+        // Dev builds can use the main site, or local sites, even if those
+        // use HTTP. Note that HTTP here could technically open you to the risk
+        // above, but it'd require a DNS MitM too (to stop local.httptoolkit.tech
+        // resolving to localhost and never hitting the network).
+        /^https?:\/\/localhost(:\d+)?$/,
+        /^http:\/\/local\.httptoolkit\.tech(:\d+)?$/,
+        /^https:\/\/app\.httptoolkit\.tech$/
+    ]
diff --git a/src/error-tracking.ts b/src/error-tracking.ts
@@ -2,7 +2,7 @@ import * as path from 'path';
 import * as child_process from 'child_process';
 import * as Sentry from '@sentry/node';
 import { RewriteFrames } from '@sentry/integrations';
-import { IS_PROD_BUILD } from './util';
+import { IS_PROD_BUILD } from './constants';
 
 let sentryInitialized = false;
 
diff --git a/src/index.ts b/src/index.ts
@@ -11,17 +11,10 @@ import updateCommand from '@oclif/plugin-update/lib/commands/update';
 import { HttpToolkitServerApi } from './api-server';
 import { checkBrowserConfig } from './browsers';
 import { reportError } from './error-tracking';
-import { delay, ALLOWED_ORIGINS } from './util';
+import { ALLOWED_ORIGINS } from './constants';
+import { delay, readFile, checkAccess, writeFile, ensureDirectoryExists } from './util';
 import { registerShutdownHandler } from './shutdown';
 
-const canAccess = util.promisify(fs.access);
-const mkDir = util.promisify(fs.mkdir);
-const readFile = util.promisify(fs.readFile);
-const writeFile = util.promisify(fs.writeFile);
-
-const ensureDirectoryExists = (path: string) =>
-    canAccess(path).catch(() => mkDir(path, { recursive: true }));
-
 async function generateHTTPSConfig(configPath: string) {
     const keyPath = path.join(configPath, 'ca.key');
     const certPath = path.join(configPath, 'ca.pem');
@@ -31,7 +24,7 @@ async function generateHTTPSConfig(configPath: string) {
             checkCertExpiry(certContent);
             return certContent;
         }),
-        canAccess(keyPath, fs.constants.R_OK),
+        checkAccess(keyPath, fs.constants.R_OK),
     ]).catch(async () => {
         // Cert doesn't exist, or is too close/past expiry. Generate a new one:
 
diff --git a/src/interceptors/electron.ts b/src/interceptors/electron.ts
@@ -1,8 +1,6 @@
 import * as _ from 'lodash';
 import { spawn } from 'child_process';
-import * as util from 'util';
 import * as path from 'path';
-import * as fs from 'fs';
 
 import { getPortPromise as getPort } from 'portfinder';
 import { generateSPKIFingerprint } from 'mockttp';
@@ -11,13 +9,11 @@ import ChromeRemoteInterface = require('chrome-remote-interface');
 import { Interceptor } from '.';
 
 import { HtkConfig } from '../config';
-import { delay } from '../util';
+import { delay, readFile } from '../util';
 import { getTerminalEnvVars, OVERRIDES_DIR } from './terminal/terminal-env-overrides';
 import { reportError, addBreadcrumb } from '../error-tracking';
 import { findExecutableInApp } from '@httptoolkit/osx-find-executable';
 
-const readFile = util.promisify(fs.readFile);
-
 const isAppBundle = (path: string) => {
     return process.platform === "darwin" &&
         path.endsWith(".app");
diff --git a/src/interceptors/fresh-chrome.ts b/src/interceptors/fresh-chrome.ts
@@ -1,21 +1,14 @@
-import { promisify } from 'util';
-import * as fs from 'fs';
-import * as rimraf from 'rimraf';
-
 import * as _ from 'lodash';
 import { generateSPKIFingerprint } from 'mockttp';
 
 import { HtkConfig } from '../config';
 
 import { getAvailableBrowsers, launchBrowser, BrowserInstance, Browser } from '../browsers';
-import { delay } from '../util';
+import { delay, readFile, deleteFolder } from '../util';
 import { HideWarningServer } from '../hide-warning-server';
 import { Interceptor } from '.';
 import { reportError } from '../error-tracking';
 
-const readFile = promisify(fs.readFile);
-const deleteFolder = promisify(rimraf);
-
 let browsers: _.Dictionary<BrowserInstance> = {};
 
 // Which Chrome variant should we launch, and do we have one available at all?
diff --git a/src/interceptors/fresh-edge.ts b/src/interceptors/fresh-edge.ts
@@ -1,21 +1,14 @@
-import { promisify } from 'util';
-import * as fs from 'fs';
-import * as rimraf from 'rimraf';
-
 import * as _ from 'lodash';
 import { generateSPKIFingerprint } from 'mockttp';
 
 import { HtkConfig } from '../config';
 
 import { getAvailableBrowsers, launchBrowser, BrowserInstance, Browser } from '../browsers';
-import { delay } from '../util';
+import { delay, deleteFolder, readFile } from '../util';
 import { HideWarningServer } from '../hide-warning-server';
 import { Interceptor } from '.';
 import { reportError } from '../error-tracking';
 
-const readFile = promisify(fs.readFile);
-const deleteFolder = promisify(rimraf);
-
 let browsers: _.Dictionary<BrowserInstance> = {};
 
 // Which Edge variant should we launch, and do we have one available at all?
diff --git a/src/interceptors/fresh-firefox.ts b/src/interceptors/fresh-firefox.ts
@@ -1,24 +1,14 @@
-import { promisify } from 'util';
-import * as fs from 'fs';
 import * as _ from 'lodash';
-import * as rimraf from 'rimraf';
 import * as path from 'path';
 
 import { HtkConfig } from '../config';
 
 import { getAvailableBrowsers, launchBrowser, BrowserInstance } from '../browsers';
 import { CertCheckServer } from '../cert-check-server';
-import { delay, windowsKill } from '../util';
+import { delay, windowsKill, readFile, canAccess, deleteFolder } from '../util';
 import { Interceptor } from '.';
 import { reportError } from '../error-tracking';
 
-const deleteFolder = promisify(rimraf);
-const readFile = promisify(fs.readFile);
-const canAccess = (path: string) =>
-    new Promise((resolve) => {
-        fs.access(path, (error: Error | null) => resolve(!error));
-    });
-
 const FIREFOX_PREF_REGEX = /\w+_pref\("([^"]+)", (.*)\);/
 
 let certInstallBrowser: BrowserInstance | undefined;
diff --git a/src/interceptors/terminal/fresh-terminal-interceptor.ts b/src/interceptors/terminal/fresh-terminal-interceptor.ts
@@ -1,6 +1,4 @@
 import * as _ from 'lodash';
-import * as fs from 'fs';
-import * as util from 'util';
 import { spawn, ChildProcess, SpawnOptions } from 'child_process';
 import * as GSettings from 'node-gsettings-wrapper';
 import * as ensureCommandExists from 'command-exists';
@@ -10,14 +8,11 @@ import { findExecutableById } from '@httptoolkit/osx-find-executable';
 import { Interceptor } from '..';
 import { HtkConfig } from '../../config';
 import { reportError, addBreadcrumb } from '../../error-tracking';
-import { spawnToResult } from '../../util';
+import { spawnToResult, canAccess } from '../../util';
 
 import { getTerminalEnvVars } from './terminal-env-overrides';
 import { editShellStartupScripts, resetShellStartupScripts } from './terminal-scripts';
 
-const checkAccess = util.promisify(fs.access);
-const canAccess = (path: string) => checkAccess(path).then(() => true).catch(() => false);
-
 const commandExists = (path: string): Promise<boolean> => ensureCommandExists(path).then(() => true).catch(() => false);
 
 const DEFAULT_GIT_BASH_PATH = 'C:/Program Files/git/git-bash.exe';
diff --git a/src/interceptors/terminal/terminal-scripts.ts b/src/interceptors/terminal/terminal-scripts.ts
@@ -4,12 +4,10 @@ import * as util from 'util';
 import * as os from 'os';
 import * as path from 'path';
 
+import { canAccess, writeFile, renameFile, readFile } from '../../util';
 import { reportError } from '../../error-tracking';
 import { OVERRIDE_BIN_PATH } from './terminal-env-overrides';
 
-const checkAccess = util.promisify(fs.access);
-const canAccess = (path: string) => checkAccess(path).then(() => true).catch(() => false);
-
 // Generate POSIX paths for git-bash on Windows (or use the normal path everywhere else)
 const POSIX_OVERRIDE_BIN_PATH = process.platform === 'win32'
     ? OVERRIDE_BIN_PATH.replace(/\\/g, '/').replace(/^(\w+):/, (_all, driveLetter) => `/${driveLetter.toLowerCase()}`)
@@ -139,9 +137,6 @@ export const editShellStartupScripts = async () => {
     ).catch(reportError);
 };
 
-const readFile = util.promisify(fs.readFile);
-const writeFile = util.promisify(fs.writeFile);
-const renameFile = util.promisify(fs.rename);
 const removeConfigSectionsFromFile = async (path: string) => {
     let fileLines: string[];
 
diff --git a/src/util.ts b/src/util.ts
@@ -1,29 +1,12 @@
-import { spawn, SpawnOptions } from 'child_process';
+import { promisify } from 'util';
+import * as fs from 'fs';
+import * as rimraf from 'rimraf';
+import { spawn } from 'child_process';
 
 export function delay(durationMs: number): Promise<void> {
     return new Promise((resolve) => setTimeout(resolve, durationMs));
 }
 
-export const IS_PROD_BUILD = !!process.env.HTTPTOOLKIT_SERVER_BINPATH;
-
-export const ALLOWED_ORIGINS = IS_PROD_BUILD
-    ? [
-        // Prod builds only allow HTTPS app.httptoolkit.tech usage. This
-        // ensures that no other sites/apps can communicate with your server
-        // whilst you have the app open. If they could (requires an HTTP mitm),
-        // they would be able to start proxies & interceptors.
-        /^https:\/\/app\.httptoolkit\.tech$/
-    ]
-    : [
-        // Dev builds can use the main site, or local sites, even if those
-        // use HTTP. Note that HTTP here could technically open you to the risk
-        // above, but it'd require a DNS MitM too (to stop local.httptoolkit.tech
-        // resolving to localhost and never hitting the network).
-        /^https?:\/\/localhost(:\d+)?$/,
-        /^http:\/\/local\.httptoolkit\.tech(:\d+)?$/,
-        /^https:\/\/app\.httptoolkit\.tech$/
-    ]
-
 export async function windowsKill(processMatcher: string) {
     await spawn('wmic', [
         'Path', 'win32_process',
@@ -64,4 +47,20 @@ export function spawnToResult(command: string, args: string[] = [], inheritOutpu
             });
         });
     });
-};
+};
+
+export const statFile = promisify(fs.stat);
+export const readFile = promisify(fs.readFile);
+export const readDir = promisify(fs.readdir);
+export const deleteFile = promisify(fs.unlink);
+export const checkAccess = promisify(fs.access);
+export const mkDir = promisify(fs.mkdir);
+export const writeFile = promisify(fs.writeFile);
+export const renameFile = promisify(fs.rename);
+
+export const canAccess = (path: string) => checkAccess(path).then(() => true).catch(() => false);
+
+export const deleteFolder = promisify(rimraf);
+
+export const ensureDirectoryExists = (path: string) =>
+    checkAccess(path).catch(() => mkDir(path, { recursive: true }));
