@geekmidas/services 1.0.4 → 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 +13 -0
- package/dist/{ServiceDiscovery-CadEgTKz.d.mts → ServiceDiscovery-BO8W-RY8.d.cts} +2 -2
- package/dist/{ServiceDiscovery-DF4OKEZp.d.cts.map → ServiceDiscovery-BO8W-RY8.d.cts.map} +1 -1
- package/dist/{ServiceDiscovery-DF4OKEZp.d.cts → ServiceDiscovery-CRq_bGbi.d.mts} +2 -2
- package/dist/{ServiceDiscovery-CadEgTKz.d.mts.map → ServiceDiscovery-CRq_bGbi.d.mts.map} +1 -1
- package/dist/{ServiceDiscovery-SujDuYHr.mjs → ServiceDiscovery-DO_uDfuG.mjs} +2 -2
- package/dist/{ServiceDiscovery-SujDuYHr.mjs.map → ServiceDiscovery-DO_uDfuG.mjs.map} +1 -1
- package/dist/{ServiceDiscovery-Cxus7ber.cjs → ServiceDiscovery-m3XkNh32.cjs} +2 -2
- package/dist/{ServiceDiscovery-Cxus7ber.cjs.map → ServiceDiscovery-m3XkNh32.cjs.map} +1 -1
- package/dist/{context-BojeLlxs.mjs → context-C9DCrFWA.mjs} +5 -2
- package/dist/context-C9DCrFWA.mjs.map +1 -0
- package/dist/{context-D5pIUGkm.d.cts → context-CU-87vsM.d.mts} +2 -2
- package/dist/{context-D5pIUGkm.d.cts.map → context-CU-87vsM.d.mts.map} +1 -1
- package/dist/{context-CkCPt2Fe.cjs → context-Cf2Ig5qr.cjs} +11 -2
- package/dist/context-Cf2Ig5qr.cjs.map +1 -0
- package/dist/{context-OmKid3Mr.d.mts → context-D2owD3ac.d.cts} +2 -2
- package/dist/{context-OmKid3Mr.d.mts.map → context-D2owD3ac.d.cts.map} +1 -1
- 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-B99KrvXR.d.mts → types-Bgk-0NOO.d.cts} +2 -2
- package/dist/{types-B99KrvXR.d.mts.map → types-Bgk-0NOO.d.cts.map} +1 -1
- package/dist/{types-BY9yrY6Y.d.cts → types-BoyOCa57.d.mts} +2 -2
- package/dist/{types-BY9yrY6Y.d.cts.map → types-BoyOCa57.d.mts.map} +1 -1
- package/docs/request-scoped-logging.md +14 -0
- package/package.json +37 -1
- package/src/__tests__/middy.spec.ts +218 -0
- package/src/__tests__/trpc.spec.ts +218 -0
- package/src/context.ts +7 -5
- package/src/middy.ts +226 -0
- package/src/trpc.ts +190 -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-BojeLlxs.mjs.map +0 -1
- package/dist/context-CkCPt2Fe.cjs.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/trpc.d.mts
ADDED
|
@@ -0,0 +1,86 @@
|
|
|
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 { TRPCMiddlewareBuilder, TRPCMiddlewareFunction } from "@trpc/server";
|
|
6
|
+
|
|
7
|
+
//#region src/trpc.d.ts
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Shape of `t.middleware` from `@trpc/server`. We accept this rather than the
|
|
11
|
+
* initialized `t` object so callers retain ownership of their tRPC instance
|
|
12
|
+
* (no double-initialization, no opinion on context/meta shape).
|
|
13
|
+
*/
|
|
14
|
+
type CreateMiddleware<TContext, TMeta> = <$ContextOverrides>(fn: TRPCMiddlewareFunction<TContext, TMeta, object, $ContextOverrides, unknown>) => TRPCMiddlewareBuilder<TContext, TMeta, $ContextOverrides, unknown>;
|
|
15
|
+
/**
|
|
16
|
+
* Result of `createServicesMiddleware`: a function that accepts a service
|
|
17
|
+
* tuple and returns a tRPC middleware that merges resolved services onto the
|
|
18
|
+
* context.
|
|
19
|
+
*/
|
|
20
|
+
type ServicesMiddleware<TContext extends object, TMeta extends object> = <const T extends Service[]>(services: [...T]) => TRPCMiddlewareBuilder<TContext, TMeta, ServiceRecord<T>, unknown>;
|
|
21
|
+
/**
|
|
22
|
+
* Context shape required by `createServicesMiddleware` overload 2.
|
|
23
|
+
* Procedures that pull services via context-stored discovery must expose it
|
|
24
|
+
* under `serviceDiscovery`.
|
|
25
|
+
*/
|
|
26
|
+
interface ContextWithServiceDiscovery {
|
|
27
|
+
serviceDiscovery: ServiceDiscovery;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Minimum context required for request-context propagation. `logger` must be
|
|
31
|
+
* present so services can call `serviceContext.getLogger()`. `requestId` and
|
|
32
|
+
* `startTime` are auto-generated if missing.
|
|
33
|
+
*/
|
|
34
|
+
interface ContextWithLogger {
|
|
35
|
+
logger: Logger;
|
|
36
|
+
requestId?: string;
|
|
37
|
+
startTime?: number;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Create a tRPC middleware that:
|
|
41
|
+
*
|
|
42
|
+
* 1. Resolves the requested services via `ServiceDiscovery`.
|
|
43
|
+
* 2. Wraps the downstream call in `runWithRequestContext` so any code reached
|
|
44
|
+
* by the procedure (including service method implementations) can read the
|
|
45
|
+
* current logger/request id via `serviceContext`.
|
|
46
|
+
* 3. Merges the resolved services onto the tRPC context so handlers can access
|
|
47
|
+
* them by service name (`ctx.database`, `ctx.cache`, ...).
|
|
48
|
+
*
|
|
49
|
+
* Two overloads:
|
|
50
|
+
* - Pass an `envParser` to create a per-request `ServiceDiscovery` instance.
|
|
51
|
+
* - Omit `envParser` to read `ctx.serviceDiscovery` from the tRPC context.
|
|
52
|
+
*
|
|
53
|
+
* @example
|
|
54
|
+
* ```ts
|
|
55
|
+
* import { initTRPC } from '@trpc/server';
|
|
56
|
+
* import { createServicesMiddleware } from '@geekmidas/services/trpc';
|
|
57
|
+
*
|
|
58
|
+
* const t = initTRPC.context<Context>().create();
|
|
59
|
+
* const withServices = createServicesMiddleware(t.middleware, envParser);
|
|
60
|
+
*
|
|
61
|
+
* export const authedProcedure = t.procedure.use(
|
|
62
|
+
* withServices([databaseService, cacheService]),
|
|
63
|
+
* );
|
|
64
|
+
* ```
|
|
65
|
+
*/
|
|
66
|
+
declare function createServicesMiddleware<TContext extends ContextWithLogger & object, TMeta extends object>(mw: CreateMiddleware<TContext, TMeta>, envParser: EnvironmentParser<{}>): ServicesMiddleware<TContext, TMeta>;
|
|
67
|
+
declare function createServicesMiddleware<TContext extends ContextWithLogger & ContextWithServiceDiscovery & object, TMeta extends object>(mw: CreateMiddleware<TContext, TMeta>): ServicesMiddleware<TContext, TMeta>;
|
|
68
|
+
/**
|
|
69
|
+
* Create a tRPC middleware that establishes a request context for downstream
|
|
70
|
+
* code without resolving any services. Useful when services aren't needed on
|
|
71
|
+
* a procedure but the handler (or libraries it calls) still wants to read
|
|
72
|
+
* `serviceContext.getLogger()` / `getRequestId()` / `getRequestStartTime()`.
|
|
73
|
+
*
|
|
74
|
+
* `requestId` and `startTime` are pulled from the tRPC context when present,
|
|
75
|
+
* otherwise generated (`randomUUID()` and `Date.now()`).
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* ```ts
|
|
79
|
+
* const withRequestContext = createRequestContextMiddleware(t.middleware);
|
|
80
|
+
* export const baseProcedure = t.procedure.use(withRequestContext);
|
|
81
|
+
* ```
|
|
82
|
+
*/
|
|
83
|
+
declare function createRequestContextMiddleware<TContext extends ContextWithLogger & object, TMeta extends object>(mw: CreateMiddleware<TContext, TMeta>): TRPCMiddlewareBuilder<TContext, TMeta, object, unknown>;
|
|
84
|
+
//#endregion
|
|
85
|
+
export { ContextWithLogger, ContextWithServiceDiscovery, ServicesMiddleware, createRequestContextMiddleware, createServicesMiddleware };
|
|
86
|
+
//# sourceMappingURL=trpc.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"trpc.d.mts","names":[],"sources":["../src/trpc.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;AASuC;;;KAOlC,gBAGH,CAAA,QAAA,EAAA,KAAA,CAAA,GAAA,CAAA,iBAAA,CAAA,CAAA,EAAA,EAFG,sBAEH,CADA,QACA,EAAA,KAAA,EAAA,MAAA,EAEA,iBAFA,EAAA,OAAA,CAAA,EAAA,GAKG,qBALH,CAKyB,QALzB,EAKmC,KALnC,EAK0C,iBAL1C,EAAA,OAAA,CAAA;;;;;;AAKG,KAOO,kBAPP,CAAA,iBAAA,MAAA,EAAA,cAAA,MAAA,CAAA,GAAA,CAAA,gBAUgB,OAVhB,EAAA,CAAA,CAAA,QAAA,EAAA,CAAA,GAWU,CAXV,CAAA,EAAA,GAYA,qBAZA,CAYsB,QAZtB,EAYgC,KAZhC,EAYuC,aAZvC,CAYqD,CAZrD,CAAA,EAAA,OAAA,CAAA;AAAqB;AAO1B;;;;AAK2B,UAOV,2BAAA,CAPU;EAAQ,gBAAE,EAQlB,gBARkB;;;;AAAX;AAO1B;AASA;AAiCgB,UAjCC,iBAAA,CAiCuB;EAAA,MAAA,EAhC/B,MAgC+B;EAAA,SACtB,CAAA,EAAA,MAAA;EAAiB,SAGb,CAAA,EAAA,MAAA;;;;;;;AAED;AACrB;;;;;;;;;;AAG4D;AA+E5D;;;;;;;;;AAKwB;iBA9FR,0CACE,sDAGb,iBAAiB,UAAU,mBACpB,wBACT,mBAAmB,UAAU;iBAChB,0CACE,oBAAoB,gEAEhC,iBAAiB,UAAU,SAAS,mBAAmB,UAAU;;;;;;;;;;;;;;;;iBA+EvD,gDACE,sDAGb,iBAAiB,UAAU,SAC7B,sBAAsB,UAAU"}
|
package/dist/trpc.mjs
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { runWithRequestContext } from "./context-C9DCrFWA.mjs";
|
|
2
|
+
import { ServiceDiscovery } from "./ServiceDiscovery-DO_uDfuG.mjs";
|
|
3
|
+
import { randomUUID } from "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 ?? 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 ?? randomUUID();
|
|
14
|
+
const startTime = ctx.startTime ?? Date.now();
|
|
15
|
+
return 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 ?? randomUUID();
|
|
54
|
+
const startTime = ctx.startTime ?? Date.now();
|
|
55
|
+
return runWithRequestContext({
|
|
56
|
+
logger: ctx.logger,
|
|
57
|
+
requestId,
|
|
58
|
+
startTime
|
|
59
|
+
}, () => opts.next());
|
|
60
|
+
});
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
//#endregion
|
|
64
|
+
export { createRequestContextMiddleware, createServicesMiddleware };
|
|
65
|
+
//# sourceMappingURL=trpc.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"trpc.mjs","names":["mw: CreateMiddleware<TContext, TMeta>","envParser?: EnvironmentParser<{}>","services: [...T]"],"sources":["../src/trpc.ts"],"sourcesContent":["import { randomUUID } from 'node:crypto';\nimport type { EnvironmentParser } from '@geekmidas/envkit';\nimport type { Logger } from '@geekmidas/logger';\nimport type {\n\tTRPCMiddlewareBuilder,\n\tTRPCMiddlewareFunction,\n} from '@trpc/server';\nimport { runWithRequestContext } from './context';\nimport { ServiceDiscovery, type ServiceRecord } from './ServiceDiscovery';\nimport type { Service } from './types';\n\n/**\n * Shape of `t.middleware` from `@trpc/server`. We accept this rather than the\n * initialized `t` object so callers retain ownership of their tRPC instance\n * (no double-initialization, no opinion on context/meta shape).\n */\ntype CreateMiddleware<TContext, TMeta> = <$ContextOverrides>(\n\tfn: TRPCMiddlewareFunction<\n\t\tTContext,\n\t\tTMeta,\n\t\tobject,\n\t\t$ContextOverrides,\n\t\tunknown\n\t>,\n) => TRPCMiddlewareBuilder<TContext, TMeta, $ContextOverrides, unknown>;\n\n/**\n * Result of `createServicesMiddleware`: a function that accepts a service\n * tuple and returns a tRPC middleware that merges resolved services onto the\n * context.\n */\nexport type ServicesMiddleware<\n\tTContext extends object,\n\tTMeta extends object,\n> = <const T extends Service[]>(\n\tservices: [...T],\n) => TRPCMiddlewareBuilder<TContext, TMeta, ServiceRecord<T>, unknown>;\n\n/**\n * Context shape required by `createServicesMiddleware` overload 2.\n * Procedures that pull services via context-stored discovery must expose it\n * under `serviceDiscovery`.\n */\nexport interface ContextWithServiceDiscovery {\n\tserviceDiscovery: ServiceDiscovery;\n}\n\n/**\n * Minimum context required for request-context propagation. `logger` must be\n * present so services can call `serviceContext.getLogger()`. `requestId` and\n * `startTime` are auto-generated if missing.\n */\nexport interface ContextWithLogger {\n\tlogger: Logger;\n\trequestId?: string;\n\tstartTime?: number;\n}\n\n/**\n * Create a tRPC middleware that:\n *\n * 1. Resolves the requested services via `ServiceDiscovery`.\n * 2. Wraps the downstream call in `runWithRequestContext` so any code reached\n * by the procedure (including service method implementations) can read the\n * current logger/request id via `serviceContext`.\n * 3. Merges the resolved services onto the tRPC context so handlers can access\n * them by service name (`ctx.database`, `ctx.cache`, ...).\n *\n * Two overloads:\n * - Pass an `envParser` to create a per-request `ServiceDiscovery` instance.\n * - Omit `envParser` to read `ctx.serviceDiscovery` from the tRPC context.\n *\n * @example\n * ```ts\n * import { initTRPC } from '@trpc/server';\n * import { createServicesMiddleware } from '@geekmidas/services/trpc';\n *\n * const t = initTRPC.context<Context>().create();\n * const withServices = createServicesMiddleware(t.middleware, envParser);\n *\n * export const authedProcedure = t.procedure.use(\n * withServices([databaseService, cacheService]),\n * );\n * ```\n */\nexport function createServicesMiddleware<\n\tTContext extends ContextWithLogger & object,\n\tTMeta extends object,\n>(\n\tmw: CreateMiddleware<TContext, TMeta>,\n\tenvParser: EnvironmentParser<{}>,\n): ServicesMiddleware<TContext, TMeta>;\nexport function createServicesMiddleware<\n\tTContext extends ContextWithLogger & ContextWithServiceDiscovery & object,\n\tTMeta extends object,\n>(mw: CreateMiddleware<TContext, TMeta>): ServicesMiddleware<TContext, TMeta>;\nexport function createServicesMiddleware<\n\tTContext extends ContextWithLogger & object,\n\tTMeta extends object,\n>(\n\tmw: CreateMiddleware<TContext, TMeta>,\n\tenvParser?: EnvironmentParser<{}>,\n): ServicesMiddleware<TContext, TMeta> {\n\treturn (<const T extends Service[]>(services: [...T]) => {\n\t\tconst builder = mw(async (opts) => {\n\t\t\tconst ctx = opts.ctx as TContext & Partial<ContextWithServiceDiscovery>;\n\n\t\t\tconst discovery =\n\t\t\t\tctx.serviceDiscovery ??\n\t\t\t\tServiceDiscovery.getInstance(\n\t\t\t\t\tenvParser ??\n\t\t\t\t\t\t(() => {\n\t\t\t\t\t\t\t// Hit only if overload 2 was selected but ctx.serviceDiscovery is\n\t\t\t\t\t\t\t// missing at runtime — surface the mistake immediately rather\n\t\t\t\t\t\t\t// than letting an undefined env parser fail deep inside register.\n\t\t\t\t\t\t\tthrow new Error(\n\t\t\t\t\t\t\t\t'createServicesMiddleware: no `envParser` provided and ' +\n\t\t\t\t\t\t\t\t\t'`ctx.serviceDiscovery` is missing. Pass an EnvironmentParser ' +\n\t\t\t\t\t\t\t\t\t'to createServicesMiddleware(), or attach a ServiceDiscovery ' +\n\t\t\t\t\t\t\t\t\t'instance to the tRPC context.',\n\t\t\t\t\t\t\t);\n\t\t\t\t\t\t})(),\n\t\t\t\t);\n\n\t\t\tconst requestId = ctx.requestId ?? randomUUID();\n\t\t\tconst startTime = ctx.startTime ?? Date.now();\n\n\t\t\treturn runWithRequestContext(\n\t\t\t\t{ logger: ctx.logger, requestId, startTime },\n\t\t\t\tasync () => {\n\t\t\t\t\tconst resolved = await discovery.register(services);\n\t\t\t\t\treturn opts.next({\n\t\t\t\t\t\tctx: { ...opts.ctx, ...resolved } as typeof opts.ctx &\n\t\t\t\t\t\t\tServiceRecord<T>,\n\t\t\t\t\t});\n\t\t\t\t},\n\t\t\t);\n\t\t});\n\n\t\t// Tag the inner middleware function with the requested services so external\n\t\t// tooling (e.g. detect-procedures route generators) can introspect a\n\t\t// procedure's service dependencies without re-executing middleware.\n\t\tconst middlewares = (\n\t\t\tbuilder as unknown as { _middlewares?: Array<{ _services?: Service[] }> }\n\t\t)._middlewares;\n\t\tif (middlewares?.length) {\n\t\t\tconst last = middlewares[middlewares.length - 1];\n\t\t\tif (last) last._services = services as unknown as Service[];\n\t\t}\n\n\t\treturn builder as TRPCMiddlewareBuilder<\n\t\t\tTContext,\n\t\t\tTMeta,\n\t\t\tServiceRecord<T>,\n\t\t\tunknown\n\t\t>;\n\t}) as ServicesMiddleware<TContext, TMeta>;\n}\n\n/**\n * Create a tRPC middleware that establishes a request context for downstream\n * code without resolving any services. Useful when services aren't needed on\n * a procedure but the handler (or libraries it calls) still wants to read\n * `serviceContext.getLogger()` / `getRequestId()` / `getRequestStartTime()`.\n *\n * `requestId` and `startTime` are pulled from the tRPC context when present,\n * otherwise generated (`randomUUID()` and `Date.now()`).\n *\n * @example\n * ```ts\n * const withRequestContext = createRequestContextMiddleware(t.middleware);\n * export const baseProcedure = t.procedure.use(withRequestContext);\n * ```\n */\nexport function createRequestContextMiddleware<\n\tTContext extends ContextWithLogger & object,\n\tTMeta extends object,\n>(\n\tmw: CreateMiddleware<TContext, TMeta>,\n): TRPCMiddlewareBuilder<TContext, TMeta, object, unknown> {\n\treturn mw(async (opts) => {\n\t\tconst ctx = opts.ctx as TContext;\n\t\tconst requestId = ctx.requestId ?? randomUUID();\n\t\tconst startTime = ctx.startTime ?? Date.now();\n\t\treturn runWithRequestContext(\n\t\t\t{ logger: ctx.logger, requestId, startTime },\n\t\t\t() => opts.next(),\n\t\t);\n\t});\n}\n"],"mappings":";;;;;AAgGA,SAAgB,yBAIfA,IACAC,WACsC;AACtC,QAAQ,CAA4BC,aAAqB;EACxD,MAAM,UAAU,GAAG,OAAO,SAAS;GAClC,MAAM,MAAM,KAAK;GAEjB,MAAM,YACL,IAAI,oBACJ,iBAAiB,YAChB,aACC,CAAC,MAAM;AAIN,UAAM,IAAI,MACT;GAKD,IAAG,CACL;GAEF,MAAM,YAAY,IAAI,aAAa,YAAY;GAC/C,MAAM,YAAY,IAAI,aAAa,KAAK,KAAK;AAE7C,UAAO,sBACN;IAAE,QAAQ,IAAI;IAAQ;IAAW;GAAW,GAC5C,YAAY;IACX,MAAM,WAAW,MAAM,UAAU,SAAS,SAAS;AACnD,WAAO,KAAK,KAAK,EAChB,KAAK;KAAE,GAAG,KAAK;KAAK,GAAG;IAAU,EAEjC,EAAC;GACF,EACD;EACD,EAAC;EAKF,MAAM,cACL,QACC;AACF,MAAI,aAAa,QAAQ;GACxB,MAAM,OAAO,YAAY,YAAY,SAAS;AAC9C,OAAI,KAAM,MAAK,YAAY;EAC3B;AAED,SAAO;CAMP;AACD;;;;;;;;;;;;;;;;AAiBD,SAAgB,+BAIfF,IAC0D;AAC1D,QAAO,GAAG,OAAO,SAAS;EACzB,MAAM,MAAM,KAAK;EACjB,MAAM,YAAY,IAAI,aAAa,YAAY;EAC/C,MAAM,YAAY,IAAI,aAAa,KAAK,KAAK;AAC7C,SAAO,sBACN;GAAE,QAAQ,IAAI;GAAQ;GAAW;EAAW,GAC5C,MAAM,KAAK,MAAM,CACjB;CACD,EAAC;AACF"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { EnvironmentParser } from "@geekmidas/envkit";
|
|
2
1
|
import { Logger } from "@geekmidas/logger";
|
|
2
|
+
import { EnvironmentParser } from "@geekmidas/envkit";
|
|
3
3
|
|
|
4
4
|
//#region src/types.d.ts
|
|
5
5
|
|
|
@@ -90,4 +90,4 @@ interface Service<TName extends string = string, TInstance = unknown> {
|
|
|
90
90
|
//# sourceMappingURL=types.d.ts.map
|
|
91
91
|
//#endregion
|
|
92
92
|
export { Service, ServiceContext, ServiceRegisterOptions };
|
|
93
|
-
//# sourceMappingURL=types-
|
|
93
|
+
//# sourceMappingURL=types-Bgk-0NOO.d.cts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types-
|
|
1
|
+
{"version":3,"file":"types-Bgk-0NOO.d.cts","names":[],"sources":["../src/types.ts"],"sourcesContent":[],"mappings":";;;;;;;AAQA;AAqCA;;AAEY,UAvCK,cAAA,CAuCL;EAAiB;AAEL;AA8BxB;;;;;;;AAW+D;;eAtEjD;;;;;;;;;;;;;;;;;;;;;UAyBG,sBAAA;;aAEL;;WAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UA8BO;;;;eAIH;;;;;;;oBAOK,yBAAyB,YAAY,QAAQ"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { EnvironmentParser } from "@geekmidas/envkit";
|
|
2
1
|
import { Logger } from "@geekmidas/logger";
|
|
2
|
+
import { EnvironmentParser } from "@geekmidas/envkit";
|
|
3
3
|
|
|
4
4
|
//#region src/types.d.ts
|
|
5
5
|
|
|
@@ -90,4 +90,4 @@ interface Service<TName extends string = string, TInstance = unknown> {
|
|
|
90
90
|
//# sourceMappingURL=types.d.ts.map
|
|
91
91
|
//#endregion
|
|
92
92
|
export { Service, ServiceContext, ServiceRegisterOptions };
|
|
93
|
-
//# sourceMappingURL=types-
|
|
93
|
+
//# sourceMappingURL=types-BoyOCa57.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types-
|
|
1
|
+
{"version":3,"file":"types-BoyOCa57.d.mts","names":[],"sources":["../src/types.ts"],"sourcesContent":[],"mappings":";;;;;;;AAQA;AAqCA;;AAEY,UAvCK,cAAA,CAuCL;EAAiB;AAEL;AA8BxB;;;;;;;AAW+D;;eAtEjD;;;;;;;;;;;;;;;;;;;;;UAyBG,sBAAA;;aAEL;;WAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UA8BO;;;;eAIH;;;;;;;oBAOK,yBAAyB,YAAY,QAAQ"}
|
|
@@ -151,3 +151,17 @@ Regression coverage lives in
|
|
|
151
151
|
- `child loggers also follow the current request` — the same guarantee for
|
|
152
152
|
`.child()` proxies.
|
|
153
153
|
- `should delegate to the current request logger` — basic delegation.
|
|
154
|
+
|
|
155
|
+
## Establishing the context
|
|
156
|
+
|
|
157
|
+
The request context this relies on is established by the adaptors that run your
|
|
158
|
+
code:
|
|
159
|
+
|
|
160
|
+
- **Constructs** (`Endpoint`, `Function`, `Cron`, `Subscriber`) wrap each
|
|
161
|
+
invocation in `runWithRequestContext` automatically.
|
|
162
|
+
- **Standalone Middy handlers** can opt in with the
|
|
163
|
+
`@geekmidas/services/middy` middlewares (`requestContext`, `addServices`,
|
|
164
|
+
`withServices`), which establish the context (and optionally resolve services)
|
|
165
|
+
before the handler runs.
|
|
166
|
+
- **Tests** can use `@geekmidas/testkit`'s `runInRequestContext` /
|
|
167
|
+
`requestContextFixture`.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@geekmidas/services",
|
|
3
|
-
"version": "1.0
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"private": false,
|
|
5
5
|
"type": "module",
|
|
6
6
|
"exports": {
|
|
@@ -23,6 +23,26 @@
|
|
|
23
23
|
"types": "./dist/context.d.cts",
|
|
24
24
|
"default": "./dist/context.cjs"
|
|
25
25
|
}
|
|
26
|
+
},
|
|
27
|
+
"./trpc": {
|
|
28
|
+
"import": {
|
|
29
|
+
"types": "./dist/trpc.d.mts",
|
|
30
|
+
"default": "./dist/trpc.mjs"
|
|
31
|
+
},
|
|
32
|
+
"require": {
|
|
33
|
+
"types": "./dist/trpc.d.cts",
|
|
34
|
+
"default": "./dist/trpc.cjs"
|
|
35
|
+
}
|
|
36
|
+
},
|
|
37
|
+
"./middy": {
|
|
38
|
+
"import": {
|
|
39
|
+
"types": "./dist/middy.d.mts",
|
|
40
|
+
"default": "./dist/middy.mjs"
|
|
41
|
+
},
|
|
42
|
+
"require": {
|
|
43
|
+
"types": "./dist/middy.d.cts",
|
|
44
|
+
"default": "./dist/middy.cjs"
|
|
45
|
+
}
|
|
26
46
|
}
|
|
27
47
|
},
|
|
28
48
|
"repository": {
|
|
@@ -35,6 +55,9 @@
|
|
|
35
55
|
},
|
|
36
56
|
"dependencies": {},
|
|
37
57
|
"peerDependencies": {
|
|
58
|
+
"@middy/core": ">=6.3.1",
|
|
59
|
+
"@trpc/server": ">=11.0.0",
|
|
60
|
+
"@types/aws-lambda": ">=8.10.92",
|
|
38
61
|
"@geekmidas/envkit": "^1.0.7",
|
|
39
62
|
"@geekmidas/logger": "^1.0.2"
|
|
40
63
|
},
|
|
@@ -44,9 +67,22 @@
|
|
|
44
67
|
},
|
|
45
68
|
"@geekmidas/logger": {
|
|
46
69
|
"optional": true
|
|
70
|
+
},
|
|
71
|
+
"@middy/core": {
|
|
72
|
+
"optional": true
|
|
73
|
+
},
|
|
74
|
+
"@trpc/server": {
|
|
75
|
+
"optional": true
|
|
76
|
+
},
|
|
77
|
+
"@types/aws-lambda": {
|
|
78
|
+
"optional": true
|
|
47
79
|
}
|
|
48
80
|
},
|
|
49
81
|
"devDependencies": {
|
|
82
|
+
"@middy/core": "~6.3.2",
|
|
83
|
+
"@trpc/server": "~11.16.0",
|
|
84
|
+
"@types/aws-lambda": "~8.10.147",
|
|
85
|
+
"@types/node": "~24.9.1",
|
|
50
86
|
"@geekmidas/envkit": "^1.0.7",
|
|
51
87
|
"@geekmidas/logger": "^1.0.2"
|
|
52
88
|
},
|
|
@@ -0,0 +1,218 @@
|
|
|
1
|
+
import { EnvironmentParser } from '@geekmidas/envkit';
|
|
2
|
+
import type { Logger } from '@geekmidas/logger';
|
|
3
|
+
import middy from '@middy/core';
|
|
4
|
+
import type { Context } from 'aws-lambda';
|
|
5
|
+
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
|
6
|
+
import { serviceContext } from '../context';
|
|
7
|
+
import { addServices, requestContext, withServices } from '../middy';
|
|
8
|
+
import { ServiceDiscovery } from '../ServiceDiscovery';
|
|
9
|
+
import type { Service } from '../types';
|
|
10
|
+
|
|
11
|
+
const createMockContext = (): Context =>
|
|
12
|
+
({
|
|
13
|
+
functionName: 'standalone',
|
|
14
|
+
functionVersion: '1',
|
|
15
|
+
invokedFunctionArn:
|
|
16
|
+
'arn:aws:lambda:us-east-1:123456789012:function:standalone',
|
|
17
|
+
memoryLimitInMB: '128',
|
|
18
|
+
awsRequestId: 'aws-req-1',
|
|
19
|
+
logGroupName: '/aws/lambda/standalone',
|
|
20
|
+
logStreamName: 'stream',
|
|
21
|
+
getRemainingTimeInMillis: () => 30000,
|
|
22
|
+
done: vi.fn(),
|
|
23
|
+
fail: vi.fn(),
|
|
24
|
+
succeed: vi.fn(),
|
|
25
|
+
callbackWaitsForEmptyEventLoop: true,
|
|
26
|
+
}) as unknown as Context;
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Invoke a Middy-wrapped handler with a mock Lambda context. The service
|
|
30
|
+
* middlewares augment the context type to require `services`, but at runtime
|
|
31
|
+
* they populate it before the handler runs — so the mock starts without it and
|
|
32
|
+
* we invoke through a loosely-typed shim.
|
|
33
|
+
*/
|
|
34
|
+
const invoke = (
|
|
35
|
+
handler: (event: any, context: any) => any,
|
|
36
|
+
event: unknown = {},
|
|
37
|
+
): Promise<unknown> => Promise.resolve(handler(event, createMockContext()));
|
|
38
|
+
|
|
39
|
+
function makeSpyLogger(): Logger {
|
|
40
|
+
const logger: Logger = {
|
|
41
|
+
trace: vi.fn(),
|
|
42
|
+
debug: vi.fn(),
|
|
43
|
+
info: vi.fn(),
|
|
44
|
+
warn: vi.fn(),
|
|
45
|
+
error: vi.fn(),
|
|
46
|
+
fatal: vi.fn(),
|
|
47
|
+
child: vi.fn(() => logger),
|
|
48
|
+
};
|
|
49
|
+
return logger;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
interface Greeter {
|
|
53
|
+
greet(): string;
|
|
54
|
+
registeredRequestId: string;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
class GreeterService implements Service<'greeter', Greeter> {
|
|
58
|
+
serviceName = 'greeter' as const;
|
|
59
|
+
async register(): Promise<Greeter> {
|
|
60
|
+
// Service code can read the request context during registration.
|
|
61
|
+
const registeredRequestId = serviceContext.getRequestId();
|
|
62
|
+
return {
|
|
63
|
+
registeredRequestId,
|
|
64
|
+
greet() {
|
|
65
|
+
serviceContext.getLogger().info('greeting');
|
|
66
|
+
return 'hello';
|
|
67
|
+
},
|
|
68
|
+
};
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
interface Counter {
|
|
73
|
+
next(): number;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
class CounterService implements Service<'counter', Counter> {
|
|
77
|
+
serviceName = 'counter' as const;
|
|
78
|
+
async register(): Promise<Counter> {
|
|
79
|
+
let n = 0;
|
|
80
|
+
return { next: () => ++n };
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
describe('middy adaptor', () => {
|
|
85
|
+
beforeEach(() => {
|
|
86
|
+
// ServiceDiscovery is a process-wide singleton that caches resolved
|
|
87
|
+
// instances; reset so each test starts clean.
|
|
88
|
+
ServiceDiscovery.reset();
|
|
89
|
+
});
|
|
90
|
+
|
|
91
|
+
describe('requestContext', () => {
|
|
92
|
+
it('makes serviceContext available inside a plain handler', async () => {
|
|
93
|
+
const logger = makeSpyLogger();
|
|
94
|
+
let seenRequestId: string | undefined;
|
|
95
|
+
let hadContext = false;
|
|
96
|
+
|
|
97
|
+
const handler = middy(async () => {
|
|
98
|
+
hadContext = serviceContext.hasContext();
|
|
99
|
+
seenRequestId = serviceContext.getRequestId();
|
|
100
|
+
serviceContext.getLogger().info('tick');
|
|
101
|
+
}).use(requestContext({ logger }));
|
|
102
|
+
|
|
103
|
+
await invoke(handler);
|
|
104
|
+
|
|
105
|
+
expect(hadContext).toBe(true);
|
|
106
|
+
expect(seenRequestId).toBe('aws-req-1');
|
|
107
|
+
expect(logger.info).toHaveBeenCalledWith('tick');
|
|
108
|
+
});
|
|
109
|
+
|
|
110
|
+
it('gives each invocation its own fresh context', async () => {
|
|
111
|
+
const seen: string[] = [];
|
|
112
|
+
let counter = 0;
|
|
113
|
+
const handler = middy(async () => {
|
|
114
|
+
seen.push(serviceContext.getRequestId());
|
|
115
|
+
}).use(
|
|
116
|
+
requestContext({
|
|
117
|
+
logger: makeSpyLogger(),
|
|
118
|
+
getRequestId: () => `req-${++counter}`,
|
|
119
|
+
}),
|
|
120
|
+
);
|
|
121
|
+
|
|
122
|
+
await invoke(handler);
|
|
123
|
+
await invoke(handler);
|
|
124
|
+
|
|
125
|
+
// The second invocation must not inherit the first's request id.
|
|
126
|
+
expect(seen).toEqual(['req-1', 'req-2']);
|
|
127
|
+
});
|
|
128
|
+
|
|
129
|
+
it('propagates handler errors', async () => {
|
|
130
|
+
const handler = middy(async () => {
|
|
131
|
+
throw new Error('boom');
|
|
132
|
+
}).use(requestContext({ logger: makeSpyLogger() }));
|
|
133
|
+
|
|
134
|
+
await expect(invoke(handler)).rejects.toThrow('boom');
|
|
135
|
+
});
|
|
136
|
+
|
|
137
|
+
it('derives the request id via getRequestId override', async () => {
|
|
138
|
+
let seen: string | undefined;
|
|
139
|
+
const handler = middy(async () => {
|
|
140
|
+
seen = serviceContext.getRequestId();
|
|
141
|
+
}).use(
|
|
142
|
+
requestContext({
|
|
143
|
+
logger: makeSpyLogger(),
|
|
144
|
+
getRequestId: () => 'custom-id',
|
|
145
|
+
}),
|
|
146
|
+
);
|
|
147
|
+
|
|
148
|
+
await invoke(handler);
|
|
149
|
+
expect(seen).toBe('custom-id');
|
|
150
|
+
});
|
|
151
|
+
});
|
|
152
|
+
|
|
153
|
+
describe('addServices', () => {
|
|
154
|
+
it('resolves services onto event.services (paired with requestContext)', async () => {
|
|
155
|
+
const envParser = new EnvironmentParser({});
|
|
156
|
+
const logger = makeSpyLogger();
|
|
157
|
+
let greeting: string | undefined;
|
|
158
|
+
let counted: number | undefined;
|
|
159
|
+
let registeredRequestId: string | undefined;
|
|
160
|
+
|
|
161
|
+
const handler = middy(async (event: { services: any }) => {
|
|
162
|
+
registeredRequestId = event.services.greeter.registeredRequestId;
|
|
163
|
+
greeting = event.services.greeter.greet();
|
|
164
|
+
counted = event.services.counter.next();
|
|
165
|
+
})
|
|
166
|
+
.use(requestContext({ logger, getRequestId: () => 'shared-id' }))
|
|
167
|
+
.use(
|
|
168
|
+
addServices([new GreeterService(), new CounterService()], {
|
|
169
|
+
envParser,
|
|
170
|
+
}),
|
|
171
|
+
);
|
|
172
|
+
|
|
173
|
+
await invoke(handler);
|
|
174
|
+
|
|
175
|
+
expect(greeting).toBe('hello');
|
|
176
|
+
expect(counted).toBe(1);
|
|
177
|
+
// register() and the service method ran inside the requestContext.
|
|
178
|
+
expect(registeredRequestId).toBe('shared-id');
|
|
179
|
+
expect(logger.info).toHaveBeenCalledWith('greeting');
|
|
180
|
+
});
|
|
181
|
+
|
|
182
|
+
it('resolves context-free services without a requestContext', async () => {
|
|
183
|
+
const envParser = new EnvironmentParser({});
|
|
184
|
+
let counted: number | undefined;
|
|
185
|
+
|
|
186
|
+
const handler = middy(async (event: { services: any }) => {
|
|
187
|
+
counted = event.services.counter.next();
|
|
188
|
+
}).use(addServices([new CounterService()], { envParser }));
|
|
189
|
+
|
|
190
|
+
await invoke(handler);
|
|
191
|
+
|
|
192
|
+
expect(counted).toBe(1);
|
|
193
|
+
});
|
|
194
|
+
});
|
|
195
|
+
|
|
196
|
+
describe('withServices', () => {
|
|
197
|
+
it('establishes context and resolves services out of the box', async () => {
|
|
198
|
+
const envParser = new EnvironmentParser({});
|
|
199
|
+
let greeting: string | undefined;
|
|
200
|
+
let registeredRequestId: string | undefined;
|
|
201
|
+
|
|
202
|
+
const handler = middy(async (event: { services: any }) => {
|
|
203
|
+
registeredRequestId = event.services.greeter.registeredRequestId;
|
|
204
|
+
greeting = event.services.greeter.greet();
|
|
205
|
+
}).use(
|
|
206
|
+
withServices([new GreeterService()], {
|
|
207
|
+
logger: makeSpyLogger(),
|
|
208
|
+
envParser,
|
|
209
|
+
}),
|
|
210
|
+
);
|
|
211
|
+
|
|
212
|
+
await invoke(handler);
|
|
213
|
+
|
|
214
|
+
expect(greeting).toBe('hello');
|
|
215
|
+
expect(registeredRequestId).toBe('aws-req-1');
|
|
216
|
+
});
|
|
217
|
+
});
|
|
218
|
+
});
|