pnpm extension generation fixed

Author: adamtroiani

package.json

@@ -104,7 +104,7 @@
     "@oclif/core": "4.4.0",
     "whatwg-url": "14.0.0",
     "supports-hyperlinks": "3.1.0",
-    "@graphql-tools/utils": "10.7.2",
+    "@graphql-tools/utils": "10.8.0",
     "@shopify/cli-hydrogen>@shopify/cli-kit": "link:./packages/cli-kit",
     "@shopify/cli-hydrogen>@shopify/plugin-cloudflare": "link:./packages/plugin-cloudflare",
     "nanoid": "3.3.8"

packages/app/src/cli/commands/app/function/typegen.ts

@@ -29,7 +29,7 @@ export default class FunctionTypegen extends AppUnlinkedCommand {
 
     const ourFunction = await chooseFunction(app, flags.path)
 
-    await buildGraphqlTypes(ourFunction, {stdout: process.stdout, stderr: process.stderr, app})
+    await buildGraphqlTypes(ourFunction)
     renderSuccess({headline: 'GraphQL types generated successfully.'})
 
     return {app}

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

@@ -22,7 +22,9 @@ import {beforeEach, describe, expect, test, vi} from 'vitest'
 import {exec} from '@shopify/cli-kit/node/system'
 import {dirname, joinPath} from '@shopify/cli-kit/node/path'
 import {inTemporaryDirectory, mkdir, writeFile, removeFile} from '@shopify/cli-kit/node/fs'
+import * as fsNode from '@shopify/cli-kit/node/fs'
 import {build as esBuild} from 'esbuild'
+import {generate} from '@graphql-codegen/cli'
 
 vi.mock('@shopify/cli-kit/node/system')
 vi.mock('esbuild', async () => {
@@ -32,6 +34,9 @@ vi.mock('esbuild', async () => {
     build: vi.fn(),
   }
 })
+vi.mock('@graphql-codegen/cli', () => ({
+  generate: vi.fn().mockResolvedValue(undefined),
+}))
 
 let stdout: any
 let stderr: any
@@ -56,15 +61,34 @@ describe('buildGraphqlTypes', () => {
     // Given
     const ourFunction = await testFunctionExtension({entryPath: 'src/index.js'})
 
+    // Mock the package.json
+    const packageJson = {
+      codegen: {
+        schema: 'schema.graphql',
+        documents: 'src/*.graphql',
+        generates: {
+          './generated/api.ts': {
+            plugins: ['typescript'],
+          },
+        },
+      },
+    }
+    vi.spyOn(fsNode, 'readFile').mockImplementation(async (path: string) => {
+      if (path === joinPath(ourFunction.directory, 'package.json')) {
+        return JSON.stringify(packageJson) as any
+      }
+      return JSON.stringify({}) as any
+    })
+
     // When
-    const got = buildGraphqlTypes(ourFunction, {stdout, stderr, signal, app})
+    const got = buildGraphqlTypes(ourFunction)
 
     // Then
     await expect(got).resolves.toBeUndefined()
-    expect(exec).toHaveBeenCalledWith('npm', ['exec', '--', 'graphql-code-generator', '--config', 'package.json'], {
+    expect(fsNode.readFile).toHaveBeenCalledWith(joinPath(ourFunction.directory, 'package.json'))
+    expect(vi.mocked(generate)).toHaveBeenCalledWith({
       cwd: ourFunction.directory,
-      stderr,
-      signal,
+      ...packageJson.codegen,
     })
   })
 
@@ -74,7 +98,7 @@ describe('buildGraphqlTypes', () => {
     ourFunction.entrySourceFilePath = 'src/main.rs'
 
     // When
-    const got = buildGraphqlTypes(ourFunction, {stdout, stderr, signal, app})
+    const got = buildGraphqlTypes(ourFunction)
 
     // Then
     await expect(got).rejects.toThrow(/GraphQL types can only be built for JavaScript functions/)

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

@@ -23,6 +23,7 @@ import {renderTasks} from '@shopify/cli-kit/node/ui'
 import {pickBy} from '@shopify/cli-kit/common/object'
 import {runWithTimer} from '@shopify/cli-kit/node/metadata'
 import {AbortError} from '@shopify/cli-kit/node/error'
+import {generate} from '@graphql-codegen/cli'
 import {Writable} from 'stream'
 
 export const PREFERRED_FUNCTION_NPM_PACKAGE_MAJOR_VERSION = '2'
@@ -77,7 +78,7 @@ async function buildJSFunctionWithoutTasks(
   if (!options.signal?.aborted) {
     options.stdout.write(`Building function ${fun.localIdentifier}...`)
     options.stdout.write(`Building GraphQL types...\n`)
-    await buildGraphqlTypes(fun, options)
+    await buildGraphqlTypes(fun)
   }
   if (!options.signal?.aborted) {
     options.stdout.write(`Bundling JS function...\n`)
@@ -102,7 +103,7 @@ async function buildJSFunctionWithTasks(
     {
       title: 'Building GraphQL types',
       task: async () => {
-        await buildGraphqlTypes(fun, options)
+        await buildGraphqlTypes(fun)
       },
     },
     {
@@ -120,19 +121,22 @@ async function buildJSFunctionWithTasks(
   ])
 }
 
-export async function buildGraphqlTypes(
-  fun: {directory: string; isJavaScript: boolean},
-  options: JSFunctionBuildOptions,
-) {
+export async function buildGraphqlTypes(fun: {directory: string; isJavaScript: boolean}) {
   if (!fun.isJavaScript) {
     throw new Error('GraphQL types can only be built for JavaScript functions')
   }
 
   return runWithTimer('cmd_all_timing_network_ms')(async () => {
-    return exec('npm', ['exec', '--', 'graphql-code-generator', '--config', 'package.json'], {
+    const packageJsonPath = joinPath(fun.directory, 'package.json')
+    const packageJson = JSON.parse(await readFile(packageJsonPath))
+
+    if (!packageJson.codegen) {
+      throw new AbortError('No `codegen` config found in package.json')
+    }
+
+    return generate({
+      ...packageJson.codegen,
       cwd: fun.directory,
-      stderr: options.stderr,
-      signal: options.signal,
     })
   })
 }

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

@@ -32,6 +32,13 @@ import {joinPath, dirname} from '@shopify/cli-kit/node/path'
 import {slugify} from '@shopify/cli-kit/common/string'
 
 vi.mock('../../models/app/validation/multi-cli-warning.js')
+vi.mock('../function/build.js', async () => {
+  const actual: any = await vi.importActual('../function/build.js')
+  return {
+    ...actual,
+    buildGraphqlTypes: vi.fn().mockResolvedValue(undefined),
+  }
+})
 vi.mock('@shopify/cli-kit/node/node-package-manager', async () => {
   const actual: any = await vi.importActual('@shopify/cli-kit/node/node-package-manager')
   return {
@@ -360,7 +367,7 @@ describe('initialize a extension', async () => {
           await file.mkdir(joinPath(destination, 'src'))
           await file.writeFile(joinPath(destination, 'src', 'index'), '')
         })
-        const buildGraphqlTypesSpy = vi.spyOn(functionBuild, 'buildGraphqlTypes').mockResolvedValue()
+        const buildGraphqlTypesSpy = vi.spyOn(functionBuild, 'buildGraphqlTypes').mockResolvedValue(undefined)
 
         // When
         const extensionDir = await createFromTemplate({
@@ -408,6 +415,20 @@ describe('initialize a extension', async () => {
           await file.mkdir(joinPath(destination, 'src'))
           await file.writeFile(joinPath(destination, 'src', 'index'), '')
           await file.writeFile(joinPath(destination, 'src', 'run.graphql'), '')
+          await file.writeFile(
+            joinPath(destination, 'package.json'),
+            JSON.stringify({
+              codegen: {
+                schema: 'schema.graphql',
+                documents: 'src/*.graphql',
+                generates: {
+                  './generated/api.ts': {
+                    plugins: ['typescript'],
+                  },
+                },
+              },
+            }),
+          )
         })
 
         // When

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

@@ -207,7 +207,7 @@ async function functionExtensionInit({
     taskList.push({
       title: `Building GraphQL types`,
       task: async () => {
-        await buildGraphqlTypes({directory, isJavaScript: true}, {stdout: process.stdout, stderr: process.stderr, app})
+        await buildGraphqlTypes({directory, isJavaScript: true})
       },
     })
   }