Deprecate resolvePresets in favour of resolvePreset (#2253)

.changeset/nine-suits-breathe.md

@@ -0,0 +1,8 @@
+---
+"graphile-config": patch
+---
+
+🚨 `{}` is no longer a valid `GraphileConfig.ResolvedPreset`; use
+`resolvePreset({})`
+
+Also: adds `resolvePreset(preset)` and deprecates `resolvePresets(presets)`.

grafast/bench/src/cli.ts

@@ -4,7 +4,7 @@ import { pathToFileURL } from "node:url";
 
 import { glob } from "glob";
 import { isSchema } from "grafast/graphql";
-import { resolvePresets } from "graphile-config";
+import { resolvePreset } from "graphile-config";
 import type { ArgsFromOptions, Argv } from "graphile-config/cli";
 import { loadConfig } from "graphile-config/load";
 
@@ -49,7 +49,7 @@ async function configFromArgs(args: ArgsFromOptions<typeof options>) {
     preset.bench.operations = operations;
   }
 
-  const config = resolvePresets([preset]);
+  const config = resolvePreset(preset);
   return config;
 }
 

grafast/dataplan-pg/scripts/runExampleSchema.mjs

@@ -6,7 +6,7 @@ import { makePgService } from "@dataplan/pg/adaptors/pg";
 import { readFile } from "fs/promises";
 import { sync as globSync } from "glob";
 import { grafast } from "grafast";
-import { resolvePresets } from "graphile-config";
+import { resolvePreset } from "graphile-config";
 import { isAsyncIterable } from "iterall";
 import JSON5 from "json5";
 
@@ -33,7 +33,7 @@ const preset = {
     },
   },
 };
