@stacks/api-toolkit 1.12.0

package/dist/profiler/server.js

@@ -0,0 +1,186 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildProfilerServer = buildProfilerServer;
+const events_1 = require("events");
+const os = require("os");
+const path = require("path");
+const fs = require("fs");
+const helpers_1 = require("../helpers");
+const promises_1 = require("node:stream/promises");
+const logger_1 = require("../logger");
+const fastify_1 = require("fastify");
+const type_provider_typebox_1 = require("@fastify/type-provider-typebox");
+const inspector_util_1 = require("./inspector-util");
+const DurationSchema = type_provider_typebox_1.Type.Number({ minimum: 0 });
+const SamplingIntervalSchema = type_provider_typebox_1.Type.Optional(type_provider_typebox_1.Type.Number({ minimum: 0 }));
+const CpuProfiler = (fastify, options, done) => {
+    let existingSession;
+    fastify.get('/profile/cpu', {
+        schema: {
+            querystring: type_provider_typebox_1.Type.Object({
+                duration: DurationSchema,
+                sampling_interval: SamplingIntervalSchema,
+            }),
+        },
+    }, async (req, res) => {
+        if (existingSession) {
+            await res.status(409).send({ error: 'Profile session already in progress' });
+            return;
+        }
+        const seconds = req.query.duration;
+        const samplingInterval = req.query.sampling_interval;
+        const cpuProfiler = (0, inspector_util_1.initCpuProfiling)(samplingInterval);
+        existingSession = { instance: cpuProfiler, response: res };
+        try {
+            const filename = `cpu_${Math.round(Date.now() / 1000)}_${seconds}-seconds.cpuprofile`;
+            await cpuProfiler.start();
+            const ac = new AbortController();
+            const timeoutPromise = (0, helpers_1.timeout)(seconds * 1000, ac);
+            await Promise.race([timeoutPromise, (0, events_1.once)(res.raw, 'close')]);
+            if (res.raw.writableEnded || res.raw.destroyed) {
+                // session was cancelled
+                ac.abort();
+                return;
+            }
+            const result = await cpuProfiler.stop();
+            const resultString = JSON.stringify(result);
+            logger_1.logger.info(`[CpuProfiler] Completed, total profile report JSON string length: ${resultString.length}`);
+            await res
+                .headers({
+                'Cache-Control': 'no-store',
+                'Transfer-Encoding': 'chunked',
+                'Content-Disposition': `attachment; filename="${filename}"`,
+                'Content-Type': 'application/json; charset=utf-8',
+            })
+                .send(resultString);
+        }
+        finally {
+            const session = existingSession;
+            existingSession = undefined;
+            await session?.instance.dispose().catch();
+        }
+    });
+    fastify.get('/profile/cpu/start', {
+        schema: {
+            querystring: type_provider_typebox_1.Type.Object({
+                sampling_interval: SamplingIntervalSchema,
+            }),
+        },
+    }, async (req, res) => {
+        if (existingSession) {
+            await res.status(409).send({ error: 'Profile session already in progress' });
+            return;
+        }
+        const samplingInterval = req.query.sampling_interval;
+        const cpuProfiler = (0, inspector_util_1.initCpuProfiling)(samplingInterval);
+        existingSession = { instance: cpuProfiler, response: res };
+        await cpuProfiler.start();
+        const profilerRunningLogger = setInterval(() => {
+            if (existingSession) {
+                logger_1.logger.error(`CPU profiler has been enabled for a long time`);
+            }
+            else {
+                clearInterval(profilerRunningLogger);
+            }
+        }, 10_000).unref();
+        await res.send('CPU profiler started');
+    });
+    fastify.get('/profile/cpu/stop', async (req, res) => {
+        if (!existingSession) {
+            await res.status(409).send({ error: 'No profile session in progress' });
+            return;
+        }
+        if (existingSession.instance.sessionType !== 'cpu') {
+            await res.status(409).send({ error: 'No CPU profile session in progress' });
+            return;
+        }
+        try {
+            const elapsedSeconds = existingSession.instance.stopwatch.getElapsedSeconds();
+            const timestampSeconds = Math.round(Date.now() / 1000);
+            const filename = `cpu_${timestampSeconds}_${elapsedSeconds}-seconds.cpuprofile`;
+            const result = await existingSession.instance.stop();
+            const resultString = JSON.stringify(result);
+            logger_1.logger.info(`[CpuProfiler] Completed, total profile report JSON string length: ${resultString.length}`);
+            await res
+                .headers({
+                'Cache-Control': 'no-store',
+                'Transfer-Encoding': 'chunked',
+                'Content-Disposition': `attachment; filename="${filename}"`,
+                'Content-Type': 'application/json; charset=utf-8',
+            })
+                .send(resultString);
+        }
+        finally {
+            const session = existingSession;
+            existingSession = undefined;
+            await session?.instance.dispose().catch();
+        }
+    });
+    fastify.get('/profile/heap_snapshot', async (req, res) => {
+        if (existingSession) {
+            await res.status(409).send({ error: 'Profile session already in progress' });
+            return;
+        }
+        const filename = `heap_${Math.round(Date.now() / 1000)}.heapsnapshot`;
+        const tmpFile = path.join(os.tmpdir(), filename);
+        const fileWriteStream = fs.createWriteStream(tmpFile);
+        const heapProfiler = (0, inspector_util_1.initHeapSnapshot)(fileWriteStream);
+        existingSession = { instance: heapProfiler, response: res };
+        try {
+            // Taking a heap snapshot (with current implementation) is a one-shot process ran to get the
+            // applications current heap memory usage, rather than something done over time. So start and
+            // stop without waiting.
+            await heapProfiler.start();
+            const result = await heapProfiler.stop();
+            logger_1.logger.info(`[HeapProfiler] Completed, total snapshot byte size: ${result.totalSnapshotByteSize}`);
+            await (0, promises_1.pipeline)(fs.createReadStream(tmpFile), res.raw);
+            await res.headers({
+                'Cache-Control': 'no-store',
+                'Transfer-Encoding': 'chunked',
+                'Content-Disposition': `attachment; filename="${filename}"`,
+                'Content-Type': 'application/json; charset=utf-8',
+            });
+        }
+        finally {
+            const session = existingSession;
+            existingSession = undefined;
+            await session?.instance.dispose().catch();
+            try {
+                fileWriteStream.destroy();
+            }
+            catch (_) { }
+            try {
+                logger_1.logger.info(`[HeapProfiler] Cleaning up tmp file ${tmpFile}`);
+                fs.unlinkSync(tmpFile);
+            }
+            catch (_) { }
+        }
+    });
+    fastify.get('/profile/cancel', async (req, res) => {
+        if (!existingSession) {
+            await res.status(409).send({ error: 'No existing profile session is exists to cancel' });
+            return;
+        }
+        const session = existingSession;
+        await session.instance.stop().catch();
+        await session.instance.dispose().catch();
+        await session.response.status(500).send('cancelled');
+        existingSession = undefined;
+        await Promise.resolve();
+        await res.send({ ok: 'existing profile session stopped' });
+    });
+    done();
+};
+/**
+ * Creates a Fastify server that controls a CPU profiler.
+ * @returns Fastify instance
+ */
+async function buildProfilerServer() {
+    const fastify = (0, fastify_1.default)({
+        trustProxy: true,
+        logger: logger_1.PINO_LOGGER_CONFIG,
+    }).withTypeProvider();
+    await fastify.register(CpuProfiler);
+    return fastify;
+}
+//# sourceMappingURL=server.js.map

