@geekmidas/constructs 9.3.0 → 9.5.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/CHANGELOG.md +82 -0
- package/dist/{AWSScheduledFunction-Dg6TPIxn.d.mts → AWSScheduledFunction--49dTSUQ.d.mts} +8 -2
- package/dist/AWSScheduledFunction--49dTSUQ.d.mts.map +1 -0
- package/dist/{AWSScheduledFunction-CU7mMGFA.mjs → AWSScheduledFunction-BXmRm9W6.mjs} +4 -3
- package/dist/{AWSScheduledFunction-CU7mMGFA.mjs.map → AWSScheduledFunction-BXmRm9W6.mjs.map} +1 -1
- package/dist/{AWSScheduledFunction-CKhVurOa.cjs → AWSScheduledFunction-C-JBSNak.cjs} +6 -5
- package/dist/{AWSScheduledFunction-CKhVurOa.cjs.map → AWSScheduledFunction-C-JBSNak.cjs.map} +1 -1
- package/dist/{AWSScheduledFunction-DAGP_vz5.d.cts → AWSScheduledFunction-D0_HIJj8.d.cts} +8 -2
- package/dist/AWSScheduledFunction-D0_HIJj8.d.cts.map +1 -0
- package/dist/{Construct-D_3yZ9m5.d.cts → Construct-BEh2DSMe.d.cts} +7 -13
- package/dist/Construct-BEh2DSMe.d.cts.map +1 -0
- package/dist/{Construct-D09WUUOf.cjs → Construct-Cf_0pAvo.cjs} +2 -10
- package/dist/Construct-Cf_0pAvo.cjs.map +1 -0
- package/dist/{Construct-D0uZvbr3.mjs → Construct-D5LZBFhb.mjs} +3 -11
- package/dist/Construct-D5LZBFhb.mjs.map +1 -0
- package/dist/{Construct-DsqpiAym.d.mts → Construct-qnOnQTcP.d.mts} +7 -13
- package/dist/Construct-qnOnQTcP.d.mts.map +1 -0
- package/dist/{Endpoint-CxBdXNZm.d.cts → Endpoint-DIQblT3d.d.cts} +2 -2
- package/dist/Endpoint-DIQblT3d.d.cts.map +1 -0
- package/dist/{Endpoint-DEydLuBs.d.mts → Endpoint-ZtG0zVz1.d.mts} +4 -4
- package/dist/{Endpoint-DEydLuBs.d.mts.map → Endpoint-ZtG0zVz1.d.mts.map} +1 -1
- package/dist/{HonoEndpointAdaptor-DCD0rhFg.cjs → HonoEndpointAdaptor-1aMXc8F3.cjs} +12 -19
- package/dist/HonoEndpointAdaptor-1aMXc8F3.cjs.map +1 -0
- package/dist/{HonoEndpointAdaptor-CJfFQ5KR.mjs → HonoEndpointAdaptor-BcVAeMLW.mjs} +11 -18
- package/dist/HonoEndpointAdaptor-BcVAeMLW.mjs.map +1 -0
- package/dist/Queue-915lgS2D.mjs +62 -0
- package/dist/Queue-915lgS2D.mjs.map +1 -0
- package/dist/Queue-HbdYCQ-X.cjs +73 -0
- package/dist/Queue-HbdYCQ-X.cjs.map +1 -0
- package/dist/{Queue-Brw--scg.d.cts → Queue-I5NfFV0V.d.mts} +30 -5
- package/dist/{Queue-Brw--scg.d.cts.map → Queue-I5NfFV0V.d.mts.map} +1 -1
- package/dist/{Queue-D5z1bwFu.d.mts → Queue-XQNGO6_-.d.cts} +30 -5
- package/dist/{Queue-D5z1bwFu.d.mts.map → Queue-XQNGO6_-.d.cts.map} +1 -1
- package/dist/{Subscriber-CJ22tp8r.d.mts → Subscriber-Bjil86Ub.d.mts} +2 -2
- package/dist/{Subscriber-CJ22tp8r.d.mts.map → Subscriber-Bjil86Ub.d.mts.map} +1 -1
- package/dist/{Subscriber-DvKSp0N4.d.cts → Subscriber-YwPpHrBc.d.cts} +2 -2
- package/dist/{Subscriber-DvKSp0N4.d.cts.map → Subscriber-YwPpHrBc.d.cts.map} +1 -1
- package/dist/{Topic-BMfrIFdX.d.cts → Topic-D8-wkoh4.d.mts} +3 -3
- package/dist/{Topic-B-fxOsR2.d.mts.map → Topic-D8-wkoh4.d.mts.map} +1 -1
- package/dist/{Topic-B-fxOsR2.d.mts → Topic-dIcPqSLa.d.cts} +3 -3
- package/dist/{Topic-BMfrIFdX.d.cts.map → Topic-dIcPqSLa.d.cts.map} +1 -1
- package/dist/adaptors/aws.cjs +29 -22
- package/dist/adaptors/aws.cjs.map +1 -1
- package/dist/adaptors/aws.d.cts +10 -9
- package/dist/adaptors/aws.d.cts.map +1 -1
- package/dist/adaptors/aws.d.mts +12 -11
- package/dist/adaptors/aws.d.mts.map +1 -1
- package/dist/adaptors/aws.mjs +29 -22
- package/dist/adaptors/aws.mjs.map +1 -1
- package/dist/adaptors/hono.cjs +7 -7
- package/dist/adaptors/hono.d.cts +3 -3
- package/dist/adaptors/hono.d.cts.map +1 -1
- package/dist/adaptors/hono.d.mts +5 -5
- package/dist/adaptors/hono.d.mts.map +1 -1
- package/dist/adaptors/hono.mjs +7 -7
- package/dist/adaptors/testing.cjs +32 -31
- package/dist/adaptors/testing.cjs.map +1 -1
- package/dist/adaptors/testing.d.cts +12 -6
- package/dist/adaptors/testing.d.cts.map +1 -1
- package/dist/adaptors/testing.d.mts +14 -8
- package/dist/adaptors/testing.d.mts.map +1 -1
- package/dist/adaptors/testing.mjs +32 -31
- package/dist/adaptors/testing.mjs.map +1 -1
- package/dist/{clone-I_WIpiFf.cjs → clone-BQnYiRgm.cjs} +1 -1
- package/dist/{clone-I_WIpiFf.cjs.map → clone-BQnYiRgm.cjs.map} +1 -1
- package/dist/{clone-pdXxc0t3.mjs → clone-BWIwx6vL.mjs} +1 -1
- package/dist/{clone-pdXxc0t3.mjs.map → clone-BWIwx6vL.mjs.map} +1 -1
- package/dist/crons/index.cjs +27 -6
- package/dist/crons/index.cjs.map +1 -1
- package/dist/crons/index.d.cts +13 -3
- package/dist/crons/index.d.cts.map +1 -1
- package/dist/crons/index.d.mts +13 -3
- package/dist/crons/index.d.mts.map +1 -1
- package/dist/crons/index.mjs +27 -6
- package/dist/crons/index.mjs.map +1 -1
- package/dist/endpoints/index.cjs +7 -32
- package/dist/endpoints/index.cjs.map +1 -1
- package/dist/endpoints/index.d.cts +6 -14
- package/dist/endpoints/index.d.cts.map +1 -1
- package/dist/endpoints/index.d.mts +6 -14
- package/dist/endpoints/index.d.mts.map +1 -1
- package/dist/endpoints/index.mjs +7 -32
- package/dist/endpoints/index.mjs.map +1 -1
- package/dist/functions/index.cjs +3 -3
- package/dist/functions/index.d.cts +2 -2
- package/dist/functions/index.d.mts +2 -2
- package/dist/functions/index.mjs +3 -3
- package/dist/{functions-DhkDodl0.mjs → functions-CNJbRq0O.mjs} +4 -89
- package/dist/functions-CNJbRq0O.mjs.map +1 -0
- package/dist/{functions-B3OFv3QV.cjs → functions-DzjxHo1V.cjs} +3 -100
- package/dist/functions-DzjxHo1V.cjs.map +1 -0
- package/dist/{index-B8LNLQXD.d.mts → index-CbhtERFB.d.mts} +2 -8
- package/dist/index-CbhtERFB.d.mts.map +1 -0
- package/dist/{index-CeoLMr7c.d.cts → index-XJKTxGx7.d.cts} +6 -12
- package/dist/index-XJKTxGx7.d.cts.map +1 -0
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +1 -1
- package/dist/index.d.mts +3 -3
- package/dist/index.mjs +1 -1
- package/dist/{lazyAccessors-C1n1QfEj.cjs → lazyAccessors-BZJl6bx_.cjs} +3 -3
- package/dist/{lazyAccessors-C1n1QfEj.cjs.map → lazyAccessors-BZJl6bx_.cjs.map} +1 -1
- package/dist/{lazyAccessors-fFIQrblM.mjs → lazyAccessors-BjAZqRqK.mjs} +3 -3
- package/dist/{lazyAccessors-fFIQrblM.mjs.map → lazyAccessors-BjAZqRqK.mjs.map} +1 -1
- package/dist/monitor-D3uHJ8DU.cjs +67 -0
- package/dist/monitor-D3uHJ8DU.cjs.map +1 -0
- package/dist/monitor-Dt7fiasS.mjs +61 -0
- package/dist/monitor-Dt7fiasS.mjs.map +1 -0
- package/dist/monitors/index.cjs +2 -2
- package/dist/monitors/index.cjs.map +1 -1
- package/dist/monitors/index.d.cts +2 -2
- package/dist/monitors/index.d.cts.map +1 -1
- package/dist/monitors/index.d.mts +2 -2
- package/dist/monitors/index.mjs +2 -2
- package/dist/monitors/index.mjs.map +1 -1
- package/dist/{processAudits-CwyaaSQc.mjs → processAudits-BEiSkgH3.mjs} +1 -1
- package/dist/{processAudits-CwyaaSQc.mjs.map → processAudits-BEiSkgH3.mjs.map} +1 -1
- package/dist/{processAudits-94Ar_EJF.cjs → processAudits-Cd912Eck.cjs} +2 -2
- package/dist/{processAudits-94Ar_EJF.cjs.map → processAudits-Cd912Eck.cjs.map} +1 -1
- package/dist/{publisher-BZgcrVPy.cjs → publisher-B6Wu-JNv.cjs} +1 -1
- package/dist/{publisher-BZgcrVPy.cjs.map → publisher-B6Wu-JNv.cjs.map} +1 -1
- package/dist/{publisher-CnpeMv-r.mjs → publisher-Cs7WcvJl.mjs} +1 -1
- package/dist/{publisher-CnpeMv-r.mjs.map → publisher-Cs7WcvJl.mjs.map} +1 -1
- package/dist/queue/index.cjs +6 -57
- package/dist/queue/index.cjs.map +1 -1
- package/dist/queue/index.d.cts +3 -3
- package/dist/queue/index.d.cts.map +1 -1
- package/dist/queue/index.d.mts +3 -3
- package/dist/queue/index.d.mts.map +1 -1
- package/dist/queue/index.mjs +5 -57
- package/dist/queue/index.mjs.map +1 -1
- package/dist/subscribers/index.cjs +2 -2
- package/dist/subscribers/index.d.cts +3 -3
- package/dist/subscribers/index.d.mts +3 -3
- package/dist/subscribers/index.mjs +2 -2
- package/dist/{telemetry-C--EgYVr.d.mts → telemetry-vq7C0ZBy.d.mts} +1 -1
- package/dist/{telemetry-C--EgYVr.d.mts.map → telemetry-vq7C0ZBy.d.mts.map} +1 -1
- package/dist/topic/index.cjs +2 -2
- package/dist/topic/index.d.cts +2 -2
- package/dist/topic/index.d.mts +2 -2
- package/dist/topic/index.mjs +2 -2
- package/dist/{types-DNngH0fX.d.mts → types-X37z95fN.d.mts} +1 -1
- package/dist/{types-DNngH0fX.d.mts.map → types-X37z95fN.d.mts.map} +1 -1
- package/dist/types.d.mts +1 -1
- package/package.json +22 -22
- package/src/Construct.ts +2 -13
- package/src/__tests__/uptime.spec.ts +340 -0
- package/src/crons/Cron.ts +10 -0
- package/src/crons/CronBuilder.ts +15 -1
- package/src/endpoints/AmazonApiGatewayEndpointAdaptor.ts +2 -23
- package/src/endpoints/EndpointBuilder.ts +1 -4
- package/src/endpoints/EndpointFactory.ts +0 -31
- package/src/endpoints/HonoEndpointAdaptor.ts +1 -16
- package/src/endpoints/TestEndpointAdaptor.ts +4 -20
- package/src/functions/BaseFunctionBuilder.ts +0 -10
- package/src/functions/FunctionBuilder.ts +0 -2
- package/src/monitor.ts +14 -55
- package/src/monitors/heartbeat.ts +4 -2
- package/src/queue/AWSLambdaQueueAdaptor.ts +33 -8
- package/src/queue/Queue.ts +35 -1
- package/src/queue/TestQueueAdaptor.ts +18 -4
- package/src/queue/__tests__/AWSLambdaQueueAdaptor.spec.ts +131 -0
- package/src/queue/__tests__/TestQueueAdaptor.spec.ts +58 -0
- package/src/queue/index.ts +3 -0
- package/dist/AWSScheduledFunction-DAGP_vz5.d.cts.map +0 -1
- package/dist/AWSScheduledFunction-Dg6TPIxn.d.mts.map +0 -1
- package/dist/Construct-D09WUUOf.cjs.map +0 -1
- package/dist/Construct-D0uZvbr3.mjs.map +0 -1
- package/dist/Construct-D_3yZ9m5.d.cts.map +0 -1
- package/dist/Construct-DsqpiAym.d.mts.map +0 -1
- package/dist/Endpoint-CxBdXNZm.d.cts.map +0 -1
- package/dist/HonoEndpointAdaptor-CJfFQ5KR.mjs.map +0 -1
- package/dist/HonoEndpointAdaptor-DCD0rhFg.cjs.map +0 -1
- package/dist/functions-B3OFv3QV.cjs.map +0 -1
- package/dist/functions-DhkDodl0.mjs.map +0 -1
- package/dist/index-B8LNLQXD.d.mts.map +0 -1
- package/dist/index-CeoLMr7c.d.cts.map +0 -1
- package/src/__tests__/monitor.spec.ts +0 -696
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
|
|
2
|
+
//#region src/monitor.ts
|
|
3
|
+
const NOOP_RUN = {
|
|
4
|
+
async success() {},
|
|
5
|
+
async failure() {}
|
|
6
|
+
};
|
|
7
|
+
/**
|
|
8
|
+
* Start a construct's monitors for one run.
|
|
9
|
+
*
|
|
10
|
+
* Never throws: a monitor that fails to register, start or report is logged,
|
|
11
|
+
* and the run goes on without it.
|
|
12
|
+
*/
|
|
13
|
+
async function startMonitors(construct, serviceDiscovery, logger) {
|
|
14
|
+
if (!construct.monitors.length) return NOOP_RUN;
|
|
15
|
+
const ctx = {
|
|
16
|
+
type: construct.type,
|
|
17
|
+
logger
|
|
18
|
+
};
|
|
19
|
+
let started;
|
|
20
|
+
try {
|
|
21
|
+
const registered = await serviceDiscovery.register([...construct.monitors]);
|
|
22
|
+
started = await Promise.all(construct.monitors.map(async ({ serviceName }) => {
|
|
23
|
+
const monitor = registered[serviceName];
|
|
24
|
+
let run;
|
|
25
|
+
try {
|
|
26
|
+
run = await monitor.start?.(ctx);
|
|
27
|
+
} catch (error) {
|
|
28
|
+
logger.warn({
|
|
29
|
+
error,
|
|
30
|
+
monitor: serviceName
|
|
31
|
+
}, "Monitor failed to start");
|
|
32
|
+
}
|
|
33
|
+
return {
|
|
34
|
+
monitor,
|
|
35
|
+
run
|
|
36
|
+
};
|
|
37
|
+
}));
|
|
38
|
+
} catch (error) {
|
|
39
|
+
logger.warn({ error }, "Monitors could not be registered");
|
|
40
|
+
return NOOP_RUN;
|
|
41
|
+
}
|
|
42
|
+
const report = async (call) => {
|
|
43
|
+
const results = await Promise.allSettled(started.map(({ monitor, run }) => call(monitor, run)));
|
|
44
|
+
for (const result of results) if (result.status === "rejected") logger.warn({ error: result.reason }, "Monitor failed to report");
|
|
45
|
+
};
|
|
46
|
+
return {
|
|
47
|
+
success: (output) => report((monitor, run) => monitor.success({
|
|
48
|
+
...ctx,
|
|
49
|
+
run,
|
|
50
|
+
output
|
|
51
|
+
})),
|
|
52
|
+
failure: (error) => report((monitor, run) => monitor.failure({
|
|
53
|
+
...ctx,
|
|
54
|
+
run,
|
|
55
|
+
error
|
|
56
|
+
}))
|
|
57
|
+
};
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
//#endregion
|
|
61
|
+
Object.defineProperty(exports, 'startMonitors', {
|
|
62
|
+
enumerable: true,
|
|
63
|
+
get: function () {
|
|
64
|
+
return startMonitors;
|
|
65
|
+
}
|
|
66
|
+
});
|
|
67
|
+
//# sourceMappingURL=monitor-D3uHJ8DU.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"monitor-D3uHJ8DU.cjs","names":["NOOP_RUN: MonitoredRun","construct: { type: ConstructType; monitors: readonly MonitorService[] }","serviceDiscovery: ServiceDiscovery<any>","logger: Logger","ctx: MonitorContext","started: { monitor: ConstructMonitor<any>; run: unknown }[]","registered: Record<string, unknown>","run: unknown","call: (monitor: ConstructMonitor<any>, run: unknown) => Promise<void>"],"sources":["../src/monitor.ts"],"sourcesContent":["import type { Logger } from '@geekmidas/logger';\nimport type { Service, ServiceDiscovery } from '@geekmidas/services';\nimport type { ConstructType } from './Construct';\n\n/**\n * What a monitor is told about the cron whose run it is reporting.\n */\nexport interface MonitorContext {\n\t/** The kind of construct, always a cron. */\n\ttype: ConstructType;\n\tlogger: Logger;\n}\n\n/**\n * Reports a cron's runs to an uptime service, set with `.uptime()`, so a cron\n * that stops running is noticed. A failure is already logged where it\n * happens; what only a monitor can report is a run that never happened.\n *\n * `start` runs before the handler and whatever it returns is handed back to\n * `success` or `failure`, so a provider that pairs the two (a check-in id) can.\n * A monitor that throws is logged and ignored: monitoring must never turn a\n * successful run into a failed one.\n */\nexport interface ConstructMonitor<TRun = unknown> {\n\tstart?(ctx: MonitorContext): Promise<TRun>;\n\tsuccess(ctx: MonitorContext & { run: TRun; output: unknown }): Promise<void>;\n\tfailure(ctx: MonitorContext & { run: TRun; error: unknown }): Promise<void>;\n}\n\n/**\n * A monitor as the build manifest records it, so infrastructure can provision\n * what it reports to: a heartbeat's URL, set in the variable it reads.\n */\nexport interface MonitorInfo {\n\t/** The kind of monitor, e.g. `heartbeat`. */\n\ttype: string;\n\t/** The service it reports to, e.g. `betterStack`. Absent for a custom one. */\n\tprovider?: string;\n\t/** The environment variable it reads its target from. */\n\tenv?: string;\n}\n\nexport type MonitorService = Service<string, ConstructMonitor<any>> & {\n\t/** How the manifest records this monitor. Defaults to its service name. */\n\tmonitor?: MonitorInfo;\n};\n\n/** A run in progress, closed by exactly one of its two methods. */\nexport interface MonitoredRun {\n\tsuccess(output: unknown): Promise<void>;\n\tfailure(error: unknown): Promise<void>;\n}\n\nconst NOOP_RUN: MonitoredRun = {\n\tasync success() {},\n\tasync failure() {},\n};\n\n/**\n * Start a construct's monitors for one run.\n *\n * Never throws: a monitor that fails to register, start or report is logged,\n * and the run goes on without it.\n */\nexport async function startMonitors(\n\tconstruct: { type: ConstructType; monitors: readonly MonitorService[] },\n\tserviceDiscovery: ServiceDiscovery<any>,\n\tlogger: Logger,\n): Promise<MonitoredRun> {\n\tif (!construct.monitors.length) {\n\t\treturn NOOP_RUN;\n\t}\n\n\tconst ctx: MonitorContext = { type: construct.type, logger };\n\n\tlet started: { monitor: ConstructMonitor<any>; run: unknown }[];\n\ttry {\n\t\tconst registered: Record<string, unknown> = await serviceDiscovery.register(\n\t\t\t[...construct.monitors],\n\t\t);\n\t\tstarted = await Promise.all(\n\t\t\tconstruct.monitors.map(async ({ serviceName }) => {\n\t\t\t\tconst monitor = registered[serviceName] as ConstructMonitor<any>;\n\t\t\t\tlet run: unknown;\n\t\t\t\ttry {\n\t\t\t\t\trun = await monitor.start?.(ctx);\n\t\t\t\t} catch (error) {\n\t\t\t\t\tlogger.warn(\n\t\t\t\t\t\t{ error, monitor: serviceName },\n\t\t\t\t\t\t'Monitor failed to start',\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t\treturn { monitor, run };\n\t\t\t}),\n\t\t);\n\t} catch (error) {\n\t\tlogger.warn({ error }, 'Monitors could not be registered');\n\t\treturn NOOP_RUN;\n\t}\n\n\tconst report = async (\n\t\tcall: (monitor: ConstructMonitor<any>, run: unknown) => Promise<void>,\n\t) => {\n\t\tconst results = await Promise.allSettled(\n\t\t\tstarted.map(({ monitor, run }) => call(monitor, run)),\n\t\t);\n\t\tfor (const result of results) {\n\t\t\tif (result.status === 'rejected') {\n\t\t\t\tlogger.warn({ error: result.reason }, 'Monitor failed to report');\n\t\t\t}\n\t\t}\n\t};\n\n\treturn {\n\t\tsuccess: (output) =>\n\t\t\treport((monitor, run) => monitor.success({ ...ctx, run, output })),\n\t\tfailure: (error) =>\n\t\t\treport((monitor, run) => monitor.failure({ ...ctx, run, error })),\n\t};\n}\n"],"mappings":";;AAqDA,MAAMA,WAAyB;CAC9B,MAAM,UAAU,CAAE;CAClB,MAAM,UAAU,CAAE;AAClB;;;;;;;AAQD,eAAsB,cACrBC,WACAC,kBACAC,QACwB;AACxB,MAAK,UAAU,SAAS,OACvB,QAAO;CAGR,MAAMC,MAAsB;EAAE,MAAM,UAAU;EAAM;CAAQ;CAE5D,IAAIC;AACJ,KAAI;EACH,MAAMC,aAAsC,MAAM,iBAAiB,SAClE,CAAC,GAAG,UAAU,QAAS,EACvB;AACD,YAAU,MAAM,QAAQ,IACvB,UAAU,SAAS,IAAI,OAAO,EAAE,aAAa,KAAK;GACjD,MAAM,UAAU,WAAW;GAC3B,IAAIC;AACJ,OAAI;AACH,UAAM,MAAM,QAAQ,QAAQ,IAAI;GAChC,SAAQ,OAAO;AACf,WAAO,KACN;KAAE;KAAO,SAAS;IAAa,GAC/B,0BACA;GACD;AACD,UAAO;IAAE;IAAS;GAAK;EACvB,EAAC,CACF;CACD,SAAQ,OAAO;AACf,SAAO,KAAK,EAAE,MAAO,GAAE,mCAAmC;AAC1D,SAAO;CACP;CAED,MAAM,SAAS,OACdC,SACI;EACJ,MAAM,UAAU,MAAM,QAAQ,WAC7B,QAAQ,IAAI,CAAC,EAAE,SAAS,KAAK,KAAK,KAAK,SAAS,IAAI,CAAC,CACrD;AACD,OAAK,MAAM,UAAU,QACpB,KAAI,OAAO,WAAW,WACrB,QAAO,KAAK,EAAE,OAAO,OAAO,OAAQ,GAAE,2BAA2B;CAGnE;AAED,QAAO;EACN,SAAS,CAAC,WACT,OAAO,CAAC,SAAS,QAAQ,QAAQ,QAAQ;GAAE,GAAG;GAAK;GAAK;EAAQ,EAAC,CAAC;EACnE,SAAS,CAAC,UACT,OAAO,CAAC,SAAS,QAAQ,QAAQ,QAAQ;GAAE,GAAG;GAAK;GAAK;EAAO,EAAC,CAAC;CAClE;AACD"}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
//#region src/monitor.ts
|
|
2
|
+
const NOOP_RUN = {
|
|
3
|
+
async success() {},
|
|
4
|
+
async failure() {}
|
|
5
|
+
};
|
|
6
|
+
/**
|
|
7
|
+
* Start a construct's monitors for one run.
|
|
8
|
+
*
|
|
9
|
+
* Never throws: a monitor that fails to register, start or report is logged,
|
|
10
|
+
* and the run goes on without it.
|
|
11
|
+
*/
|
|
12
|
+
async function startMonitors(construct, serviceDiscovery, logger) {
|
|
13
|
+
if (!construct.monitors.length) return NOOP_RUN;
|
|
14
|
+
const ctx = {
|
|
15
|
+
type: construct.type,
|
|
16
|
+
logger
|
|
17
|
+
};
|
|
18
|
+
let started;
|
|
19
|
+
try {
|
|
20
|
+
const registered = await serviceDiscovery.register([...construct.monitors]);
|
|
21
|
+
started = await Promise.all(construct.monitors.map(async ({ serviceName }) => {
|
|
22
|
+
const monitor = registered[serviceName];
|
|
23
|
+
let run;
|
|
24
|
+
try {
|
|
25
|
+
run = await monitor.start?.(ctx);
|
|
26
|
+
} catch (error) {
|
|
27
|
+
logger.warn({
|
|
28
|
+
error,
|
|
29
|
+
monitor: serviceName
|
|
30
|
+
}, "Monitor failed to start");
|
|
31
|
+
}
|
|
32
|
+
return {
|
|
33
|
+
monitor,
|
|
34
|
+
run
|
|
35
|
+
};
|
|
36
|
+
}));
|
|
37
|
+
} catch (error) {
|
|
38
|
+
logger.warn({ error }, "Monitors could not be registered");
|
|
39
|
+
return NOOP_RUN;
|
|
40
|
+
}
|
|
41
|
+
const report = async (call) => {
|
|
42
|
+
const results = await Promise.allSettled(started.map(({ monitor, run }) => call(monitor, run)));
|
|
43
|
+
for (const result of results) if (result.status === "rejected") logger.warn({ error: result.reason }, "Monitor failed to report");
|
|
44
|
+
};
|
|
45
|
+
return {
|
|
46
|
+
success: (output) => report((monitor, run) => monitor.success({
|
|
47
|
+
...ctx,
|
|
48
|
+
run,
|
|
49
|
+
output
|
|
50
|
+
})),
|
|
51
|
+
failure: (error) => report((monitor, run) => monitor.failure({
|
|
52
|
+
...ctx,
|
|
53
|
+
run,
|
|
54
|
+
error
|
|
55
|
+
}))
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
//#endregion
|
|
60
|
+
export { startMonitors };
|
|
61
|
+
//# sourceMappingURL=monitor-Dt7fiasS.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"monitor-Dt7fiasS.mjs","names":["NOOP_RUN: MonitoredRun","construct: { type: ConstructType; monitors: readonly MonitorService[] }","serviceDiscovery: ServiceDiscovery<any>","logger: Logger","ctx: MonitorContext","started: { monitor: ConstructMonitor<any>; run: unknown }[]","registered: Record<string, unknown>","run: unknown","call: (monitor: ConstructMonitor<any>, run: unknown) => Promise<void>"],"sources":["../src/monitor.ts"],"sourcesContent":["import type { Logger } from '@geekmidas/logger';\nimport type { Service, ServiceDiscovery } from '@geekmidas/services';\nimport type { ConstructType } from './Construct';\n\n/**\n * What a monitor is told about the cron whose run it is reporting.\n */\nexport interface MonitorContext {\n\t/** The kind of construct, always a cron. */\n\ttype: ConstructType;\n\tlogger: Logger;\n}\n\n/**\n * Reports a cron's runs to an uptime service, set with `.uptime()`, so a cron\n * that stops running is noticed. A failure is already logged where it\n * happens; what only a monitor can report is a run that never happened.\n *\n * `start` runs before the handler and whatever it returns is handed back to\n * `success` or `failure`, so a provider that pairs the two (a check-in id) can.\n * A monitor that throws is logged and ignored: monitoring must never turn a\n * successful run into a failed one.\n */\nexport interface ConstructMonitor<TRun = unknown> {\n\tstart?(ctx: MonitorContext): Promise<TRun>;\n\tsuccess(ctx: MonitorContext & { run: TRun; output: unknown }): Promise<void>;\n\tfailure(ctx: MonitorContext & { run: TRun; error: unknown }): Promise<void>;\n}\n\n/**\n * A monitor as the build manifest records it, so infrastructure can provision\n * what it reports to: a heartbeat's URL, set in the variable it reads.\n */\nexport interface MonitorInfo {\n\t/** The kind of monitor, e.g. `heartbeat`. */\n\ttype: string;\n\t/** The service it reports to, e.g. `betterStack`. Absent for a custom one. */\n\tprovider?: string;\n\t/** The environment variable it reads its target from. */\n\tenv?: string;\n}\n\nexport type MonitorService = Service<string, ConstructMonitor<any>> & {\n\t/** How the manifest records this monitor. Defaults to its service name. */\n\tmonitor?: MonitorInfo;\n};\n\n/** A run in progress, closed by exactly one of its two methods. */\nexport interface MonitoredRun {\n\tsuccess(output: unknown): Promise<void>;\n\tfailure(error: unknown): Promise<void>;\n}\n\nconst NOOP_RUN: MonitoredRun = {\n\tasync success() {},\n\tasync failure() {},\n};\n\n/**\n * Start a construct's monitors for one run.\n *\n * Never throws: a monitor that fails to register, start or report is logged,\n * and the run goes on without it.\n */\nexport async function startMonitors(\n\tconstruct: { type: ConstructType; monitors: readonly MonitorService[] },\n\tserviceDiscovery: ServiceDiscovery<any>,\n\tlogger: Logger,\n): Promise<MonitoredRun> {\n\tif (!construct.monitors.length) {\n\t\treturn NOOP_RUN;\n\t}\n\n\tconst ctx: MonitorContext = { type: construct.type, logger };\n\n\tlet started: { monitor: ConstructMonitor<any>; run: unknown }[];\n\ttry {\n\t\tconst registered: Record<string, unknown> = await serviceDiscovery.register(\n\t\t\t[...construct.monitors],\n\t\t);\n\t\tstarted = await Promise.all(\n\t\t\tconstruct.monitors.map(async ({ serviceName }) => {\n\t\t\t\tconst monitor = registered[serviceName] as ConstructMonitor<any>;\n\t\t\t\tlet run: unknown;\n\t\t\t\ttry {\n\t\t\t\t\trun = await monitor.start?.(ctx);\n\t\t\t\t} catch (error) {\n\t\t\t\t\tlogger.warn(\n\t\t\t\t\t\t{ error, monitor: serviceName },\n\t\t\t\t\t\t'Monitor failed to start',\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t\treturn { monitor, run };\n\t\t\t}),\n\t\t);\n\t} catch (error) {\n\t\tlogger.warn({ error }, 'Monitors could not be registered');\n\t\treturn NOOP_RUN;\n\t}\n\n\tconst report = async (\n\t\tcall: (monitor: ConstructMonitor<any>, run: unknown) => Promise<void>,\n\t) => {\n\t\tconst results = await Promise.allSettled(\n\t\t\tstarted.map(({ monitor, run }) => call(monitor, run)),\n\t\t);\n\t\tfor (const result of results) {\n\t\t\tif (result.status === 'rejected') {\n\t\t\t\tlogger.warn({ error: result.reason }, 'Monitor failed to report');\n\t\t\t}\n\t\t}\n\t};\n\n\treturn {\n\t\tsuccess: (output) =>\n\t\t\treport((monitor, run) => monitor.success({ ...ctx, run, output })),\n\t\tfailure: (error) =>\n\t\t\treport((monitor, run) => monitor.failure({ ...ctx, run, error })),\n\t};\n}\n"],"mappings":";AAqDA,MAAMA,WAAyB;CAC9B,MAAM,UAAU,CAAE;CAClB,MAAM,UAAU,CAAE;AAClB;;;;;;;AAQD,eAAsB,cACrBC,WACAC,kBACAC,QACwB;AACxB,MAAK,UAAU,SAAS,OACvB,QAAO;CAGR,MAAMC,MAAsB;EAAE,MAAM,UAAU;EAAM;CAAQ;CAE5D,IAAIC;AACJ,KAAI;EACH,MAAMC,aAAsC,MAAM,iBAAiB,SAClE,CAAC,GAAG,UAAU,QAAS,EACvB;AACD,YAAU,MAAM,QAAQ,IACvB,UAAU,SAAS,IAAI,OAAO,EAAE,aAAa,KAAK;GACjD,MAAM,UAAU,WAAW;GAC3B,IAAIC;AACJ,OAAI;AACH,UAAM,MAAM,QAAQ,QAAQ,IAAI;GAChC,SAAQ,OAAO;AACf,WAAO,KACN;KAAE;KAAO,SAAS;IAAa,GAC/B,0BACA;GACD;AACD,UAAO;IAAE;IAAS;GAAK;EACvB,EAAC,CACF;CACD,SAAQ,OAAO;AACf,SAAO,KAAK,EAAE,MAAO,GAAE,mCAAmC;AAC1D,SAAO;CACP;CAED,MAAM,SAAS,OACdC,SACI;EACJ,MAAM,UAAU,MAAM,QAAQ,WAC7B,QAAQ,IAAI,CAAC,EAAE,SAAS,KAAK,KAAK,KAAK,SAAS,IAAI,CAAC,CACrD;AACD,OAAK,MAAM,UAAU,QACpB,KAAI,OAAO,WAAW,WACrB,QAAO,KAAK,EAAE,OAAO,OAAO,OAAQ,GAAE,2BAA2B;CAGnE;AAED,QAAO;EACN,SAAS,CAAC,WACT,OAAO,CAAC,SAAS,QAAQ,QAAQ,QAAQ;GAAE,GAAG;GAAK;GAAK;EAAQ,EAAC,CAAC;EACnE,SAAS,CAAC,UACT,OAAO,CAAC,SAAS,QAAQ,QAAQ,QAAQ;GAAE,GAAG;GAAK;GAAK;EAAO,EAAC,CAAC;CAClE;AACD"}
|
package/dist/monitors/index.cjs
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* ```typescript
|
|
10
10
|
* cron
|
|
11
11
|
* .schedule('cron(0 0 * * *)')
|
|
12
|
-
* .
|
|
12
|
+
* .uptime(heartbeat.betterStack())
|
|
13
13
|
* .handle(async () => {});
|
|
14
14
|
* ```
|
|
15
15
|
*/
|
|
@@ -27,7 +27,7 @@ function heartbeat(options = {}) {
|
|
|
27
27
|
const ping = async (target) => {
|
|
28
28
|
if (!url || !target) return;
|
|
29
29
|
const response = await fetch(target(url), { signal: AbortSignal.timeout(timeout) });
|
|
30
|
-
if (!response.ok) throw new Error(
|
|
30
|
+
if (!response.ok) throw new Error("Heartbeat responded with an error status", { cause: { status: response.status } });
|
|
31
31
|
};
|
|
32
32
|
return {
|
|
33
33
|
start: () => ping(start),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs","names":["options: HeartbeatOptions","target?: (url: string) => string","env?: string"],"sources":["../../src/monitors/heartbeat.ts"],"sourcesContent":["import type { Service } from '@geekmidas/services';\nimport type { ConstructMonitor, MonitorInfo } from '../monitor';\n\nexport interface HeartbeatOptions {\n\t/**\n\t * The environment variable holding the heartbeat URL. Required: the manifest\n\t * lists it so infrastructure sets it wherever the construct is deployed. If\n\t * it is missing at runtime the monitor is skipped with a warning, and the\n\t * run goes on.\n\t * @default 'HEARTBEAT_URL'\n\t */\n\tenv?: string;\n\t/** The URL to request when a run starts. Omit for providers without one. */\n\tstart?: (url: string) => string;\n\t/** The URL to request when a run succeeds. @default the URL itself */\n\tsuccess?: (url: string) => string;\n\t/**\n\t * The URL to request when a run fails. Omit to send nothing, and let the\n\t * provider alert on the missed success ping instead.\n\t */\n\tfailure?: (url: string) => string;\n\t/** Milliseconds to wait for the provider. @default 3000 */\n\ttimeout?: number;\n\t/**\n\t * The service the URL belongs to, recorded in the manifest so infrastructure\n\t * knows which kind of heartbeat to create. Set by the presets.\n\t */\n\tprovider?: string;\n}\n\n/**\n * A monitor that pings a URL when a run succeeds, and optionally when it\n * starts or fails — the shape most heartbeat and cron-monitoring services\n * share.\n *\n * @example\n * ```typescript\n * cron\n * .schedule('cron(0 0 * * *)')\n * .
|
|
1
|
+
{"version":3,"file":"index.cjs","names":["options: HeartbeatOptions","target?: (url: string) => string","env?: string"],"sources":["../../src/monitors/heartbeat.ts"],"sourcesContent":["import type { Service } from '@geekmidas/services';\nimport type { ConstructMonitor, MonitorInfo } from '../monitor';\n\nexport interface HeartbeatOptions {\n\t/**\n\t * The environment variable holding the heartbeat URL. Required: the manifest\n\t * lists it so infrastructure sets it wherever the construct is deployed. If\n\t * it is missing at runtime the monitor is skipped with a warning, and the\n\t * run goes on.\n\t * @default 'HEARTBEAT_URL'\n\t */\n\tenv?: string;\n\t/** The URL to request when a run starts. Omit for providers without one. */\n\tstart?: (url: string) => string;\n\t/** The URL to request when a run succeeds. @default the URL itself */\n\tsuccess?: (url: string) => string;\n\t/**\n\t * The URL to request when a run fails. Omit to send nothing, and let the\n\t * provider alert on the missed success ping instead.\n\t */\n\tfailure?: (url: string) => string;\n\t/** Milliseconds to wait for the provider. @default 3000 */\n\ttimeout?: number;\n\t/**\n\t * The service the URL belongs to, recorded in the manifest so infrastructure\n\t * knows which kind of heartbeat to create. Set by the presets.\n\t */\n\tprovider?: string;\n}\n\n/**\n * A monitor that pings a URL when a run succeeds, and optionally when it\n * starts or fails — the shape most heartbeat and cron-monitoring services\n * share.\n *\n * @example\n * ```typescript\n * cron\n * .schedule('cron(0 0 * * *)')\n * .uptime(heartbeat.betterStack())\n * .handle(async () => {});\n * ```\n */\nexport function heartbeat(\n\toptions: HeartbeatOptions = {},\n): Service<`heartbeat:${string}`, ConstructMonitor> & { monitor: MonitorInfo } {\n\tconst {\n\t\tenv = 'HEARTBEAT_URL',\n\t\tstart,\n\t\tsuccess = (url) => url,\n\t\tfailure,\n\t\ttimeout = 3000,\n\t\tprovider,\n\t} = options;\n\n\treturn {\n\t\tserviceName: `heartbeat:${env}`,\n\t\tmonitor: { type: 'heartbeat', ...(provider ? { provider } : {}), env },\n\t\tasync register({ envParser }) {\n\t\t\tconst { url } = envParser\n\t\t\t\t.create((get) => ({ url: get(env).string() }))\n\t\t\t\t.parse();\n\n\t\t\tconst ping = async (target?: (url: string) => string) => {\n\t\t\t\tif (!url || !target) {\n\t\t\t\t\treturn;\n\t\t\t\t}\n\t\t\t\tconst response = await fetch(target(url), {\n\t\t\t\t\tsignal: AbortSignal.timeout(timeout),\n\t\t\t\t});\n\t\t\t\tif (!response.ok) {\n\t\t\t\t\tthrow new Error('Heartbeat responded with an error status', {\n\t\t\t\t\t\tcause: { status: response.status },\n\t\t\t\t\t});\n\t\t\t\t}\n\t\t\t};\n\n\t\t\treturn {\n\t\t\t\tstart: () => ping(start),\n\t\t\t\tsuccess: () => ping(success),\n\t\t\t\tfailure: () => ping(failure),\n\t\t\t};\n\t\t},\n\t};\n}\n\n/** Better Stack heartbeats: `{url}` on success, `{url}/fail` on failure. */\nheartbeat.betterStack = (env?: string) =>\n\theartbeat({ env, provider: 'betterStack', failure: (url) => `${url}/fail` });\n\n/** Healthchecks.io: `{url}/start`, `{url}` and `{url}/fail`. */\nheartbeat.healthchecks = (env?: string) =>\n\theartbeat({\n\t\tenv,\n\t\tprovider: 'healthchecks',\n\t\tstart: (url) => `${url}/start`,\n\t\tfailure: (url) => `${url}/fail`,\n\t});\n"],"mappings":";;;;;;;;;;;;;;;AA2CA,SAAgB,UACfA,UAA4B,CAAE,GACgD;CAC9E,MAAM,EACL,MAAM,iBACN,OACA,UAAU,CAAC,QAAQ,KACnB,SACA,UAAU,KACV,UACA,GAAG;AAEJ,QAAO;EACN,cAAc,YAAY,IAAI;EAC9B,SAAS;GAAE,MAAM;GAAa,GAAI,WAAW,EAAE,SAAU,IAAG,CAAE;GAAG;EAAK;EACtE,MAAM,SAAS,EAAE,WAAW,EAAE;GAC7B,MAAM,EAAE,KAAK,GAAG,UACd,OAAO,CAAC,SAAS,EAAE,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAE,GAAE,CAC7C,OAAO;GAET,MAAM,OAAO,OAAOC,WAAqC;AACxD,SAAK,QAAQ,OACZ;IAED,MAAM,WAAW,MAAM,MAAM,OAAO,IAAI,EAAE,EACzC,QAAQ,YAAY,QAAQ,QAAQ,CACpC,EAAC;AACF,SAAK,SAAS,GACb,OAAM,IAAI,MAAM,4CAA4C,EAC3D,OAAO,EAAE,QAAQ,SAAS,OAAQ,EAClC;GAEF;AAED,UAAO;IACN,OAAO,MAAM,KAAK,MAAM;IACxB,SAAS,MAAM,KAAK,QAAQ;IAC5B,SAAS,MAAM,KAAK,QAAQ;GAC5B;EACD;CACD;AACD;;AAGD,UAAU,cAAc,CAACC,QACxB,UAAU;CAAE;CAAK,UAAU;CAAe,SAAS,CAAC,SAAS,EAAE,IAAI;AAAQ,EAAC;;AAG7E,UAAU,eAAe,CAACA,QACzB,UAAU;CACT;CACA,UAAU;CACV,OAAO,CAAC,SAAS,EAAE,IAAI;CACvB,SAAS,CAAC,SAAS,EAAE,IAAI;AACzB,EAAC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ConstructMonitor, MonitorContext, MonitorInfo, MonitorService } from "../Construct-
|
|
1
|
+
import { ConstructMonitor, MonitorContext, MonitorInfo, MonitorService } from "../Construct-BEh2DSMe.cjs";
|
|
2
2
|
import { Service } from "@geekmidas/services";
|
|
3
3
|
|
|
4
4
|
//#region src/monitors/heartbeat.d.ts
|
|
@@ -37,7 +37,7 @@ interface HeartbeatOptions {
|
|
|
37
37
|
* ```typescript
|
|
38
38
|
* cron
|
|
39
39
|
* .schedule('cron(0 0 * * *)')
|
|
40
|
-
* .
|
|
40
|
+
* .uptime(heartbeat.betterStack())
|
|
41
41
|
* .handle(async () => {});
|
|
42
42
|
* ```
|
|
43
43
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/monitors/heartbeat.ts"],"sourcesContent":[],"mappings":";;;;UAGiB,gBAAA;;AAAjB;AAwCA;;;;;EAEU,GAAuD,CAAA,EAAA,MAAA;EAAW;EAF5D,KAAA,CAAA,EAAA,CAAA,GAAS,EAAA,MAAA,EAAA,GAAA,MAAA;EAAA;EAAA,
|
|
1
|
+
{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/monitors/heartbeat.ts"],"sourcesContent":[],"mappings":";;;;UAGiB,gBAAA;;AAAjB;AAwCA;;;;;EAEU,GAAuD,CAAA,EAAA,MAAA;EAAW;EAF5D,KAAA,CAAA,EAAA,CAAA,GAAS,EAAA,MAAA,EAAA,GAAA,MAAA;EAAA;EAAA,OA4CY,CAAA,EAAA,CAAA,GAAA,EAAA,MAAA,EAAA,GAAA,MAAA;EAAA;;;;EAIC,OA9C2B,CAAA,EAAA,CAAA,GAAA,EAAA,MAAA,EAAA,GAAA,MAAA;EAAW;;;;;;;;;;;;;;;;;;;;;iBAF5D,SAAA,WACN,mBACP,+BAA+B;WAA+B;;kBAFjD,SAAA;qCA4CqB,+BAAA;aA1C4B;;sCA8C3B,+BAAA;aA9C2B"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ConstructMonitor, MonitorContext, MonitorInfo, MonitorService } from "../Construct-
|
|
1
|
+
import { ConstructMonitor, MonitorContext, MonitorInfo, MonitorService } from "../Construct-qnOnQTcP.mjs";
|
|
2
2
|
import { Service } from "@geekmidas/services";
|
|
3
3
|
|
|
4
4
|
//#region src/monitors/heartbeat.d.ts
|
|
@@ -37,7 +37,7 @@ interface HeartbeatOptions {
|
|
|
37
37
|
* ```typescript
|
|
38
38
|
* cron
|
|
39
39
|
* .schedule('cron(0 0 * * *)')
|
|
40
|
-
* .
|
|
40
|
+
* .uptime(heartbeat.betterStack())
|
|
41
41
|
* .handle(async () => {});
|
|
42
42
|
* ```
|
|
43
43
|
*/
|
package/dist/monitors/index.mjs
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
* ```typescript
|
|
9
9
|
* cron
|
|
10
10
|
* .schedule('cron(0 0 * * *)')
|
|
11
|
-
* .
|
|
11
|
+
* .uptime(heartbeat.betterStack())
|
|
12
12
|
* .handle(async () => {});
|
|
13
13
|
* ```
|
|
14
14
|
*/
|
|
@@ -26,7 +26,7 @@ function heartbeat(options = {}) {
|
|
|
26
26
|
const ping = async (target) => {
|
|
27
27
|
if (!url || !target) return;
|
|
28
28
|
const response = await fetch(target(url), { signal: AbortSignal.timeout(timeout) });
|
|
29
|
-
if (!response.ok) throw new Error(
|
|
29
|
+
if (!response.ok) throw new Error("Heartbeat responded with an error status", { cause: { status: response.status } });
|
|
30
30
|
};
|
|
31
31
|
return {
|
|
32
32
|
start: () => ping(start),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","names":["options: HeartbeatOptions","target?: (url: string) => string","env?: string"],"sources":["../../src/monitors/heartbeat.ts"],"sourcesContent":["import type { Service } from '@geekmidas/services';\nimport type { ConstructMonitor, MonitorInfo } from '../monitor';\n\nexport interface HeartbeatOptions {\n\t/**\n\t * The environment variable holding the heartbeat URL. Required: the manifest\n\t * lists it so infrastructure sets it wherever the construct is deployed. If\n\t * it is missing at runtime the monitor is skipped with a warning, and the\n\t * run goes on.\n\t * @default 'HEARTBEAT_URL'\n\t */\n\tenv?: string;\n\t/** The URL to request when a run starts. Omit for providers without one. */\n\tstart?: (url: string) => string;\n\t/** The URL to request when a run succeeds. @default the URL itself */\n\tsuccess?: (url: string) => string;\n\t/**\n\t * The URL to request when a run fails. Omit to send nothing, and let the\n\t * provider alert on the missed success ping instead.\n\t */\n\tfailure?: (url: string) => string;\n\t/** Milliseconds to wait for the provider. @default 3000 */\n\ttimeout?: number;\n\t/**\n\t * The service the URL belongs to, recorded in the manifest so infrastructure\n\t * knows which kind of heartbeat to create. Set by the presets.\n\t */\n\tprovider?: string;\n}\n\n/**\n * A monitor that pings a URL when a run succeeds, and optionally when it\n * starts or fails — the shape most heartbeat and cron-monitoring services\n * share.\n *\n * @example\n * ```typescript\n * cron\n * .schedule('cron(0 0 * * *)')\n * .
|
|
1
|
+
{"version":3,"file":"index.mjs","names":["options: HeartbeatOptions","target?: (url: string) => string","env?: string"],"sources":["../../src/monitors/heartbeat.ts"],"sourcesContent":["import type { Service } from '@geekmidas/services';\nimport type { ConstructMonitor, MonitorInfo } from '../monitor';\n\nexport interface HeartbeatOptions {\n\t/**\n\t * The environment variable holding the heartbeat URL. Required: the manifest\n\t * lists it so infrastructure sets it wherever the construct is deployed. If\n\t * it is missing at runtime the monitor is skipped with a warning, and the\n\t * run goes on.\n\t * @default 'HEARTBEAT_URL'\n\t */\n\tenv?: string;\n\t/** The URL to request when a run starts. Omit for providers without one. */\n\tstart?: (url: string) => string;\n\t/** The URL to request when a run succeeds. @default the URL itself */\n\tsuccess?: (url: string) => string;\n\t/**\n\t * The URL to request when a run fails. Omit to send nothing, and let the\n\t * provider alert on the missed success ping instead.\n\t */\n\tfailure?: (url: string) => string;\n\t/** Milliseconds to wait for the provider. @default 3000 */\n\ttimeout?: number;\n\t/**\n\t * The service the URL belongs to, recorded in the manifest so infrastructure\n\t * knows which kind of heartbeat to create. Set by the presets.\n\t */\n\tprovider?: string;\n}\n\n/**\n * A monitor that pings a URL when a run succeeds, and optionally when it\n * starts or fails — the shape most heartbeat and cron-monitoring services\n * share.\n *\n * @example\n * ```typescript\n * cron\n * .schedule('cron(0 0 * * *)')\n * .uptime(heartbeat.betterStack())\n * .handle(async () => {});\n * ```\n */\nexport function heartbeat(\n\toptions: HeartbeatOptions = {},\n): Service<`heartbeat:${string}`, ConstructMonitor> & { monitor: MonitorInfo } {\n\tconst {\n\t\tenv = 'HEARTBEAT_URL',\n\t\tstart,\n\t\tsuccess = (url) => url,\n\t\tfailure,\n\t\ttimeout = 3000,\n\t\tprovider,\n\t} = options;\n\n\treturn {\n\t\tserviceName: `heartbeat:${env}`,\n\t\tmonitor: { type: 'heartbeat', ...(provider ? { provider } : {}), env },\n\t\tasync register({ envParser }) {\n\t\t\tconst { url } = envParser\n\t\t\t\t.create((get) => ({ url: get(env).string() }))\n\t\t\t\t.parse();\n\n\t\t\tconst ping = async (target?: (url: string) => string) => {\n\t\t\t\tif (!url || !target) {\n\t\t\t\t\treturn;\n\t\t\t\t}\n\t\t\t\tconst response = await fetch(target(url), {\n\t\t\t\t\tsignal: AbortSignal.timeout(timeout),\n\t\t\t\t});\n\t\t\t\tif (!response.ok) {\n\t\t\t\t\tthrow new Error('Heartbeat responded with an error status', {\n\t\t\t\t\t\tcause: { status: response.status },\n\t\t\t\t\t});\n\t\t\t\t}\n\t\t\t};\n\n\t\t\treturn {\n\t\t\t\tstart: () => ping(start),\n\t\t\t\tsuccess: () => ping(success),\n\t\t\t\tfailure: () => ping(failure),\n\t\t\t};\n\t\t},\n\t};\n}\n\n/** Better Stack heartbeats: `{url}` on success, `{url}/fail` on failure. */\nheartbeat.betterStack = (env?: string) =>\n\theartbeat({ env, provider: 'betterStack', failure: (url) => `${url}/fail` });\n\n/** Healthchecks.io: `{url}/start`, `{url}` and `{url}/fail`. */\nheartbeat.healthchecks = (env?: string) =>\n\theartbeat({\n\t\tenv,\n\t\tprovider: 'healthchecks',\n\t\tstart: (url) => `${url}/start`,\n\t\tfailure: (url) => `${url}/fail`,\n\t});\n"],"mappings":";;;;;;;;;;;;;;AA2CA,SAAgB,UACfA,UAA4B,CAAE,GACgD;CAC9E,MAAM,EACL,MAAM,iBACN,OACA,UAAU,CAAC,QAAQ,KACnB,SACA,UAAU,KACV,UACA,GAAG;AAEJ,QAAO;EACN,cAAc,YAAY,IAAI;EAC9B,SAAS;GAAE,MAAM;GAAa,GAAI,WAAW,EAAE,SAAU,IAAG,CAAE;GAAG;EAAK;EACtE,MAAM,SAAS,EAAE,WAAW,EAAE;GAC7B,MAAM,EAAE,KAAK,GAAG,UACd,OAAO,CAAC,SAAS,EAAE,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAE,GAAE,CAC7C,OAAO;GAET,MAAM,OAAO,OAAOC,WAAqC;AACxD,SAAK,QAAQ,OACZ;IAED,MAAM,WAAW,MAAM,MAAM,OAAO,IAAI,EAAE,EACzC,QAAQ,YAAY,QAAQ,QAAQ,CACpC,EAAC;AACF,SAAK,SAAS,GACb,OAAM,IAAI,MAAM,4CAA4C,EAC3D,OAAO,EAAE,QAAQ,SAAS,OAAQ,EAClC;GAEF;AAED,UAAO;IACN,OAAO,MAAM,KAAK,MAAM;IACxB,SAAS,MAAM,KAAK,QAAQ;IAC5B,SAAS,MAAM,KAAK,QAAQ;GAC5B;EACD;CACD;AACD;;AAGD,UAAU,cAAc,CAACC,QACxB,UAAU;CAAE;CAAK,UAAU;CAAe,SAAS,CAAC,SAAS,EAAE,IAAI;AAAQ,EAAC;;AAG7E,UAAU,eAAe,CAACA,QACzB,UAAU;CACT;CACA,UAAU;CACV,OAAO,CAAC,SAAS,EAAE,IAAI;CACvB,SAAS,CAAC,SAAS,EAAE,IAAI;AACzB,EAAC"}
|
|
@@ -77,4 +77,4 @@ async function executeWithAuditTransaction(auditContext, handler, onComplete, op
|
|
|
77
77
|
|
|
78
78
|
//#endregion
|
|
79
79
|
export { createAuditContext, executeWithAuditTransaction };
|
|
80
|
-
//# sourceMappingURL=processAudits-
|
|
80
|
+
//# sourceMappingURL=processAudits-BEiSkgH3.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"processAudits-CwyaaSQc.mjs","names":["endpoint: Endpoint<\n\t\tany,\n\t\tany,\n\t\tany,\n\t\tany,\n\t\tTServices,\n\t\tTLogger,\n\t\tTSession,\n\t\tany,\n\t\tany,\n\t\tTAuditStorage,\n\t\tTAuditStorageServiceName,\n\t\tTAuditAction,\n\t\tTDatabase,\n\t\tTDatabaseServiceName\n\t>","serviceDiscovery: ServiceDiscovery<any>","logger: TLogger","ctx: {\n\t\tsession: TSession;\n\t\theader: HeaderFn;\n\t\tcookie: CookieFn;\n\t\tservices: Record<string, unknown>;\n\t}","actor: AuditActor","auditContext: AuditExecutionContext<TAuditAction> | undefined","handler: (auditor?: Auditor<TAuditAction>) => Promise<T>","onComplete?: (response: T, auditor: Auditor<TAuditAction>) => Promise<void>","options?: ExecuteWithAuditTransactionOptions","response"],"sources":["../src/endpoints/processAudits.ts"],"sourcesContent":["import type {\n\tAuditActor,\n\tAuditableAction,\n\tAuditor,\n\tAuditStorage,\n} from '@geekmidas/audit';\nimport { DefaultAuditor } from '@geekmidas/audit';\nimport type { Logger } from '@geekmidas/logger';\nimport type { InferStandardSchema } from '@geekmidas/schema';\nimport type { Service, ServiceDiscovery } from '@geekmidas/services';\nimport type { StandardSchemaV1 } from '@standard-schema/spec';\nimport type { ActorExtractor, MappedAudit } from './audit';\nimport type { CookieFn, Endpoint, HeaderFn } from './Endpoint';\n\n/**\n * Process declarative audit definitions after successful endpoint execution.\n * Similar to publishConstructEvents for events.\n *\n * @param endpoint - The endpoint with audit configuration\n * @param response - The handler response to generate audit payloads from\n * @param serviceDiscovery - Service discovery for registering audit storage\n * @param logger - Logger for debug/error messages\n * @param ctx - Request context (session, headers, cookies, services)\n * @param existingAuditor - Optional existing auditor instance (e.g., from handler context).\n * If provided, uses this auditor (with its stored transaction).\n * If not provided, creates a new auditor.\n */\nexport async function processEndpointAudits<\n\tTServices extends Service[] = [],\n\tTSession = unknown,\n\tTLogger extends Logger = Logger,\n\tOutSchema extends StandardSchemaV1 | undefined = undefined,\n\tTAuditStorage extends AuditStorage | undefined = undefined,\n\tTAuditStorageServiceName extends string = string,\n\tTAuditAction extends AuditableAction<string, unknown> = AuditableAction<\n\t\tstring,\n\t\tunknown\n\t>,\n>(\n\tendpoint: Endpoint<\n\t\tany,\n\t\tany,\n\t\tany,\n\t\tOutSchema,\n\t\tTServices,\n\t\tTLogger,\n\t\tTSession,\n\t\tany,\n\t\tany,\n\t\tTAuditStorage,\n\t\tTAuditStorageServiceName,\n\t\tTAuditAction\n\t>,\n\tresponse: InferStandardSchema<OutSchema>,\n\tserviceDiscovery: ServiceDiscovery<any>,\n\tlogger: TLogger,\n\tctx: {\n\t\tsession: TSession;\n\t\theader: HeaderFn;\n\t\tcookie: CookieFn;\n\t\tservices: Record<string, unknown>;\n\t},\n\texistingAuditor?: Auditor<TAuditAction>,\n): Promise<void> {\n\ttry {\n\t\tconst audits = endpoint.audits as MappedAudit<TAuditAction, OutSchema>[];\n\n\t\t// If we have an existing auditor (from handler context), we need to flush\n\t\t// any manual audits it collected, even if there are no declarative audits\n\t\tconst hasExistingRecords =\n\t\t\texistingAuditor && existingAuditor.getRecords().length > 0;\n\n\t\t// Skip if no declarative audits and no existing records to flush\n\t\tif (!audits?.length && !hasExistingRecords) {\n\t\t\tlogger.debug('No audits to process');\n\t\t\treturn;\n\t\t}\n\n\t\t// If no auditor storage service and we have things to process, warn\n\t\tif (!endpoint.auditorStorageService) {\n\t\t\tif (hasExistingRecords || audits?.length) {\n\t\t\t\tlogger.warn('No auditor storage service available');\n\t\t\t}\n\t\t\treturn;\n\t\t}\n\n\t\t// Get or create auditor\n\t\tlet auditor: Auditor<TAuditAction>;\n\n\t\tif (existingAuditor) {\n\t\t\t// Use existing auditor (preserves stored transaction and manual audits)\n\t\t\tauditor = existingAuditor;\n\t\t\tlogger.debug('Using existing auditor from handler context');\n\t\t} else {\n\t\t\t// Create new auditor (backward compatibility)\n\t\t\tconst services = await serviceDiscovery.register([\n\t\t\t\tendpoint.auditorStorageService,\n\t\t\t]);\n\t\t\tconst storage = services[\n\t\t\t\tendpoint.auditorStorageService.serviceName\n\t\t\t] as AuditStorage;\n\n\t\t\t// Extract actor if configured\n\t\t\tlet actor: AuditActor = { id: 'system', type: 'system' };\n\t\t\tif (endpoint.actorExtractor) {\n\t\t\t\ttry {\n\t\t\t\t\tactor = await (\n\t\t\t\t\t\tendpoint.actorExtractor as ActorExtractor<\n\t\t\t\t\t\t\tTServices,\n\t\t\t\t\t\t\tTSession,\n\t\t\t\t\t\t\tTLogger\n\t\t\t\t\t\t>\n\t\t\t\t\t)({\n\t\t\t\t\t\tservices: ctx.services as any,\n\t\t\t\t\t\tsession: ctx.session,\n\t\t\t\t\t\theader: ctx.header,\n\t\t\t\t\t\tcookie: ctx.cookie,\n\t\t\t\t\t\tlogger,\n\t\t\t\t\t});\n\t\t\t\t} catch (error) {\n\t\t\t\t\tlogger.error(error as Error, 'Failed to extract actor for audits');\n\t\t\t\t\t// Continue with system actor\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tauditor = new DefaultAuditor<TAuditAction>({\n\t\t\t\tactor,\n\t\t\t\tstorage,\n\t\t\t\tmetadata: {\n\t\t\t\t\tendpoint: endpoint.route,\n\t\t\t\t\tmethod: endpoint.method,\n\t\t\t\t},\n\t\t\t});\n\t\t}\n\n\t\t// Process each declarative audit\n\t\tif (audits?.length) {\n\t\t\tfor (const audit of audits) {\n\t\t\t\tlogger.debug({ audit: audit.type }, 'Processing declarative audit');\n\n\t\t\t\t// Check when condition\n\t\t\t\tif (audit.when && !audit.when(response as any)) {\n\t\t\t\t\tlogger.debug(\n\t\t\t\t\t\t{ audit: audit.type },\n\t\t\t\t\t\t'Audit skipped due to when condition',\n\t\t\t\t\t);\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\n\t\t\t\t// Extract payload\n\t\t\t\tconst payload = audit.payload(response as any);\n\n\t\t\t\t// Extract entityId if configured\n\t\t\t\tconst entityId = audit.entityId?.(response as any);\n\n\t\t\t\t// Record the audit\n\t\t\t\tauditor.audit(audit.type as any, payload as any, {\n\t\t\t\t\ttable: audit.table,\n\t\t\t\t\tentityId,\n\t\t\t\t});\n\t\t\t}\n\t\t}\n\n\t\t// Flush audits to storage\n\t\t// Note: If existingAuditor has a stored transaction (via setTransaction),\n\t\t// flush() will use it automatically\n\t\tconst recordCount = auditor.getRecords().length;\n\t\tif (recordCount > 0) {\n\t\t\t// Check if auditor has a stored transaction (for logging purposes)\n\t\t\tconst trx =\n\t\t\t\t'getTransaction' in auditor\n\t\t\t\t\t? (auditor as { getTransaction(): unknown }).getTransaction()\n\t\t\t\t\t: undefined;\n\t\t\tlogger.debug(\n\t\t\t\t{ auditCount: recordCount, hasTransaction: !!trx },\n\t\t\t\t'Flushing audits',\n\t\t\t);\n\t\t\tawait auditor.flush();\n\t\t}\n\t} catch (error) {\n\t\tlogger.error(error as Error, 'Failed to process audits');\n\t\t// Don't rethrow - audit failures shouldn't fail the request\n\t}\n}\n\n/**\n * Context for audit-aware handler execution.\n */\nexport interface AuditExecutionContext<\n\tTAuditAction extends AuditableAction<string, unknown> = AuditableAction<\n\t\tstring,\n\t\tunknown\n\t>,\n> {\n\t/** The auditor instance for recording audits */\n\tauditor: Auditor<TAuditAction>;\n\t/** The audit storage instance */\n\tstorage: AuditStorage;\n}\n\n/**\n * Create audit context for handler execution.\n * Returns the auditor and storage for use in the handler.\n *\n * @param endpoint - The endpoint with audit configuration\n * @param serviceDiscovery - Service discovery for getting audit storage\n * @param logger - Logger for debug/error messages\n * @param ctx - Request context for actor extraction\n * @returns Audit context with auditor and storage, or undefined if not configured\n */\nexport async function createAuditContext<\n\tTServices extends Service[] = [],\n\tTSession = unknown,\n\tTLogger extends Logger = Logger,\n\tTAuditStorage extends AuditStorage | undefined = undefined,\n\tTAuditStorageServiceName extends string = string,\n\tTAuditAction extends AuditableAction<string, unknown> = AuditableAction<\n\t\tstring,\n\t\tunknown\n\t>,\n\tTDatabase = undefined,\n\tTDatabaseServiceName extends string = string,\n>(\n\tendpoint: Endpoint<\n\t\tany,\n\t\tany,\n\t\tany,\n\t\tany,\n\t\tTServices,\n\t\tTLogger,\n\t\tTSession,\n\t\tany,\n\t\tany,\n\t\tTAuditStorage,\n\t\tTAuditStorageServiceName,\n\t\tTAuditAction,\n\t\tTDatabase,\n\t\tTDatabaseServiceName\n\t>,\n\tserviceDiscovery: ServiceDiscovery<any>,\n\tlogger: TLogger,\n\tctx: {\n\t\tsession: TSession;\n\t\theader: HeaderFn;\n\t\tcookie: CookieFn;\n\t\tservices: Record<string, unknown>;\n\t},\n): Promise<AuditExecutionContext<TAuditAction> | undefined> {\n\tif (!endpoint.auditorStorageService) {\n\t\treturn undefined;\n\t}\n\n\tconst services = await serviceDiscovery.register([\n\t\tendpoint.auditorStorageService,\n\t]);\n\tconst storage = services[\n\t\tendpoint.auditorStorageService.serviceName\n\t] as AuditStorage;\n\n\t// Extract actor if configured\n\tlet actor: AuditActor = { id: 'system', type: 'system' };\n\tif (endpoint.actorExtractor) {\n\t\ttry {\n\t\t\tactor = await (\n\t\t\t\tendpoint.actorExtractor as ActorExtractor<TServices, TSession, TLogger>\n\t\t\t)({\n\t\t\t\tservices: ctx.services as any,\n\t\t\t\tsession: ctx.session,\n\t\t\t\theader: ctx.header,\n\t\t\t\tcookie: ctx.cookie,\n\t\t\t\tlogger,\n\t\t\t});\n\t\t} catch (error) {\n\t\t\tlogger.error(error as Error, 'Failed to extract actor for audits');\n\t\t}\n\t}\n\n\tconst auditor = new DefaultAuditor<TAuditAction>({\n\t\tactor,\n\t\tstorage,\n\t\tmetadata: {\n\t\t\tendpoint: endpoint.route,\n\t\t\tmethod: endpoint.method,\n\t\t},\n\t});\n\n\treturn { auditor, storage };\n}\n\n/**\n * Options for executeWithAuditTransaction.\n */\nexport interface ExecuteWithAuditTransactionOptions {\n\t/**\n\t * Database connection to use for the transaction.\n\t * If this is already a transaction, it will be reused instead of creating a nested one.\n\t * If not provided, the storage's internal database is used.\n\t */\n\tdb?: unknown;\n}\n\n/**\n * Execute a handler with automatic audit transaction support.\n * If the audit storage provides a withTransaction method, wraps execution\n * in a transaction so audits are atomic with handler's database operations.\n *\n * This is database-agnostic - each storage implementation provides its own\n * transaction handling based on the underlying database (Kysely, Drizzle, etc.).\n *\n * If the db parameter is provided and is already a transaction, the storage\n * will reuse it instead of creating a nested transaction (similar to\n * packages/db/src/kysely.ts#withTransaction).\n *\n * @param auditContext - The audit context from createAuditContext\n * @param handler - The handler function to execute (receives auditor)\n * @param onComplete - Called after handler with response, to process declarative audits\n * @param options - Optional configuration including database connection\n * @returns The handler result\n */\nexport async function executeWithAuditTransaction<\n\tT,\n\tTAuditAction extends AuditableAction<string, unknown> = AuditableAction<\n\t\tstring,\n\t\tunknown\n\t>,\n>(\n\tauditContext: AuditExecutionContext<TAuditAction> | undefined,\n\thandler: (auditor?: Auditor<TAuditAction>) => Promise<T>,\n\tonComplete?: (response: T, auditor: Auditor<TAuditAction>) => Promise<void>,\n\toptions?: ExecuteWithAuditTransactionOptions,\n): Promise<T> {\n\t// No audit context - just run handler\n\tif (!auditContext) {\n\t\treturn handler(undefined);\n\t}\n\n\tconst { auditor, storage } = auditContext;\n\n\t// Check if storage provides a transaction wrapper\n\tif (storage.withTransaction) {\n\t\t// Wrap in transaction - audits are atomic with handler operations\n\t\t// The storage's withTransaction handles setTransaction and flush\n\t\t// Pass db so existing transactions are reused\n\t\treturn storage.withTransaction(\n\t\t\tauditor,\n\t\t\tasync () => {\n\t\t\t\tconst response = await handler(auditor);\n\n\t\t\t\t// Process declarative audits within the transaction\n\t\t\t\tif (onComplete) {\n\t\t\t\t\tawait onComplete(response, auditor);\n\t\t\t\t}\n\n\t\t\t\treturn response;\n\t\t\t},\n\t\t\toptions?.db,\n\t\t);\n\t}\n\n\t// No transaction support - run handler and flush audits after\n\tconst response = await handler(auditor);\n\n\tif (onComplete) {\n\t\tawait onComplete(response, auditor);\n\t}\n\n\t// Flush audits (no transaction)\n\tawait auditor.flush();\n\n\treturn response;\n}\n"],"mappings":";;;;;;;;;;;;;AAkNA,eAAsB,mBAarBA,UAgBAC,kBACAC,QACAC,KAM2D;AAC3D,MAAK,SAAS,sBACb;CAGD,MAAM,WAAW,MAAM,iBAAiB,SAAS,CAChD,SAAS,qBACT,EAAC;CACF,MAAM,UAAU,SACf,SAAS,sBAAsB;CAIhC,IAAIC,QAAoB;EAAE,IAAI;EAAU,MAAM;CAAU;AACxD,KAAI,SAAS,eACZ,KAAI;AACH,UAAQ,MAAM,AACb,SAAS,eACR;GACD,UAAU,IAAI;GACd,SAAS,IAAI;GACb,QAAQ,IAAI;GACZ,QAAQ,IAAI;GACZ;EACA,EAAC;CACF,SAAQ,OAAO;AACf,SAAO,MAAM,OAAgB,qCAAqC;CAClE;CAGF,MAAM,UAAU,IAAI,eAA6B;EAChD;EACA;EACA,UAAU;GACT,UAAU,SAAS;GACnB,QAAQ,SAAS;EACjB;CACD;AAED,QAAO;EAAE;EAAS;CAAS;AAC3B;;;;;;;;;;;;;;;;;;;AAgCD,eAAsB,4BAOrBC,cACAC,SACAC,YACAC,SACa;AAEb,MAAK,aACJ,QAAO,eAAkB;CAG1B,MAAM,EAAE,SAAS,SAAS,GAAG;AAG7B,KAAI,QAAQ,gBAIX,QAAO,QAAQ,gBACd,SACA,YAAY;EACX,MAAMC,aAAW,MAAM,QAAQ,QAAQ;AAGvC,MAAI,WACH,OAAM,WAAWA,YAAU,QAAQ;AAGpC,SAAOA;CACP,GACD,SAAS,GACT;CAIF,MAAM,WAAW,MAAM,QAAQ,QAAQ;AAEvC,KAAI,WACH,OAAM,WAAW,UAAU,QAAQ;AAIpC,OAAM,QAAQ,OAAO;AAErB,QAAO;AACP"}
|
|
1
|
+
{"version":3,"file":"processAudits-BEiSkgH3.mjs","names":["endpoint: Endpoint<\n\t\tany,\n\t\tany,\n\t\tany,\n\t\tany,\n\t\tTServices,\n\t\tTLogger,\n\t\tTSession,\n\t\tany,\n\t\tany,\n\t\tTAuditStorage,\n\t\tTAuditStorageServiceName,\n\t\tTAuditAction,\n\t\tTDatabase,\n\t\tTDatabaseServiceName\n\t>","serviceDiscovery: ServiceDiscovery<any>","logger: TLogger","ctx: {\n\t\tsession: TSession;\n\t\theader: HeaderFn;\n\t\tcookie: CookieFn;\n\t\tservices: Record<string, unknown>;\n\t}","actor: AuditActor","auditContext: AuditExecutionContext<TAuditAction> | undefined","handler: (auditor?: Auditor<TAuditAction>) => Promise<T>","onComplete?: (response: T, auditor: Auditor<TAuditAction>) => Promise<void>","options?: ExecuteWithAuditTransactionOptions","response"],"sources":["../src/endpoints/processAudits.ts"],"sourcesContent":["import type {\n\tAuditActor,\n\tAuditableAction,\n\tAuditor,\n\tAuditStorage,\n} from '@geekmidas/audit';\nimport { DefaultAuditor } from '@geekmidas/audit';\nimport type { Logger } from '@geekmidas/logger';\nimport type { InferStandardSchema } from '@geekmidas/schema';\nimport type { Service, ServiceDiscovery } from '@geekmidas/services';\nimport type { StandardSchemaV1 } from '@standard-schema/spec';\nimport type { ActorExtractor, MappedAudit } from './audit';\nimport type { CookieFn, Endpoint, HeaderFn } from './Endpoint';\n\n/**\n * Process declarative audit definitions after successful endpoint execution.\n * Similar to publishConstructEvents for events.\n *\n * @param endpoint - The endpoint with audit configuration\n * @param response - The handler response to generate audit payloads from\n * @param serviceDiscovery - Service discovery for registering audit storage\n * @param logger - Logger for debug/error messages\n * @param ctx - Request context (session, headers, cookies, services)\n * @param existingAuditor - Optional existing auditor instance (e.g., from handler context).\n * If provided, uses this auditor (with its stored transaction).\n * If not provided, creates a new auditor.\n */\nexport async function processEndpointAudits<\n\tTServices extends Service[] = [],\n\tTSession = unknown,\n\tTLogger extends Logger = Logger,\n\tOutSchema extends StandardSchemaV1 | undefined = undefined,\n\tTAuditStorage extends AuditStorage | undefined = undefined,\n\tTAuditStorageServiceName extends string = string,\n\tTAuditAction extends AuditableAction<string, unknown> = AuditableAction<\n\t\tstring,\n\t\tunknown\n\t>,\n>(\n\tendpoint: Endpoint<\n\t\tany,\n\t\tany,\n\t\tany,\n\t\tOutSchema,\n\t\tTServices,\n\t\tTLogger,\n\t\tTSession,\n\t\tany,\n\t\tany,\n\t\tTAuditStorage,\n\t\tTAuditStorageServiceName,\n\t\tTAuditAction\n\t>,\n\tresponse: InferStandardSchema<OutSchema>,\n\tserviceDiscovery: ServiceDiscovery<any>,\n\tlogger: TLogger,\n\tctx: {\n\t\tsession: TSession;\n\t\theader: HeaderFn;\n\t\tcookie: CookieFn;\n\t\tservices: Record<string, unknown>;\n\t},\n\texistingAuditor?: Auditor<TAuditAction>,\n): Promise<void> {\n\ttry {\n\t\tconst audits = endpoint.audits as MappedAudit<TAuditAction, OutSchema>[];\n\n\t\t// If we have an existing auditor (from handler context), we need to flush\n\t\t// any manual audits it collected, even if there are no declarative audits\n\t\tconst hasExistingRecords =\n\t\t\texistingAuditor && existingAuditor.getRecords().length > 0;\n\n\t\t// Skip if no declarative audits and no existing records to flush\n\t\tif (!audits?.length && !hasExistingRecords) {\n\t\t\tlogger.debug('No audits to process');\n\t\t\treturn;\n\t\t}\n\n\t\t// If no auditor storage service and we have things to process, warn\n\t\tif (!endpoint.auditorStorageService) {\n\t\t\tif (hasExistingRecords || audits?.length) {\n\t\t\t\tlogger.warn('No auditor storage service available');\n\t\t\t}\n\t\t\treturn;\n\t\t}\n\n\t\t// Get or create auditor\n\t\tlet auditor: Auditor<TAuditAction>;\n\n\t\tif (existingAuditor) {\n\t\t\t// Use existing auditor (preserves stored transaction and manual audits)\n\t\t\tauditor = existingAuditor;\n\t\t\tlogger.debug('Using existing auditor from handler context');\n\t\t} else {\n\t\t\t// Create new auditor (backward compatibility)\n\t\t\tconst services = await serviceDiscovery.register([\n\t\t\t\tendpoint.auditorStorageService,\n\t\t\t]);\n\t\t\tconst storage = services[\n\t\t\t\tendpoint.auditorStorageService.serviceName\n\t\t\t] as AuditStorage;\n\n\t\t\t// Extract actor if configured\n\t\t\tlet actor: AuditActor = { id: 'system', type: 'system' };\n\t\t\tif (endpoint.actorExtractor) {\n\t\t\t\ttry {\n\t\t\t\t\tactor = await (\n\t\t\t\t\t\tendpoint.actorExtractor as ActorExtractor<\n\t\t\t\t\t\t\tTServices,\n\t\t\t\t\t\t\tTSession,\n\t\t\t\t\t\t\tTLogger\n\t\t\t\t\t\t>\n\t\t\t\t\t)({\n\t\t\t\t\t\tservices: ctx.services as any,\n\t\t\t\t\t\tsession: ctx.session,\n\t\t\t\t\t\theader: ctx.header,\n\t\t\t\t\t\tcookie: ctx.cookie,\n\t\t\t\t\t\tlogger,\n\t\t\t\t\t});\n\t\t\t\t} catch (error) {\n\t\t\t\t\tlogger.error(error as Error, 'Failed to extract actor for audits');\n\t\t\t\t\t// Continue with system actor\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tauditor = new DefaultAuditor<TAuditAction>({\n\t\t\t\tactor,\n\t\t\t\tstorage,\n\t\t\t\tmetadata: {\n\t\t\t\t\tendpoint: endpoint.route,\n\t\t\t\t\tmethod: endpoint.method,\n\t\t\t\t},\n\t\t\t});\n\t\t}\n\n\t\t// Process each declarative audit\n\t\tif (audits?.length) {\n\t\t\tfor (const audit of audits) {\n\t\t\t\tlogger.debug({ audit: audit.type }, 'Processing declarative audit');\n\n\t\t\t\t// Check when condition\n\t\t\t\tif (audit.when && !audit.when(response as any)) {\n\t\t\t\t\tlogger.debug(\n\t\t\t\t\t\t{ audit: audit.type },\n\t\t\t\t\t\t'Audit skipped due to when condition',\n\t\t\t\t\t);\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\n\t\t\t\t// Extract payload\n\t\t\t\tconst payload = audit.payload(response as any);\n\n\t\t\t\t// Extract entityId if configured\n\t\t\t\tconst entityId = audit.entityId?.(response as any);\n\n\t\t\t\t// Record the audit\n\t\t\t\tauditor.audit(audit.type as any, payload as any, {\n\t\t\t\t\ttable: audit.table,\n\t\t\t\t\tentityId,\n\t\t\t\t});\n\t\t\t}\n\t\t}\n\n\t\t// Flush audits to storage\n\t\t// Note: If existingAuditor has a stored transaction (via setTransaction),\n\t\t// flush() will use it automatically\n\t\tconst recordCount = auditor.getRecords().length;\n\t\tif (recordCount > 0) {\n\t\t\t// Check if auditor has a stored transaction (for logging purposes)\n\t\t\tconst trx =\n\t\t\t\t'getTransaction' in auditor\n\t\t\t\t\t? (auditor as { getTransaction(): unknown }).getTransaction()\n\t\t\t\t\t: undefined;\n\t\t\tlogger.debug(\n\t\t\t\t{ auditCount: recordCount, hasTransaction: !!trx },\n\t\t\t\t'Flushing audits',\n\t\t\t);\n\t\t\tawait auditor.flush();\n\t\t}\n\t} catch (error) {\n\t\tlogger.error(error as Error, 'Failed to process audits');\n\t\t// Don't rethrow - audit failures shouldn't fail the request\n\t}\n}\n\n/**\n * Context for audit-aware handler execution.\n */\nexport interface AuditExecutionContext<\n\tTAuditAction extends AuditableAction<string, unknown> = AuditableAction<\n\t\tstring,\n\t\tunknown\n\t>,\n> {\n\t/** The auditor instance for recording audits */\n\tauditor: Auditor<TAuditAction>;\n\t/** The audit storage instance */\n\tstorage: AuditStorage;\n}\n\n/**\n * Create audit context for handler execution.\n * Returns the auditor and storage for use in the handler.\n *\n * @param endpoint - The endpoint with audit configuration\n * @param serviceDiscovery - Service discovery for getting audit storage\n * @param logger - Logger for debug/error messages\n * @param ctx - Request context for actor extraction\n * @returns Audit context with auditor and storage, or undefined if not configured\n */\nexport async function createAuditContext<\n\tTServices extends Service[] = [],\n\tTSession = unknown,\n\tTLogger extends Logger = Logger,\n\tTAuditStorage extends AuditStorage | undefined = undefined,\n\tTAuditStorageServiceName extends string = string,\n\tTAuditAction extends AuditableAction<string, unknown> = AuditableAction<\n\t\tstring,\n\t\tunknown\n\t>,\n\tTDatabase = undefined,\n\tTDatabaseServiceName extends string = string,\n>(\n\tendpoint: Endpoint<\n\t\tany,\n\t\tany,\n\t\tany,\n\t\tany,\n\t\tTServices,\n\t\tTLogger,\n\t\tTSession,\n\t\tany,\n\t\tany,\n\t\tTAuditStorage,\n\t\tTAuditStorageServiceName,\n\t\tTAuditAction,\n\t\tTDatabase,\n\t\tTDatabaseServiceName\n\t>,\n\tserviceDiscovery: ServiceDiscovery<any>,\n\tlogger: TLogger,\n\tctx: {\n\t\tsession: TSession;\n\t\theader: HeaderFn;\n\t\tcookie: CookieFn;\n\t\tservices: Record<string, unknown>;\n\t},\n): Promise<AuditExecutionContext<TAuditAction> | undefined> {\n\tif (!endpoint.auditorStorageService) {\n\t\treturn undefined;\n\t}\n\n\tconst services = await serviceDiscovery.register([\n\t\tendpoint.auditorStorageService,\n\t]);\n\tconst storage = services[\n\t\tendpoint.auditorStorageService.serviceName\n\t] as AuditStorage;\n\n\t// Extract actor if configured\n\tlet actor: AuditActor = { id: 'system', type: 'system' };\n\tif (endpoint.actorExtractor) {\n\t\ttry {\n\t\t\tactor = await (\n\t\t\t\tendpoint.actorExtractor as ActorExtractor<TServices, TSession, TLogger>\n\t\t\t)({\n\t\t\t\tservices: ctx.services as any,\n\t\t\t\tsession: ctx.session,\n\t\t\t\theader: ctx.header,\n\t\t\t\tcookie: ctx.cookie,\n\t\t\t\tlogger,\n\t\t\t});\n\t\t} catch (error) {\n\t\t\tlogger.error(error as Error, 'Failed to extract actor for audits');\n\t\t}\n\t}\n\n\tconst auditor = new DefaultAuditor<TAuditAction>({\n\t\tactor,\n\t\tstorage,\n\t\tmetadata: {\n\t\t\tendpoint: endpoint.route,\n\t\t\tmethod: endpoint.method,\n\t\t},\n\t});\n\n\treturn { auditor, storage };\n}\n\n/**\n * Options for executeWithAuditTransaction.\n */\nexport interface ExecuteWithAuditTransactionOptions {\n\t/**\n\t * Database connection to use for the transaction.\n\t * If this is already a transaction, it will be reused instead of creating a nested one.\n\t * If not provided, the storage's internal database is used.\n\t */\n\tdb?: unknown;\n}\n\n/**\n * Execute a handler with automatic audit transaction support.\n * If the audit storage provides a withTransaction method, wraps execution\n * in a transaction so audits are atomic with handler's database operations.\n *\n * This is database-agnostic - each storage implementation provides its own\n * transaction handling based on the underlying database (Kysely, Drizzle, etc.).\n *\n * If the db parameter is provided and is already a transaction, the storage\n * will reuse it instead of creating a nested transaction (similar to\n * packages/db/src/kysely.ts#withTransaction).\n *\n * @param auditContext - The audit context from createAuditContext\n * @param handler - The handler function to execute (receives auditor)\n * @param onComplete - Called after handler with response, to process declarative audits\n * @param options - Optional configuration including database connection\n * @returns The handler result\n */\nexport async function executeWithAuditTransaction<\n\tT,\n\tTAuditAction extends AuditableAction<string, unknown> = AuditableAction<\n\t\tstring,\n\t\tunknown\n\t>,\n>(\n\tauditContext: AuditExecutionContext<TAuditAction> | undefined,\n\thandler: (auditor?: Auditor<TAuditAction>) => Promise<T>,\n\tonComplete?: (response: T, auditor: Auditor<TAuditAction>) => Promise<void>,\n\toptions?: ExecuteWithAuditTransactionOptions,\n): Promise<T> {\n\t// No audit context - just run handler\n\tif (!auditContext) {\n\t\treturn handler(undefined);\n\t}\n\n\tconst { auditor, storage } = auditContext;\n\n\t// Check if storage provides a transaction wrapper\n\tif (storage.withTransaction) {\n\t\t// Wrap in transaction - audits are atomic with handler operations\n\t\t// The storage's withTransaction handles setTransaction and flush\n\t\t// Pass db so existing transactions are reused\n\t\treturn storage.withTransaction(\n\t\t\tauditor,\n\t\t\tasync () => {\n\t\t\t\tconst response = await handler(auditor);\n\n\t\t\t\t// Process declarative audits within the transaction\n\t\t\t\tif (onComplete) {\n\t\t\t\t\tawait onComplete(response, auditor);\n\t\t\t\t}\n\n\t\t\t\treturn response;\n\t\t\t},\n\t\t\toptions?.db,\n\t\t);\n\t}\n\n\t// No transaction support - run handler and flush audits after\n\tconst response = await handler(auditor);\n\n\tif (onComplete) {\n\t\tawait onComplete(response, auditor);\n\t}\n\n\t// Flush audits (no transaction)\n\tawait auditor.flush();\n\n\treturn response;\n}\n"],"mappings":";;;;;;;;;;;;;AAkNA,eAAsB,mBAarBA,UAgBAC,kBACAC,QACAC,KAM2D;AAC3D,MAAK,SAAS,sBACb;CAGD,MAAM,WAAW,MAAM,iBAAiB,SAAS,CAChD,SAAS,qBACT,EAAC;CACF,MAAM,UAAU,SACf,SAAS,sBAAsB;CAIhC,IAAIC,QAAoB;EAAE,IAAI;EAAU,MAAM;CAAU;AACxD,KAAI,SAAS,eACZ,KAAI;AACH,UAAQ,MAAM,AACb,SAAS,eACR;GACD,UAAU,IAAI;GACd,SAAS,IAAI;GACb,QAAQ,IAAI;GACZ,QAAQ,IAAI;GACZ;EACA,EAAC;CACF,SAAQ,OAAO;AACf,SAAO,MAAM,OAAgB,qCAAqC;CAClE;CAGF,MAAM,UAAU,IAAI,eAA6B;EAChD;EACA;EACA,UAAU;GACT,UAAU,SAAS;GACnB,QAAQ,SAAS;EACjB;CACD;AAED,QAAO;EAAE;EAAS;CAAS;AAC3B;;;;;;;;;;;;;;;;;;;AAgCD,eAAsB,4BAOrBC,cACAC,SACAC,YACAC,SACa;AAEb,MAAK,aACJ,QAAO,eAAkB;CAG1B,MAAM,EAAE,SAAS,SAAS,GAAG;AAG7B,KAAI,QAAQ,gBAIX,QAAO,QAAQ,gBACd,SACA,YAAY;EACX,MAAMC,aAAW,MAAM,QAAQ,QAAQ;AAGvC,MAAI,WACH,OAAM,WAAWA,YAAU,QAAQ;AAGpC,SAAOA;CACP,GACD,SAAS,GACT;CAIF,MAAM,WAAW,MAAM,QAAQ,QAAQ;AAEvC,KAAI,WACH,OAAM,WAAW,UAAU,QAAQ;AAIpC,OAAM,QAAQ,OAAO;AAErB,QAAO;AACP"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const require_Construct = require('./Construct-
|
|
1
|
+
const require_Construct = require('./Construct-Cf_0pAvo.cjs');
|
|
2
2
|
const __geekmidas_audit = require_Construct.__toESM(require("@geekmidas/audit"));
|
|
3
3
|
|
|
4
4
|
//#region src/endpoints/processAudits.ts
|
|
@@ -89,4 +89,4 @@ Object.defineProperty(exports, 'executeWithAuditTransaction', {
|
|
|
89
89
|
return executeWithAuditTransaction;
|
|
90
90
|
}
|
|
91
91
|
});
|
|
92
|
-
//# sourceMappingURL=processAudits-
|
|
92
|
+
//# sourceMappingURL=processAudits-Cd912Eck.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"processAudits-94Ar_EJF.cjs","names":["endpoint: Endpoint<\n\t\tany,\n\t\tany,\n\t\tany,\n\t\tany,\n\t\tTServices,\n\t\tTLogger,\n\t\tTSession,\n\t\tany,\n\t\tany,\n\t\tTAuditStorage,\n\t\tTAuditStorageServiceName,\n\t\tTAuditAction,\n\t\tTDatabase,\n\t\tTDatabaseServiceName\n\t>","serviceDiscovery: ServiceDiscovery<any>","logger: TLogger","ctx: {\n\t\tsession: TSession;\n\t\theader: HeaderFn;\n\t\tcookie: CookieFn;\n\t\tservices: Record<string, unknown>;\n\t}","actor: AuditActor","DefaultAuditor","auditContext: AuditExecutionContext<TAuditAction> | undefined","handler: (auditor?: Auditor<TAuditAction>) => Promise<T>","onComplete?: (response: T, auditor: Auditor<TAuditAction>) => Promise<void>","options?: ExecuteWithAuditTransactionOptions","response"],"sources":["../src/endpoints/processAudits.ts"],"sourcesContent":["import type {\n\tAuditActor,\n\tAuditableAction,\n\tAuditor,\n\tAuditStorage,\n} from '@geekmidas/audit';\nimport { DefaultAuditor } from '@geekmidas/audit';\nimport type { Logger } from '@geekmidas/logger';\nimport type { InferStandardSchema } from '@geekmidas/schema';\nimport type { Service, ServiceDiscovery } from '@geekmidas/services';\nimport type { StandardSchemaV1 } from '@standard-schema/spec';\nimport type { ActorExtractor, MappedAudit } from './audit';\nimport type { CookieFn, Endpoint, HeaderFn } from './Endpoint';\n\n/**\n * Process declarative audit definitions after successful endpoint execution.\n * Similar to publishConstructEvents for events.\n *\n * @param endpoint - The endpoint with audit configuration\n * @param response - The handler response to generate audit payloads from\n * @param serviceDiscovery - Service discovery for registering audit storage\n * @param logger - Logger for debug/error messages\n * @param ctx - Request context (session, headers, cookies, services)\n * @param existingAuditor - Optional existing auditor instance (e.g., from handler context).\n * If provided, uses this auditor (with its stored transaction).\n * If not provided, creates a new auditor.\n */\nexport async function processEndpointAudits<\n\tTServices extends Service[] = [],\n\tTSession = unknown,\n\tTLogger extends Logger = Logger,\n\tOutSchema extends StandardSchemaV1 | undefined = undefined,\n\tTAuditStorage extends AuditStorage | undefined = undefined,\n\tTAuditStorageServiceName extends string = string,\n\tTAuditAction extends AuditableAction<string, unknown> = AuditableAction<\n\t\tstring,\n\t\tunknown\n\t>,\n>(\n\tendpoint: Endpoint<\n\t\tany,\n\t\tany,\n\t\tany,\n\t\tOutSchema,\n\t\tTServices,\n\t\tTLogger,\n\t\tTSession,\n\t\tany,\n\t\tany,\n\t\tTAuditStorage,\n\t\tTAuditStorageServiceName,\n\t\tTAuditAction\n\t>,\n\tresponse: InferStandardSchema<OutSchema>,\n\tserviceDiscovery: ServiceDiscovery<any>,\n\tlogger: TLogger,\n\tctx: {\n\t\tsession: TSession;\n\t\theader: HeaderFn;\n\t\tcookie: CookieFn;\n\t\tservices: Record<string, unknown>;\n\t},\n\texistingAuditor?: Auditor<TAuditAction>,\n): Promise<void> {\n\ttry {\n\t\tconst audits = endpoint.audits as MappedAudit<TAuditAction, OutSchema>[];\n\n\t\t// If we have an existing auditor (from handler context), we need to flush\n\t\t// any manual audits it collected, even if there are no declarative audits\n\t\tconst hasExistingRecords =\n\t\t\texistingAuditor && existingAuditor.getRecords().length > 0;\n\n\t\t// Skip if no declarative audits and no existing records to flush\n\t\tif (!audits?.length && !hasExistingRecords) {\n\t\t\tlogger.debug('No audits to process');\n\t\t\treturn;\n\t\t}\n\n\t\t// If no auditor storage service and we have things to process, warn\n\t\tif (!endpoint.auditorStorageService) {\n\t\t\tif (hasExistingRecords || audits?.length) {\n\t\t\t\tlogger.warn('No auditor storage service available');\n\t\t\t}\n\t\t\treturn;\n\t\t}\n\n\t\t// Get or create auditor\n\t\tlet auditor: Auditor<TAuditAction>;\n\n\t\tif (existingAuditor) {\n\t\t\t// Use existing auditor (preserves stored transaction and manual audits)\n\t\t\tauditor = existingAuditor;\n\t\t\tlogger.debug('Using existing auditor from handler context');\n\t\t} else {\n\t\t\t// Create new auditor (backward compatibility)\n\t\t\tconst services = await serviceDiscovery.register([\n\t\t\t\tendpoint.auditorStorageService,\n\t\t\t]);\n\t\t\tconst storage = services[\n\t\t\t\tendpoint.auditorStorageService.serviceName\n\t\t\t] as AuditStorage;\n\n\t\t\t// Extract actor if configured\n\t\t\tlet actor: AuditActor = { id: 'system', type: 'system' };\n\t\t\tif (endpoint.actorExtractor) {\n\t\t\t\ttry {\n\t\t\t\t\tactor = await (\n\t\t\t\t\t\tendpoint.actorExtractor as ActorExtractor<\n\t\t\t\t\t\t\tTServices,\n\t\t\t\t\t\t\tTSession,\n\t\t\t\t\t\t\tTLogger\n\t\t\t\t\t\t>\n\t\t\t\t\t)({\n\t\t\t\t\t\tservices: ctx.services as any,\n\t\t\t\t\t\tsession: ctx.session,\n\t\t\t\t\t\theader: ctx.header,\n\t\t\t\t\t\tcookie: ctx.cookie,\n\t\t\t\t\t\tlogger,\n\t\t\t\t\t});\n\t\t\t\t} catch (error) {\n\t\t\t\t\tlogger.error(error as Error, 'Failed to extract actor for audits');\n\t\t\t\t\t// Continue with system actor\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tauditor = new DefaultAuditor<TAuditAction>({\n\t\t\t\tactor,\n\t\t\t\tstorage,\n\t\t\t\tmetadata: {\n\t\t\t\t\tendpoint: endpoint.route,\n\t\t\t\t\tmethod: endpoint.method,\n\t\t\t\t},\n\t\t\t});\n\t\t}\n\n\t\t// Process each declarative audit\n\t\tif (audits?.length) {\n\t\t\tfor (const audit of audits) {\n\t\t\t\tlogger.debug({ audit: audit.type }, 'Processing declarative audit');\n\n\t\t\t\t// Check when condition\n\t\t\t\tif (audit.when && !audit.when(response as any)) {\n\t\t\t\t\tlogger.debug(\n\t\t\t\t\t\t{ audit: audit.type },\n\t\t\t\t\t\t'Audit skipped due to when condition',\n\t\t\t\t\t);\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\n\t\t\t\t// Extract payload\n\t\t\t\tconst payload = audit.payload(response as any);\n\n\t\t\t\t// Extract entityId if configured\n\t\t\t\tconst entityId = audit.entityId?.(response as any);\n\n\t\t\t\t// Record the audit\n\t\t\t\tauditor.audit(audit.type as any, payload as any, {\n\t\t\t\t\ttable: audit.table,\n\t\t\t\t\tentityId,\n\t\t\t\t});\n\t\t\t}\n\t\t}\n\n\t\t// Flush audits to storage\n\t\t// Note: If existingAuditor has a stored transaction (via setTransaction),\n\t\t// flush() will use it automatically\n\t\tconst recordCount = auditor.getRecords().length;\n\t\tif (recordCount > 0) {\n\t\t\t// Check if auditor has a stored transaction (for logging purposes)\n\t\t\tconst trx =\n\t\t\t\t'getTransaction' in auditor\n\t\t\t\t\t? (auditor as { getTransaction(): unknown }).getTransaction()\n\t\t\t\t\t: undefined;\n\t\t\tlogger.debug(\n\t\t\t\t{ auditCount: recordCount, hasTransaction: !!trx },\n\t\t\t\t'Flushing audits',\n\t\t\t);\n\t\t\tawait auditor.flush();\n\t\t}\n\t} catch (error) {\n\t\tlogger.error(error as Error, 'Failed to process audits');\n\t\t// Don't rethrow - audit failures shouldn't fail the request\n\t}\n}\n\n/**\n * Context for audit-aware handler execution.\n */\nexport interface AuditExecutionContext<\n\tTAuditAction extends AuditableAction<string, unknown> = AuditableAction<\n\t\tstring,\n\t\tunknown\n\t>,\n> {\n\t/** The auditor instance for recording audits */\n\tauditor: Auditor<TAuditAction>;\n\t/** The audit storage instance */\n\tstorage: AuditStorage;\n}\n\n/**\n * Create audit context for handler execution.\n * Returns the auditor and storage for use in the handler.\n *\n * @param endpoint - The endpoint with audit configuration\n * @param serviceDiscovery - Service discovery for getting audit storage\n * @param logger - Logger for debug/error messages\n * @param ctx - Request context for actor extraction\n * @returns Audit context with auditor and storage, or undefined if not configured\n */\nexport async function createAuditContext<\n\tTServices extends Service[] = [],\n\tTSession = unknown,\n\tTLogger extends Logger = Logger,\n\tTAuditStorage extends AuditStorage | undefined = undefined,\n\tTAuditStorageServiceName extends string = string,\n\tTAuditAction extends AuditableAction<string, unknown> = AuditableAction<\n\t\tstring,\n\t\tunknown\n\t>,\n\tTDatabase = undefined,\n\tTDatabaseServiceName extends string = string,\n>(\n\tendpoint: Endpoint<\n\t\tany,\n\t\tany,\n\t\tany,\n\t\tany,\n\t\tTServices,\n\t\tTLogger,\n\t\tTSession,\n\t\tany,\n\t\tany,\n\t\tTAuditStorage,\n\t\tTAuditStorageServiceName,\n\t\tTAuditAction,\n\t\tTDatabase,\n\t\tTDatabaseServiceName\n\t>,\n\tserviceDiscovery: ServiceDiscovery<any>,\n\tlogger: TLogger,\n\tctx: {\n\t\tsession: TSession;\n\t\theader: HeaderFn;\n\t\tcookie: CookieFn;\n\t\tservices: Record<string, unknown>;\n\t},\n): Promise<AuditExecutionContext<TAuditAction> | undefined> {\n\tif (!endpoint.auditorStorageService) {\n\t\treturn undefined;\n\t}\n\n\tconst services = await serviceDiscovery.register([\n\t\tendpoint.auditorStorageService,\n\t]);\n\tconst storage = services[\n\t\tendpoint.auditorStorageService.serviceName\n\t] as AuditStorage;\n\n\t// Extract actor if configured\n\tlet actor: AuditActor = { id: 'system', type: 'system' };\n\tif (endpoint.actorExtractor) {\n\t\ttry {\n\t\t\tactor = await (\n\t\t\t\tendpoint.actorExtractor as ActorExtractor<TServices, TSession, TLogger>\n\t\t\t)({\n\t\t\t\tservices: ctx.services as any,\n\t\t\t\tsession: ctx.session,\n\t\t\t\theader: ctx.header,\n\t\t\t\tcookie: ctx.cookie,\n\t\t\t\tlogger,\n\t\t\t});\n\t\t} catch (error) {\n\t\t\tlogger.error(error as Error, 'Failed to extract actor for audits');\n\t\t}\n\t}\n\n\tconst auditor = new DefaultAuditor<TAuditAction>({\n\t\tactor,\n\t\tstorage,\n\t\tmetadata: {\n\t\t\tendpoint: endpoint.route,\n\t\t\tmethod: endpoint.method,\n\t\t},\n\t});\n\n\treturn { auditor, storage };\n}\n\n/**\n * Options for executeWithAuditTransaction.\n */\nexport interface ExecuteWithAuditTransactionOptions {\n\t/**\n\t * Database connection to use for the transaction.\n\t * If this is already a transaction, it will be reused instead of creating a nested one.\n\t * If not provided, the storage's internal database is used.\n\t */\n\tdb?: unknown;\n}\n\n/**\n * Execute a handler with automatic audit transaction support.\n * If the audit storage provides a withTransaction method, wraps execution\n * in a transaction so audits are atomic with handler's database operations.\n *\n * This is database-agnostic - each storage implementation provides its own\n * transaction handling based on the underlying database (Kysely, Drizzle, etc.).\n *\n * If the db parameter is provided and is already a transaction, the storage\n * will reuse it instead of creating a nested transaction (similar to\n * packages/db/src/kysely.ts#withTransaction).\n *\n * @param auditContext - The audit context from createAuditContext\n * @param handler - The handler function to execute (receives auditor)\n * @param onComplete - Called after handler with response, to process declarative audits\n * @param options - Optional configuration including database connection\n * @returns The handler result\n */\nexport async function executeWithAuditTransaction<\n\tT,\n\tTAuditAction extends AuditableAction<string, unknown> = AuditableAction<\n\t\tstring,\n\t\tunknown\n\t>,\n>(\n\tauditContext: AuditExecutionContext<TAuditAction> | undefined,\n\thandler: (auditor?: Auditor<TAuditAction>) => Promise<T>,\n\tonComplete?: (response: T, auditor: Auditor<TAuditAction>) => Promise<void>,\n\toptions?: ExecuteWithAuditTransactionOptions,\n): Promise<T> {\n\t// No audit context - just run handler\n\tif (!auditContext) {\n\t\treturn handler(undefined);\n\t}\n\n\tconst { auditor, storage } = auditContext;\n\n\t// Check if storage provides a transaction wrapper\n\tif (storage.withTransaction) {\n\t\t// Wrap in transaction - audits are atomic with handler operations\n\t\t// The storage's withTransaction handles setTransaction and flush\n\t\t// Pass db so existing transactions are reused\n\t\treturn storage.withTransaction(\n\t\t\tauditor,\n\t\t\tasync () => {\n\t\t\t\tconst response = await handler(auditor);\n\n\t\t\t\t// Process declarative audits within the transaction\n\t\t\t\tif (onComplete) {\n\t\t\t\t\tawait onComplete(response, auditor);\n\t\t\t\t}\n\n\t\t\t\treturn response;\n\t\t\t},\n\t\t\toptions?.db,\n\t\t);\n\t}\n\n\t// No transaction support - run handler and flush audits after\n\tconst response = await handler(auditor);\n\n\tif (onComplete) {\n\t\tawait onComplete(response, auditor);\n\t}\n\n\t// Flush audits (no transaction)\n\tawait auditor.flush();\n\n\treturn response;\n}\n"],"mappings":";;;;;;;;;;;;;;AAkNA,eAAsB,mBAarBA,UAgBAC,kBACAC,QACAC,KAM2D;AAC3D,MAAK,SAAS,sBACb;CAGD,MAAM,WAAW,MAAM,iBAAiB,SAAS,CAChD,SAAS,qBACT,EAAC;CACF,MAAM,UAAU,SACf,SAAS,sBAAsB;CAIhC,IAAIC,QAAoB;EAAE,IAAI;EAAU,MAAM;CAAU;AACxD,KAAI,SAAS,eACZ,KAAI;AACH,UAAQ,MAAM,AACb,SAAS,eACR;GACD,UAAU,IAAI;GACd,SAAS,IAAI;GACb,QAAQ,IAAI;GACZ,QAAQ,IAAI;GACZ;EACA,EAAC;CACF,SAAQ,OAAO;AACf,SAAO,MAAM,OAAgB,qCAAqC;CAClE;CAGF,MAAM,UAAU,IAAIC,iCAA6B;EAChD;EACA;EACA,UAAU;GACT,UAAU,SAAS;GACnB,QAAQ,SAAS;EACjB;CACD;AAED,QAAO;EAAE;EAAS;CAAS;AAC3B;;;;;;;;;;;;;;;;;;;AAgCD,eAAsB,4BAOrBC,cACAC,SACAC,YACAC,SACa;AAEb,MAAK,aACJ,QAAO,eAAkB;CAG1B,MAAM,EAAE,SAAS,SAAS,GAAG;AAG7B,KAAI,QAAQ,gBAIX,QAAO,QAAQ,gBACd,SACA,YAAY;EACX,MAAMC,aAAW,MAAM,QAAQ,QAAQ;AAGvC,MAAI,WACH,OAAM,WAAWA,YAAU,QAAQ;AAGpC,SAAOA;CACP,GACD,SAAS,GACT;CAIF,MAAM,WAAW,MAAM,QAAQ,QAAQ;AAEvC,KAAI,WACH,OAAM,WAAW,UAAU,QAAQ;AAIpC,OAAM,QAAQ,OAAO;AAErB,QAAO;AACP"}
|
|
1
|
+
{"version":3,"file":"processAudits-Cd912Eck.cjs","names":["endpoint: Endpoint<\n\t\tany,\n\t\tany,\n\t\tany,\n\t\tany,\n\t\tTServices,\n\t\tTLogger,\n\t\tTSession,\n\t\tany,\n\t\tany,\n\t\tTAuditStorage,\n\t\tTAuditStorageServiceName,\n\t\tTAuditAction,\n\t\tTDatabase,\n\t\tTDatabaseServiceName\n\t>","serviceDiscovery: ServiceDiscovery<any>","logger: TLogger","ctx: {\n\t\tsession: TSession;\n\t\theader: HeaderFn;\n\t\tcookie: CookieFn;\n\t\tservices: Record<string, unknown>;\n\t}","actor: AuditActor","DefaultAuditor","auditContext: AuditExecutionContext<TAuditAction> | undefined","handler: (auditor?: Auditor<TAuditAction>) => Promise<T>","onComplete?: (response: T, auditor: Auditor<TAuditAction>) => Promise<void>","options?: ExecuteWithAuditTransactionOptions","response"],"sources":["../src/endpoints/processAudits.ts"],"sourcesContent":["import type {\n\tAuditActor,\n\tAuditableAction,\n\tAuditor,\n\tAuditStorage,\n} from '@geekmidas/audit';\nimport { DefaultAuditor } from '@geekmidas/audit';\nimport type { Logger } from '@geekmidas/logger';\nimport type { InferStandardSchema } from '@geekmidas/schema';\nimport type { Service, ServiceDiscovery } from '@geekmidas/services';\nimport type { StandardSchemaV1 } from '@standard-schema/spec';\nimport type { ActorExtractor, MappedAudit } from './audit';\nimport type { CookieFn, Endpoint, HeaderFn } from './Endpoint';\n\n/**\n * Process declarative audit definitions after successful endpoint execution.\n * Similar to publishConstructEvents for events.\n *\n * @param endpoint - The endpoint with audit configuration\n * @param response - The handler response to generate audit payloads from\n * @param serviceDiscovery - Service discovery for registering audit storage\n * @param logger - Logger for debug/error messages\n * @param ctx - Request context (session, headers, cookies, services)\n * @param existingAuditor - Optional existing auditor instance (e.g., from handler context).\n * If provided, uses this auditor (with its stored transaction).\n * If not provided, creates a new auditor.\n */\nexport async function processEndpointAudits<\n\tTServices extends Service[] = [],\n\tTSession = unknown,\n\tTLogger extends Logger = Logger,\n\tOutSchema extends StandardSchemaV1 | undefined = undefined,\n\tTAuditStorage extends AuditStorage | undefined = undefined,\n\tTAuditStorageServiceName extends string = string,\n\tTAuditAction extends AuditableAction<string, unknown> = AuditableAction<\n\t\tstring,\n\t\tunknown\n\t>,\n>(\n\tendpoint: Endpoint<\n\t\tany,\n\t\tany,\n\t\tany,\n\t\tOutSchema,\n\t\tTServices,\n\t\tTLogger,\n\t\tTSession,\n\t\tany,\n\t\tany,\n\t\tTAuditStorage,\n\t\tTAuditStorageServiceName,\n\t\tTAuditAction\n\t>,\n\tresponse: InferStandardSchema<OutSchema>,\n\tserviceDiscovery: ServiceDiscovery<any>,\n\tlogger: TLogger,\n\tctx: {\n\t\tsession: TSession;\n\t\theader: HeaderFn;\n\t\tcookie: CookieFn;\n\t\tservices: Record<string, unknown>;\n\t},\n\texistingAuditor?: Auditor<TAuditAction>,\n): Promise<void> {\n\ttry {\n\t\tconst audits = endpoint.audits as MappedAudit<TAuditAction, OutSchema>[];\n\n\t\t// If we have an existing auditor (from handler context), we need to flush\n\t\t// any manual audits it collected, even if there are no declarative audits\n\t\tconst hasExistingRecords =\n\t\t\texistingAuditor && existingAuditor.getRecords().length > 0;\n\n\t\t// Skip if no declarative audits and no existing records to flush\n\t\tif (!audits?.length && !hasExistingRecords) {\n\t\t\tlogger.debug('No audits to process');\n\t\t\treturn;\n\t\t}\n\n\t\t// If no auditor storage service and we have things to process, warn\n\t\tif (!endpoint.auditorStorageService) {\n\t\t\tif (hasExistingRecords || audits?.length) {\n\t\t\t\tlogger.warn('No auditor storage service available');\n\t\t\t}\n\t\t\treturn;\n\t\t}\n\n\t\t// Get or create auditor\n\t\tlet auditor: Auditor<TAuditAction>;\n\n\t\tif (existingAuditor) {\n\t\t\t// Use existing auditor (preserves stored transaction and manual audits)\n\t\t\tauditor = existingAuditor;\n\t\t\tlogger.debug('Using existing auditor from handler context');\n\t\t} else {\n\t\t\t// Create new auditor (backward compatibility)\n\t\t\tconst services = await serviceDiscovery.register([\n\t\t\t\tendpoint.auditorStorageService,\n\t\t\t]);\n\t\t\tconst storage = services[\n\t\t\t\tendpoint.auditorStorageService.serviceName\n\t\t\t] as AuditStorage;\n\n\t\t\t// Extract actor if configured\n\t\t\tlet actor: AuditActor = { id: 'system', type: 'system' };\n\t\t\tif (endpoint.actorExtractor) {\n\t\t\t\ttry {\n\t\t\t\t\tactor = await (\n\t\t\t\t\t\tendpoint.actorExtractor as ActorExtractor<\n\t\t\t\t\t\t\tTServices,\n\t\t\t\t\t\t\tTSession,\n\t\t\t\t\t\t\tTLogger\n\t\t\t\t\t\t>\n\t\t\t\t\t)({\n\t\t\t\t\t\tservices: ctx.services as any,\n\t\t\t\t\t\tsession: ctx.session,\n\t\t\t\t\t\theader: ctx.header,\n\t\t\t\t\t\tcookie: ctx.cookie,\n\t\t\t\t\t\tlogger,\n\t\t\t\t\t});\n\t\t\t\t} catch (error) {\n\t\t\t\t\tlogger.error(error as Error, 'Failed to extract actor for audits');\n\t\t\t\t\t// Continue with system actor\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tauditor = new DefaultAuditor<TAuditAction>({\n\t\t\t\tactor,\n\t\t\t\tstorage,\n\t\t\t\tmetadata: {\n\t\t\t\t\tendpoint: endpoint.route,\n\t\t\t\t\tmethod: endpoint.method,\n\t\t\t\t},\n\t\t\t});\n\t\t}\n\n\t\t// Process each declarative audit\n\t\tif (audits?.length) {\n\t\t\tfor (const audit of audits) {\n\t\t\t\tlogger.debug({ audit: audit.type }, 'Processing declarative audit');\n\n\t\t\t\t// Check when condition\n\t\t\t\tif (audit.when && !audit.when(response as any)) {\n\t\t\t\t\tlogger.debug(\n\t\t\t\t\t\t{ audit: audit.type },\n\t\t\t\t\t\t'Audit skipped due to when condition',\n\t\t\t\t\t);\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\n\t\t\t\t// Extract payload\n\t\t\t\tconst payload = audit.payload(response as any);\n\n\t\t\t\t// Extract entityId if configured\n\t\t\t\tconst entityId = audit.entityId?.(response as any);\n\n\t\t\t\t// Record the audit\n\t\t\t\tauditor.audit(audit.type as any, payload as any, {\n\t\t\t\t\ttable: audit.table,\n\t\t\t\t\tentityId,\n\t\t\t\t});\n\t\t\t}\n\t\t}\n\n\t\t// Flush audits to storage\n\t\t// Note: If existingAuditor has a stored transaction (via setTransaction),\n\t\t// flush() will use it automatically\n\t\tconst recordCount = auditor.getRecords().length;\n\t\tif (recordCount > 0) {\n\t\t\t// Check if auditor has a stored transaction (for logging purposes)\n\t\t\tconst trx =\n\t\t\t\t'getTransaction' in auditor\n\t\t\t\t\t? (auditor as { getTransaction(): unknown }).getTransaction()\n\t\t\t\t\t: undefined;\n\t\t\tlogger.debug(\n\t\t\t\t{ auditCount: recordCount, hasTransaction: !!trx },\n\t\t\t\t'Flushing audits',\n\t\t\t);\n\t\t\tawait auditor.flush();\n\t\t}\n\t} catch (error) {\n\t\tlogger.error(error as Error, 'Failed to process audits');\n\t\t// Don't rethrow - audit failures shouldn't fail the request\n\t}\n}\n\n/**\n * Context for audit-aware handler execution.\n */\nexport interface AuditExecutionContext<\n\tTAuditAction extends AuditableAction<string, unknown> = AuditableAction<\n\t\tstring,\n\t\tunknown\n\t>,\n> {\n\t/** The auditor instance for recording audits */\n\tauditor: Auditor<TAuditAction>;\n\t/** The audit storage instance */\n\tstorage: AuditStorage;\n}\n\n/**\n * Create audit context for handler execution.\n * Returns the auditor and storage for use in the handler.\n *\n * @param endpoint - The endpoint with audit configuration\n * @param serviceDiscovery - Service discovery for getting audit storage\n * @param logger - Logger for debug/error messages\n * @param ctx - Request context for actor extraction\n * @returns Audit context with auditor and storage, or undefined if not configured\n */\nexport async function createAuditContext<\n\tTServices extends Service[] = [],\n\tTSession = unknown,\n\tTLogger extends Logger = Logger,\n\tTAuditStorage extends AuditStorage | undefined = undefined,\n\tTAuditStorageServiceName extends string = string,\n\tTAuditAction extends AuditableAction<string, unknown> = AuditableAction<\n\t\tstring,\n\t\tunknown\n\t>,\n\tTDatabase = undefined,\n\tTDatabaseServiceName extends string = string,\n>(\n\tendpoint: Endpoint<\n\t\tany,\n\t\tany,\n\t\tany,\n\t\tany,\n\t\tTServices,\n\t\tTLogger,\n\t\tTSession,\n\t\tany,\n\t\tany,\n\t\tTAuditStorage,\n\t\tTAuditStorageServiceName,\n\t\tTAuditAction,\n\t\tTDatabase,\n\t\tTDatabaseServiceName\n\t>,\n\tserviceDiscovery: ServiceDiscovery<any>,\n\tlogger: TLogger,\n\tctx: {\n\t\tsession: TSession;\n\t\theader: HeaderFn;\n\t\tcookie: CookieFn;\n\t\tservices: Record<string, unknown>;\n\t},\n): Promise<AuditExecutionContext<TAuditAction> | undefined> {\n\tif (!endpoint.auditorStorageService) {\n\t\treturn undefined;\n\t}\n\n\tconst services = await serviceDiscovery.register([\n\t\tendpoint.auditorStorageService,\n\t]);\n\tconst storage = services[\n\t\tendpoint.auditorStorageService.serviceName\n\t] as AuditStorage;\n\n\t// Extract actor if configured\n\tlet actor: AuditActor = { id: 'system', type: 'system' };\n\tif (endpoint.actorExtractor) {\n\t\ttry {\n\t\t\tactor = await (\n\t\t\t\tendpoint.actorExtractor as ActorExtractor<TServices, TSession, TLogger>\n\t\t\t)({\n\t\t\t\tservices: ctx.services as any,\n\t\t\t\tsession: ctx.session,\n\t\t\t\theader: ctx.header,\n\t\t\t\tcookie: ctx.cookie,\n\t\t\t\tlogger,\n\t\t\t});\n\t\t} catch (error) {\n\t\t\tlogger.error(error as Error, 'Failed to extract actor for audits');\n\t\t}\n\t}\n\n\tconst auditor = new DefaultAuditor<TAuditAction>({\n\t\tactor,\n\t\tstorage,\n\t\tmetadata: {\n\t\t\tendpoint: endpoint.route,\n\t\t\tmethod: endpoint.method,\n\t\t},\n\t});\n\n\treturn { auditor, storage };\n}\n\n/**\n * Options for executeWithAuditTransaction.\n */\nexport interface ExecuteWithAuditTransactionOptions {\n\t/**\n\t * Database connection to use for the transaction.\n\t * If this is already a transaction, it will be reused instead of creating a nested one.\n\t * If not provided, the storage's internal database is used.\n\t */\n\tdb?: unknown;\n}\n\n/**\n * Execute a handler with automatic audit transaction support.\n * If the audit storage provides a withTransaction method, wraps execution\n * in a transaction so audits are atomic with handler's database operations.\n *\n * This is database-agnostic - each storage implementation provides its own\n * transaction handling based on the underlying database (Kysely, Drizzle, etc.).\n *\n * If the db parameter is provided and is already a transaction, the storage\n * will reuse it instead of creating a nested transaction (similar to\n * packages/db/src/kysely.ts#withTransaction).\n *\n * @param auditContext - The audit context from createAuditContext\n * @param handler - The handler function to execute (receives auditor)\n * @param onComplete - Called after handler with response, to process declarative audits\n * @param options - Optional configuration including database connection\n * @returns The handler result\n */\nexport async function executeWithAuditTransaction<\n\tT,\n\tTAuditAction extends AuditableAction<string, unknown> = AuditableAction<\n\t\tstring,\n\t\tunknown\n\t>,\n>(\n\tauditContext: AuditExecutionContext<TAuditAction> | undefined,\n\thandler: (auditor?: Auditor<TAuditAction>) => Promise<T>,\n\tonComplete?: (response: T, auditor: Auditor<TAuditAction>) => Promise<void>,\n\toptions?: ExecuteWithAuditTransactionOptions,\n): Promise<T> {\n\t// No audit context - just run handler\n\tif (!auditContext) {\n\t\treturn handler(undefined);\n\t}\n\n\tconst { auditor, storage } = auditContext;\n\n\t// Check if storage provides a transaction wrapper\n\tif (storage.withTransaction) {\n\t\t// Wrap in transaction - audits are atomic with handler operations\n\t\t// The storage's withTransaction handles setTransaction and flush\n\t\t// Pass db so existing transactions are reused\n\t\treturn storage.withTransaction(\n\t\t\tauditor,\n\t\t\tasync () => {\n\t\t\t\tconst response = await handler(auditor);\n\n\t\t\t\t// Process declarative audits within the transaction\n\t\t\t\tif (onComplete) {\n\t\t\t\t\tawait onComplete(response, auditor);\n\t\t\t\t}\n\n\t\t\t\treturn response;\n\t\t\t},\n\t\t\toptions?.db,\n\t\t);\n\t}\n\n\t// No transaction support - run handler and flush audits after\n\tconst response = await handler(auditor);\n\n\tif (onComplete) {\n\t\tawait onComplete(response, auditor);\n\t}\n\n\t// Flush audits (no transaction)\n\tawait auditor.flush();\n\n\treturn response;\n}\n"],"mappings":";;;;;;;;;;;;;;AAkNA,eAAsB,mBAarBA,UAgBAC,kBACAC,QACAC,KAM2D;AAC3D,MAAK,SAAS,sBACb;CAGD,MAAM,WAAW,MAAM,iBAAiB,SAAS,CAChD,SAAS,qBACT,EAAC;CACF,MAAM,UAAU,SACf,SAAS,sBAAsB;CAIhC,IAAIC,QAAoB;EAAE,IAAI;EAAU,MAAM;CAAU;AACxD,KAAI,SAAS,eACZ,KAAI;AACH,UAAQ,MAAM,AACb,SAAS,eACR;GACD,UAAU,IAAI;GACd,SAAS,IAAI;GACb,QAAQ,IAAI;GACZ,QAAQ,IAAI;GACZ;EACA,EAAC;CACF,SAAQ,OAAO;AACf,SAAO,MAAM,OAAgB,qCAAqC;CAClE;CAGF,MAAM,UAAU,IAAIC,iCAA6B;EAChD;EACA;EACA,UAAU;GACT,UAAU,SAAS;GACnB,QAAQ,SAAS;EACjB;CACD;AAED,QAAO;EAAE;EAAS;CAAS;AAC3B;;;;;;;;;;;;;;;;;;;AAgCD,eAAsB,4BAOrBC,cACAC,SACAC,YACAC,SACa;AAEb,MAAK,aACJ,QAAO,eAAkB;CAG1B,MAAM,EAAE,SAAS,SAAS,GAAG;AAG7B,KAAI,QAAQ,gBAIX,QAAO,QAAQ,gBACd,SACA,YAAY;EACX,MAAMC,aAAW,MAAM,QAAQ,QAAQ;AAGvC,MAAI,WACH,OAAM,WAAWA,YAAU,QAAQ;AAGpC,SAAOA;CACP,GACD,SAAS,GACT;CAIF,MAAM,WAAW,MAAM,QAAQ,QAAQ;AAEvC,KAAI,WACH,OAAM,WAAW,UAAU,QAAQ;AAIpC,OAAM,QAAQ,OAAO;AAErB,QAAO;AACP"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"publisher-
|
|
1
|
+
{"version":3,"file":"publisher-B6Wu-JNv.cjs","names":["logger: Logger","serviceDiscovery: ServiceDiscovery<any>","ev: MappedEvent<T, OutSchema>[]","response: InferStandardSchema<OutSchema>","publisherService: TPublisherService","events: MappedEvent<T, OutSchema>[]","construct: Construct<\n\t\tLogger,\n\t\tTServiceName,\n\t\tT,\n\t\tOutSchema,\n\t\tTServices,\n\t\tTAuditStorageServiceName,\n\t\tTAuditStorage\n\t>"],"sources":["../src/publisher.ts"],"sourcesContent":["import type { AuditStorage } from '@geekmidas/audit';\nimport type { EventPublisher, MappedEvent } from '@geekmidas/events';\nimport type { Logger } from '@geekmidas/logger';\nimport type { InferStandardSchema } from '@geekmidas/schema';\nimport type { Service, ServiceDiscovery } from '@geekmidas/services';\nimport type { StandardSchemaV1 } from '@standard-schema/spec';\nimport type { Construct } from './Construct';\n\nexport async function publishEvents<\n\tT extends EventPublisher<any> | undefined,\n\tOutSchema extends StandardSchemaV1 | undefined = undefined,\n\tTServiceName extends string = string,\n\tTPublisherService extends Service<TServiceName, T> | undefined = undefined,\n>(\n\tlogger: Logger,\n\tserviceDiscovery: ServiceDiscovery<any>,\n\tev: MappedEvent<T, OutSchema>[] = [],\n\tresponse: InferStandardSchema<OutSchema>,\n\tpublisherService: TPublisherService,\n) {\n\ttry {\n\t\tif (!ev?.length) {\n\t\t\tlogger.debug('No events to publish');\n\t\t\treturn;\n\t\t}\n\t\tif (!publisherService) {\n\t\t\tlogger.warn('No publisher service available');\n\t\t\treturn;\n\t\t}\n\n\t\tconst services = await serviceDiscovery.register([publisherService]);\n\n\t\tconst publisher = services[\n\t\t\tpublisherService.serviceName\n\t\t] as EventPublisher<any>;\n\n\t\tconst events: MappedEvent<T, OutSchema>[] = [];\n\n\t\tfor (const { when, payload, type, ...e } of ev) {\n\t\t\tlogger.debug({ event: type }, 'Processing event');\n\t\t\tconst resolvedPayload = await payload(response);\n\t\t\tconst event = {\n\t\t\t\t...e,\n\t\t\t\ttype,\n\t\t\t\tpayload: resolvedPayload,\n\t\t\t};\n\n\t\t\tif (!when || when(response as any)) {\n\t\t\t\tevents.push(event);\n\t\t\t}\n\t\t}\n\n\t\tif (events.length) {\n\t\t\tlogger.debug({ eventCount: ev.length }, 'Publishing events');\n\n\t\t\tawait publisher.publish(events).catch((err) => {\n\t\t\t\tlogger.error(err, 'Failed to publish events');\n\t\t\t});\n\t\t}\n\t} catch (error) {\n\t\tlogger.error(error as any, 'Something went wrong publishing events');\n\t}\n}\n\nexport async function publishConstructEvents<\n\tT extends EventPublisher<any> | undefined,\n\tOutSchema extends StandardSchemaV1 | undefined = undefined,\n\tTServiceName extends string = string,\n\tTServices extends Service[] = [],\n\tTAuditStorageServiceName extends string = string,\n\tTAuditStorage extends AuditStorage | undefined = undefined,\n>(\n\tconstruct: Construct<\n\t\tLogger,\n\t\tTServiceName,\n\t\tT,\n\t\tOutSchema,\n\t\tTServices,\n\t\tTAuditStorageServiceName,\n\t\tTAuditStorage\n\t>,\n\tresponse: InferStandardSchema<OutSchema>,\n\tserviceDiscovery: ServiceDiscovery<any>,\n\tlogger: Logger = construct.logger,\n) {\n\treturn publishEvents(\n\t\tlogger,\n\t\tserviceDiscovery,\n\t\tconstruct.events,\n\t\tresponse,\n\t\tconstruct.publisherService,\n\t);\n}\n"],"mappings":";;AAQA,eAAsB,cAMrBA,QACAC,kBACAC,KAAkC,CAAE,GACpCC,UACAC,kBACC;AACD,KAAI;AACH,OAAK,IAAI,QAAQ;AAChB,UAAO,MAAM,uBAAuB;AACpC;EACA;AACD,OAAK,kBAAkB;AACtB,UAAO,KAAK,iCAAiC;AAC7C;EACA;EAED,MAAM,WAAW,MAAM,iBAAiB,SAAS,CAAC,gBAAiB,EAAC;EAEpE,MAAM,YAAY,SACjB,iBAAiB;EAGlB,MAAMC,SAAsC,CAAE;AAE9C,OAAK,MAAM,EAAE,MAAM,SAAS,KAAM,GAAG,GAAG,IAAI,IAAI;AAC/C,UAAO,MAAM,EAAE,OAAO,KAAM,GAAE,mBAAmB;GACjD,MAAM,kBAAkB,MAAM,QAAQ,SAAS;GAC/C,MAAM,QAAQ;IACb,GAAG;IACH;IACA,SAAS;GACT;AAED,QAAK,QAAQ,KAAK,SAAgB,CACjC,QAAO,KAAK,MAAM;EAEnB;AAED,MAAI,OAAO,QAAQ;AAClB,UAAO,MAAM,EAAE,YAAY,GAAG,OAAQ,GAAE,oBAAoB;AAE5D,SAAM,UAAU,QAAQ,OAAO,CAAC,MAAM,CAAC,QAAQ;AAC9C,WAAO,MAAM,KAAK,2BAA2B;GAC7C,EAAC;EACF;CACD,SAAQ,OAAO;AACf,SAAO,MAAM,OAAc,yCAAyC;CACpE;AACD;AAED,eAAsB,uBAQrBC,WASAH,UACAF,kBACAD,SAAiB,UAAU,QAC1B;AACD,QAAO,cACN,QACA,kBACA,UAAU,QACV,UACA,UAAU,iBACV;AACD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"publisher-
|
|
1
|
+
{"version":3,"file":"publisher-Cs7WcvJl.mjs","names":["logger: Logger","serviceDiscovery: ServiceDiscovery<any>","ev: MappedEvent<T, OutSchema>[]","response: InferStandardSchema<OutSchema>","publisherService: TPublisherService","events: MappedEvent<T, OutSchema>[]","construct: Construct<\n\t\tLogger,\n\t\tTServiceName,\n\t\tT,\n\t\tOutSchema,\n\t\tTServices,\n\t\tTAuditStorageServiceName,\n\t\tTAuditStorage\n\t>"],"sources":["../src/publisher.ts"],"sourcesContent":["import type { AuditStorage } from '@geekmidas/audit';\nimport type { EventPublisher, MappedEvent } from '@geekmidas/events';\nimport type { Logger } from '@geekmidas/logger';\nimport type { InferStandardSchema } from '@geekmidas/schema';\nimport type { Service, ServiceDiscovery } from '@geekmidas/services';\nimport type { StandardSchemaV1 } from '@standard-schema/spec';\nimport type { Construct } from './Construct';\n\nexport async function publishEvents<\n\tT extends EventPublisher<any> | undefined,\n\tOutSchema extends StandardSchemaV1 | undefined = undefined,\n\tTServiceName extends string = string,\n\tTPublisherService extends Service<TServiceName, T> | undefined = undefined,\n>(\n\tlogger: Logger,\n\tserviceDiscovery: ServiceDiscovery<any>,\n\tev: MappedEvent<T, OutSchema>[] = [],\n\tresponse: InferStandardSchema<OutSchema>,\n\tpublisherService: TPublisherService,\n) {\n\ttry {\n\t\tif (!ev?.length) {\n\t\t\tlogger.debug('No events to publish');\n\t\t\treturn;\n\t\t}\n\t\tif (!publisherService) {\n\t\t\tlogger.warn('No publisher service available');\n\t\t\treturn;\n\t\t}\n\n\t\tconst services = await serviceDiscovery.register([publisherService]);\n\n\t\tconst publisher = services[\n\t\t\tpublisherService.serviceName\n\t\t] as EventPublisher<any>;\n\n\t\tconst events: MappedEvent<T, OutSchema>[] = [];\n\n\t\tfor (const { when, payload, type, ...e } of ev) {\n\t\t\tlogger.debug({ event: type }, 'Processing event');\n\t\t\tconst resolvedPayload = await payload(response);\n\t\t\tconst event = {\n\t\t\t\t...e,\n\t\t\t\ttype,\n\t\t\t\tpayload: resolvedPayload,\n\t\t\t};\n\n\t\t\tif (!when || when(response as any)) {\n\t\t\t\tevents.push(event);\n\t\t\t}\n\t\t}\n\n\t\tif (events.length) {\n\t\t\tlogger.debug({ eventCount: ev.length }, 'Publishing events');\n\n\t\t\tawait publisher.publish(events).catch((err) => {\n\t\t\t\tlogger.error(err, 'Failed to publish events');\n\t\t\t});\n\t\t}\n\t} catch (error) {\n\t\tlogger.error(error as any, 'Something went wrong publishing events');\n\t}\n}\n\nexport async function publishConstructEvents<\n\tT extends EventPublisher<any> | undefined,\n\tOutSchema extends StandardSchemaV1 | undefined = undefined,\n\tTServiceName extends string = string,\n\tTServices extends Service[] = [],\n\tTAuditStorageServiceName extends string = string,\n\tTAuditStorage extends AuditStorage | undefined = undefined,\n>(\n\tconstruct: Construct<\n\t\tLogger,\n\t\tTServiceName,\n\t\tT,\n\t\tOutSchema,\n\t\tTServices,\n\t\tTAuditStorageServiceName,\n\t\tTAuditStorage\n\t>,\n\tresponse: InferStandardSchema<OutSchema>,\n\tserviceDiscovery: ServiceDiscovery<any>,\n\tlogger: Logger = construct.logger,\n) {\n\treturn publishEvents(\n\t\tlogger,\n\t\tserviceDiscovery,\n\t\tconstruct.events,\n\t\tresponse,\n\t\tconstruct.publisherService,\n\t);\n}\n"],"mappings":";AAQA,eAAsB,cAMrBA,QACAC,kBACAC,KAAkC,CAAE,GACpCC,UACAC,kBACC;AACD,KAAI;AACH,OAAK,IAAI,QAAQ;AAChB,UAAO,MAAM,uBAAuB;AACpC;EACA;AACD,OAAK,kBAAkB;AACtB,UAAO,KAAK,iCAAiC;AAC7C;EACA;EAED,MAAM,WAAW,MAAM,iBAAiB,SAAS,CAAC,gBAAiB,EAAC;EAEpE,MAAM,YAAY,SACjB,iBAAiB;EAGlB,MAAMC,SAAsC,CAAE;AAE9C,OAAK,MAAM,EAAE,MAAM,SAAS,KAAM,GAAG,GAAG,IAAI,IAAI;AAC/C,UAAO,MAAM,EAAE,OAAO,KAAM,GAAE,mBAAmB;GACjD,MAAM,kBAAkB,MAAM,QAAQ,SAAS;GAC/C,MAAM,QAAQ;IACb,GAAG;IACH;IACA,SAAS;GACT;AAED,QAAK,QAAQ,KAAK,SAAgB,CACjC,QAAO,KAAK,MAAM;EAEnB;AAED,MAAI,OAAO,QAAQ;AAClB,UAAO,MAAM,EAAE,YAAY,GAAG,OAAQ,GAAE,oBAAoB;AAE5D,SAAM,UAAU,QAAQ,OAAO,CAAC,MAAM,CAAC,QAAQ;AAC9C,WAAO,MAAM,KAAK,2BAA2B;GAC7C,EAAC;EACF;CACD,SAAQ,OAAO;AACf,SAAO,MAAM,OAAc,yCAAyC;CACpE;AACD;AAED,eAAsB,uBAQrBC,WASAH,UACAF,kBACAD,SAAiB,UAAU,QAC1B;AACD,QAAO,cACN,QACA,kBACA,UAAU,QACV,UACA,UAAU,iBACV;AACD"}
|
package/dist/queue/index.cjs
CHANGED
|
@@ -1,60 +1,8 @@
|
|
|
1
|
-
const require_Construct = require('../Construct-
|
|
2
|
-
const require_clone = require('../clone-
|
|
1
|
+
const require_Construct = require('../Construct-Cf_0pAvo.cjs');
|
|
2
|
+
const require_clone = require('../clone-BQnYiRgm.cjs');
|
|
3
|
+
const require_Queue = require('../Queue-HbdYCQ-X.cjs');
|
|
3
4
|
const __geekmidas_logger_console = require_Construct.__toESM(require("@geekmidas/logger/console"));
|
|
4
|
-
const __geekmidas_envkit = require_Construct.__toESM(require("@geekmidas/envkit"));
|
|
5
|
-
const __geekmidas_events = require_Construct.__toESM(require("@geekmidas/events"));
|
|
6
5
|
|
|
7
|
-
//#region src/queue/Queue.ts
|
|
8
|
-
const DEFAULT_LOGGER$1 = new __geekmidas_logger_console.ConsoleLogger();
|
|
9
|
-
/**
|
|
10
|
-
* A queue worker — a point-to-point SQS-style queue and its single consumer.
|
|
11
|
-
* Unlike a `Subscriber` (topic fan-out, filtered by `subscribedEvents`), a queue
|
|
12
|
-
* drains every message of its one `message` type. Build one with `q` (see
|
|
13
|
-
* `QueueBuilder`); `gkm build` discovers it into the manifest's `queues` field.
|
|
14
|
-
*
|
|
15
|
-
* The producer side is {@link Queue.publisher} — a ready-to-inject `Service`
|
|
16
|
-
* that any endpoint/function drops into `.services([...])` to send messages.
|
|
17
|
-
*/
|
|
18
|
-
var Queue = class extends require_Construct.Construct {
|
|
19
|
-
__IS_QUEUE__ = true;
|
|
20
|
-
static isQueue(obj) {
|
|
21
|
-
return Boolean(obj && obj.__IS_QUEUE__ === true && obj.type === require_Construct.ConstructType.Queue);
|
|
22
|
-
}
|
|
23
|
-
constructor(name, handler, messageSchema, timeout = 3e4, services = [], logger = DEFAULT_LOGGER$1, batchSize, fifo) {
|
|
24
|
-
super(require_Construct.ConstructType.Queue, logger, services, [], void 0, void 0, timeout);
|
|
25
|
-
this.name = name;
|
|
26
|
-
this.handler = handler;
|
|
27
|
-
this.messageSchema = messageSchema;
|
|
28
|
-
this.timeout = timeout;
|
|
29
|
-
this.services = services;
|
|
30
|
-
this.logger = logger;
|
|
31
|
-
this.batchSize = batchSize;
|
|
32
|
-
this.fifo = fifo;
|
|
33
|
-
}
|
|
34
|
-
/**
|
|
35
|
-
* The producer side — a `Service` exposing an `EventPublisher` typed to this
|
|
36
|
-
* queue's message. Inject it via `.services([queue.publisher])`; the handler
|
|
37
|
-
* then calls `services.<name>Publisher.publish([{ type, payload }])`.
|
|
38
|
-
*
|
|
39
|
-
* It reads `<NAME>_PUBLISHER_CONNECTION_STRING` and builds the transport from
|
|
40
|
-
* the URL protocol — `pgboss://` locally, `sqs://` deployed — so the same
|
|
41
|
-
* code publishes to Postgres in dev and SQS in prod. Because it's a `Service`,
|
|
42
|
-
* `Construct.getEnvironment()` sniffs it, so the env requirement flows into
|
|
43
|
-
* the manifest and infra links exactly this queue with least privilege.
|
|
44
|
-
*/
|
|
45
|
-
get publisher() {
|
|
46
|
-
const envVar = `${(0, __geekmidas_envkit.environmentCase)(this.name)}_PUBLISHER_CONNECTION_STRING`;
|
|
47
|
-
return {
|
|
48
|
-
serviceName: `${this.name}Publisher`,
|
|
49
|
-
async register({ envParser }) {
|
|
50
|
-
const { connectionString } = envParser.create((get) => ({ connectionString: get(envVar).string() })).parse();
|
|
51
|
-
return __geekmidas_events.Publisher.fromConnectionString(connectionString);
|
|
52
|
-
}
|
|
53
|
-
};
|
|
54
|
-
}
|
|
55
|
-
};
|
|
56
|
-
|
|
57
|
-
//#endregion
|
|
58
6
|
//#region src/queue/QueueBuilder.ts
|
|
59
7
|
/**
|
|
60
8
|
* Builds a {@link Queue} worker — `q.queue('orders').services([db]).message(schema).handle(fn)`.
|
|
@@ -98,7 +46,7 @@ var QueueBuilder = class {
|
|
|
98
46
|
handle(fn) {
|
|
99
47
|
if (!this._name) throw new Error("Queue requires a name — call .queue(name) before .handle().");
|
|
100
48
|
if (!this._messageSchema) throw new Error("Queue requires a message schema — call .message(schema) before .handle().");
|
|
101
|
-
const queue = new Queue(this._name, fn, this._messageSchema, this._timeout, this._services, this._logger, this._batchSize, this._fifo);
|
|
49
|
+
const queue = new require_Queue.Queue(this._name, fn, this._messageSchema, this._timeout, this._services, this._logger, this._batchSize, this._fifo);
|
|
102
50
|
return queue;
|
|
103
51
|
}
|
|
104
52
|
};
|
|
@@ -108,7 +56,8 @@ var QueueBuilder = class {
|
|
|
108
56
|
const q = new QueueBuilder();
|
|
109
57
|
|
|
110
58
|
//#endregion
|
|
111
|
-
exports.Queue = Queue;
|
|
59
|
+
exports.Queue = require_Queue.Queue;
|
|
112
60
|
exports.QueueBuilder = QueueBuilder;
|
|
61
|
+
exports.isQueueResult = require_Queue.isQueueResult;
|
|
113
62
|
exports.q = q;
|
|
114
63
|
//# sourceMappingURL=index.cjs.map
|