fix: gracefull shutdown on watch/cache

Author: evenstensberg

package.json

@@ -41,7 +41,7 @@
     "test": "jest --reporters=default",
     "test:smoketests": "nyc node smoketests",
     "test:coverage": "nyc --no-clean jest",
-    "test:cli": "jest test --reporters=default",
+    "test:cli": "jest test/build/cache --reporters=default",
     "test:packages": "jest packages/ --reporters=default",
     "test:ci": "yarn test:cli && yarn test:packages",
     "test:watch": "jest test/ packages/ --watch",

packages/webpack-cli/src/webpack-cli.ts

@@ -2484,18 +2484,22 @@ class WebpackCLI implements IWebpackCLI {
 
     compiler = await this.createCompiler(options as WebpackDevServerOptions, callback);
 
-    if (!compiler) {
-      return;
-    }
+    if (!compiler) return;
 
     const isWatch = (compiler: WebpackCompiler): boolean =>
       Boolean(
         this.isMultipleCompiler(compiler)
           ? compiler.compilers.some((compiler) => compiler.options.watch)
           : compiler.options.watch,
       );
+    const isFileSystemCacheEnabled = (compiler: WebpackCompiler): boolean =>
+      Boolean(
+        this.isMultipleCompiler(compiler)
+          ? compiler.compilers.some((compiler) => compiler.options.cache)
+          : compiler.options.cache,
+      );
 
-    if (isWatch(compiler)) {
+    if (isWatch(compiler) || isFileSystemCacheEnabled(compiler)) {
       let needForceShutdown = false;
 
       for (const signal of EXIT_SIGNALS) {
@@ -2508,7 +2512,6 @@ class WebpackCLI implements IWebpackCLI {
           this.logger.info(
             "Gracefully shutting down. To force exit, press ^C again. Please wait...",
           );
-
           needForceShutdown = true;
 
           compiler.close(() => {

test/build/cache/cache.test.js

@@ -2,7 +2,7 @@
 
 const fs = require("node:fs");
 const path = require("node:path");
-const { run } = require("../../utils/test-utils");
+const { processKill, run, runAndGetProcess } = require("../../utils/test-utils");
 
 describe("cache", () => {
   it("should work", async () => {
@@ -218,4 +218,30 @@ describe("cache", () => {
     expect(stderr).toBeTruthy();
     expect(stdout).toBeTruthy();
   });
+
+  it("should gracefully exit when cache is true", (done) => {
+    fs.rmSync(path.join(__dirname, "../../../node_modules/.cache/webpack/graceful-exit-test"), {
+      recursive: true,
+      force: true,
+    });
+
+    const proc = runAndGetProcess(__dirname, [
+      "--config",
+      "./graceful-exit.webpack.config.js",
+      "--name",
+      "graceful-exit-test",
+    ]);
+    proc.stdout.on("data", (chunk) => {
+      const data = chunk.toString();
+      if (data.includes("app.bundle.js")) {
+        processKill(proc);
+        return;
+      }
+      expect(data).toContain(
+        "Gracefully shutting down. To force exit, press ^C again. Please wait...",
+      );
+    });
+
+    proc.on("exit", () => done());
+  });
 });

test/build/cache/graceful-exit.webpack.config.js

@@ -0,0 +1,40 @@
+const path = require("node:path");
+
+class InfiniteWaitPlugin {
+  constructor(options = {}) {
+    this.wait = options.wait || 10e3;
+  }
+
+  apply(compiler) {
+    compiler.hooks.done.tapPromise("Graceful Exit Test", async () => {
+      // eslint-disable-next-line no-new
+      new Promise((res) => {
+        setTimeout(res, this.wait);
+      });
+    });
+  }
+}
+
+module.exports = {
+  mode: "development",
+  name: "graceful-exit-test",
+  cache: {
+    type: "filesystem",
+    buildDependencies: {
+      config: [__filename],
+    },
+  },
+  infrastructureLogging: {
+    debug: /cache/,
+  },
+  entry: {
+    app: "./src/main.js",
+  },
+  output: {
+    filename: "[name].bundle.js",
+    chunkFilename: "[name].bundle.js",
+    path: path.resolve(__dirname, "dist"),
+    publicPath: "/",
+  },
+  plugins: [new InfiniteWaitPlugin()],
+};