feat(graphql): add experimental mode to optimize/cache schema union d…

…efinitions

packages/sanity/src/_internal/cli/actions/graphql/deployApiAction.ts

@@ -55,6 +55,7 @@ export default async function deployGraphQLApiAction(
     playground: playgroundFlag,
     generation: generationFlag,
     'non-null-document-fields': nonNullDocumentFieldsFlag,
+    withUnionCache,
   } = flags
 
   const {apiClient, output, prompt} = context
@@ -200,6 +201,7 @@ export default async function deployGraphQLApiAction(
           typeof nonNullDocumentFieldsFlag === 'undefined'
             ? nonNullDocumentFields
             : nonNullDocumentFieldsFlag,
+        withUnionCache,
       })
 
       apiSpec = generateSchema(extracted, {filterSuffix: apiDef.filterSuffix})
@@ -404,6 +406,7 @@ function parseCliFlags(args: {argv?: string[]}) {
     .option('generation', {type: 'string'})
     .option('non-null-document-fields', {type: 'boolean'})
     .option('playground', {type: 'boolean'})
+    .option('with-union-cache', {type: 'boolean'})
     .option('force', {type: 'boolean'}).argv
 }
 

packages/sanity/src/_internal/cli/actions/graphql/extractFromSanitySchema.ts

@@ -150,10 +150,11 @@ function getCrossDatasetReferenceMetadata(
 
 export function extractFromSanitySchema(
   sanitySchema: CompiledSchema,
-  extractOptions: {nonNullDocumentFields?: boolean} = {},
+  extractOptions: {nonNullDocumentFields?: boolean; withUnionCache?: boolean} = {},
 ): ApiSpecification {
-  const {nonNullDocumentFields} = extractOptions
+  const {nonNullDocumentFields, withUnionCache} = extractOptions
   const unionRecursionGuards = new Set<string>()
+  const unionDefinitionCache = new Map<string, any>()
   const hasErrors =
     sanitySchema._validation &&
     sanitySchema._validation.some((group) =>
@@ -456,6 +457,13 @@ export function extractFromSanitySchema(
       return {}
     }
 
+    const unionCacheKey = `${options.grandParent}-${guardPathName}-${candidates
+      .map((c) => c.type?.name)
+      .join('-')}`
+    if (withUnionCache && unionDefinitionCache.has(unionCacheKey)) {
+      return unionDefinitionCache.get(unionCacheKey)
+    }
+
     try {
       unionRecursionGuards.add(guardPathName)
 
@@ -532,9 +540,13 @@ export function extractFromSanitySchema(
 
       const references = refs.length > 0 ? refs : undefined
       const inlineObjects = inlineObjs.length > 0 ? inlineObjs : undefined
-      return isReference(parent)
+
+      const unionDefinition = isReference(parent)
         ? {type: name, references}
         : {type: name, references, inlineObjects}
+
+      unionDefinitionCache.set(unionCacheKey, unionDefinition)
+      return unionDefinition
     } finally {
       unionRecursionGuards.delete(guardPathName)
     }

packages/sanity/src/_internal/cli/commands/graphql/deployGraphQLAPICommand.ts

@@ -16,6 +16,7 @@ configuration file. Tread with caution!
   --non-null-document-fields Use non-null document fields (_id, _type etc)
   --playground Enable GraphQL playground for easier debugging
   --no-playground Disable GraphQL playground
+  --with-union-cache *Experimental:* Enable union cache that optimizes schema generation for schemas with many self referencing types
 
 Examples
   # Deploy all defined GraphQL APIs