Merge pull request #7480 from Shopify/lopert.prepend-api-version

prepend api_version to schema

Author: lopert

packages/app/src/cli/services/build/extension.test.ts

@@ -1,6 +1,7 @@
 import {buildFunctionExtension} from './extension.js'
 import {testFunctionExtension} from '../../models/app/app.test-data.js'
 import {buildGraphqlTypes, buildJSFunction, runWasmOpt, runTrampoline} from '../function/build.js'
+import {validateSchemaApiVersion} from '../function/schema-version.js'
 import {ExtensionInstance} from '../../models/extensions/extension-instance.js'
 import {FunctionConfigType} from '../../models/extensions/specifications/function.js'
 import {beforeEach, describe, expect, test, vi} from 'vitest'
@@ -12,6 +13,7 @@ import {joinPath} from '@shopify/cli-kit/node/path'
 
 vi.mock('@shopify/cli-kit/node/system')
 vi.mock('../function/build.js')
+vi.mock('../function/schema-version.js')
 vi.mock('proper-lockfile')
 vi.mock('@shopify/cli-kit/node/fs')
 
@@ -418,6 +420,26 @@ describe('buildFunctionExtension', () => {
     expect(runWasmOpt).toHaveBeenCalled()
   })
 
+  test('calls validateSchemaApiVersion with the values from the extension config', async () => {
+    // When
+    await expect(
+      buildFunctionExtension(extension, {
+        stdout,
+        stderr,
+        signal,
+        app,
+        environment: 'production',
+      }),
+    ).resolves.toBeUndefined()
+
+    // Then
+    expect(validateSchemaApiVersion).toHaveBeenCalledWith({
+      directory: extension.directory,
+      localIdentifier: extension.localIdentifier,
+      apiVersion: extension.configuration.api_version,
+    })
+  })
+
   test('does not rebundle when build.path stays in the default output directory', async () => {
     // Given
     extension.configuration.build!.path = 'dist/custom.wasm'

packages/app/src/cli/services/build/extension.ts

@@ -2,6 +2,7 @@ import {formatBundleSize} from './bundle-size.js'
 import {AppInterface} from '../../models/app/app.js'
 import {bundleExtension} from '../extensions/bundle.js'
 import {buildGraphqlTypes, buildJSFunction, runTrampoline, runWasmOpt} from '../function/build.js'
+import {validateSchemaApiVersion} from '../function/schema-version.js'
 import {ExtensionInstance} from '../../models/extensions/extension-instance.js'
 import {FunctionConfigType} from '../../models/extensions/specifications/function.js'
 import {exec} from '@shopify/cli-kit/node/system'
@@ -156,12 +157,18 @@ export async function buildFunctionExtension(
   }
 
   try {
+    const functionConfiguration = (extension as ExtensionInstance<FunctionConfigType>).configuration
     const bundlePath = extension.outputPath
-    const relativeBuildPath =
-      (extension as ExtensionInstance<FunctionConfigType>).configuration.build?.path ?? extension.outputRelativePath
+    const relativeBuildPath = functionConfiguration.build?.path ?? extension.outputRelativePath
 
     extension.outputPath = joinPath(extension.directory, relativeBuildPath)
 
+    await validateSchemaApiVersion({
+      directory: extension.directory,
+      localIdentifier: extension.localIdentifier,
+      apiVersion: functionConfiguration.api_version,
+    })
+
     if (extension.isJavaScript) {
       await runCommandOrBuildJSFunction(extension, options)
     } else {

packages/app/src/cli/services/function/schema-version.test.ts

@@ -0,0 +1,109 @@
+import {
+  prependSchemaVersionHeader,
+  readSchemaApiVersion,
+  validateSchemaApiVersion,
+  SCHEMA_VERSION_MARKER_PREFIX,
+} from './schema-version.js'
+import {describe, expect, test} from 'vitest'
+import {AbortError} from '@shopify/cli-kit/node/error'
+import {inTemporaryDirectory, writeFile} from '@shopify/cli-kit/node/fs'
+import {joinPath} from '@shopify/cli-kit/node/path'
+
+function options(directory: string, apiVersion: string) {
+  return {directory, localIdentifier: 'my-function', apiVersion}
+}
+
+describe('prependSchemaVersionHeader', () => {
+  test('prepends a comment block with the version marker', () => {
+    const result = prependSchemaVersionHeader('type Query { id: ID }', '2025-10')
+
+    expect(result.startsWith(`${SCHEMA_VERSION_MARKER_PREFIX}2025-10\n`)).toBe(true)
+    expect(result.endsWith('type Query { id: ID }')).toBe(true)
+  })
+})
+
+describe('readSchemaApiVersion', () => {
+  test('returns the version when the marker is present', async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      const path = joinPath(tmpDir, 'schema.graphql')
+      await writeFile(path, prependSchemaVersionHeader('type Query { id: ID }', '2025-10'))
+
+      await expect(readSchemaApiVersion(path)).resolves.toEqual('2025-10')
+    })
+  })
+
+  test('returns undefined when the file has no marker', async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      const path = joinPath(tmpDir, 'schema.graphql')
+      await writeFile(path, '# some other comment\ntype Query { id: ID }')
+
+      await expect(readSchemaApiVersion(path)).resolves.toBeUndefined()
+    })
+  })
+
+  test('returns undefined when the file does not exist', async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      await expect(readSchemaApiVersion(joinPath(tmpDir, 'missing.graphql'))).resolves.toBeUndefined()
+    })
+  })
+
+  test('does not match the marker once SDL content has started', async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      const path = joinPath(tmpDir, 'schema.graphql')
+      // Marker buried after SDL content should be ignored.
+      await writeFile(path, `type Query { id: ID }\n${SCHEMA_VERSION_MARKER_PREFIX}2025-10\n`)
+
+      await expect(readSchemaApiVersion(path)).resolves.toBeUndefined()
+    })
+  })
+
+  test('trims surrounding whitespace from the marker value', async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      const path = joinPath(tmpDir, 'schema.graphql')
+      await writeFile(path, `${SCHEMA_VERSION_MARKER_PREFIX}  2025-10  \ntype Query { id: ID }`)
+
+      await expect(readSchemaApiVersion(path)).resolves.toEqual('2025-10')
+    })
+  })
+})
+
+describe('validateSchemaApiVersion', () => {
+  test('no-ops when the schema file does not exist', async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      await expect(validateSchemaApiVersion(options(tmpDir, '2025-10'))).resolves.toBeUndefined()
+    })
+  })
+
+  test('no-ops when the schema file has no version marker', async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      await writeFile(joinPath(tmpDir, 'schema.graphql'), 'type Query { id: ID }')
+
+      await expect(validateSchemaApiVersion(options(tmpDir, '2025-10'))).resolves.toBeUndefined()
+    })
+  })
+
+  test('no-ops when the marker matches the configured api_version', async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      await writeFile(
+        joinPath(tmpDir, 'schema.graphql'),
+        prependSchemaVersionHeader('type Query { id: ID }', '2025-10'),
+      )
+
+      await expect(validateSchemaApiVersion(options(tmpDir, '2025-10'))).resolves.toBeUndefined()
+    })
+  })
+
+  test('throws an AbortError with remediation when the marker is stale', async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      await writeFile(
+        joinPath(tmpDir, 'schema.graphql'),
+        prependSchemaVersionHeader('type Query { id: ID }', '2025-07'),
+      )
+
+      const result = validateSchemaApiVersion(options(tmpDir, '2025-10'))
+
+      await expect(result).rejects.toThrow(AbortError)
+      await expect(result).rejects.toThrow(/2025-07[\s\S]*2025-10/)
+    })
+  })
+})

