Export wrap (#2094)

graphile · Jun 14, 2024 · ab3ac22 · ab3ac22
2 parents b1ffe28 + c0e50a1
commit ab3ac22
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 8 deletions.
diff --git a/.changeset/quick-dogs-clap.md b/.changeset/quick-dogs-clap.md
@@ -0,0 +1,5 @@
+---
+"graphile-export": patch
+---
+
+Output location in more error messages.
diff --git a/.changeset/silent-cups-allow.md b/.changeset/silent-cups-allow.md
@@ -0,0 +1,6 @@
+---
+"graphile-utils": patch
+"postgraphile": patch
+---
+
+makeWrapPlansPlugin more likely to be exportable.
diff --git a/graphile-build/graphile-utils/src/makeWrapPlansPlugin.ts b/graphile-build/graphile-utils/src/makeWrapPlansPlugin.ts
@@ -150,16 +150,18 @@ export function makeWrapPlansPlugin<T>(
               [access, fieldName],
             ),
           } = field;
+          const typeName = Self.name;
           return {
             ...field,
             plan: EXPORTABLE(
               (
                 ExecutableStep,
-                field,
+                fieldName,
                 inspect,
                 isExecutableStep,
                 oldPlan,
                 planWrapper,
+                typeName,
               ) =>
                 (...planParams) => {
                   // A replacement for `oldPlan` that automatically passes through arguments that weren't replaced
@@ -172,9 +174,9 @@ export function makeWrapPlansPlugin<T>(
                     );
                     if (!($prev instanceof ExecutableStep)) {
                       console.error(
-                        `Wrapped a plan function, but that function did not return a step!\n${String(
+                        `Wrapped a plan function at ${typeName}.${fieldName}, but that function did not return a step!\n${String(
                           oldPlan,
-                        )}\n${inspect(field)}`,
+                        )}`,
                       );
 
                       throw new Error(
@@ -206,11 +208,12 @@ export function makeWrapPlansPlugin<T>(
                 },
               [
                 ExecutableStep,
-                field,
+                fieldName,
                 inspect,
                 isExecutableStep,
                 oldPlan,
                 planWrapper,
+                typeName,
               ],
             ),
           };

diff --git a/postgraphile/postgraphile/graphile.config.ts b/postgraphile/postgraphile/graphile.config.ts
@@ -3,7 +3,11 @@ import type { PgSelectSingleStep } from "@dataplan/pg";
 import { TYPES } from "@dataplan/pg";
 import PersistedPlugin from "@grafserv/persisted";
 import { EXPORTABLE, exportSchema } from "graphile-export";
-import { gql, makeExtendSchemaPlugin } from "graphile-utils";
+import {
+  gql,
+  makeExtendSchemaPlugin,
+  makeWrapPlansPlugin,
+} from "graphile-utils";
 import * as jsonwebtoken from "jsonwebtoken";
 import type {} from "postgraphile";
 import { jsonParse } from "postgraphile/@dataplan/json";
@@ -291,10 +295,12 @@ const preset: GraphileConfig.Preset = {
           }
           extend type Query {
             throw: Int
+            wrapMe: Int
           }
         `,
         plans: {
           Query: {
+            wrapMe: EXPORTABLE((constant) => () => constant(42), [constant]),
             throw: EXPORTABLE(
               (error) => () => {
                 return error(
@@ -331,6 +337,18 @@ const preset: GraphileConfig.Preset = {
         },
       };
     }),
+    makeWrapPlansPlugin({
+      Query: {
+        wrapMe(plan) {
+          return plan();
+        },
+      },
+      Mutation: {
+        updatePost(plan) {
+          return plan();
+        },
+      },
+    }),
     makeExtendSchemaPlugin({
       typeDefs: gql`
         extend type Query {

diff --git a/utils/graphile-export/src/exportSchema.ts b/utils/graphile-export/src/exportSchema.ts
@@ -1031,13 +1031,13 @@ function _convertToAST(
     return func(file, thing as AnyFunction, locationHint, nameHint);
   } else if (isSchema(thing)) {
     throw new Error(
-      "Attempted to export GraphQLSchema directly from `_convertToAST`; this is currently unsupported.",
+      `Attempted to export GraphQLSchema directly from \`_convertToAST\` (at ${locationHint}); this is currently unsupported.`,
     );
   } else if (typeof thing === "object" && thing != null) {
     const prototype = Object.getPrototypeOf(thing);
     if (prototype !== null && prototype !== Object.prototype) {
       throw new Error(
-        `Attempting to export an instance of a class; you should wrap this definition in EXPORTABLE! (Class: ${thing.constructor})`,
+        `Attempting to export an instance of a class (at ${locationHint}); you should wrap this definition in EXPORTABLE! (Class: ${thing.constructor})`,
       );
     }
     const propertyPairs: Array<
@@ -1092,7 +1092,9 @@ function _convertToAST(
       }
     } else {
       if (hasUnsafeKeys) {
-        throw new Error(`Unexportable key found on non-null-prototype object`);
+        throw new Error(
+          `Unexportable key found on non-null-prototype object (at ${locationHint})`,
+        );
       } else {
         const obj = t.objectExpression(
           propertyPairs.map(([key, val]) => t.objectProperty(key, val)),