fix(document-builder): enum variables key names (#1294)

Author: jasonkuhrt

examples/70_type-level/selection-sets.ts

@@ -114,7 +114,6 @@ const getPokemonsLike = async (filter: Graffle.SelectionSets.Query.pokemons$Argu
     name: true,
   })
 
-// todo add test coverage for $ stripping on arguments.
 const pokemons = await getPokemonsLike({ $type: `water` })
 
 // We don't lose any type safety. :)

examples/__outputs__/10_transport-http/transport-http_extension_headers__dynamicHeaders.output.txt

@@ -4,7 +4,7 @@
   headers: Headers {
     accept: 'application/graphql-response+json; charset=utf-8, application/json; charset=utf-8',
     'content-type': 'application/json',
-    'x-sent-at-time': '1734878384165'
+    'x-sent-at-time': '1735104630184'
   },
   method: 'post',
   url: 'http://localhost:3000/graphql',

examples/__outputs__/20_output/output_envelope.output.txt

@@ -16,7 +16,7 @@
     headers: Headers {
       'content-type': 'application/graphql-response+json; charset=utf-8',
       'content-length': '142',
-      date: 'Sun, 22 Dec 2024 14:39:45 GMT',
+      date: 'Wed, 25 Dec 2024 05:30:30 GMT',
       connection: 'keep-alive',
       'keep-alive': 'timeout=5'
     },

examples/__outputs__/60_extension/extension_opentelemetry__opentelemetry.output.txt

@@ -9,14 +9,14 @@
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '7adcc8f82ea6b22e5d53dc12a862e3b7',
-  parentId: '45c84f0a43771166',
+  traceId: '2d49d55d453267b20a3306c412c2c4bb',
+  parentId: '3294547ab163e342',
   traceState: undefined,
   name: 'encode',
-  id: 'f723a4047c4f8246',
+  id: '1ef2540c3612ae74',
   kind: 0,
-  timestamp: 1734878385686000,
-  duration: 1952.542,
+  timestamp: 1735104630493000,
+  duration: 965.459,
   attributes: {},
   status: { code: 0 },
   events: [],
@@ -33,14 +33,14 @@
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '7adcc8f82ea6b22e5d53dc12a862e3b7',
-  parentId: '45c84f0a43771166',
+  traceId: '2d49d55d453267b20a3306c412c2c4bb',
+  parentId: '3294547ab163e342',
   traceState: undefined,
   name: 'pack',
-  id: '8404e21eb12fbc92',
+  id: '12dbd874c3b489ce',
   kind: 0,
-  timestamp: 1734878385689000,
-  duration: 12830.875,
+  timestamp: 1735104630495000,
+  duration: 10833.958,
   attributes: {},
   status: { code: 0 },
   events: [],
@@ -57,14 +57,14 @@
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '7adcc8f82ea6b22e5d53dc12a862e3b7',
-  parentId: '45c84f0a43771166',
+  traceId: '2d49d55d453267b20a3306c412c2c4bb',
+  parentId: '3294547ab163e342',
   traceState: undefined,
   name: 'exchange',
-  id: 'c5691fe0bcfc9991',
+  id: '837a3ca4af1a71df',
   kind: 0,
-  timestamp: 1734878385703000,
-  duration: 20900.792,
+  timestamp: 1735104630506000,
+  duration: 19948.584,
   attributes: {},
   status: { code: 0 },
   events: [],
@@ -81,14 +81,14 @@
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '7adcc8f82ea6b22e5d53dc12a862e3b7',
-  parentId: '45c84f0a43771166',
+  traceId: '2d49d55d453267b20a3306c412c2c4bb',
+  parentId: '3294547ab163e342',
   traceState: undefined,
   name: 'unpack',
-  id: 'bafdd78624e21445',
+  id: '392e6c2ad292f089',
   kind: 0,
-  timestamp: 1734878385724000,
-  duration: 992.417,
+  timestamp: 1735104630526000,
+  duration: 1046.75,
   attributes: {},
   status: { code: 0 },
   events: [],
@@ -105,14 +105,14 @@
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '7adcc8f82ea6b22e5d53dc12a862e3b7',
-  parentId: '45c84f0a43771166',
+  traceId: '2d49d55d453267b20a3306c412c2c4bb',
+  parentId: '3294547ab163e342',
   traceState: undefined,
   name: 'decode',
-  id: '32fa8b5942d69ca9',
+  id: 'f6f9b43acdbbb5d3',
   kind: 0,
-  timestamp: 1734878385725000,
-  duration: 446.542,
+  timestamp: 1735104630528000,
+  duration: 480.041,
   attributes: {},
   status: { code: 0 },
   events: [],
@@ -129,14 +129,14 @@
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '7adcc8f82ea6b22e5d53dc12a862e3b7',
+  traceId: '2d49d55d453267b20a3306c412c2c4bb',
   parentId: undefined,
   traceState: undefined,
   name: 'request',
-  id: '45c84f0a43771166',
+  id: '3294547ab163e342',
   kind: 0,
-  timestamp: 1734878385686000,
-  duration: 39771.791,
+  timestamp: 1735104630492000,
+  duration: 35822.333,
   attributes: {},
   status: { code: 0 },
   events: [],

package.json

@@ -92,7 +92,7 @@
     "serve:pokemon": "tsx tests/_/services/pokemonManual.ts",
     "gen:graffle": "pnpm gen:graffle:tests && pnpm build && cd website && pnpm gen:graffle",
     "gen:graffle:tests": "tsx tests/_/schemas/generate.ts && pnpm graffle --project src/extensions/SchemaErrors/tests/fixture",