packages/app/src/cli/services/function/schema-version.ts

@@ -0,0 +1,79 @@
+import {AbortError} from '@shopify/cli-kit/node/error'
+import {fileExists, readFile} from '@shopify/cli-kit/node/fs'
+import {joinPath} from '@shopify/cli-kit/node/path'
+import {outputContent, outputDebug, outputToken} from '@shopify/cli-kit/node/output'
+
+/**
+ * Marker used in the leading comments of `schema.graphql` to record the
+ * `api_version` the schema was fetched for. Format: `# api_version: <version>`.
+ */
+export const SCHEMA_VERSION_MARKER_PREFIX = '# api_version: '
+
+/**
+ * Prepends a versioned header to a schema definition. The header documents
+ * which `api_version` the schema was generated for so subsequent builds can
+ * detect when the on-disk schema is stale.
+ */
+export function prependSchemaVersionHeader(definition: string, apiVersion: string): string {
+  return `${SCHEMA_VERSION_MARKER_PREFIX}${apiVersion}\n\n${definition}`
+}
+
+/**
+ * Reads the `api_version` recorded in the leading comments of a schema file.
+ * Returns `undefined` if the file does not have the marker (e.g. hand-authored
+ * schemas, or schemas generated before this header existed).
+ */
+export async function readSchemaApiVersion(filePath: string): Promise<string | undefined> {
+  if (!(await fileExists(filePath))) {
+    outputDebug(`Could not determine api_version: schema file not found at ${filePath}.`)
+    return undefined
+  }
+
+  const contents = await readFile(filePath)
+  // The marker is always written as the first line by `prependSchemaVersionHeader`.
+  const firstLine = contents.split('\n', 1)[0]!
+  if (firstLine.startsWith(SCHEMA_VERSION_MARKER_PREFIX)) {
+    return firstLine.slice(SCHEMA_VERSION_MARKER_PREFIX.length).trim()
+  }
+
+  outputDebug(
+    `Could not determine api_version from ${filePath}: missing '${SCHEMA_VERSION_MARKER_PREFIX}' marker on the first line.`,
+  )
+  return undefined
+}
+
+/**
+ * Validates that `<extension>/schema.graphql` matches the `api_version`
+ * declared in the extension TOML. Throws an `AbortError` with a remediation
+ * pointing at `shopify app function schema` when the on-disk schema is stale.
+ *
+ * Silently no-ops when:
+ *   - the schema file does not exist (handled by codegen / out of scope here)
+ *   - the schema file has no version marker (hand-authored schema, or one
+ *     generated before this header existed)
+ */
+interface ValidateSchemaApiVersionOptions {
+  directory: string
+  localIdentifier: string
+  apiVersion: string
+}
+
+export async function validateSchemaApiVersion({
+  directory,
+  localIdentifier,
+  apiVersion,
+}: ValidateSchemaApiVersionOptions): Promise<void> {
+  const schemaPath = joinPath(directory, 'schema.graphql')
+  const versionFromSchema = await readSchemaApiVersion(schemaPath)
+  if (versionFromSchema === undefined) return
+  if (versionFromSchema === apiVersion) return
+
+  throw new AbortError(
+    outputContent`The ${outputToken.cyan(
+      'schema.graphql',
+    )} file for ${outputToken.cyan(localIdentifier)} was generated for api_version ${outputToken.yellow(
+      versionFromSchema,
+    )} but your function is now on api_version ${outputToken.yellow(apiVersion)}.`,
+    outputContent`Run ${outputToken.genericShellCommand('shopify app function schema')} to refresh it.`,
+  )
+}