package/dist/profiler/server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../../src/profiler/server.ts"],"names":[],"mappings":";;AAuMA,kDAOC;AA7MD,mCAA8B;AAE9B,yBAAyB;AACzB,6BAA6B;AAC7B,yBAAyB;AACzB,wCAAqC;AACrC,mDAAgD;AAChD,sCAAuD;AACvD,qCAAwF;AACxF,0EAA2E;AAC3E,qDAAwF;AAExF,MAAM,cAAc,GAAG,4BAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;AACnD,MAAM,sBAAsB,GAAG,4BAAI,CAAC,QAAQ,CAAC,4BAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAE1E,MAAM,WAAW,GAA6E,CAC5F,OAAO,EACP,OAAO,EACP,IAAI,EACJ,EAAE;IACF,IAAI,eAA4F,CAAC;IAEjG,OAAO,CAAC,GAAG,CACT,cAAc,EACd;QACE,MAAM,EAAE;YACN,WAAW,EAAE,4BAAI,CAAC,MAAM,CAAC;gBACvB,QAAQ,EAAE,cAAc;gBACxB,iBAAiB,EAAE,sBAAsB;aAC1C,CAAC;SACH;KACF,EACD,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QACjB,IAAI,eAAe,EAAE,CAAC;YACpB,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,qCAAqC,EAAE,CAAC,CAAC;YAC7E,OAAO;QACT,CAAC;QACD,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC;QACnC,MAAM,gBAAgB,GAAG,GAAG,CAAC,KAAK,CAAC,iBAAiB,CAAC;QACrD,MAAM,WAAW,GAAG,IAAA,iCAAgB,EAAC,gBAAgB,CAAC,CAAC;QACvD,eAAe,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC;QAC3D,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,IAAI,OAAO,qBAAqB,CAAC;YACtF,MAAM,WAAW,CAAC,KAAK,EAAE,CAAC;YAC1B,MAAM,EAAE,GAAG,IAAI,eAAe,EAAE,CAAC;YACjC,MAAM,cAAc,GAAG,IAAA,iBAAO,EAAC,OAAO,GAAG,IAAI,EAAE,EAAE,CAAC,CAAC;YACnD,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,IAAA,aAAI,EAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;YAC7D,IAAI,GAAG,CAAC,GAAG,CAAC,aAAa,IAAI,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;gBAC/C,wBAAwB;gBACxB,EAAE,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO;YACT,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,CAAC;YACxC,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAC5C,eAAM,CAAC,IAAI,CACT,qEAAqE,YAAY,CAAC,MAAM,EAAE,CAC3F,CAAC;YACF,MAAM,GAAG;iBACN,OAAO,CAAC;gBACP,eAAe,EAAE,UAAU;gBAC3B,mBAAmB,EAAE,SAAS;gBAC9B,qBAAqB,EAAE,yBAAyB,QAAQ,GAAG;gBAC3D,cAAc,EAAE,iCAAiC;aAClD,CAAC;iBACD,IAAI,CAAC,YAAY,CAAC,CAAC;QACxB,CAAC;gBAAS,CAAC;YACT,MAAM,OAAO,GAAG,eAAe,CAAC;YAChC,eAAe,GAAG,SAAS,CAAC;YAC5B,MAAM,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC;QAC5C,CAAC;IACH,CAAC,CACF,CAAC;IAEF,OAAO,CAAC,GAAG,CACT,oBAAoB,EACpB;QACE,MAAM,EAAE;YACN,WAAW,EAAE,4BAAI,CAAC,MAAM,CAAC;gBACvB,iBAAiB,EAAE,sBAAsB;aAC1C,CAAC;SACH;KACF,EACD,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QACjB,IAAI,eAAe,EAAE,CAAC;YACpB,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,qCAAqC,EAAE,CAAC,CAAC;YAC7E,OAAO;QACT,CAAC;QACD,MAAM,gBAAgB,GAAG,GAAG,CAAC,KAAK,CAAC,iBAAiB,CAAC;QACrD,MAAM,WAAW,GAAG,IAAA,iCAAgB,EAAC,gBAAgB,CAAC,CAAC;QACvD,eAAe,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC;QAC3D,MAAM,WAAW,CAAC,KAAK,EAAE,CAAC;QAC1B,MAAM,qBAAqB,GAAG,WAAW,CAAC,GAAG,EAAE;YAC7C,IAAI,eAAe,EAAE,CAAC;gBACpB,eAAM,CAAC,KAAK,CAAC,+CAA+C,CAAC,CAAC;YAChE,CAAC;iBAAM,CAAC;gBACN,aAAa,CAAC,qBAAqB,CAAC,CAAC;YACvC,CAAC;QACH,CAAC,EAAE,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC;QACnB,MAAM,GAAG,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IACzC,CAAC,CACF,CAAC;IAEF,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QAClD,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,gCAAgC,EAAE,CAAC,CAAC;YACxE,OAAO;QACT,CAAC;QACD,IAAI,eAAe,CAAC,QAAQ,CAAC,WAAW,KAAK,KAAK,EAAE,CAAC;YACnD,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,oCAAoC,EAAE,CAAC,CAAC;YAC5E,OAAO;QACT,CAAC;QACD,IAAI,CAAC;YACH,MAAM,cAAc,GAAG,eAAe,CAAC,QAAQ,CAAC,SAAS,CAAC,iBAAiB,EAAE,CAAC;YAC9E,MAAM,gBAAgB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;YACvD,MAAM,QAAQ,GAAG,OAAO,gBAAgB,IAAI,cAAc,qBAAqB,CAAC;YAChF,MAAM,MAAM,GAAG,MACb,eAAe,CAAC,QACjB,CAAC,IAAI,EAAE,CAAC;YACT,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAC5C,eAAM,CAAC,IAAI,CACT,qEAAqE,YAAY,CAAC,MAAM,EAAE,CAC3F,CAAC;YACF,MAAM,GAAG;iBACN,OAAO,CAAC;gBACP,eAAe,EAAE,UAAU;gBAC3B,mBAAmB,EAAE,SAAS;gBAC9B,qBAAqB,EAAE,yBAAyB,QAAQ,GAAG;gBAC3D,cAAc,EAAE,iCAAiC;aAClD,CAAC;iBACD,IAAI,CAAC,YAAY,CAAC,CAAC;QACxB,CAAC;gBAAS,CAAC;YACT,MAAM,OAAO,GAAG,eAAe,CAAC;YAChC,eAAe,GAAG,SAAS,CAAC;YAC5B,MAAM,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC;QAC5C,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QACvD,IAAI,eAAe,EAAE,CAAC;YACpB,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,qCAAqC,EAAE,CAAC,CAAC;YAC7E,OAAO;QACT,CAAC;QACD,MAAM,QAAQ,GAAG,QAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC;QACtE,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,QAAQ,CAAC,CAAC;QACjD,MAAM,eAAe,GAAG,EAAE,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QACtD,MAAM,YAAY,GAAG,IAAA,iCAAgB,EAAC,eAAe,CAAC,CAAC;QACvD,eAAe,GAAG,EAAE,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC;QAC5D,IAAI,CAAC;YACH,4FAA4F;YAC5F,6FAA6F;YAC7F,wBAAwB;YACxB,MAAM,YAAY,CAAC,KAAK,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,IAAI,EAAE,CAAC;YACzC,eAAM,CAAC,IAAI,CACT,uDAAuD,MAAM,CAAC,qBAAqB,EAAE,CACtF,CAAC;YACF,MAAM,IAAA,mBAAQ,EAAC,EAAE,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;YACtD,MAAM,GAAG,CAAC,OAAO,CAAC;gBAChB,eAAe,EAAE,UAAU;gBAC3B,mBAAmB,EAAE,SAAS;gBAC9B,qBAAqB,EAAE,yBAAyB,QAAQ,GAAG;gBAC3D,cAAc,EAAE,iCAAiC;aAClD,CAAC,CAAC;QACL,CAAC;gBAAS,CAAC;YACT,MAAM,OAAO,GAAG,eAAe,CAAC;YAChC,eAAe,GAAG,SAAS,CAAC;YAC5B,MAAM,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC;YAC1C,IAAI,CAAC;gBACH,eAAe,CAAC,OAAO,EAAE,CAAC;YAC5B,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC,CAAA,CAAC;YACd,IAAI,CAAC;gBACH,eAAM,CAAC,IAAI,CAAC,uCAAuC,OAAO,EAAE,CAAC,CAAC;gBAC9D,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YACzB,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC,CAAA,CAAC;QAChB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QAChD,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,iDAAiD,EAAE,CAAC,CAAC;YACzF,OAAO;QACT,CAAC;QACD,MAAM,OAAO,GAAG,eAAe,CAAC;QAChC,MAAM,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC;QACtC,MAAM,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC;QACzC,MAAM,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACrD,eAAe,GAAG,SAAS,CAAC;QAC5B,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;QACxB,MAAM,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,kCAAkC,EAAE,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,IAAI,EAAE,CAAC;AACT,CAAC,CAAC;AAEF;;;GAGG;AACI,KAAK,UAAU,mBAAmB;IACvC,MAAM,OAAO,GAAG,IAAA,iBAAO,EAAC;QACtB,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,2BAAkB;KAC3B,CAAC,CAAC,gBAAgB,EAAuB,CAAC;IAC3C,MAAM,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACpC,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/server-version/index.d.ts

