Merge pull request #5256 from Shopify/ah.fix-shopify-function-version-check

Allow multiple compatible `@shopify/shopify_function` major versions

Author: andrewhassan

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

@@ -188,8 +188,13 @@ export async function buildFunctionExtension(
     }
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
   } catch (error: any) {
-    // We capture and rethrow as AbortError to avoid random user-code errors being reported as CLI bugs.
-    // At the same time, we need to keep the ESBuild details for the logs. (the `errors` array)
+    // To avoid random user-code errors being reported as CLI bugs, we capture and rethrow them as AbortError.
+    // In this case, we need to keep the ESBuild details for the logs. (the `errors` array).
+    // If the error is already an AbortError, we can just rethrow it.
+    if (error instanceof AbortError) {
+      throw error
+    }
+
     const errorMessage = (error as Error).message ?? 'Unknown error occurred'
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const newError: any = new AbortError('Failed to build function.', errorMessage)

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

@@ -142,7 +142,7 @@ describe('bundleExtension', () => {
   test('errors if shopify library is not on a compatible version', async () => {
     await inTemporaryDirectory(async (tmpDir) => {
       // Given
-      const incompatibleVersion = '0.0.1'
+      const incompatibleVersion = '999.0.0'
       const ourFunction = await testFunctionExtension({dir: tmpDir})
       ourFunction.entrySourceFilePath = joinPath(tmpDir, 'src/index.ts')
       await installShopifyLibrary(tmpDir)

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

@@ -17,7 +17,8 @@ import {runWithTimer} from '@shopify/cli-kit/node/metadata'
 import {AbortError} from '@shopify/cli-kit/node/error'
 import {Writable} from 'stream'
 
-export const SHOPIFY_FUNCTION_NPM_PACKAGE_MAJOR_VERSION = '1'
+const ALLOWED_FUNCTION_NPM_PACKAGE_MAJOR_VERSIONS = ['0', '1']
+export const PREFERRED_FUNCTION_NPM_PACKAGE_MAJOR_VERSION = '1'
 
 class InvalidShopifyFunctionPackageError extends AbortError {
   constructor(message: string) {
@@ -28,7 +29,7 @@ class InvalidShopifyFunctionPackageError extends AbortError {
       )} library installed.`,
       [
         outputContent`Add ${outputToken.green(
-          `"@shopify/shopify_function": "~${SHOPIFY_FUNCTION_NPM_PACKAGE_MAJOR_VERSION}.0.0"`,
+          `"@shopify/shopify_function": "~${PREFERRED_FUNCTION_NPM_PACKAGE_MAJOR_VERSION}.0.0"`,
         )} to the dependencies section of the package.json file in your function's directory, if not already present.`
           .value,
         `Run your package manager's install command to update dependencies.`,
@@ -160,7 +161,7 @@ async function validateShopifyFunctionPackageVersion(fun: ExtensionInstance<Func
   const packageJson = JSON.parse(await readFile(packageJsonPath))
   const majorVersion = packageJson.version.split('.')[0]
 
-  if (majorVersion !== SHOPIFY_FUNCTION_NPM_PACKAGE_MAJOR_VERSION) {
+  if (!ALLOWED_FUNCTION_NPM_PACKAGE_MAJOR_VERSIONS.includes(majorVersion)) {
     throw new InvalidShopifyFunctionPackageError(
       'The installed version of the Shopify Functions JavaScript library is not compatible with this version of Shopify CLI.',
     )

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

@@ -1,6 +1,6 @@
 import {configurationFileNames, versions} from '../../constants.js'
 import {AppInterface} from '../../models/app/app.js'
-import {buildGraphqlTypes, SHOPIFY_FUNCTION_NPM_PACKAGE_MAJOR_VERSION} from '../function/build.js'
+import {buildGraphqlTypes, PREFERRED_FUNCTION_NPM_PACKAGE_MAJOR_VERSION} from '../function/build.js'
 import {GenerateExtensionContentOutput} from '../../prompts/generate/extension.js'
 import {ExtensionFlavor, ExtensionTemplate} from '../../models/app/template.js'
 import {ensureDownloadedExtensionFlavorExists, ensureExtensionDirectoryExists} from '../extensions/common.js'
@@ -301,7 +301,7 @@ export function getFunctionRuntimeDependencies(templateLanguage: string): Depend
   if (templateLanguage === 'javascript') {
     dependencies.push({
       name: '@shopify/shopify_function',
-      version: `~${SHOPIFY_FUNCTION_NPM_PACKAGE_MAJOR_VERSION}.0.0`,
+      version: `~${PREFERRED_FUNCTION_NPM_PACKAGE_MAJOR_VERSION}.0.0`,
     })
   }
   return dependencies