@andrew_l/graceful 0.3.22 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +7 -2
- package/dist/index.d.mts.map +1 -0
- package/dist/index.mjs +89 -129
- package/dist/index.mjs.map +1 -1
- package/package.json +9 -8
- package/dist/index.cjs +0 -156
- package/dist/index.cjs.map +0 -1
- package/dist/index.d.cts +0 -48
- package/dist/index.d.ts +0 -48
package/dist/index.d.mts
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
type HandlerError = (err: Error) => void;
|
|
2
2
|
type Handler<returnType = unknown> = () => Promise<returnType> | returnType;
|
|
3
3
|
type CancelCallback = () => void;
|
|
4
|
+
/**
|
|
5
|
+
* Returns true when process received shutdown signal
|
|
6
|
+
* @group Main
|
|
7
|
+
*/
|
|
8
|
+
declare function isShuttingDown(): boolean;
|
|
4
9
|
/**
|
|
5
10
|
* Gracefully terminate application's modules on shutdown.
|
|
6
11
|
* @param handler - Async or sync function which handles shutdown.
|
|
@@ -44,5 +49,5 @@ declare function onShutdown(name: string, dependencies: string[], handler: Handl
|
|
|
44
49
|
*/
|
|
45
50
|
declare function onShutdownError(callback: HandlerError): CancelCallback;
|
|
46
51
|
declare function processGraceful(signal?: NodeJS.Signals): void;
|
|
47
|
-
|
|
48
|
-
|
|
52
|
+
export { isShuttingDown, onShutdown, onShutdownError, processGraceful };
|
|
53
|
+
//# sourceMappingURL=index.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.mts","names":["Error","err","returnType","Promise","Handler","handler","CancelCallback","name","dependencies","HandlerError","callback","NodeJS","Signals","signal"],"sources":["../src/index.d.ts"],"mappings":"KAAK,YAAA,IAAgBC,GAAU,EAAL,KAAK;AAAA,KAC1B,OAAA,+BAAsC,OAAA,CAAQ,UAAA,IAAc,UAAA;AAAA,KAC5D,cAAA;;AAF0B;AAAA;;iBAOP,cAAA;;;;;iBAKA,UAAA,CAAWI,OAAAA,EAAS,OAAA,GAAU,cAAc;;;;;;iBAM5C,UAAA,CAAWE,IAAAA,UAAcF,OAAAA,EAAS,OAAA,GAAU,cAAc;AAjBP;;;;AACxD;AADwD,iBAuBnD,UAAA,CAAWG,YAAAA,YAAwBH,OAAAA,EAAS,OAAA,GAAU,cAAc;;;;AAjBtD;AAKtC;;;;;;;;AAAoE;AAMpE;;;;;;;iBA2BwB,UAAA,CAAWE,IAAAA,UAAcC,YAAAA,YAAwBH,OAAAA,EAAS,OAAA,GAAU,cAAc;;AA3BxB;AAMlF;iBAyBwB,eAAA,CAAgBK,QAAAA,EAAU,YAAA,GAAe,cAAc;AAAA,iBACvD,eAAA,CAAgBG,MAAAA,GAAS,MAAA,CAAO,OAAO"}
|
package/dist/index.mjs
CHANGED
|
@@ -1,152 +1,112 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
1
|
+
import { asyncForEach, defer, isFunction, isString, logger, noop } from "@andrew_l/toolkit";
|
|
3
2
|
const log = logger("Graceful Shutdown");
|
|
4
|
-
const HANDLED_EVENTS = Object.freeze([
|
|
3
|
+
const HANDLED_EVENTS = Object.freeze([
|
|
4
|
+
"SIGINT",
|
|
5
|
+
"SIGTERM",
|
|
6
|
+
"SIGQUIT"
|
|
7
|
+
]);
|
|
5
8
|
const DEPENDENCY_TREE = /* @__PURE__ */ new Map();
|
|
6
9
|
const DEPENDENCY_MAP = /* @__PURE__ */ new WeakMap();
|
|
7
10
|
const HANDLERS_MAP = /* @__PURE__ */ new Map();
|
|
8
11
|
const SHUTDOWN_ERROR_HANDLERS = [];
|
|
9
12
|
let shuttingDown = false;
|
|
13
|
+
function isShuttingDown() {
|
|
14
|
+
return shuttingDown;
|
|
15
|
+
}
|
|
10
16
|
function onShutdown(...args) {
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
if (!HANDLERS_MAP.has(name)) {
|
|
34
|
-
HANDLERS_MAP.set(name, []);
|
|
35
|
-
}
|
|
36
|
-
HANDLERS_MAP.get(name).push(handler);
|
|
37
|
-
return () => {
|
|
38
|
-
const handlersList = (HANDLERS_MAP.get(name) ?? []).filter(
|
|
39
|
-
(v) => v !== handler
|
|
40
|
-
);
|
|
41
|
-
if (!handlersList.length) {
|
|
42
|
-
HANDLERS_MAP.delete(name);
|
|
43
|
-
}
|
|
44
|
-
const renewDependencies = new Set(
|
|
45
|
-
handlersList.map((v) => DEPENDENCY_MAP.get(v)).flat().filter(isString)
|
|
46
|
-
);
|
|
47
|
-
if (renewDependencies.size) {
|
|
48
|
-
DEPENDENCY_TREE.set(name, renewDependencies);
|
|
49
|
-
} else {
|
|
50
|
-
DEPENDENCY_TREE.delete(name);
|
|
51
|
-
}
|
|
52
|
-
DEPENDENCY_MAP.delete(handler);
|
|
53
|
-
};
|
|
17
|
+
const [_name, _dependencies, _handler] = args;
|
|
18
|
+
const handler = isFunction(_name) ? _name : isFunction(_dependencies) ? _dependencies : _handler;
|
|
19
|
+
const dependencies = Array.isArray(_name) ? _name : Array.isArray(_dependencies) ? _dependencies : [];
|
|
20
|
+
const name = isString(_name) ? _name : Math.random().toString(36);
|
|
21
|
+
if (shuttingDown) {
|
|
22
|
+
log.warn("Warn! Attempt to register handler while processing terminating: %s", name);
|
|
23
|
+
return noop;
|
|
24
|
+
}
|
|
25
|
+
if (dependencies.reduce((acc, dep) => acc || testForCycles(dep), false)) throw new Error(`Adding shutdown handler "${name}" will create a dependency loop: aborting`);
|
|
26
|
+
log.debug("Register handler: %s", name);
|
|
27
|
+
DEPENDENCY_TREE.set(name, /* @__PURE__ */ new Set([...DEPENDENCY_TREE.get(name) || [], ...dependencies]));
|
|
28
|
+
DEPENDENCY_MAP.set(handler, dependencies);
|
|
29
|
+
if (!HANDLERS_MAP.has(name)) HANDLERS_MAP.set(name, []);
|
|
30
|
+
HANDLERS_MAP.get(name).push(handler);
|
|
31
|
+
return () => {
|
|
32
|
+
const handlersList = (HANDLERS_MAP.get(name) ?? []).filter((v) => v !== handler);
|
|
33
|
+
if (!handlersList.length) HANDLERS_MAP.delete(name);
|
|
34
|
+
const renewDependencies = new Set(handlersList.map((v) => DEPENDENCY_MAP.get(v)).flat().filter(isString));
|
|
35
|
+
if (renewDependencies.size) DEPENDENCY_TREE.set(name, renewDependencies);
|
|
36
|
+
else DEPENDENCY_TREE.delete(name);
|
|
37
|
+
DEPENDENCY_MAP.delete(handler);
|
|
38
|
+
};
|
|
54
39
|
}
|
|
55
40
|
function onShutdownError(callback) {
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
}
|
|
62
|
-
};
|
|
41
|
+
SHUTDOWN_ERROR_HANDLERS.push(callback);
|
|
42
|
+
return () => {
|
|
43
|
+
const idx = SHUTDOWN_ERROR_HANDLERS.indexOf(callback);
|
|
44
|
+
if (idx > -1) SHUTDOWN_ERROR_HANDLERS.splice(idx, 1);
|
|
45
|
+
};
|
|
63
46
|
}
|
|
64
47
|
function processGraceful(signal = "SIGTERM") {
|
|
65
|
-
|
|
66
|
-
|
|
48
|
+
log.debug("Force with signal: %s", signal);
|
|
49
|
+
process.emit("SIGTERM", signal);
|
|
67
50
|
}
|
|
68
51
|
async function shutdown(name, promisesMap) {
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
}
|
|
97
|
-
},
|
|
98
|
-
{ concurrency: 10 }
|
|
99
|
-
);
|
|
100
|
-
clearTimeout(timeoutInterval);
|
|
101
|
-
}
|
|
102
|
-
} catch (err) {
|
|
103
|
-
lastError = err;
|
|
104
|
-
}
|
|
105
|
-
if (lastError) {
|
|
106
|
-
q.reject(lastError);
|
|
107
|
-
} else {
|
|
108
|
-
q.resolve();
|
|
109
|
-
}
|
|
110
|
-
return q.promise;
|
|
111
|
-
}
|
|
112
|
-
for (const eventName of HANDLED_EVENTS) {
|
|
113
|
-
process.removeAllListeners(eventName).addListener(eventName, () => {
|
|
114
|
-
log.debug("Received signal: %s", eventName);
|
|
115
|
-
onShutdownEvent();
|
|
116
|
-
});
|
|
52
|
+
if (promisesMap.has(name)) return promisesMap.get(name);
|
|
53
|
+
const q = defer();
|
|
54
|
+
promisesMap.set(name, q.promise);
|
|
55
|
+
let lastError;
|
|
56
|
+
try {
|
|
57
|
+
const dependencies = DEPENDENCY_TREE.get(name);
|
|
58
|
+
if (dependencies) await Promise.all(Array.from(dependencies).map((dep) => shutdown(dep, promisesMap).catch((err) => lastError = err)));
|
|
59
|
+
const allHandlers = HANDLERS_MAP.get(name);
|
|
60
|
+
if (allHandlers?.length) {
|
|
61
|
+
const timeoutInterval = setInterval(() => {
|
|
62
|
+
log.warn("Long shutdown %s", name);
|
|
63
|
+
}, 3e3);
|
|
64
|
+
await asyncForEach(allHandlers, async (fn) => {
|
|
65
|
+
try {
|
|
66
|
+
await fn();
|
|
67
|
+
} catch (err) {
|
|
68
|
+
lastError = err;
|
|
69
|
+
}
|
|
70
|
+
}, { concurrency: 10 });
|
|
71
|
+
clearTimeout(timeoutInterval);
|
|
72
|
+
}
|
|
73
|
+
} catch (err) {
|
|
74
|
+
lastError = err;
|
|
75
|
+
}
|
|
76
|
+
if (lastError) q.reject(lastError);
|
|
77
|
+
else q.resolve();
|
|
78
|
+
return q.promise;
|
|
117
79
|
}
|
|
80
|
+
for (const eventName of HANDLED_EVENTS) process.removeAllListeners(eventName).addListener(eventName, () => {
|
|
81
|
+
log.debug("Received signal: %s", eventName);
|
|
82
|
+
onShutdownEvent();
|
|
83
|
+
});
|
|
118
84
|
function onShutdownEvent() {
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
85
|
+
if (shuttingDown) return;
|
|
86
|
+
shuttingDown = true;
|
|
87
|
+
const unreferencedNames = getAllUnreferencedNames();
|
|
88
|
+
const visited = /* @__PURE__ */ new Map();
|
|
89
|
+
Promise.all(unreferencedNames.map((name) => shutdown(name, visited))).then(() => exit(0)).catch((e) => {
|
|
90
|
+
Promise.all(SHUTDOWN_ERROR_HANDLERS.map((f) => f(e))).then(() => exit(42759)).catch(() => exit(42758));
|
|
91
|
+
});
|
|
126
92
|
}
|
|
127
93
|
function testForCycles(name, visitedSet = /* @__PURE__ */ new Set()) {
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
}
|
|
135
|
-
return false;
|
|
94
|
+
if (visitedSet.has(name)) return true;
|
|
95
|
+
visitedSet.add(name);
|
|
96
|
+
const dependencies = DEPENDENCY_TREE.get(name);
|
|
97
|
+
if (!dependencies) return false;
|
|
98
|
+
for (const dependencyName of dependencies.values()) if (testForCycles(dependencyName, visitedSet)) return true;
|
|
99
|
+
return false;
|
|
136
100
|
}
|
|
137
101
|
function getAllUnreferencedNames() {
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
result.delete(dependencyName);
|
|
142
|
-
}
|
|
143
|
-
}
|
|
144
|
-
return Array.from(result);
|
|
102
|
+
const result = new Set(Array.from(DEPENDENCY_TREE.keys()));
|
|
103
|
+
for (const dependencies of DEPENDENCY_TREE.values()) for (const dependencyName of dependencies.values()) result.delete(dependencyName);
|
|
104
|
+
return Array.from(result);
|
|
145
105
|
}
|
|
146
106
|
function exit(code) {
|
|
147
|
-
|
|
148
|
-
|
|
107
|
+
log.info("Shutdown with code: %d", code ?? 0);
|
|
108
|
+
process.exit(code);
|
|
149
109
|
}
|
|
110
|
+
export { isShuttingDown, onShutdown, onShutdownError, processGraceful };
|
|
150
111
|
|
|
151
|
-
|
|
152
|
-
//# sourceMappingURL=index.mjs.map
|
|
112
|
+
//# sourceMappingURL=index.mjs.map
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sources":["../src/index.ts"],"sourcesContent":["import {\n type AnyFunction,\n asyncForEach,\n defer,\n isFunction,\n isString,\n logger,\n noop,\n} from '@andrew_l/toolkit';\n\ntype HandlerError = (err: Error) => void;\ntype Handler<returnType = unknown> = () => Promise<returnType> | returnType;\ntype CancelCallback = () => void;\n\nconst log = logger('Graceful Shutdown');\n\nconst HANDLED_EVENTS = Object.freeze(['SIGINT', 'SIGTERM', 'SIGQUIT'] as const);\n\nconst DEPENDENCY_TREE = new Map<string, Set<string>>();\nconst DEPENDENCY_MAP = new WeakMap<AnyFunction, string[]>();\nconst HANDLERS_MAP = new Map<string, AnyFunction[]>();\nconst SHUTDOWN_ERROR_HANDLERS: HandlerError[] = [];\n\nlet shuttingDown = false;\n\n/**\n * Gracefully terminate application's modules on shutdown.\n * @param handler - Async or sync function which handles shutdown.\n */\nexport function onShutdown(handler: Handler): CancelCallback;\n\n/**\n * Gracefully terminate application's modules on shutdown.\n * @param name - Name of the handler.\n * @param handler - Async or sync function which handles shutdown.\n */\nexport function onShutdown(name: string, handler: Handler): CancelCallback;\n\n/**\n * Gracefully terminate application's modules on shutdown.\n * @param dependencies - Which handlers should be processed first.\n * @param handler - Async or sync function which handles shutdown.\n */\nexport function onShutdown(\n dependencies: string[],\n handler: Handler,\n): CancelCallback;\n\n/**\n * Gracefully terminate application's modules on shutdown.\n * @param name - Name of the handler.\n * @param dependencies - Which handlers should be processed first.\n * @param handler - Async or sync function which handles shutdown.\n *\n * @example\n * // This will called after http server close\n * onShutdown('mongoose', ['http-server'], async () => {\n * console.info('Graceful: mongodb connection.');\n * await mongoose.disconnect();\n * });\n *\n * onShutdown('http-server', async () => {\n * console.info('Graceful: http server.');\n * await httpServer.close();\n * });\n *\n * @group Main\n */\nexport function onShutdown(\n name: string,\n dependencies: string[],\n handler: Handler,\n): CancelCallback;\n\nexport function onShutdown(...args: any[]): CancelCallback {\n const [_name, _dependencies, _handler] = args;\n\n const handler = isFunction(_name)\n ? _name\n : isFunction(_dependencies)\n ? _dependencies\n : _handler;\n\n const dependencies = Array.isArray(_name)\n ? _name\n : Array.isArray(_dependencies)\n ? _dependencies\n : [];\n\n const name = isString(_name) ? _name : Math.random().toString(36);\n\n if (shuttingDown) {\n log.warn(\n 'Warn! Attempt to register handler while processing terminating: %s',\n name,\n );\n\n return noop;\n }\n\n if (dependencies.reduce((acc, dep) => acc || testForCycles(dep), false)) {\n throw new Error(\n `Adding shutdown handler \"${name}\" will create a dependency loop: aborting`,\n );\n }\n\n log.debug('Register handler: %s', name);\n\n DEPENDENCY_TREE.set(\n name,\n new Set([...(DEPENDENCY_TREE.get(name) || []), ...dependencies]),\n );\n\n DEPENDENCY_MAP.set(handler, dependencies);\n\n if (!HANDLERS_MAP.has(name)) {\n HANDLERS_MAP.set(name, []);\n }\n\n HANDLERS_MAP.get(name)!.push(handler);\n\n return () => {\n const handlersList = (HANDLERS_MAP.get(name) ?? []).filter(\n v => v !== handler,\n );\n\n if (!handlersList.length) {\n HANDLERS_MAP.delete(name);\n }\n\n const renewDependencies = new Set(\n handlersList\n .map(v => DEPENDENCY_MAP.get(v))\n .flat()\n .filter(isString),\n );\n\n if (renewDependencies.size) {\n DEPENDENCY_TREE.set(name, renewDependencies);\n } else {\n DEPENDENCY_TREE.delete(name);\n }\n\n DEPENDENCY_MAP.delete(handler);\n };\n}\n\n/**\n * Optional export to handle shutdown errors.\n */\nexport function onShutdownError(callback: HandlerError): CancelCallback {\n SHUTDOWN_ERROR_HANDLERS.push(callback);\n\n return () => {\n const idx = SHUTDOWN_ERROR_HANDLERS.indexOf(callback);\n if (idx > -1) {\n SHUTDOWN_ERROR_HANDLERS.splice(idx, 1);\n }\n };\n}\n\nexport function processGraceful(signal: NodeJS.Signals = 'SIGTERM') {\n log.debug('Force with signal: %s', signal);\n process.emit('SIGTERM', signal);\n}\n\nasync function shutdown(name: string, promisesMap: Map<string, Promise<any>>) {\n if (promisesMap.has(name)) {\n return promisesMap.get(name);\n }\n\n const q = defer<void>();\n\n promisesMap.set(name, q.promise);\n\n let lastError: unknown;\n\n try {\n const dependencies = DEPENDENCY_TREE.get(name);\n\n // Wait for all dependencies to shut down.\n if (dependencies) {\n await Promise.all(\n Array.from(dependencies).map(dep =>\n shutdown(dep, promisesMap).catch(err => (lastError = err)),\n ),\n );\n }\n\n // Shutdown this item.\n const allHandlers = HANDLERS_MAP.get(name);\n\n if (allHandlers?.length) {\n const timeoutInterval = setInterval(() => {\n log.warn('Long shutdown %s', name);\n }, 3000);\n\n await asyncForEach(\n allHandlers,\n async fn => {\n try {\n await fn();\n } catch (err) {\n lastError = err;\n }\n },\n { concurrency: 10 },\n );\n\n clearTimeout(timeoutInterval);\n }\n } catch (err) {\n lastError = err;\n }\n\n if (lastError) {\n q.reject(lastError);\n } else {\n q.resolve();\n }\n\n return q.promise;\n}\n\nfor (const eventName of HANDLED_EVENTS) {\n process.removeAllListeners(eventName).addListener(eventName, () => {\n log.debug('Received signal: %s', eventName);\n onShutdownEvent();\n });\n}\n\nfunction onShutdownEvent() {\n if (shuttingDown) return;\n shuttingDown = true;\n\n // Get all unreferenced nodes.\n const unreferencedNames = getAllUnreferencedNames();\n\n const visited = new Map();\n Promise.all(unreferencedNames.map(name => shutdown(name, visited)))\n .then(() => exit(0))\n .catch(e => {\n Promise.all(SHUTDOWN_ERROR_HANDLERS.map(f => f(e)))\n .then(() => exit(42759))\n .catch(() => exit(42758));\n });\n}\n\nfunction testForCycles(name: string, visitedSet = new Set()): boolean {\n // Return true if the cycle is found.\n if (visitedSet.has(name)) return true;\n\n visitedSet.add(name);\n\n // If any of the cycles found in dependencies, return true.\n const dependencies = DEPENDENCY_TREE.get(name);\n\n if (!dependencies) return false;\n\n for (const dependencyName of dependencies.values()) {\n if (testForCycles(dependencyName, visitedSet)) return true;\n }\n\n return false;\n}\n\nfunction getAllUnreferencedNames(): string[] {\n const result = new Set(Array.from(DEPENDENCY_TREE.keys()));\n\n for (const dependencies of DEPENDENCY_TREE.values()) {\n for (const dependencyName of dependencies.values()) {\n result.delete(dependencyName);\n }\n }\n\n return Array.from(result);\n}\n\nfunction exit(code?: number): void {\n log.info('Shutdown with code: %d', code ?? 0);\n process.exit(code);\n}\n"],"names":[],"mappings":";;AAcA,MAAM,GAAA,GAAM,OAAO,mBAAmB,CAAA;AAEtC,MAAM,iBAAiB,MAAA,CAAO,MAAA,CAAO,CAAC,QAAA,EAAU,SAAA,EAAW,SAAS,CAAU,CAAA;AAE9E,MAAM,eAAA,uBAAsB,GAAA,EAAyB;AACrD,MAAM,cAAA,uBAAqB,OAAA,EAA+B;AAC1D,MAAM,YAAA,uBAAmB,GAAA,EAA2B;AACpD,MAAM,0BAA0C,EAAC;AAEjD,IAAI,YAAA,GAAe,KAAA;AAmDZ,SAAS,cAAc,IAAA,EAA6B;AACzD,EAAA,MAAM,CAAC,KAAA,EAAO,aAAA,EAAe,QAAQ,CAAA,GAAI,IAAA;AAEzC,EAAA,MAAM,OAAA,GAAU,WAAW,KAAK,CAAA,GAC5B,QACA,UAAA,CAAW,aAAa,IACtB,aAAA,GACA,QAAA;AAEN,EAAA,MAAM,YAAA,GAAe,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,GACpC,KAAA,GACA,KAAA,CAAM,OAAA,CAAQ,aAAa,CAAA,GACzB,aAAA,GACA,EAAC;AAEP,EAAA,MAAM,IAAA,GAAO,SAAS,KAAK,CAAA,GAAI,QAAQ,IAAA,CAAK,MAAA,EAAO,CAAE,QAAA,CAAS,EAAE,CAAA;AAEhE,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,GAAA,CAAI,IAAA;AAAA,MACF,oEAAA;AAAA,MACA;AAAA,KACF;AAEA,IAAA,OAAO,IAAA;AAAA,EACT;AAEA,EAAA,IAAI,YAAA,CAAa,MAAA,CAAO,CAAC,GAAA,EAAK,GAAA,KAAQ,OAAO,aAAA,CAAc,GAAG,CAAA,EAAG,KAAK,CAAA,EAAG;AACvE,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,4BAA4B,IAAI,CAAA,yCAAA;AAAA,KAClC;AAAA,EACF;AAEA,EAAA,GAAA,CAAI,KAAA,CAAM,wBAAwB,IAAI,CAAA;AAEtC,EAAA,eAAA,CAAgB,GAAA;AAAA,IACd,IAAA;AAAA,oBACA,IAAI,GAAA,CAAI,CAAC,GAAI,eAAA,CAAgB,GAAA,CAAI,IAAI,CAAA,IAAK,EAAC,EAAI,GAAG,YAAY,CAAC;AAAA,GACjE;AAEA,EAAA,cAAA,CAAe,GAAA,CAAI,SAAS,YAAY,CAAA;AAExC,EAAA,IAAI,CAAC,YAAA,CAAa,GAAA,CAAI,IAAI,CAAA,EAAG;AAC3B,IAAA,YAAA,CAAa,GAAA,CAAI,IAAA,EAAM,EAAE,CAAA;AAAA,EAC3B;AAEA,EAAA,YAAA,CAAa,GAAA,CAAI,IAAI,CAAA,CAAG,IAAA,CAAK,OAAO,CAAA;AAEpC,EAAA,OAAO,MAAM;AACX,IAAA,MAAM,gBAAgB,YAAA,CAAa,GAAA,CAAI,IAAI,CAAA,IAAK,EAAC,EAAG,MAAA;AAAA,MAClD,OAAK,CAAA,KAAM;AAAA,KACb;AAEA,IAAA,IAAI,CAAC,aAAa,MAAA,EAAQ;AACxB,MAAA,YAAA,CAAa,OAAO,IAAI,CAAA;AAAA,IAC1B;AAEA,IAAA,MAAM,oBAAoB,IAAI,GAAA;AAAA,MAC5B,YAAA,CACG,GAAA,CAAI,CAAA,CAAA,KAAK,cAAA,CAAe,GAAA,CAAI,CAAC,CAAC,CAAA,CAC9B,IAAA,EAAK,CACL,MAAA,CAAO,QAAQ;AAAA,KACpB;AAEA,IAAA,IAAI,kBAAkB,IAAA,EAAM;AAC1B,MAAA,eAAA,CAAgB,GAAA,CAAI,MAAM,iBAAiB,CAAA;AAAA,IAC7C,CAAA,MAAO;AACL,MAAA,eAAA,CAAgB,OAAO,IAAI,CAAA;AAAA,IAC7B;AAEA,IAAA,cAAA,CAAe,OAAO,OAAO,CAAA;AAAA,EAC/B,CAAA;AACF;AAKO,SAAS,gBAAgB,QAAA,EAAwC;AACtE,EAAA,uBAAA,CAAwB,KAAK,QAAQ,CAAA;AAErC,EAAA,OAAO,MAAM;AACX,IAAA,MAAM,GAAA,GAAM,uBAAA,CAAwB,OAAA,CAAQ,QAAQ,CAAA;AACpD,IAAA,IAAI,MAAM,EAAA,EAAI;AACZ,MAAA,uBAAA,CAAwB,MAAA,CAAO,KAAK,CAAC,CAAA;AAAA,IACvC;AAAA,EACF,CAAA;AACF;AAEO,SAAS,eAAA,CAAgB,SAAyB,SAAA,EAAW;AAClE,EAAA,GAAA,CAAI,KAAA,CAAM,yBAAyB,MAAM,CAAA;AACzC,EAAA,OAAA,CAAQ,IAAA,CAAK,WAAW,MAAM,CAAA;AAChC;AAEA,eAAe,QAAA,CAAS,MAAc,WAAA,EAAwC;AAC5E,EAAA,IAAI,WAAA,CAAY,GAAA,CAAI,IAAI,CAAA,EAAG;AACzB,IAAA,OAAO,WAAA,CAAY,IAAI,IAAI,CAAA;AAAA,EAC7B;AAEA,EAAA,MAAM,IAAI,KAAA,EAAY;AAEtB,EAAA,WAAA,CAAY,GAAA,CAAI,IAAA,EAAM,CAAA,CAAE,OAAO,CAAA;AAE/B,EAAA,IAAI,SAAA;AAEJ,EAAA,IAAI;AACF,IAAA,MAAM,YAAA,GAAe,eAAA,CAAgB,GAAA,CAAI,IAAI,CAAA;AAG7C,IAAA,IAAI,YAAA,EAAc;AAChB,MAAA,MAAM,OAAA,CAAQ,GAAA;AAAA,QACZ,KAAA,CAAM,IAAA,CAAK,YAAY,CAAA,CAAE,GAAA;AAAA,UAAI,CAAA,GAAA,KAC3B,SAAS,GAAA,EAAK,WAAW,EAAE,KAAA,CAAM,CAAA,GAAA,KAAQ,YAAY,GAAI;AAAA;AAC3D,OACF;AAAA,IACF;AAGA,IAAA,MAAM,WAAA,GAAc,YAAA,CAAa,GAAA,CAAI,IAAI,CAAA;AAEzC,IAAA,IAAI,aAAa,MAAA,EAAQ;AACvB,MAAA,MAAM,eAAA,GAAkB,YAAY,MAAM;AACxC,QAAA,GAAA,CAAI,IAAA,CAAK,oBAAoB,IAAI,CAAA;AAAA,MACnC,GAAG,GAAI,CAAA;AAEP,MAAA,MAAM,YAAA;AAAA,QACJ,WAAA;AAAA,QACA,OAAM,EAAA,KAAM;AACV,UAAA,IAAI;AACF,YAAA,MAAM,EAAA,EAAG;AAAA,UACX,SAAS,GAAA,EAAK;AACZ,YAAA,SAAA,GAAY,GAAA;AAAA,UACd;AAAA,QACF,CAAA;AAAA,QACA,EAAE,aAAa,EAAA;AAAG,OACpB;AAEA,MAAA,YAAA,CAAa,eAAe,CAAA;AAAA,IAC9B;AAAA,EACF,SAAS,GAAA,EAAK;AACZ,IAAA,SAAA,GAAY,GAAA;AAAA,EACd;AAEA,EAAA,IAAI,SAAA,EAAW;AACb,IAAA,CAAA,CAAE,OAAO,SAAS,CAAA;AAAA,EACpB,CAAA,MAAO;AACL,IAAA,CAAA,CAAE,OAAA,EAAQ;AAAA,EACZ;AAEA,EAAA,OAAO,CAAA,CAAE,OAAA;AACX;AAEA,KAAA,MAAW,aAAa,cAAA,EAAgB;AACtC,EAAA,OAAA,CAAQ,kBAAA,CAAmB,SAAS,CAAA,CAAE,WAAA,CAAY,WAAW,MAAM;AACjE,IAAA,GAAA,CAAI,KAAA,CAAM,uBAAuB,SAAS,CAAA;AAC1C,IAAA,eAAA,EAAgB;AAAA,EAClB,CAAC,CAAA;AACH;AAEA,SAAS,eAAA,GAAkB;AACzB,EAAA,IAAI,YAAA,EAAc;AAClB,EAAA,YAAA,GAAe,IAAA;AAGf,EAAA,MAAM,oBAAoB,uBAAA,EAAwB;AAElD,EAAA,MAAM,OAAA,uBAAc,GAAA,EAAI;AACxB,EAAA,OAAA,CAAQ,IAAI,iBAAA,CAAkB,GAAA,CAAI,CAAA,IAAA,KAAQ,QAAA,CAAS,MAAM,OAAO,CAAC,CAAC,CAAA,CAC/D,KAAK,MAAM,IAAA,CAAK,CAAC,CAAC,CAAA,CAClB,MAAM,CAAA,CAAA,KAAK;AACV,IAAA,OAAA,CAAQ,IAAI,uBAAA,CAAwB,GAAA,CAAI,OAAK,CAAA,CAAE,CAAC,CAAC,CAAC,CAAA,CAC/C,KAAK,MAAM,IAAA,CAAK,KAAK,CAAC,CAAA,CACtB,MAAM,MAAM,IAAA,CAAK,KAAK,CAAC,CAAA;AAAA,EAC5B,CAAC,CAAA;AACL;AAEA,SAAS,aAAA,CAAc,IAAA,EAAc,UAAA,mBAAa,IAAI,KAAI,EAAY;AAEpE,EAAA,IAAI,UAAA,CAAW,GAAA,CAAI,IAAI,CAAA,EAAG,OAAO,IAAA;AAEjC,EAAA,UAAA,CAAW,IAAI,IAAI,CAAA;AAGnB,EAAA,MAAM,YAAA,GAAe,eAAA,CAAgB,GAAA,CAAI,IAAI,CAAA;AAE7C,EAAA,IAAI,CAAC,cAAc,OAAO,KAAA;AAE1B,EAAA,KAAA,MAAW,cAAA,IAAkB,YAAA,CAAa,MAAA,EAAO,EAAG;AAClD,IAAA,IAAI,aAAA,CAAc,cAAA,EAAgB,UAAU,CAAA,EAAG,OAAO,IAAA;AAAA,EACxD;AAEA,EAAA,OAAO,KAAA;AACT;AAEA,SAAS,uBAAA,GAAoC;AAC3C,EAAA,MAAM,MAAA,GAAS,IAAI,GAAA,CAAI,KAAA,CAAM,KAAK,eAAA,CAAgB,IAAA,EAAM,CAAC,CAAA;AAEzD,EAAA,KAAA,MAAW,YAAA,IAAgB,eAAA,CAAgB,MAAA,EAAO,EAAG;AACnD,IAAA,KAAA,MAAW,cAAA,IAAkB,YAAA,CAAa,MAAA,EAAO,EAAG;AAClD,MAAA,MAAA,CAAO,OAAO,cAAc,CAAA;AAAA,IAC9B;AAAA,EACF;AAEA,EAAA,OAAO,KAAA,CAAM,KAAK,MAAM,CAAA;AAC1B;AAEA,SAAS,KAAK,IAAA,EAAqB;AACjC,EAAA,GAAA,CAAI,IAAA,CAAK,wBAAA,EAA0B,IAAA,IAAQ,CAAC,CAAA;AAC5C,EAAA,OAAA,CAAQ,KAAK,IAAI,CAAA;AACnB;;;;"}
|
|
1
|
+
{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import {\n type AnyFunction,\n asyncForEach,\n defer,\n isFunction,\n isString,\n logger,\n noop,\n} from '@andrew_l/toolkit';\n\ntype HandlerError = (err: Error) => void;\ntype Handler<returnType = unknown> = () => Promise<returnType> | returnType;\ntype CancelCallback = () => void;\n\nconst log = logger('Graceful Shutdown');\n\nconst HANDLED_EVENTS = Object.freeze(['SIGINT', 'SIGTERM', 'SIGQUIT'] as const);\n\nconst DEPENDENCY_TREE = new Map<string, Set<string>>();\nconst DEPENDENCY_MAP = new WeakMap<AnyFunction, string[]>();\nconst HANDLERS_MAP = new Map<string, AnyFunction[]>();\nconst SHUTDOWN_ERROR_HANDLERS: HandlerError[] = [];\n\nlet shuttingDown = false;\n\n/**\n * Returns true when process received shutdown signal\n * @group Main\n */\nexport function isShuttingDown(): boolean {\n return shuttingDown;\n}\n\n/**\n * Gracefully terminate application's modules on shutdown.\n * @param handler - Async or sync function which handles shutdown.\n */\nexport function onShutdown(handler: Handler): CancelCallback;\n\n/**\n * Gracefully terminate application's modules on shutdown.\n * @param name - Name of the handler.\n * @param handler - Async or sync function which handles shutdown.\n */\nexport function onShutdown(name: string, handler: Handler): CancelCallback;\n\n/**\n * Gracefully terminate application's modules on shutdown.\n * @param dependencies - Which handlers should be processed first.\n * @param handler - Async or sync function which handles shutdown.\n */\nexport function onShutdown(\n dependencies: string[],\n handler: Handler,\n): CancelCallback;\n\n/**\n * Gracefully terminate application's modules on shutdown.\n * @param name - Name of the handler.\n * @param dependencies - Which handlers should be processed first.\n * @param handler - Async or sync function which handles shutdown.\n *\n * @example\n * // This will called after http server close\n * onShutdown('mongoose', ['http-server'], async () => {\n * console.info('Graceful: mongodb connection.');\n * await mongoose.disconnect();\n * });\n *\n * onShutdown('http-server', async () => {\n * console.info('Graceful: http server.');\n * await httpServer.close();\n * });\n *\n * @group Main\n */\nexport function onShutdown(\n name: string,\n dependencies: string[],\n handler: Handler,\n): CancelCallback;\n\nexport function onShutdown(...args: any[]): CancelCallback {\n const [_name, _dependencies, _handler] = args;\n\n const handler = isFunction(_name)\n ? _name\n : isFunction(_dependencies)\n ? _dependencies\n : _handler;\n\n const dependencies = Array.isArray(_name)\n ? _name\n : Array.isArray(_dependencies)\n ? _dependencies\n : [];\n\n const name = isString(_name) ? _name : Math.random().toString(36);\n\n if (shuttingDown) {\n log.warn(\n 'Warn! Attempt to register handler while processing terminating: %s',\n name,\n );\n\n return noop;\n }\n\n if (dependencies.reduce((acc, dep) => acc || testForCycles(dep), false)) {\n throw new Error(\n `Adding shutdown handler \"${name}\" will create a dependency loop: aborting`,\n );\n }\n\n log.debug('Register handler: %s', name);\n\n DEPENDENCY_TREE.set(\n name,\n new Set([...(DEPENDENCY_TREE.get(name) || []), ...dependencies]),\n );\n\n DEPENDENCY_MAP.set(handler, dependencies);\n\n if (!HANDLERS_MAP.has(name)) {\n HANDLERS_MAP.set(name, []);\n }\n\n HANDLERS_MAP.get(name)!.push(handler);\n\n return () => {\n const handlersList = (HANDLERS_MAP.get(name) ?? []).filter(\n v => v !== handler,\n );\n\n if (!handlersList.length) {\n HANDLERS_MAP.delete(name);\n }\n\n const renewDependencies = new Set(\n handlersList\n .map(v => DEPENDENCY_MAP.get(v))\n .flat()\n .filter(isString),\n );\n\n if (renewDependencies.size) {\n DEPENDENCY_TREE.set(name, renewDependencies);\n } else {\n DEPENDENCY_TREE.delete(name);\n }\n\n DEPENDENCY_MAP.delete(handler);\n };\n}\n\n/**\n * Optional export to handle shutdown errors.\n */\nexport function onShutdownError(callback: HandlerError): CancelCallback {\n SHUTDOWN_ERROR_HANDLERS.push(callback);\n\n return () => {\n const idx = SHUTDOWN_ERROR_HANDLERS.indexOf(callback);\n if (idx > -1) {\n SHUTDOWN_ERROR_HANDLERS.splice(idx, 1);\n }\n };\n}\n\nexport function processGraceful(signal: NodeJS.Signals = 'SIGTERM') {\n log.debug('Force with signal: %s', signal);\n process.emit('SIGTERM', signal);\n}\n\nasync function shutdown(name: string, promisesMap: Map<string, Promise<any>>) {\n if (promisesMap.has(name)) {\n return promisesMap.get(name);\n }\n\n const q = defer<void>();\n\n promisesMap.set(name, q.promise);\n\n let lastError: unknown;\n\n try {\n const dependencies = DEPENDENCY_TREE.get(name);\n\n // Wait for all dependencies to shut down.\n if (dependencies) {\n await Promise.all(\n Array.from(dependencies).map(dep =>\n shutdown(dep, promisesMap).catch(err => (lastError = err)),\n ),\n );\n }\n\n // Shutdown this item.\n const allHandlers = HANDLERS_MAP.get(name);\n\n if (allHandlers?.length) {\n const timeoutInterval = setInterval(() => {\n log.warn('Long shutdown %s', name);\n }, 3000);\n\n await asyncForEach(\n allHandlers,\n async fn => {\n try {\n await fn();\n } catch (err) {\n lastError = err;\n }\n },\n { concurrency: 10 },\n );\n\n clearTimeout(timeoutInterval);\n }\n } catch (err) {\n lastError = err;\n }\n\n if (lastError) {\n q.reject(lastError);\n } else {\n q.resolve();\n }\n\n return q.promise;\n}\n\nfor (const eventName of HANDLED_EVENTS) {\n process.removeAllListeners(eventName).addListener(eventName, () => {\n log.debug('Received signal: %s', eventName);\n onShutdownEvent();\n });\n}\n\nfunction onShutdownEvent() {\n if (shuttingDown) return;\n shuttingDown = true;\n\n // Get all unreferenced nodes.\n const unreferencedNames = getAllUnreferencedNames();\n\n const visited = new Map();\n Promise.all(unreferencedNames.map(name => shutdown(name, visited)))\n .then(() => exit(0))\n .catch(e => {\n Promise.all(SHUTDOWN_ERROR_HANDLERS.map(f => f(e)))\n .then(() => exit(42759))\n .catch(() => exit(42758));\n });\n}\n\nfunction testForCycles(name: string, visitedSet = new Set()): boolean {\n // Return true if the cycle is found.\n if (visitedSet.has(name)) return true;\n\n visitedSet.add(name);\n\n // If any of the cycles found in dependencies, return true.\n const dependencies = DEPENDENCY_TREE.get(name);\n\n if (!dependencies) return false;\n\n for (const dependencyName of dependencies.values()) {\n if (testForCycles(dependencyName, visitedSet)) return true;\n }\n\n return false;\n}\n\nfunction getAllUnreferencedNames(): string[] {\n const result = new Set(Array.from(DEPENDENCY_TREE.keys()));\n\n for (const dependencies of DEPENDENCY_TREE.values()) {\n for (const dependencyName of dependencies.values()) {\n result.delete(dependencyName);\n }\n }\n\n return Array.from(result);\n}\n\nfunction exit(code?: number): void {\n log.info('Shutdown with code: %d', code ?? 0);\n process.exit(code);\n}\n"],"mappings":";AAcA,MAAM,MAAM,OAAO,mBAAmB;AAEtC,MAAM,iBAAiB,OAAO,OAAO;CAAC;CAAU;CAAW;AAAS,CAAU;AAE9E,MAAM,kCAAkB,IAAI,IAAyB;AACrD,MAAM,iCAAiB,IAAI,QAA+B;AAC1D,MAAM,+BAAe,IAAI,IAA2B;AACpD,MAAM,0BAA0C,CAAC;AAEjD,IAAI,eAAe;;;;AAMnB,SAAgB,WAAA,GAAA,MAA0B;CACxC,MAAA,CAAO,OAAA,eAAA,YAAA;CACT,MAAA,UAAA,WAAA,KAAA,IAAA,QAAA,WAAA,aAAA,IAAA,gBAAA;CAmDA,MAAA,eAA2B,MAAG,QAA6B,KAAA,IAAA,QAAA,MAAA,QAAA,aAAA,IAAA,gBAAA,CAAA;CACzD,MAAM,OAAC,SAAO,KAAA,IAAe,QAAA,KAAY,OAAA,CAAA,CAAA,SAAA,EAAA;CAEzC,IAAA,cAAgB;EAMhB,IAAA,KAAM,sEAEyB,IACzB;EAGN,OAAM;CAEN;KACE,aACE,QAAA,KAAA,QAAA,OAAA,cAAA,GAAA,GAAA,KAAA,GAAA,MAAA,IACA,MACF,4BAAA,KAAA,0CAAA;KAEA,MAAO,wBAAA,IAAA;CACT,gBAAA,IAAA,sBAAA,IAAA,IAAA,CAAA,GAAA,gBAAA,IAAA,IAAA,KAAA,CAAA,GAAA,GAAA,YAAA,CAAA,CAAA;CAEA,eAAI,IAAa,SAAQ,YAAa;CAMtC,IAAI,CAAA,aAAM,IAAA,IAAA,GAAA,aAA4B,IAAA,MAAA,CAAA,CAAA;CAEtC,aAAA,IAAgB,IACd,CAAA,CAAA,KAAA,OAAA;CAIF,aAAA;EAEA,MAAK,gBAAiB,aACpB,IAAA,IAAa,KAAI,CAAA,EAAA,CAAO,QAAC,MAAA,MAAA,OAAA;EAG3B,IAAA,CAAA,aAAiB,QAAO,aAAY,OAAA,IAAA;EAEpC,MAAA,oBAAa,IAAA,IAAA,aAAA,KAAA,MAAA,eAAA,IAAA,CAAA,CAAA,CAAA,CAAA,KAAA,CAAA,CAAA,OAAA,QAAA,CAAA;EACX,IAAA,kBAAsB,MAAA,gBAAqB,IAAK,MAAI,iBAC7C;OAGF,gBAAa,OAChB,IAAA;EAGF,eAAM,OAAA,OAAoB;;;SAc5B,gBAAA,UAAA;CACF,wBAAA,KAAA,QAAA;;;;CAKA;;SAGE,gBAAa,SAAA,WAAA;KACX,MAAM,yBAAM,MAAwB;SAChC,KAAM,WACR,MAAA;;AAGN,eAAA,SAAA,MAAA,aAAA;CAEA,IAAA,YAAgB,IAAA,IAAgB,GAAA,OAAyB,YAAW,IAAA,IAAA;CAClE,MAAI,IAAM,MAAA;CACV,YAAQ,IAAK,MAAA,EAAW,OAAM;CAChC,IAAA;CAEA,IAAA;EACE,MAAI,eAAgB,gBACX,IAAA,IAAY;EAGrB,IAAA,cAAsB,MAAA,QAAA,IAAA,MAAA,KAAA,YAAA,CAAA,CAAA,KAAA,QAAA,SAAA,KAAA,WAAA,CAAA,CAAA,OAAA,QAAA,YAAA,GAAA,CAAA,CAAA;EAEtB,MAAA,cAAgB,aAAe,IAAA,IAAA;EAE/B,IAAI,aAAA,QAAA;GAEJ,MAAI,kBAAA,kBAAA;IACF,IAAM,KAAA,oBAAe,IAAA;GAGrB,GAAI,GAAA;GASJ,MAAM,aAAc,aAAa,OAAI,OAAI;IAEzC,IAAI;KACF,MAAM,GAAA;IACJ,SAAS,KAAA;KACX,YAAO;IAEP;MAGI,EAAI,aAAA,GAAA,CAAA;gBACO,eAAA;;UAET,KAAA;cACF;;KAKJ,WAAa,EAAA,OAAA,SAAe;MAC9B,EAAA,QAAA;CACF,OAAA,EAAS;;KAET,MAAA,aAAA,gBAAA,QAAA,mBAAA,SAAA,CAAA,CAAA,YAAA,iBAAA;CAEA,IAAI,MAAA,uBACgB,SAAA;iBAER;CAGZ;AACF,SAAA,kBAAA;CAEA,IAAK,cAAM;CAEP,eAAU;CACV,MAAA,oBAAgB,wBAAA;CACjB,MAAA,0BAAA,IAAA,IAAA;CAGH,QAAS,IAAA,kBAAkB,KAAA,SAAA,SAAA,MAAA,OAAA,CAAA,CAAA,CAAA,CAAA,WAAA,KAAA,CAAA,CAAA,CAAA,CAAA,OAAA,MAAA;EACzB,QAAI,IAAA,wBAAc,KAAA,MAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,WAAA,KAAA,KAAA,CAAA,CAAA,CAAA,YAAA,KAAA,KAAA,CAAA;CAClB,CAAA;;SAKM,cAAA,MAAA,6BAAkB,IAAA,IAAA,GAAA;CACxB,IAAA,WAAY,IAAA,IAAA,GAAA,OAAkB;YAGlB,IAAI,IAAA;CAGd,MAAC,eAAA,gBAAA,IAAA,IAAA;CACL,IAAA,CAAA,cAAA,OAAA;CAEA,KAAA,MAAS,kBAA4B,aAAA,OAAA,GAAA,IAAA,cAAiC,gBAAA,UAAA,GAAA,OAAA;CAEpE,OAAI;;SAKE,0BAAe;CAErB,MAAK,SAAA,IAAc,IAAA,MAAO,KAAA,gBAAA,KAAA,CAAA,CAAA;CAE1B,KAAK,MAAM,gBAAA,gBAA+B,OAAO,GAC/C,KAAI,MAAA,kBAAc,aAAgB,OAAa,GAAA,OAAO,OAAA,cAAA;CAGxD,OAAO,MAAA,KAAA,MAAA;AACT;AAEA,SAAS,KAAA,MAAA;CACP,IAAA,KAAM,0BAA4B,QAAA,CAAA;CAElC,QAAK,KAAM,IAAA;;AASb,SAAS,gBAA0B,YAAA,iBAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@andrew_l/graceful",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"description": "Utility to manage application shutdown.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -16,26 +16,27 @@
|
|
|
16
16
|
"exports": {
|
|
17
17
|
".": {
|
|
18
18
|
"import": "./dist/index.mjs",
|
|
19
|
-
"require": "./dist/index.
|
|
19
|
+
"require": "./dist/index.mjs",
|
|
20
|
+
"types": "./dist/index.d.mts"
|
|
20
21
|
}
|
|
21
22
|
},
|
|
22
|
-
"main": "./dist/index.
|
|
23
|
-
"types": "./dist/index.d.
|
|
23
|
+
"main": "./dist/index.mjs",
|
|
24
|
+
"types": "./dist/index.d.mts",
|
|
24
25
|
"files": [
|
|
25
26
|
"dist"
|
|
26
27
|
],
|
|
27
28
|
"devDependencies": {
|
|
28
29
|
"@types/node": "22.10.5",
|
|
29
|
-
"
|
|
30
|
-
"
|
|
30
|
+
"obuild": "^0.4.37",
|
|
31
|
+
"typescript": "6.0.3",
|
|
31
32
|
"vitest": "^3.2.4"
|
|
32
33
|
},
|
|
33
34
|
"dependencies": {
|
|
34
|
-
"@andrew_l/toolkit": "0.
|
|
35
|
+
"@andrew_l/toolkit": "0.4.0"
|
|
35
36
|
},
|
|
36
37
|
"scripts": {
|
|
37
38
|
"check-types": "tsc --noEmit",
|
|
38
|
-
"build": "
|
|
39
|
+
"build": "obuild",
|
|
39
40
|
"test": "echo todo",
|
|
40
41
|
"test:watch": "vitest watch --typecheck"
|
|
41
42
|
}
|
package/dist/index.cjs
DELETED
|
@@ -1,156 +0,0 @@
|
|
|
1
|
-
'use strict';
|
|
2
|
-
|
|
3
|
-
const toolkit = require('@andrew_l/toolkit');
|
|
4
|
-
|
|
5
|
-
const log = toolkit.logger("Graceful Shutdown");
|
|
6
|
-
const HANDLED_EVENTS = Object.freeze(["SIGINT", "SIGTERM", "SIGQUIT"]);
|
|
7
|
-
const DEPENDENCY_TREE = /* @__PURE__ */ new Map();
|
|
8
|
-
const DEPENDENCY_MAP = /* @__PURE__ */ new WeakMap();
|
|
9
|
-
const HANDLERS_MAP = /* @__PURE__ */ new Map();
|
|
10
|
-
const SHUTDOWN_ERROR_HANDLERS = [];
|
|
11
|
-
let shuttingDown = false;
|
|
12
|
-
function onShutdown(...args) {
|
|
13
|
-
const [_name, _dependencies, _handler] = args;
|
|
14
|
-
const handler = toolkit.isFunction(_name) ? _name : toolkit.isFunction(_dependencies) ? _dependencies : _handler;
|
|
15
|
-
const dependencies = Array.isArray(_name) ? _name : Array.isArray(_dependencies) ? _dependencies : [];
|
|
16
|
-
const name = toolkit.isString(_name) ? _name : Math.random().toString(36);
|
|
17
|
-
if (shuttingDown) {
|
|
18
|
-
log.warn(
|
|
19
|
-
"Warn! Attempt to register handler while processing terminating: %s",
|
|
20
|
-
name
|
|
21
|
-
);
|
|
22
|
-
return toolkit.noop;
|
|
23
|
-
}
|
|
24
|
-
if (dependencies.reduce((acc, dep) => acc || testForCycles(dep), false)) {
|
|
25
|
-
throw new Error(
|
|
26
|
-
`Adding shutdown handler "${name}" will create a dependency loop: aborting`
|
|
27
|
-
);
|
|
28
|
-
}
|
|
29
|
-
log.debug("Register handler: %s", name);
|
|
30
|
-
DEPENDENCY_TREE.set(
|
|
31
|
-
name,
|
|
32
|
-
/* @__PURE__ */ new Set([...DEPENDENCY_TREE.get(name) || [], ...dependencies])
|
|
33
|
-
);
|
|
34
|
-
DEPENDENCY_MAP.set(handler, dependencies);
|
|
35
|
-
if (!HANDLERS_MAP.has(name)) {
|
|
36
|
-
HANDLERS_MAP.set(name, []);
|
|
37
|
-
}
|
|
38
|
-
HANDLERS_MAP.get(name).push(handler);
|
|
39
|
-
return () => {
|
|
40
|
-
const handlersList = (HANDLERS_MAP.get(name) ?? []).filter(
|
|
41
|
-
(v) => v !== handler
|
|
42
|
-
);
|
|
43
|
-
if (!handlersList.length) {
|
|
44
|
-
HANDLERS_MAP.delete(name);
|
|
45
|
-
}
|
|
46
|
-
const renewDependencies = new Set(
|
|
47
|
-
handlersList.map((v) => DEPENDENCY_MAP.get(v)).flat().filter(toolkit.isString)
|
|
48
|
-
);
|
|
49
|
-
if (renewDependencies.size) {
|
|
50
|
-
DEPENDENCY_TREE.set(name, renewDependencies);
|
|
51
|
-
} else {
|
|
52
|
-
DEPENDENCY_TREE.delete(name);
|
|
53
|
-
}
|
|
54
|
-
DEPENDENCY_MAP.delete(handler);
|
|
55
|
-
};
|
|
56
|
-
}
|
|
57
|
-
function onShutdownError(callback) {
|
|
58
|
-
SHUTDOWN_ERROR_HANDLERS.push(callback);
|
|
59
|
-
return () => {
|
|
60
|
-
const idx = SHUTDOWN_ERROR_HANDLERS.indexOf(callback);
|
|
61
|
-
if (idx > -1) {
|
|
62
|
-
SHUTDOWN_ERROR_HANDLERS.splice(idx, 1);
|
|
63
|
-
}
|
|
64
|
-
};
|
|
65
|
-
}
|
|
66
|
-
function processGraceful(signal = "SIGTERM") {
|
|
67
|
-
log.debug("Force with signal: %s", signal);
|
|
68
|
-
process.emit("SIGTERM", signal);
|
|
69
|
-
}
|
|
70
|
-
async function shutdown(name, promisesMap) {
|
|
71
|
-
if (promisesMap.has(name)) {
|
|
72
|
-
return promisesMap.get(name);
|
|
73
|
-
}
|
|
74
|
-
const q = toolkit.defer();
|
|
75
|
-
promisesMap.set(name, q.promise);
|
|
76
|
-
let lastError;
|
|
77
|
-
try {
|
|
78
|
-
const dependencies = DEPENDENCY_TREE.get(name);
|
|
79
|
-
if (dependencies) {
|
|
80
|
-
await Promise.all(
|
|
81
|
-
Array.from(dependencies).map(
|
|
82
|
-
(dep) => shutdown(dep, promisesMap).catch((err) => lastError = err)
|
|
83
|
-
)
|
|
84
|
-
);
|
|
85
|
-
}
|
|
86
|
-
const allHandlers = HANDLERS_MAP.get(name);
|
|
87
|
-
if (allHandlers?.length) {
|
|
88
|
-
const timeoutInterval = setInterval(() => {
|
|
89
|
-
log.warn("Long shutdown %s", name);
|
|
90
|
-
}, 3e3);
|
|
91
|
-
await toolkit.asyncForEach(
|
|
92
|
-
allHandlers,
|
|
93
|
-
async (fn) => {
|
|
94
|
-
try {
|
|
95
|
-
await fn();
|
|
96
|
-
} catch (err) {
|
|
97
|
-
lastError = err;
|
|
98
|
-
}
|
|
99
|
-
},
|
|
100
|
-
{ concurrency: 10 }
|
|
101
|
-
);
|
|
102
|
-
clearTimeout(timeoutInterval);
|
|
103
|
-
}
|
|
104
|
-
} catch (err) {
|
|
105
|
-
lastError = err;
|
|
106
|
-
}
|
|
107
|
-
if (lastError) {
|
|
108
|
-
q.reject(lastError);
|
|
109
|
-
} else {
|
|
110
|
-
q.resolve();
|
|
111
|
-
}
|
|
112
|
-
return q.promise;
|
|
113
|
-
}
|
|
114
|
-
for (const eventName of HANDLED_EVENTS) {
|
|
115
|
-
process.removeAllListeners(eventName).addListener(eventName, () => {
|
|
116
|
-
log.debug("Received signal: %s", eventName);
|
|
117
|
-
onShutdownEvent();
|
|
118
|
-
});
|
|
119
|
-
}
|
|
120
|
-
function onShutdownEvent() {
|
|
121
|
-
if (shuttingDown) return;
|
|
122
|
-
shuttingDown = true;
|
|
123
|
-
const unreferencedNames = getAllUnreferencedNames();
|
|
124
|
-
const visited = /* @__PURE__ */ new Map();
|
|
125
|
-
Promise.all(unreferencedNames.map((name) => shutdown(name, visited))).then(() => exit(0)).catch((e) => {
|
|
126
|
-
Promise.all(SHUTDOWN_ERROR_HANDLERS.map((f) => f(e))).then(() => exit(42759)).catch(() => exit(42758));
|
|
127
|
-
});
|
|
128
|
-
}
|
|
129
|
-
function testForCycles(name, visitedSet = /* @__PURE__ */ new Set()) {
|
|
130
|
-
if (visitedSet.has(name)) return true;
|
|
131
|
-
visitedSet.add(name);
|
|
132
|
-
const dependencies = DEPENDENCY_TREE.get(name);
|
|
133
|
-
if (!dependencies) return false;
|
|
134
|
-
for (const dependencyName of dependencies.values()) {
|
|
135
|
-
if (testForCycles(dependencyName, visitedSet)) return true;
|
|
136
|
-
}
|
|
137
|
-
return false;
|
|
138
|
-
}
|
|
139
|
-
function getAllUnreferencedNames() {
|
|
140
|
-
const result = new Set(Array.from(DEPENDENCY_TREE.keys()));
|
|
141
|
-
for (const dependencies of DEPENDENCY_TREE.values()) {
|
|
142
|
-
for (const dependencyName of dependencies.values()) {
|
|
143
|
-
result.delete(dependencyName);
|
|
144
|
-
}
|
|
145
|
-
}
|
|
146
|
-
return Array.from(result);
|
|
147
|
-
}
|
|
148
|
-
function exit(code) {
|
|
149
|
-
log.info("Shutdown with code: %d", code ?? 0);
|
|
150
|
-
process.exit(code);
|
|
151
|
-
}
|
|
152
|
-
|
|
153
|
-
exports.onShutdown = onShutdown;
|
|
154
|
-
exports.onShutdownError = onShutdownError;
|
|
155
|
-
exports.processGraceful = processGraceful;
|
|
156
|
-
//# sourceMappingURL=index.cjs.map
|
package/dist/index.cjs.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs","sources":["../src/index.ts"],"sourcesContent":["import {\n type AnyFunction,\n asyncForEach,\n defer,\n isFunction,\n isString,\n logger,\n noop,\n} from '@andrew_l/toolkit';\n\ntype HandlerError = (err: Error) => void;\ntype Handler<returnType = unknown> = () => Promise<returnType> | returnType;\ntype CancelCallback = () => void;\n\nconst log = logger('Graceful Shutdown');\n\nconst HANDLED_EVENTS = Object.freeze(['SIGINT', 'SIGTERM', 'SIGQUIT'] as const);\n\nconst DEPENDENCY_TREE = new Map<string, Set<string>>();\nconst DEPENDENCY_MAP = new WeakMap<AnyFunction, string[]>();\nconst HANDLERS_MAP = new Map<string, AnyFunction[]>();\nconst SHUTDOWN_ERROR_HANDLERS: HandlerError[] = [];\n\nlet shuttingDown = false;\n\n/**\n * Gracefully terminate application's modules on shutdown.\n * @param handler - Async or sync function which handles shutdown.\n */\nexport function onShutdown(handler: Handler): CancelCallback;\n\n/**\n * Gracefully terminate application's modules on shutdown.\n * @param name - Name of the handler.\n * @param handler - Async or sync function which handles shutdown.\n */\nexport function onShutdown(name: string, handler: Handler): CancelCallback;\n\n/**\n * Gracefully terminate application's modules on shutdown.\n * @param dependencies - Which handlers should be processed first.\n * @param handler - Async or sync function which handles shutdown.\n */\nexport function onShutdown(\n dependencies: string[],\n handler: Handler,\n): CancelCallback;\n\n/**\n * Gracefully terminate application's modules on shutdown.\n * @param name - Name of the handler.\n * @param dependencies - Which handlers should be processed first.\n * @param handler - Async or sync function which handles shutdown.\n *\n * @example\n * // This will called after http server close\n * onShutdown('mongoose', ['http-server'], async () => {\n * console.info('Graceful: mongodb connection.');\n * await mongoose.disconnect();\n * });\n *\n * onShutdown('http-server', async () => {\n * console.info('Graceful: http server.');\n * await httpServer.close();\n * });\n *\n * @group Main\n */\nexport function onShutdown(\n name: string,\n dependencies: string[],\n handler: Handler,\n): CancelCallback;\n\nexport function onShutdown(...args: any[]): CancelCallback {\n const [_name, _dependencies, _handler] = args;\n\n const handler = isFunction(_name)\n ? _name\n : isFunction(_dependencies)\n ? _dependencies\n : _handler;\n\n const dependencies = Array.isArray(_name)\n ? _name\n : Array.isArray(_dependencies)\n ? _dependencies\n : [];\n\n const name = isString(_name) ? _name : Math.random().toString(36);\n\n if (shuttingDown) {\n log.warn(\n 'Warn! Attempt to register handler while processing terminating: %s',\n name,\n );\n\n return noop;\n }\n\n if (dependencies.reduce((acc, dep) => acc || testForCycles(dep), false)) {\n throw new Error(\n `Adding shutdown handler \"${name}\" will create a dependency loop: aborting`,\n );\n }\n\n log.debug('Register handler: %s', name);\n\n DEPENDENCY_TREE.set(\n name,\n new Set([...(DEPENDENCY_TREE.get(name) || []), ...dependencies]),\n );\n\n DEPENDENCY_MAP.set(handler, dependencies);\n\n if (!HANDLERS_MAP.has(name)) {\n HANDLERS_MAP.set(name, []);\n }\n\n HANDLERS_MAP.get(name)!.push(handler);\n\n return () => {\n const handlersList = (HANDLERS_MAP.get(name) ?? []).filter(\n v => v !== handler,\n );\n\n if (!handlersList.length) {\n HANDLERS_MAP.delete(name);\n }\n\n const renewDependencies = new Set(\n handlersList\n .map(v => DEPENDENCY_MAP.get(v))\n .flat()\n .filter(isString),\n );\n\n if (renewDependencies.size) {\n DEPENDENCY_TREE.set(name, renewDependencies);\n } else {\n DEPENDENCY_TREE.delete(name);\n }\n\n DEPENDENCY_MAP.delete(handler);\n };\n}\n\n/**\n * Optional export to handle shutdown errors.\n */\nexport function onShutdownError(callback: HandlerError): CancelCallback {\n SHUTDOWN_ERROR_HANDLERS.push(callback);\n\n return () => {\n const idx = SHUTDOWN_ERROR_HANDLERS.indexOf(callback);\n if (idx > -1) {\n SHUTDOWN_ERROR_HANDLERS.splice(idx, 1);\n }\n };\n}\n\nexport function processGraceful(signal: NodeJS.Signals = 'SIGTERM') {\n log.debug('Force with signal: %s', signal);\n process.emit('SIGTERM', signal);\n}\n\nasync function shutdown(name: string, promisesMap: Map<string, Promise<any>>) {\n if (promisesMap.has(name)) {\n return promisesMap.get(name);\n }\n\n const q = defer<void>();\n\n promisesMap.set(name, q.promise);\n\n let lastError: unknown;\n\n try {\n const dependencies = DEPENDENCY_TREE.get(name);\n\n // Wait for all dependencies to shut down.\n if (dependencies) {\n await Promise.all(\n Array.from(dependencies).map(dep =>\n shutdown(dep, promisesMap).catch(err => (lastError = err)),\n ),\n );\n }\n\n // Shutdown this item.\n const allHandlers = HANDLERS_MAP.get(name);\n\n if (allHandlers?.length) {\n const timeoutInterval = setInterval(() => {\n log.warn('Long shutdown %s', name);\n }, 3000);\n\n await asyncForEach(\n allHandlers,\n async fn => {\n try {\n await fn();\n } catch (err) {\n lastError = err;\n }\n },\n { concurrency: 10 },\n );\n\n clearTimeout(timeoutInterval);\n }\n } catch (err) {\n lastError = err;\n }\n\n if (lastError) {\n q.reject(lastError);\n } else {\n q.resolve();\n }\n\n return q.promise;\n}\n\nfor (const eventName of HANDLED_EVENTS) {\n process.removeAllListeners(eventName).addListener(eventName, () => {\n log.debug('Received signal: %s', eventName);\n onShutdownEvent();\n });\n}\n\nfunction onShutdownEvent() {\n if (shuttingDown) return;\n shuttingDown = true;\n\n // Get all unreferenced nodes.\n const unreferencedNames = getAllUnreferencedNames();\n\n const visited = new Map();\n Promise.all(unreferencedNames.map(name => shutdown(name, visited)))\n .then(() => exit(0))\n .catch(e => {\n Promise.all(SHUTDOWN_ERROR_HANDLERS.map(f => f(e)))\n .then(() => exit(42759))\n .catch(() => exit(42758));\n });\n}\n\nfunction testForCycles(name: string, visitedSet = new Set()): boolean {\n // Return true if the cycle is found.\n if (visitedSet.has(name)) return true;\n\n visitedSet.add(name);\n\n // If any of the cycles found in dependencies, return true.\n const dependencies = DEPENDENCY_TREE.get(name);\n\n if (!dependencies) return false;\n\n for (const dependencyName of dependencies.values()) {\n if (testForCycles(dependencyName, visitedSet)) return true;\n }\n\n return false;\n}\n\nfunction getAllUnreferencedNames(): string[] {\n const result = new Set(Array.from(DEPENDENCY_TREE.keys()));\n\n for (const dependencies of DEPENDENCY_TREE.values()) {\n for (const dependencyName of dependencies.values()) {\n result.delete(dependencyName);\n }\n }\n\n return Array.from(result);\n}\n\nfunction exit(code?: number): void {\n log.info('Shutdown with code: %d', code ?? 0);\n process.exit(code);\n}\n"],"names":["logger","isFunction","isString","noop","defer","asyncForEach"],"mappings":";;;;AAcA,MAAM,GAAA,GAAMA,eAAO,mBAAmB,CAAA;AAEtC,MAAM,iBAAiB,MAAA,CAAO,MAAA,CAAO,CAAC,QAAA,EAAU,SAAA,EAAW,SAAS,CAAU,CAAA;AAE9E,MAAM,eAAA,uBAAsB,GAAA,EAAyB;AACrD,MAAM,cAAA,uBAAqB,OAAA,EAA+B;AAC1D,MAAM,YAAA,uBAAmB,GAAA,EAA2B;AACpD,MAAM,0BAA0C,EAAC;AAEjD,IAAI,YAAA,GAAe,KAAA;AAmDZ,SAAS,cAAc,IAAA,EAA6B;AACzD,EAAA,MAAM,CAAC,KAAA,EAAO,aAAA,EAAe,QAAQ,CAAA,GAAI,IAAA;AAEzC,EAAA,MAAM,OAAA,GAAUC,mBAAW,KAAK,CAAA,GAC5B,QACAA,kBAAA,CAAW,aAAa,IACtB,aAAA,GACA,QAAA;AAEN,EAAA,MAAM,YAAA,GAAe,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,GACpC,KAAA,GACA,KAAA,CAAM,OAAA,CAAQ,aAAa,CAAA,GACzB,aAAA,GACA,EAAC;AAEP,EAAA,MAAM,IAAA,GAAOC,iBAAS,KAAK,CAAA,GAAI,QAAQ,IAAA,CAAK,MAAA,EAAO,CAAE,QAAA,CAAS,EAAE,CAAA;AAEhE,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,GAAA,CAAI,IAAA;AAAA,MACF,oEAAA;AAAA,MACA;AAAA,KACF;AAEA,IAAA,OAAOC,YAAA;AAAA,EACT;AAEA,EAAA,IAAI,YAAA,CAAa,MAAA,CAAO,CAAC,GAAA,EAAK,GAAA,KAAQ,OAAO,aAAA,CAAc,GAAG,CAAA,EAAG,KAAK,CAAA,EAAG;AACvE,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,4BAA4B,IAAI,CAAA,yCAAA;AAAA,KAClC;AAAA,EACF;AAEA,EAAA,GAAA,CAAI,KAAA,CAAM,wBAAwB,IAAI,CAAA;AAEtC,EAAA,eAAA,CAAgB,GAAA;AAAA,IACd,IAAA;AAAA,oBACA,IAAI,GAAA,CAAI,CAAC,GAAI,eAAA,CAAgB,GAAA,CAAI,IAAI,CAAA,IAAK,EAAC,EAAI,GAAG,YAAY,CAAC;AAAA,GACjE;AAEA,EAAA,cAAA,CAAe,GAAA,CAAI,SAAS,YAAY,CAAA;AAExC,EAAA,IAAI,CAAC,YAAA,CAAa,GAAA,CAAI,IAAI,CAAA,EAAG;AAC3B,IAAA,YAAA,CAAa,GAAA,CAAI,IAAA,EAAM,EAAE,CAAA;AAAA,EAC3B;AAEA,EAAA,YAAA,CAAa,GAAA,CAAI,IAAI,CAAA,CAAG,IAAA,CAAK,OAAO,CAAA;AAEpC,EAAA,OAAO,MAAM;AACX,IAAA,MAAM,gBAAgB,YAAA,CAAa,GAAA,CAAI,IAAI,CAAA,IAAK,EAAC,EAAG,MAAA;AAAA,MAClD,OAAK,CAAA,KAAM;AAAA,KACb;AAEA,IAAA,IAAI,CAAC,aAAa,MAAA,EAAQ;AACxB,MAAA,YAAA,CAAa,OAAO,IAAI,CAAA;AAAA,IAC1B;AAEA,IAAA,MAAM,oBAAoB,IAAI,GAAA;AAAA,MAC5B,YAAA,CACG,GAAA,CAAI,CAAA,CAAA,KAAK,cAAA,CAAe,GAAA,CAAI,CAAC,CAAC,CAAA,CAC9B,IAAA,EAAK,CACL,MAAA,CAAOD,gBAAQ;AAAA,KACpB;AAEA,IAAA,IAAI,kBAAkB,IAAA,EAAM;AAC1B,MAAA,eAAA,CAAgB,GAAA,CAAI,MAAM,iBAAiB,CAAA;AAAA,IAC7C,CAAA,MAAO;AACL,MAAA,eAAA,CAAgB,OAAO,IAAI,CAAA;AAAA,IAC7B;AAEA,IAAA,cAAA,CAAe,OAAO,OAAO,CAAA;AAAA,EAC/B,CAAA;AACF;AAKO,SAAS,gBAAgB,QAAA,EAAwC;AACtE,EAAA,uBAAA,CAAwB,KAAK,QAAQ,CAAA;AAErC,EAAA,OAAO,MAAM;AACX,IAAA,MAAM,GAAA,GAAM,uBAAA,CAAwB,OAAA,CAAQ,QAAQ,CAAA;AACpD,IAAA,IAAI,MAAM,EAAA,EAAI;AACZ,MAAA,uBAAA,CAAwB,MAAA,CAAO,KAAK,CAAC,CAAA;AAAA,IACvC;AAAA,EACF,CAAA;AACF;AAEO,SAAS,eAAA,CAAgB,SAAyB,SAAA,EAAW;AAClE,EAAA,GAAA,CAAI,KAAA,CAAM,yBAAyB,MAAM,CAAA;AACzC,EAAA,OAAA,CAAQ,IAAA,CAAK,WAAW,MAAM,CAAA;AAChC;AAEA,eAAe,QAAA,CAAS,MAAc,WAAA,EAAwC;AAC5E,EAAA,IAAI,WAAA,CAAY,GAAA,CAAI,IAAI,CAAA,EAAG;AACzB,IAAA,OAAO,WAAA,CAAY,IAAI,IAAI,CAAA;AAAA,EAC7B;AAEA,EAAA,MAAM,IAAIE,aAAA,EAAY;AAEtB,EAAA,WAAA,CAAY,GAAA,CAAI,IAAA,EAAM,CAAA,CAAE,OAAO,CAAA;AAE/B,EAAA,IAAI,SAAA;AAEJ,EAAA,IAAI;AACF,IAAA,MAAM,YAAA,GAAe,eAAA,CAAgB,GAAA,CAAI,IAAI,CAAA;AAG7C,IAAA,IAAI,YAAA,EAAc;AAChB,MAAA,MAAM,OAAA,CAAQ,GAAA;AAAA,QACZ,KAAA,CAAM,IAAA,CAAK,YAAY,CAAA,CAAE,GAAA;AAAA,UAAI,CAAA,GAAA,KAC3B,SAAS,GAAA,EAAK,WAAW,EAAE,KAAA,CAAM,CAAA,GAAA,KAAQ,YAAY,GAAI;AAAA;AAC3D,OACF;AAAA,IACF;AAGA,IAAA,MAAM,WAAA,GAAc,YAAA,CAAa,GAAA,CAAI,IAAI,CAAA;AAEzC,IAAA,IAAI,aAAa,MAAA,EAAQ;AACvB,MAAA,MAAM,eAAA,GAAkB,YAAY,MAAM;AACxC,QAAA,GAAA,CAAI,IAAA,CAAK,oBAAoB,IAAI,CAAA;AAAA,MACnC,GAAG,GAAI,CAAA;AAEP,MAAA,MAAMC,oBAAA;AAAA,QACJ,WAAA;AAAA,QACA,OAAM,EAAA,KAAM;AACV,UAAA,IAAI;AACF,YAAA,MAAM,EAAA,EAAG;AAAA,UACX,SAAS,GAAA,EAAK;AACZ,YAAA,SAAA,GAAY,GAAA;AAAA,UACd;AAAA,QACF,CAAA;AAAA,QACA,EAAE,aAAa,EAAA;AAAG,OACpB;AAEA,MAAA,YAAA,CAAa,eAAe,CAAA;AAAA,IAC9B;AAAA,EACF,SAAS,GAAA,EAAK;AACZ,IAAA,SAAA,GAAY,GAAA;AAAA,EACd;AAEA,EAAA,IAAI,SAAA,EAAW;AACb,IAAA,CAAA,CAAE,OAAO,SAAS,CAAA;AAAA,EACpB,CAAA,MAAO;AACL,IAAA,CAAA,CAAE,OAAA,EAAQ;AAAA,EACZ;AAEA,EAAA,OAAO,CAAA,CAAE,OAAA;AACX;AAEA,KAAA,MAAW,aAAa,cAAA,EAAgB;AACtC,EAAA,OAAA,CAAQ,kBAAA,CAAmB,SAAS,CAAA,CAAE,WAAA,CAAY,WAAW,MAAM;AACjE,IAAA,GAAA,CAAI,KAAA,CAAM,uBAAuB,SAAS,CAAA;AAC1C,IAAA,eAAA,EAAgB;AAAA,EAClB,CAAC,CAAA;AACH;AAEA,SAAS,eAAA,GAAkB;AACzB,EAAA,IAAI,YAAA,EAAc;AAClB,EAAA,YAAA,GAAe,IAAA;AAGf,EAAA,MAAM,oBAAoB,uBAAA,EAAwB;AAElD,EAAA,MAAM,OAAA,uBAAc,GAAA,EAAI;AACxB,EAAA,OAAA,CAAQ,IAAI,iBAAA,CAAkB,GAAA,CAAI,CAAA,IAAA,KAAQ,QAAA,CAAS,MAAM,OAAO,CAAC,CAAC,CAAA,CAC/D,KAAK,MAAM,IAAA,CAAK,CAAC,CAAC,CAAA,CAClB,MAAM,CAAA,CAAA,KAAK;AACV,IAAA,OAAA,CAAQ,IAAI,uBAAA,CAAwB,GAAA,CAAI,OAAK,CAAA,CAAE,CAAC,CAAC,CAAC,CAAA,CAC/C,KAAK,MAAM,IAAA,CAAK,KAAK,CAAC,CAAA,CACtB,MAAM,MAAM,IAAA,CAAK,KAAK,CAAC,CAAA;AAAA,EAC5B,CAAC,CAAA;AACL;AAEA,SAAS,aAAA,CAAc,IAAA,EAAc,UAAA,mBAAa,IAAI,KAAI,EAAY;AAEpE,EAAA,IAAI,UAAA,CAAW,GAAA,CAAI,IAAI,CAAA,EAAG,OAAO,IAAA;AAEjC,EAAA,UAAA,CAAW,IAAI,IAAI,CAAA;AAGnB,EAAA,MAAM,YAAA,GAAe,eAAA,CAAgB,GAAA,CAAI,IAAI,CAAA;AAE7C,EAAA,IAAI,CAAC,cAAc,OAAO,KAAA;AAE1B,EAAA,KAAA,MAAW,cAAA,IAAkB,YAAA,CAAa,MAAA,EAAO,EAAG;AAClD,IAAA,IAAI,aAAA,CAAc,cAAA,EAAgB,UAAU,CAAA,EAAG,OAAO,IAAA;AAAA,EACxD;AAEA,EAAA,OAAO,KAAA;AACT;AAEA,SAAS,uBAAA,GAAoC;AAC3C,EAAA,MAAM,MAAA,GAAS,IAAI,GAAA,CAAI,KAAA,CAAM,KAAK,eAAA,CAAgB,IAAA,EAAM,CAAC,CAAA;AAEzD,EAAA,KAAA,MAAW,YAAA,IAAgB,eAAA,CAAgB,MAAA,EAAO,EAAG;AACnD,IAAA,KAAA,MAAW,cAAA,IAAkB,YAAA,CAAa,MAAA,EAAO,EAAG;AAClD,MAAA,MAAA,CAAO,OAAO,cAAc,CAAA;AAAA,IAC9B;AAAA,EACF;AAEA,EAAA,OAAO,KAAA,CAAM,KAAK,MAAM,CAAA;AAC1B;AAEA,SAAS,KAAK,IAAA,EAAqB;AACjC,EAAA,GAAA,CAAI,IAAA,CAAK,wBAAA,EAA0B,IAAA,IAAQ,CAAC,CAAA;AAC5C,EAAA,OAAA,CAAQ,KAAK,IAAI,CAAA;AACnB;;;;;;"}
|
package/dist/index.d.cts
DELETED
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
type HandlerError = (err: Error) => void;
|
|
2
|
-
type Handler<returnType = unknown> = () => Promise<returnType> | returnType;
|
|
3
|
-
type CancelCallback = () => void;
|
|
4
|
-
/**
|
|
5
|
-
* Gracefully terminate application's modules on shutdown.
|
|
6
|
-
* @param handler - Async or sync function which handles shutdown.
|
|
7
|
-
*/
|
|
8
|
-
declare function onShutdown(handler: Handler): CancelCallback;
|
|
9
|
-
/**
|
|
10
|
-
* Gracefully terminate application's modules on shutdown.
|
|
11
|
-
* @param name - Name of the handler.
|
|
12
|
-
* @param handler - Async or sync function which handles shutdown.
|
|
13
|
-
*/
|
|
14
|
-
declare function onShutdown(name: string, handler: Handler): CancelCallback;
|
|
15
|
-
/**
|
|
16
|
-
* Gracefully terminate application's modules on shutdown.
|
|
17
|
-
* @param dependencies - Which handlers should be processed first.
|
|
18
|
-
* @param handler - Async or sync function which handles shutdown.
|
|
19
|
-
*/
|
|
20
|
-
declare function onShutdown(dependencies: string[], handler: Handler): CancelCallback;
|
|
21
|
-
/**
|
|
22
|
-
* Gracefully terminate application's modules on shutdown.
|
|
23
|
-
* @param name - Name of the handler.
|
|
24
|
-
* @param dependencies - Which handlers should be processed first.
|
|
25
|
-
* @param handler - Async or sync function which handles shutdown.
|
|
26
|
-
*
|
|
27
|
-
* @example
|
|
28
|
-
* // This will called after http server close
|
|
29
|
-
* onShutdown('mongoose', ['http-server'], async () => {
|
|
30
|
-
* console.info('Graceful: mongodb connection.');
|
|
31
|
-
* await mongoose.disconnect();
|
|
32
|
-
* });
|
|
33
|
-
*
|
|
34
|
-
* onShutdown('http-server', async () => {
|
|
35
|
-
* console.info('Graceful: http server.');
|
|
36
|
-
* await httpServer.close();
|
|
37
|
-
* });
|
|
38
|
-
*
|
|
39
|
-
* @group Main
|
|
40
|
-
*/
|
|
41
|
-
declare function onShutdown(name: string, dependencies: string[], handler: Handler): CancelCallback;
|
|
42
|
-
/**
|
|
43
|
-
* Optional export to handle shutdown errors.
|
|
44
|
-
*/
|
|
45
|
-
declare function onShutdownError(callback: HandlerError): CancelCallback;
|
|
46
|
-
declare function processGraceful(signal?: NodeJS.Signals): void;
|
|
47
|
-
|
|
48
|
-
export { onShutdown, onShutdownError, processGraceful };
|
package/dist/index.d.ts
DELETED
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
type HandlerError = (err: Error) => void;
|
|
2
|
-
type Handler<returnType = unknown> = () => Promise<returnType> | returnType;
|
|
3
|
-
type CancelCallback = () => void;
|
|
4
|
-
/**
|
|
5
|
-
* Gracefully terminate application's modules on shutdown.
|
|
6
|
-
* @param handler - Async or sync function which handles shutdown.
|
|
7
|
-
*/
|
|
8
|
-
declare function onShutdown(handler: Handler): CancelCallback;
|
|
9
|
-
/**
|
|
10
|
-
* Gracefully terminate application's modules on shutdown.
|
|
11
|
-
* @param name - Name of the handler.
|
|
12
|
-
* @param handler - Async or sync function which handles shutdown.
|
|
13
|
-
*/
|
|
14
|
-
declare function onShutdown(name: string, handler: Handler): CancelCallback;
|
|
15
|
-
/**
|
|
16
|
-
* Gracefully terminate application's modules on shutdown.
|
|
17
|
-
* @param dependencies - Which handlers should be processed first.
|
|
18
|
-
* @param handler - Async or sync function which handles shutdown.
|
|
19
|
-
*/
|
|
20
|
-
declare function onShutdown(dependencies: string[], handler: Handler): CancelCallback;
|
|
21
|
-
/**
|
|
22
|
-
* Gracefully terminate application's modules on shutdown.
|
|
23
|
-
* @param name - Name of the handler.
|
|
24
|
-
* @param dependencies - Which handlers should be processed first.
|
|
25
|
-
* @param handler - Async or sync function which handles shutdown.
|
|
26
|
-
*
|
|
27
|
-
* @example
|
|
28
|
-
* // This will called after http server close
|
|
29
|
-
* onShutdown('mongoose', ['http-server'], async () => {
|
|
30
|
-
* console.info('Graceful: mongodb connection.');
|
|
31
|
-
* await mongoose.disconnect();
|
|
32
|
-
* });
|
|
33
|
-
*
|
|
34
|
-
* onShutdown('http-server', async () => {
|
|
35
|
-
* console.info('Graceful: http server.');
|
|
36
|
-
* await httpServer.close();
|
|
37
|
-
* });
|
|
38
|
-
*
|
|
39
|
-
* @group Main
|
|
40
|
-
*/
|
|
41
|
-
declare function onShutdown(name: string, dependencies: string[], handler: Handler): CancelCallback;
|
|
42
|
-
/**
|
|
43
|
-
* Optional export to handle shutdown errors.
|
|
44
|
-
*/
|
|
45
|
-
declare function onShutdownError(callback: HandlerError): CancelCallback;
|
|
46
|
-
declare function processGraceful(signal?: NodeJS.Signals): void;
|
|
47
|
-
|
|
48
|
-
export { onShutdown, onShutdownError, processGraceful };
|