Grafserv overhaul: now compatible with envelop

.changeset/famous-falcons-yell.md

@@ -0,0 +1,8 @@
+---
+"grafast": patch
+---
+
+`resolvedPreset` and `outputDataAsString` can now be specified directly via
+ExecutionArgs - no need to pass additional params to `execute()` and
+`subscribe()` to enable these. Previous signatures are now deprecated (but still
+supported, for a few betas at least).

.changeset/odd-wasps-wait.md

@@ -0,0 +1,5 @@
+---
+"grafserv": patch
+---
+
+Massive refactor of Grafserv internals.

.changeset/perfect-timers-rhyme.md

@@ -0,0 +1,6 @@
+---
+"postgraphile": patch
+"grafast": patch
+---
+
+Envelop peer dependency upgraded to V5

grafast/grafast/package.json

@@ -72,7 +72,7 @@
     "tslib": "^2.6.2"
   },
   "peerDependencies": {
-    "@envelop/core": "^3.0.4",
+    "@envelop/core": "^5.0.0",
     "graphile-config": "workspace:^",
     "graphql": "^16.1.0-experimental-stream-defer.6",
     "tamedevil": "workspace:^"

grafast/grafast/src/execute.ts

@@ -9,7 +9,11 @@ import type { PromiseOrValue } from "graphql/jsutils/PromiseOrValue";
 import { NULL_PRESET } from "./config.js";
 import { isDev } from "./dev.js";
 import { inspect } from "./inspect.js";
-import type { ExecutionEventEmitter, ExecutionEventMap } from "./interfaces.js";
+import type {
+  ExecutionEventEmitter,
+  ExecutionEventMap,
+  GrafastExecutionArgs,
+} from "./interfaces.js";
 import { $$eventEmitter, $$extensions } from "./interfaces.js";
 import { grafastPrepare } from "./prepare.js";
 import { isPromiseLike } from "./utils.js";
@@ -89,16 +93,36 @@ export function withGrafastArgs(
   }
 }
 
+/**
+ * @deprecated Second and third parameters should be passed as part of args,
+ * specifically `resolvedPreset` and `outputDataAsString`.
+ */
+export function execute(
+  args: GrafastExecutionArgs,
+  resolvedPreset: GraphileConfig.ResolvedPreset | undefined,
+  outputDataAsString?: boolean,
+): PromiseOrValue<
+  ExecutionResult | AsyncGenerator<AsyncExecutionResult, void, undefined>
+>;
 /**
  * Use this instead of GraphQL.js' execute method and we'll automatically
  * run grafastPrepare for you and handle the result.
  */
 export function execute(
   args: ExecutionArgs,
-  resolvedPreset: GraphileConfig.ResolvedPreset = NULL_PRESET,
-  outputDataAsString = false,
+): PromiseOrValue<
+  ExecutionResult | AsyncGenerator<AsyncExecutionResult, void, undefined>
+>;
+export function execute(
+  args: GrafastExecutionArgs,
+  resolvedPreset?: GraphileConfig.ResolvedPreset,
+  outputDataAsString?: boolean,
 ): PromiseOrValue<
   ExecutionResult | AsyncGenerator<AsyncExecutionResult, void, undefined>
 > {
-  return withGrafastArgs(args, resolvedPreset, outputDataAsString);
+  return withGrafastArgs(
+    args,
+    args.resolvedPreset ?? resolvedPreset ?? NULL_PRESET,
+    args.outputDataAsString ?? outputDataAsString ?? false,
+  );
 }

grafast/grafast/src/index.ts

@@ -45,6 +45,7 @@ import type {
   $$queryCache,
   CacheByOperationEntry,
   DataFromStep,
+  GrafastExecutionArgs,
   GrafastTimeouts,
   ScalarInputPlanResolver,
 } from "./interfaces.js";
