Merge PR #1 from shubham-kv/feat/clear-cache-cmd

feat: `clear-cache` command

Author: shubham-kv

src/actions.ts

@@ -1,12 +1,14 @@
 import { Command } from "@commander-js/extra-typings";
+import { existsSync } from "fs";
+import { rm } from "fs/promises";
 
 import { configureAndStartCacheProxy } from "./proxy";
 import { isIntegerString } from "./utils/string";
 import { cacheDirPath, testCacheDirPath } from "./constants";
 
 type StartCommand = Command<[string], { port: string }, {}>;
 
-export function startServer(this: StartCommand) {
+export function startServer(this: StartCommand): void {
   const [origin] = this.processedArgs;
   const { port } = this.opts();
 
@@ -32,3 +34,19 @@ export function startServer(this: StartCommand) {
       process.env.NODE_ENV === "test" ? testCacheDirPath : cacheDirPath,
   });
 }
+
+export async function clearCache(this: Command<[], {}, {}>): Promise<void> {
+  const cacheDir =
+    process.env.NODE_ENV === "test" ? testCacheDirPath : cacheDirPath;
+
+  if (existsSync(cacheDir)) {
+    try {
+      await rm(cacheDir, { force: true, recursive: true });
+      console.log('Cleared the cache successfully!');
+    } catch (e) {
+      this.error("Failed to remove the cache directory, try again");
+    }
+  } else {
+    this.error("Invalid cache directory");
+  }
+}

src/cli.ts

@@ -3,7 +3,7 @@
 import { Command } from "@commander-js/extra-typings";
 import { description, version } from "../package.json";
 
-import { startServer } from "./actions";
+import { clearCache, startServer } from "./actions";
 
 const program = new Command()
   .name("caching-proxy")
@@ -19,8 +19,13 @@ program
   )
   .requiredOption(
     "-p, --port <port>",
-    "Port number on which this server will run",
+    "Port number on which this server will run"
   )
   .action(startServer);
 
+program
+  .command("clear-cache")
+  .description("Clear the entire cache of the proxy server")
+  .action(clearCache);
+
 program.parse(process.argv);

test/app.spec.ts

@@ -1,7 +1,7 @@
 import { afterAll, beforeAll, describe, expect, test } from "vitest";
 import path from "path";
 import { existsSync, rmSync } from "fs";
-import { ChildProcessWithoutNullStreams, spawn } from "child_process";
+import { ChildProcessWithoutNullStreams, spawn, spawnSync } from "child_process";
 import axios, { AxiosInstance, AxiosResponse } from "axios";
 
 import { sampleData } from "./__fixtures__/sample-data";