-const resolvedPreset = resolvePresets([preset]);
+const resolvedPreset = resolvePreset(preset);
 
 async function runTestQuery(basePath) {
   const source = await readFile(`${basePath}.test.graphql`, "utf8");

grafast/grafast/__tests__/awkward-identifiers-test.ts

@@ -1,4 +1,5 @@
 import { expect } from "chai";
+import { resolvePreset } from "graphile-config";
 import { ExecutionResult, parse } from "graphql";
 import { it } from "mocha";
 
@@ -89,13 +90,11 @@ it("ok", () => {
   }
 }`;
   expect(JSON.stringify(result.data, null, 2)).to.equal(expected);
-  const result2 = execute(
-    {
-      schema,
-      document: parse(source),
-    },
-    {},
-    true,
-  ) as any;
+  const result2 = execute({
+    schema,
+    document: parse(source),
+    resolvedPreset: resolvePreset({}),
+    outputDataAsString: true,
+  }) as any;
   expect(JSON.stringify(JSON.parse(result2.data), null, 2)).to.equal(expected);
 });

grafast/grafast/__tests__/errorHandling-test.ts

@@ -1,5 +1,6 @@
 /* eslint-disable graphile-export/exhaustive-deps, graphile-export/export-methods, graphile-export/export-instances, graphile-export/export-subclasses, graphile-export/no-nested */
 import { expect } from "chai";
+import { resolvePreset } from "graphile-config";
 import type { AsyncExecutionResult, ExecutionResult } from "graphql";
 import { it } from "mocha";
 
@@ -14,6 +15,9 @@ import {
   sideEffect,
 } from "../dist/index.js";
 
+const resolvedPreset = resolvePreset({});
+const requestContext = {};
+
 declare global {
   namespace Grafast {
     interface Context {
@@ -146,7 +150,7 @@ it(
       requestContext: {
         mol: 42,
       },
-      resolvedPreset: {},
+      resolvedPreset,
     })) as AsyncGenerator<AsyncExecutionResult>;
     let payloads: AsyncExecutionResult[] = [];
     for await (const payload of stream) {
@@ -185,8 +189,8 @@ it(
       variableValues: {
         arr: ["A", "b"],
       },
-      requestContext: {},
-      resolvedPreset: {},
+      requestContext,
+      resolvedPreset,
     })) as ExecutionResult;
     expect(result.errors).to.be.undefined;
     expect(result.data).to.deep.equal({

grafast/grafast/__tests__/errorHandlingStreamTermination-test.ts

@@ -1,5 +1,6 @@
 /* eslint-disable graphile-export/exhaustive-deps, graphile-export/export-methods, graphile-export/export-instances, graphile-export/export-subclasses, graphile-export/no-nested */
 import { expect } from "chai";
+import { resolvePreset } from "graphile-config";
 import type { AsyncExecutionResult } from "graphql";
 import { it } from "mocha";
 
@@ -14,6 +15,9 @@ import {
 } from "../dist/index.js";
 import type { StreamDetails } from "../dist/interfaces.js";
 
+const resolvedPreset = resolvePreset({});
+const requestContext = {};
+
 const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
 
 class SyncListCallbackStep<
@@ -158,14 +162,12 @@ function throwOnUnhandledRejections(callback: () => Promise<void>) {
           streams--;
         }
       });
-      const stream = await grafast(
-        {
-          schema,
-          source,
-        },
-        {},
-        {},
-      );
+      const stream = await grafast({
+        schema,
+        source,
+        resolvedPreset,
+        requestContext,
+      });
 
       let payloads: AsyncExecutionResult[] = [];
       const wasAStream = isAsyncIterable(stream);

grafast/grafast/__tests__/forbidden-test.ts

@@ -1,15 +1,13 @@
 /* eslint-disable graphile-export/exhaustive-deps, graphile-export/export-methods, graphile-export/export-instances, graphile-export/export-subclasses, graphile-export/no-nested */
 import { expect } from "chai";
-import type { AsyncExecutionResult, ExecutionResult } from "graphql";
+import type { ExecutionResult } from "graphql";
 import { it } from "mocha";
 
-import type { ExecutionDetails, PromiseOrDirect } from "../dist/index.js";
+import type { ExecutionDetails } from "../dist/index.js";
 import {
   arrayOfLength,
-  constant,
   ExecutableStep,
   grafast,
-  lambda,
   makeGrafastSchema,
 } from "../dist/index.js";
 

grafast/grafast/__tests__/inputs-test.ts

@@ -1,16 +1,13 @@
 /* eslint-disable graphile-export/exhaustive-deps, graphile-export/export-methods, graphile-export/export-instances, graphile-export/export-subclasses, graphile-export/no-nested */
 import { expect } from "chai";
-import type { AsyncExecutionResult, ExecutionResult } from "graphql";
+import { resolvePreset } from "graphile-config";
+import type { ExecutionResult } from "graphql";
 import { it } from "mocha";
 
-import type { PromiseOrDirect } from "../dist/index.js";
-import {
-  constant,
-  ExecutableStep,
-  grafast,
-  lambda,
-  makeGrafastSchema,
-} from "../dist/index.js";
+import { grafast, makeGrafastSchema } from "../dist/index.js";
+
+const resolvedPreset = resolvePreset({});
+const requestContext = {};
 
 const makeSchema = (useStreamableStep = false) => {
   return makeGrafastSchema({
@@ -81,15 +78,13 @@ it("executes with matching types", async () => {
     nnlos3: [null, null, null],
     nnlonns1: ["1", "2", "3"],
   };
-  const result = (await grafast(
-    {
-      schema,
-      source,
-      variableValues,
-    },
-    {},
-    {},
-  )) as ExecutionResult;
+  const result = (await grafast({
+    schema,
+    source,
+    variableValues,
+    resolvedPreset,
+    requestContext,
+  })) as ExecutionResult;
   expect(result.data).to.deep.equal(variableValues);
 });
 
@@ -120,15 +115,13 @@ it("executes with stricter inner type", async () => {
     nnlos1: ["1", "2", "3"],
     nnlonns1: ["1", "2", "3"],
   };
-  const result = (await grafast(
-    {
-      schema,
-      source,
-      variableValues,
-    },
-    {},
-    {},
-  )) as ExecutionResult;
+  const result = (await grafast({
+    schema,
+    source,
+    variableValues,
+    resolvedPreset,
+    requestContext,
+  })) as ExecutionResult;
   expect(result.data).to.deep.equal(variableValues);
 });
 
@@ -165,15 +158,13 @@ it("executes with stricter outer type", async () => {
     nnlos3: [null, null, null],
     nnlonns1: ["1", "2", "3"],
   };
-  const result = (await grafast(
-    {
-      schema,
-      source,
-      variableValues,
-    },
-    {},
-    {},
-  )) as ExecutionResult;
+  const result = (await grafast({
+    schema,
+    source,
+    variableValues,
+    resolvedPreset,
+    requestContext,
+  })) as ExecutionResult;
   expect(result.data).to.deep.equal(variableValues);
 });
 
@@ -198,14 +189,12 @@ it("executes with stricter inner and outer type", async () => {
     nnlos1: ["1", "2", "3"],
     nnlonns1: ["1", "2", "3"],
   };
-  const result = (await grafast(
-    {
-      schema,
-      source,
-      variableValues,
-    },
-    {},
-    {},
-  )) as ExecutionResult;
+  const result = (await grafast({
+    schema,
+    source,
+    variableValues,
+    resolvedPreset,
+    requestContext,
+  })) as ExecutionResult;
   expect(result.data).to.deep.equal(variableValues);
 });