-    "gen:graffle:examples": "pnpm build && cd examples && pnpm i && pnpm gen:graffle",
+    "examples:gen:graffle": "pnpm build && cd examples && pnpm i && pnpm gen:graffle",
     "examples:link-mode": "cd examples && pnpm add ..",
     "graffle": "tsx ./src/generator/cli/generate.ts",
     "gen:examples": "tsx scripts/generate-examples-derivatives/generate.ts && pnpm format",

src/documentBuilder/Select/$parseSelection.ts

@@ -1,3 +1,5 @@
+import { Grafaid } from '../../lib/grafaid/__.js'
+import { Select } from './../Select/__.js'
 import type { SelectionSet } from './_.js'
 import { Arguments, Directive, Indicator, InlineFragment, SelectAlias, SelectScalarsWildcard } from './_.js'
 
@@ -88,9 +90,15 @@ export const parseSelectionInlineFragment = (key: string, value: any): ParsedInl
 
 export const parseSelection = (key: string, value: any): ParsedSelection => {
   if (key === Arguments.key) {
+    const argumentsNormalized = Grafaid.mapVariables(value, (key, value) => {
+      return {
+        key: Select.Arguments.enumKeyPrefixStrip(key),
+        value,
+      }
+    })
     return {
       type: `Arguments`,
-      arguments: value,
+      arguments: argumentsNormalized ?? {},
     }
   }
 

src/documentBuilder/Select/arguments.ts

@@ -8,4 +8,6 @@ export const enumKeyPrefix = `$`
 
 export const enumKeyPrefixPattern = /^\$/g
 
+export const enumKeyPrefixStrip = (key: string) => key.replace(enumKeyPrefixPattern, ``)
+
 export const isEnumKey = (key: string) => key.startsWith(enumKeyPrefix)

src/documentBuilder/SelectGraphQLMapper/__snapshots__/toGraphQL.test.ts.snap

@@ -675,6 +675,52 @@ exports[`( variables: false; scalars: (none) ) - Query - args - custom scalar -
 "
 `;
 
+exports[`( variables: false; scalars: (none) ) - Query - args - enum > args - enum 1`] = `
+"
+
+--------------GRAFFLE QUERY-------------
+{
+  "stringWithArgEnum": {
+    "$": {
+      "$ABCEnum": "A"
+    }
+  }
+}
+--------GRAPHQL DOCUMENT & VARIABLES--------
+{
+  stringWithArgEnum(ABCEnum: A)
+}
+----------------
+{
+  "$default": {}
+}
+"
+`;
+
+exports[`( variables: false; scalars: (none) ) - Query - args - input object enum > args - input object enum 1`] = `
+"
+
+--------------GRAFFLE QUERY-------------
+{
+  "stringWithArgInputObjectEnum": {
+    "$": {
+      "input": {
+        "$abcEnum": "A"
+      }
+    }
+  }
+}
+--------GRAPHQL DOCUMENT & VARIABLES--------
+{
+  stringWithArgInputObjectEnum(input: {abcEnum: "A"})
+}
+----------------
+{
+  "$default": {}
+}
+"
+`;
+
 exports[`( variables: false; scalars: (none) ) - Query - args - object with args (empty object) > args - object with args (empty object) 1`] = `
 "
 
@@ -2146,6 +2192,58 @@ query ($input: InputObjectNested) {
 "
 `;
 
+exports[`( variables: true; scalars: (none) ) - Query - args - enum > args - enum 1`] = `
+"
+
+--------------GRAFFLE QUERY-------------
+{
+  "stringWithArgEnum": {
+    "$": {
+      "$ABCEnum": "A"
+    }
+  }
+}
+--------GRAPHQL DOCUMENT & VARIABLES--------
+query ($ABCEnum: ABCEnum) {
+  stringWithArgEnum(ABCEnum: $ABCEnum)
+}
+----------------
+{
+  "$default": {
+    "ABCEnum": "A"
+  }
+}
+"
+`;
+
+exports[`( variables: true; scalars: (none) ) - Query - args - input object enum > args - input object enum 1`] = `
+"
+
+--------------GRAFFLE QUERY-------------
+{
+  "stringWithArgInputObjectEnum": {
+    "$": {
+      "input": {
+        "$abcEnum": "A"
+      }
+    }
+  }
+}
+--------GRAPHQL DOCUMENT & VARIABLES--------
+query ($input: InputObjectEnum!) {
+  stringWithArgInputObjectEnum(input: $input)
+}
+----------------
+{
+  "$default": {
+    "input": {
+      "abcEnum": "A"
+    }
+  }
+}
+"
+`;
+
 exports[`( variables: true; scalars: (none) ) - Query - args - object with args (empty object) > args - object with args (empty object) 1`] = `
 "
 

src/documentBuilder/SelectGraphQLMapper/nodes/1_Document.ts

@@ -21,7 +21,7 @@ export const toGraphQLDocument = (
     definitions: operationsAndVariables.map(_ => _.operation),
   })
 
-  const operationsVariables = Object.fromEntries(operationsAndVariables.map((_): [string, Grafaid.Variables] => {
+  const operationsVariables = Object.fromEntries(operationsAndVariables.map((_) => {
     const name = _.operation.name?.value ?? defaultOperationName
     return [name, _.variables]
   }))

src/documentBuilder/SelectGraphQLMapper/nodes/2_OperationDefinition.ts

@@ -52,3 +52,5 @@ export const toGraphQLOperationDefinition: GraphQLPreOperationMapper<
     variables,
   }
 }
+
+// TODO: optimization: skip when using SDDM b/c we don't need $-directed enums