@@ -11,6 +11,46 @@ import { testCacheDirPath } from "../src/constants";
 import { ReqResConfig, StartCommandOptions } from "./types";
 
 describe("caching-proxy-cli", () => {
+  const originHost = "localhost";
+  const originPort = 3000;
+  const originHref = `http://${originHost}:${originPort}`;
+  const proxyServerHost = "localhost";
+  const proxyPort = "4000";
+  const proxyHref = `http://${proxyServerHost}:${proxyPort}`;
+
+  const reqResConfigs: ReqResConfig[] = [
+    {
+      requestPath: "/api/sample-json",
+      responseContentType: "application/json",
+      responseData: sampleData.json,
+    },
+    {
+      requestPath: "/api/sample-xml",
+      responseContentType: "application/xml",
+      responseData: sampleData.xml,
+    },
+    {
+      requestPath: "/api/sample-plain-txt",
+      responseContentType: "text/plain",
+      responseData: sampleData.plainTxt,
+    },
+    {
+      requestPath: "/public/sample-html",
+      responseContentType: "text/html",
+      responseData: sampleData.html,
+    },
+    {
+      requestPath: "/public/sample-styles.css",
+      responseContentType: "text/css",
+      responseData: sampleData.css,
+    },
+    {
+      requestPath: "/public/sample-script",
+      responseContentType: "application/javascript",
+      responseData: sampleData.javascript,
+    },
+  ];
+
   describe("start command with invalid options", () => {
     const invalidOptions: StartCommandOptions[] = [
       { origin: "", port: "" },
@@ -67,13 +107,6 @@ describe("caching-proxy-cli", () => {
   });
 
   describe("start command with valid options", () => {
-    const originHost = "localhost";
-    const originPort = 3000;
-    const originHref = `http://${originHost}:${originPort}`;
-    const proxyServerHost = "localhost";
-    const proxyPort = "4000";
-    const proxyHref = `http://${proxyServerHost}:${proxyPort}`;
-
     let proxyChildProcess: ChildProcessWithoutNullStreams;
 
     setupMockServer({ host: originHost, port: originPort });
@@ -120,39 +153,6 @@ describe("caching-proxy-cli", () => {
       });
     });
 
-    const reqResConfigs: ReqResConfig[] = [
-      {
-        requestPath: "/api/sample-json",
-        responseContentType: "application/json",
-        responseData: sampleData.json,
-      },
-      {
-        requestPath: "/api/sample-xml",
-        responseContentType: "application/xml",
-        responseData: sampleData.xml,
-      },
-      {
-        requestPath: "/api/sample-plain-txt",
-        responseContentType: "text/plain",
-        responseData: sampleData.plainTxt,
-      },
-      {
-        requestPath: "/public/sample-html",
-        responseContentType: "text/html",
-        responseData: sampleData.html,
-      },
-      {
-        requestPath: "/public/sample-styles.css",
-        responseContentType: "text/css",
-        responseData: sampleData.css,
-      },
-      {
-        requestPath: "/public/sample-script",
-        responseContentType: "application/javascript",
-        responseData: sampleData.javascript,
-      },
-    ];
-
     describe.each(reqResConfigs)(
       "when proxy server is fetched for $responseContentType response content type API",
       (config) => {
@@ -220,4 +220,79 @@ describe("caching-proxy-cli", () => {
       }
     );
   });
+
+  describe("'clear-cache' command", () => {
+    let proxyChildProcess: ChildProcessWithoutNullStreams;
+
+    setupMockServer({ host: originHost, port: originPort });
+
+    beforeAll(async () => {
+      proxyChildProcess = spawn("ts-node", [
+        path.join(__dirname, "../src/cli.ts"),
+        "start",
+        originHref,
+        "-p",
+        proxyPort,
+      ]);
+
+      // Wait for the proxy server to start
+      await new Promise<void>((resolve, reject) => {
+        const timeout = 5 * 1000;
+
+        proxyChildProcess.stdout.once("data", (chunk: any) => {
+          const data = chunk.toString();
+
+          if (/caching proxy running/gi.test(data)) {
+            resolve();
+          } else {
+            reject(new Error("Unexpected stdout data"));
+          }
+        });
+
+        setTimeout(() => {
+          const err = new Error(
+            `Failed to receive proxyChildProcess.stdout 'data' event within ${
+              timeout / 1000
+            }s`
+          );
+          reject(err);
+        }, timeout);
+      });
+
+      // Make a request to have something in cache directory to delete
+      const axiosInstance = axios.create({
+        baseURL: proxyHref,
+      });
+
+      try {
+        await axiosInstance.get(reqResConfigs[0].requestPath);
+      } catch (e) {
+        throw e;
+      }
+    });
+
+    afterAll(() => {
+      const res = proxyChildProcess?.kill("SIGTERM");
+      console.log(
+        `Kill ${res ? "succeeded" : "failed"} for the spawned process`
+      );
+    });
+
+    describe("when 'clear-cache' command is executed", () => {
+      let data: string | undefined = undefined
+
+      beforeAll(() => {
+        const buffer = spawnSync("ts-node", [
+          path.join(__dirname, "../src/cli.ts"),
+          "clear-cache",
+        ]);
+
+        data = buffer.stdout.toString()
+      })
+
+      test("should clear the cache directory", () => {
+        expect(data).toMatch(/cleared the cache successfully/gi)
+      });
+    });
+  });
 });