@fastrack/starter-actuator 0.1.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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Fastrack
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,5 @@
1
+ # @fastrack/starter-actuator
2
+
3
+ Endpoints: `/live` (process alive), `/ready` (readiness + contributors), `/health` (full health), `/info` (version/build/env), `/metrics` (Prometheus). Other starters register health contributors.
4
+
5
+ See [docs/starters.md](../../docs/starters.md).
@@ -0,0 +1,19 @@
1
+ import type { FastifyInstance } from "fastify";
2
+ export interface HealthContributor {
3
+ name: string;
4
+ check(): Promise<{
5
+ ok: boolean;
6
+ status?: "up" | "down";
7
+ details?: Record<string, unknown>;
8
+ }>;
9
+ }
10
+ /**
11
+ * Register a health contributor with the app (call from starters that have dependencies).
12
+ * The app must have been created with createApp so that _fastrackContext and _healthContributors exist.
13
+ */
14
+ export declare function registerHealthContributor(app: FastifyInstance, name: string, check: () => Promise<{
15
+ ok: boolean;
16
+ status?: "up" | "down";
17
+ details?: Record<string, unknown>;
18
+ }>): void;
19
+ //# sourceMappingURL=health.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"health.d.ts","sourceRoot":"","sources":["../src/health.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAG/C,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,IAAI,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC,CAAC;CAC9F;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,EAAE,eAAe,EACpB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,OAAO,CAAC;IAAE,EAAE,EAAE,OAAO,CAAC;IAAC,MAAM,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,CAAC,GAC/F,IAAI,CAKN"}
package/dist/health.js ADDED
@@ -0,0 +1,12 @@
1
+ import { getFastrackContext } from "@fastrack/core";
2
+ /**
3
+ * Register a health contributor with the app (call from starters that have dependencies).
4
+ * The app must have been created with createApp so that _fastrackContext and _healthContributors exist.
5
+ */
6
+ export function registerHealthContributor(app, name, check) {
7
+ const ctx = getFastrackContext(app);
8
+ if (ctx?.registerHealthContributor) {
9
+ ctx.registerHealthContributor(name, check);
10
+ }
11
+ }
12
+ //# sourceMappingURL=health.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"health.js","sourceRoot":"","sources":["../src/health.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAOpD;;;GAGG;AACH,MAAM,UAAU,yBAAyB,CACvC,GAAoB,EACpB,IAAY,EACZ,KAAgG;IAEhG,MAAM,GAAG,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;IACpC,IAAI,GAAG,EAAE,yBAAyB,EAAE,CAAC;QACnC,GAAG,CAAC,yBAAyB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;AACH,CAAC"}
@@ -0,0 +1,7 @@
1
+ /**
2
+ * @fastrack/starter-actuator — /live, /ready, /health, /info, /metrics.
3
+ */
4
+ export { actuatorStarter } from "./plugin.js";
5
+ export { registerHealthContributor, type HealthContributor } from "./health.js";
6
+ export type { ActuatorStarterConfig } from "./plugin.js";
7
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,yBAAyB,EAAE,KAAK,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChF,YAAY,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC"}
package/dist/index.js ADDED
@@ -0,0 +1,6 @@
1
+ /**
2
+ * @fastrack/starter-actuator — /live, /ready, /health, /info, /metrics.
3
+ */
4
+ export { actuatorStarter } from "./plugin.js";
5
+ export { registerHealthContributor } from "./health.js";
6
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,yBAAyB,EAA0B,MAAM,aAAa,CAAC"}
@@ -0,0 +1,13 @@
1
+ import { type Static } from "@sinclair/typebox";
2
+ import type { FastrackStarter } from "@fastrack/core";
3
+ export declare const ActuatorStarterConfigSchema: import("@sinclair/typebox").TObject<{
4
+ pathPrefix: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
5
+ enableLive: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
6
+ enableReady: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
7
+ enableHealth: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
8
+ enableInfo: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
9
+ enableMetrics: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
10
+ }>;
11
+ export type ActuatorStarterConfig = Static<typeof ActuatorStarterConfigSchema>;
12
+ export declare const actuatorStarter: FastrackStarter<ActuatorStarterConfig>;
13
+ //# sourceMappingURL=plugin.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEtD,OAAO,KAAK,EAAE,eAAe,EAAmB,MAAM,gBAAgB,CAAC;AAGvE,eAAO,MAAM,2BAA2B;;;;;;;EAOtC,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAE/E,eAAO,MAAM,eAAe,EAAE,eAAe,CAAC,qBAAqB,CA8ElE,CAAC"}
package/dist/plugin.js ADDED
@@ -0,0 +1,88 @@
1
+ import { Type } from "@sinclair/typebox";
2
+ import { getHealthContributors } from "@fastrack/core";
3
+ export const ActuatorStarterConfigSchema = Type.Object({
4
+ pathPrefix: Type.Optional(Type.String({ default: "" })),
5
+ enableLive: Type.Optional(Type.Boolean({ default: true })),
6
+ enableReady: Type.Optional(Type.Boolean({ default: true })),
7
+ enableHealth: Type.Optional(Type.Boolean({ default: true })),
8
+ enableInfo: Type.Optional(Type.Boolean({ default: true })),
9
+ enableMetrics: Type.Optional(Type.Boolean({ default: true })),
10
+ });
11
+ export const actuatorStarter = {
12
+ name: "actuator",
13
+ configSchema: ActuatorStarterConfigSchema,
14
+ defaults: {
15
+ pathPrefix: "",
16
+ enableLive: true,
17
+ enableReady: true,
18
+ enableHealth: true,
19
+ enableInfo: true,
20
+ enableMetrics: true,
21
+ },
22
+ register(app, ctx, config) {
23
+ const p = config.pathPrefix ?? "";
24
+ if (config.enableLive !== false) {
25
+ app.get(`${p}/live`, async (_request, reply) => {
26
+ return reply.status(200).send({ status: "up" });
27
+ });
28
+ }
29
+ if (config.enableReady !== false) {
30
+ app.get(`${p}/ready`, async (_request, reply) => {
31
+ const ready = ctx.getReadiness?.() ?? true;
32
+ const contributors = getHealthContributors(app);
33
+ const details = {};
34
+ if (contributors) {
35
+ for (const [name, check] of contributors) {
36
+ try {
37
+ const result = await check();
38
+ details[name] = result.ok ? "up" : "down";
39
+ }
40
+ catch {
41
+ details[name] = "down";
42
+ }
43
+ }
44
+ }
45
+ const allUp = ready && Object.values(details).every((v) => v === "up");
46
+ return reply.status(allUp ? 200 : 503).send({ status: allUp ? "up" : "down", details });
47
+ });
48
+ }
49
+ if (config.enableHealth !== false) {
50
+ app.get(`${p}/health`, async (_request, reply) => {
51
+ const contributors = getHealthContributors(app);
52
+ const details = {};
53
+ let ok = true;
54
+ if (contributors) {
55
+ for (const [name, check] of contributors) {
56
+ try {
57
+ const result = await check();
58
+ details[name] = result.details ?? (result.ok ? "up" : "down");
59
+ if (!result.ok)
60
+ ok = false;
61
+ }
62
+ catch (e) {
63
+ details[name] = "down";
64
+ ok = false;
65
+ }
66
+ }
67
+ }
68
+ return reply.status(ok ? 200 : 503).send({ status: ok ? "up" : "down", details });
69
+ });
70
+ }
71
+ if (config.enableInfo !== false) {
72
+ app.get(`${p}/info`, async (_request, reply) => {
73
+ return reply.send({
74
+ version: process.env.npm_package_version ?? "0.0.0",
75
+ env: process.env.NODE_ENV ?? "development",
76
+ node: process.version,
77
+ });
78
+ });
79
+ }
80
+ if (config.enableMetrics !== false) {
81
+ app.get(`${p}/metrics`, async (_request, reply) => {
82
+ reply.header("Content-Type", "text/plain; charset=utf-8");
83
+ return reply.send("# Fastrack metrics placeholder\n# Add Prometheus metrics here.\n");
84
+ });
85
+ }
86
+ },
87
+ };
88
+ //# sourceMappingURL=plugin.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAe,MAAM,mBAAmB,CAAC;AAGtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAEvD,MAAM,CAAC,MAAM,2BAA2B,GAAG,IAAI,CAAC,MAAM,CAAC;IACrD,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;IACvD,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1D,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3D,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5D,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1D,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;CAC9D,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,eAAe,GAA2C;IACrE,IAAI,EAAE,UAAU;IAChB,YAAY,EAAE,2BAA2B;IACzC,QAAQ,EAAE;QACR,UAAU,EAAE,EAAE;QACd,UAAU,EAAE,IAAI;QAChB,WAAW,EAAE,IAAI;QACjB,YAAY,EAAE,IAAI;QAClB,UAAU,EAAE,IAAI;QAChB,aAAa,EAAE,IAAI;KACpB;IACD,QAAQ,CAAC,GAAoB,EAAE,GAAoB,EAAE,MAA6B;QAChF,MAAM,CAAC,GAAG,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC;QAElC,IAAI,MAAM,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;YAChC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE;gBAC7C,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;YAClD,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,MAAM,CAAC,WAAW,KAAK,KAAK,EAAE,CAAC;YACjC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE;gBAC9C,MAAM,KAAK,GAAG,GAAG,CAAC,YAAY,EAAE,EAAE,IAAI,IAAI,CAAC;gBAC3C,MAAM,YAAY,GAAG,qBAAqB,CAAC,GAAG,CAAC,CAAC;gBAChD,MAAM,OAAO,GAA4B,EAAE,CAAC;gBAC5C,IAAI,YAAY,EAAE,CAAC;oBACjB,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,YAAY,EAAE,CAAC;wBACzC,IAAI,CAAC;4BACH,MAAM,MAAM,GAAG,MAAM,KAAK,EAAE,CAAC;4BAC7B,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;wBAC5C,CAAC;wBAAC,MAAM,CAAC;4BACP,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;wBACzB,CAAC;oBACH,CAAC;gBACH,CAAC;gBACD,MAAM,KAAK,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;gBACvE,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;YAC1F,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,MAAM,CAAC,YAAY,KAAK,KAAK,EAAE,CAAC;YAClC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE;gBAC/C,MAAM,YAAY,GAAG,qBAAqB,CAAC,GAAG,CAAC,CAAC;gBAChD,MAAM,OAAO,GAA4B,EAAE,CAAC;gBAC5C,IAAI,EAAE,GAAG,IAAI,CAAC;gBACd,IAAI,YAAY,EAAE,CAAC;oBACjB,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,YAAY,EAAE,CAAC;wBACzC,IAAI,CAAC;4BACH,MAAM,MAAM,GAAG,MAAM,KAAK,EAAE,CAAC;4BAC7B,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;4BAC9D,IAAI,CAAC,MAAM,CAAC,EAAE;gCAAE,EAAE,GAAG,KAAK,CAAC;wBAC7B,CAAC;wBAAC,OAAO,CAAC,EAAE,CAAC;4BACX,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;4BACvB,EAAE,GAAG,KAAK,CAAC;wBACb,CAAC;oBACH,CAAC;gBACH,CAAC;gBACD,OAAO,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;YACpF,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,MAAM,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;YAChC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE;gBAC7C,OAAO,KAAK,CAAC,IAAI,CAAC;oBAChB,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,OAAO;oBACnD,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,aAAa;oBAC1C,IAAI,EAAE,OAAO,CAAC,OAAO;iBACtB,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,MAAM,CAAC,aAAa,KAAK,KAAK,EAAE,CAAC;YACnC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE;gBAChD,KAAK,CAAC,MAAM,CAAC,cAAc,EAAE,2BAA2B,CAAC,CAAC;gBAC1D,OAAO,KAAK,CAAC,IAAI,CAAC,kEAAkE,CAAC,CAAC;YACxF,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;CACF,CAAC"}
package/package.json ADDED
@@ -0,0 +1,35 @@
1
+ {
2
+ "name": "@fastrack/starter-actuator",
3
+ "version": "0.1.0",
4
+ "type": "module",
5
+ "main": "dist/index.js",
6
+ "types": "dist/index.d.ts",
7
+ "exports": {
8
+ ".": {
9
+ "types": "./dist/index.d.ts",
10
+ "import": "./dist/index.js",
11
+ "default": "./dist/index.js"
12
+ }
13
+ },
14
+ "dependencies": {
15
+ "@sinclair/typebox": "^0.34.34",
16
+ "fastify": "^5.1.0",
17
+ "@fastrack/core": "0.1.0"
18
+ },
19
+ "devDependencies": {
20
+ "typescript": "^5.6.3"
21
+ },
22
+ "publishConfig": {
23
+ "access": "public",
24
+ "registry": "https://registry.npmjs.org/"
25
+ },
26
+ "engines": {
27
+ "node": ">=18"
28
+ },
29
+ "scripts": {
30
+ "build": "tsc -p tsconfig.json",
31
+ "clean": "node -e \"require('fs').rmSync('dist',{recursive:true,force:true})\"",
32
+ "lint": "echo ok",
33
+ "test": "echo ok"
34
+ }
35
+ }
package/src/health.ts ADDED
@@ -0,0 +1,22 @@
1
+ import type { FastifyInstance } from "fastify";
2
+ import { getFastrackContext } from "@fastrack/core";
3
+
4
+ export interface HealthContributor {
5
+ name: string;
6
+ check(): Promise<{ ok: boolean; status?: "up" | "down"; details?: Record<string, unknown> }>;
7
+ }
8
+
9
+ /**
10
+ * Register a health contributor with the app (call from starters that have dependencies).
11
+ * The app must have been created with createApp so that _fastrackContext and _healthContributors exist.
12
+ */
13
+ export function registerHealthContributor(
14
+ app: FastifyInstance,
15
+ name: string,
16
+ check: () => Promise<{ ok: boolean; status?: "up" | "down"; details?: Record<string, unknown> }>
17
+ ): void {
18
+ const ctx = getFastrackContext(app);
19
+ if (ctx?.registerHealthContributor) {
20
+ ctx.registerHealthContributor(name, check);
21
+ }
22
+ }
package/src/index.ts ADDED
@@ -0,0 +1,6 @@
1
+ /**
2
+ * @fastrack/starter-actuator — /live, /ready, /health, /info, /metrics.
3
+ */
4
+ export { actuatorStarter } from "./plugin.js";
5
+ export { registerHealthContributor, type HealthContributor } from "./health.js";
6
+ export type { ActuatorStarterConfig } from "./plugin.js";
package/src/plugin.ts ADDED
@@ -0,0 +1,95 @@
1
+ import { Type, type Static } from "@sinclair/typebox";
2
+ import type { FastifyInstance } from "fastify";
3
+ import type { FastrackStarter, FastrackContext } from "@fastrack/core";
4
+ import { getHealthContributors } from "@fastrack/core";
5
+
6
+ export const ActuatorStarterConfigSchema = Type.Object({
7
+ pathPrefix: Type.Optional(Type.String({ default: "" })),
8
+ enableLive: Type.Optional(Type.Boolean({ default: true })),
9
+ enableReady: Type.Optional(Type.Boolean({ default: true })),
10
+ enableHealth: Type.Optional(Type.Boolean({ default: true })),
11
+ enableInfo: Type.Optional(Type.Boolean({ default: true })),
12
+ enableMetrics: Type.Optional(Type.Boolean({ default: true })),
13
+ });
14
+
15
+ export type ActuatorStarterConfig = Static<typeof ActuatorStarterConfigSchema>;
16
+
17
+ export const actuatorStarter: FastrackStarter<ActuatorStarterConfig> = {
18
+ name: "actuator",
19
+ configSchema: ActuatorStarterConfigSchema,
20
+ defaults: {
21
+ pathPrefix: "",
22
+ enableLive: true,
23
+ enableReady: true,
24
+ enableHealth: true,
25
+ enableInfo: true,
26
+ enableMetrics: true,
27
+ },
28
+ register(app: FastifyInstance, ctx: FastrackContext, config: ActuatorStarterConfig) {
29
+ const p = config.pathPrefix ?? "";
30
+
31
+ if (config.enableLive !== false) {
32
+ app.get(`${p}/live`, async (_request, reply) => {
33
+ return reply.status(200).send({ status: "up" });
34
+ });
35
+ }
36
+
37
+ if (config.enableReady !== false) {
38
+ app.get(`${p}/ready`, async (_request, reply) => {
39
+ const ready = ctx.getReadiness?.() ?? true;
40
+ const contributors = getHealthContributors(app);
41
+ const details: Record<string, unknown> = {};
42
+ if (contributors) {
43
+ for (const [name, check] of contributors) {
44
+ try {
45
+ const result = await check();
46
+ details[name] = result.ok ? "up" : "down";
47
+ } catch {
48
+ details[name] = "down";
49
+ }
50
+ }
51
+ }
52
+ const allUp = ready && Object.values(details).every((v) => v === "up");
53
+ return reply.status(allUp ? 200 : 503).send({ status: allUp ? "up" : "down", details });
54
+ });
55
+ }
56
+
57
+ if (config.enableHealth !== false) {
58
+ app.get(`${p}/health`, async (_request, reply) => {
59
+ const contributors = getHealthContributors(app);
60
+ const details: Record<string, unknown> = {};
61
+ let ok = true;
62
+ if (contributors) {
63
+ for (const [name, check] of contributors) {
64
+ try {
65
+ const result = await check();
66
+ details[name] = result.details ?? (result.ok ? "up" : "down");
67
+ if (!result.ok) ok = false;
68
+ } catch (e) {
69
+ details[name] = "down";
70
+ ok = false;
71
+ }
72
+ }
73
+ }
74
+ return reply.status(ok ? 200 : 503).send({ status: ok ? "up" : "down", details });
75
+ });
76
+ }
77
+
78
+ if (config.enableInfo !== false) {
79
+ app.get(`${p}/info`, async (_request, reply) => {
80
+ return reply.send({
81
+ version: process.env.npm_package_version ?? "0.0.0",
82
+ env: process.env.NODE_ENV ?? "development",
83
+ node: process.version,
84
+ });
85
+ });
86
+ }
87
+
88
+ if (config.enableMetrics !== false) {
89
+ app.get(`${p}/metrics`, async (_request, reply) => {
90
+ reply.header("Content-Type", "text/plain; charset=utf-8");
91
+ return reply.send("# Fastrack metrics placeholder\n# Add Prometheus metrics here.\n");
92
+ });
93
+ }
94
+ },
95
+ };
package/tsconfig.json ADDED
@@ -0,0 +1,6 @@
1
+ {
2
+ "extends": "../../tsconfig.base.json",
3
+ "compilerOptions": { "outDir": "dist", "rootDir": "src" },
4
+ "include": ["src/**/*"],
5
+ "exclude": ["node_modules", "dist", "**/*.test.ts", "**/*.spec.ts"]
6
+ }