feat: stable types node and exit hooks (#18899)

* feat: stabilise @types/node version * feat: type-safe ExitHooks.ts * chore: update pnpm-lock.yaml * feat(engine-core): split event and signal exit hook into two separate hooks * chore: re-create pnpm-lock.yaml
prisma · Apr 28, 2023 · ccf3df0 · ccf3df0
1 parent 7773098
commit ccf3df0
Show file tree

Hide file tree

Showing 19 changed files with 97 additions and 296 deletions.
diff --git a/packages/debug/package.json b/packages/debug/package.json
@@ -15,7 +15,7 @@
   "bugs": "https://github.com/prisma/prisma/issues",
   "devDependencies": {
     "@types/jest": "29.4.0",
-    "@types/node": "12.20.55",
+    "@types/node": "14.18.42",
     "esbuild": "0.15.13",
     "jest": "29.4.3",
     "jest-junit": "15.0.0",

diff --git a/packages/engine-core/package.json b/packages/engine-core/package.json
@@ -17,7 +17,7 @@
     "@swc/core": "1.3.32",
     "@swc/jest": "0.2.24",
     "@types/jest": "29.4.0",
-    "@types/node": "16.18.23",
+    "@types/node": "14.18.42",
     "esbuild": "0.15.13",
     "jest": "29.4.3",
     "jest-junit": "15.0.0",

diff --git a/packages/engine-core/src/library/ExitHooks.ts b/packages/engine-core/src/library/ExitHooks.ts
@@ -1,4 +1,5 @@
 import Debug from '@prisma/debug'
+import os from 'os'
 
 export type BeforeExitListener = () => Promise<void> | void
 
@@ -15,11 +16,11 @@ export class ExitHooks {
       return
     }
 
-    this.installHook('beforeExit')
-    this.installHook('exit')
-    this.installHook('SIGINT', true)
-    this.installHook('SIGUSR2', true)
-    this.installHook('SIGTERM', true)
+    this.installExitEventHook('beforeExit')
+    this.installExitEventHook('exit')
+    this.installExitSignalHook('SIGINT')
+    this.installExitSignalHook('SIGUSR2')
+    this.installExitSignalHook('SIGTERM')
     this.areHooksInstalled = true
   }
 
@@ -48,20 +49,34 @@ export class ExitHooks {
     return this.idToListenerMap.get(id)
   }
 
-  private installHook(event: string, shouldExit = false) {
-    process.once(event, async (code) => {
-      debug(`exit event received: ${event}`)
-      for (const listener of this.idToListenerMap.values()) {
-        await listener()
-      }
+  private installExitEventHook(event: 'beforeExit' | 'exit') {
+    // Note: TypeScript isn't able to narrow type arguments on overloaded functions.
+    process.once(event as any, this.exitLikeHook)
+  }
 
-      this.idToListenerMap.clear()
+  private installExitSignalHook(signal: NodeJS.Signals) {
+    process.once(signal, async (signal) => {
+      await this.exitLikeHook(signal)
+      const isSomeoneStillListening = process.listenerCount(signal) > 0
 
-      // only exit, if only we are listening
-      // if there is another listener, that other listener is responsible
-      if (shouldExit && process.listenerCount(event) === 0) {
-        process.exit(code)
+      // Only exit when there are no listeners left for this signal.
+      // If there is another listener, that other listener is responsible for exiting.
+      if (isSomeoneStillListening) {
+        return
       }
+
+      // the usual way to exit with a signal is to add 128 to the signal number
+      const exitCode = os.constants.signals[signal] + 128
+      process.exit(exitCode)
     })
   }
+
+  private exitLikeHook = async (event: 'beforeExit' | 'exit' | NodeJS.Signals) => {
+    debug(`exit event received: ${event}`)
+    for (const listener of this.idToListenerMap.values()) {
+      await listener()
+    }
+
+    this.idToListenerMap.clear()
+  }
 }
diff --git a/packages/engines/package.json b/packages/engines/package.json
@@ -14,7 +14,7 @@
     "@swc/core": "1.3.32",
     "@swc/jest": "0.2.24",
     "@types/jest": "29.4.0",
-    "@types/node": "16.18.23",
+    "@types/node": "14.18.42",
     "execa": "5.1.1",
     "jest": "29.4.3",
     "typescript": "4.9.5"

diff --git a/packages/fetch-engine/package.json b/packages/fetch-engine/package.json
@@ -19,7 +19,7 @@
     "@swc/core": "1.3.32",
     "@swc/jest": "0.2.24",
     "@types/jest": "29.4.0",
-    "@types/node": "16.18.23",
+    "@types/node": "14.18.42",
     "@types/node-fetch": "2.6.3",
     "@types/progress": "2.0.5",
     "del": "6.1.1",

diff --git a/packages/generator-helper/package.json b/packages/generator-helper/package.json
@@ -31,7 +31,7 @@
     "@swc/core": "1.3.32",
     "@swc/jest": "0.2.24",
     "@types/jest": "29.4.0",
-    "@types/node": "12.20.55",
+    "@types/node": "14.18.42",
     "esbuild": "0.15.13",
     "jest": "29.4.3",
     "jest-junit": "15.0.0",

diff --git a/packages/get-platform/package.json b/packages/get-platform/package.json
@@ -17,7 +17,7 @@
     "@swc/core": "1.3.32",
     "@swc/jest": "0.2.24",
     "@types/jest": "29.4.0",
-    "@types/node": "16.18.23",
+    "@types/node": "14.18.42",
     "jest": "29.4.3",
     "jest-junit": "15.0.0",
     "typescript": "4.9.5"

diff --git a/packages/instrumentation/package.json b/packages/instrumentation/package.json
@@ -14,7 +14,7 @@
   "bugs": "https://github.com/prisma/prisma/issues",
   "devDependencies": {
     "@swc/core": "1.3.32",
-    "@types/node": "16.18.23",
+    "@types/node": "14.18.42",
     "typescript": "4.9.5",
     "jest": "29.4.3",
     "jest-junit": "15.0.0",

diff --git a/packages/integration-tests/package.json b/packages/integration-tests/package.json
@@ -20,7 +20,7 @@
     "@swc/jest": "0.2.24",
     "@types/jest": "29.4.0",
     "@types/mssql": "8.1.2",
-    "@types/node": "12.20.55",
+    "@types/node": "14.18.42",
     "@types/pg": "8.6.6",
     "@types/sqlite3": "3.1.8",
     "decimal.js": "10.4.3",

diff --git a/packages/migrate/package.json b/packages/migrate/package.json
@@ -23,7 +23,7 @@
     "@swc/core": "1.3.32",
     "@swc/jest": "0.2.24",
     "@types/jest": "29.4.0",
-    "@types/node": "12.20.55",
+    "@types/node": "14.18.42",
     "@types/pg": "8.6.6",
     "@types/prompts": "2.4.4",
     "@types/sqlite3": "3.1.8",

diff --git a/packages/migrate/src/__tests__/fixtures/seed-sqlite-custom-ts-node/package.json b/packages/migrate/src/__tests__/fixtures/seed-sqlite-custom-ts-node/package.json
@@ -6,6 +6,6 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "14.14.21"
+    "@types/node": "14.18.42"
   }
 }
diff --git a/packages/migrate/src/__tests__/fixtures/seed-sqlite-js/package.json b/packages/migrate/src/__tests__/fixtures/seed-sqlite-js/package.json
@@ -3,7 +3,7 @@
   "version": "1.0.0",
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "14.14.21"
+    "@types/node": "14.18.42"
   },
   "prisma": {
     "seed": "node prisma/seed.js"

diff --git a/packages/migrate/src/__tests__/fixtures/seed-sqlite-legacy-custom-ts-node/package.json b/packages/migrate/src/__tests__/fixtures/seed-sqlite-legacy-custom-ts-node/package.json
@@ -6,6 +6,6 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "14.14.21"
+    "@types/node": "14.18.42"
   }
 }
diff --git a/packages/migrate/src/__tests__/fixtures/seed-sqlite-legacy/package.json b/packages/migrate/src/__tests__/fixtures/seed-sqlite-legacy/package.json
@@ -3,6 +3,6 @@
   "version": "1.0.0",
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "14.14.21"
+    "@types/node": "14.18.42"
   }
 }