@@ -0,0 +1,8 @@
+interface ServerVersion {
+    branch: string;
+    commit: string;
+    tag: string;
+}
+export declare function getServerVersion(): ServerVersion;
+export declare const SERVER_VERSION: ServerVersion;
+export {};

package/dist/server-version/index.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SERVER_VERSION = void 0;
+exports.getServerVersion = getServerVersion;
+const node_fs_1 = require("node:fs");
+const is_debugging_1 = require("../helpers/is-debugging");
+function getServerVersion() {
+    if (process.env.NODE_ENV === 'test') {
+        return {
+            branch: 'test',
+            commit: '123456',
+            tag: 'v0.0.1',
+        };
+    }
+    try {
+        const [branch, commit, tag] = (0, node_fs_1.readFileSync)('.git-info', 'utf-8').split('\n');
+        return { branch, commit, tag };
+    }
+    catch (error) {
+        // If .git-info file does not exist and we are debugging, return a default version
+        const fileNotExists = error.code === 'ENOENT';
+        if (fileNotExists && (0, is_debugging_1.isDebugging)()) {
+            return {
+                branch: 'debugging',
+                commit: '123456',
+                tag: 'v0.0.1',
+            };
+        }
+        throw error;
+    }
+}
+exports.SERVER_VERSION = getServerVersion();
+//# sourceMappingURL=index.js.map

