@gaganref/confect-server 10.3.1-fork.39 → 10.3.1-fork.40
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/dist/HttpRouter.d.ts +2 -0
- package/dist/HttpRouter.d.ts.map +1 -1
- package/dist/HttpRouter.js +14 -5
- package/dist/HttpRouter.js.map +1 -1
- package/package.json +2 -2
- package/src/HttpRouter.ts +54 -4
package/dist/HttpRouter.d.ts
CHANGED
|
@@ -67,6 +67,7 @@ export type Routes<Services_ = Services> = Layer.Layer<never, never, HttpRouter.
|
|
|
67
67
|
* precedence.
|
|
68
68
|
*/
|
|
69
69
|
export declare const make: <Id extends string, Groups extends HttpApiGroup.Constraint>(routes: Routes, options?: {
|
|
70
|
+
readonly observability?: Layer.Layer<never> | undefined;
|
|
70
71
|
readonly api?: HttpApi.HttpApi<Id, Groups> | undefined;
|
|
71
72
|
}) => ConvexHttpRouter;
|
|
72
73
|
/**
|
|
@@ -75,6 +76,7 @@ export declare const make: <Id extends string, Groups extends HttpApiGroup.Const
|
|
|
75
76
|
* Supply `{ api }` as in {@link make}; labels stay component-relative.
|
|
76
77
|
*/
|
|
77
78
|
export declare const forSchema: <DatabaseSchema_ extends DatabaseSchema.AnyWithProps>(schema: DatabaseSchema_) => <Id extends string, Groups extends HttpApiGroup.Constraint>(routes: Routes<Handler.ActionServices<DatabaseSchema_>>, options?: {
|
|
79
|
+
readonly observability?: Layer.Layer<never> | undefined;
|
|
78
80
|
readonly api?: HttpApi.HttpApi<Id, Groups> | undefined;
|
|
79
81
|
}) => ConvexHttpRouter;
|
|
80
82
|
//# sourceMappingURL=HttpRouter.d.ts.map
|
package/dist/HttpRouter.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"HttpRouter.d.ts","sourceRoot":"","sources":["../src/HttpRouter.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,UAAU,IAAI,gBAAgB,EAOpC,MAAM,eAAe,CAAC;AAMvB,OAAO,KAAK,KAAK,UAAU,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AAEtC,OAAO,KAAK,KAAK,IAAI,MAAM,aAAa,CAAC;AAIzC,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AACnD,OAAO,KAAK,KAAK,YAAY,MAAM,8BAA8B,CAAC;AAClE,OAAO,KAAK,KAAK,IAAI,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,KAAK,YAAY,MAAM,0BAA0B,CAAC;AAC9D,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;
|
|
1
|
+
{"version":3,"file":"HttpRouter.d.ts","sourceRoot":"","sources":["../src/HttpRouter.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,UAAU,IAAI,gBAAgB,EAOpC,MAAM,eAAe,CAAC;AAMvB,OAAO,KAAK,KAAK,UAAU,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AAEtC,OAAO,KAAK,KAAK,IAAI,MAAM,aAAa,CAAC;AAIzC,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AACnD,OAAO,KAAK,KAAK,YAAY,MAAM,8BAA8B,CAAC;AAClE,OAAO,KAAK,KAAK,IAAI,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,KAAK,YAAY,MAAM,0BAA0B,CAAC;AAC9D,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;AAIrD,OAAO,KAAK,KAAK,YAAY,MAAM,mBAAmB,CAAC;AACvD,OAAO,KAAK,KAAK,IAAI,MAAM,WAAW,CAAC;AACvC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,KAAK,cAAc,MAAM,qBAAqB,CAAC;AAE3D,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAC;AAI7C,OAAO,KAAK,KAAK,cAAc,MAAM,qBAAqB,CAAC;AAC3D,OAAO,KAAK,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAErD,OAAO,KAAK,KAAK,SAAS,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAExD;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAChB,WAAW,CAAC,WAAW,GACvB,cAAc,CAAC,cAAc,GAC7B,YAAY,CAAC,YAAY,GACzB,SAAS,CAAC,SAAS,GACnB,IAAI,CAAC,IAAI,GACT,iBAAiB,GACjB,eAAe,GACf,OAAO,GACP,aAAa,GACb,aAAa,GACb,mBAAmB,CAAC;AAExB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,MAAM,CAAC,SAAS,GAAG,QAAQ,IAAI,KAAK,CAAC,KAAK,CACpD,KAAK,EACL,KAAK,EACH,UAAU,CAAC,UAAU,GACrB,IAAI,CAAC,SAAS,GACd,UAAU,CAAC,UAAU,GACrB,YAAY,CAAC,YAAY,GACzB,IAAI,CAAC,IAAI,GACT,UAAU,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC,GACzC,UAAU,CAAC,OAAO,CAAC,gBAAgB,EAAE,SAAS,CAAC,GAC/C,UAAU,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,GAChC,UAAU,CAAC,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC,CACzC,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,IAAI,GAAI,EAAE,SAAS,MAAM,EAAE,MAAM,SAAS,YAAY,CAAC,UAAU,UACpE,MAAM,YACJ;IACR,QAAQ,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IACxD,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;CACxD,KACA,gBAMA,CAAC;AAEJ;;;;GAIG;AACH,eAAO,MAAM,SAAS,GACnB,eAAe,SAAS,cAAc,CAAC,YAAY,UAC1C,eAAe,MAExB,EAAE,SAAS,MAAM,EAAE,MAAM,SAAS,YAAY,CAAC,UAAU,UAChD,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC,YAC7C;IACR,QAAQ,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IACxD,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;CACxD,KACA,gBAkBA,CAAC"}
|
package/dist/HttpRouter.js
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { __exportAll } from "./_virtual/_rolldown/runtime.js";
|
|
2
2
|
import { layer } from "./ConvexConfigProvider.js";
|
|
3
3
|
import { layer as layer$1 } from "./ConvexLogger.js";
|
|
4
|
+
import { memoized } from "./internal/observability.js";
|
|
4
5
|
import { actionLayer, baseActionLayer } from "./RegisteredFunction.js";
|
|
5
6
|
import * as Context from "effect/Context";
|
|
6
7
|
import * as Effect from "effect/Effect";
|
|
@@ -15,6 +16,7 @@ import * as Config from "effect/Config";
|
|
|
15
16
|
import * as FindMyWay from "effect/http/FindMyWay";
|
|
16
17
|
import * as HttpApi from "effect/http-api/HttpApi";
|
|
17
18
|
import * as HttpRouter from "effect/http/HttpRouter";
|
|
19
|
+
import * as HttpMiddleware from "effect/http/HttpMiddleware";
|
|
18
20
|
import * as HttpServer from "effect/http/HttpServer";
|
|
19
21
|
//#region src/HttpRouter.ts
|
|
20
22
|
var HttpRouter_exports = /* @__PURE__ */ __exportAll({
|
|
@@ -40,22 +42,29 @@ var HttpRouter_exports = /* @__PURE__ */ __exportAll({
|
|
|
40
42
|
* exact paths first and longer path prefixes before the catch-all, so they take
|
|
41
43
|
* precedence.
|
|
42
44
|
*/
|
|
43
|
-
const make = (routes, options) => makeWithLayer(routes, baseActionLayer, options?.api);
|
|
45
|
+
const make = (routes, options) => makeWithLayer(routes, baseActionLayer, options?.api, options?.observability);
|
|
44
46
|
/**
|
|
45
47
|
* Derive HTTP capabilities and ID scopes from the generated database schema.
|
|
46
48
|
* Component routes are relative to their installation's HTTP mount prefix.
|
|
47
49
|
* Supply `{ api }` as in {@link make}; labels stay component-relative.
|
|
48
50
|
*/
|
|
49
|
-
const forSchema = (schema) => (routes, options) => makeWithLayer(Match.value(schema.target.kind).pipe(Match.when("app", () => routes), Match.when("component", () => routes.pipe(Layer.provide(componentRouter))), Match.exhaustive), (ctx) => actionLayer(schema, ctx), options?.api);
|
|
51
|
+
const forSchema = (schema) => (routes, options) => makeWithLayer(Match.value(schema.target.kind).pipe(Match.when("app", () => routes), Match.when("component", () => routes.pipe(Layer.provide(componentRouter))), Match.exhaustive), (ctx) => actionLayer(schema, ctx), options?.api, options?.observability, schema.target.kind === "component");
|
|
50
52
|
const componentRouter = Layer.effect(HttpRouter.HttpRouter, Effect.gen(function* () {
|
|
51
53
|
const router = yield* HttpRouter.HttpRouter;
|
|
52
54
|
const siteUrl = yield* Config.schema(Schema.URLFromString, "CONVEX_SITE_URL");
|
|
53
55
|
return router.prefixed(siteUrl.pathname);
|
|
54
56
|
}).pipe(Effect.orDie));
|
|
55
|
-
const makeWithLayer = (routes, layer$2, api) => {
|
|
57
|
+
const makeWithLayer = (routes, layer$2, api, observability, siteRelative = false) => {
|
|
56
58
|
applyMonkeyPatches();
|
|
57
|
-
const
|
|
58
|
-
|
|
59
|
+
const spanName = Layer.effect(HttpMiddleware.SpanNameGenerator, Effect.gen(function* () {
|
|
60
|
+
const prefix = siteRelative ? (yield* Config.schema(Schema.URLFromString, "CONVEX_SITE_URL")).pathname.replace(/\/$/, "") : "";
|
|
61
|
+
return (request) => convexHttpRouter.lookup(new URL(request.originalUrl).pathname.slice(prefix.length) || "/", request.method)?.[2] ?? "/*";
|
|
62
|
+
}).pipe(Effect.orDie));
|
|
63
|
+
const AppLayer = routes.pipe(Layer.provideMerge(observability === void 0 ? layer$1 : Layer.merge(memoized(observability), spanName)), Layer.provideMerge(layer), Layer.provide(HttpServer.layerServices));
|
|
64
|
+
const { handler } = HttpRouter.toWebHandler(AppLayer, {
|
|
65
|
+
disableLogger: true,
|
|
66
|
+
...observability === void 0 ? {} : { middleware: (effect) => Effect.andThen(Effect.annotateCurrentSpan("kind", "httpAction"), effect) }
|
|
67
|
+
});
|
|
59
68
|
const httpAction = httpActionGeneric((ctx, request) => {
|
|
60
69
|
const services = Effect.runSync(Effect.scoped(Layer.build(layer$2(ctx))));
|
|
61
70
|
return handler(request, Context.add(services, Console.Console, globalThis.console));
|
package/dist/HttpRouter.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"HttpRouter.js","names":["RegisteredFunction.baseActionLayer","RegisteredFunction.actionLayer","ConvexLogger.layer","ConvexConfigProvider.layer","layer"],"sources":["../src/HttpRouter.ts"],"sourcesContent":["import {\n type HttpRouter as ConvexHttpRouter,\n httpActionGeneric,\n httpRouter,\n ROUTABLE_HTTP_METHODS,\n type RouteSpecWithPathPrefix,\n type GenericActionCtx,\n type GenericDataModel,\n} from \"convex/server\";\nimport * as Array from \"effect/Array\";\nimport * as Console from \"effect/Console\";\nimport * as Context from \"effect/Context\";\nimport * as Config from \"effect/Config\";\nimport * as Effect from \"effect/Effect\";\nimport type * as FileSystem from \"effect/FileSystem\";\nimport * as Layer from \"effect/Layer\";\nimport * as Match from \"effect/Match\";\nimport type * as Path from \"effect/Path\";\nimport * as Schema from \"effect/Schema\";\nimport * as SchemaAST from \"effect/SchemaAST\";\nimport * as FindMyWay from \"effect/http/FindMyWay\";\nimport * as HttpApi from \"effect/http-api/HttpApi\";\nimport type * as HttpApiGroup from \"effect/http-api/HttpApiGroup\";\nimport type * as Etag from \"effect/http/Etag\";\nimport type * as HttpPlatform from \"effect/http/HttpPlatform\";\nimport * as HttpRouter from \"effect/http/HttpRouter\";\nimport * as HttpServer from \"effect/http/HttpServer\";\nimport type * as ActionRunner from \"./ActionRunner.js\";\nimport type * as Auth from \"./Auth.js\";\nimport type { ExecutionMetadata } from \"./ExecutionMetadata.js\";\nimport type { RequestMetadata } from \"./RequestMetadata.js\";\nimport type * as DatabaseSchema from \"./DatabaseSchema.js\";\nimport type * as DataModel from \"./DataModel.js\";\nimport type * as Handler from \"./Handler.js\";\nimport * as ConvexConfigProvider from \"./ConvexConfigProvider.js\";\nimport * as ConvexLogger from \"./ConvexLogger.js\";\nimport type * as MutationRunner from \"./MutationRunner.js\";\nimport type * as QueryRunner from \"./QueryRunner.js\";\nimport * as RegisteredFunction from \"./RegisteredFunction.js\";\nimport type * as Scheduler from \"./Scheduler.js\";\nimport type { Storage } from \"./Storage.js\";\nimport type { StorageActionWriter } from \"./StorageActionWriter.js\";\nimport type { StorageReader } from \"./StorageReader.js\";\nimport type { StorageWriter } from \"./StorageWriter.js\";\n\n/**\n * The Confect services available to HTTP route handlers and middleware,\n * supplied per request from the Convex action context.\n */\nexport type Services =\n | QueryRunner.QueryRunner\n | MutationRunner.MutationRunner\n | ActionRunner.ActionRunner\n | Scheduler.Scheduler\n | Auth.Auth\n | ExecutionMetadata\n | RequestMetadata\n | Storage\n | StorageReader\n | StorageWriter\n | StorageActionWriter;\n\n/**\n * A layer that registers routes on the HTTP router—the input to {@link make}.\n *\n * Compose it from Effect's `effect/http` and `effect/http-api` modules:\n * `HttpApiBuilder.layer(api)` registers an `HttpApi`'s endpoints (provide its\n * group handler layers with `Layer.provide`), `HttpApiScalar.layer(api, ...)`\n * serves interactive API docs, `HttpRouter.add` registers a plain route, and\n * `HttpRouter.middleware(fn, { global: true })` applies middleware to every\n * route. Merge any number of these with `Layer.mergeAll`.\n *\n * Route handlers and middleware may require any of the Confect {@link Services},\n * which surface as request-level `Requires` markers and are supplied per\n * request. Anything else the layer requires is a type error—notably, an\n * `HttpApiBuilder.layer(api)` whose group handler layers are not provided\n * leaves an `HttpApiGroup.ToService` requirement behind, so a missing handler\n * group is caught at compile time.\n *\n * Layers are built with Confect's Convex-aware `ConfigProvider` in context, so\n * `Config` reads (e.g. in `Layer.unwrap`) resolve against Convex environment\n * variables.\n */\nexport type Routes<Services_ = Services> = Layer.Layer<\n never,\n never,\n | HttpRouter.HttpRouter\n | Etag.Generator\n | FileSystem.FileSystem\n | HttpPlatform.HttpPlatform\n | Path.Path\n | HttpRouter.Request<\"Requires\", Services_>\n | HttpRouter.Request<\"GlobalRequires\", Services_>\n | HttpRouter.Request<\"Error\", any>\n | HttpRouter.Request<\"GlobalError\", any>\n>;\n\n/**\n * Create a Convex HTTP router serving the given routes.\n *\n * A single catch-all `httpAction` is registered for every routable method under\n * the path prefix `\"/\"`, making the Effect router the single source of truth\n * for paths: place an API with `HttpApi.prefix` or absolute route paths.\n * Requests that match no route receive the Effect router's 404 response.\n *\n * Supply `{ api }` with the `HttpApi` registered by the routes layer to show\n * endpoint patterns in Convex completion logs and the dashboard. Requests that\n * match no reflected endpoint keep the catch-all completion label. Without the\n * option, Convex reports the catch-all registrations. Application endpoints\n * must not overlap component HTTP mounts: Convex also uses dashboard route\n * entries to select between application and component routers.\n *\n * Plain Convex routes can still be added to the returned router—Convex matches\n * exact paths first and longer path prefixes before the catch-all, so they take\n * precedence.\n */\nexport const make = <Id extends string, Groups extends HttpApiGroup.Constraint>(\n routes: Routes,\n options?: { readonly api?: HttpApi.HttpApi<Id, Groups> | undefined },\n): ConvexHttpRouter =>\n makeWithLayer(routes, RegisteredFunction.baseActionLayer, options?.api);\n\n/**\n * Derive HTTP capabilities and ID scopes from the generated database schema.\n * Component routes are relative to their installation's HTTP mount prefix.\n * Supply `{ api }` as in {@link make}; labels stay component-relative.\n */\nexport const forSchema =\n <DatabaseSchema_ extends DatabaseSchema.AnyWithProps>(\n schema: DatabaseSchema_,\n ) =>\n <Id extends string, Groups extends HttpApiGroup.Constraint>(\n routes: Routes<Handler.ActionServices<DatabaseSchema_>>,\n options?: { readonly api?: HttpApi.HttpApi<Id, Groups> | undefined },\n ): ConvexHttpRouter =>\n makeWithLayer<\n Handler.ActionServices<DatabaseSchema_>,\n DataModel.ToConvex<DataModel.FromSchema<DatabaseSchema_>>,\n Id,\n Groups\n >(\n Match.value(schema.target.kind).pipe(\n Match.when(\"app\", () => routes),\n Match.when(\"component\", () =>\n routes.pipe(Layer.provide(componentRouter)),\n ),\n Match.exhaustive,\n ),\n (ctx) => RegisteredFunction.actionLayer(schema, ctx),\n options?.api,\n );\n\n// Convex uses a component-relative path to select its HTTP action but passes\n// the original request URL to that action. Its CONVEX_SITE_URL includes the\n// installation's full mount prefix (including parent mounts). Prefixing the\n// Effect router preserves relative routes without rewriting the Request body.\nconst componentRouter = Layer.effect(\n HttpRouter.HttpRouter,\n Effect.gen(function* () {\n const router = yield* HttpRouter.HttpRouter;\n const siteUrl = yield* Config.schema(\n Schema.URLFromString,\n \"CONVEX_SITE_URL\",\n );\n return router.prefixed(siteUrl.pathname);\n }).pipe(Effect.orDie),\n);\n\nconst makeWithLayer = <\n Services_,\n DataModel_ extends GenericDataModel,\n Id extends string,\n Groups extends HttpApiGroup.Constraint,\n>(\n routes: Routes<Services_>,\n layer: (ctx: GenericActionCtx<DataModel_>) => Layer.Layer<Services_>,\n api: HttpApi.HttpApi<Id, Groups> | undefined,\n): ConvexHttpRouter => {\n applyMonkeyPatches();\n\n // Provided (not just merged) so that route layers' own construction—e.g.\n // a `Layer.unwrap` reading `Config`—resolves configuration through the\n // Convex-aware provider; merged so that request fibers—endpoint handlers\n // and middleware—do too.\n const AppLayer = routes.pipe(\n Layer.provideMerge(ConvexLogger.layer),\n Layer.provideMerge(ConvexConfigProvider.layer),\n Layer.provide(HttpServer.layerServices),\n );\n\n // The Confect service requirements of route handlers and middleware surface\n // as request-level `Requires` markers on the layer, which the web handler\n // exposes as a per-request context argument.\n const { handler } = HttpRouter.toWebHandler(AppLayer, {\n disableLogger: true,\n });\n\n const httpAction = httpActionGeneric((ctx, request): Promise<Response> => {\n // The ctx-backed service layers are all synchronous and finalizer-free,\n // so the scope can close as soon as the context is built.\n // Convex's HTTP registration erases the data model. The supplied generated\n // schema restores it; this does not change the runtime context or services.\n const services = Effect.runSync(\n Effect.scoped(\n Layer.build(layer(ctx as unknown as GenericActionCtx<DataModel_>)),\n ),\n );\n return handler(\n request,\n Context.add(services, Console.Console, globalThis.console),\n );\n });\n\n const convexHttpRouter = httpRouter();\n\n Array.forEach(ROUTABLE_HTTP_METHODS, (method) => {\n const routeSpec: RouteSpecWithPathPrefix = {\n pathPrefix: \"/\",\n method,\n handler: httpAction,\n };\n convexHttpRouter.route(routeSpec);\n });\n\n if (api !== undefined) {\n const matcher = FindMyWay.make<string>();\n const reflected: ReturnType<ConvexHttpRouter[\"getRoutes\"]> = [];\n HttpApi.reflect(api, {\n onGroup: () => {},\n onEndpoint: ({ endpoint }) => {\n const method = ROUTABLE_HTTP_METHODS.find(\n (candidate) => candidate === endpoint.method,\n );\n if (method === undefined) return;\n const path = apiRouterPath(\n endpoint.path as FindMyWay.PathInput,\n endpoint.params,\n );\n matcher.on(method, path, endpoint.path);\n // Effect also matches a wildcard route's base path without its slash.\n if (path.endsWith(\"/*\")) {\n matcher.on(method, path.slice(0, -2) as `/${string}`, endpoint.path);\n }\n reflected.push([endpoint.path, method, httpAction]);\n },\n });\n reflected.sort(\n ([pathA, methodA], [pathB, methodB]) =>\n pathA.localeCompare(pathB) || methodA.localeCompare(methodB),\n );\n\n const getRoutes = convexHttpRouter.getRoutes;\n convexHttpRouter.getRoutes = () =>\n reflected.length === 0\n ? getRoutes()\n : [\n ...getRoutes().filter(([, , action]) => action !== httpAction),\n ...reflected,\n ];\n const lookup = convexHttpRouter.lookup;\n convexHttpRouter.lookup = (path, method) => {\n const match = lookup(path, method);\n if (match === null || match[0] !== httpAction) return match;\n const normalized = match[1];\n const reflectedPath = matcher.find(normalized, path)?.handler;\n return reflectedPath === undefined\n ? match\n : [httpAction, normalized, reflectedPath];\n };\n }\n\n return convexHttpRouter;\n};\n\n/*!\n * apiRouterPath is adapted from Effect 4.0.1 http-api/internal/path.ts.\n *\n * MIT License\n *\n * Copyright (c) 2023 Effectful Technologies Inc\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n// Match Effect's HttpApiBuilder path normalization, which is not publicly\n// exported (effect/http-api/internal/path.ts). Undeclared colons are literals;\n// declared params followed by a literal suffix need an explicit regex boundary.\nconst apiRouterPath = (\n path: FindMyWay.PathInput,\n params: Schema.Top | undefined,\n): FindMyWay.PathInput => {\n if (params === undefined || !path.includes(\":\")) return path;\n let ast = params.ast;\n while (ast.encoding !== undefined) {\n ast = ast.encoding[ast.encoding.length - 1].to;\n }\n if (!SchemaAST.isObjects(ast) || ast.indexSignatures.length !== 0)\n return path;\n const names = new Set(\n ast.propertySignatures.map((property) => String(property.name)),\n );\n let normalized = \"\";\n let depth = 0;\n let regexStart = -1;\n for (let i = 0; i < path.length; i++) {\n const char = path[i];\n if (depth > 0 || i === regexStart) {\n normalized += char;\n if (char === \"\\\\\") normalized += path[++i] ?? \"\";\n else if (char === \"(\") depth++;\n else if (char === \")\") depth--;\n } else if (char !== \":\") {\n normalized += char;\n } else if (path[i + 1] === \":\") {\n normalized += \"::\";\n i++;\n } else {\n const param = /^:(\\w+)/.exec(path.slice(i));\n if (param !== null && names.has(param[1])) {\n normalized += param[0];\n i += param[0].length - 1;\n const next = path[i + 1];\n if (next === \"(\") regexStart = i + 1;\n else if (next !== undefined && !\"/.-?\".includes(next))\n normalized += \"(.*?)\";\n } else {\n normalized += \"::\";\n }\n }\n }\n return normalized as FindMyWay.PathInput;\n};\n\n// These are necessary until the Convex runtime supports these APIs. See\n// https://discord.com/channels/1019350475847499849/1281364098419785760\n// Each patch is applied only where the API is actually broken, so runtimes\n// with working implementations—Node under convex-test, notably, where\n// `new AbortSignal()` is an illegal constructor—keep their native behavior.\nconst applyMonkeyPatches = () => {\n const urlCredentialsBroken = (() => {\n try {\n return new URL(\"https://confect.dev\").username === undefined;\n } catch {\n return true;\n }\n })();\n if (urlCredentialsBroken) {\n URL = class extends URL {\n override get username() {\n return \"\";\n }\n override get password() {\n return \"\";\n }\n };\n }\n\n const requestSignalBroken = (() => {\n try {\n return new Request(\"https://confect.dev\").signal === undefined;\n } catch {\n return true;\n }\n })();\n if (requestSignalBroken) {\n // `configurable` so repeated definition—e.g. module re-evaluation in a\n // long-lived environment—does not throw.\n Object.defineProperty(Request.prototype, \"signal\", {\n get: () => new AbortSignal(),\n configurable: true,\n });\n }\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoHA,MAAa,QACX,QACA,YAEA,cAAc,QAAQA,iBAAoC,SAAS,GAAG;;;;;;AAOxE,MAAa,aAET,YAGA,QACA,YAEA,cAME,MAAM,MAAM,OAAO,OAAO,IAAI,CAAC,CAAC,KAC9B,MAAM,KAAK,aAAa,MAAM,GAC9B,MAAM,KAAK,mBACT,OAAO,KAAK,MAAM,QAAQ,eAAe,CAAC,CAC5C,GACA,MAAM,UACR,IACC,QAAQC,YAA+B,QAAQ,GAAG,GACnD,SAAS,GACX;AAMJ,MAAM,kBAAkB,MAAM,OAC5B,WAAW,YACX,OAAO,IAAI,aAAa;CACtB,MAAM,SAAS,OAAO,WAAW;CACjC,MAAM,UAAU,OAAO,OAAO,OAC5B,OAAO,eACP,iBACF;CACA,OAAO,OAAO,SAAS,QAAQ,QAAQ;AACzC,CAAC,CAAC,CAAC,KAAK,OAAO,KAAK,CACtB;AAEA,MAAM,iBAMJ,QACA,SACA,QACqB;CACrB,mBAAmB;CAMnB,MAAM,WAAW,OAAO,KACtB,MAAM,aAAaC,OAAkB,GACrC,MAAM,aAAaC,KAA0B,GAC7C,MAAM,QAAQ,WAAW,aAAa,CACxC;CAKA,MAAM,EAAE,YAAY,WAAW,aAAa,UAAU,EACpD,eAAe,KACjB,CAAC;CAED,MAAM,aAAa,mBAAmB,KAAK,YAA+B;EAKxE,MAAM,WAAW,OAAO,QACtB,OAAO,OACL,MAAM,MAAMC,QAAM,GAA8C,CAAC,CACnE,CACF;EACA,OAAO,QACL,SACA,QAAQ,IAAI,UAAU,QAAQ,SAAS,WAAW,OAAO,CAC3D;CACF,CAAC;CAED,MAAM,mBAAmB,WAAW;CAEpC,MAAM,QAAQ,wBAAwB,WAAW;EAC/C,MAAM,YAAqC;GACzC,YAAY;GACZ;GACA,SAAS;EACX;EACA,iBAAiB,MAAM,SAAS;CAClC,CAAC;CAED,IAAI,QAAQ,KAAA,GAAW;EACrB,MAAM,UAAU,UAAU,KAAa;EACvC,MAAM,YAAuD,CAAC;EAC9D,QAAQ,QAAQ,KAAK;GACnB,eAAe,CAAC;GAChB,aAAa,EAAE,eAAe;IAC5B,MAAM,SAAS,sBAAsB,MAClC,cAAc,cAAc,SAAS,MACxC;IACA,IAAI,WAAW,KAAA,GAAW;IAC1B,MAAM,OAAO,cACX,SAAS,MACT,SAAS,MACX;IACA,QAAQ,GAAG,QAAQ,MAAM,SAAS,IAAI;IAEtC,IAAI,KAAK,SAAS,IAAI,GACpB,QAAQ,GAAG,QAAQ,KAAK,MAAM,GAAG,EAAE,GAAmB,SAAS,IAAI;IAErE,UAAU,KAAK;KAAC,SAAS;KAAM;KAAQ;IAAU,CAAC;GACpD;EACF,CAAC;EACD,UAAU,MACP,CAAC,OAAO,UAAU,CAAC,OAAO,aACzB,MAAM,cAAc,KAAK,KAAK,QAAQ,cAAc,OAAO,CAC/D;EAEA,MAAM,YAAY,iBAAiB;EACnC,iBAAiB,kBACf,UAAU,WAAW,IACjB,UAAU,IACV,CACE,GAAG,UAAU,CAAC,CAAC,QAAQ,KAAK,YAAY,WAAW,UAAU,GAC7D,GAAG,SACL;EACN,MAAM,SAAS,iBAAiB;EAChC,iBAAiB,UAAU,MAAM,WAAW;GAC1C,MAAM,QAAQ,OAAO,MAAM,MAAM;GACjC,IAAI,UAAU,QAAQ,MAAM,OAAO,YAAY,OAAO;GACtD,MAAM,aAAa,MAAM;GACzB,MAAM,gBAAgB,QAAQ,KAAK,YAAY,IAAI,CAAC,EAAE;GACtD,OAAO,kBAAkB,KAAA,IACrB,QACA;IAAC;IAAY;IAAY;GAAa;EAC5C;CACF;CAEA,OAAO;AACT;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BA,MAAM,iBACJ,MACA,WACwB;CACxB,IAAI,WAAW,KAAA,KAAa,CAAC,KAAK,SAAS,GAAG,GAAG,OAAO;CACxD,IAAI,MAAM,OAAO;CACjB,OAAO,IAAI,aAAa,KAAA,GACtB,MAAM,IAAI,SAAS,IAAI,SAAS,SAAS,EAAE,CAAC;CAE9C,IAAI,CAAC,UAAU,UAAU,GAAG,KAAK,IAAI,gBAAgB,WAAW,GAC9D,OAAO;CACT,MAAM,QAAQ,IAAI,IAChB,IAAI,mBAAmB,KAAK,aAAa,OAAO,SAAS,IAAI,CAAC,CAChE;CACA,IAAI,aAAa;CACjB,IAAI,QAAQ;CACZ,IAAI,aAAa;CACjB,KAAK,IAAI,IAAI,GAAG,IAAI,KAAK,QAAQ,KAAK;EACpC,MAAM,OAAO,KAAK;EAClB,IAAI,QAAQ,KAAK,MAAM,YAAY;GACjC,cAAc;GACd,IAAI,SAAS,MAAM,cAAc,KAAK,EAAE,MAAM;QACzC,IAAI,SAAS,KAAK;QAClB,IAAI,SAAS,KAAK;EACzB,OAAO,IAAI,SAAS,KAClB,cAAc;OACT,IAAI,KAAK,IAAI,OAAO,KAAK;GAC9B,cAAc;GACd;EACF,OAAO;GACL,MAAM,QAAQ,UAAU,KAAK,KAAK,MAAM,CAAC,CAAC;GAC1C,IAAI,UAAU,QAAQ,MAAM,IAAI,MAAM,EAAE,GAAG;IACzC,cAAc,MAAM;IACpB,KAAK,MAAM,EAAE,CAAC,SAAS;IACvB,MAAM,OAAO,KAAK,IAAI;IACtB,IAAI,SAAS,KAAK,aAAa,IAAI;SAC9B,IAAI,SAAS,KAAA,KAAa,CAAC,OAAO,SAAS,IAAI,GAClD,cAAc;GAClB,OACE,cAAc;EAElB;CACF;CACA,OAAO;AACT;AAOA,MAAM,2BAA2B;CAQ/B,WAPoC;EAClC,IAAI;GACF,OAAO,IAAI,IAAI,qBAAqB,CAAC,CAAC,aAAa,KAAA;EACrD,QAAQ;GACN,OAAO;EACT;CACF,EAAA,CACuB,GACrB,MAAM,cAAc,IAAI;EACtB,IAAa,WAAW;GACtB,OAAO;EACT;EACA,IAAa,WAAW;GACtB,OAAO;EACT;CACF;CAUF,WAPmC;EACjC,IAAI;GACF,OAAO,IAAI,QAAQ,qBAAqB,CAAC,CAAC,WAAW,KAAA;EACvD,QAAQ;GACN,OAAO;EACT;CACF,EAAA,CACsB,GAGpB,OAAO,eAAe,QAAQ,WAAW,UAAU;EACjD,WAAW,IAAI,YAAY;EAC3B,cAAc;CAChB,CAAC;AAEL"}
|
|
1
|
+
{"version":3,"file":"HttpRouter.js","names":["RegisteredFunction.baseActionLayer","RegisteredFunction.actionLayer","ConvexLogger.layer","ObservabilityRuntime.memoized","ConvexConfigProvider.layer","layer"],"sources":["../src/HttpRouter.ts"],"sourcesContent":["import {\n type HttpRouter as ConvexHttpRouter,\n httpActionGeneric,\n httpRouter,\n ROUTABLE_HTTP_METHODS,\n type RouteSpecWithPathPrefix,\n type GenericActionCtx,\n type GenericDataModel,\n} from \"convex/server\";\nimport * as Array from \"effect/Array\";\nimport * as Console from \"effect/Console\";\nimport * as Context from \"effect/Context\";\nimport * as Config from \"effect/Config\";\nimport * as Effect from \"effect/Effect\";\nimport type * as FileSystem from \"effect/FileSystem\";\nimport * as Layer from \"effect/Layer\";\nimport * as Match from \"effect/Match\";\nimport type * as Path from \"effect/Path\";\nimport * as Schema from \"effect/Schema\";\nimport * as SchemaAST from \"effect/SchemaAST\";\nimport * as FindMyWay from \"effect/http/FindMyWay\";\nimport * as HttpApi from \"effect/http-api/HttpApi\";\nimport type * as HttpApiGroup from \"effect/http-api/HttpApiGroup\";\nimport type * as Etag from \"effect/http/Etag\";\nimport type * as HttpPlatform from \"effect/http/HttpPlatform\";\nimport * as HttpRouter from \"effect/http/HttpRouter\";\nimport * as HttpMiddleware from \"effect/http/HttpMiddleware\";\nimport type * as HttpServerRequest from \"effect/http/HttpServerRequest\";\nimport * as HttpServer from \"effect/http/HttpServer\";\nimport type * as ActionRunner from \"./ActionRunner.js\";\nimport type * as Auth from \"./Auth.js\";\nimport type { ExecutionMetadata } from \"./ExecutionMetadata.js\";\nimport type { RequestMetadata } from \"./RequestMetadata.js\";\nimport type * as DatabaseSchema from \"./DatabaseSchema.js\";\nimport type * as DataModel from \"./DataModel.js\";\nimport type * as Handler from \"./Handler.js\";\nimport * as ConvexConfigProvider from \"./ConvexConfigProvider.js\";\nimport * as ObservabilityRuntime from \"./internal/observability.js\";\nimport * as ConvexLogger from \"./ConvexLogger.js\";\nimport type * as MutationRunner from \"./MutationRunner.js\";\nimport type * as QueryRunner from \"./QueryRunner.js\";\nimport * as RegisteredFunction from \"./RegisteredFunction.js\";\nimport type * as Scheduler from \"./Scheduler.js\";\nimport type { Storage } from \"./Storage.js\";\nimport type { StorageActionWriter } from \"./StorageActionWriter.js\";\nimport type { StorageReader } from \"./StorageReader.js\";\nimport type { StorageWriter } from \"./StorageWriter.js\";\n\n/**\n * The Confect services available to HTTP route handlers and middleware,\n * supplied per request from the Convex action context.\n */\nexport type Services =\n | QueryRunner.QueryRunner\n | MutationRunner.MutationRunner\n | ActionRunner.ActionRunner\n | Scheduler.Scheduler\n | Auth.Auth\n | ExecutionMetadata\n | RequestMetadata\n | Storage\n | StorageReader\n | StorageWriter\n | StorageActionWriter;\n\n/**\n * A layer that registers routes on the HTTP router—the input to {@link make}.\n *\n * Compose it from Effect's `effect/http` and `effect/http-api` modules:\n * `HttpApiBuilder.layer(api)` registers an `HttpApi`'s endpoints (provide its\n * group handler layers with `Layer.provide`), `HttpApiScalar.layer(api, ...)`\n * serves interactive API docs, `HttpRouter.add` registers a plain route, and\n * `HttpRouter.middleware(fn, { global: true })` applies middleware to every\n * route. Merge any number of these with `Layer.mergeAll`.\n *\n * Route handlers and middleware may require any of the Confect {@link Services},\n * which surface as request-level `Requires` markers and are supplied per\n * request. Anything else the layer requires is a type error—notably, an\n * `HttpApiBuilder.layer(api)` whose group handler layers are not provided\n * leaves an `HttpApiGroup.ToService` requirement behind, so a missing handler\n * group is caught at compile time.\n *\n * Layers are built with Confect's Convex-aware `ConfigProvider` in context, so\n * `Config` reads (e.g. in `Layer.unwrap`) resolve against Convex environment\n * variables.\n */\nexport type Routes<Services_ = Services> = Layer.Layer<\n never,\n never,\n | HttpRouter.HttpRouter\n | Etag.Generator\n | FileSystem.FileSystem\n | HttpPlatform.HttpPlatform\n | Path.Path\n | HttpRouter.Request<\"Requires\", Services_>\n | HttpRouter.Request<\"GlobalRequires\", Services_>\n | HttpRouter.Request<\"Error\", any>\n | HttpRouter.Request<\"GlobalError\", any>\n>;\n\n/**\n * Create a Convex HTTP router serving the given routes.\n *\n * A single catch-all `httpAction` is registered for every routable method under\n * the path prefix `\"/\"`, making the Effect router the single source of truth\n * for paths: place an API with `HttpApi.prefix` or absolute route paths.\n * Requests that match no route receive the Effect router's 404 response.\n *\n * Supply `{ api }` with the `HttpApi` registered by the routes layer to show\n * endpoint patterns in Convex completion logs and the dashboard. Requests that\n * match no reflected endpoint keep the catch-all completion label. Without the\n * option, Convex reports the catch-all registrations. Application endpoints\n * must not overlap component HTTP mounts: Convex also uses dashboard route\n * entries to select between application and component routers.\n *\n * Plain Convex routes can still be added to the returned router—Convex matches\n * exact paths first and longer path prefixes before the catch-all, so they take\n * precedence.\n */\nexport const make = <Id extends string, Groups extends HttpApiGroup.Constraint>(\n routes: Routes,\n options?: {\n readonly observability?: Layer.Layer<never> | undefined;\n readonly api?: HttpApi.HttpApi<Id, Groups> | undefined;\n },\n): ConvexHttpRouter =>\n makeWithLayer(\n routes,\n RegisteredFunction.baseActionLayer,\n options?.api,\n options?.observability,\n );\n\n/**\n * Derive HTTP capabilities and ID scopes from the generated database schema.\n * Component routes are relative to their installation's HTTP mount prefix.\n * Supply `{ api }` as in {@link make}; labels stay component-relative.\n */\nexport const forSchema =\n <DatabaseSchema_ extends DatabaseSchema.AnyWithProps>(\n schema: DatabaseSchema_,\n ) =>\n <Id extends string, Groups extends HttpApiGroup.Constraint>(\n routes: Routes<Handler.ActionServices<DatabaseSchema_>>,\n options?: {\n readonly observability?: Layer.Layer<never> | undefined;\n readonly api?: HttpApi.HttpApi<Id, Groups> | undefined;\n },\n ): ConvexHttpRouter =>\n makeWithLayer<\n Handler.ActionServices<DatabaseSchema_>,\n DataModel.ToConvex<DataModel.FromSchema<DatabaseSchema_>>,\n Id,\n Groups\n >(\n Match.value(schema.target.kind).pipe(\n Match.when(\"app\", () => routes),\n Match.when(\"component\", () =>\n routes.pipe(Layer.provide(componentRouter)),\n ),\n Match.exhaustive,\n ),\n (ctx) => RegisteredFunction.actionLayer(schema, ctx),\n options?.api,\n options?.observability,\n schema.target.kind === \"component\",\n );\n\n// Convex uses a component-relative path to select its HTTP action but passes\n// the original request URL to that action. Its CONVEX_SITE_URL includes the\n// installation's full mount prefix (including parent mounts). Prefixing the\n// Effect router preserves relative routes without rewriting the Request body.\nconst componentRouter = Layer.effect(\n HttpRouter.HttpRouter,\n Effect.gen(function* () {\n const router = yield* HttpRouter.HttpRouter;\n const siteUrl = yield* Config.schema(\n Schema.URLFromString,\n \"CONVEX_SITE_URL\",\n );\n return router.prefixed(siteUrl.pathname);\n }).pipe(Effect.orDie),\n);\n\nconst makeWithLayer = <\n Services_,\n DataModel_ extends GenericDataModel,\n Id extends string,\n Groups extends HttpApiGroup.Constraint,\n>(\n routes: Routes<Services_>,\n layer: (ctx: GenericActionCtx<DataModel_>) => Layer.Layer<Services_>,\n api: HttpApi.HttpApi<Id, Groups> | undefined,\n observability?: Layer.Layer<never>,\n siteRelative = false,\n): ConvexHttpRouter => {\n applyMonkeyPatches();\n\n const spanName = Layer.effect(\n HttpMiddleware.SpanNameGenerator,\n Effect.gen(function* () {\n const prefix = siteRelative\n ? (yield* Config.schema(\n Schema.URLFromString,\n \"CONVEX_SITE_URL\",\n )).pathname.replace(/\\/$/, \"\")\n : \"\";\n return (request: HttpServerRequest.HttpServerRequest) =>\n convexHttpRouter.lookup(\n new URL(request.originalUrl).pathname.slice(prefix.length) || \"/\",\n request.method as (typeof ROUTABLE_HTTP_METHODS)[number],\n )?.[2] ?? \"/*\";\n }).pipe(Effect.orDie),\n );\n\n // Provided (not just merged) so that route layers' own construction—e.g.\n // a `Layer.unwrap` reading `Config`—resolves configuration through the\n // Convex-aware provider; merged so that request fibers—endpoint handlers\n // and middleware—do too.\n const AppLayer = routes.pipe(\n Layer.provideMerge(\n observability === undefined\n ? ConvexLogger.layer\n : Layer.merge(ObservabilityRuntime.memoized(observability), spanName),\n ),\n Layer.provideMerge(ConvexConfigProvider.layer),\n Layer.provide(HttpServer.layerServices),\n );\n\n // The Confect service requirements of route handlers and middleware surface\n // as request-level `Requires` markers on the layer, which the web handler\n // exposes as a per-request context argument.\n const { handler } = HttpRouter.toWebHandler(AppLayer, {\n disableLogger: true,\n /* oxlint-disable effecttsgo/any-unknown-in-error-context -- Keep Effect's erased HTTP boundary errors intact. */\n ...(observability === undefined\n ? {}\n : {\n middleware: (effect) =>\n Effect.andThen(\n Effect.annotateCurrentSpan(\"kind\", \"httpAction\"),\n effect,\n ),\n }),\n /* oxlint-enable effecttsgo/any-unknown-in-error-context */\n });\n\n const httpAction = httpActionGeneric((ctx, request): Promise<Response> => {\n // The ctx-backed service layers are all synchronous and finalizer-free,\n // so the scope can close as soon as the context is built.\n // Convex's HTTP registration erases the data model. The supplied generated\n // schema restores it; this does not change the runtime context or services.\n const services = Effect.runSync(\n Effect.scoped(\n Layer.build(layer(ctx as unknown as GenericActionCtx<DataModel_>)),\n ),\n );\n return handler(\n request,\n Context.add(services, Console.Console, globalThis.console),\n );\n });\n\n const convexHttpRouter = httpRouter();\n\n Array.forEach(ROUTABLE_HTTP_METHODS, (method) => {\n const routeSpec: RouteSpecWithPathPrefix = {\n pathPrefix: \"/\",\n method,\n handler: httpAction,\n };\n convexHttpRouter.route(routeSpec);\n });\n\n if (api !== undefined) {\n const matcher = FindMyWay.make<string>();\n const reflected: ReturnType<ConvexHttpRouter[\"getRoutes\"]> = [];\n HttpApi.reflect(api, {\n onGroup: () => {},\n onEndpoint: ({ endpoint }) => {\n const method = ROUTABLE_HTTP_METHODS.find(\n (candidate) => candidate === endpoint.method,\n );\n if (method === undefined) return;\n const path = apiRouterPath(\n endpoint.path as FindMyWay.PathInput,\n endpoint.params,\n );\n matcher.on(method, path, endpoint.path);\n // Effect also matches a wildcard route's base path without its slash.\n if (path.endsWith(\"/*\")) {\n matcher.on(method, path.slice(0, -2) as `/${string}`, endpoint.path);\n }\n reflected.push([endpoint.path, method, httpAction]);\n },\n });\n reflected.sort(\n ([pathA, methodA], [pathB, methodB]) =>\n pathA.localeCompare(pathB) || methodA.localeCompare(methodB),\n );\n\n const getRoutes = convexHttpRouter.getRoutes;\n convexHttpRouter.getRoutes = () =>\n reflected.length === 0\n ? getRoutes()\n : [\n ...getRoutes().filter(([, , action]) => action !== httpAction),\n ...reflected,\n ];\n const lookup = convexHttpRouter.lookup;\n convexHttpRouter.lookup = (path, method) => {\n const match = lookup(path, method);\n if (match === null || match[0] !== httpAction) return match;\n const normalized = match[1];\n const reflectedPath = matcher.find(normalized, path)?.handler;\n return reflectedPath === undefined\n ? match\n : [httpAction, normalized, reflectedPath];\n };\n }\n\n return convexHttpRouter;\n};\n\n/*!\n * apiRouterPath is adapted from Effect 4.0.1 http-api/internal/path.ts.\n *\n * MIT License\n *\n * Copyright (c) 2023 Effectful Technologies Inc\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n// Match Effect's HttpApiBuilder path normalization, which is not publicly\n// exported (effect/http-api/internal/path.ts). Undeclared colons are literals;\n// declared params followed by a literal suffix need an explicit regex boundary.\nconst apiRouterPath = (\n path: FindMyWay.PathInput,\n params: Schema.Top | undefined,\n): FindMyWay.PathInput => {\n if (params === undefined || !path.includes(\":\")) return path;\n let ast = params.ast;\n while (ast.encoding !== undefined) {\n ast = ast.encoding[ast.encoding.length - 1].to;\n }\n if (!SchemaAST.isObjects(ast) || ast.indexSignatures.length !== 0)\n return path;\n const names = new Set(\n ast.propertySignatures.map((property) => String(property.name)),\n );\n let normalized = \"\";\n let depth = 0;\n let regexStart = -1;\n for (let i = 0; i < path.length; i++) {\n const char = path[i];\n if (depth > 0 || i === regexStart) {\n normalized += char;\n if (char === \"\\\\\") normalized += path[++i] ?? \"\";\n else if (char === \"(\") depth++;\n else if (char === \")\") depth--;\n } else if (char !== \":\") {\n normalized += char;\n } else if (path[i + 1] === \":\") {\n normalized += \"::\";\n i++;\n } else {\n const param = /^:(\\w+)/.exec(path.slice(i));\n if (param !== null && names.has(param[1])) {\n normalized += param[0];\n i += param[0].length - 1;\n const next = path[i + 1];\n if (next === \"(\") regexStart = i + 1;\n else if (next !== undefined && !\"/.-?\".includes(next))\n normalized += \"(.*?)\";\n } else {\n normalized += \"::\";\n }\n }\n }\n return normalized as FindMyWay.PathInput;\n};\n\n// These are necessary until the Convex runtime supports these APIs. See\n// https://discord.com/channels/1019350475847499849/1281364098419785760\n// Each patch is applied only where the API is actually broken, so runtimes\n// with working implementations—Node under convex-test, notably, where\n// `new AbortSignal()` is an illegal constructor—keep their native behavior.\nconst applyMonkeyPatches = () => {\n const urlCredentialsBroken = (() => {\n try {\n return new URL(\"https://confect.dev\").username === undefined;\n } catch {\n return true;\n }\n })();\n if (urlCredentialsBroken) {\n URL = class extends URL {\n override get username() {\n return \"\";\n }\n override get password() {\n return \"\";\n }\n };\n }\n\n const requestSignalBroken = (() => {\n try {\n return new Request(\"https://confect.dev\").signal === undefined;\n } catch {\n return true;\n }\n })();\n if (requestSignalBroken) {\n // `configurable` so repeated definition—e.g. module re-evaluation in a\n // long-lived environment—does not throw.\n Object.defineProperty(Request.prototype, \"signal\", {\n get: () => new AbortSignal(),\n configurable: true,\n });\n }\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuHA,MAAa,QACX,QACA,YAKA,cACE,QACAA,iBACA,SAAS,KACT,SAAS,aACX;;;;;;AAOF,MAAa,aAET,YAGA,QACA,YAKA,cAME,MAAM,MAAM,OAAO,OAAO,IAAI,CAAC,CAAC,KAC9B,MAAM,KAAK,aAAa,MAAM,GAC9B,MAAM,KAAK,mBACT,OAAO,KAAK,MAAM,QAAQ,eAAe,CAAC,CAC5C,GACA,MAAM,UACR,IACC,QAAQC,YAA+B,QAAQ,GAAG,GACnD,SAAS,KACT,SAAS,eACT,OAAO,OAAO,SAAS,WACzB;AAMJ,MAAM,kBAAkB,MAAM,OAC5B,WAAW,YACX,OAAO,IAAI,aAAa;CACtB,MAAM,SAAS,OAAO,WAAW;CACjC,MAAM,UAAU,OAAO,OAAO,OAC5B,OAAO,eACP,iBACF;CACA,OAAO,OAAO,SAAS,QAAQ,QAAQ;AACzC,CAAC,CAAC,CAAC,KAAK,OAAO,KAAK,CACtB;AAEA,MAAM,iBAMJ,QACA,SACA,KACA,eACA,eAAe,UACM;CACrB,mBAAmB;CAEnB,MAAM,WAAW,MAAM,OACrB,eAAe,mBACf,OAAO,IAAI,aAAa;EACtB,MAAM,SAAS,gBACV,OAAO,OAAO,OACb,OAAO,eACP,iBACF,EAAA,CAAG,SAAS,QAAQ,OAAO,EAAE,IAC7B;EACJ,QAAQ,YACN,iBAAiB,OACf,IAAI,IAAI,QAAQ,WAAW,CAAC,CAAC,SAAS,MAAM,OAAO,MAAM,KAAK,KAC9D,QAAQ,MACV,CAAC,GAAG,MAAM;CACd,CAAC,CAAC,CAAC,KAAK,OAAO,KAAK,CACtB;CAMA,MAAM,WAAW,OAAO,KACtB,MAAM,aACJ,kBAAkB,KAAA,IACdC,UACA,MAAM,MAAMC,SAA8B,aAAa,GAAG,QAAQ,CACxE,GACA,MAAM,aAAaC,KAA0B,GAC7C,MAAM,QAAQ,WAAW,aAAa,CACxC;CAKA,MAAM,EAAE,YAAY,WAAW,aAAa,UAAU;EACpD,eAAe;EAEf,GAAI,kBAAkB,KAAA,IAClB,CAAC,IACD,EACE,aAAa,WACX,OAAO,QACL,OAAO,oBAAoB,QAAQ,YAAY,GAC/C,MACF,EACJ;CAEN,CAAC;CAED,MAAM,aAAa,mBAAmB,KAAK,YAA+B;EAKxE,MAAM,WAAW,OAAO,QACtB,OAAO,OACL,MAAM,MAAMC,QAAM,GAA8C,CAAC,CACnE,CACF;EACA,OAAO,QACL,SACA,QAAQ,IAAI,UAAU,QAAQ,SAAS,WAAW,OAAO,CAC3D;CACF,CAAC;CAED,MAAM,mBAAmB,WAAW;CAEpC,MAAM,QAAQ,wBAAwB,WAAW;EAC/C,MAAM,YAAqC;GACzC,YAAY;GACZ;GACA,SAAS;EACX;EACA,iBAAiB,MAAM,SAAS;CAClC,CAAC;CAED,IAAI,QAAQ,KAAA,GAAW;EACrB,MAAM,UAAU,UAAU,KAAa;EACvC,MAAM,YAAuD,CAAC;EAC9D,QAAQ,QAAQ,KAAK;GACnB,eAAe,CAAC;GAChB,aAAa,EAAE,eAAe;IAC5B,MAAM,SAAS,sBAAsB,MAClC,cAAc,cAAc,SAAS,MACxC;IACA,IAAI,WAAW,KAAA,GAAW;IAC1B,MAAM,OAAO,cACX,SAAS,MACT,SAAS,MACX;IACA,QAAQ,GAAG,QAAQ,MAAM,SAAS,IAAI;IAEtC,IAAI,KAAK,SAAS,IAAI,GACpB,QAAQ,GAAG,QAAQ,KAAK,MAAM,GAAG,EAAE,GAAmB,SAAS,IAAI;IAErE,UAAU,KAAK;KAAC,SAAS;KAAM;KAAQ;IAAU,CAAC;GACpD;EACF,CAAC;EACD,UAAU,MACP,CAAC,OAAO,UAAU,CAAC,OAAO,aACzB,MAAM,cAAc,KAAK,KAAK,QAAQ,cAAc,OAAO,CAC/D;EAEA,MAAM,YAAY,iBAAiB;EACnC,iBAAiB,kBACf,UAAU,WAAW,IACjB,UAAU,IACV,CACE,GAAG,UAAU,CAAC,CAAC,QAAQ,KAAK,YAAY,WAAW,UAAU,GAC7D,GAAG,SACL;EACN,MAAM,SAAS,iBAAiB;EAChC,iBAAiB,UAAU,MAAM,WAAW;GAC1C,MAAM,QAAQ,OAAO,MAAM,MAAM;GACjC,IAAI,UAAU,QAAQ,MAAM,OAAO,YAAY,OAAO;GACtD,MAAM,aAAa,MAAM;GACzB,MAAM,gBAAgB,QAAQ,KAAK,YAAY,IAAI,CAAC,EAAE;GACtD,OAAO,kBAAkB,KAAA,IACrB,QACA;IAAC;IAAY;IAAY;GAAa;EAC5C;CACF;CAEA,OAAO;AACT;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BA,MAAM,iBACJ,MACA,WACwB;CACxB,IAAI,WAAW,KAAA,KAAa,CAAC,KAAK,SAAS,GAAG,GAAG,OAAO;CACxD,IAAI,MAAM,OAAO;CACjB,OAAO,IAAI,aAAa,KAAA,GACtB,MAAM,IAAI,SAAS,IAAI,SAAS,SAAS,EAAE,CAAC;CAE9C,IAAI,CAAC,UAAU,UAAU,GAAG,KAAK,IAAI,gBAAgB,WAAW,GAC9D,OAAO;CACT,MAAM,QAAQ,IAAI,IAChB,IAAI,mBAAmB,KAAK,aAAa,OAAO,SAAS,IAAI,CAAC,CAChE;CACA,IAAI,aAAa;CACjB,IAAI,QAAQ;CACZ,IAAI,aAAa;CACjB,KAAK,IAAI,IAAI,GAAG,IAAI,KAAK,QAAQ,KAAK;EACpC,MAAM,OAAO,KAAK;EAClB,IAAI,QAAQ,KAAK,MAAM,YAAY;GACjC,cAAc;GACd,IAAI,SAAS,MAAM,cAAc,KAAK,EAAE,MAAM;QACzC,IAAI,SAAS,KAAK;QAClB,IAAI,SAAS,KAAK;EACzB,OAAO,IAAI,SAAS,KAClB,cAAc;OACT,IAAI,KAAK,IAAI,OAAO,KAAK;GAC9B,cAAc;GACd;EACF,OAAO;GACL,MAAM,QAAQ,UAAU,KAAK,KAAK,MAAM,CAAC,CAAC;GAC1C,IAAI,UAAU,QAAQ,MAAM,IAAI,MAAM,EAAE,GAAG;IACzC,cAAc,MAAM;IACpB,KAAK,MAAM,EAAE,CAAC,SAAS;IACvB,MAAM,OAAO,KAAK,IAAI;IACtB,IAAI,SAAS,KAAK,aAAa,IAAI;SAC9B,IAAI,SAAS,KAAA,KAAa,CAAC,OAAO,SAAS,IAAI,GAClD,cAAc;GAClB,OACE,cAAc;EAElB;CACF;CACA,OAAO;AACT;AAOA,MAAM,2BAA2B;CAQ/B,WAPoC;EAClC,IAAI;GACF,OAAO,IAAI,IAAI,qBAAqB,CAAC,CAAC,aAAa,KAAA;EACrD,QAAQ;GACN,OAAO;EACT;CACF,EAAA,CACuB,GACrB,MAAM,cAAc,IAAI;EACtB,IAAa,WAAW;GACtB,OAAO;EACT;EACA,IAAa,WAAW;GACtB,OAAO;EACT;CACF;CAUF,WAPmC;EACjC,IAAI;GACF,OAAO,IAAI,QAAQ,qBAAqB,CAAC,CAAC,WAAW,KAAA;EACvD,QAAQ;GACN,OAAO;EACT;CACF,EAAA,CACsB,GAGpB,OAAO,eAAe,QAAQ,WAAW,UAAU;EACjD,WAAW,IAAI,YAAY;EAC3B,cAAc;CAChB,CAAC;AAEL"}
|
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gaganref/confect-server",
|
|
3
|
-
"version": "10.3.1-fork.
|
|
3
|
+
"version": "10.3.1-fork.40",
|
|
4
4
|
"dependencies": {
|
|
5
5
|
"@effect/ai-openai-compat": "4.0.4",
|
|
6
6
|
"@effect/ai-openrouter": "4.0.4"
|
|
7
7
|
},
|
|
8
8
|
"peerDependencies": {
|
|
9
|
-
"@confect/core": "npm:@gaganref/confect-core@10.3.1-fork.
|
|
9
|
+
"@confect/core": "npm:@gaganref/confect-core@10.3.1-fork.40",
|
|
10
10
|
"@effect/platform-node": ">=4.0.0 <4.1.0",
|
|
11
11
|
"convex": "^1.48.0",
|
|
12
12
|
"effect": ">=4.0.4 <4.1.0"
|
package/src/HttpRouter.ts
CHANGED
|
@@ -24,6 +24,8 @@ import type * as HttpApiGroup from "effect/http-api/HttpApiGroup";
|
|
|
24
24
|
import type * as Etag from "effect/http/Etag";
|
|
25
25
|
import type * as HttpPlatform from "effect/http/HttpPlatform";
|
|
26
26
|
import * as HttpRouter from "effect/http/HttpRouter";
|
|
27
|
+
import * as HttpMiddleware from "effect/http/HttpMiddleware";
|
|
28
|
+
import type * as HttpServerRequest from "effect/http/HttpServerRequest";
|
|
27
29
|
import * as HttpServer from "effect/http/HttpServer";
|
|
28
30
|
import type * as ActionRunner from "./ActionRunner.js";
|
|
29
31
|
import type * as Auth from "./Auth.js";
|
|
@@ -33,6 +35,7 @@ import type * as DatabaseSchema from "./DatabaseSchema.js";
|
|
|
33
35
|
import type * as DataModel from "./DataModel.js";
|
|
34
36
|
import type * as Handler from "./Handler.js";
|
|
35
37
|
import * as ConvexConfigProvider from "./ConvexConfigProvider.js";
|
|
38
|
+
import * as ObservabilityRuntime from "./internal/observability.js";
|
|
36
39
|
import * as ConvexLogger from "./ConvexLogger.js";
|
|
37
40
|
import type * as MutationRunner from "./MutationRunner.js";
|
|
38
41
|
import type * as QueryRunner from "./QueryRunner.js";
|
|
@@ -116,9 +119,17 @@ export type Routes<Services_ = Services> = Layer.Layer<
|
|
|
116
119
|
*/
|
|
117
120
|
export const make = <Id extends string, Groups extends HttpApiGroup.Constraint>(
|
|
118
121
|
routes: Routes,
|
|
119
|
-
options?: {
|
|
122
|
+
options?: {
|
|
123
|
+
readonly observability?: Layer.Layer<never> | undefined;
|
|
124
|
+
readonly api?: HttpApi.HttpApi<Id, Groups> | undefined;
|
|
125
|
+
},
|
|
120
126
|
): ConvexHttpRouter =>
|
|
121
|
-
makeWithLayer(
|
|
127
|
+
makeWithLayer(
|
|
128
|
+
routes,
|
|
129
|
+
RegisteredFunction.baseActionLayer,
|
|
130
|
+
options?.api,
|
|
131
|
+
options?.observability,
|
|
132
|
+
);
|
|
122
133
|
|
|
123
134
|
/**
|
|
124
135
|
* Derive HTTP capabilities and ID scopes from the generated database schema.
|
|
@@ -131,7 +142,10 @@ export const forSchema =
|
|
|
131
142
|
) =>
|
|
132
143
|
<Id extends string, Groups extends HttpApiGroup.Constraint>(
|
|
133
144
|
routes: Routes<Handler.ActionServices<DatabaseSchema_>>,
|
|
134
|
-
options?: {
|
|
145
|
+
options?: {
|
|
146
|
+
readonly observability?: Layer.Layer<never> | undefined;
|
|
147
|
+
readonly api?: HttpApi.HttpApi<Id, Groups> | undefined;
|
|
148
|
+
},
|
|
135
149
|
): ConvexHttpRouter =>
|
|
136
150
|
makeWithLayer<
|
|
137
151
|
Handler.ActionServices<DatabaseSchema_>,
|
|
@@ -148,6 +162,8 @@ export const forSchema =
|
|
|
148
162
|
),
|
|
149
163
|
(ctx) => RegisteredFunction.actionLayer(schema, ctx),
|
|
150
164
|
options?.api,
|
|
165
|
+
options?.observability,
|
|
166
|
+
schema.target.kind === "component",
|
|
151
167
|
);
|
|
152
168
|
|
|
153
169
|
// Convex uses a component-relative path to select its HTTP action but passes
|
|
@@ -175,15 +191,38 @@ const makeWithLayer = <
|
|
|
175
191
|
routes: Routes<Services_>,
|
|
176
192
|
layer: (ctx: GenericActionCtx<DataModel_>) => Layer.Layer<Services_>,
|
|
177
193
|
api: HttpApi.HttpApi<Id, Groups> | undefined,
|
|
194
|
+
observability?: Layer.Layer<never>,
|
|
195
|
+
siteRelative = false,
|
|
178
196
|
): ConvexHttpRouter => {
|
|
179
197
|
applyMonkeyPatches();
|
|
180
198
|
|
|
199
|
+
const spanName = Layer.effect(
|
|
200
|
+
HttpMiddleware.SpanNameGenerator,
|
|
201
|
+
Effect.gen(function* () {
|
|
202
|
+
const prefix = siteRelative
|
|
203
|
+
? (yield* Config.schema(
|
|
204
|
+
Schema.URLFromString,
|
|
205
|
+
"CONVEX_SITE_URL",
|
|
206
|
+
)).pathname.replace(/\/$/, "")
|
|
207
|
+
: "";
|
|
208
|
+
return (request: HttpServerRequest.HttpServerRequest) =>
|
|
209
|
+
convexHttpRouter.lookup(
|
|
210
|
+
new URL(request.originalUrl).pathname.slice(prefix.length) || "/",
|
|
211
|
+
request.method as (typeof ROUTABLE_HTTP_METHODS)[number],
|
|
212
|
+
)?.[2] ?? "/*";
|
|
213
|
+
}).pipe(Effect.orDie),
|
|
214
|
+
);
|
|
215
|
+
|
|
181
216
|
// Provided (not just merged) so that route layers' own construction—e.g.
|
|
182
217
|
// a `Layer.unwrap` reading `Config`—resolves configuration through the
|
|
183
218
|
// Convex-aware provider; merged so that request fibers—endpoint handlers
|
|
184
219
|
// and middleware—do too.
|
|
185
220
|
const AppLayer = routes.pipe(
|
|
186
|
-
Layer.provideMerge(
|
|
221
|
+
Layer.provideMerge(
|
|
222
|
+
observability === undefined
|
|
223
|
+
? ConvexLogger.layer
|
|
224
|
+
: Layer.merge(ObservabilityRuntime.memoized(observability), spanName),
|
|
225
|
+
),
|
|
187
226
|
Layer.provideMerge(ConvexConfigProvider.layer),
|
|
188
227
|
Layer.provide(HttpServer.layerServices),
|
|
189
228
|
);
|
|
@@ -193,6 +232,17 @@ const makeWithLayer = <
|
|
|
193
232
|
// exposes as a per-request context argument.
|
|
194
233
|
const { handler } = HttpRouter.toWebHandler(AppLayer, {
|
|
195
234
|
disableLogger: true,
|
|
235
|
+
/* oxlint-disable effecttsgo/any-unknown-in-error-context -- Keep Effect's erased HTTP boundary errors intact. */
|
|
236
|
+
...(observability === undefined
|
|
237
|
+
? {}
|
|
238
|
+
: {
|
|
239
|
+
middleware: (effect) =>
|
|
240
|
+
Effect.andThen(
|
|
241
|
+
Effect.annotateCurrentSpan("kind", "httpAction"),
|
|
242
|
+
effect,
|
|
243
|
+
),
|
|
244
|
+
}),
|
|
245
|
+
/* oxlint-enable effecttsgo/any-unknown-in-error-context */
|
|
196
246
|
});
|
|
197
247
|
|
|
198
248
|
const httpAction = httpActionGeneric((ctx, request): Promise<Response> => {
|