@alxia/graphql 0.4.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -137,6 +137,26 @@ graphql(app, {
137
137
  - **CORS** is `@alxia/cors`'s for the whole app: Yoga's own is off unless
138
138
  `cors` is given.
139
139
 
140
+ ## Which operation ran
141
+
142
+ Every call is a `POST /graphql`; `graphql()` tells the observers around it
143
+ which operation it executes. Behind `use(logger())` the request's line
144
+ carries `operationName` and `operationType`, and behind
145
+ `use(telemetry({ … }))` its span is named `query GetNotes`, with
146
+ OpenTelemetry's `graphql.operation.name` and `graphql.operation.type`. A
147
+ batched body is one line and one span, `batch`, with every name.
148
+
149
+ ```ts
150
+ const app = alxia()
151
+ .use(logger())
152
+ .use(telemetry({ service: 'notes' }))
153
+ .plugin((app) => graphql(app, { schema }));
154
+ ```
155
+
156
+ A request
157
+ refused before it executes, and an operation over `ws: true`, name none yet.
158
+ See [the endpoint guide](https://github.com/softistx/alxia/blob/develop/packages/graphql/docs/guide/endpoint.md#the-operation-in-the-log-and-the-trace).
159
+
140
160
  ## WebSocket
141
161
 
142
162
  `ws: true` serves the endpoint over WebSocket too, with the
@@ -1 +1 @@
1
- {"version":3,"file":"graphql.d.ts","sourceRoot":"","sources":["../src/graphql.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,KAAK,KAAK,EACV,KAAK,WAAW,EAChB,KAAK,KAAK,EAEV,KAAK,SAAS,EACd,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EACX,wBAAwB,EACxB,kBAAkB,EAClB,iBAAiB,EACjB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAkB,KAAK,WAAW,EAAe,MAAM,WAAW,CAAC;AAC1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,KAAK,gBAAgB,EAAiB,MAAM,MAAM,CAAC;AAE5D,oFAAoF;AACpF,KAAK,SAAS,GACX,QAAQ,GACR,OAAO,GACP,SAAS,GACT,SAAS,GACT,MAAM,GACN,OAAO,GACP,UAAU,CAAC;AAEd;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,GAAG,IAAI,IAAI,CAAC,WAAW,GAAG,GAAG,EAAE,SAAS,CAAC,CAAC;AAEpE;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CAC9D;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,CAAC,GAAG,EAAE,WAAW,GAAG,KAAK,IAAI,GAAG,SAAS;IAClE,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,CAAC;CAC/B,GACE,kBAAkB,GAAG,aAAa,CAAC,GAAG,CAAC,GAAG,gBAAgB,GAAG,WAAW,GAGzE;IACC,QAAQ,CAAC,QAAQ,EAAE,qEAAqE,CAAC;CACzF,CAAC;AAEJ,MAAM,WAAW,cAAc,CAC9B,SAAS,SAAS,WAAW,EAC7B,OAAO,SAAS,WAAW,EAC3B,IAAI,SAAS,SAAS,EACtB,SAAS,GAAG,OAAO,CAClB,SAAQ,IAAI,CACZ,iBAAiB,CAAC,SAAS,EAAE,OAAO,CAAC,EACrC,iBAAiB,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAClD;IACD;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,UAAU,GAAG,gBAAgB,GAAG,KAAK,CAAC;IACrD,gEAAgE;IAChE,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAC1B,iBAAiB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,UAAU,CAAC,EACjD,OAAO,CACP,CAAC;IACF,gEAAgE;IAChE,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC;IAClC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,wBAAwB,CAAC,SAAS,CAAC,CAAC;IACrD,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC;IACrB;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,iBAAiB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;IAC9D;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,OAAO,GAAG,gBAAgB,CAAC;CACzC;AAED;;;;GAIG;AACH,KAAK,eAAe,CAAC,QAAQ,EAAE,QAAQ,IAAI,QAAQ,SAAS,QAAQ,GACjE,OAAO,GACP;IACA,QAAQ,CAAC,MAAM,EAAE,yEAAyE,OAAO,CAChG,MAAM,QAAQ,EACd,MAAM,QAAQ,CACd,GACA,MAAM,EAAE,CAAC;CACV,CAAC;AAEJ;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,OAAO,CACtB,GAAG,SAAS,MAAM,EAClB,MAAM,SAAS,MAAM,EACrB,SAAS,EACT,OAAO,SAAS,WAAW,GAAG,KAAK,EACnC,KAAK,CAAC,IAAI,SAAS,SAAS,GAAG,UAAU,EAEzC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,EACvB,OAAO,EAAE,cAAc,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,GACpE,eAAe,CACd,kBAAkB,GAAG,aAAa,CAAC,GAAG,CAAC,GAAG,OAAO,EACjD,SAAS,CACT,GACA,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,CAqCpB"}
1
+ {"version":3,"file":"graphql.d.ts","sourceRoot":"","sources":["../src/graphql.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,KAAK,KAAK,EACV,KAAK,WAAW,EAChB,KAAK,KAAK,EAEV,KAAK,SAAS,EACd,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EACX,wBAAwB,EACxB,kBAAkB,EAClB,iBAAiB,EACjB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAkB,KAAK,WAAW,EAAe,MAAM,WAAW,CAAC;AAE1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,KAAK,gBAAgB,EAAiB,MAAM,MAAM,CAAC;AAE5D,oFAAoF;AACpF,KAAK,SAAS,GACX,QAAQ,GACR,OAAO,GACP,SAAS,GACT,SAAS,GACT,MAAM,GACN,OAAO,GACP,UAAU,CAAC;AAEd;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,GAAG,IAAI,IAAI,CAAC,WAAW,GAAG,GAAG,EAAE,SAAS,CAAC,CAAC;AAEpE;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CAC9D;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,CAAC,GAAG,EAAE,WAAW,GAAG,KAAK,IAAI,GAAG,SAAS;IAClE,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,CAAC;CAC/B,GACE,kBAAkB,GAAG,aAAa,CAAC,GAAG,CAAC,GAAG,gBAAgB,GAAG,WAAW,GAGzE;IACC,QAAQ,CAAC,QAAQ,EAAE,qEAAqE,CAAC;CACzF,CAAC;AAEJ,MAAM,WAAW,cAAc,CAC9B,SAAS,SAAS,WAAW,EAC7B,OAAO,SAAS,WAAW,EAC3B,IAAI,SAAS,SAAS,EACtB,SAAS,GAAG,OAAO,CAClB,SAAQ,IAAI,CACZ,iBAAiB,CAAC,SAAS,EAAE,OAAO,CAAC,EACrC,iBAAiB,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAClD;IACD;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,UAAU,GAAG,gBAAgB,GAAG,KAAK,CAAC;IACrD,gEAAgE;IAChE,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAC1B,iBAAiB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,UAAU,CAAC,EACjD,OAAO,CACP,CAAC;IACF,gEAAgE;IAChE,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC;IAClC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,wBAAwB,CAAC,SAAS,CAAC,CAAC;IACrD,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC;IACrB;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,iBAAiB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;IAC9D;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,OAAO,GAAG,gBAAgB,CAAC;CACzC;AAED;;;;GAIG;AACH,KAAK,eAAe,CAAC,QAAQ,EAAE,QAAQ,IAAI,QAAQ,SAAS,QAAQ,GACjE,OAAO,GACP;IACA,QAAQ,CAAC,MAAM,EAAE,yEAAyE,OAAO,CAChG,MAAM,QAAQ,EACd,MAAM,QAAQ,CACd,GACA,MAAM,EAAE,CAAC;CACV,CAAC;AAEJ;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,OAAO,CACtB,GAAG,SAAS,MAAM,EAClB,MAAM,SAAS,MAAM,EACrB,SAAS,EACT,OAAO,SAAS,WAAW,GAAG,KAAK,EACnC,KAAK,CAAC,IAAI,SAAS,SAAS,GAAG,UAAU,EAEzC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,EACvB,OAAO,EAAE,cAAc,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,GACpE,eAAe,CACd,kBAAkB,GAAG,aAAa,CAAC,GAAG,CAAC,GAAG,OAAO,EACjD,SAAS,CACT,GACA,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,CAsCpB"}
package/dist/index.js CHANGED
@@ -161,6 +161,25 @@ function endedOnShutdown(response, signal) {
161
161
  });
162
162
  }
163
163
 
164
+ // src/operation.ts
165
+ import { reportOperation } from "@alxia/core";
166
+ import { getOperationAST } from "graphql";
167
+ function report(args) {
168
+ const operation = getOperationAST(args.document, args.operationName);
169
+ if (operation === undefined || operation === null)
170
+ return;
171
+ reportOperation(args.contextValue, {
172
+ type: operation.operation,
173
+ name: operation.name?.value
174
+ });
175
+ }
176
+ function reportsOperations() {
177
+ return {
178
+ onExecute: ({ args }) => report(args),
179
+ onSubscribe: ({ args }) => report(args)
180
+ };
181
+ }
182
+
164
183
  // src/ws.ts
165
184
  var MISSING_PEER = "@alxia/graphql: graphql(app, { ws }) serves GraphQL over WebSocket with the optional peer graphql-ws, which is not installed: bun add graphql-ws";
166
185
  function loader() {
@@ -303,6 +322,7 @@ function graphql(app, options) {
303
322
  const page = graphiql ?? true;
304
323
  const yogaAt = yogaServers({
305
324
  ...yogaOptions,
325
+ plugins: [...yogaOptions.plugins ?? [], reportsOperations()],
306
326
  cors,
307
327
  graphiql: ide === undefined ? (_request, context) => isDev(context) && page : ide === "graphiql" ? page : false
308
328
  });
@@ -322,5 +342,5 @@ export {
322
342
  renderSandbox
323
343
  };
324
344
 
325
- //# debugId=E799A72AD243BAC264756E2164756E21
345
+ //# debugId=FE06B312B406C45364756E2164756E21
326
346
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1,13 +1,14 @@
1
1
  {
2
2
  "version": 3,
3
- "sources": ["../src/graphql.ts", "../src/handler.ts", "../src/sandbox.ts", "../src/ws.ts"],
3
+ "sources": ["../src/graphql.ts", "../src/handler.ts", "../src/sandbox.ts", "../src/operation.ts", "../src/ws.ts"],
4
4
  "sourcesContent": [
5
- "import {\n\ttype Alxia,\n\ttype BaseContext,\n\ttype Empty,\n\tisDev,\n\ttype RoutePath,\n} from '@alxia/core';\nimport type {\n\tGraphQLSchemaWithContext,\n\tYogaInitialContext,\n\tYogaServerOptions,\n} from 'graphql-yoga';\nimport { graphqlHandler, type YogaContext, yogaServers } from './handler';\nimport type { SandboxOptions } from './sandbox';\nimport { type GraphQLWsOptions, graphqlSocket } from './ws';\n\n/** The parts of a route's context Yoga owns, or that mean nothing to a resolver. */\ntype RouteOnly =\n\t| 'params'\n\t| 'query'\n\t| 'headers'\n\t| 'cookies'\n\t| 'body'\n\t| 'reply'\n\t| 'redirect';\n\n/**\n * What alxia hands Yoga for each request: the context its middlewares built —\n * `user`, `db`, `log`… — with `request`, `url`, `ip` and `set`, through\n * which a resolver sets a cookie or a header on the response.\n */\nexport type ServerContext<Ctx> = Omit<BaseContext & Ctx, RouteOnly>;\n\n/**\n * What an operation over WebSocket adds to its context (`ws` on): the\n * `connectionParams` the client sent when it connected. `undefined` over\n * HTTP, and for a client that sent none.\n */\nexport interface GraphQLWsContext {\n\treadonly connectionParams?: Readonly<Record<string, unknown>>;\n}\n\n/**\n * What a resolver reads as its context: Yoga's own, the app's, what\n * the `context` option adds, and over WebSocket the `connectionParams`. Type a schema with it:\n *\n * ```ts\n * const base = alxia().use(bearer({ jwt }));\n * const schema = createSchema<GraphQLContext<typeof base>>({ ... });\n * ```\n */\nexport type GraphQLContext<App, UserContext = Empty> = App extends {\n\treadonly '~context': infer Ctx;\n}\n\t? YogaInitialContext & ServerContext<Ctx> & GraphQLWsContext & UserContext\n\t: // Not `never`: a schema typed with `never` would let every resolver\n\t\t// read anything until `graphql()` refused it.\n\t\t{\n\t\t\treadonly '~error': 'GraphQLContext needs the type of an app: GraphQLContext<typeof app>';\n\t\t};\n\nexport interface GraphQLOptions<\n\tServerCtx extends YogaContext,\n\tUserCtx extends YogaContext,\n\tPath extends RoutePath,\n\tSchemaCtx = unknown,\n> extends Omit<\n\t\tYogaServerOptions<ServerCtx, UserCtx>,\n\t\t'graphqlEndpoint' | 'cors' | 'schema' | 'graphiql'\n\t> {\n\t/**\n\t * What a browser gets at the endpoint: Yoga's GraphiQL, Apollo Sandbox,\n\t * or nothing. By default, GraphiQL in the serving app's dev alone\n\t * (`isDev`: `alxia({ dev })`, else `NODE_ENV=development`), nothing\n\t * otherwise; `graphiql` or `apollo-sandbox` serves one everywhere.\n\t */\n\treadonly ide?: 'graphiql' | 'apollo-sandbox' | false;\n\t/** GraphiQL's options, Yoga's own, when `ide` is `graphiql`. */\n\treadonly graphiql?: Exclude<\n\t\tYogaServerOptions<ServerCtx, UserCtx>['graphiql'],\n\t\tboolean\n\t>;\n\t/** Apollo Sandbox's options, when `ide` is `apollo-sandbox`. */\n\treadonly sandbox?: SandboxOptions;\n\t/**\n\t * The schema, from Yoga's `createSchema`, Pothos, or any tool that types\n\t * its context. Its context must be one the app builds: a resolver that\n\t * reads `user` behind no middleware that adds one is a compile error.\n\t */\n\treadonly schema: GraphQLSchemaWithContext<SchemaCtx>;\n\t/** Where the endpoint is, under the app's prefix. `/graphql` by default. */\n\treadonly path?: Path;\n\t/**\n\t * Yoga's own CORS. Off by default: `@alxia/cors` answers for the whole\n\t * app, this endpoint included.\n\t */\n\treadonly cors?: YogaServerOptions<ServerCtx, UserCtx>['cors'];\n\t/**\n\t * GraphQL over WebSocket too, the `graphql-transport-ws` protocol of\n\t * Apollo Client's and urql's default link, served by the optional peer\n\t * `graphql-ws` at the endpoint's path: `true`, or where and how often it\n\t * pings. Off by default: subscriptions are served over server-sent\n\t * events, which stay served beside it.\n\t */\n\treadonly ws?: boolean | GraphQLWsOptions;\n}\n\n/**\n * The check Yoga's types leave out: the context the app builds must hold\n * what the schema's resolvers read. A mistake comes back as a `schema`\n * whose type is the message.\n */\ntype ProvidesContext<Provided, Required> = Provided extends Required\n\t? unknown\n\t: {\n\t\t\treadonly schema: `the schema's resolvers read a context the app does not build: missing ${Exclude<\n\t\t\t\tkeyof Required,\n\t\t\t\tkeyof Provided\n\t\t\t> &\n\t\t\t\tstring}`;\n\t\t};\n\n/**\n * A GraphQL endpoint on `app`, served by [GraphQL Yoga](https://the-guild.dev/graphql/yoga-server):\n * `GET` and `POST` at `path`, behind every middleware given to `use` on `app`\n * before it. A guard before it guards it; what the middlewares added is in each\n * resolver's context, typed. Yoga's options pass through — `plugins`\n * (Envelop's and Yoga's), `graphiql`, `maskedErrors`, `batching`… —\n * and subscriptions are served over server-sent events, and over\n * WebSocket too with `ws: true`.\n *\n * ```ts\n * const app = alxia()\n * .use(bearer({ jwt }))\n * .plugin((app) => graphql(app, { schema, plugins: [useDepthLimit()] }));\n * ```\n */\nexport function graphql<\n\tCtx extends object,\n\tPrefix extends string,\n\tSchemaCtx,\n\tUserCtx extends YogaContext = Empty,\n\tconst Path extends RoutePath = '/graphql',\n>(\n\tapp: Alxia<Ctx, Prefix>,\n\toptions: GraphQLOptions<ServerContext<Ctx>, UserCtx, Path, SchemaCtx> &\n\t\tProvidesContext<\n\t\t\tYogaInitialContext & ServerContext<Ctx> & UserCtx,\n\t\t\tSchemaCtx\n\t\t>,\n): Alxia<Ctx, Prefix> {\n\tconst {\n\t\tpath = '/graphql' as Path,\n\t\tcors = false,\n\t\tide,\n\t\tgraphiql,\n\t\tsandbox,\n\t\tws = false,\n\t\t...yogaOptions\n\t} = options;\n\tconst page = graphiql ?? true;\n\tconst yogaAt = yogaServers<UserCtx>({\n\t\t...(yogaOptions as YogaServerOptions<YogaContext, UserCtx>),\n\t\tcors,\n\t\tgraphiql: (ide === undefined\n\t\t\t? (_request: Request, context: object) => isDev(context) && page\n\t\t\t: ide === 'graphiql'\n\t\t\t\t? page\n\t\t\t\t: false) as YogaServerOptions<YogaContext, UserCtx>['graphiql'],\n\t});\n\tconst handler = graphqlHandler(\n\t\tyogaAt,\n\t\tide === 'apollo-sandbox' ? (sandbox ?? {}) : false,\n\t);\n\n\tconst route = app as unknown as {\n\t\tget(path: string, handler: unknown): unknown;\n\t\tpost(path: string, handler: unknown): unknown;\n\t\tws(path: string, ...rest: unknown[]): unknown;\n\t};\n\troute.get(path, handler);\n\troute.post(path, handler);\n\tif (ws !== false) {\n\t\tconst socket = graphqlSocket(yogaAt, path, ws === true ? {} : ws);\n\t\troute.ws(socket.path, socket.middleware, socket.handlers);\n\t}\n\treturn app as never;\n}\n",
5
+ "import {\n\ttype Alxia,\n\ttype BaseContext,\n\ttype Empty,\n\tisDev,\n\ttype RoutePath,\n} from '@alxia/core';\nimport type {\n\tGraphQLSchemaWithContext,\n\tYogaInitialContext,\n\tYogaServerOptions,\n} from 'graphql-yoga';\nimport { graphqlHandler, type YogaContext, yogaServers } from './handler';\nimport { reportsOperations } from './operation';\nimport type { SandboxOptions } from './sandbox';\nimport { type GraphQLWsOptions, graphqlSocket } from './ws';\n\n/** The parts of a route's context Yoga owns, or that mean nothing to a resolver. */\ntype RouteOnly =\n\t| 'params'\n\t| 'query'\n\t| 'headers'\n\t| 'cookies'\n\t| 'body'\n\t| 'reply'\n\t| 'redirect';\n\n/**\n * What alxia hands Yoga for each request: the context its middlewares built —\n * `user`, `db`, `log`… — with `request`, `url`, `ip` and `set`, through\n * which a resolver sets a cookie or a header on the response.\n */\nexport type ServerContext<Ctx> = Omit<BaseContext & Ctx, RouteOnly>;\n\n/**\n * What an operation over WebSocket adds to its context (`ws` on): the\n * `connectionParams` the client sent when it connected. `undefined` over\n * HTTP, and for a client that sent none.\n */\nexport interface GraphQLWsContext {\n\treadonly connectionParams?: Readonly<Record<string, unknown>>;\n}\n\n/**\n * What a resolver reads as its context: Yoga's own, the app's, what\n * the `context` option adds, and over WebSocket the `connectionParams`. Type a schema with it:\n *\n * ```ts\n * const base = alxia().use(bearer({ jwt }));\n * const schema = createSchema<GraphQLContext<typeof base>>({ ... });\n * ```\n */\nexport type GraphQLContext<App, UserContext = Empty> = App extends {\n\treadonly '~context': infer Ctx;\n}\n\t? YogaInitialContext & ServerContext<Ctx> & GraphQLWsContext & UserContext\n\t: // Not `never`: a schema typed with `never` would let every resolver\n\t\t// read anything until `graphql()` refused it.\n\t\t{\n\t\t\treadonly '~error': 'GraphQLContext needs the type of an app: GraphQLContext<typeof app>';\n\t\t};\n\nexport interface GraphQLOptions<\n\tServerCtx extends YogaContext,\n\tUserCtx extends YogaContext,\n\tPath extends RoutePath,\n\tSchemaCtx = unknown,\n> extends Omit<\n\t\tYogaServerOptions<ServerCtx, UserCtx>,\n\t\t'graphqlEndpoint' | 'cors' | 'schema' | 'graphiql'\n\t> {\n\t/**\n\t * What a browser gets at the endpoint: Yoga's GraphiQL, Apollo Sandbox,\n\t * or nothing. By default, GraphiQL in the serving app's dev alone\n\t * (`isDev`: `alxia({ dev })`, else `NODE_ENV=development`), nothing\n\t * otherwise; `graphiql` or `apollo-sandbox` serves one everywhere.\n\t */\n\treadonly ide?: 'graphiql' | 'apollo-sandbox' | false;\n\t/** GraphiQL's options, Yoga's own, when `ide` is `graphiql`. */\n\treadonly graphiql?: Exclude<\n\t\tYogaServerOptions<ServerCtx, UserCtx>['graphiql'],\n\t\tboolean\n\t>;\n\t/** Apollo Sandbox's options, when `ide` is `apollo-sandbox`. */\n\treadonly sandbox?: SandboxOptions;\n\t/**\n\t * The schema, from Yoga's `createSchema`, Pothos, or any tool that types\n\t * its context. Its context must be one the app builds: a resolver that\n\t * reads `user` behind no middleware that adds one is a compile error.\n\t */\n\treadonly schema: GraphQLSchemaWithContext<SchemaCtx>;\n\t/** Where the endpoint is, under the app's prefix. `/graphql` by default. */\n\treadonly path?: Path;\n\t/**\n\t * Yoga's own CORS. Off by default: `@alxia/cors` answers for the whole\n\t * app, this endpoint included.\n\t */\n\treadonly cors?: YogaServerOptions<ServerCtx, UserCtx>['cors'];\n\t/**\n\t * GraphQL over WebSocket too, the `graphql-transport-ws` protocol of\n\t * Apollo Client's and urql's default link, served by the optional peer\n\t * `graphql-ws` at the endpoint's path: `true`, or where and how often it\n\t * pings. Off by default: subscriptions are served over server-sent\n\t * events, which stay served beside it.\n\t */\n\treadonly ws?: boolean | GraphQLWsOptions;\n}\n\n/**\n * The check Yoga's types leave out: the context the app builds must hold\n * what the schema's resolvers read. A mistake comes back as a `schema`\n * whose type is the message.\n */\ntype ProvidesContext<Provided, Required> = Provided extends Required\n\t? unknown\n\t: {\n\t\t\treadonly schema: `the schema's resolvers read a context the app does not build: missing ${Exclude<\n\t\t\t\tkeyof Required,\n\t\t\t\tkeyof Provided\n\t\t\t> &\n\t\t\t\tstring}`;\n\t\t};\n\n/**\n * A GraphQL endpoint on `app`, served by [GraphQL Yoga](https://the-guild.dev/graphql/yoga-server):\n * `GET` and `POST` at `path`, behind every middleware given to `use` on `app`\n * before it. A guard before it guards it; what the middlewares added is in each\n * resolver's context, typed. Yoga's options pass through — `plugins`\n * (Envelop's and Yoga's), `graphiql`, `maskedErrors`, `batching`… —\n * and subscriptions are served over server-sent events, and over\n * WebSocket too with `ws: true`.\n *\n * ```ts\n * const app = alxia()\n * .use(bearer({ jwt }))\n * .plugin((app) => graphql(app, { schema, plugins: [useDepthLimit()] }));\n * ```\n */\nexport function graphql<\n\tCtx extends object,\n\tPrefix extends string,\n\tSchemaCtx,\n\tUserCtx extends YogaContext = Empty,\n\tconst Path extends RoutePath = '/graphql',\n>(\n\tapp: Alxia<Ctx, Prefix>,\n\toptions: GraphQLOptions<ServerContext<Ctx>, UserCtx, Path, SchemaCtx> &\n\t\tProvidesContext<\n\t\t\tYogaInitialContext & ServerContext<Ctx> & UserCtx,\n\t\t\tSchemaCtx\n\t\t>,\n): Alxia<Ctx, Prefix> {\n\tconst {\n\t\tpath = '/graphql' as Path,\n\t\tcors = false,\n\t\tide,\n\t\tgraphiql,\n\t\tsandbox,\n\t\tws = false,\n\t\t...yogaOptions\n\t} = options;\n\tconst page = graphiql ?? true;\n\tconst yogaAt = yogaServers<UserCtx>({\n\t\t...(yogaOptions as YogaServerOptions<YogaContext, UserCtx>),\n\t\tplugins: [...(yogaOptions.plugins ?? []), reportsOperations()],\n\t\tcors,\n\t\tgraphiql: (ide === undefined\n\t\t\t? (_request: Request, context: object) => isDev(context) && page\n\t\t\t: ide === 'graphiql'\n\t\t\t\t? page\n\t\t\t\t: false) as YogaServerOptions<YogaContext, UserCtx>['graphiql'],\n\t});\n\tconst handler = graphqlHandler(\n\t\tyogaAt,\n\t\tide === 'apollo-sandbox' ? (sandbox ?? {}) : false,\n\t);\n\n\tconst route = app as unknown as {\n\t\tget(path: string, handler: unknown): unknown;\n\t\tpost(path: string, handler: unknown): unknown;\n\t\tws(path: string, ...rest: unknown[]): unknown;\n\t};\n\troute.get(path, handler);\n\troute.post(path, handler);\n\tif (ws !== false) {\n\t\tconst socket = graphqlSocket(yogaAt, path, ws === true ? {} : ws);\n\t\troute.ws(socket.path, socket.middleware, socket.handlers);\n\t}\n\treturn app as never;\n}\n",
6
6
  "/**\n * The endpoint behind `graphql()`: one Yoga per path it is served at, and\n * the route handler that hands each request to it.\n */\nimport { type BaseContext, type StatusCode, shutdownSignal } from '@alxia/core';\nimport {\n\tcreateYoga,\n\ttype YogaServerInstance,\n\ttype YogaServerOptions,\n} from 'graphql-yoga';\nimport { renderSandbox, SANDBOX_POLICY, type SandboxOptions } from './sandbox';\n\nexport type YogaContext = Record<string, any>;\n\n/** Where Yoga's GraphiQL page loads its files from: one pinned version on unpkg. */\nconst GRAPHIQL_FILES =\n\t/https:\\/\\/unpkg\\.com\\/@graphql-yoga\\/graphiql@[\\w.-]+\\//;\n\n/**\n * What GraphiQL's page may load: its scripts, styles and Monaco's\n * workers from the exact version of `@graphql-yoga/graphiql` the page\n * names, fetched and run as blobs; queries to this server alone; framed\n * by no one. A page that names none (a `renderGraphiQL` of the app's own)\n * gets this server alone. `@alxia/secure-headers` keeps a policy a\n * response already has.\n */\nexport function graphiqlPolicy(html: string): string {\n\tconst files = html.match(GRAPHIQL_FILES)?.[0] ?? '';\n\tconst from = files === '' ? '' : ` ${files}`;\n\treturn [\n\t\t\"default-src 'self'\",\n\t\t`script-src 'self' 'unsafe-inline'${from}`,\n\t\t`style-src 'self' 'unsafe-inline'${from}`,\n\t\t\"img-src 'self' data: https:\",\n\t\t`font-src 'self' data:${from}`,\n\t\t\"worker-src 'self' blob:\",\n\t\t`connect-src 'self'${from}`,\n\t\t\"frame-ancestors 'none'\",\n\t].join('; ');\n}\n\n/**\n * The Yoga serving `endpoint`, created on first use. One per path: a plugin\n * mounted under a prefix serves the same routes at a longer path, and\n * GraphiQL must ask that one.\n */\nexport function yogaServers<UserCtx extends YogaContext>(\n\toptions: Omit<YogaServerOptions<YogaContext, UserCtx>, 'graphqlEndpoint'>,\n): (endpoint: string) => YogaServerInstance<YogaContext, UserCtx> {\n\tconst servers = new Map<string, YogaServerInstance<YogaContext, UserCtx>>();\n\treturn (endpoint) => {\n\t\tlet yoga = servers.get(endpoint);\n\t\tif (yoga === undefined) {\n\t\t\tyoga = createYoga<YogaContext, UserCtx>({\n\t\t\t\t...options,\n\t\t\t\tgraphqlEndpoint: endpoint,\n\t\t\t});\n\t\t\tservers.set(endpoint, yoga);\n\t\t}\n\t\treturn yoga;\n\t};\n}\n\n/**\n * What Yoga is handed as its server context: the route's context — the\n * middlewares' work — minus what a resolver has no use for.\n */\nexport function serverContext(\n\tctx: Record<string, unknown>,\n): Record<string, unknown> {\n\tconst {\n\t\tparams: _params,\n\t\tquery: _query,\n\t\theaders: _headers,\n\t\tcookies: _cookies,\n\t\tbody: _body,\n\t\treply: _reply,\n\t\tredirect: _redirect,\n\t\t...server\n\t} = ctx;\n\treturn server;\n}\n\n/**\n * The handler of the endpoint's `GET` and `POST`: Apollo Sandbox's page to\n * a browser when `sandbox` is not `false`, else the request to Yoga, with\n * the route's context — the middlewares' work, minus what a resolver has no use\n * for — as Yoga's server context.\n */\nexport function graphqlHandler<UserCtx extends YogaContext>(\n\tyogaAt: (endpoint: string) => YogaServerInstance<YogaContext, UserCtx>,\n\tsandbox: SandboxOptions | false,\n) {\n\t// A handler's context: its route is the one it was declared at. Named\n\t// `graphql`, the name the route table `listen` prints in dev shows.\n\treturn async function graphql(\n\t\tctx: Record<string, unknown> & BaseContext & { readonly route: string },\n\t) {\n\t\tconst { reply } = ctx;\n\t\tconst server = serverContext(ctx);\n\t\tif (\n\t\t\tsandbox !== false &&\n\t\t\tctx.request.method === 'GET' &&\n\t\t\tctx.request.headers.get('accept')?.includes('text/html') &&\n\t\t\t!ctx.url.searchParams.has('query')\n\t\t) {\n\t\t\t// A path: the page resolves it against its own address, so behind\n\t\t\t// a TLS proxy the Sandbox asks over https, as the browser did.\n\t\t\treturn reply(200, renderSandbox(ctx.route, sandbox), {\n\t\t\t\theaders: {\n\t\t\t\t\t'content-type': 'text/html;charset=utf-8',\n\t\t\t\t\t'content-security-policy': SANDBOX_POLICY,\n\t\t\t\t},\n\t\t\t});\n\t\t}\n\t\tconst response = await yogaAt(ctx.route).fetch(ctx.request, server);\n\t\tconst headers = new Headers(response.headers);\n\t\tif (\n\t\t\theaders.get('content-type')?.startsWith('text/html') &&\n\t\t\t!headers.has('content-security-policy')\n\t\t) {\n\t\t\t// GraphiQL's page: its policy names the files it loads.\n\t\t\tconst html = await response.text();\n\t\t\theaders.set('content-security-policy', graphiqlPolicy(html));\n\t\t\treturn reply(response.status as StatusCode, html, { headers });\n\t\t}\n\t\tconst body = endedOnShutdown(response, shutdownSignal(ctx));\n\t\treturn reply(response.status as StatusCode, body ?? undefined, {\n\t\t\theaders,\n\t\t});\n\t};\n}\n\n/**\n * A subscription's or an incremental delivery's body, which streams until\n * its reader stops: ended when the app starts shutting down — Yoga's\n * stream cancelled, as when the client leaves, and the client reading its\n * end — so the drain does not wait for it. Any other body finishes within\n * the drain as it is.\n */\nfunction endedOnShutdown(\n\tresponse: Response,\n\tsignal: AbortSignal,\n): ReadableStream<Uint8Array> | null {\n\tconst body = response.body;\n\tconst type = response.headers.get('content-type') ?? '';\n\tif (body === null || !/text\\/event-stream|multipart\\/mixed/.test(type)) {\n\t\treturn body;\n\t}\n\tconst reader = body.getReader();\n\treturn new ReadableStream<Uint8Array>({\n\t\tstart(controller) {\n\t\t\tconst end = () => {\n\t\t\t\tvoid reader.cancel();\n\t\t\t\ttry {\n\t\t\t\t\tcontroller.close();\n\t\t\t\t} catch {\n\t\t\t\t\t// Closed already: the stream had ended.\n\t\t\t\t}\n\t\t\t};\n\t\t\tif (signal.aborted) end();\n\t\t\telse signal.addEventListener('abort', end, { once: true });\n\t\t},\n\t\tasync pull(controller) {\n\t\t\tconst { value, done } = await reader.read();\n\t\t\tif (done) {\n\t\t\t\ttry {\n\t\t\t\t\tcontroller.close();\n\t\t\t\t} catch {\n\t\t\t\t\t// Closed already: the shutdown ended it.\n\t\t\t\t}\n\t\t\t\treturn;\n\t\t\t}\n\t\t\tcontroller.enqueue(value);\n\t\t},\n\t\tcancel: (reason) => reader.cancel(reason),\n\t});\n}\n",
7
7
  "/**\n * [Apollo Sandbox](https://www.apollographql.com/docs/graphos/platform/sandbox),\n * embedded: the page a browser gets at the endpoint when the IDE is\n * `apollo-sandbox`. `@nxgt/shared-graphql`'s `renderSandbox`, kept twice: the\n * Sandbox asks the address the page was opened at, as there since\n * nxgt-core#171, but here the page resolves the path itself, so a TLS proxy\n * in front changes nothing.\n */\n\nexport interface SandboxOptions {\n\t/** The page's title. `Sandbox Explorer` by default. */\n\treadonly title?: string;\n\t/** The operation the Sandbox opens with. */\n\treadonly initialDocument?: string;\n\t/** Headers every operation sends, shown and editable in the Sandbox. */\n\treadonly initialHeaders?: Readonly<Record<string, string>>;\n\t/** Whether the Sandbox polls the schema as it changes. On by default. */\n\treadonly pollForSchemaUpdates?: boolean;\n\t/** Whether operations send the browser's cookies: a session cookie. On by default. */\n\treadonly includeCookies?: boolean;\n}\n\n/** What the page loads: the Sandbox's script, its frame, and operations to this server. */\nexport const SANDBOX_POLICY = [\n\t\"default-src 'self'\",\n\t\"script-src 'self' 'unsafe-inline' https://embeddable-sandbox.cdn.apollographql.com\",\n\t\"style-src 'self' 'unsafe-inline'\",\n\t'frame-src https://sandbox.embed.apollographql.com',\n\t\"img-src 'self' data: https:\",\n\t\"connect-src 'self'\",\n].join('; ');\n\n/**\n * The page, its endpoint `endpoint`: a URL, or a path the page resolves\n * against its own address. Every value is escaped into its JavaScript and\n * HTML.\n */\nexport function renderSandbox(\n\tendpoint: string,\n\toptions: SandboxOptions = {},\n): string {\n\tconst config = {\n\t\ttarget: '#sandbox',\n\t\tinitialEndpoint: endpoint,\n\t\tinitialState: {\n\t\t\tincludeCookies: options.includeCookies ?? true,\n\t\t\tpollForSchemaUpdates: options.pollForSchemaUpdates ?? true,\n\t\t\t...(options.initialDocument === undefined\n\t\t\t\t? {}\n\t\t\t\t: { document: options.initialDocument }),\n\t\t\t...(options.initialHeaders === undefined\n\t\t\t\t? {}\n\t\t\t\t: { headers: options.initialHeaders }),\n\t\t},\n\t\thideCookieToggle: false,\n\t\tendpointIsEditable: false,\n\t};\n\treturn `<!doctype html>\n<html lang=\"en\">\n<head>\n<meta charset=\"utf-8\" />\n<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" />\n<title>${html(options.title ?? 'Sandbox Explorer')}</title>\n<style>html, body { margin: 0; height: 100%; } #sandbox { position: absolute; inset: 0; }</style>\n</head>\n<body>\n<div id=\"sandbox\"></div>\n<script src=\"https://embeddable-sandbox.cdn.apollographql.com/_latest/embeddable-sandbox.umd.production.min.js\"></script>\n<script>\n{\nconst config = ${script(config)};\nconfig.initialEndpoint = new URL(config.initialEndpoint, location.href).href;\nnew window.EmbeddedSandbox(config);\n}\n</script>\n</body>\n</html>`;\n}\n\nfunction html(text: string): string {\n\treturn text.replace(/[&<>\"']/g, (char) => `&#${char.charCodeAt(0)};`);\n}\n\n/** JSON that cannot close the `<script>` it is written in. */\nfunction script(value: unknown): string {\n\treturn JSON.stringify(value)\n\t\t.replace(/</g, '\\\\u003c')\n\t\t.replace(/>/g, '\\\\u003e')\n\t\t.replace(/\\u2028/g, '\\\\u2028')\n\t\t.replace(/\\u2029/g, '\\\\u2029');\n}\n",
8
+ "/**\n * The plugin that tells the observers around the endpoint — `@alxia/logger`,\n * `@alxia/telemetry` — which operation each request executes.\n */\nimport { reportOperation } from '@alxia/core';\nimport { getOperationAST } from 'graphql';\nimport type { Plugin } from 'graphql-yoga';\n\ninterface Executed {\n\treadonly document: Parameters<typeof getOperationAST>[0];\n\treadonly operationName?: string | null | undefined;\n\treadonly contextValue: unknown;\n}\n\n/** Reports the operation of `args`: its type, and its name when it has one. */\nfunction report(args: Executed): void {\n\tconst operation = getOperationAST(args.document, args.operationName);\n\tif (operation === undefined || operation === null) return;\n\treportOperation(args.contextValue as object, {\n\t\ttype: operation.operation,\n\t\tname: operation.name?.value,\n\t});\n}\n\n/**\n * A Yoga plugin reporting each operation Yoga executes or subscribes to,\n * through core's `reportOperation`: a batched body reports each of its\n * operations, a request refused before it executes none.\n */\nexport function reportsOperations(): Plugin {\n\treturn {\n\t\tonExecute: ({ args }) => report(args),\n\t\tonSubscribe: ({ args }) => report(args),\n\t};\n}\n",
8
9
  "/**\n * GraphQL over WebSocket, the `graphql-transport-ws` protocol of\n * `graphql-ws`, on a socket route of the app: the upgrade runs the app's\n * middlewares, each operation runs through Yoga's envelop — its plugins,\n * its `context` — and the app's shutdown closes the sockets with 1001.\n */\nimport type { BaseContext, NextFunction, RoutePath, Socket } from '@alxia/core';\nimport type { Server, ServerOptions, SubscribePayload } from 'graphql-ws';\nimport type { YogaInitialContext, YogaServerInstance } from 'graphql-yoga';\nimport { serverContext, type YogaContext } from './handler';\n\n/** `graphql(app, { ws })`: GraphQL over WebSocket beside the HTTP endpoint. */\nexport interface GraphQLWsOptions {\n\t/**\n\t * Where a client opens its socket, under the app's prefix. The\n\t * endpoint's own path by default: one URL, `http(s)://` for queries and\n\t * server-sent events, `ws(s)://` for the socket.\n\t */\n\treadonly path?: RoutePath;\n\t/**\n\t * Milliseconds between the WebSocket pings the server sends each open\n\t * socket, so a proxy does not close an idle subscription. `12_000` by\n\t * default, as `graphql-ws`'s own server for Node; `false` for none.\n\t */\n\treadonly keepAlive?: number | false;\n}\n\n/**\n * What `graphql-ws` keeps of each socket: the context its upgrade built,\n * and the request each of its operations reads as Yoga's `request`.\n */\ninterface Extra {\n\treadonly ctx: Record<string, unknown> & BaseContext;\n\treadonly request: Request;\n}\n\ntype Module = typeof import('graphql-ws');\n\n/** What the missing optional peer is answered with: the package to add. */\nexport const MISSING_PEER =\n\t'@alxia/graphql: graphql(app, { ws }) serves GraphQL over WebSocket with the optional peer graphql-ws, which is not installed: bun add graphql-ws';\n\n/** `graphql-ws`, imported once; a missing peer rejects with `MISSING_PEER`. */\nfunction loader(): () => Promise<Module> {\n\tlet loading: Promise<Module> | undefined;\n\treturn () => {\n\t\tloading ??= import('graphql-ws').catch((cause: unknown) => {\n\t\t\tthrow new Error(MISSING_PEER, { cause });\n\t\t});\n\t\treturn loading;\n\t};\n}\n\n/** The rest of each operation, run by the functions Yoga's envelop gave it. */\ninterface Enveloped {\n\treadonly execute: (args: never) => unknown;\n\treadonly subscribe: (args: never) => unknown;\n}\n\n/** Where the socket route is, and the endpoint whose Yoga it runs. */\ninterface Paths {\n\treadonly endpoint: string;\n\treadonly socket: string;\n}\n\n/**\n * The Yoga of the endpoint a socket route serves: the HTTP one, so its\n * plugins are set up once. The socket's route is its full path, the\n * prefix of each app it is mounted into included, then its own `path`.\n */\nfunction endpointOf(route: string, paths: Paths): string {\n\t// A path of `/` adds nothing to a prefix: `/api` + `/` is `/api`.\n\tconst own = paths.socket === '/' ? '' : paths.socket;\n\tconst at = paths.endpoint === '/' ? '' : paths.endpoint;\n\treturn route.slice(0, route.length - own.length) + at || '/';\n}\n\n/**\n * `graphql-ws`'s options: each operation parsed, validated, executed and\n * subscribed through Yoga's envelop, with the context the upgrade built,\n * the operation's `params` and the client's `connectionParams`.\n */\nfunction serverOptions<UserCtx extends YogaContext>(\n\tyogaAt: (endpoint: string) => YogaServerInstance<YogaContext, UserCtx>,\n\tpaths: Paths,\n): ServerOptions<Record<string, unknown> | undefined, Extra> {\n\t// Each operation's envelop, found by its context: one object per\n\t// operation, which the root resolvers' `parent` is not.\n\tconst enveloped = new WeakMap<object, Enveloped>();\n\tconst of = (args: { contextValue?: unknown }) =>\n\t\tenveloped.get(args.contextValue as object) as Enveloped;\n\treturn {\n\t\texecute: (args) => of(args).execute(args as never) as never,\n\t\tsubscribe: (args) => of(args).subscribe(args as never) as never,\n\t\tasync onSubscribe(context, _id, params: SubscribePayload) {\n\t\t\tconst { ctx, request } = context.extra;\n\t\t\tconst initial = {\n\t\t\t\t...serverContext(ctx),\n\t\t\t\trequest,\n\t\t\t\tparams,\n\t\t\t\tconnectionParams: context.connectionParams,\n\t\t\t} as unknown as YogaInitialContext & YogaContext;\n\t\t\tconst { schema, execute, subscribe, contextFactory, parse, validate } =\n\t\t\t\tyogaAt(endpointOf(ctx.route as string, paths)).getEnveloped(initial);\n\t\t\tlet document: ReturnType<typeof parse>;\n\t\t\ttry {\n\t\t\t\tdocument = parse(params.query);\n\t\t\t} catch (error) {\n\t\t\t\treturn [error as never];\n\t\t\t}\n\t\t\tconst errors = validate(schema, document);\n\t\t\tif (errors.length > 0) return errors;\n\t\t\tconst contextValue = await contextFactory();\n\t\t\tenveloped.set(contextValue, { execute, subscribe });\n\t\t\treturn {\n\t\t\t\tschema,\n\t\t\t\tdocument,\n\t\t\t\toperationName: params.operationName,\n\t\t\t\tvariableValues: params.variables,\n\t\t\t\tcontextValue,\n\t\t\t};\n\t\t},\n\t};\n}\n\n/** The subprotocol the upgrade request offers that `graphql-ws` serves, or `''`. */\nfunction chosen(module: Module, request: Request): string {\n\tconst offered = request.headers.get('sec-websocket-protocol') ?? '';\n\treturn module.handleProtocols(offered) || '';\n}\n\n/**\n * The request an operation over the socket reads: the upgrade's URL and\n * headers, as a `POST`, which it is to Yoga — a `GET` may not run a\n * mutation, and the upgrade is one — its signal aborted when the socket\n * closes.\n */\nfunction operationRequest(upgrade: Request, signal: AbortSignal): Request {\n\treturn new Request(upgrade.url, {\n\t\tmethod: 'POST',\n\t\theaders: upgrade.headers,\n\t\tsignal,\n\t});\n}\n\n/** `keepAlive` checked where `graphql()` is declared: a positive number of milliseconds, or `false`. */\nfunction pingEvery(keepAlive: number | false | undefined): number | false {\n\tif (keepAlive === undefined) return 12_000;\n\tif (keepAlive === false) return false;\n\tif (Number.isFinite(keepAlive) && keepAlive > 0) return keepAlive;\n\tthrow new TypeError(\n\t\t`graphql(app, { ws: { keepAlive: ${keepAlive} } }): keepAlive is the milliseconds between pings, a positive number, or false for none`,\n\t);\n}\n\n/** What one socket holds: the message handler `graphql-ws` registered, its end, its pings. */\ninterface Client {\n\tonMessage?: (data: string) => Promise<void>;\n\tclosed?: (code?: number, reason?: string) => Promise<void>;\n\tpings?: ReturnType<typeof setInterval>;\n\treadonly gone: AbortController;\n}\n\n/**\n * The socket route's middleware and handlers: the upgrade loads\n * `graphql-ws` and names the subprotocol it serves in the `101`; each\n * open socket is a `graphql-ws` client, ended when it closes.\n */\nexport function graphqlSocket<UserCtx extends YogaContext>(\n\tyogaAt: (endpoint: string) => YogaServerInstance<YogaContext, UserCtx>,\n\tendpoint: string,\n\toptions: GraphQLWsOptions,\n) {\n\tconst paths: Paths = { endpoint, socket: options.path ?? endpoint };\n\tconst keepAlive = pingEvery(options.keepAlive);\n\tconst load = loader();\n\tlet module: Module | undefined;\n\tlet server: Server<Extra> | undefined;\n\tconst clients = new WeakMap<object, Client>();\n\n\t// Named `graphqlWs`, the name the route table shows.\n\tasync function graphqlWs(ctx: BaseContext, next: NextFunction) {\n\t\tmodule ??= await load();\n\t\tserver ??= module.makeServer(serverOptions(yogaAt, paths));\n\t\tconst protocol = chosen(module, ctx.request);\n\t\tif (protocol !== '')\n\t\t\tctx.set.headers.set('sec-websocket-protocol', protocol);\n\t\treturn next();\n\t}\n\n\ttype GraphQLSocket = Socket<Record<string, unknown> & BaseContext, unknown>;\n\tconst handlers = {\n\t\topen(socket: GraphQLSocket) {\n\t\t\tconst raw = socket.raw;\n\t\t\tconst client: Client = { gone: new AbortController() };\n\t\t\tclients.set(raw, client);\n\t\t\t// The upgrade loaded both: a socket opens behind its middleware alone.\n\t\t\tconst graphqlWsServer = server as NonNullable<typeof server>;\n\t\t\tclient.closed = graphqlWsServer.opened(\n\t\t\t\t{\n\t\t\t\t\t// Anything else is closed by graphql-ws: 4406, Subprotocol not acceptable.\n\t\t\t\t\tprotocol: chosen(module as Module, socket.data.request),\n\t\t\t\t\tsend: (data: string) => {\n\t\t\t\t\t\tif (raw.readyState === 1) raw.sendText(data);\n\t\t\t\t\t},\n\t\t\t\t\tclose: (code?: number, reason?: string) => raw.close(code, reason),\n\t\t\t\t\tonMessage: (handle: (data: string) => Promise<void>) => {\n\t\t\t\t\t\tclient.onMessage = handle;\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tctx: socket.data,\n\t\t\t\t\trequest: operationRequest(socket.data.request, client.gone.signal),\n\t\t\t\t},\n\t\t\t);\n\t\t\tif (keepAlive !== false) {\n\t\t\t\tclient.pings = setInterval(() => raw.ping(), keepAlive);\n\t\t\t}\n\t\t},\n\t\tasync message(socket: GraphQLSocket, message: unknown) {\n\t\t\tconst data =\n\t\t\t\ttypeof message === 'string'\n\t\t\t\t\t? message\n\t\t\t\t\t: new TextDecoder().decode(message as Uint8Array);\n\t\t\tawait clients.get(socket.raw)?.onMessage?.(data);\n\t\t},\n\t\tasync close(socket: GraphQLSocket, code: number, reason: string) {\n\t\t\tconst client = clients.get(socket.raw);\n\t\t\tif (client === undefined) return;\n\t\t\tclearInterval(client.pings);\n\t\t\tclients.delete(socket.raw);\n\t\t\tclient.gone.abort();\n\t\t\tawait client.closed?.(code, reason);\n\t\t},\n\t};\n\treturn { path: paths.socket, middleware: graphqlWs, handlers };\n}\n"
9
10
  ],
10
- "mappings": ";AAAA;AAAA;AAAA;;;ACIA;AACA;AAAA;AAAA;;;ACkBO,IAAM,iBAAiB;AAAA,EAC7B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACD,EAAE,KAAK,IAAI;AAOJ,SAAS,aAAa,CAC5B,UACA,UAA0B,CAAC,GAClB;AAAA,EACT,MAAM,SAAS;AAAA,IACd,QAAQ;AAAA,IACR,iBAAiB;AAAA,IACjB,cAAc;AAAA,MACb,gBAAgB,QAAQ,kBAAkB;AAAA,MAC1C,sBAAsB,QAAQ,wBAAwB;AAAA,SAClD,QAAQ,oBAAoB,YAC7B,CAAC,IACD,EAAE,UAAU,QAAQ,gBAAgB;AAAA,SACnC,QAAQ,mBAAmB,YAC5B,CAAC,IACD,EAAE,SAAS,QAAQ,eAAe;AAAA,IACtC;AAAA,IACA,kBAAkB;AAAA,IAClB,oBAAoB;AAAA,EACrB;AAAA,EACA,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA,SAKC,KAAK,QAAQ,SAAS,kBAAkB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,iBAQhC,OAAO,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAS9B,SAAS,IAAI,CAAC,MAAsB;AAAA,EACnC,OAAO,KAAK,QAAQ,YAAY,CAAC,SAAS,KAAK,KAAK,WAAW,CAAC,IAAI;AAAA;AAIrE,SAAS,MAAM,CAAC,OAAwB;AAAA,EACvC,OAAO,KAAK,UAAU,KAAK,EACzB,QAAQ,MAAM,SAAS,EACvB,QAAQ,MAAM,SAAS,EACvB,QAAQ,WAAW,SAAS,EAC5B,QAAQ,WAAW,SAAS;AAAA;;;AD1E/B,IAAM,iBACL;AAUM,SAAS,cAAc,CAAC,MAAsB;AAAA,EACpD,MAAM,QAAQ,KAAK,MAAM,cAAc,IAAI,MAAM;AAAA,EACjD,MAAM,OAAO,UAAU,KAAK,KAAK,IAAI;AAAA,EACrC,OAAO;AAAA,IACN;AAAA,IACA,oCAAoC;AAAA,IACpC,mCAAmC;AAAA,IACnC;AAAA,IACA,wBAAwB;AAAA,IACxB;AAAA,IACA,qBAAqB;AAAA,IACrB;AAAA,EACD,EAAE,KAAK,IAAI;AAAA;AAQL,SAAS,WAAwC,CACvD,SACiE;AAAA,EACjE,MAAM,UAAU,IAAI;AAAA,EACpB,OAAO,CAAC,aAAa;AAAA,IACpB,IAAI,OAAO,QAAQ,IAAI,QAAQ;AAAA,IAC/B,IAAI,SAAS,WAAW;AAAA,MACvB,OAAO,WAAiC;AAAA,WACpC;AAAA,QACH,iBAAiB;AAAA,MAClB,CAAC;AAAA,MACD,QAAQ,IAAI,UAAU,IAAI;AAAA,IAC3B;AAAA,IACA,OAAO;AAAA;AAAA;AAQF,SAAS,aAAa,CAC5B,KAC0B;AAAA,EAC1B;AAAA,IACC,QAAQ;AAAA,IACR,OAAO;AAAA,IACP,SAAS;AAAA,IACT,SAAS;AAAA,IACT,MAAM;AAAA,IACN,OAAO;AAAA,IACP,UAAU;AAAA,OACP;AAAA,MACA;AAAA,EACJ,OAAO;AAAA;AASD,SAAS,cAA2C,CAC1D,QACA,SACC;AAAA,EAGD,OAAO,eAAe,OAAO,CAC5B,KACC;AAAA,IACD,QAAQ,UAAU;AAAA,IAClB,MAAM,SAAS,cAAc,GAAG;AAAA,IAChC,IACC,YAAY,SACZ,IAAI,QAAQ,WAAW,SACvB,IAAI,QAAQ,QAAQ,IAAI,QAAQ,GAAG,SAAS,WAAW,KACvD,CAAC,IAAI,IAAI,aAAa,IAAI,OAAO,GAChC;AAAA,MAGD,OAAO,MAAM,KAAK,cAAc,IAAI,OAAO,OAAO,GAAG;AAAA,QACpD,SAAS;AAAA,UACR,gBAAgB;AAAA,UAChB,2BAA2B;AAAA,QAC5B;AAAA,MACD,CAAC;AAAA,IACF;AAAA,IACA,MAAM,WAAW,MAAM,OAAO,IAAI,KAAK,EAAE,MAAM,IAAI,SAAS,MAAM;AAAA,IAClE,MAAM,UAAU,IAAI,QAAQ,SAAS,OAAO;AAAA,IAC5C,IACC,QAAQ,IAAI,cAAc,GAAG,WAAW,WAAW,KACnD,CAAC,QAAQ,IAAI,yBAAyB,GACrC;AAAA,MAED,MAAM,OAAO,MAAM,SAAS,KAAK;AAAA,MACjC,QAAQ,IAAI,2BAA2B,eAAe,IAAI,CAAC;AAAA,MAC3D,OAAO,MAAM,SAAS,QAAsB,MAAM,EAAE,QAAQ,CAAC;AAAA,IAC9D;AAAA,IACA,MAAM,OAAO,gBAAgB,UAAU,eAAe,GAAG,CAAC;AAAA,IAC1D,OAAO,MAAM,SAAS,QAAsB,QAAQ,WAAW;AAAA,MAC9D;AAAA,IACD,CAAC;AAAA;AAAA;AAWH,SAAS,eAAe,CACvB,UACA,QACoC;AAAA,EACpC,MAAM,OAAO,SAAS;AAAA,EACtB,MAAM,OAAO,SAAS,QAAQ,IAAI,cAAc,KAAK;AAAA,EACrD,IAAI,SAAS,QAAQ,CAAC,sCAAsC,KAAK,IAAI,GAAG;AAAA,IACvE,OAAO;AAAA,EACR;AAAA,EACA,MAAM,SAAS,KAAK,UAAU;AAAA,EAC9B,OAAO,IAAI,eAA2B;AAAA,IACrC,KAAK,CAAC,YAAY;AAAA,MACjB,MAAM,MAAM,MAAM;AAAA,QACZ,OAAO,OAAO;AAAA,QACnB,IAAI;AAAA,UACH,WAAW,MAAM;AAAA,UAChB,MAAM;AAAA;AAAA,MAIT,IAAI,OAAO;AAAA,QAAS,IAAI;AAAA,MACnB;AAAA,eAAO,iBAAiB,SAAS,KAAK,EAAE,MAAM,KAAK,CAAC;AAAA;AAAA,SAEpD,KAAI,CAAC,YAAY;AAAA,MACtB,QAAQ,OAAO,SAAS,MAAM,OAAO,KAAK;AAAA,MAC1C,IAAI,MAAM;AAAA,QACT,IAAI;AAAA,UACH,WAAW,MAAM;AAAA,UAChB,MAAM;AAAA,QAGR;AAAA,MACD;AAAA,MACA,WAAW,QAAQ,KAAK;AAAA;AAAA,IAEzB,QAAQ,CAAC,WAAW,OAAO,OAAO,MAAM;AAAA,EACzC,CAAC;AAAA;;;AEzIK,IAAM,eACZ;AAGD,SAAS,MAAM,GAA0B;AAAA,EACxC,IAAI;AAAA,EACJ,OAAO,MAAM;AAAA,IACZ,YAAmB,qBAAc,MAAM,CAAC,UAAmB;AAAA,MAC1D,MAAM,IAAI,MAAM,cAAc,EAAE,MAAM,CAAC;AAAA,KACvC;AAAA,IACD,OAAO;AAAA;AAAA;AAqBT,SAAS,UAAU,CAAC,OAAe,OAAsB;AAAA,EAExD,MAAM,MAAM,MAAM,WAAW,MAAM,KAAK,MAAM;AAAA,EAC9C,MAAM,KAAK,MAAM,aAAa,MAAM,KAAK,MAAM;AAAA,EAC/C,OAAO,MAAM,MAAM,GAAG,MAAM,SAAS,IAAI,MAAM,IAAI,MAAM;AAAA;AAQ1D,SAAS,aAA0C,CAClD,QACA,OAC4D;AAAA,EAG5D,MAAM,YAAY,IAAI;AAAA,EACtB,MAAM,KAAK,CAAC,SACX,UAAU,IAAI,KAAK,YAAsB;AAAA,EAC1C,OAAO;AAAA,IACN,SAAS,CAAC,SAAS,GAAG,IAAI,EAAE,QAAQ,IAAa;AAAA,IACjD,WAAW,CAAC,SAAS,GAAG,IAAI,EAAE,UAAU,IAAa;AAAA,SAC/C,YAAW,CAAC,SAAS,KAAK,QAA0B;AAAA,MACzD,QAAQ,KAAK,YAAY,QAAQ;AAAA,MACjC,MAAM,UAAU;AAAA,WACZ,cAAc,GAAG;AAAA,QACpB;AAAA,QACA;AAAA,QACA,kBAAkB,QAAQ;AAAA,MAC3B;AAAA,MACA,QAAQ,QAAQ,SAAS,WAAW,gBAAgB,OAAO,aAC1D,OAAO,WAAW,IAAI,OAAiB,KAAK,CAAC,EAAE,aAAa,OAAO;AAAA,MACpE,IAAI;AAAA,MACJ,IAAI;AAAA,QACH,WAAW,MAAM,OAAO,KAAK;AAAA,QAC5B,OAAO,OAAO;AAAA,QACf,OAAO,CAAC,KAAc;AAAA;AAAA,MAEvB,MAAM,SAAS,SAAS,QAAQ,QAAQ;AAAA,MACxC,IAAI,OAAO,SAAS;AAAA,QAAG,OAAO;AAAA,MAC9B,MAAM,eAAe,MAAM,eAAe;AAAA,MAC1C,UAAU,IAAI,cAAc,EAAE,SAAS,UAAU,CAAC;AAAA,MAClD,OAAO;AAAA,QACN;AAAA,QACA;AAAA,QACA,eAAe,OAAO;AAAA,QACtB,gBAAgB,OAAO;AAAA,QACvB;AAAA,MACD;AAAA;AAAA,EAEF;AAAA;AAID,SAAS,MAAM,CAAC,QAAgB,SAA0B;AAAA,EACzD,MAAM,UAAU,QAAQ,QAAQ,IAAI,wBAAwB,KAAK;AAAA,EACjE,OAAO,OAAO,gBAAgB,OAAO,KAAK;AAAA;AAS3C,SAAS,gBAAgB,CAAC,SAAkB,QAA8B;AAAA,EACzE,OAAO,IAAI,QAAQ,QAAQ,KAAK;AAAA,IAC/B,QAAQ;AAAA,IACR,SAAS,QAAQ;AAAA,IACjB;AAAA,EACD,CAAC;AAAA;AAIF,SAAS,SAAS,CAAC,WAAuD;AAAA,EACzE,IAAI,cAAc;AAAA,IAAW,OAAO;AAAA,EACpC,IAAI,cAAc;AAAA,IAAO,OAAO;AAAA,EAChC,IAAI,OAAO,SAAS,SAAS,KAAK,YAAY;AAAA,IAAG,OAAO;AAAA,EACxD,MAAM,IAAI,UACT,mCAAmC,mGACpC;AAAA;AAgBM,SAAS,aAA0C,CACzD,QACA,UACA,SACC;AAAA,EACD,MAAM,QAAe,EAAE,UAAU,QAAQ,QAAQ,QAAQ,SAAS;AAAA,EAClE,MAAM,YAAY,UAAU,QAAQ,SAAS;AAAA,EAC7C,MAAM,OAAO,OAAO;AAAA,EACpB,IAAI;AAAA,EACJ,IAAI;AAAA,EACJ,MAAM,UAAU,IAAI;AAAA,EAGpB,eAAe,SAAS,CAAC,KAAkB,MAAoB;AAAA,IAC9D,WAAW,MAAM,KAAK;AAAA,IACtB,WAAW,OAAO,WAAW,cAAc,QAAQ,KAAK,CAAC;AAAA,IACzD,MAAM,WAAW,OAAO,QAAQ,IAAI,OAAO;AAAA,IAC3C,IAAI,aAAa;AAAA,MAChB,IAAI,IAAI,QAAQ,IAAI,0BAA0B,QAAQ;AAAA,IACvD,OAAO,KAAK;AAAA;AAAA,EAIb,MAAM,WAAW;AAAA,IAChB,IAAI,CAAC,QAAuB;AAAA,MAC3B,MAAM,MAAM,OAAO;AAAA,MACnB,MAAM,SAAiB,EAAE,MAAM,IAAI,gBAAkB;AAAA,MACrD,QAAQ,IAAI,KAAK,MAAM;AAAA,MAEvB,MAAM,kBAAkB;AAAA,MACxB,OAAO,SAAS,gBAAgB,OAC/B;AAAA,QAEC,UAAU,OAAO,QAAkB,OAAO,KAAK,OAAO;AAAA,QACtD,MAAM,CAAC,SAAiB;AAAA,UACvB,IAAI,IAAI,eAAe;AAAA,YAAG,IAAI,SAAS,IAAI;AAAA;AAAA,QAE5C,OAAO,CAAC,MAAe,WAAoB,IAAI,MAAM,MAAM,MAAM;AAAA,QACjE,WAAW,CAAC,WAA4C;AAAA,UACvD,OAAO,YAAY;AAAA;AAAA,MAErB,GACA;AAAA,QACC,KAAK,OAAO;AAAA,QACZ,SAAS,iBAAiB,OAAO,KAAK,SAAS,OAAO,KAAK,MAAM;AAAA,MAClE,CACD;AAAA,MACA,IAAI,cAAc,OAAO;AAAA,QACxB,OAAO,QAAQ,YAAY,MAAM,IAAI,KAAK,GAAG,SAAS;AAAA,MACvD;AAAA;AAAA,SAEK,QAAO,CAAC,QAAuB,SAAkB;AAAA,MACtD,MAAM,OACL,OAAO,YAAY,WAChB,UACA,IAAI,YAAY,EAAE,OAAO,OAAqB;AAAA,MAClD,MAAM,QAAQ,IAAI,OAAO,GAAG,GAAG,YAAY,IAAI;AAAA;AAAA,SAE1C,MAAK,CAAC,QAAuB,MAAc,QAAgB;AAAA,MAChE,MAAM,SAAS,QAAQ,IAAI,OAAO,GAAG;AAAA,MACrC,IAAI,WAAW;AAAA,QAAW;AAAA,MAC1B,cAAc,OAAO,KAAK;AAAA,MAC1B,QAAQ,OAAO,OAAO,GAAG;AAAA,MACzB,OAAO,KAAK,MAAM;AAAA,MAClB,MAAM,OAAO,SAAS,MAAM,MAAM;AAAA;AAAA,EAEpC;AAAA,EACA,OAAO,EAAE,MAAM,MAAM,QAAQ,YAAY,WAAW,SAAS;AAAA;;;AHlGvD,SAAS,OAMf,CACA,KACA,SAKqB;AAAA,EACrB;AAAA,IACC,OAAO;AAAA,IACP,OAAO;AAAA,IACP;AAAA,IACA;AAAA,IACA;AAAA,IACA,KAAK;AAAA,OACF;AAAA,MACA;AAAA,EACJ,MAAM,OAAO,YAAY;AAAA,EACzB,MAAM,SAAS,YAAqB;AAAA,OAC/B;AAAA,IACJ;AAAA,IACA,UAAW,QAAQ,YAChB,CAAC,UAAmB,YAAoB,MAAM,OAAO,KAAK,OAC1D,QAAQ,aACP,OACA;AAAA,EACL,CAAC;AAAA,EACD,MAAM,UAAU,eACf,QACA,QAAQ,mBAAoB,WAAW,CAAC,IAAK,KAC9C;AAAA,EAEA,MAAM,QAAQ;AAAA,EAKd,MAAM,IAAI,MAAM,OAAO;AAAA,EACvB,MAAM,KAAK,MAAM,OAAO;AAAA,EACxB,IAAI,OAAO,OAAO;AAAA,IACjB,MAAM,SAAS,cAAc,QAAQ,MAAM,OAAO,OAAO,CAAC,IAAI,EAAE;AAAA,IAChE,MAAM,GAAG,OAAO,MAAM,OAAO,YAAY,OAAO,QAAQ;AAAA,EACzD;AAAA,EACA,OAAO;AAAA;",
11
- "debugId": "E799A72AD243BAC264756E2164756E21",
11
+ "mappings": ";AAAA;AAAA;AAAA;;;ACIA;AACA;AAAA;AAAA;;;ACkBO,IAAM,iBAAiB;AAAA,EAC7B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACD,EAAE,KAAK,IAAI;AAOJ,SAAS,aAAa,CAC5B,UACA,UAA0B,CAAC,GAClB;AAAA,EACT,MAAM,SAAS;AAAA,IACd,QAAQ;AAAA,IACR,iBAAiB;AAAA,IACjB,cAAc;AAAA,MACb,gBAAgB,QAAQ,kBAAkB;AAAA,MAC1C,sBAAsB,QAAQ,wBAAwB;AAAA,SAClD,QAAQ,oBAAoB,YAC7B,CAAC,IACD,EAAE,UAAU,QAAQ,gBAAgB;AAAA,SACnC,QAAQ,mBAAmB,YAC5B,CAAC,IACD,EAAE,SAAS,QAAQ,eAAe;AAAA,IACtC;AAAA,IACA,kBAAkB;AAAA,IAClB,oBAAoB;AAAA,EACrB;AAAA,EACA,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA,SAKC,KAAK,QAAQ,SAAS,kBAAkB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,iBAQhC,OAAO,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAS9B,SAAS,IAAI,CAAC,MAAsB;AAAA,EACnC,OAAO,KAAK,QAAQ,YAAY,CAAC,SAAS,KAAK,KAAK,WAAW,CAAC,IAAI;AAAA;AAIrE,SAAS,MAAM,CAAC,OAAwB;AAAA,EACvC,OAAO,KAAK,UAAU,KAAK,EACzB,QAAQ,MAAM,SAAS,EACvB,QAAQ,MAAM,SAAS,EACvB,QAAQ,WAAW,SAAS,EAC5B,QAAQ,WAAW,SAAS;AAAA;;;AD1E/B,IAAM,iBACL;AAUM,SAAS,cAAc,CAAC,MAAsB;AAAA,EACpD,MAAM,QAAQ,KAAK,MAAM,cAAc,IAAI,MAAM;AAAA,EACjD,MAAM,OAAO,UAAU,KAAK,KAAK,IAAI;AAAA,EACrC,OAAO;AAAA,IACN;AAAA,IACA,oCAAoC;AAAA,IACpC,mCAAmC;AAAA,IACnC;AAAA,IACA,wBAAwB;AAAA,IACxB;AAAA,IACA,qBAAqB;AAAA,IACrB;AAAA,EACD,EAAE,KAAK,IAAI;AAAA;AAQL,SAAS,WAAwC,CACvD,SACiE;AAAA,EACjE,MAAM,UAAU,IAAI;AAAA,EACpB,OAAO,CAAC,aAAa;AAAA,IACpB,IAAI,OAAO,QAAQ,IAAI,QAAQ;AAAA,IAC/B,IAAI,SAAS,WAAW;AAAA,MACvB,OAAO,WAAiC;AAAA,WACpC;AAAA,QACH,iBAAiB;AAAA,MAClB,CAAC;AAAA,MACD,QAAQ,IAAI,UAAU,IAAI;AAAA,IAC3B;AAAA,IACA,OAAO;AAAA;AAAA;AAQF,SAAS,aAAa,CAC5B,KAC0B;AAAA,EAC1B;AAAA,IACC,QAAQ;AAAA,IACR,OAAO;AAAA,IACP,SAAS;AAAA,IACT,SAAS;AAAA,IACT,MAAM;AAAA,IACN,OAAO;AAAA,IACP,UAAU;AAAA,OACP;AAAA,MACA;AAAA,EACJ,OAAO;AAAA;AASD,SAAS,cAA2C,CAC1D,QACA,SACC;AAAA,EAGD,OAAO,eAAe,OAAO,CAC5B,KACC;AAAA,IACD,QAAQ,UAAU;AAAA,IAClB,MAAM,SAAS,cAAc,GAAG;AAAA,IAChC,IACC,YAAY,SACZ,IAAI,QAAQ,WAAW,SACvB,IAAI,QAAQ,QAAQ,IAAI,QAAQ,GAAG,SAAS,WAAW,KACvD,CAAC,IAAI,IAAI,aAAa,IAAI,OAAO,GAChC;AAAA,MAGD,OAAO,MAAM,KAAK,cAAc,IAAI,OAAO,OAAO,GAAG;AAAA,QACpD,SAAS;AAAA,UACR,gBAAgB;AAAA,UAChB,2BAA2B;AAAA,QAC5B;AAAA,MACD,CAAC;AAAA,IACF;AAAA,IACA,MAAM,WAAW,MAAM,OAAO,IAAI,KAAK,EAAE,MAAM,IAAI,SAAS,MAAM;AAAA,IAClE,MAAM,UAAU,IAAI,QAAQ,SAAS,OAAO;AAAA,IAC5C,IACC,QAAQ,IAAI,cAAc,GAAG,WAAW,WAAW,KACnD,CAAC,QAAQ,IAAI,yBAAyB,GACrC;AAAA,MAED,MAAM,OAAO,MAAM,SAAS,KAAK;AAAA,MACjC,QAAQ,IAAI,2BAA2B,eAAe,IAAI,CAAC;AAAA,MAC3D,OAAO,MAAM,SAAS,QAAsB,MAAM,EAAE,QAAQ,CAAC;AAAA,IAC9D;AAAA,IACA,MAAM,OAAO,gBAAgB,UAAU,eAAe,GAAG,CAAC;AAAA,IAC1D,OAAO,MAAM,SAAS,QAAsB,QAAQ,WAAW;AAAA,MAC9D;AAAA,IACD,CAAC;AAAA;AAAA;AAWH,SAAS,eAAe,CACvB,UACA,QACoC;AAAA,EACpC,MAAM,OAAO,SAAS;AAAA,EACtB,MAAM,OAAO,SAAS,QAAQ,IAAI,cAAc,KAAK;AAAA,EACrD,IAAI,SAAS,QAAQ,CAAC,sCAAsC,KAAK,IAAI,GAAG;AAAA,IACvE,OAAO;AAAA,EACR;AAAA,EACA,MAAM,SAAS,KAAK,UAAU;AAAA,EAC9B,OAAO,IAAI,eAA2B;AAAA,IACrC,KAAK,CAAC,YAAY;AAAA,MACjB,MAAM,MAAM,MAAM;AAAA,QACZ,OAAO,OAAO;AAAA,QACnB,IAAI;AAAA,UACH,WAAW,MAAM;AAAA,UAChB,MAAM;AAAA;AAAA,MAIT,IAAI,OAAO;AAAA,QAAS,IAAI;AAAA,MACnB;AAAA,eAAO,iBAAiB,SAAS,KAAK,EAAE,MAAM,KAAK,CAAC;AAAA;AAAA,SAEpD,KAAI,CAAC,YAAY;AAAA,MACtB,QAAQ,OAAO,SAAS,MAAM,OAAO,KAAK;AAAA,MAC1C,IAAI,MAAM;AAAA,QACT,IAAI;AAAA,UACH,WAAW,MAAM;AAAA,UAChB,MAAM;AAAA,QAGR;AAAA,MACD;AAAA,MACA,WAAW,QAAQ,KAAK;AAAA;AAAA,IAEzB,QAAQ,CAAC,WAAW,OAAO,OAAO,MAAM;AAAA,EACzC,CAAC;AAAA;;;AE5KF;AACA;AAUA,SAAS,MAAM,CAAC,MAAsB;AAAA,EACrC,MAAM,YAAY,gBAAgB,KAAK,UAAU,KAAK,aAAa;AAAA,EACnE,IAAI,cAAc,aAAa,cAAc;AAAA,IAAM;AAAA,EACnD,gBAAgB,KAAK,cAAwB;AAAA,IAC5C,MAAM,UAAU;AAAA,IAChB,MAAM,UAAU,MAAM;AAAA,EACvB,CAAC;AAAA;AAQK,SAAS,iBAAiB,GAAW;AAAA,EAC3C,OAAO;AAAA,IACN,WAAW,GAAG,WAAW,OAAO,IAAI;AAAA,IACpC,aAAa,GAAG,WAAW,OAAO,IAAI;AAAA,EACvC;AAAA;;;ACMM,IAAM,eACZ;AAGD,SAAS,MAAM,GAA0B;AAAA,EACxC,IAAI;AAAA,EACJ,OAAO,MAAM;AAAA,IACZ,YAAmB,qBAAc,MAAM,CAAC,UAAmB;AAAA,MAC1D,MAAM,IAAI,MAAM,cAAc,EAAE,MAAM,CAAC;AAAA,KACvC;AAAA,IACD,OAAO;AAAA;AAAA;AAqBT,SAAS,UAAU,CAAC,OAAe,OAAsB;AAAA,EAExD,MAAM,MAAM,MAAM,WAAW,MAAM,KAAK,MAAM;AAAA,EAC9C,MAAM,KAAK,MAAM,aAAa,MAAM,KAAK,MAAM;AAAA,EAC/C,OAAO,MAAM,MAAM,GAAG,MAAM,SAAS,IAAI,MAAM,IAAI,MAAM;AAAA;AAQ1D,SAAS,aAA0C,CAClD,QACA,OAC4D;AAAA,EAG5D,MAAM,YAAY,IAAI;AAAA,EACtB,MAAM,KAAK,CAAC,SACX,UAAU,IAAI,KAAK,YAAsB;AAAA,EAC1C,OAAO;AAAA,IACN,SAAS,CAAC,SAAS,GAAG,IAAI,EAAE,QAAQ,IAAa;AAAA,IACjD,WAAW,CAAC,SAAS,GAAG,IAAI,EAAE,UAAU,IAAa;AAAA,SAC/C,YAAW,CAAC,SAAS,KAAK,QAA0B;AAAA,MACzD,QAAQ,KAAK,YAAY,QAAQ;AAAA,MACjC,MAAM,UAAU;AAAA,WACZ,cAAc,GAAG;AAAA,QACpB;AAAA,QACA;AAAA,QACA,kBAAkB,QAAQ;AAAA,MAC3B;AAAA,MACA,QAAQ,QAAQ,SAAS,WAAW,gBAAgB,OAAO,aAC1D,OAAO,WAAW,IAAI,OAAiB,KAAK,CAAC,EAAE,aAAa,OAAO;AAAA,MACpE,IAAI;AAAA,MACJ,IAAI;AAAA,QACH,WAAW,MAAM,OAAO,KAAK;AAAA,QAC5B,OAAO,OAAO;AAAA,QACf,OAAO,CAAC,KAAc;AAAA;AAAA,MAEvB,MAAM,SAAS,SAAS,QAAQ,QAAQ;AAAA,MACxC,IAAI,OAAO,SAAS;AAAA,QAAG,OAAO;AAAA,MAC9B,MAAM,eAAe,MAAM,eAAe;AAAA,MAC1C,UAAU,IAAI,cAAc,EAAE,SAAS,UAAU,CAAC;AAAA,MAClD,OAAO;AAAA,QACN;AAAA,QACA;AAAA,QACA,eAAe,OAAO;AAAA,QACtB,gBAAgB,OAAO;AAAA,QACvB;AAAA,MACD;AAAA;AAAA,EAEF;AAAA;AAID,SAAS,MAAM,CAAC,QAAgB,SAA0B;AAAA,EACzD,MAAM,UAAU,QAAQ,QAAQ,IAAI,wBAAwB,KAAK;AAAA,EACjE,OAAO,OAAO,gBAAgB,OAAO,KAAK;AAAA;AAS3C,SAAS,gBAAgB,CAAC,SAAkB,QAA8B;AAAA,EACzE,OAAO,IAAI,QAAQ,QAAQ,KAAK;AAAA,IAC/B,QAAQ;AAAA,IACR,SAAS,QAAQ;AAAA,IACjB;AAAA,EACD,CAAC;AAAA;AAIF,SAAS,SAAS,CAAC,WAAuD;AAAA,EACzE,IAAI,cAAc;AAAA,IAAW,OAAO;AAAA,EACpC,IAAI,cAAc;AAAA,IAAO,OAAO;AAAA,EAChC,IAAI,OAAO,SAAS,SAAS,KAAK,YAAY;AAAA,IAAG,OAAO;AAAA,EACxD,MAAM,IAAI,UACT,mCAAmC,mGACpC;AAAA;AAgBM,SAAS,aAA0C,CACzD,QACA,UACA,SACC;AAAA,EACD,MAAM,QAAe,EAAE,UAAU,QAAQ,QAAQ,QAAQ,SAAS;AAAA,EAClE,MAAM,YAAY,UAAU,QAAQ,SAAS;AAAA,EAC7C,MAAM,OAAO,OAAO;AAAA,EACpB,IAAI;AAAA,EACJ,IAAI;AAAA,EACJ,MAAM,UAAU,IAAI;AAAA,EAGpB,eAAe,SAAS,CAAC,KAAkB,MAAoB;AAAA,IAC9D,WAAW,MAAM,KAAK;AAAA,IACtB,WAAW,OAAO,WAAW,cAAc,QAAQ,KAAK,CAAC;AAAA,IACzD,MAAM,WAAW,OAAO,QAAQ,IAAI,OAAO;AAAA,IAC3C,IAAI,aAAa;AAAA,MAChB,IAAI,IAAI,QAAQ,IAAI,0BAA0B,QAAQ;AAAA,IACvD,OAAO,KAAK;AAAA;AAAA,EAIb,MAAM,WAAW;AAAA,IAChB,IAAI,CAAC,QAAuB;AAAA,MAC3B,MAAM,MAAM,OAAO;AAAA,MACnB,MAAM,SAAiB,EAAE,MAAM,IAAI,gBAAkB;AAAA,MACrD,QAAQ,IAAI,KAAK,MAAM;AAAA,MAEvB,MAAM,kBAAkB;AAAA,MACxB,OAAO,SAAS,gBAAgB,OAC/B;AAAA,QAEC,UAAU,OAAO,QAAkB,OAAO,KAAK,OAAO;AAAA,QACtD,MAAM,CAAC,SAAiB;AAAA,UACvB,IAAI,IAAI,eAAe;AAAA,YAAG,IAAI,SAAS,IAAI;AAAA;AAAA,QAE5C,OAAO,CAAC,MAAe,WAAoB,IAAI,MAAM,MAAM,MAAM;AAAA,QACjE,WAAW,CAAC,WAA4C;AAAA,UACvD,OAAO,YAAY;AAAA;AAAA,MAErB,GACA;AAAA,QACC,KAAK,OAAO;AAAA,QACZ,SAAS,iBAAiB,OAAO,KAAK,SAAS,OAAO,KAAK,MAAM;AAAA,MAClE,CACD;AAAA,MACA,IAAI,cAAc,OAAO;AAAA,QACxB,OAAO,QAAQ,YAAY,MAAM,IAAI,KAAK,GAAG,SAAS;AAAA,MACvD;AAAA;AAAA,SAEK,QAAO,CAAC,QAAuB,SAAkB;AAAA,MACtD,MAAM,OACL,OAAO,YAAY,WAChB,UACA,IAAI,YAAY,EAAE,OAAO,OAAqB;AAAA,MAClD,MAAM,QAAQ,IAAI,OAAO,GAAG,GAAG,YAAY,IAAI;AAAA;AAAA,SAE1C,MAAK,CAAC,QAAuB,MAAc,QAAgB;AAAA,MAChE,MAAM,SAAS,QAAQ,IAAI,OAAO,GAAG;AAAA,MACrC,IAAI,WAAW;AAAA,QAAW;AAAA,MAC1B,cAAc,OAAO,KAAK;AAAA,MAC1B,QAAQ,OAAO,OAAO,GAAG;AAAA,MACzB,OAAO,KAAK,MAAM;AAAA,MAClB,MAAM,OAAO,SAAS,MAAM,MAAM;AAAA;AAAA,EAEpC;AAAA,EACA,OAAO,EAAE,MAAM,MAAM,QAAQ,YAAY,WAAW,SAAS;AAAA;;;AJjGvD,SAAS,OAMf,CACA,KACA,SAKqB;AAAA,EACrB;AAAA,IACC,OAAO;AAAA,IACP,OAAO;AAAA,IACP;AAAA,IACA;AAAA,IACA;AAAA,IACA,KAAK;AAAA,OACF;AAAA,MACA;AAAA,EACJ,MAAM,OAAO,YAAY;AAAA,EACzB,MAAM,SAAS,YAAqB;AAAA,OAC/B;AAAA,IACJ,SAAS,CAAC,GAAI,YAAY,WAAW,CAAC,GAAI,kBAAkB,CAAC;AAAA,IAC7D;AAAA,IACA,UAAW,QAAQ,YAChB,CAAC,UAAmB,YAAoB,MAAM,OAAO,KAAK,OAC1D,QAAQ,aACP,OACA;AAAA,EACL,CAAC;AAAA,EACD,MAAM,UAAU,eACf,QACA,QAAQ,mBAAoB,WAAW,CAAC,IAAK,KAC9C;AAAA,EAEA,MAAM,QAAQ;AAAA,EAKd,MAAM,IAAI,MAAM,OAAO;AAAA,EACvB,MAAM,KAAK,MAAM,OAAO;AAAA,EACxB,IAAI,OAAO,OAAO;AAAA,IACjB,MAAM,SAAS,cAAc,QAAQ,MAAM,OAAO,OAAO,CAAC,IAAI,EAAE;AAAA,IAChE,MAAM,GAAG,OAAO,MAAM,OAAO,YAAY,OAAO,QAAQ;AAAA,EACzD;AAAA,EACA,OAAO;AAAA;",
12
+ "debugId": "FE06B312B406C45364756E2164756E21",
12
13
  "names": []
13
14
  }
@@ -0,0 +1,8 @@
1
+ import type { Plugin } from 'graphql-yoga';
2
+ /**
3
+ * A Yoga plugin reporting each operation Yoga executes or subscribes to,
4
+ * through core's `reportOperation`: a batched body reports each of its
5
+ * operations, a request refused before it executes none.
6
+ */
7
+ export declare function reportsOperations(): Plugin;
8
+ //# sourceMappingURL=operation.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../src/operation.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAkB3C;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,MAAM,CAK1C"}
@@ -157,6 +157,39 @@ POST {} → 200 {"errors":[{"message":"Must provid
157
157
  Both methods answer a body to read as GraphQL, whatever its status, and
158
158
  the replies of the middlewares before them — a guard's `401`, say.
159
159
 
160
+ ## The operation in the log and the trace
161
+
162
+ Every call is a `POST /graphql`, so the route alone cannot tell `GetNotes`
163
+ from `AddNote`. For each operation Yoga executes or subscribes to,
164
+ `graphql()` reports its type and name to the middlewares around it
165
+ (`reportOperation` of `@alxia/core`, a Yoga plugin it adds after yours),
166
+ and no package imports another: `@alxia/logger` adds `operationName` and
167
+ `operationType` to the request's line, and `@alxia/telemetry` names its
168
+ span `query GetNotes` with `graphql.operation.name` and
169
+ `graphql.operation.type`. Give both to `use` before `graphql()`:
170
+
171
+ ```ts
172
+ const app = alxia()
173
+ .use(logger())
174
+ .use(telemetry({ service: 'notes' }))
175
+ .plugin((app) => graphql(app, { schema }));
176
+ ```
177
+
178
+ ```json
179
+ {"message":"POST /graphql 200","status":200,"operationName":"GetNotes","operationType":"query"}
180
+ ```
181
+
182
+ - A batched body (`batching`, an array) is one line and one span: the type
183
+ is `batch`, the names are listed, `GetNotes,AddNote`.
184
+ - An anonymous operation has a type and no name.
185
+ - A request refused before it executes (a syntax error, a document that
186
+ fails validation) names no operation: its line is the plain
187
+ `POST /graphql`.
188
+ - Your own middleware reads it with `operationOf(ctx)` after `next()`.
189
+ - Over `ws: true`, the operations on a socket are not reported: logger and
190
+ telemetry see the upgrade alone, so they are not logged or spanned yet
191
+ ([roadmap](../roadmap.md)).
192
+
160
193
  ## Errors, health and shutdown
161
194
 
162
195
  **GraphQL errors stay GraphQL's.** A resolver that throws, a query that
@@ -142,6 +142,14 @@ before you trust it. A header the upgrade's middlewares set with
142
142
  `set.headers` is sent with the `101`; set during an operation, it goes
143
143
  nowhere.
144
144
 
145
+ ## Logging and tracing
146
+
147
+ `@alxia/logger` and `@alxia/telemetry` see the upgrade request, `101`, and
148
+ not the operations on the socket: the request is answered before they run,
149
+ so none of them gets an `operationName` or a span. Log from a Yoga plugin's
150
+ `onExecute` for now; each operation over the socket is on the
151
+ [roadmap](../roadmap.md).
152
+
145
153
  ## Errors
146
154
 
147
155
  An error stays GraphQL's. A resolver's arrives in a `next` message with
@@ -141,6 +141,11 @@ POST [{"query":"{ admin }"},{"query":"{ __typename }"}]
141
141
  200 [{"data":{"admin":"welcome"}},{"data":{"__typename":"Query"}}]
142
142
  ```
143
143
 
144
+ A batch is one request, so one log line and one span: `@alxia/logger` writes
145
+ `operationType: 'batch'` and every name, `operationName: 'GetNotes,AddNote'`,
146
+ and `@alxia/telemetry` names the span `batch GetNotes,AddNote`
147
+ ([endpoint guide](endpoint.md#the-operation-in-the-log-and-the-trace)).
148
+
144
149
  ## Subscriptions
145
150
 
146
151
  Subscriptions are served over server-sent events, Yoga's default: a
package/docs/roadmap.md CHANGED
@@ -30,7 +30,7 @@ number on it. Every release, with each change it made, is in
30
30
 
31
31
  ## Next
32
32
 
33
- Nothing scheduled yet.
33
+ - **Each operation over a socket.** A `ws: true` connection is logged or spanned at its upgrade alone: its operations — a query, a mutation, a subscription's stream — name no operation yet, because the request is answered before they run.
34
34
 
35
35
  ## Later
36
36
 
@@ -38,6 +38,10 @@ Nothing scheduled yet.
38
38
 
39
39
  ## Shipped
40
40
 
41
+ ### Next release
42
+
43
+ - **The operation, told to the observers.** Each operation the endpoint executes is reported to the middlewares around it: `@alxia/logger` writes `operationName` and `operationType` on the request's line, `@alxia/telemetry` names its span `query GetNotes` with `graphql.operation.name` and `graphql.operation.type`. A batched body is one line and one span, `batch`, with every name ([endpoint guide](guide/endpoint.md#the-operation-in-the-log-and-the-trace)).
44
+
41
45
  ### 0.1.0
42
46
 
43
47
  - **GraphQL Yoga as a route.** `graphql(app, options)` serves a schema at
@@ -401,6 +401,24 @@ const base = alxia().use(bearer({ jwt }));
401
401
  const app = base.plugin((app) => graphql(app, { schema }));
402
402
  ```
403
403
 
404
+ ### Every log line and span is an anonymous `POST /graphql`
405
+
406
+ **When:** `@alxia/logger` writes `POST /graphql 200` with no
407
+ `operationName`, and the span of `@alxia/telemetry` is named
408
+ `POST /graphql`.
409
+
410
+ **Why:** an operation is reported only when Yoga executes it. A request
411
+ refused before that (a syntax error, a document that fails validation) names
412
+ none; an operation over `ws: true` is not reported; and a logger or a
413
+ telemetry given to `use` *after* the endpoint, or a version of
414
+ `@alxia/core` older than the one that reports (`operationOf`), never reads
415
+ it.
416
+
417
+ **Fix:** give `logger()` and `telemetry()` to `use` before `graphql()`, and
418
+ update `@alxia/core`, `@alxia/graphql`, `@alxia/logger` and
419
+ `@alxia/telemetry` together. See
420
+ [the endpoint guide](guide/endpoint.md#the-operation-in-the-log-and-the-trace).
421
+
404
422
  ### The logger, CORS or secure headers miss the endpoint
405
423
 
406
424
  **When:** `use(logger())`, `use(cors(…))` or `use(secureHeaders())` comes
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alxia/graphql",
3
- "version": "0.4.0",
3
+ "version": "0.5.0",
4
4
  "description": "GraphQL for alxia with GraphQL Yoga: its plugins, subscriptions over SSE or WebSocket (graphql-ws) and GraphiQL, behind the app's hooks, its resolvers reading the app's typed context",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -41,7 +41,7 @@
41
41
  ]
42
42
  },
43
43
  "devDependencies": {
44
- "@alxia/core": "^0.6.0",
44
+ "@alxia/core": "^0.7.0",
45
45
  "@types/bun": "^1.4.2",
46
46
  "dataloader": "^2.2.3",
47
47
  "graphql": "^16.11.0",
@@ -49,7 +49,7 @@
49
49
  "graphql-yoga": "^5.16.0"
50
50
  },
51
51
  "peerDependencies": {
52
- "@alxia/core": "^0.6.0",
52
+ "@alxia/core": "^0.7.0",
53
53
  "graphql": "^16.11.0 || ^17.0.0",
54
54
  "graphql-ws": "^6.1.0",
55
55
  "graphql-yoga": "^5.16.0",