package/dist/server-version/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/server-version/index.ts"],"names":[],"mappings":";;;AASA,4CAwBC;AAjCD,qCAAuC;AACvC,0DAAsD;AAQtD,SAAgB,gBAAgB;IAC9B,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;QACpC,OAAO;YACL,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,QAAQ;SACd,CAAC;IACJ,CAAC;IAED,IAAI,CAAC;QACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,GAAG,IAAA,sBAAY,EAAC,WAAW,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC7E,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;IACjC,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,kFAAkF;QAClF,MAAM,aAAa,GAAI,KAA+B,CAAC,IAAI,KAAK,QAAQ,CAAC;QACzE,IAAI,aAAa,IAAI,IAAA,0BAAW,GAAE,EAAE,CAAC;YACnC,OAAO;gBACL,MAAM,EAAE,WAAW;gBACnB,MAAM,EAAE,QAAQ;gBAChB,GAAG,EAAE,QAAQ;aACd,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAEY,QAAA,cAAc,GAAG,gBAAgB,EAAE,CAAC"}

package/dist/shutdown-handler/index.d.ts

@@ -0,0 +1,17 @@
+type ShutdownHandler = () => void | PromiseLike<void>;
+type ShutdownConfig = {
+    name: string;
+    handler: ShutdownHandler;
+    forceKillable: boolean;
+    forceKillHandler?: ShutdownHandler;
+};
+/**
+ * Start a graceful API shutdown.
+ */
+export declare function shutdown(): Promise<void>;
+/**
+ * Register shutdown handlers for different API components.
+ * @param configs - Array of shutdown configurations
+ */
+export declare function registerShutdownConfig(...configs: ShutdownConfig[]): void;
+export {};

