Add replace fs and fs-extra with fs/promises

Author: pmdartus

karma.conf.js

@@ -28,7 +28,6 @@ module.exports = function(config) {
                     "http-proxy-agent": require.resolve('./test/empty-stub.js'),
                     "https-proxy-agent": require.resolve('./test/empty-stub.js'),
                     "request-promise-native": require.resolve('./test/empty-stub.js'),
-                    "fs-extra": require.resolve('./test/empty-stub.js'),
                     "portfinder": require.resolve('./test/empty-stub.js'),
                     "dns2": require.resolve('./test/empty-stub.js'),
                     "ws": require.resolve('./test/empty-stub.js')

package.json

@@ -103,7 +103,6 @@
     "@types/connect": "3.4.35",
     "@types/dns2": "1.4.0",
     "@types/express": "4.17.13",
-    "@types/fs-extra": "8.1.0",
     "@types/graphql": "14.5.0",
     "@types/lodash": "4.14.178",
     "@types/mocha": "8.2.3",
@@ -127,7 +126,6 @@
     "dns2": "1.4.2",
     "form-data-encoder": "^1.7.2",
     "formdata-node": "^4.3.2",
-    "fs-extra": "^8.1.0",
     "http-proxy-agent": "^5.0.0",
     "karma": "^6.3.2",
     "karma-chai": "^0.1.0",

src/rules/requests/request-handlers.ts

@@ -5,6 +5,7 @@ import net = require('net');
 import tls = require('tls');
 import http = require('http');
 import https = require('https');
+import * as fs from 'fs/promises';
 import * as h2Client from 'http2-wrapper';
 import CacheableLookup from 'cacheable-lookup';
 import { decode as decodeBase64 } from 'base64-arraybuffer';
@@ -20,7 +21,6 @@ import {
 } from "../../types";
 
 import { MaybePromise } from '../../util/type-utils';
-import { readFile } from '../../util/fs';
 import {
     waitForCompletedRequest,
     buildBodyReader,
@@ -306,7 +306,7 @@ export class StreamHandler extends StreamHandlerDefinition {
 export class FileHandler extends FileHandlerDefinition {
     async handle(_request: OngoingRequest, response: OngoingResponse) {
         // Read the file first, to ensure we error cleanly if it's unavailable
-        const fileContents = await readFile(this.filePath, null);
+        const fileContents = await fs.readFile(this.filePath);
 
         if (this.headers) dropDefaultHeaders(response);
 
@@ -369,7 +369,7 @@ export class PassThroughHandler extends PassThroughHandlerDefinition {
                         if ('cert' in certObject) {
                             return certObject.cert.toString('utf8');
                         } else {
-                            return readFile(certObject.certPath, 'utf8');
+                            return fs.readFile(certObject.certPath, 'utf8');
                         }
                     }))
             );
@@ -505,7 +505,7 @@ export class PassThroughHandler extends PassThroughHandlerDefinition {
                 // this can result in sending a request much more quickly!
                 reqBodyOverride = asBuffer(replaceBody);
             } else if (replaceBodyFromFile) {
-                reqBodyOverride = await readFile(replaceBodyFromFile, null);
+                reqBodyOverride = await fs.readFile(replaceBodyFromFile);
             } else if (updateJsonBody) {
                 const { body: realBody } = await waitForCompletedRequest(clientReq);
                 if (await realBody.getJson() === undefined) {
@@ -783,7 +783,7 @@ export class PassThroughHandler extends PassThroughHandlerDefinition {
                         // this can result in sending a request much more quickly!
                         resBodyOverride = asBuffer(replaceBody);
                     } else if (replaceBodyFromFile) {
-                        resBodyOverride = await readFile(replaceBodyFromFile, null);
+                        resBodyOverride = await fs.readFile(replaceBodyFromFile);
                     } else if (updateJsonBody) {
                         const rawBody = await streamToBuffer(serverRes);
                         const realBody = buildBodyReader(rawBody, serverRes.headers);

src/rules/websockets/websocket-handlers.ts

@@ -3,6 +3,7 @@ import net = require('net');
 import * as url from 'url';
 import * as tls from 'tls';
 import * as http from 'http';
+import * as fs from 'fs/promises';
 import * as WebSocket from 'ws';
 import CacheableLookup from 'cacheable-lookup';
 
@@ -30,7 +31,6 @@ import {
 import { streamToBuffer } from '../../util/buffer-utils';
 import { isLocalhostAddress } from '../../util/socket-util';
 import { MaybePromise } from '../../util/type-utils';
-import { readFile } from '../../util/fs';
 
 import { getAgent } from '../http-agents';
 import { ProxySettingSource } from '../proxy-config';
@@ -200,7 +200,7 @@ export class PassThroughWebSocketHandler extends PassThroughWebSocketHandlerDefi
                         if ('cert' in certObject) {
                             return certObject.cert.toString('utf8');
                         } else {
-                            return readFile(certObject.certPath, 'utf8');
+                            return fs.readFile(certObject.certPath, 'utf8');
                         }
                     }))
             );

src/util/fs.ts

@@ -1,11 +1,10 @@
 import * as _ from 'lodash';
+import * as fs from 'fs/promises';
 import { v4 as uuid } from "uuid";
 import * as forge from 'node-forge';
 
 const { pki, md, util: { encode64 } } = forge;
 
-import * as fs from './fs';
-
 export type CAOptions = (CertDataOptions | CertPathOptions);
 
 export interface CertDataOptions extends BaseCAOptions {

src/util/tls.ts

@@ -1,9 +1,9 @@
 import * as https from 'https';
 import * as path from 'path';
+import * as fs from 'fs/promises';
 import * as forge from 'node-forge';
 
 import { expect, fetch, ignoreNetworkError, nodeOnly } from "./test-utils";
-import * as fs from '../src/util/fs';
 
 import { CA, generateCACertificate } from '../src/util/tls';
 

test/ca.spec.ts

@@ -1,7 +1,7 @@
-import * as fs from 'fs-extra';
 import * as http from 'http';
 import * as tls from 'tls';
 import * as https from 'https';
+import * as fs from 'fs/promises';
 
 import { getLocal } from "../..";
 import {
@@ -71,9 +71,9 @@ describe("When configured for HTTPS", () => {
 
             it("should use the default domain when no SNI is provided", async () => {
                 const tlsSocket = tls.connect({
-                    ca: fs.readFileSync('./test/fixtures/test-ca.pem'),
-                    key: fs.readFileSync('./test/fixtures/test-ca.key'),
-                    cert: fs.readFileSync('./test/fixtures/test-ca.pem'),
+                    ca: await fs.readFile('./test/fixtures/test-ca.pem'),
+                    key: await fs.readFile('./test/fixtures/test-ca.key'),
+                    cert: await fs.readFile('./test/fixtures/test-ca.pem'),
 
                     host: 'localhost',
                     port: server.port,
@@ -89,9 +89,9 @@ describe("When configured for HTTPS", () => {
 
             it("should still use the SNI name if one is provided", async () => {
                 const tlsSocket = tls.connect({
-                    ca: fs.readFileSync('./test/fixtures/test-ca.pem'),
-                    key: fs.readFileSync('./test/fixtures/test-ca.key'),
-                    cert: fs.readFileSync('./test/fixtures/test-ca.pem'),
+                    ca: await fs.readFile('./test/fixtures/test-ca.pem'),
+                    key: await fs.readFile('./test/fixtures/test-ca.key'),
+                    cert: await fs.readFile('./test/fixtures/test-ca.pem'),
 
                     host: 'localhost',
                     servername: 'sni-name.example', // <-- Set a name via SNI

test/integration/https.spec.ts

@@ -1,7 +1,7 @@
 import _ = require("lodash");
-import * as fs from 'fs-extra';
 import * as https from 'https';
 import * as http2 from 'http2';
+import * as fs from 'fs/promises';
 import * as semver from 'semver';
 import portfinder = require('portfinder');
 import request = require("request-promise-native");
@@ -107,12 +107,12 @@ nodeOnly(() => {
                 ]);
             });
 
-            describe("given an untrusted upstream certificate", () => {
+            describe("given an untrusted upstream certificate", async () => {
 
                 let badServer: Mockttp;
 
                 const certPath = './test/fixtures/untrusted-ca.pem';
-                const cert = fs.readFileSync(certPath);
+                const cert = await fs.readFile(certPath);
 
                 beforeEach(async () => {
                     badServer = getLocal({
@@ -384,8 +384,8 @@ nodeOnly(() => {
             beforeEach(async () => {
                 http2Server = makeDestroyable(http2.createSecureServer({
                     allowHTTP1: false,
-                    key: fs.readFileSync('./test/fixtures/test-ca.key'),
-                    cert: fs.readFileSync('./test/fixtures/test-ca.pem')
+                    key: await fs.readFile('./test/fixtures/test-ca.key'),
+                    cert: await fs.readFile('./test/fixtures/test-ca.pem')
                 }, async (req, res) => {
                     res.writeHead(200, {
                         "received-url": req.url,

test/integration/proxying/https-proxying.spec.ts

@@ -1,5 +1,5 @@
 import _ = require("lodash");
-import * as fs from 'fs-extra';
+import * as fs from 'fs/promises';
 import request = require("request-promise-native");
 
 import { getLocal, Mockttp, MockedEndpoint } from "../../..";