@@ -323,6 +324,7 @@ export {
   getEnumValueConfig,
   grafast,
   GrafastArgumentConfig,
+  GrafastExecutionArgs,
   GrafastFieldConfig,
   GrafastFieldConfigArgumentMap,
   grafast as grafastGraphql,

grafast/grafast/src/interfaces.ts

@@ -1,6 +1,7 @@
 import type EventEmitter from "eventemitter3";
 import type {
   ASTNode,
+  ExecutionArgs,
   FragmentDefinitionNode,
   GraphQLArgs,
   GraphQLArgument,
@@ -942,3 +943,8 @@ export const $$deepDepSkip = Symbol("deepDepSkip_experimental");
 
 export type DataFromStep<TStep extends ExecutableStep> =
   TStep extends ExecutableStep<infer TData> ? TData : never;
+
+export interface GrafastExecutionArgs extends ExecutionArgs {
+  resolvedPreset?: GraphileConfig.ResolvedPreset;
+  outputDataAsString?: boolean;
+}

grafast/grafast/src/subscribe.ts

@@ -7,18 +7,41 @@ import type { PromiseOrValue } from "graphql/jsutils/PromiseOrValue";
 
 import { NULL_PRESET } from "./config.js";
 import { withGrafastArgs } from "./execute.js";
+import type { GrafastExecutionArgs } from "./index.js";
 
+/**
+ * @deprecated Second and third parameters should be passed as part of args,
+ * specifically `resolvedPreset` and `outputDataAsString`.
+ */
+export function subscribe(
+  args: ExecutionArgs,
+  resolvedPreset: GraphileConfig.ResolvedPreset | undefined,
+  outputDataAsString?: boolean,
+): PromiseOrValue<
+  | AsyncGenerator<ExecutionResult | AsyncExecutionResult, void, void>
+  | ExecutionResult
+>;
 /**
  * Use this instead of GraphQL.js' subscribe method and we'll automatically
  * run grafastPrepare for you and handle the result.
  */
 export function subscribe(
-  args: ExecutionArgs,
-  resolvedPreset: GraphileConfig.ResolvedPreset = NULL_PRESET,
-  outputDataAsString = false,
+  args: GrafastExecutionArgs,
+): PromiseOrValue<
+  | AsyncGenerator<ExecutionResult | AsyncExecutionResult, void, void>
+  | ExecutionResult
+>;
+export function subscribe(
+  args: GrafastExecutionArgs,
+  resolvedPreset?: GraphileConfig.ResolvedPreset,
+  outputDataAsString?: boolean,
 ): PromiseOrValue<
   | AsyncGenerator<ExecutionResult | AsyncExecutionResult, void, void>
   | ExecutionResult
 > {
-  return withGrafastArgs(args, resolvedPreset, outputDataAsString);
+  return withGrafastArgs(
+    args,
+    args.resolvedPreset ?? resolvedPreset ?? NULL_PRESET,
+    args.outputDataAsString ?? outputDataAsString ?? false,
+  );
 }

grafast/grafserv/__tests__/envelop.test.ts

@@ -0,0 +1,77 @@
+import { envelop, useLogger, useMaskedErrors } from "@envelop/core";
+import { fetch } from "@whatwg-node/fetch";
+
+import { GrafservEnvelopPreset } from "../src/envelop/index.js";
+import { makeExampleServer } from "./exampleServer.js";
+
+let server: Awaited<ReturnType<typeof makeExampleServer>> | null = null;
+
+afterEach(() => {
+  server?.release();
+});
+
+const sharedConfig: GraphileConfig.Preset = {
+  grafserv: {
+    graphqlOverGET: true,
+    graphqlPath: "/graphql",
+    dangerouslyAllowAllCORSRequests: true,
+  },
+  grafast: {
+    context: () => {
+      return {
+        fromGrafastContext: true,
+      };
+    },
+  },
+};
+
+test("envelop plugin is used", async () => {
+  const logFn = jest.fn((_eventName, _args) => {});
+  const getEnveloped = envelop({
+    plugins: [useLogger({ logFn }), useMaskedErrors()],
+  });
+  server = await makeExampleServer({
+    extends: [sharedConfig, GrafservEnvelopPreset],
+    grafserv: {
+      getEnveloped,
+    },
+  });
+  const res = await fetch(server.url, {
+    method: "POST",
+    headers: {
+      "content-type": "application/json",
+      accept: "application/graphql-response+json",
+    },
+    body: JSON.stringify({ query: "{ __typename }" }),
+  });
+  const responseBody = await res.json();
+  expect(responseBody.data).toEqual({
+    __typename: "Query",
+  });
+  expect(logFn).toHaveBeenCalledTimes(2);
+  expect(logFn.mock.calls[0][0]).toEqual("execute-start");
+  expect(logFn.mock.calls[1][0]).toEqual("execute-end");
+});
+
+test("envelop masked errors works", async () => {
+  const getEnveloped = envelop({
+    plugins: [useMaskedErrors()],
+  });
+  server = await makeExampleServer({
+    extends: [sharedConfig, GrafservEnvelopPreset],
+    grafserv: {
+      getEnveloped,
+    },
+  });
+  const res = await fetch(server.url, {
+    method: "POST",
+    headers: {
+      "content-type": "application/json",
+      accept: "application/graphql-response+json",
+    },
+    body: JSON.stringify({ query: "{ throwAnError }" }),
+  });
+  const responseBody = await res.json();
+  expect(responseBody.errors).toBeTruthy();
+  expect(responseBody.errors[0].message).toEqual("Unexpected error.");
+});

grafast/grafserv/__tests__/errors.test.ts

@@ -4,7 +4,7 @@ import { makeExampleServer } from "./exampleServer.js";
 
 let server: Awaited<ReturnType<typeof makeExampleServer>> | null = null;
 
-afterAll(() => {
+afterEach(() => {
   server?.release();
 });
 

grafast/grafserv/__tests__/exampleServer.ts

@@ -1,7 +1,8 @@
 import { createServer } from "node:http";
 import type { AddressInfo } from "node:net";
 
-import { constant, makeGrafastSchema } from "grafast";
+import { constant, error, makeGrafastSchema } from "grafast";
+import { resolvePresets } from "graphile-config";
 
 import { grafserv } from "../src/servers/node/index.js";
 
@@ -14,23 +15,29 @@ export async function makeExampleServer(
     },
   },
 ) {
+  const resolvedPreset = resolvePresets([preset]);
   const schema = makeGrafastSchema({
     typeDefs: /* GraphQL */ `
       type Query {
         hello: String!
+        throwAnError: String
       }
     `,
     plans: {
       Query: {
         hello() {
           return constant("world");
         },
+        throwAnError() {
+          return error(new Error("You asked for an error... Here it is."));
+        },
       },
     },
   });
 
   const serv = grafserv({ schema, preset });
-  const server = createServer(serv.createHandler());
+  const server = createServer();
+  serv.addTo(server);
   const promise = new Promise<void>((resolve, reject) => {
     server.on("listening", () => {
       server.off("error", reject);
@@ -45,9 +52,13 @@ export async function makeExampleServer(
     info.family === "IPv6"
       ? `[${info.address === "::" ? "::1" : info.address}]`
       : info.address
-  }:${info.port}${preset.grafserv.graphqlPath}`;
+  }:${info.port}${resolvedPreset.grafserv!.graphqlPath}`;
 
-  const release = () => server.close();
+  const release = () => {
+    serv.release();
+    server.close();
+    server.closeAllConnections();
+  };
   return { url, release };
 }
 

grafast/grafserv/package.json

@@ -10,6 +10,10 @@
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
+    "./envelop": {
+      "types": "./dist/envelop/index.d.ts",
+      "default": "./dist/envelop/index.js"
+    },
     "./node": {
       "types": "./dist/servers/node/index.d.ts",
       "default": "./dist/servers/node/index.js"
@@ -85,13 +89,17 @@
     "node": ">=16.10"
   },
   "peerDependencies": {
+    "@envelop/core": "^5.0.0",
     "grafast": "workspace:^",
     "graphile-config": "workspace:^",
     "graphql": "^16.1.0-experimental-stream-defer.6",
     "h3": "^1.7.1",
     "ws": "^8.12.1"
   },
   "peerDependenciesMeta": {
+    "@envelop/core": {
+      "optional": true
+    },
     "h3": {
       "optional": true
     },
@@ -100,6 +108,7 @@
     }
   },
   "devDependencies": {
+    "@envelop/core": "^5.0.0",
     "@fastify/websocket": "^8.2.0",
     "@types/aws-lambda": "^8.10.123",
     "@types/express": "^4.17.17",