package/dist/shutdown-handler/index.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shutdown = shutdown;
+exports.registerShutdownConfig = registerShutdownConfig;
+const time_1 = require("../helpers/time");
+const logger_1 = require("../logger");
+const SHUTDOWN_SIGNALS = ['SIGINT', 'SIGTERM'];
+const shutdownConfigs = [];
+let isShuttingDown = false;
+/**
+ * Start a graceful API shutdown.
+ */
+async function shutdown() {
+    if (isShuttingDown) {
+        return;
+    }
+    isShuttingDown = true;
+    const timeoutMs = parseInt(process.env['STACKS_SHUTDOWN_FORCE_KILL_TIMEOUT'] ?? '60') * 1000;
+    let errorEncountered = false;
+    for (const config of shutdownConfigs) {
+        try {
+            logger_1.logger.info(`Closing ${config.name}...`);
+            const gracefulShutdown = await (0, time_1.resolveOrTimeout)(Promise.resolve(config.handler()), timeoutMs, !config.forceKillable, () => logger_1.logger.error(`${config.name} is taking longer than expected to shutdown, possibly hanging indefinitely`));
+            if (!gracefulShutdown) {
+                if (config.forceKillable && config.forceKillHandler) {
+                    await Promise.resolve(config.forceKillHandler());
+                }
+                logger_1.logger.error(`${config.name} was force killed after taking longer than ${timeoutMs}ms to shutdown`);
+            }
+            else {
+                logger_1.logger.info(`${config.name} closed`);
+            }
+        }
+        catch (error) {
+            errorEncountered = true;
+            logger_1.logger.error(error, `Error running ${config.name} shutdown handler`);
+        }
+    }
+    if (errorEncountered) {
+        process.exit(1);
+    }
+    else {
+        logger_1.logger.info('App shutdown successful.');
+        process.exit();
+    }
+}
+let shutdownSignalsRegistered = false;
+function registerShutdownSignals() {
+    if (shutdownSignalsRegistered) {
+        return;
+    }
+    shutdownSignalsRegistered = true;
+    SHUTDOWN_SIGNALS.forEach(sig => {
+        process.once(sig, () => {
+            logger_1.logger.info(`Shutting down... received signal: ${sig}`);
+            void shutdown();
+        });
+    });
+    process.once('unhandledRejection', error => {
+        logger_1.logger.error(error, 'unhandledRejection');
+        logger_1.logger.error('Shutting down... received unhandledRejection.');
+        void shutdown();
+    });
+    process.once('uncaughtException', error => {
+        logger_1.logger.error(error, 'uncaughtException');
+        logger_1.logger.error('Shutting down... received uncaughtException.');
+        void shutdown();
+    });
+    process.once('beforeExit', () => {
+        logger_1.logger.error('Shutting down... received beforeExit.');
+        void shutdown();
+    });
+}
+/**
+ * Register shutdown handlers for different API components.
+ * @param configs - Array of shutdown configurations
+ */
+function registerShutdownConfig(...configs) {
+    registerShutdownSignals();
+    shutdownConfigs.push(...configs);
+}
+//# sourceMappingURL=index.js.map

