@geekmidas/services 1.0.3 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +19 -0
- package/README.md +24 -0
- package/dist/{ServiceDiscovery-ykolgkIj.d.mts → ServiceDiscovery-BO8W-RY8.d.cts} +2 -2
- package/dist/{ServiceDiscovery-ykolgkIj.d.mts.map → ServiceDiscovery-BO8W-RY8.d.cts.map} +1 -1
- package/dist/{ServiceDiscovery-Dvqa-Q1_.d.cts → ServiceDiscovery-CRq_bGbi.d.mts} +2 -2
- package/dist/{ServiceDiscovery-Dvqa-Q1_.d.cts.map → ServiceDiscovery-CRq_bGbi.d.mts.map} +1 -1
- package/dist/{ServiceDiscovery-tZ6VKHIZ.mjs → ServiceDiscovery-DO_uDfuG.mjs} +2 -2
- package/dist/{ServiceDiscovery-tZ6VKHIZ.mjs.map → ServiceDiscovery-DO_uDfuG.mjs.map} +1 -1
- package/dist/{ServiceDiscovery-C5x1wcN1.cjs → ServiceDiscovery-m3XkNh32.cjs} +2 -2
- package/dist/{ServiceDiscovery-C5x1wcN1.cjs.map → ServiceDiscovery-m3XkNh32.cjs.map} +1 -1
- package/dist/{context-BpYagzpr.mjs → context-C9DCrFWA.mjs} +64 -4
- package/dist/context-C9DCrFWA.mjs.map +1 -0
- package/dist/{context-CaeISj3o.d.cts → context-CU-87vsM.d.mts} +2 -2
- package/dist/context-CU-87vsM.d.mts.map +1 -0
- package/dist/{context-CoyHq8lH.cjs → context-Cf2Ig5qr.cjs} +70 -4
- package/dist/context-Cf2Ig5qr.cjs.map +1 -0
- package/dist/{context-HGC2PJzv.d.mts → context-D2owD3ac.d.cts} +2 -2
- package/dist/context-D2owD3ac.d.cts.map +1 -0
- package/dist/context.cjs +1 -1
- package/dist/context.d.cts +2 -2
- package/dist/context.d.mts +2 -2
- package/dist/context.mjs +1 -1
- package/dist/index.cjs +2 -2
- package/dist/index.d.cts +3 -3
- package/dist/index.d.mts +3 -3
- package/dist/index.mjs +2 -2
- package/dist/middy.cjs +120 -0
- package/dist/middy.cjs.map +1 -0
- package/dist/middy.d.cts +146 -0
- package/dist/middy.d.cts.map +1 -0
- package/dist/middy.d.mts +146 -0
- package/dist/middy.d.mts.map +1 -0
- package/dist/middy.mjs +118 -0
- package/dist/middy.mjs.map +1 -0
- package/dist/trpc.cjs +66 -0
- package/dist/trpc.cjs.map +1 -0
- package/dist/trpc.d.cts +86 -0
- package/dist/trpc.d.cts.map +1 -0
- package/dist/trpc.d.mts +86 -0
- package/dist/trpc.d.mts.map +1 -0
- package/dist/trpc.mjs +65 -0
- package/dist/trpc.mjs.map +1 -0
- package/dist/{types-CcHmCx_U.d.mts → types-Bgk-0NOO.d.cts} +9 -2
- package/dist/types-Bgk-0NOO.d.cts.map +1 -0
- package/dist/{types-D7d_yeU5.d.cts → types-BoyOCa57.d.mts} +9 -2
- package/dist/types-BoyOCa57.d.mts.map +1 -0
- package/docs/request-scoped-logging.md +167 -0
- package/package.json +37 -1
- package/src/__tests__/context.spec.ts +180 -4
- package/src/__tests__/middy.spec.ts +218 -0
- package/src/__tests__/trpc.spec.ts +218 -0
- package/src/context.ts +104 -8
- package/src/middy.ts +226 -0
- package/src/trpc.ts +190 -0
- package/src/types.ts +7 -0
- package/tsdown.config.ts +11 -1
- package/dist/ServiceDiscovery.cjs +0 -4
- package/dist/ServiceDiscovery.d.cts +0 -3
- package/dist/ServiceDiscovery.d.mts +0 -3
- package/dist/ServiceDiscovery.mjs +0 -4
- package/dist/context-BpYagzpr.mjs.map +0 -1
- package/dist/context-CaeISj3o.d.cts.map +0 -1
- package/dist/context-CoyHq8lH.cjs.map +0 -1
- package/dist/context-HGC2PJzv.d.mts.map +0 -1
- package/dist/types-CcHmCx_U.d.mts.map +0 -1
- package/dist/types-D7d_yeU5.d.cts.map +0 -1
- package/dist/types.cjs +0 -0
- package/dist/types.d.cts +0 -2
- package/dist/types.d.mts +0 -2
- package/dist/types.mjs +0 -0
package/dist/middy.cjs
ADDED
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
const require_context = require('./context-Cf2Ig5qr.cjs');
|
|
2
|
+
const require_ServiceDiscovery = require('./ServiceDiscovery-m3XkNh32.cjs');
|
|
3
|
+
|
|
4
|
+
//#region src/middy.ts
|
|
5
|
+
function deriveRequestId(options, event, context) {
|
|
6
|
+
return options.getRequestId?.(event, context) ?? context.awsRequestId;
|
|
7
|
+
}
|
|
8
|
+
function buildLogger(baseLogger, options, requestId, event, context) {
|
|
9
|
+
return baseLogger.child({
|
|
10
|
+
requestId,
|
|
11
|
+
...options.bindings?.(event, context) ?? {}
|
|
12
|
+
});
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Middy middleware that establishes a request context for the handler so any
|
|
16
|
+
* code it reaches — including `@geekmidas/services` service methods — can call
|
|
17
|
+
* `serviceContext.getLogger()` / `getRequestId()` / `getRequestStartTime()`.
|
|
18
|
+
*
|
|
19
|
+
* Use this on standalone functions that need request-scoped logging. To also
|
|
20
|
+
* resolve services, pair it with {@link addServices}, or use
|
|
21
|
+
* {@link withServices} which bundles both.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* import middy from '@middy/core';
|
|
26
|
+
* import { serviceContext } from '@geekmidas/services';
|
|
27
|
+
* import { requestContext } from '@geekmidas/services/middy';
|
|
28
|
+
*
|
|
29
|
+
* export const handler = middy(async () => {
|
|
30
|
+
* serviceContext.getLogger().info('tick');
|
|
31
|
+
* }).use(requestContext({ logger }));
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
function requestContext(options) {
|
|
35
|
+
const baseLogger = options.logger;
|
|
36
|
+
return {
|
|
37
|
+
before: (request) => {
|
|
38
|
+
const { event, context } = request;
|
|
39
|
+
const requestId = deriveRequestId(options, event, context);
|
|
40
|
+
const logger = buildLogger(baseLogger, options, requestId, event, context);
|
|
41
|
+
require_context.enterRequestContext({
|
|
42
|
+
logger,
|
|
43
|
+
requestId,
|
|
44
|
+
startTime: Date.now()
|
|
45
|
+
});
|
|
46
|
+
},
|
|
47
|
+
after: () => {
|
|
48
|
+
require_context.exitRequestContext();
|
|
49
|
+
},
|
|
50
|
+
onError: () => {
|
|
51
|
+
require_context.exitRequestContext();
|
|
52
|
+
}
|
|
53
|
+
};
|
|
54
|
+
}
|
|
55
|
+
function resolveDiscovery(options) {
|
|
56
|
+
return options.serviceDiscovery ?? require_ServiceDiscovery.ServiceDiscovery.getInstance(options.envParser);
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Middy middleware that resolves an array of {@link Service}s via
|
|
60
|
+
* {@link ServiceDiscovery} and attaches the resolved record to `event.services`
|
|
61
|
+
* (keyed by each service's `serviceName`), matching how the `Function`/`Cron`
|
|
62
|
+
* constructs expose services on the event.
|
|
63
|
+
*
|
|
64
|
+
* This middleware only resolves services; it does **not** establish a request
|
|
65
|
+
* context. If your services read `serviceContext` (e.g. `getLogger()`), pair it
|
|
66
|
+
* with {@link requestContext}, or use {@link withServices} which bundles both.
|
|
67
|
+
*
|
|
68
|
+
* Chainable — `.use(addServices([a])).use(addServices([b]))` accumulates onto
|
|
69
|
+
* `event.services`.
|
|
70
|
+
*
|
|
71
|
+
* @example
|
|
72
|
+
* ```ts
|
|
73
|
+
* import middy from '@middy/core';
|
|
74
|
+
* import { addServices, requestContext } from '@geekmidas/services/middy';
|
|
75
|
+
*
|
|
76
|
+
* export const handler = middy(async (event) => {
|
|
77
|
+
* await event.services.database.users.deletePast();
|
|
78
|
+
* event.services.cache.clear();
|
|
79
|
+
* })
|
|
80
|
+
* .use(requestContext())
|
|
81
|
+
* .use(addServices([databaseService, cacheService], { envParser }));
|
|
82
|
+
* ```
|
|
83
|
+
*/
|
|
84
|
+
function addServices(services, options) {
|
|
85
|
+
const discovery = resolveDiscovery(options);
|
|
86
|
+
return { before: async (request) => {
|
|
87
|
+
const resolved = await discovery.register(services);
|
|
88
|
+
const event = request.event;
|
|
89
|
+
event.services = {
|
|
90
|
+
...event.services ?? {},
|
|
91
|
+
...resolved
|
|
92
|
+
};
|
|
93
|
+
} };
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* Batteries-included Middy setup for service-backed handlers: returns a pair of
|
|
97
|
+
* middlewares — {@link requestContext} followed by {@link addServices} — so a
|
|
98
|
+
* single `.use(withServices([...]))` gives the handler both a request context
|
|
99
|
+
* and the resolved services on `event.services`.
|
|
100
|
+
*
|
|
101
|
+
* @example
|
|
102
|
+
* ```ts
|
|
103
|
+
* import middy from '@middy/core';
|
|
104
|
+
* import { withServices } from '@geekmidas/services/middy';
|
|
105
|
+
*
|
|
106
|
+
* export const handler = middy(async (event) => {
|
|
107
|
+
* await event.services.database.users.deletePast();
|
|
108
|
+
* event.services.cache.clear();
|
|
109
|
+
* }).use(withServices([databaseService, cacheService], { envParser }));
|
|
110
|
+
* ```
|
|
111
|
+
*/
|
|
112
|
+
function withServices(services, options) {
|
|
113
|
+
return [requestContext(options), addServices(services, options)];
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
//#endregion
|
|
117
|
+
exports.addServices = addServices;
|
|
118
|
+
exports.requestContext = requestContext;
|
|
119
|
+
exports.withServices = withServices;
|
|
120
|
+
//# sourceMappingURL=middy.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"middy.cjs","names":["options: RequestContextOptions","event: unknown","context: Context","baseLogger: Logger","requestId: string","options: RequestContextOptions<TLogger>","options: ServiceResolverOptions","services: [...T]","options: ServiceMiddlewareOptions<TLogger>"],"sources":["../src/middy.ts"],"sourcesContent":["import type { EnvironmentParser } from '@geekmidas/envkit';\nimport type { Logger } from '@geekmidas/logger';\nimport type { MiddlewareObj } from '@middy/core';\nimport type { Context } from 'aws-lambda';\nimport { enterRequestContext, exitRequestContext } from './context';\nimport { ServiceDiscovery, type ServiceRecord } from './ServiceDiscovery';\nimport type { Service } from './types';\n\n/**\n * Middy middleware helpers that bring `@geekmidas/services` request context and\n * service discovery to **standalone** Middy Lambda handlers — i.e. functions\n * that aren't built with the `@geekmidas/constructs` Function/Cron constructs\n * but still want `serviceContext.getLogger()` and resolved services.\n *\n * Why middleware (and not `runWithRequestContext`)? Middy runs `before → handler\n * → after` as sequential awaits in a single async context, so establishing the\n * context with `AsyncLocalStorage.enterWith` (via `enterRequestContext`) in a\n * `before` hook propagates to the handler. `after`/`onError` reset it.\n *\n * Teardown is best-effort: like `enterRequestContext`, the reset is observable\n * to code the handler reaches but not necessarily to the frame that invoked the\n * Middy handler. This is fine for Lambda, where each invocation runs in its own\n * fresh async context — `requestContext` always establishes a brand-new context\n * per invocation, so requests never inherit a previous invocation's logger.\n *\n * @module\n */\n\n/**\n * Options for {@link requestContext}. Generic over the logger type so a custom\n * logger that extends {@link Logger} is preserved rather than widened.\n */\nexport interface RequestContextOptions<TLogger extends Logger = Logger> {\n\t/**\n\t * Logger to derive the per-request child logger from. Required — the caller\n\t * decides which logger to use (there is no implicit default).\n\t */\n\tlogger: TLogger;\n\t/**\n\t * Derive the request id from the event/context.\n\t * Defaults to `context.awsRequestId` (always present in a Lambda invocation).\n\t */\n\tgetRequestId?: (event: unknown, context: Context) => string;\n\t/**\n\t * Extra bindings to attach to the per-request child logger.\n\t */\n\tbindings?: (event: unknown, context: Context) => Record<string, unknown>;\n}\n\n/**\n * Options for {@link addServices} — how services are resolved. No logger is\n * needed because resolving services doesn't establish a request context.\n */\nexport interface ServiceResolverOptions {\n\t/**\n\t * Environment parser used to build the {@link ServiceDiscovery}. Required —\n\t * the caller supplies the parser (there is no implicit `process.env` default).\n\t */\n\tenvParser: EnvironmentParser<{}>;\n\t/**\n\t * Explicit {@link ServiceDiscovery} to resolve services from. Takes\n\t * precedence over `envParser`.\n\t */\n\tserviceDiscovery?: ServiceDiscovery;\n}\n\n/**\n * Options for {@link withServices}: request context (logger) + service resolution.\n */\nexport type ServiceMiddlewareOptions<TLogger extends Logger = Logger> =\n\tRequestContextOptions<TLogger> & ServiceResolverOptions;\n\nfunction deriveRequestId(\n\toptions: RequestContextOptions,\n\tevent: unknown,\n\tcontext: Context,\n): string {\n\t// Lambda always populates context.awsRequestId; getRequestId can override it.\n\treturn options.getRequestId?.(event, context) ?? context.awsRequestId;\n}\n\nfunction buildLogger(\n\tbaseLogger: Logger,\n\toptions: RequestContextOptions,\n\trequestId: string,\n\tevent: unknown,\n\tcontext: Context,\n): Logger {\n\treturn baseLogger.child({\n\t\trequestId,\n\t\t...(options.bindings?.(event, context) ?? {}),\n\t});\n}\n\n/**\n * Middy middleware that establishes a request context for the handler so any\n * code it reaches — including `@geekmidas/services` service methods — can call\n * `serviceContext.getLogger()` / `getRequestId()` / `getRequestStartTime()`.\n *\n * Use this on standalone functions that need request-scoped logging. To also\n * resolve services, pair it with {@link addServices}, or use\n * {@link withServices} which bundles both.\n *\n * @example\n * ```ts\n * import middy from '@middy/core';\n * import { serviceContext } from '@geekmidas/services';\n * import { requestContext } from '@geekmidas/services/middy';\n *\n * export const handler = middy(async () => {\n * serviceContext.getLogger().info('tick');\n * }).use(requestContext({ logger }));\n * ```\n */\nexport function requestContext<TLogger extends Logger = Logger>(\n\toptions: RequestContextOptions<TLogger>,\n): MiddlewareObj<unknown, unknown, Error, Context> {\n\tconst baseLogger = options.logger;\n\treturn {\n\t\tbefore: (request) => {\n\t\t\tconst { event, context } = request;\n\t\t\tconst requestId = deriveRequestId(options, event, context);\n\t\t\tconst logger = buildLogger(\n\t\t\t\tbaseLogger,\n\t\t\t\toptions,\n\t\t\t\trequestId,\n\t\t\t\tevent,\n\t\t\t\tcontext,\n\t\t\t);\n\t\t\tenterRequestContext({ logger, requestId, startTime: Date.now() });\n\t\t},\n\t\tafter: () => {\n\t\t\texitRequestContext();\n\t\t},\n\t\tonError: () => {\n\t\t\texitRequestContext();\n\t\t},\n\t};\n}\n\nfunction resolveDiscovery(options: ServiceResolverOptions): ServiceDiscovery {\n\treturn (\n\t\toptions.serviceDiscovery ?? ServiceDiscovery.getInstance(options.envParser)\n\t);\n}\n\n/**\n * Event augmentation applied by {@link addServices} / {@link withServices}:\n * resolved services keyed by `serviceName`. Intersect it with your own event\n * type to type the handler, e.g. `(event: EventServices<T> & APIGatewayEvent)`.\n */\nexport type EventServices<T extends Service[]> = {\n\tservices: ServiceRecord<T>;\n};\n\n/**\n * Middy middleware that resolves an array of {@link Service}s via\n * {@link ServiceDiscovery} and attaches the resolved record to `event.services`\n * (keyed by each service's `serviceName`), matching how the `Function`/`Cron`\n * constructs expose services on the event.\n *\n * This middleware only resolves services; it does **not** establish a request\n * context. If your services read `serviceContext` (e.g. `getLogger()`), pair it\n * with {@link requestContext}, or use {@link withServices} which bundles both.\n *\n * Chainable — `.use(addServices([a])).use(addServices([b]))` accumulates onto\n * `event.services`.\n *\n * @example\n * ```ts\n * import middy from '@middy/core';\n * import { addServices, requestContext } from '@geekmidas/services/middy';\n *\n * export const handler = middy(async (event) => {\n * await event.services.database.users.deletePast();\n * event.services.cache.clear();\n * })\n * .use(requestContext())\n * .use(addServices([databaseService, cacheService], { envParser }));\n * ```\n */\nexport function addServices<const T extends Service[]>(\n\tservices: [...T],\n\toptions: ServiceResolverOptions,\n): MiddlewareObj<EventServices<T>, unknown, Error, Context> {\n\tconst discovery = resolveDiscovery(options);\n\n\treturn {\n\t\tbefore: async (request) => {\n\t\t\tconst resolved = await discovery.register(services);\n\t\t\tconst event = request.event as { services?: Record<string, unknown> };\n\t\t\t// Merge so chained addServices(...) calls accumulate on event.services.\n\t\t\tevent.services = { ...(event.services ?? {}), ...resolved };\n\t\t},\n\t};\n}\n\n/**\n * Batteries-included Middy setup for service-backed handlers: returns a pair of\n * middlewares — {@link requestContext} followed by {@link addServices} — so a\n * single `.use(withServices([...]))` gives the handler both a request context\n * and the resolved services on `event.services`.\n *\n * @example\n * ```ts\n * import middy from '@middy/core';\n * import { withServices } from '@geekmidas/services/middy';\n *\n * export const handler = middy(async (event) => {\n * await event.services.database.users.deletePast();\n * event.services.cache.clear();\n * }).use(withServices([databaseService, cacheService], { envParser }));\n * ```\n */\nexport function withServices<\n\tconst T extends Service[],\n\tTLogger extends Logger = Logger,\n>(\n\tservices: [...T],\n\toptions: ServiceMiddlewareOptions<TLogger>,\n): [\n\tMiddlewareObj<unknown, unknown, Error, Context>,\n\tMiddlewareObj<EventServices<T>, unknown, Error, Context>,\n] {\n\treturn [requestContext(options), addServices(services, options)];\n}\n"],"mappings":";;;;AAwEA,SAAS,gBACRA,SACAC,OACAC,SACS;AAET,QAAO,QAAQ,eAAe,OAAO,QAAQ,IAAI,QAAQ;AACzD;AAED,SAAS,YACRC,YACAH,SACAI,WACAH,OACAC,SACS;AACT,QAAO,WAAW,MAAM;EACvB;EACA,GAAI,QAAQ,WAAW,OAAO,QAAQ,IAAI,CAAE;CAC5C,EAAC;AACF;;;;;;;;;;;;;;;;;;;;;AAsBD,SAAgB,eACfG,SACkD;CAClD,MAAM,aAAa,QAAQ;AAC3B,QAAO;EACN,QAAQ,CAAC,YAAY;GACpB,MAAM,EAAE,OAAO,SAAS,GAAG;GAC3B,MAAM,YAAY,gBAAgB,SAAS,OAAO,QAAQ;GAC1D,MAAM,SAAS,YACd,YACA,SACA,WACA,OACA,QACA;AACD,uCAAoB;IAAE;IAAQ;IAAW,WAAW,KAAK,KAAK;GAAE,EAAC;EACjE;EACD,OAAO,MAAM;AACZ,uCAAoB;EACpB;EACD,SAAS,MAAM;AACd,uCAAoB;EACpB;CACD;AACD;AAED,SAAS,iBAAiBC,SAAmD;AAC5E,QACC,QAAQ,oBAAoB,0CAAiB,YAAY,QAAQ,UAAU;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCD,SAAgB,YACfC,UACAD,SAC2D;CAC3D,MAAM,YAAY,iBAAiB,QAAQ;AAE3C,QAAO,EACN,QAAQ,OAAO,YAAY;EAC1B,MAAM,WAAW,MAAM,UAAU,SAAS,SAAS;EACnD,MAAM,QAAQ,QAAQ;AAEtB,QAAM,WAAW;GAAE,GAAI,MAAM,YAAY,CAAE;GAAG,GAAG;EAAU;CAC3D,EACD;AACD;;;;;;;;;;;;;;;;;;AAmBD,SAAgB,aAIfC,UACAC,SAIC;AACD,QAAO,CAAC,eAAe,QAAQ,EAAE,YAAY,UAAU,QAAQ,AAAC;AAChE"}
|
package/dist/middy.d.cts
ADDED
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
import { Service } from "./types-Bgk-0NOO.cjs";
|
|
2
|
+
import { ServiceDiscovery, ServiceRecord } from "./ServiceDiscovery-BO8W-RY8.cjs";
|
|
3
|
+
import { Logger } from "@geekmidas/logger";
|
|
4
|
+
import { EnvironmentParser } from "@geekmidas/envkit";
|
|
5
|
+
import { MiddlewareObj } from "@middy/core";
|
|
6
|
+
import { Context } from "aws-lambda";
|
|
7
|
+
|
|
8
|
+
//#region src/middy.d.ts
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Middy middleware helpers that bring `@geekmidas/services` request context and
|
|
12
|
+
* service discovery to **standalone** Middy Lambda handlers — i.e. functions
|
|
13
|
+
* that aren't built with the `@geekmidas/constructs` Function/Cron constructs
|
|
14
|
+
* but still want `serviceContext.getLogger()` and resolved services.
|
|
15
|
+
*
|
|
16
|
+
* Why middleware (and not `runWithRequestContext`)? Middy runs `before → handler
|
|
17
|
+
* → after` as sequential awaits in a single async context, so establishing the
|
|
18
|
+
* context with `AsyncLocalStorage.enterWith` (via `enterRequestContext`) in a
|
|
19
|
+
* `before` hook propagates to the handler. `after`/`onError` reset it.
|
|
20
|
+
*
|
|
21
|
+
* Teardown is best-effort: like `enterRequestContext`, the reset is observable
|
|
22
|
+
* to code the handler reaches but not necessarily to the frame that invoked the
|
|
23
|
+
* Middy handler. This is fine for Lambda, where each invocation runs in its own
|
|
24
|
+
* fresh async context — `requestContext` always establishes a brand-new context
|
|
25
|
+
* per invocation, so requests never inherit a previous invocation's logger.
|
|
26
|
+
*
|
|
27
|
+
* @module
|
|
28
|
+
*/
|
|
29
|
+
/**
|
|
30
|
+
* Options for {@link requestContext}. Generic over the logger type so a custom
|
|
31
|
+
* logger that extends {@link Logger} is preserved rather than widened.
|
|
32
|
+
*/
|
|
33
|
+
interface RequestContextOptions<TLogger extends Logger = Logger> {
|
|
34
|
+
/**
|
|
35
|
+
* Logger to derive the per-request child logger from. Required — the caller
|
|
36
|
+
* decides which logger to use (there is no implicit default).
|
|
37
|
+
*/
|
|
38
|
+
logger: TLogger;
|
|
39
|
+
/**
|
|
40
|
+
* Derive the request id from the event/context.
|
|
41
|
+
* Defaults to `context.awsRequestId` (always present in a Lambda invocation).
|
|
42
|
+
*/
|
|
43
|
+
getRequestId?: (event: unknown, context: Context) => string;
|
|
44
|
+
/**
|
|
45
|
+
* Extra bindings to attach to the per-request child logger.
|
|
46
|
+
*/
|
|
47
|
+
bindings?: (event: unknown, context: Context) => Record<string, unknown>;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Options for {@link addServices} — how services are resolved. No logger is
|
|
51
|
+
* needed because resolving services doesn't establish a request context.
|
|
52
|
+
*/
|
|
53
|
+
interface ServiceResolverOptions {
|
|
54
|
+
/**
|
|
55
|
+
* Environment parser used to build the {@link ServiceDiscovery}. Required —
|
|
56
|
+
* the caller supplies the parser (there is no implicit `process.env` default).
|
|
57
|
+
*/
|
|
58
|
+
envParser: EnvironmentParser<{}>;
|
|
59
|
+
/**
|
|
60
|
+
* Explicit {@link ServiceDiscovery} to resolve services from. Takes
|
|
61
|
+
* precedence over `envParser`.
|
|
62
|
+
*/
|
|
63
|
+
serviceDiscovery?: ServiceDiscovery;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Options for {@link withServices}: request context (logger) + service resolution.
|
|
67
|
+
*/
|
|
68
|
+
type ServiceMiddlewareOptions<TLogger extends Logger = Logger> = RequestContextOptions<TLogger> & ServiceResolverOptions;
|
|
69
|
+
/**
|
|
70
|
+
* Middy middleware that establishes a request context for the handler so any
|
|
71
|
+
* code it reaches — including `@geekmidas/services` service methods — can call
|
|
72
|
+
* `serviceContext.getLogger()` / `getRequestId()` / `getRequestStartTime()`.
|
|
73
|
+
*
|
|
74
|
+
* Use this on standalone functions that need request-scoped logging. To also
|
|
75
|
+
* resolve services, pair it with {@link addServices}, or use
|
|
76
|
+
* {@link withServices} which bundles both.
|
|
77
|
+
*
|
|
78
|
+
* @example
|
|
79
|
+
* ```ts
|
|
80
|
+
* import middy from '@middy/core';
|
|
81
|
+
* import { serviceContext } from '@geekmidas/services';
|
|
82
|
+
* import { requestContext } from '@geekmidas/services/middy';
|
|
83
|
+
*
|
|
84
|
+
* export const handler = middy(async () => {
|
|
85
|
+
* serviceContext.getLogger().info('tick');
|
|
86
|
+
* }).use(requestContext({ logger }));
|
|
87
|
+
* ```
|
|
88
|
+
*/
|
|
89
|
+
declare function requestContext<TLogger extends Logger = Logger>(options: RequestContextOptions<TLogger>): MiddlewareObj<unknown, unknown, Error, Context>;
|
|
90
|
+
/**
|
|
91
|
+
* Event augmentation applied by {@link addServices} / {@link withServices}:
|
|
92
|
+
* resolved services keyed by `serviceName`. Intersect it with your own event
|
|
93
|
+
* type to type the handler, e.g. `(event: EventServices<T> & APIGatewayEvent)`.
|
|
94
|
+
*/
|
|
95
|
+
type EventServices<T extends Service[]> = {
|
|
96
|
+
services: ServiceRecord<T>;
|
|
97
|
+
};
|
|
98
|
+
/**
|
|
99
|
+
* Middy middleware that resolves an array of {@link Service}s via
|
|
100
|
+
* {@link ServiceDiscovery} and attaches the resolved record to `event.services`
|
|
101
|
+
* (keyed by each service's `serviceName`), matching how the `Function`/`Cron`
|
|
102
|
+
* constructs expose services on the event.
|
|
103
|
+
*
|
|
104
|
+
* This middleware only resolves services; it does **not** establish a request
|
|
105
|
+
* context. If your services read `serviceContext` (e.g. `getLogger()`), pair it
|
|
106
|
+
* with {@link requestContext}, or use {@link withServices} which bundles both.
|
|
107
|
+
*
|
|
108
|
+
* Chainable — `.use(addServices([a])).use(addServices([b]))` accumulates onto
|
|
109
|
+
* `event.services`.
|
|
110
|
+
*
|
|
111
|
+
* @example
|
|
112
|
+
* ```ts
|
|
113
|
+
* import middy from '@middy/core';
|
|
114
|
+
* import { addServices, requestContext } from '@geekmidas/services/middy';
|
|
115
|
+
*
|
|
116
|
+
* export const handler = middy(async (event) => {
|
|
117
|
+
* await event.services.database.users.deletePast();
|
|
118
|
+
* event.services.cache.clear();
|
|
119
|
+
* })
|
|
120
|
+
* .use(requestContext())
|
|
121
|
+
* .use(addServices([databaseService, cacheService], { envParser }));
|
|
122
|
+
* ```
|
|
123
|
+
*/
|
|
124
|
+
declare function addServices<const T extends Service[]>(services: [...T], options: ServiceResolverOptions): MiddlewareObj<EventServices<T>, unknown, Error, Context>;
|
|
125
|
+
/**
|
|
126
|
+
* Batteries-included Middy setup for service-backed handlers: returns a pair of
|
|
127
|
+
* middlewares — {@link requestContext} followed by {@link addServices} — so a
|
|
128
|
+
* single `.use(withServices([...]))` gives the handler both a request context
|
|
129
|
+
* and the resolved services on `event.services`.
|
|
130
|
+
*
|
|
131
|
+
* @example
|
|
132
|
+
* ```ts
|
|
133
|
+
* import middy from '@middy/core';
|
|
134
|
+
* import { withServices } from '@geekmidas/services/middy';
|
|
135
|
+
*
|
|
136
|
+
* export const handler = middy(async (event) => {
|
|
137
|
+
* await event.services.database.users.deletePast();
|
|
138
|
+
* event.services.cache.clear();
|
|
139
|
+
* }).use(withServices([databaseService, cacheService], { envParser }));
|
|
140
|
+
* ```
|
|
141
|
+
*/
|
|
142
|
+
declare function withServices<const T extends Service[], TLogger extends Logger = Logger>(services: [...T], options: ServiceMiddlewareOptions<TLogger>): [MiddlewareObj<unknown, unknown, Error, Context>, MiddlewareObj<EventServices<T>, unknown, Error, Context>];
|
|
143
|
+
//# sourceMappingURL=middy.d.ts.map
|
|
144
|
+
//#endregion
|
|
145
|
+
export { EventServices, RequestContextOptions, ServiceMiddlewareOptions, ServiceResolverOptions, addServices, requestContext, withServices };
|
|
146
|
+
//# sourceMappingURL=middy.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"middy.d.cts","names":[],"sources":["../src/middy.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;AAgCA;;;;;;;;AAcwD;AAOxD;;;;AAUoC;AAMpC;;;;;;;AACwD,UAtCvC,qBAsCuC,CAAA,gBAtCD,MAsCC,GAtCQ,MAsCR,CAAA,CAAA;EA4CxC;;;;EAA8C,MAC9B,EA9EvB,OA8EuB;EAAO;;;;EACvB,YAAA,CAAA,EAAA,CAAA,KAAA,EAAA,OAAA,EAAA,OAAA,EA1E0B,OA0E1B,EAAA,GAAA,MAAA;EAmCJ;;;EAA+B,QAClB,CAAA,EAAA,CAAA,KAAA,EAAA,OAAA,EAAA,OAAA,EA1Ga,OA0Gb,EAAA,GA1GyB,MA0GzB,CAAA,MAAA,EAAA,OAAA,CAAA;;AAAD;AA6BxB;;;AACe,UAjIE,sBAAA,CAiIF;EAAC;;;;EAEiC,SAAE,EA9HvC,iBA8HuC,CAAA,CAAA,CAAA,CAAA;EAAO;AAA1C;AA8BhB;;EAA4B,gBACX,CAAA,EAxJG,gBAwJH;;;;;AAIP,KAtJE,wBAsJF,CAAA,gBAtJ2C,MAsJ3C,GAtJoD,MAsJpD,CAAA,GArJT,qBAqJS,CArJa,OAqJb,CAAA,GArJwB,sBAqJxB;;;;;;;;;AAGI;;;;;;;;;;;;iBA5GE,+BAA+B,SAAS,iBAC9C,sBAAsB,WAC7B,gCAAgC,OAAO;;;;;;KAmC9B,wBAAwB;YACzB,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA6BT,4BAA4B,yBAC7B,aACL,yBACP,cAAc,cAAc,aAAa,OAAO;;;;;;;;;;;;;;;;;;iBA8BnC,6BACC,2BACA,SAAS,sBAEX,aACL,yBAAyB,YAElC,gCAAgC,OAAO,UACvC,cAAc,cAAc,aAAa,OAAO"}
|
package/dist/middy.d.mts
ADDED
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
import { Service } from "./types-BoyOCa57.mjs";
|
|
2
|
+
import { ServiceDiscovery, ServiceRecord } from "./ServiceDiscovery-CRq_bGbi.mjs";
|
|
3
|
+
import { Logger } from "@geekmidas/logger";
|
|
4
|
+
import { EnvironmentParser } from "@geekmidas/envkit";
|
|
5
|
+
import { MiddlewareObj } from "@middy/core";
|
|
6
|
+
import { Context } from "aws-lambda";
|
|
7
|
+
|
|
8
|
+
//#region src/middy.d.ts
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Middy middleware helpers that bring `@geekmidas/services` request context and
|
|
12
|
+
* service discovery to **standalone** Middy Lambda handlers — i.e. functions
|
|
13
|
+
* that aren't built with the `@geekmidas/constructs` Function/Cron constructs
|
|
14
|
+
* but still want `serviceContext.getLogger()` and resolved services.
|
|
15
|
+
*
|
|
16
|
+
* Why middleware (and not `runWithRequestContext`)? Middy runs `before → handler
|
|
17
|
+
* → after` as sequential awaits in a single async context, so establishing the
|
|
18
|
+
* context with `AsyncLocalStorage.enterWith` (via `enterRequestContext`) in a
|
|
19
|
+
* `before` hook propagates to the handler. `after`/`onError` reset it.
|
|
20
|
+
*
|
|
21
|
+
* Teardown is best-effort: like `enterRequestContext`, the reset is observable
|
|
22
|
+
* to code the handler reaches but not necessarily to the frame that invoked the
|
|
23
|
+
* Middy handler. This is fine for Lambda, where each invocation runs in its own
|
|
24
|
+
* fresh async context — `requestContext` always establishes a brand-new context
|
|
25
|
+
* per invocation, so requests never inherit a previous invocation's logger.
|
|
26
|
+
*
|
|
27
|
+
* @module
|
|
28
|
+
*/
|
|
29
|
+
/**
|
|
30
|
+
* Options for {@link requestContext}. Generic over the logger type so a custom
|
|
31
|
+
* logger that extends {@link Logger} is preserved rather than widened.
|
|
32
|
+
*/
|
|
33
|
+
interface RequestContextOptions<TLogger extends Logger = Logger> {
|
|
34
|
+
/**
|
|
35
|
+
* Logger to derive the per-request child logger from. Required — the caller
|
|
36
|
+
* decides which logger to use (there is no implicit default).
|
|
37
|
+
*/
|
|
38
|
+
logger: TLogger;
|
|
39
|
+
/**
|
|
40
|
+
* Derive the request id from the event/context.
|
|
41
|
+
* Defaults to `context.awsRequestId` (always present in a Lambda invocation).
|
|
42
|
+
*/
|
|
43
|
+
getRequestId?: (event: unknown, context: Context) => string;
|
|
44
|
+
/**
|
|
45
|
+
* Extra bindings to attach to the per-request child logger.
|
|
46
|
+
*/
|
|
47
|
+
bindings?: (event: unknown, context: Context) => Record<string, unknown>;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Options for {@link addServices} — how services are resolved. No logger is
|
|
51
|
+
* needed because resolving services doesn't establish a request context.
|
|
52
|
+
*/
|
|
53
|
+
interface ServiceResolverOptions {
|
|
54
|
+
/**
|
|
55
|
+
* Environment parser used to build the {@link ServiceDiscovery}. Required —
|
|
56
|
+
* the caller supplies the parser (there is no implicit `process.env` default).
|
|
57
|
+
*/
|
|
58
|
+
envParser: EnvironmentParser<{}>;
|
|
59
|
+
/**
|
|
60
|
+
* Explicit {@link ServiceDiscovery} to resolve services from. Takes
|
|
61
|
+
* precedence over `envParser`.
|
|
62
|
+
*/
|
|
63
|
+
serviceDiscovery?: ServiceDiscovery;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Options for {@link withServices}: request context (logger) + service resolution.
|
|
67
|
+
*/
|
|
68
|
+
type ServiceMiddlewareOptions<TLogger extends Logger = Logger> = RequestContextOptions<TLogger> & ServiceResolverOptions;
|
|
69
|
+
/**
|
|
70
|
+
* Middy middleware that establishes a request context for the handler so any
|
|
71
|
+
* code it reaches — including `@geekmidas/services` service methods — can call
|
|
72
|
+
* `serviceContext.getLogger()` / `getRequestId()` / `getRequestStartTime()`.
|
|
73
|
+
*
|
|
74
|
+
* Use this on standalone functions that need request-scoped logging. To also
|
|
75
|
+
* resolve services, pair it with {@link addServices}, or use
|
|
76
|
+
* {@link withServices} which bundles both.
|
|
77
|
+
*
|
|
78
|
+
* @example
|
|
79
|
+
* ```ts
|
|
80
|
+
* import middy from '@middy/core';
|
|
81
|
+
* import { serviceContext } from '@geekmidas/services';
|
|
82
|
+
* import { requestContext } from '@geekmidas/services/middy';
|
|
83
|
+
*
|
|
84
|
+
* export const handler = middy(async () => {
|
|
85
|
+
* serviceContext.getLogger().info('tick');
|
|
86
|
+
* }).use(requestContext({ logger }));
|
|
87
|
+
* ```
|
|
88
|
+
*/
|
|
89
|
+
declare function requestContext<TLogger extends Logger = Logger>(options: RequestContextOptions<TLogger>): MiddlewareObj<unknown, unknown, Error, Context>;
|
|
90
|
+
/**
|
|
91
|
+
* Event augmentation applied by {@link addServices} / {@link withServices}:
|
|
92
|
+
* resolved services keyed by `serviceName`. Intersect it with your own event
|
|
93
|
+
* type to type the handler, e.g. `(event: EventServices<T> & APIGatewayEvent)`.
|
|
94
|
+
*/
|
|
95
|
+
type EventServices<T extends Service[]> = {
|
|
96
|
+
services: ServiceRecord<T>;
|
|
97
|
+
};
|
|
98
|
+
/**
|
|
99
|
+
* Middy middleware that resolves an array of {@link Service}s via
|
|
100
|
+
* {@link ServiceDiscovery} and attaches the resolved record to `event.services`
|
|
101
|
+
* (keyed by each service's `serviceName`), matching how the `Function`/`Cron`
|
|
102
|
+
* constructs expose services on the event.
|
|
103
|
+
*
|
|
104
|
+
* This middleware only resolves services; it does **not** establish a request
|
|
105
|
+
* context. If your services read `serviceContext` (e.g. `getLogger()`), pair it
|
|
106
|
+
* with {@link requestContext}, or use {@link withServices} which bundles both.
|
|
107
|
+
*
|
|
108
|
+
* Chainable — `.use(addServices([a])).use(addServices([b]))` accumulates onto
|
|
109
|
+
* `event.services`.
|
|
110
|
+
*
|
|
111
|
+
* @example
|
|
112
|
+
* ```ts
|
|
113
|
+
* import middy from '@middy/core';
|
|
114
|
+
* import { addServices, requestContext } from '@geekmidas/services/middy';
|
|
115
|
+
*
|
|
116
|
+
* export const handler = middy(async (event) => {
|
|
117
|
+
* await event.services.database.users.deletePast();
|
|
118
|
+
* event.services.cache.clear();
|
|
119
|
+
* })
|
|
120
|
+
* .use(requestContext())
|
|
121
|
+
* .use(addServices([databaseService, cacheService], { envParser }));
|
|
122
|
+
* ```
|
|
123
|
+
*/
|
|
124
|
+
declare function addServices<const T extends Service[]>(services: [...T], options: ServiceResolverOptions): MiddlewareObj<EventServices<T>, unknown, Error, Context>;
|
|
125
|
+
/**
|
|
126
|
+
* Batteries-included Middy setup for service-backed handlers: returns a pair of
|
|
127
|
+
* middlewares — {@link requestContext} followed by {@link addServices} — so a
|
|
128
|
+
* single `.use(withServices([...]))` gives the handler both a request context
|
|
129
|
+
* and the resolved services on `event.services`.
|
|
130
|
+
*
|
|
131
|
+
* @example
|
|
132
|
+
* ```ts
|
|
133
|
+
* import middy from '@middy/core';
|
|
134
|
+
* import { withServices } from '@geekmidas/services/middy';
|
|
135
|
+
*
|
|
136
|
+
* export const handler = middy(async (event) => {
|
|
137
|
+
* await event.services.database.users.deletePast();
|
|
138
|
+
* event.services.cache.clear();
|
|
139
|
+
* }).use(withServices([databaseService, cacheService], { envParser }));
|
|
140
|
+
* ```
|
|
141
|
+
*/
|
|
142
|
+
declare function withServices<const T extends Service[], TLogger extends Logger = Logger>(services: [...T], options: ServiceMiddlewareOptions<TLogger>): [MiddlewareObj<unknown, unknown, Error, Context>, MiddlewareObj<EventServices<T>, unknown, Error, Context>];
|
|
143
|
+
//# sourceMappingURL=middy.d.ts.map
|
|
144
|
+
//#endregion
|
|
145
|
+
export { EventServices, RequestContextOptions, ServiceMiddlewareOptions, ServiceResolverOptions, addServices, requestContext, withServices };
|
|
146
|
+
//# sourceMappingURL=middy.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"middy.d.mts","names":[],"sources":["../src/middy.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;AAgCA;;;;;;;;AAcwD;AAOxD;;;;AAUoC;AAMpC;;;;;;;AACwD,UAtCvC,qBAsCuC,CAAA,gBAtCD,MAsCC,GAtCQ,MAsCR,CAAA,CAAA;EA4CxC;;;;EAA8C,MAC9B,EA9EvB,OA8EuB;EAAO;;;;EACvB,YAAA,CAAA,EAAA,CAAA,KAAA,EAAA,OAAA,EAAA,OAAA,EA1E0B,OA0E1B,EAAA,GAAA,MAAA;EAmCJ;;;EAA+B,QAClB,CAAA,EAAA,CAAA,KAAA,EAAA,OAAA,EAAA,OAAA,EA1Ga,OA0Gb,EAAA,GA1GyB,MA0GzB,CAAA,MAAA,EAAA,OAAA,CAAA;;AAAD;AA6BxB;;;AACe,UAjIE,sBAAA,CAiIF;EAAC;;;;EAEiC,SAAE,EA9HvC,iBA8HuC,CAAA,CAAA,CAAA,CAAA;EAAO;AAA1C;AA8BhB;;EAA4B,gBACX,CAAA,EAxJG,gBAwJH;;;;;AAIP,KAtJE,wBAsJF,CAAA,gBAtJ2C,MAsJ3C,GAtJoD,MAsJpD,CAAA,GArJT,qBAqJS,CArJa,OAqJb,CAAA,GArJwB,sBAqJxB;;;;;;;;;AAGI;;;;;;;;;;;;iBA5GE,+BAA+B,SAAS,iBAC9C,sBAAsB,WAC7B,gCAAgC,OAAO;;;;;;KAmC9B,wBAAwB;YACzB,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA6BT,4BAA4B,yBAC7B,aACL,yBACP,cAAc,cAAc,aAAa,OAAO;;;;;;;;;;;;;;;;;;iBA8BnC,6BACC,2BACA,SAAS,sBAEX,aACL,yBAAyB,YAElC,gCAAgC,OAAO,UACvC,cAAc,cAAc,aAAa,OAAO"}
|
package/dist/middy.mjs
ADDED
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
import { enterRequestContext, exitRequestContext } from "./context-C9DCrFWA.mjs";
|
|
2
|
+
import { ServiceDiscovery } from "./ServiceDiscovery-DO_uDfuG.mjs";
|
|
3
|
+
|
|
4
|
+
//#region src/middy.ts
|
|
5
|
+
function deriveRequestId(options, event, context) {
|
|
6
|
+
return options.getRequestId?.(event, context) ?? context.awsRequestId;
|
|
7
|
+
}
|
|
8
|
+
function buildLogger(baseLogger, options, requestId, event, context) {
|
|
9
|
+
return baseLogger.child({
|
|
10
|
+
requestId,
|
|
11
|
+
...options.bindings?.(event, context) ?? {}
|
|
12
|
+
});
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Middy middleware that establishes a request context for the handler so any
|
|
16
|
+
* code it reaches — including `@geekmidas/services` service methods — can call
|
|
17
|
+
* `serviceContext.getLogger()` / `getRequestId()` / `getRequestStartTime()`.
|
|
18
|
+
*
|
|
19
|
+
* Use this on standalone functions that need request-scoped logging. To also
|
|
20
|
+
* resolve services, pair it with {@link addServices}, or use
|
|
21
|
+
* {@link withServices} which bundles both.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* import middy from '@middy/core';
|
|
26
|
+
* import { serviceContext } from '@geekmidas/services';
|
|
27
|
+
* import { requestContext } from '@geekmidas/services/middy';
|
|
28
|
+
*
|
|
29
|
+
* export const handler = middy(async () => {
|
|
30
|
+
* serviceContext.getLogger().info('tick');
|
|
31
|
+
* }).use(requestContext({ logger }));
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
function requestContext(options) {
|
|
35
|
+
const baseLogger = options.logger;
|
|
36
|
+
return {
|
|
37
|
+
before: (request) => {
|
|
38
|
+
const { event, context } = request;
|
|
39
|
+
const requestId = deriveRequestId(options, event, context);
|
|
40
|
+
const logger = buildLogger(baseLogger, options, requestId, event, context);
|
|
41
|
+
enterRequestContext({
|
|
42
|
+
logger,
|
|
43
|
+
requestId,
|
|
44
|
+
startTime: Date.now()
|
|
45
|
+
});
|
|
46
|
+
},
|
|
47
|
+
after: () => {
|
|
48
|
+
exitRequestContext();
|
|
49
|
+
},
|
|
50
|
+
onError: () => {
|
|
51
|
+
exitRequestContext();
|
|
52
|
+
}
|
|
53
|
+
};
|
|
54
|
+
}
|
|
55
|
+
function resolveDiscovery(options) {
|
|
56
|
+
return options.serviceDiscovery ?? ServiceDiscovery.getInstance(options.envParser);
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Middy middleware that resolves an array of {@link Service}s via
|
|
60
|
+
* {@link ServiceDiscovery} and attaches the resolved record to `event.services`
|
|
61
|
+
* (keyed by each service's `serviceName`), matching how the `Function`/`Cron`
|
|
62
|
+
* constructs expose services on the event.
|
|
63
|
+
*
|
|
64
|
+
* This middleware only resolves services; it does **not** establish a request
|
|
65
|
+
* context. If your services read `serviceContext` (e.g. `getLogger()`), pair it
|
|
66
|
+
* with {@link requestContext}, or use {@link withServices} which bundles both.
|
|
67
|
+
*
|
|
68
|
+
* Chainable — `.use(addServices([a])).use(addServices([b]))` accumulates onto
|
|
69
|
+
* `event.services`.
|
|
70
|
+
*
|
|
71
|
+
* @example
|
|
72
|
+
* ```ts
|
|
73
|
+
* import middy from '@middy/core';
|
|
74
|
+
* import { addServices, requestContext } from '@geekmidas/services/middy';
|
|
75
|
+
*
|
|
76
|
+
* export const handler = middy(async (event) => {
|
|
77
|
+
* await event.services.database.users.deletePast();
|
|
78
|
+
* event.services.cache.clear();
|
|
79
|
+
* })
|
|
80
|
+
* .use(requestContext())
|
|
81
|
+
* .use(addServices([databaseService, cacheService], { envParser }));
|
|
82
|
+
* ```
|
|
83
|
+
*/
|
|
84
|
+
function addServices(services, options) {
|
|
85
|
+
const discovery = resolveDiscovery(options);
|
|
86
|
+
return { before: async (request) => {
|
|
87
|
+
const resolved = await discovery.register(services);
|
|
88
|
+
const event = request.event;
|
|
89
|
+
event.services = {
|
|
90
|
+
...event.services ?? {},
|
|
91
|
+
...resolved
|
|
92
|
+
};
|
|
93
|
+
} };
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* Batteries-included Middy setup for service-backed handlers: returns a pair of
|
|
97
|
+
* middlewares — {@link requestContext} followed by {@link addServices} — so a
|
|
98
|
+
* single `.use(withServices([...]))` gives the handler both a request context
|
|
99
|
+
* and the resolved services on `event.services`.
|
|
100
|
+
*
|
|
101
|
+
* @example
|
|
102
|
+
* ```ts
|
|
103
|
+
* import middy from '@middy/core';
|
|
104
|
+
* import { withServices } from '@geekmidas/services/middy';
|
|
105
|
+
*
|
|
106
|
+
* export const handler = middy(async (event) => {
|
|
107
|
+
* await event.services.database.users.deletePast();
|
|
108
|
+
* event.services.cache.clear();
|
|
109
|
+
* }).use(withServices([databaseService, cacheService], { envParser }));
|
|
110
|
+
* ```
|
|
111
|
+
*/
|
|
112
|
+
function withServices(services, options) {
|
|
113
|
+
return [requestContext(options), addServices(services, options)];
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
//#endregion
|
|
117
|
+
export { addServices, requestContext, withServices };
|
|
118
|
+
//# sourceMappingURL=middy.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"middy.mjs","names":["options: RequestContextOptions","event: unknown","context: Context","baseLogger: Logger","requestId: string","options: RequestContextOptions<TLogger>","options: ServiceResolverOptions","services: [...T]","options: ServiceMiddlewareOptions<TLogger>"],"sources":["../src/middy.ts"],"sourcesContent":["import type { EnvironmentParser } from '@geekmidas/envkit';\nimport type { Logger } from '@geekmidas/logger';\nimport type { MiddlewareObj } from '@middy/core';\nimport type { Context } from 'aws-lambda';\nimport { enterRequestContext, exitRequestContext } from './context';\nimport { ServiceDiscovery, type ServiceRecord } from './ServiceDiscovery';\nimport type { Service } from './types';\n\n/**\n * Middy middleware helpers that bring `@geekmidas/services` request context and\n * service discovery to **standalone** Middy Lambda handlers — i.e. functions\n * that aren't built with the `@geekmidas/constructs` Function/Cron constructs\n * but still want `serviceContext.getLogger()` and resolved services.\n *\n * Why middleware (and not `runWithRequestContext`)? Middy runs `before → handler\n * → after` as sequential awaits in a single async context, so establishing the\n * context with `AsyncLocalStorage.enterWith` (via `enterRequestContext`) in a\n * `before` hook propagates to the handler. `after`/`onError` reset it.\n *\n * Teardown is best-effort: like `enterRequestContext`, the reset is observable\n * to code the handler reaches but not necessarily to the frame that invoked the\n * Middy handler. This is fine for Lambda, where each invocation runs in its own\n * fresh async context — `requestContext` always establishes a brand-new context\n * per invocation, so requests never inherit a previous invocation's logger.\n *\n * @module\n */\n\n/**\n * Options for {@link requestContext}. Generic over the logger type so a custom\n * logger that extends {@link Logger} is preserved rather than widened.\n */\nexport interface RequestContextOptions<TLogger extends Logger = Logger> {\n\t/**\n\t * Logger to derive the per-request child logger from. Required — the caller\n\t * decides which logger to use (there is no implicit default).\n\t */\n\tlogger: TLogger;\n\t/**\n\t * Derive the request id from the event/context.\n\t * Defaults to `context.awsRequestId` (always present in a Lambda invocation).\n\t */\n\tgetRequestId?: (event: unknown, context: Context) => string;\n\t/**\n\t * Extra bindings to attach to the per-request child logger.\n\t */\n\tbindings?: (event: unknown, context: Context) => Record<string, unknown>;\n}\n\n/**\n * Options for {@link addServices} — how services are resolved. No logger is\n * needed because resolving services doesn't establish a request context.\n */\nexport interface ServiceResolverOptions {\n\t/**\n\t * Environment parser used to build the {@link ServiceDiscovery}. Required —\n\t * the caller supplies the parser (there is no implicit `process.env` default).\n\t */\n\tenvParser: EnvironmentParser<{}>;\n\t/**\n\t * Explicit {@link ServiceDiscovery} to resolve services from. Takes\n\t * precedence over `envParser`.\n\t */\n\tserviceDiscovery?: ServiceDiscovery;\n}\n\n/**\n * Options for {@link withServices}: request context (logger) + service resolution.\n */\nexport type ServiceMiddlewareOptions<TLogger extends Logger = Logger> =\n\tRequestContextOptions<TLogger> & ServiceResolverOptions;\n\nfunction deriveRequestId(\n\toptions: RequestContextOptions,\n\tevent: unknown,\n\tcontext: Context,\n): string {\n\t// Lambda always populates context.awsRequestId; getRequestId can override it.\n\treturn options.getRequestId?.(event, context) ?? context.awsRequestId;\n}\n\nfunction buildLogger(\n\tbaseLogger: Logger,\n\toptions: RequestContextOptions,\n\trequestId: string,\n\tevent: unknown,\n\tcontext: Context,\n): Logger {\n\treturn baseLogger.child({\n\t\trequestId,\n\t\t...(options.bindings?.(event, context) ?? {}),\n\t});\n}\n\n/**\n * Middy middleware that establishes a request context for the handler so any\n * code it reaches — including `@geekmidas/services` service methods — can call\n * `serviceContext.getLogger()` / `getRequestId()` / `getRequestStartTime()`.\n *\n * Use this on standalone functions that need request-scoped logging. To also\n * resolve services, pair it with {@link addServices}, or use\n * {@link withServices} which bundles both.\n *\n * @example\n * ```ts\n * import middy from '@middy/core';\n * import { serviceContext } from '@geekmidas/services';\n * import { requestContext } from '@geekmidas/services/middy';\n *\n * export const handler = middy(async () => {\n * serviceContext.getLogger().info('tick');\n * }).use(requestContext({ logger }));\n * ```\n */\nexport function requestContext<TLogger extends Logger = Logger>(\n\toptions: RequestContextOptions<TLogger>,\n): MiddlewareObj<unknown, unknown, Error, Context> {\n\tconst baseLogger = options.logger;\n\treturn {\n\t\tbefore: (request) => {\n\t\t\tconst { event, context } = request;\n\t\t\tconst requestId = deriveRequestId(options, event, context);\n\t\t\tconst logger = buildLogger(\n\t\t\t\tbaseLogger,\n\t\t\t\toptions,\n\t\t\t\trequestId,\n\t\t\t\tevent,\n\t\t\t\tcontext,\n\t\t\t);\n\t\t\tenterRequestContext({ logger, requestId, startTime: Date.now() });\n\t\t},\n\t\tafter: () => {\n\t\t\texitRequestContext();\n\t\t},\n\t\tonError: () => {\n\t\t\texitRequestContext();\n\t\t},\n\t};\n}\n\nfunction resolveDiscovery(options: ServiceResolverOptions): ServiceDiscovery {\n\treturn (\n\t\toptions.serviceDiscovery ?? ServiceDiscovery.getInstance(options.envParser)\n\t);\n}\n\n/**\n * Event augmentation applied by {@link addServices} / {@link withServices}:\n * resolved services keyed by `serviceName`. Intersect it with your own event\n * type to type the handler, e.g. `(event: EventServices<T> & APIGatewayEvent)`.\n */\nexport type EventServices<T extends Service[]> = {\n\tservices: ServiceRecord<T>;\n};\n\n/**\n * Middy middleware that resolves an array of {@link Service}s via\n * {@link ServiceDiscovery} and attaches the resolved record to `event.services`\n * (keyed by each service's `serviceName`), matching how the `Function`/`Cron`\n * constructs expose services on the event.\n *\n * This middleware only resolves services; it does **not** establish a request\n * context. If your services read `serviceContext` (e.g. `getLogger()`), pair it\n * with {@link requestContext}, or use {@link withServices} which bundles both.\n *\n * Chainable — `.use(addServices([a])).use(addServices([b]))` accumulates onto\n * `event.services`.\n *\n * @example\n * ```ts\n * import middy from '@middy/core';\n * import { addServices, requestContext } from '@geekmidas/services/middy';\n *\n * export const handler = middy(async (event) => {\n * await event.services.database.users.deletePast();\n * event.services.cache.clear();\n * })\n * .use(requestContext())\n * .use(addServices([databaseService, cacheService], { envParser }));\n * ```\n */\nexport function addServices<const T extends Service[]>(\n\tservices: [...T],\n\toptions: ServiceResolverOptions,\n): MiddlewareObj<EventServices<T>, unknown, Error, Context> {\n\tconst discovery = resolveDiscovery(options);\n\n\treturn {\n\t\tbefore: async (request) => {\n\t\t\tconst resolved = await discovery.register(services);\n\t\t\tconst event = request.event as { services?: Record<string, unknown> };\n\t\t\t// Merge so chained addServices(...) calls accumulate on event.services.\n\t\t\tevent.services = { ...(event.services ?? {}), ...resolved };\n\t\t},\n\t};\n}\n\n/**\n * Batteries-included Middy setup for service-backed handlers: returns a pair of\n * middlewares — {@link requestContext} followed by {@link addServices} — so a\n * single `.use(withServices([...]))` gives the handler both a request context\n * and the resolved services on `event.services`.\n *\n * @example\n * ```ts\n * import middy from '@middy/core';\n * import { withServices } from '@geekmidas/services/middy';\n *\n * export const handler = middy(async (event) => {\n * await event.services.database.users.deletePast();\n * event.services.cache.clear();\n * }).use(withServices([databaseService, cacheService], { envParser }));\n * ```\n */\nexport function withServices<\n\tconst T extends Service[],\n\tTLogger extends Logger = Logger,\n>(\n\tservices: [...T],\n\toptions: ServiceMiddlewareOptions<TLogger>,\n): [\n\tMiddlewareObj<unknown, unknown, Error, Context>,\n\tMiddlewareObj<EventServices<T>, unknown, Error, Context>,\n] {\n\treturn [requestContext(options), addServices(services, options)];\n}\n"],"mappings":";;;;AAwEA,SAAS,gBACRA,SACAC,OACAC,SACS;AAET,QAAO,QAAQ,eAAe,OAAO,QAAQ,IAAI,QAAQ;AACzD;AAED,SAAS,YACRC,YACAH,SACAI,WACAH,OACAC,SACS;AACT,QAAO,WAAW,MAAM;EACvB;EACA,GAAI,QAAQ,WAAW,OAAO,QAAQ,IAAI,CAAE;CAC5C,EAAC;AACF;;;;;;;;;;;;;;;;;;;;;AAsBD,SAAgB,eACfG,SACkD;CAClD,MAAM,aAAa,QAAQ;AAC3B,QAAO;EACN,QAAQ,CAAC,YAAY;GACpB,MAAM,EAAE,OAAO,SAAS,GAAG;GAC3B,MAAM,YAAY,gBAAgB,SAAS,OAAO,QAAQ;GAC1D,MAAM,SAAS,YACd,YACA,SACA,WACA,OACA,QACA;AACD,uBAAoB;IAAE;IAAQ;IAAW,WAAW,KAAK,KAAK;GAAE,EAAC;EACjE;EACD,OAAO,MAAM;AACZ,uBAAoB;EACpB;EACD,SAAS,MAAM;AACd,uBAAoB;EACpB;CACD;AACD;AAED,SAAS,iBAAiBC,SAAmD;AAC5E,QACC,QAAQ,oBAAoB,iBAAiB,YAAY,QAAQ,UAAU;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCD,SAAgB,YACfC,UACAD,SAC2D;CAC3D,MAAM,YAAY,iBAAiB,QAAQ;AAE3C,QAAO,EACN,QAAQ,OAAO,YAAY;EAC1B,MAAM,WAAW,MAAM,UAAU,SAAS,SAAS;EACnD,MAAM,QAAQ,QAAQ;AAEtB,QAAM,WAAW;GAAE,GAAI,MAAM,YAAY,CAAE;GAAG,GAAG;EAAU;CAC3D,EACD;AACD;;;;;;;;;;;;;;;;;;AAmBD,SAAgB,aAIfC,UACAC,SAIC;AACD,QAAO,CAAC,eAAe,QAAQ,EAAE,YAAY,UAAU,QAAQ,AAAC;AAChE"}
|
package/dist/trpc.cjs
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
const require_context = require('./context-Cf2Ig5qr.cjs');
|
|
2
|
+
const require_ServiceDiscovery = require('./ServiceDiscovery-m3XkNh32.cjs');
|
|
3
|
+
const node_crypto = require_context.__toESM(require("node:crypto"));
|
|
4
|
+
|
|
5
|
+
//#region src/trpc.ts
|
|
6
|
+
function createServicesMiddleware(mw, envParser) {
|
|
7
|
+
return (services) => {
|
|
8
|
+
const builder = mw(async (opts) => {
|
|
9
|
+
const ctx = opts.ctx;
|
|
10
|
+
const discovery = ctx.serviceDiscovery ?? require_ServiceDiscovery.ServiceDiscovery.getInstance(envParser ?? (() => {
|
|
11
|
+
throw new Error("createServicesMiddleware: no `envParser` provided and `ctx.serviceDiscovery` is missing. Pass an EnvironmentParser to createServicesMiddleware(), or attach a ServiceDiscovery instance to the tRPC context.");
|
|
12
|
+
})());
|
|
13
|
+
const requestId = ctx.requestId ?? (0, node_crypto.randomUUID)();
|
|
14
|
+
const startTime = ctx.startTime ?? Date.now();
|
|
15
|
+
return require_context.runWithRequestContext({
|
|
16
|
+
logger: ctx.logger,
|
|
17
|
+
requestId,
|
|
18
|
+
startTime
|
|
19
|
+
}, async () => {
|
|
20
|
+
const resolved = await discovery.register(services);
|
|
21
|
+
return opts.next({ ctx: {
|
|
22
|
+
...opts.ctx,
|
|
23
|
+
...resolved
|
|
24
|
+
} });
|
|
25
|
+
});
|
|
26
|
+
});
|
|
27
|
+
const middlewares = builder._middlewares;
|
|
28
|
+
if (middlewares?.length) {
|
|
29
|
+
const last = middlewares[middlewares.length - 1];
|
|
30
|
+
if (last) last._services = services;
|
|
31
|
+
}
|
|
32
|
+
return builder;
|
|
33
|
+
};
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Create a tRPC middleware that establishes a request context for downstream
|
|
37
|
+
* code without resolving any services. Useful when services aren't needed on
|
|
38
|
+
* a procedure but the handler (or libraries it calls) still wants to read
|
|
39
|
+
* `serviceContext.getLogger()` / `getRequestId()` / `getRequestStartTime()`.
|
|
40
|
+
*
|
|
41
|
+
* `requestId` and `startTime` are pulled from the tRPC context when present,
|
|
42
|
+
* otherwise generated (`randomUUID()` and `Date.now()`).
|
|
43
|
+
*
|
|
44
|
+
* @example
|
|
45
|
+
* ```ts
|
|
46
|
+
* const withRequestContext = createRequestContextMiddleware(t.middleware);
|
|
47
|
+
* export const baseProcedure = t.procedure.use(withRequestContext);
|
|
48
|
+
* ```
|
|
49
|
+
*/
|
|
50
|
+
function createRequestContextMiddleware(mw) {
|
|
51
|
+
return mw(async (opts) => {
|
|
52
|
+
const ctx = opts.ctx;
|
|
53
|
+
const requestId = ctx.requestId ?? (0, node_crypto.randomUUID)();
|
|
54
|
+
const startTime = ctx.startTime ?? Date.now();
|
|
55
|
+
return require_context.runWithRequestContext({
|
|
56
|
+
logger: ctx.logger,
|
|
57
|
+
requestId,
|
|
58
|
+
startTime
|
|
59
|
+
}, () => opts.next());
|
|
60
|
+
});
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
//#endregion
|
|
64
|
+
exports.createRequestContextMiddleware = createRequestContextMiddleware;
|
|
65
|
+
exports.createServicesMiddleware = createServicesMiddleware;
|
|
66
|
+
//# sourceMappingURL=trpc.cjs.map
|