diff --git a/packages/migrate/src/__tests__/fixtures/seed-sqlite-sh/package.json b/packages/migrate/src/__tests__/fixtures/seed-sqlite-sh/package.json
@@ -3,7 +3,7 @@
   "version": "1.0.0",
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "14.14.21"
+    "@types/node": "14.18.42"
   },
   "prisma": {
     "seed": "./prisma/seed.sh"

diff --git a/packages/migrate/src/__tests__/fixtures/seed-sqlite-ts-esm/package.json b/packages/migrate/src/__tests__/fixtures/seed-sqlite-ts-esm/package.json
@@ -4,7 +4,7 @@
   "license": "MIT",
   "type": "module",
   "devDependencies": {
-    "@types/node": "14.14.21",
+    "@types/node": "14.18.42",
     "ts-node": "10",
     "typescript": "4.7.4"
   },

diff --git a/packages/migrate/src/__tests__/fixtures/seed-sqlite-ts/package.json b/packages/migrate/src/__tests__/fixtures/seed-sqlite-ts/package.json
@@ -3,7 +3,7 @@
   "version": "1.0.0",
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "14.14.21"
+    "@types/node": "14.18.42"
   },
   "prisma": {
     "seed": "ts-node prisma/seed.ts"

diff --git a/packages/migrate/src/__tests__/fixtures/seed-sqlite/package.json b/packages/migrate/src/__tests__/fixtures/seed-sqlite/package.json
@@ -3,6 +3,6 @@
   "version": "1.0.0",
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "14.14.21"
+    "@types/node": "14.18.42"
   }
 }