package/dist/shutdown-handler/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/shutdown-handler/index.ts"],"names":[],"mappings":";;AAoBA,4BAwCC;AAmCD,wDAGC;AAlGD,0CAAmD;AACnD,sCAAmC;AAEnC,MAAM,gBAAgB,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAU,CAAC;AAUxD,MAAM,eAAe,GAAqB,EAAE,CAAC;AAE7C,IAAI,cAAc,GAAG,KAAK,CAAC;AAE3B;;GAEG;AACI,KAAK,UAAU,QAAQ;IAC5B,IAAI,cAAc,EAAE,CAAC;QACnB,OAAO;IACT,CAAC;IACD,cAAc,GAAG,IAAI,CAAC;IACtB,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC;IAC7F,IAAI,gBAAgB,GAAG,KAAK,CAAC;IAC7B,KAAK,MAAM,MAAM,IAAI,eAAe,EAAE,CAAC;QACrC,IAAI,CAAC;YACH,eAAM,CAAC,IAAI,CAAC,WAAW,MAAM,CAAC,IAAI,KAAK,CAAC,CAAC;YACzC,MAAM,gBAAgB,GAAG,MAAM,IAAA,uBAAgB,EAC7C,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,EACjC,SAAS,EACT,CAAC,MAAM,CAAC,aAAa,EACrB,GAAG,EAAE,CACH,eAAM,CAAC,KAAK,CACV,GAAG,MAAM,CAAC,IAAI,4EAA4E,CAC3F,CACJ,CAAC;YACF,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACtB,IAAI,MAAM,CAAC,aAAa,IAAI,MAAM,CAAC,gBAAgB,EAAE,CAAC;oBACpD,MAAM,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC,CAAC;gBACnD,CAAC;gBACD,eAAM,CAAC,KAAK,CACV,GAAG,MAAM,CAAC,IAAI,8CAA8C,SAAS,gBAAgB,CACtF,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,eAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,IAAI,SAAS,CAAC,CAAC;YACvC,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,gBAAgB,GAAG,IAAI,CAAC;YACxB,eAAM,CAAC,KAAK,CAAC,KAAK,EAAE,iBAAiB,MAAM,CAAC,IAAI,mBAAmB,CAAC,CAAC;QACvE,CAAC;IACH,CAAC;IACD,IAAI,gBAAgB,EAAE,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;SAAM,CAAC;QACN,eAAM,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QACxC,OAAO,CAAC,IAAI,EAAE,CAAC;IACjB,CAAC;AACH,CAAC;AAED,IAAI,yBAAyB,GAAG,KAAK,CAAC;AACtC,SAAS,uBAAuB;IAC9B,IAAI,yBAAyB,EAAE,CAAC;QAC9B,OAAO;IACT,CAAC;IACD,yBAAyB,GAAG,IAAI,CAAC;IAEjC,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QAC7B,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE;YACrB,eAAM,CAAC,IAAI,CAAC,qCAAqC,GAAG,EAAE,CAAC,CAAC;YACxD,KAAK,QAAQ,EAAE,CAAC;QAClB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,KAAK,CAAC,EAAE;QACzC,eAAM,CAAC,KAAK,CAAC,KAAK,EAAE,oBAAoB,CAAC,CAAC;QAC1C,eAAM,CAAC,KAAK,CAAC,+CAA+C,CAAC,CAAC;QAC9D,KAAK,QAAQ,EAAE,CAAC;IAClB,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,CAAC,EAAE;QACxC,eAAM,CAAC,KAAK,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC;QACzC,eAAM,CAAC,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAC7D,KAAK,QAAQ,EAAE,CAAC;IAClB,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,EAAE;QAC9B,eAAM,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;QACtD,KAAK,QAAQ,EAAE,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAgB,sBAAsB,CAAC,GAAG,OAAyB;IACjE,uBAAuB,EAAE,CAAC;IAC1B,eAAe,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;AACnC,CAAC"}

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@stacks/api-toolkit",
+  "version": "1.12.0",
+  "description": "API development toolkit",
+  "main": "./dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "scripts": {
+    "build": "rimraf ./dist && tsc --project tsconfig.build.json && copyfiles -u 1 ./src/server-version/*.mjs ./dist",
+    "test": "jest --runInBand",
+    "lint:eslint": "eslint . --ext .js,.jsx,.ts,.tsx -f unix",
+    "lint:prettier": "prettier --check src/**/*.ts",
+    "testenv:run": "docker compose -f docker/docker-compose.dev.postgres.yml up",
+    "testenv:stop": "docker compose -f docker/docker-compose.dev.postgres.yml down -v -t 0",
+    "testenv:logs": "docker compose -f docker/docker-compose.dev.postgres.yml logs -t -f"
+  },
+  "bin": {
+    "api-toolkit-git-info": "./bin/api-toolkit-git-info.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stx-labs/api-toolkit.git"
+  },
+  "keywords": [
+    "api",
+    "toolkit"
+  ],
+  "files": [
+    "dist/",
+    "bin/"
+  ],
+  "author": "Stacks Labs",
+  "license": "Apache 2.0",
+  "bugs": {
+    "url": "https://github.com/stx-labs/api-toolkit/issues"
+  },
+  "homepage": "https://github.com/stx-labs/api-toolkit#readme",
+  "prettier": "@stacks/prettier-config",
+  "engines": {
+    "node": ">=22"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^17.5.0",
+    "@commitlint/config-conventional": "^17.4.4",
+    "@stacks/eslint-config": "^1.2.0",
+    "@types/jest": "^29.5.14",
+    "@typescript-eslint/eslint-plugin": "^5.56.0",
+    "@typescript-eslint/parser": "^5.56.0",
+    "babel-jest": "^29.5.0",
+    "copyfiles": "^2.4.1",
+    "eslint": "^8.36.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-tsdoc": "^0.2.17",
+    "husky": "^8.0.3",
+    "jest": "^29.7.0",
+    "prettier": "^2.8.6",
+    "rimraf": "^4.4.1",
+    "ts-jest": "^29.3.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.2"
+  },
+  "dependencies": {
+    "@fastify/cors": "^8.0.0",
+    "@fastify/swagger": "^8.3.1",
+    "@fastify/type-provider-typebox": "^3.2.0",
+    "@sinclair/typebox": "^0.28.20",
+    "@types/node": "^22.14.1",
+    "fastify": "^4.3.0",
+    "fastify-metrics": "^10.2.0",
+    "node-pg-migrate": "^6.2.2",
+    "pino": "^8.11.0",
+    "postgres": "^3.3.4"
+  }
+}