Merge pull request #663 from Shopify/functions-matching-flag

Functions matching behind a flag

fixtures/app/extensions/product-discount/input.graphql

@@ -1,4 +0,0 @@
-{
-  # select fields on MerchandiseDiscountRoot
-  # or delete this file if the script requires no input
-}

packages/app/src/cli/services/environment/identifiers.test.ts

@@ -7,6 +7,7 @@ import {FunctionExtension, UIExtension} from '../../models/app/extensions.js'
 import {testApp} from '../../models/app/app.test-data.js'
 import {beforeEach, describe, expect, it, vi} from 'vitest'
 import {err, ok} from '@shopify/cli-kit/common/result'
+import {environment} from '@shopify/cli-kit'
 
 const REGISTRATION_A: RemoteSource = {
   uuid: 'UUID_A',
@@ -117,6 +118,7 @@ beforeEach(() => {
       ...cliKit,
       session: {ensureAuthenticatedPartners: async () => 'token'},
       ui: {prompt: vi.fn()},
+      environment: {local: {useFunctionMatching: vi.fn()}},
     }
   })
   vi.mock('../dev/fetch')
@@ -130,6 +132,7 @@ beforeEach(() => {
 describe('ensureDeploymentIdsPresence: matchmaking returns invalid', () => {
   it('throw an invalid environment error if functions is invalid', async () => {
     // Given
+    vi.mocked(environment.local.useFunctionMatching).mockReturnValue(true)
     vi.mocked(ensureFunctionsIds).mockResolvedValue(err('invalid-environment'))
     vi.mocked(ensureExtensionsIds).mockResolvedValue(ok({extensions: {}, extensionIds: {}}))
 
@@ -142,6 +145,7 @@ describe('ensureDeploymentIdsPresence: matchmaking returns invalid', () => {
 
   it('throw an invalid environment error if there are pending remote matches', async () => {
     // Given
+    vi.mocked(environment.local.useFunctionMatching).mockReturnValue(true)
     vi.mocked(ensureFunctionsIds).mockResolvedValue(err('pending-remote'))
     vi.mocked(ensureExtensionsIds).mockResolvedValue(ok({extensions: {}, extensionIds: {}}))
 
@@ -154,6 +158,7 @@ describe('ensureDeploymentIdsPresence: matchmaking returns invalid', () => {
 
   it('throw an invalid environment error if extensions is invalid', async () => {
     // Given
+    vi.mocked(environment.local.useFunctionMatching).mockReturnValue(true)
     vi.mocked(ensureFunctionsIds).mockResolvedValue(ok({}))
     vi.mocked(ensureExtensionsIds).mockResolvedValue(err('invalid-environment'))
 
@@ -168,6 +173,7 @@ describe('ensureDeploymentIdsPresence: matchmaking returns invalid', () => {
 describe('ensureDeploymentIdsPresence: matchmaking is valid', () => {
   it('returns the combination of functions and extensions', async () => {
     // Given
+    vi.mocked(environment.local.useFunctionMatching).mockReturnValue(true)
     vi.mocked(ensureFunctionsIds).mockResolvedValue(ok({FUNCTION_A: 'ID_A', FUNCTION_B: 'ID_B'}))
     vi.mocked(ensureExtensionsIds).mockResolvedValue(
       ok({extensions: {EXTENSION_A: 'UUID_A'}, extensionIds: {EXTENSION_A: 'ID_A'}}),
@@ -184,3 +190,26 @@ describe('ensureDeploymentIdsPresence: matchmaking is valid', () => {
     })
   })
 })
+
+describe('ensureDeploymentIdsPresence: when not using function matchmaking', () => {
+  it('returns the combination of functions in .env and extensions', async () => {
+    // Given
+    vi.mocked(environment.local.useFunctionMatching).mockReturnValue(false)
+    vi.mocked(ensureExtensionsIds).mockResolvedValue(
+      ok({extensions: {EXTENSION_A: 'UUID_A'}, extensionIds: {EXTENSION_A: 'ID_A'}}),
+    )
+
+    // When
+    const got = await ensureDeploymentIdsPresence(
+      options([EXTENSION_A, EXTENSION_A_2], [FUNCTION_C], {FUNCTION_C: 'ID_C'}),
+    )
+
+    // Then
+    await expect(got).toEqual({
+      app: 'appId',
+      extensions: {EXTENSION_A: 'UUID_A', FUNCTION_C: 'ID_C'},
+      extensionIds: {EXTENSION_A: 'ID_A'},
+    })
+    expect(vi.mocked(ensureFunctionsIds)).not.toHaveBeenCalled()
+  })
+})

packages/app/src/cli/services/environment/identifiers.ts

@@ -1,10 +1,10 @@
 import {ensureFunctionsIds} from './identifiers-functions.js'
 import {ensureExtensionsIds} from './identifiers-extensions.js'
 import {AppInterface} from '../../models/app/app.js'
-import {Identifiers} from '../../models/app/identifiers.js'
+import {Identifiers, IdentifiersExtensions} from '../../models/app/identifiers.js'
 import {fetchAppExtensionRegistrations} from '../dev/fetch.js'
 import {ExtensionTypes} from '../../constants.js'
-import {output, error} from '@shopify/cli-kit'
+import {output, error, environment} from '@shopify/cli-kit'
 import {PackageManager} from '@shopify/cli-kit/node/node-package-manager'
 
 export interface EnsureDeploymentIdsPresenceOptions {
@@ -37,19 +37,40 @@ export async function ensureDeploymentIdsPresence(options: EnsureDeploymentIdsPr
 
   const remoteSpecifications = await fetchAppExtensionRegistrations({token: options.token, apiKey: options.appId})
 
-  const functions = await ensureFunctionsIds(options, remoteSpecifications.app.functions)
-  if (functions.isErr()) throw handleIdsError(functions.error, options.appName, options.app.packageManager)
+  let functions: IdentifiersExtensions
+  if (environment.local.useFunctionMatching()) {
+    const result = await ensureFunctionsIds(options, remoteSpecifications.app.functions)
+    if (result.isErr()) throw handleIdsError(result.error, options.appName, options.app.packageManager)
+    functions = result.value
+  } else {
+    functions = unmatchedFunctionIdentifiers(options)
+  }
 
   const extensions = await ensureExtensionsIds(options, remoteSpecifications.app.extensionRegistrations)
   if (extensions.isErr()) throw handleIdsError(extensions.error, options.appName, options.app.packageManager)
 
   return {
     app: options.appId,
-    extensions: {...functions.value, ...extensions.value.extensions},
+    extensions: {...functions, ...extensions.value.extensions},
     extensionIds: extensions.value.extensionIds,
   }
 }
 
+function unmatchedFunctionIdentifiers(options: EnsureDeploymentIdsPresenceOptions) {
+  const validIdentifiers = options.envIdentifiers.extensions ?? {}
+  const functionLocalIdentifiers: IdentifiersExtensions = Object.fromEntries(
+    options.app.extensions.function
+      .map((extension) => extension.localIdentifier)
+      .map((extensionIdentifier) => {
+        return validIdentifiers[extensionIdentifier]
+          ? [extensionIdentifier, validIdentifiers[extensionIdentifier]]
+          : undefined
+      })
+      .filter((entry) => entry !== undefined) as string[][],
+  )
+  return functionLocalIdentifiers
+}
+
 function handleIdsError(errorType: MatchingError, appName: string, packageManager: PackageManager) {
   switch (errorType) {
     case 'pending-remote':

packages/cli-kit/src/constants.ts

@@ -30,6 +30,7 @@ const constants = {
     themeToken: 'SHOPIFY_CLI_THEME_TOKEN',
     unitTest: 'SHOPIFY_UNIT_TEST',
     verbose: 'SHOPIFY_FLAG_VERBOSE',
+    functionMatching: 'SHOPIFY_CLI_FUNCTION_MATCHING',
     // Variables to detect if the CLI is running in a cloud environment
     codespaceName: 'CODESPACE_NAME',
     codespaces: 'CODESPACES',

packages/cli-kit/src/environment/local.ts

@@ -95,6 +95,10 @@ export function useDeviceAuth(env = process.env): boolean {
   return isTruthy(env[constants.environmentVariables.deviceAuth]) || isCloudEnvironment(env)
 }
 
+export function useFunctionMatching(env = process.env): boolean {
+  return isTruthy(env[constants.environmentVariables.functionMatching])
+}
+
 // https://www.gitpod.io/docs/environment-variables#default-environment-variables
 export function gitpodURL(env = process.env): string | undefined {
   return env[constants.environmentVariables.gitpod]