Merge pull request #1031 from thefrontside/tm/no-sigterm-windows

Do not bind SIGTERM in Windows

Author: taras

.gitattributes

@@ -0,0 +1,20 @@
+# Set default line ending behavior
+* text=auto
+
+# Explicitly set line endings for text files
+*.ts text eol=lf
+*.mjs text eol=lf
+*.js text eol=lf
+*.json text eol=lf
+*.md text eol=lf
+*.yml text eol=lf
+*.yaml text eol=lf
+
+# Binary files
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.gif binary
+*.ico binary
+*.woff binary
+*.woff2 binary

.github/workflows/verify.yaml

@@ -11,7 +11,11 @@ permissions:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    runs-on: ${{ matrix.os }}
 
     steps:
       - name: checkout
@@ -34,7 +38,14 @@ jobs:
       - name: lint
         run: deno lint
 
-      - name: test
+      - name: test (Windows)
+        if: runner.os == 'Windows'
+        run: deno task test
+        shell: cmd
+
+      - name: test (Unix)
+        if: runner.os != 'Windows'
         run: deno task test
+
       - name: test:node
         run: deno task test:node

deno.json

@@ -7,7 +7,7 @@
   },
   "lock": false,
   "tasks": {
-    "test": "deno test --allow-run=deno",
+    "test": "deno test --allow-run --allow-ffi",
     "test:node": "deno task build:npm 0.0.0 && node test/main/node.mjs hello world",
     "build:jsr": "deno run -A tasks/build-jsr.ts",
     "build:npm": "deno run -A tasks/build-npm.ts"
@@ -20,7 +20,8 @@
       "build",
       "website",
       "www",
-      "packages"
+      "packages",
+      "docs/*.ts"
     ]
   },
   "fmt": {
@@ -46,5 +47,12 @@
       "dom",
       "dom.iterable"
     ]
+  },
+  "imports": {
+    "@deno/dnt": "jsr:@deno/[email protected]",
+    "ctrlc-windows": "npm:[email protected]",
+    "@std/testing": "jsr:@std/testing@^1",
+    "@std/expect": "jsr:@std/expect@^1",
+    "ts-expect": "npm:[email protected]"
   }
 }

lib/main.ts

@@ -83,11 +83,18 @@ export async function main(
             hardexit = (status) => Deno.exit(status);
             try {
               Deno.addSignalListener("SIGINT", interrupt.SIGINT);
-              Deno.addSignalListener("SIGTERM", interrupt.SIGTERM);
+              /**
+               * Windows only supports ctrl-c (SIGINT), ctrl-break (SIGBREAK), and ctrl-close (SIGUP)
+               */
+              if (Deno.build.os !== "windows") {
+                Deno.addSignalListener("SIGTERM", interrupt.SIGTERM);
+              }
               yield* body(Deno.args.slice());
             } finally {
               Deno.removeSignalListener("SIGINT", interrupt.SIGINT);
-              Deno.removeSignalListener("SIGTERM", interrupt.SIGTERM);
+              if (Deno.build.os !== "windows") {
+                Deno.removeSignalListener("SIGTERM", interrupt.SIGTERM);
+              }
             }
           },
           *node() {
@@ -99,11 +106,15 @@ export async function main(
             hardexit = (status) => process.exit(status);
             try {
               process.on("SIGINT", interrupt.SIGINT);
-              process.on("SIGTERM", interrupt.SIGTERM);
+              if (process.platform !== "win32") {
+                process.on("SIGTERM", interrupt.SIGTERM);
+              }
               yield* body(process.argv.slice(2));
             } finally {
               process.off("SIGINT", interrupt.SIGINT);
-              process.off("SIGTERM", interrupt.SIGINT);
+              if (process.platform !== "win32") {
+                process.off("SIGTERM", interrupt.SIGINT);
+              }
             }
           },
           *browser() {

tasks/build-npm.ts

@@ -1,4 +1,4 @@
-import { build, emptyDir } from "jsr:@deno/dnt@0.41.3";
+import { build, emptyDir } from "@deno/dnt";
 
 const outDir = "./build/npm";
 

test/main.test.ts

@@ -21,24 +21,26 @@ describe("main", () => {
     });
   });
 
-  it("gracefully shuts down on SIGTERM", async () => {
-    await run(function* () {
-      let daemon = yield* useCommand("deno", {
-        stdout: "piped",
-        args: ["run", "test/main/ok.daemon.ts"],
-      });
-      let stdout = yield* buffer(daemon.stdout);
-      yield* detect(stdout, "started");
+  if (Deno.build.os !== "windows") {
+    it("gracefully shuts down on SIGTERM", async () => {
+      await run(function* () {
+        let daemon = yield* useCommand("deno", {
+          stdout: "piped",
+          args: ["run", "test/main/ok.daemon.ts"],
+        });
+        let stdout = yield* buffer(daemon.stdout);
+        yield* detect(stdout, "started");
 
-      daemon.kill("SIGTERM");
+        daemon.kill("SIGTERM");
 
-      let status = yield* daemon.status;
+        let status = yield* daemon.status;
 
-      expect(status.code).toBe(143);
+        expect(status.code).toBe(143);
 
-      yield* detect(stdout, "gracefully stopped");
+        yield* detect(stdout, "gracefully stopped");
+      });
     });
-  });
+  }
 
   it("exits gracefully on explicit exit()", async () => {
     await run(function* () {

test/suite.ts

@@ -1,15 +1,9 @@
-export * from "https://deno.land/[email protected]/testing/bdd.ts";
-export { expect } from "jsr:@std/expect";
-export { expectType } from "https://esm.sh/ts-expect@1.3.0?pin=v123";
+export * from "@std/testing/bdd";
+export { expect } from "@std/expect";
+export { expectType } from "ts-expect";
 
-import {
-  action,
-  call,
-  type Operation,
-  resource,
-  sleep,
-  spawn,
-} from "../mod.ts";
+import { ctrlc } from "ctrlc-windows";
+import { action, type Operation, resource, sleep, spawn } from "../mod.ts";
 
 declare global {
   interface Promise<T> extends Operation<T> {}
@@ -83,12 +77,26 @@ export function useCommand(
   return resource(function* (provide) {
     let command = new Deno.Command(cmd, options);
     let process = command.spawn();
+
+    if (Deno.build.os === "windows") {
+      // Wrap the kill method to use ctrlc-windows on Windows
+      // See: https://github.com/denoland/deno/issues/29599
+      const originalKill = process.kill.bind(process);
+      process.kill = (signal) => {
+        if (signal === "SIGINT") {
+          ctrlc(process.pid);
+        } else {
+          originalKill(signal);
+        }
+      };
+    }
+
     try {
       yield* provide(process);
     } finally {
       try {
         process.kill("SIGINT");
-        yield* call(process.status);
+        yield* process.status;
       } catch (error) {
         // if the process already quit, then this error is expected.
         // unfortunately there is no way (I know of) to check this