packages/app/src/cli/services/generate-schema.test.ts

@@ -47,7 +47,7 @@ describe('generateSchemaService', () => {
 
       // Then
       const outputFile = await readFile(joinPath(extension.directory, 'schema.graphql'))
-      expect(outputFile).toEqual('schema')
+      expect(outputFile).toEqual(`# api_version: ${extension.configuration.api_version}\n\nschema`)
     })
   })
 
@@ -72,7 +72,7 @@ describe('generateSchemaService', () => {
       })
 
       // Then
-      expect(mockOutput).toHaveBeenCalledWith('schema')
+      expect(mockOutput).toHaveBeenCalledWith(`# api_version: ${extension.configuration.api_version}\n\nschema`)
     })
   })
 

packages/app/src/cli/services/generate-schema.ts

@@ -1,3 +1,4 @@
+import {prependSchemaVersionHeader} from './function/schema-version.js'
 import {DeveloperPlatformClient} from '../utilities/developer-platform-client.js'
 import {SchemaDefinitionByApiTypeQueryVariables} from '../api/graphql/functions/generated/schema-definition-by-api-type.js'
 import {SchemaDefinitionByTargetQueryVariables} from '../api/graphql/functions/generated/schema-definition-by-target.js'
@@ -22,7 +23,7 @@ export async function generateSchemaService(options: GenerateSchemaOptions) {
   const apiKey = app.configuration.client_id
   const {api_version: version, type, targeting} = extension.configuration
   const usingTargets = Boolean(targeting?.length)
-  const definition = await (usingTargets
+  const fetchedDefinition = await (usingTargets
     ? generateSchemaFromTarget({
         localIdentifier: extension.localIdentifier,
         developerPlatformClient,
@@ -41,6 +42,8 @@ export async function generateSchemaService(options: GenerateSchemaOptions) {
         orgId,
       }))
 
+  const definition = prependSchemaVersionHeader(fetchedDefinition, version)
+
   if (stdout) {
     outputResult(definition)
   } else {