Refactor APK fetch & terminal script setup to fully use fs utils

Author: pimterry

src/interceptors/android/fetch-apk.ts

@@ -1,10 +1,9 @@
-import * as fs from 'fs';
 import * as path from 'path';
 import * as stream from 'stream';
 import * as semver from 'semver';
 import fetch from 'node-fetch';
 
-import { readDir, createTmp, moveFile, deleteFile } from '../../util/fs';
+import * as fs from '../../util/fs';
 import { HtkConfig } from '../../config';
 import { logError } from '../../error-tracking';
 
@@ -30,7 +29,7 @@ async function getLatestRelease(): Promise<{ version: string, url: string } | un
 }
 
 async function getAllLocalApks(config: HtkConfig) {
-    const apks = (await readDir(config.configPath))
+    const apks = (await fs.readDir(config.configPath))
         .map(filename => filename.match(/^httptoolkit-(.*).apk$/))
         .filter((match): match is RegExpMatchArray => !!match)
         .map((match) => ({
@@ -68,7 +67,7 @@ async function updateLocalApk(
         path: tmpApk,
         fd: tmpApkFd,
         cleanupCallback
-    } = await createTmp({ keep: true });
+    } = await fs.createTmp({ keep: true });
 
     const tmpApkStream = fs.createWriteStream(tmpApk, { fd: tmpApkFd });
     apkStream.pipe(tmpApkStream);
@@ -88,15 +87,15 @@ async function updateLocalApk(
 
     console.log(`Local APK written to ${tmpApk}`);
 
-    await moveFile(tmpApk, path.join(config.configPath, `httptoolkit-${version}.apk`));
+    await fs.moveFile(tmpApk, path.join(config.configPath, `httptoolkit-${version}.apk`));
     console.log(`Local APK moved to ${path.join(config.configPath, `httptoolkit-${version}.apk`)}`);
     await cleanupOldApks(config);
 }
 
 export async function clearAllApks(config: HtkConfig) {
     const apks = await getAllLocalApks(config);
     console.log(`Deleting all APKs: ${apks.map(apk => apk.path).join(', ')}`);
-    return Promise.all(apks.map(apk => deleteFile(apk.path)));
+    return Promise.all(apks.map(apk => fs.deleteFile(apk.path)));
 }
 
 // Delete all but the most recent APK version in the config directory.
@@ -106,7 +105,7 @@ async function cleanupOldApks(config: HtkConfig) {
     console.log(`Deleting old APKs: ${apks.slice(1).map(apk => apk.path).join(', ')}`);
 
     return Promise.all(
-        apks.slice(1).map(apk => deleteFile(apk.path))
+        apks.slice(1).map(apk => fs.deleteFile(apk.path))
     );
 }
 

src/interceptors/terminal/terminal-scripts.ts

@@ -1,10 +1,9 @@
 import _ from 'lodash';
-import * as fs from 'fs';
 import * as util from 'util';
 import * as os from 'os';
 import * as path from 'path';
 
-import { canAccess, writeFile, moveFile, readFile, getRealPath } from '../../util/fs';
+import * as fs from '../../util/fs';
 import { logError } from '../../error-tracking';
 import { OVERRIDE_BIN_PATH } from './terminal-env-overrides';
 
@@ -15,16 +14,15 @@ const POSIX_OVERRIDE_BIN_PATH = process.platform === 'win32'
 
 const SHELL = (process.env.SHELL || '').split('/').slice(-1)[0];
 
-const appendOrCreateFile = util.promisify(fs.appendFile);
 const appendToFirstExisting = async (paths: string[], forceWrite: boolean, contents: string) => {
     for (let path of paths) {
         // Follow the path through symlinks (relatively common for terminal config):
-        const realPath = await getRealPath(path);
+        const realPath = await fs.getRealPath(path);
         if (!realPath) continue; // File (or linked file) does not exist
 
-        if (await canAccess(realPath)) {
+        if (await fs.canAccess(realPath)) {
             // Found our first valid readable file - append our extra config
-            return appendOrCreateFile(realPath, contents);
+            return fs.appendOrCreateFile(realPath, contents);
         }
 
         // ^ Small races here, if the file content/perms change between check and write, but
@@ -33,7 +31,7 @@ const appendToFirstExisting = async (paths: string[], forceWrite: boolean, conte
 
     if (forceWrite) {
         // If force write is set, write the last file anyway, even though it didn't exist before:
-        return appendOrCreateFile(paths.slice(-1)[0], contents);
+        return fs.appendOrCreateFile(paths.slice(-1)[0], contents);
     }
 };
 
@@ -196,19 +194,19 @@ export const editShellStartupScripts = async () => {
         [
             path.join(os.homedir(), '.config', 'fish', 'config.fish'),
         ],
-        SHELL === 'fish' || await canAccess(path.join(os.homedir(), '.config', 'fish')),
+        SHELL === 'fish' || await fs.canAccess(path.join(os.homedir(), '.config', 'fish')),
         FISH_SHELL_PATH_CONFIG
     ).catch(logError);
 };
 
 const removeConfigSectionsFromFile = async (path: string) => {
     let fileLines: string[];
 
-    const targetPath = await getRealPath(path); // Follow symlinks, if present
+    const targetPath = await fs.getRealPath(path); // Follow symlinks, if present
     if (!targetPath) return; // File doesn't exist, no need to clean it up
 
     try {
-        fileLines = (await readFile(targetPath, 'utf8')).split('\n');
+        fileLines = (await fs.readFile(targetPath, 'utf8')).split('\n');
     } catch (e) {
         // Silently skip any files we can't read
         return;
@@ -227,8 +225,8 @@ const removeConfigSectionsFromFile = async (path: string) => {
     // Write & rename to ensure this is atomic, and avoid races here
     // as much as we reasonably can.
     const tempFile = targetPath + Date.now() + '.temp';
-    await writeFile(tempFile, fileLines.join('\n'));
-    return moveFile(tempFile, targetPath);
+    await fs.writeFile(tempFile, fileLines.join('\n'));
+    return fs.moveFile(tempFile, targetPath);
 };
 
 // Cleanup: strip our extra config line from all config files

src/util/fs.ts

@@ -18,6 +18,10 @@ export const chmod = fs.promises.chmod;
 export const mkDir = fs.promises.mkdir;
 export const writeFile = fs.promises.writeFile;
 export const copyFile = fs.promises.copyFile;
+export const appendOrCreateFile = fs.promises.appendFile;
+
+export const createReadStream = fs.createReadStream;
+export const createWriteStream = fs.createWriteStream;
 
 export const copyRecursive = async (from: string, to: string) => {
     // fs.cp is only available in Node 16.7.0+