@geekmidas/constructs 9.1.0 → 9.2.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 +35 -0
- package/dist/{AWSScheduledFunction-BHHlWlfV.d.cts → AWSScheduledFunction-B0thZRJU.d.cts} +2 -2
- package/dist/{AWSScheduledFunction-BHHlWlfV.d.cts.map → AWSScheduledFunction-B0thZRJU.d.cts.map} +1 -1
- package/dist/{AWSScheduledFunction-C42adp8A.cjs → AWSScheduledFunction-CKhVurOa.cjs} +3 -3
- package/dist/{AWSScheduledFunction-C42adp8A.cjs.map → AWSScheduledFunction-CKhVurOa.cjs.map} +1 -1
- package/dist/{AWSScheduledFunction-KP6lqbsW.mjs → AWSScheduledFunction-CU7mMGFA.mjs} +2 -2
- package/dist/{AWSScheduledFunction-KP6lqbsW.mjs.map → AWSScheduledFunction-CU7mMGFA.mjs.map} +1 -1
- package/dist/{AWSScheduledFunction-BzGCUbkk.d.mts → AWSScheduledFunction-a6hRp3nk.d.mts} +2 -2
- package/dist/{AWSScheduledFunction-BzGCUbkk.d.mts.map → AWSScheduledFunction-a6hRp3nk.d.mts.map} +1 -1
- package/dist/{Construct-TGIM_E4o.cjs → Construct-D09WUUOf.cjs} +9 -1
- package/dist/Construct-D09WUUOf.cjs.map +1 -0
- package/dist/{Construct-BWF5HxaM.mjs → Construct-D0uZvbr3.mjs} +9 -1
- package/dist/Construct-D0uZvbr3.mjs.map +1 -0
- package/dist/{Construct-JlyQkBkv.d.cts → Construct-D_3yZ9m5.d.cts} +23 -3
- package/dist/Construct-D_3yZ9m5.d.cts.map +1 -0
- package/dist/{Construct-pxwC6fDD.d.mts → Construct-DsqpiAym.d.mts} +23 -3
- package/dist/Construct-DsqpiAym.d.mts.map +1 -0
- package/dist/{Endpoint-Cwjhc1Hl.d.cts → Endpoint-BmnuNbF1.d.cts} +2 -2
- package/dist/{Endpoint-Cwjhc1Hl.d.cts.map → Endpoint-BmnuNbF1.d.cts.map} +1 -1
- package/dist/{Endpoint-B0P_pEMr.d.mts → Endpoint-DEydLuBs.d.mts} +2 -2
- package/dist/{Endpoint-B0P_pEMr.d.mts.map → Endpoint-DEydLuBs.d.mts.map} +1 -1
- package/dist/{HonoEndpointAdaptor-BMVwx2cz.mjs → HonoEndpointAdaptor-Dd-S7gV_.mjs} +3 -3
- package/dist/{HonoEndpointAdaptor-BMVwx2cz.mjs.map → HonoEndpointAdaptor-Dd-S7gV_.mjs.map} +1 -1
- package/dist/{HonoEndpointAdaptor-DPDsDi-D.cjs → HonoEndpointAdaptor-INisd3XZ.cjs} +5 -5
- package/dist/{HonoEndpointAdaptor-DPDsDi-D.cjs.map → HonoEndpointAdaptor-INisd3XZ.cjs.map} +1 -1
- package/dist/{Queue-BL68oDJ-.d.mts → Queue-Brw--scg.d.cts} +3 -3
- package/dist/{Queue-BL68oDJ-.d.mts.map → Queue-Brw--scg.d.cts.map} +1 -1
- package/dist/{Queue-DxJ6btRE.d.cts → Queue-D5z1bwFu.d.mts} +3 -3
- package/dist/{Queue-DxJ6btRE.d.cts.map → Queue-D5z1bwFu.d.mts.map} +1 -1
- package/dist/{Subscriber-DF6xsBAJ.d.mts → Subscriber-CJ22tp8r.d.mts} +2 -2
- package/dist/{Subscriber-DF6xsBAJ.d.mts.map → Subscriber-CJ22tp8r.d.mts.map} +1 -1
- package/dist/{Subscriber-BpVhcGhX.d.cts → Subscriber-DvKSp0N4.d.cts} +2 -2
- package/dist/{Subscriber-BpVhcGhX.d.cts.map → Subscriber-DvKSp0N4.d.cts.map} +1 -1
- package/dist/{Topic-DJXoDeMP.d.cts → Topic-B-fxOsR2.d.mts} +3 -3
- package/dist/{Topic-DJXoDeMP.d.cts.map → Topic-B-fxOsR2.d.mts.map} +1 -1
- package/dist/{Topic-DxWQBgMN.d.mts → Topic-BMfrIFdX.d.cts} +3 -3
- package/dist/{Topic-DxWQBgMN.d.mts.map → Topic-BMfrIFdX.d.cts.map} +1 -1
- package/dist/adaptors/aws.cjs +5 -5
- package/dist/adaptors/aws.d.cts +6 -6
- package/dist/adaptors/aws.d.mts +6 -6
- package/dist/adaptors/aws.mjs +4 -4
- package/dist/adaptors/hono.cjs +5 -5
- package/dist/adaptors/hono.d.cts +3 -3
- package/dist/adaptors/hono.d.mts +3 -3
- package/dist/adaptors/hono.mjs +4 -4
- package/dist/adaptors/testing.cjs +5 -5
- package/dist/adaptors/testing.d.cts +5 -5
- package/dist/adaptors/testing.d.mts +5 -5
- package/dist/adaptors/testing.mjs +4 -4
- package/dist/crons/index.cjs +3 -3
- package/dist/crons/index.d.cts +7 -7
- package/dist/crons/index.d.mts +3 -3
- package/dist/crons/index.mjs +3 -3
- package/dist/endpoints/index.cjs +3 -3
- package/dist/endpoints/index.d.cts +5 -5
- package/dist/endpoints/index.d.mts +3 -3
- package/dist/endpoints/index.mjs +3 -3
- package/dist/functions/index.cjs +2 -2
- package/dist/functions/index.d.cts +2 -2
- package/dist/functions/index.d.mts +2 -2
- package/dist/functions/index.mjs +2 -2
- package/dist/{functions-SqtCDc9c.cjs → functions-B3OFv3QV.cjs} +2 -2
- package/dist/functions-B3OFv3QV.cjs.map +1 -0
- package/dist/{functions-EqTloHjo.mjs → functions-DhkDodl0.mjs} +2 -2
- package/dist/functions-DhkDodl0.mjs.map +1 -0
- package/dist/{index-C7iynzLI.d.mts → index-B8LNLQXD.d.mts} +2 -2
- package/dist/{index-C7iynzLI.d.mts.map → index-B8LNLQXD.d.mts.map} +1 -1
- package/dist/{index-DdgJRm4q.d.cts → index-HWHPZv8u.d.cts} +6 -6
- package/dist/{index-DdgJRm4q.d.cts.map → index-HWHPZv8u.d.cts.map} +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +2 -2
- package/dist/index.d.mts +2 -2
- package/dist/index.mjs +1 -1
- package/dist/{lazyAccessors-CCTK19xj.mjs → lazyAccessors-DzxZVtPR.mjs} +3 -3
- package/dist/{lazyAccessors-CCTK19xj.mjs.map → lazyAccessors-DzxZVtPR.mjs.map} +1 -1
- package/dist/{lazyAccessors-D04oftGw.cjs → lazyAccessors-iwvg1Pv4.cjs} +3 -3
- package/dist/{lazyAccessors-D04oftGw.cjs.map → lazyAccessors-iwvg1Pv4.cjs.map} +1 -1
- package/dist/monitors/index.cjs +9 -2
- package/dist/monitors/index.cjs.map +1 -1
- package/dist/monitors/index.d.cts +19 -6
- package/dist/monitors/index.d.cts.map +1 -1
- package/dist/monitors/index.d.mts +15 -6
- package/dist/monitors/index.d.mts.map +1 -1
- package/dist/monitors/index.mjs +9 -2
- package/dist/monitors/index.mjs.map +1 -1
- package/dist/{processAudits-BJZT5gmy.cjs → processAudits-94Ar_EJF.cjs} +2 -2
- package/dist/{processAudits-BJZT5gmy.cjs.map → processAudits-94Ar_EJF.cjs.map} +1 -1
- package/dist/queue/index.cjs +1 -1
- package/dist/queue/index.d.cts +4 -4
- package/dist/queue/index.d.mts +2 -2
- package/dist/queue/index.mjs +1 -1
- package/dist/subscribers/index.cjs +1 -1
- package/dist/subscribers/index.d.cts +5 -5
- package/dist/subscribers/index.d.mts +3 -3
- package/dist/subscribers/index.mjs +1 -1
- package/dist/topic/index.cjs +1 -1
- package/dist/topic/index.d.cts +2 -2
- package/dist/topic/index.d.mts +2 -2
- package/dist/topic/index.mjs +1 -1
- package/package.json +22 -22
- package/src/Construct.ts +12 -1
- package/src/__tests__/monitor.spec.ts +67 -7
- package/src/index.ts +1 -0
- package/src/monitor.ts +17 -1
- package/src/monitors/heartbeat.ts +16 -6
- package/dist/Construct-BWF5HxaM.mjs.map +0 -1
- package/dist/Construct-JlyQkBkv.d.cts.map +0 -1
- package/dist/Construct-TGIM_E4o.cjs.map +0 -1
- package/dist/Construct-pxwC6fDD.d.mts.map +0 -1
- package/dist/functions-EqTloHjo.mjs.map +0 -1
- package/dist/functions-SqtCDc9c.cjs.map +0 -1
|
@@ -1,11 +1,13 @@
|
|
|
1
|
-
import { ConstructMonitor, MonitorContext, MonitorService } from "../Construct-
|
|
1
|
+
import { ConstructMonitor, MonitorContext, MonitorInfo, MonitorService } from "../Construct-D_3yZ9m5.cjs";
|
|
2
2
|
import { Service } from "@geekmidas/services";
|
|
3
3
|
|
|
4
4
|
//#region src/monitors/heartbeat.d.ts
|
|
5
5
|
interface HeartbeatOptions {
|
|
6
6
|
/**
|
|
7
|
-
* The environment variable holding the heartbeat URL.
|
|
8
|
-
*
|
|
7
|
+
* The environment variable holding the heartbeat URL. Required: the manifest
|
|
8
|
+
* lists it so infrastructure sets it wherever the construct is deployed. If
|
|
9
|
+
* it is missing at runtime the monitor is skipped with a warning, and the
|
|
10
|
+
* run goes on.
|
|
9
11
|
* @default 'HEARTBEAT_URL'
|
|
10
12
|
*/
|
|
11
13
|
env?: string;
|
|
@@ -20,6 +22,11 @@ interface HeartbeatOptions {
|
|
|
20
22
|
failure?: (url: string) => string;
|
|
21
23
|
/** Milliseconds to wait for the provider. @default 3000 */
|
|
22
24
|
timeout?: number;
|
|
25
|
+
/**
|
|
26
|
+
* The service the URL belongs to, recorded in the manifest so infrastructure
|
|
27
|
+
* knows which kind of heartbeat to create. Set by the presets.
|
|
28
|
+
*/
|
|
29
|
+
provider?: string;
|
|
23
30
|
}
|
|
24
31
|
/**
|
|
25
32
|
* A monitor that pings a URL when a run succeeds, and optionally when it
|
|
@@ -34,10 +41,16 @@ interface HeartbeatOptions {
|
|
|
34
41
|
* .handle(async () => {});
|
|
35
42
|
* ```
|
|
36
43
|
*/
|
|
37
|
-
declare function heartbeat(options?: HeartbeatOptions): Service<`heartbeat:${string}`, ConstructMonitor
|
|
44
|
+
declare function heartbeat(options?: HeartbeatOptions): Service<`heartbeat:${string}`, ConstructMonitor> & {
|
|
45
|
+
monitor: MonitorInfo;
|
|
46
|
+
};
|
|
38
47
|
declare namespace heartbeat {
|
|
39
|
-
var betterStack: (env?: string) => Service<`heartbeat:${string}`, ConstructMonitor<unknown
|
|
40
|
-
|
|
48
|
+
var betterStack: (env?: string) => Service<`heartbeat:${string}`, ConstructMonitor<unknown>> & {
|
|
49
|
+
monitor: MonitorInfo;
|
|
50
|
+
};
|
|
51
|
+
var healthchecks: (env?: string) => Service<`heartbeat:${string}`, ConstructMonitor<unknown>> & {
|
|
52
|
+
monitor: MonitorInfo;
|
|
53
|
+
};
|
|
41
54
|
}
|
|
42
55
|
//# sourceMappingURL=heartbeat.d.ts.map
|
|
43
56
|
//#endregion
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/monitors/heartbeat.ts"],"sourcesContent":[],"mappings":";;;;UAGiB,gBAAA;;AAAjB;
|
|
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,OA0CY,CAAA,EAAA,CAAA,GAAA,EAAA,MAAA,EAAA,GAAA,MAAA;EAAA;;;;EAIC,OA5C2B,CAAA,EAAA,CAAA,GAAA,EAAA,MAAA,EAAA,GAAA,MAAA;EAAW;;;;;;;;;;;;;;;;;;;;;iBAF5D,SAAA,WACN,mBACP,+BAA+B;WAA+B;;kBAFjD,SAAA;qCA0CqB,+BAAA;aAxC4B;;sCA4C3B,+BAAA;aA5C2B"}
|
|
@@ -1,11 +1,13 @@
|
|
|
1
|
-
import { ConstructMonitor, MonitorContext, MonitorService } from "../Construct-
|
|
1
|
+
import { ConstructMonitor, MonitorContext, MonitorInfo, MonitorService } from "../Construct-DsqpiAym.mjs";
|
|
2
2
|
import { Service } from "@geekmidas/services";
|
|
3
3
|
|
|
4
4
|
//#region src/monitors/heartbeat.d.ts
|
|
5
5
|
interface HeartbeatOptions {
|
|
6
6
|
/**
|
|
7
|
-
* The environment variable holding the heartbeat URL.
|
|
8
|
-
*
|
|
7
|
+
* The environment variable holding the heartbeat URL. Required: the manifest
|
|
8
|
+
* lists it so infrastructure sets it wherever the construct is deployed. If
|
|
9
|
+
* it is missing at runtime the monitor is skipped with a warning, and the
|
|
10
|
+
* run goes on.
|
|
9
11
|
* @default 'HEARTBEAT_URL'
|
|
10
12
|
*/
|
|
11
13
|
env?: string;
|
|
@@ -20,6 +22,11 @@ interface HeartbeatOptions {
|
|
|
20
22
|
failure?: (url: string) => string;
|
|
21
23
|
/** Milliseconds to wait for the provider. @default 3000 */
|
|
22
24
|
timeout?: number;
|
|
25
|
+
/**
|
|
26
|
+
* The service the URL belongs to, recorded in the manifest so infrastructure
|
|
27
|
+
* knows which kind of heartbeat to create. Set by the presets.
|
|
28
|
+
*/
|
|
29
|
+
provider?: string;
|
|
23
30
|
}
|
|
24
31
|
/**
|
|
25
32
|
* A monitor that pings a URL when a run succeeds, and optionally when it
|
|
@@ -34,10 +41,12 @@ interface HeartbeatOptions {
|
|
|
34
41
|
* .handle(async () => {});
|
|
35
42
|
* ```
|
|
36
43
|
*/
|
|
37
|
-
declare function heartbeat(options?: HeartbeatOptions): Service<`heartbeat:${string}`, ConstructMonitor
|
|
44
|
+
declare function heartbeat(options?: HeartbeatOptions): Service<`heartbeat:${string}`, ConstructMonitor> & {
|
|
45
|
+
monitor: MonitorInfo;
|
|
46
|
+
};
|
|
38
47
|
declare namespace heartbeat {
|
|
39
|
-
var betterStack: (env?: string) =>
|
|
40
|
-
var healthchecks: (env?: string) =>
|
|
48
|
+
var betterStack: (env?: string) => any;
|
|
49
|
+
var healthchecks: (env?: string) => any;
|
|
41
50
|
}
|
|
42
51
|
//# sourceMappingURL=heartbeat.d.ts.map
|
|
43
52
|
//#endregion
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/monitors/heartbeat.ts"],"sourcesContent":[],"mappings":";;;;UAGiB,gBAAA;;AAAjB;
|
|
1
|
+
{"version":3,"file":"index.d.mts","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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAAT,SAAA,WACN,mBACP,+BAA+B;WAA+B;;kBAFjD,SAAA"}
|
package/dist/monitors/index.mjs
CHANGED
|
@@ -13,11 +13,16 @@
|
|
|
13
13
|
* ```
|
|
14
14
|
*/
|
|
15
15
|
function heartbeat(options = {}) {
|
|
16
|
-
const { env = "HEARTBEAT_URL", start, success = (url) => url, failure, timeout = 3e3 } = options;
|
|
16
|
+
const { env = "HEARTBEAT_URL", start, success = (url) => url, failure, timeout = 3e3, provider } = options;
|
|
17
17
|
return {
|
|
18
18
|
serviceName: `heartbeat:${env}`,
|
|
19
|
+
monitor: {
|
|
20
|
+
type: "heartbeat",
|
|
21
|
+
...provider ? { provider } : {},
|
|
22
|
+
env
|
|
23
|
+
},
|
|
19
24
|
async register({ envParser }) {
|
|
20
|
-
const { url } = envParser.create((get) => ({ url: get(env).string()
|
|
25
|
+
const { url } = envParser.create((get) => ({ url: get(env).string() })).parse();
|
|
21
26
|
const ping = async (target) => {
|
|
22
27
|
if (!url || !target) return;
|
|
23
28
|
const response = await fetch(target(url), { signal: AbortSignal.timeout(timeout) });
|
|
@@ -34,11 +39,13 @@ function heartbeat(options = {}) {
|
|
|
34
39
|
/** Better Stack heartbeats: `{url}` on success, `{url}/fail` on failure. */
|
|
35
40
|
heartbeat.betterStack = (env) => heartbeat({
|
|
36
41
|
env,
|
|
42
|
+
provider: "betterStack",
|
|
37
43
|
failure: (url) => `${url}/fail`
|
|
38
44
|
});
|
|
39
45
|
/** Healthchecks.io: `{url}/start`, `{url}` and `{url}/fail`. */
|
|
40
46
|
heartbeat.healthchecks = (env) => heartbeat({
|
|
41
47
|
env,
|
|
48
|
+
provider: "healthchecks",
|
|
42
49
|
start: (url) => `${url}/start`,
|
|
43
50
|
failure: (url) => `${url}/fail`
|
|
44
51
|
});
|
|
@@ -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 } from '../monitor';\n\nexport interface HeartbeatOptions {\n\t/**\n\t * The environment variable holding the heartbeat URL.
|
|
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('rate(1 day)')\n * .monitor(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 ${response.status}`);\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,OAAO,2BAA2B,SAAS,OAAO;GAE7D;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
|
-
const require_Construct = require('./Construct-
|
|
1
|
+
const require_Construct = require('./Construct-D09WUUOf.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-94Ar_EJF.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"processAudits-BJZT5gmy.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-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"}
|
package/dist/queue/index.cjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const require_Construct = require('../Construct-
|
|
1
|
+
const require_Construct = require('../Construct-D09WUUOf.cjs');
|
|
2
2
|
const require_clone = require('../clone-I_WIpiFf.cjs');
|
|
3
3
|
const __geekmidas_logger_console = require_Construct.__toESM(require("@geekmidas/logger/console"));
|
|
4
4
|
const __geekmidas_envkit = require_Construct.__toESM(require("@geekmidas/envkit"));
|
package/dist/queue/index.d.cts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import "../Construct-
|
|
2
|
-
import { Queue, QueueContext, QueueHandler, QueueMessage } from "../Queue-
|
|
3
|
-
import * as
|
|
1
|
+
import "../Construct-D_3yZ9m5.cjs";
|
|
2
|
+
import { Queue, QueueContext, QueueHandler, QueueMessage } from "../Queue-Brw--scg.cjs";
|
|
3
|
+
import * as _geekmidas_logger8 from "@geekmidas/logger";
|
|
4
4
|
import { Logger } from "@geekmidas/logger";
|
|
5
5
|
import { Service } from "@geekmidas/services";
|
|
6
6
|
import { StandardSchemaV1 } from "@standard-schema/spec";
|
|
@@ -37,7 +37,7 @@ declare class QueueBuilder<TName extends string = string, TMessage extends Stand
|
|
|
37
37
|
//# sourceMappingURL=QueueBuilder.d.ts.map
|
|
38
38
|
//#endregion
|
|
39
39
|
//#region src/queue/index.d.ts
|
|
40
|
-
declare const q: QueueBuilder<string, undefined, [],
|
|
40
|
+
declare const q: QueueBuilder<string, undefined, [], _geekmidas_logger8.Logger>;
|
|
41
41
|
//# sourceMappingURL=index.d.ts.map
|
|
42
42
|
|
|
43
43
|
//#endregion
|
package/dist/queue/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import "../Construct-
|
|
2
|
-
import { Queue, QueueContext, QueueHandler, QueueMessage } from "../Queue-
|
|
1
|
+
import "../Construct-DsqpiAym.mjs";
|
|
2
|
+
import { Queue, QueueContext, QueueHandler, QueueMessage } from "../Queue-D5z1bwFu.mjs";
|
|
3
3
|
import { Service } from "@geekmidas/services";
|
|
4
4
|
import { Logger as Logger$1 } from "@geekmidas/logger";
|
|
5
5
|
import { StandardSchemaV1 } from "@standard-schema/spec";
|
package/dist/queue/index.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Construct, ConstructType } from "../Construct-
|
|
1
|
+
import { Construct, ConstructType } from "../Construct-D0uZvbr3.mjs";
|
|
2
2
|
import { cloneWith } from "../clone-pdXxc0t3.mjs";
|
|
3
3
|
import { ConsoleLogger, DEFAULT_LOGGER } from "@geekmidas/logger/console";
|
|
4
4
|
import { environmentCase } from "@geekmidas/envkit";
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const require_Construct = require('../Construct-
|
|
1
|
+
const require_Construct = require('../Construct-D09WUUOf.cjs');
|
|
2
2
|
const require_clone = require('../clone-I_WIpiFf.cjs');
|
|
3
3
|
const __geekmidas_logger_console = require_Construct.__toESM(require("@geekmidas/logger/console"));
|
|
4
4
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import "../Construct-
|
|
2
|
-
import { Subscriber, SubscriberHandler } from "../Subscriber-
|
|
3
|
-
import { Topic, TopicEvents, TopicMessage } from "../Topic-
|
|
1
|
+
import "../Construct-D_3yZ9m5.cjs";
|
|
2
|
+
import { Subscriber, SubscriberHandler } from "../Subscriber-DvKSp0N4.cjs";
|
|
3
|
+
import { Topic, TopicEvents, TopicMessage } from "../Topic-BMfrIFdX.cjs";
|
|
4
4
|
import { EventPublisher, ExtractPublisherMessage } from "@geekmidas/events";
|
|
5
|
-
import * as
|
|
5
|
+
import * as _geekmidas_logger9 from "@geekmidas/logger";
|
|
6
6
|
import { Logger } from "@geekmidas/logger";
|
|
7
7
|
import { Service } from "@geekmidas/services";
|
|
8
8
|
import { StandardSchemaV1 } from "@standard-schema/spec";
|
|
@@ -40,7 +40,7 @@ declare class SubscriberBuilder<TServices extends Service[] = [], TLogger extend
|
|
|
40
40
|
//# sourceMappingURL=SubscriberBuilder.d.ts.map
|
|
41
41
|
//#endregion
|
|
42
42
|
//#region src/subscribers/index.d.ts
|
|
43
|
-
declare const s: SubscriberBuilder<[],
|
|
43
|
+
declare const s: SubscriberBuilder<[], _geekmidas_logger9.Logger, undefined, undefined, string, []>;
|
|
44
44
|
//# sourceMappingURL=index.d.ts.map
|
|
45
45
|
|
|
46
46
|
//#endregion
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import "../Construct-
|
|
2
|
-
import { Subscriber, SubscriberHandler } from "../Subscriber-
|
|
3
|
-
import { Topic, TopicEvents, TopicMessage } from "../Topic-
|
|
1
|
+
import "../Construct-DsqpiAym.mjs";
|
|
2
|
+
import { Subscriber, SubscriberHandler } from "../Subscriber-CJ22tp8r.mjs";
|
|
3
|
+
import { Topic, TopicEvents, TopicMessage } from "../Topic-B-fxOsR2.mjs";
|
|
4
4
|
import { Service } from "@geekmidas/services";
|
|
5
5
|
import { EventPublisher, ExtractPublisherMessage } from "@geekmidas/events";
|
|
6
6
|
import { Logger as Logger$1 } from "@geekmidas/logger";
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Construct, ConstructType } from "../Construct-
|
|
1
|
+
import { Construct, ConstructType } from "../Construct-D0uZvbr3.mjs";
|
|
2
2
|
import { cloneWith } from "../clone-pdXxc0t3.mjs";
|
|
3
3
|
import { ConsoleLogger, DEFAULT_LOGGER } from "@geekmidas/logger/console";
|
|
4
4
|
|
package/dist/topic/index.cjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const require_Construct = require('../Construct-
|
|
1
|
+
const require_Construct = require('../Construct-D09WUUOf.cjs');
|
|
2
2
|
const require_clone = require('../clone-I_WIpiFf.cjs');
|
|
3
3
|
const __geekmidas_logger_console = require_Construct.__toESM(require("@geekmidas/logger/console"));
|
|
4
4
|
const __geekmidas_envkit = require_Construct.__toESM(require("@geekmidas/envkit"));
|
package/dist/topic/index.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import "../Construct-
|
|
2
|
-
import { Topic, TopicEvents, TopicMessage } from "../Topic-
|
|
1
|
+
import "../Construct-D_3yZ9m5.cjs";
|
|
2
|
+
import { Topic, TopicEvents, TopicMessage } from "../Topic-BMfrIFdX.cjs";
|
|
3
3
|
import { Logger } from "@geekmidas/logger";
|
|
4
4
|
|
|
5
5
|
//#region src/topic/TopicBuilder.d.ts
|
package/dist/topic/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import "../Construct-
|
|
2
|
-
import { Topic, TopicEvents, TopicMessage } from "../Topic-
|
|
1
|
+
import "../Construct-DsqpiAym.mjs";
|
|
2
|
+
import { Topic, TopicEvents, TopicMessage } from "../Topic-B-fxOsR2.mjs";
|
|
3
3
|
import { Logger } from "@geekmidas/logger";
|
|
4
4
|
|
|
5
5
|
//#region src/topic/TopicBuilder.d.ts
|
package/dist/topic/index.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Construct, ConstructType } from "../Construct-
|
|
1
|
+
import { Construct, ConstructType } from "../Construct-D0uZvbr3.mjs";
|
|
2
2
|
import { cloneWith } from "../clone-pdXxc0t3.mjs";
|
|
3
3
|
import { ConsoleLogger, DEFAULT_LOGGER } from "@geekmidas/logger/console";
|
|
4
4
|
import { environmentCase } from "@geekmidas/envkit";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@geekmidas/constructs",
|
|
3
|
-
"version": "9.
|
|
3
|
+
"version": "9.2.0",
|
|
4
4
|
"private": false,
|
|
5
5
|
"type": "module",
|
|
6
6
|
"exports": {
|
|
@@ -156,33 +156,33 @@
|
|
|
156
156
|
"pg": "~8.16.3",
|
|
157
157
|
"msw": "~2.10.3",
|
|
158
158
|
"zod": "~4.1.13",
|
|
159
|
-
"@geekmidas/
|
|
160
|
-
"@geekmidas/
|
|
161
|
-
"@geekmidas/db": "^9.
|
|
162
|
-
"@geekmidas/envkit": "^9.
|
|
163
|
-
"@geekmidas/errors": "^9.
|
|
164
|
-
"@geekmidas/events": "^9.
|
|
165
|
-
"@geekmidas/rate-limit": "^9.
|
|
166
|
-
"@geekmidas/schema": "^9.
|
|
167
|
-
"@geekmidas/
|
|
168
|
-
"@geekmidas/
|
|
169
|
-
"@geekmidas/
|
|
159
|
+
"@geekmidas/audit": "^9.2.0",
|
|
160
|
+
"@geekmidas/cache": "^9.2.0",
|
|
161
|
+
"@geekmidas/db": "^9.2.0",
|
|
162
|
+
"@geekmidas/envkit": "^9.2.0",
|
|
163
|
+
"@geekmidas/errors": "^9.2.0",
|
|
164
|
+
"@geekmidas/events": "^9.2.0",
|
|
165
|
+
"@geekmidas/rate-limit": "^9.2.0",
|
|
166
|
+
"@geekmidas/schema": "^9.2.0",
|
|
167
|
+
"@geekmidas/services": "^9.2.0",
|
|
168
|
+
"@geekmidas/testkit": "^9.2.0",
|
|
169
|
+
"@geekmidas/logger": "^9.2.0"
|
|
170
170
|
},
|
|
171
171
|
"peerDependencies": {
|
|
172
172
|
"@middy/core": ">=6.3.1",
|
|
173
173
|
"@types/aws-lambda": ">=8.10.92",
|
|
174
174
|
"hono": ">=4.8.2",
|
|
175
175
|
"msw": ">=2.0.0",
|
|
176
|
-
"@geekmidas/audit": "^9.
|
|
177
|
-
"@geekmidas/cache": "^9.
|
|
178
|
-
"@geekmidas/db": "^9.
|
|
179
|
-
"@geekmidas/envkit": "^9.
|
|
180
|
-
"@geekmidas/errors": "^9.
|
|
181
|
-
"@geekmidas/events": "^9.
|
|
182
|
-
"@geekmidas/logger": "^9.
|
|
183
|
-
"@geekmidas/rate-limit": "^9.
|
|
184
|
-
"@geekmidas/schema": "^9.
|
|
185
|
-
"@geekmidas/services": "^9.
|
|
176
|
+
"@geekmidas/audit": "^9.2.0",
|
|
177
|
+
"@geekmidas/cache": "^9.2.0",
|
|
178
|
+
"@geekmidas/db": "^9.2.0",
|
|
179
|
+
"@geekmidas/envkit": "^9.2.0",
|
|
180
|
+
"@geekmidas/errors": "^9.2.0",
|
|
181
|
+
"@geekmidas/events": "^9.2.0",
|
|
182
|
+
"@geekmidas/logger": "^9.2.0",
|
|
183
|
+
"@geekmidas/rate-limit": "^9.2.0",
|
|
184
|
+
"@geekmidas/schema": "^9.2.0",
|
|
185
|
+
"@geekmidas/services": "^9.2.0"
|
|
186
186
|
},
|
|
187
187
|
"peerDependenciesMeta": {
|
|
188
188
|
"@geekmidas/audit": {
|
package/src/Construct.ts
CHANGED
|
@@ -9,7 +9,7 @@ import type { Logger } from '@geekmidas/logger';
|
|
|
9
9
|
import type { Service, ServiceContext } from '@geekmidas/services';
|
|
10
10
|
import type { StandardSchemaV1 } from '@standard-schema/spec';
|
|
11
11
|
import compact from 'lodash.compact';
|
|
12
|
-
import type { MonitorService } from './monitor';
|
|
12
|
+
import type { MonitorInfo, MonitorService } from './monitor';
|
|
13
13
|
|
|
14
14
|
// Cache for service environment variables to handle singleton services
|
|
15
15
|
// Stores both the full list and the optional subset so the same sniff result
|
|
@@ -80,6 +80,17 @@ export abstract class Construct<
|
|
|
80
80
|
>,
|
|
81
81
|
) {}
|
|
82
82
|
|
|
83
|
+
/**
|
|
84
|
+
* This construct's monitors as the build manifest records them, or nothing
|
|
85
|
+
* when it has none.
|
|
86
|
+
*/
|
|
87
|
+
getMonitoring(): MonitorInfo[] | undefined {
|
|
88
|
+
if (!this.monitors.length) return undefined;
|
|
89
|
+
return this.monitors.map(
|
|
90
|
+
(monitor) => monitor.monitor ?? { type: monitor.serviceName },
|
|
91
|
+
);
|
|
92
|
+
}
|
|
93
|
+
|
|
83
94
|
/**
|
|
84
95
|
* Returns an array of environment variable names required by this construct's services.
|
|
85
96
|
* This is determined by running a "sniffer" EnvironmentParser through each service's
|
|
@@ -145,18 +145,20 @@ describe('heartbeat', () => {
|
|
|
145
145
|
expect(pings).toEqual(['/abc/start', '/abc']);
|
|
146
146
|
});
|
|
147
147
|
|
|
148
|
-
it('
|
|
148
|
+
it('skips the heartbeat but still runs when its env var is missing', async () => {
|
|
149
149
|
const cron = new CronBuilder()
|
|
150
150
|
.input(z.object({}))
|
|
151
151
|
.schedule('rate(1 day)')
|
|
152
152
|
.monitor(heartbeat.betterStack())
|
|
153
|
-
.
|
|
153
|
+
.output(z.object({ ok: z.boolean() }))
|
|
154
|
+
.handle(async () => ({ ok: true }));
|
|
154
155
|
|
|
155
|
-
await new TestFunctionAdaptor(cron, discovery()).invoke({
|
|
156
|
+
const output = await new TestFunctionAdaptor(cron, discovery()).invoke({
|
|
156
157
|
input: {},
|
|
157
158
|
services: {},
|
|
158
159
|
});
|
|
159
160
|
|
|
161
|
+
expect(output).toEqual({ ok: true });
|
|
160
162
|
expect(pings).toEqual([]);
|
|
161
163
|
});
|
|
162
164
|
|
|
@@ -196,16 +198,17 @@ describe('heartbeat', () => {
|
|
|
196
198
|
expect(output).toEqual({ ok: true });
|
|
197
199
|
});
|
|
198
200
|
|
|
199
|
-
it('declares its env var as
|
|
201
|
+
it('declares its env var as required', async () => {
|
|
200
202
|
const cron = new CronBuilder()
|
|
201
203
|
.input(z.object({}))
|
|
202
204
|
.schedule('rate(1 day)')
|
|
203
205
|
.monitor(heartbeat.betterStack('NIGHTLY_HEARTBEAT_URL'))
|
|
204
206
|
.handle(async () => ({}));
|
|
205
207
|
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
);
|
|
208
|
+
const environment = await cron.getEnvironment({ markOptional: true });
|
|
209
|
+
|
|
210
|
+
expect(environment).toContain('NIGHTLY_HEARTBEAT_URL');
|
|
211
|
+
expect(environment).not.toContain('NIGHTLY_HEARTBEAT_URL?');
|
|
209
212
|
});
|
|
210
213
|
});
|
|
211
214
|
|
|
@@ -634,3 +637,60 @@ describe('heartbeat requests, per construct', () => {
|
|
|
634
637
|
});
|
|
635
638
|
});
|
|
636
639
|
});
|
|
640
|
+
|
|
641
|
+
describe('getMonitoring', () => {
|
|
642
|
+
it('records each monitor for the manifest', () => {
|
|
643
|
+
const cron = new CronBuilder()
|
|
644
|
+
.schedule('rate(1 day)')
|
|
645
|
+
.monitor(heartbeat.betterStack('MONITORING_URL'))
|
|
646
|
+
.monitor(heartbeat.healthchecks('HEALTHCHECKS_URL'))
|
|
647
|
+
.handle(async () => ({}));
|
|
648
|
+
|
|
649
|
+
expect(cron.getMonitoring()).toEqual([
|
|
650
|
+
{ type: 'heartbeat', provider: 'betterStack', env: 'MONITORING_URL' },
|
|
651
|
+
{ type: 'heartbeat', provider: 'healthchecks', env: 'HEALTHCHECKS_URL' },
|
|
652
|
+
]);
|
|
653
|
+
});
|
|
654
|
+
|
|
655
|
+
it('records a custom heartbeat without a provider, on its default env var', () => {
|
|
656
|
+
const fn = new FunctionBuilder()
|
|
657
|
+
.monitor(heartbeat())
|
|
658
|
+
.handle(async () => ({}));
|
|
659
|
+
|
|
660
|
+
expect(fn.getMonitoring()).toEqual([
|
|
661
|
+
{ type: 'heartbeat', env: 'HEARTBEAT_URL' },
|
|
662
|
+
]);
|
|
663
|
+
});
|
|
664
|
+
|
|
665
|
+
it('records a hand-written monitor by its service name', () => {
|
|
666
|
+
const fn = new FunctionBuilder()
|
|
667
|
+
.monitor({
|
|
668
|
+
serviceName: 'errors',
|
|
669
|
+
async register() {
|
|
670
|
+
return { async success() {}, async failure() {} };
|
|
671
|
+
},
|
|
672
|
+
})
|
|
673
|
+
.handle(async () => ({}));
|
|
674
|
+
|
|
675
|
+
expect(fn.getMonitoring()).toEqual([{ type: 'errors' }]);
|
|
676
|
+
});
|
|
677
|
+
|
|
678
|
+
it('records an endpoint’s monitors inherited from its factory', () => {
|
|
679
|
+
const endpoint = new EndpointFactory()
|
|
680
|
+
.monitor(heartbeat.betterStack())
|
|
681
|
+
.get('/health')
|
|
682
|
+
.handle(async () => ({}));
|
|
683
|
+
|
|
684
|
+
expect(endpoint.getMonitoring()).toEqual([
|
|
685
|
+
{ type: 'heartbeat', provider: 'betterStack', env: 'HEARTBEAT_URL' },
|
|
686
|
+
]);
|
|
687
|
+
});
|
|
688
|
+
|
|
689
|
+
it('records nothing for a construct without monitors', () => {
|
|
690
|
+
const cron = new CronBuilder()
|
|
691
|
+
.schedule('rate(1 day)')
|
|
692
|
+
.handle(async () => ({}));
|
|
693
|
+
|
|
694
|
+
expect(cron.getMonitoring()).toBeUndefined();
|
|
695
|
+
});
|
|
696
|
+
});
|
package/src/index.ts
CHANGED
package/src/monitor.ts
CHANGED
|
@@ -30,7 +30,23 @@ export interface ConstructMonitor<TRun = unknown> {
|
|
|
30
30
|
): Promise<void>;
|
|
31
31
|
}
|
|
32
32
|
|
|
33
|
-
|
|
33
|
+
/**
|
|
34
|
+
* A monitor as the build manifest records it, so infrastructure can provision
|
|
35
|
+
* what it reports to: a heartbeat's URL, set in the variable it reads.
|
|
36
|
+
*/
|
|
37
|
+
export interface MonitorInfo {
|
|
38
|
+
/** The kind of monitor, e.g. `heartbeat`. */
|
|
39
|
+
type: string;
|
|
40
|
+
/** The service it reports to, e.g. `betterStack`. Absent for a custom one. */
|
|
41
|
+
provider?: string;
|
|
42
|
+
/** The environment variable it reads its target from. */
|
|
43
|
+
env?: string;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
export type MonitorService = Service<string, ConstructMonitor<any>> & {
|
|
47
|
+
/** How the manifest records this monitor. Defaults to its service name. */
|
|
48
|
+
monitor?: MonitorInfo;
|
|
49
|
+
};
|
|
34
50
|
|
|
35
51
|
/** A run in progress, closed by exactly one of its two methods. */
|
|
36
52
|
export interface MonitoredRun {
|