Merge pull request #638 from Shopify/functions-id-matching

Refactor extensions ID-matching

Author: isaacroldan

packages/app/src/cli/constants.ts

@@ -310,7 +310,7 @@ export const extensionGraphqlId = (type: ExtensionTypes) => {
     case 'delivery_customization':
     case 'shipping_rate_presenter':
       // As we add new extensions, this bug will force us to add a new case here.
-      return type
+      return type.toUpperCase()
   }
 }
 

packages/app/src/cli/services/environment/id-manual-matching.test.ts

@@ -91,7 +91,7 @@ describe('manualMatch: when all extensions are matched', () => {
     vi.mocked(ui.prompt).mockResolvedValueOnce({uuid: 'UUID_A_2'})
 
     // When
-    const got = await manualMatchIds([EXTENSION_A, EXTENSION_A_2], [REGISTRATION_A, REGISTRATION_A_2])
+    const got = await manualMatchIds({local: [EXTENSION_A, EXTENSION_A_2], remote: [REGISTRATION_A, REGISTRATION_A_2]})
 
     // Then
     const expected: ManualMatchResult = {
@@ -109,7 +109,7 @@ describe('manualMatch: when there are more local extensions', () => {
     vi.mocked(ui.prompt).mockResolvedValueOnce({uuid: 'UUID_A'})
 
     // When
-    const got = await manualMatchIds([EXTENSION_A, EXTENSION_A_2], [REGISTRATION_A])
+    const got = await manualMatchIds({local: [EXTENSION_A, EXTENSION_A_2], remote: [REGISTRATION_A]})
 
     // Then
     const expected: ManualMatchResult = {
@@ -129,7 +129,10 @@ describe('manualMatch: when there are more local extensions and user selects to
     vi.mocked(ui.prompt).mockResolvedValueOnce({uuid: 'UUID_A_2'})
 
     // When
-    const got = await manualMatchIds([EXTENSION_A, EXTENSION_A_2, EXTENSION_B], [REGISTRATION_A, REGISTRATION_A_2])
+    const got = await manualMatchIds({
+      local: [EXTENSION_A, EXTENSION_A_2, EXTENSION_B],
+      remote: [REGISTRATION_A, REGISTRATION_A_2],
+    })
 
     // Then
     const expected: ManualMatchResult = {
@@ -149,7 +152,10 @@ describe('manualMatch: when not all remote extensions are matched', () => {
     vi.mocked(ui.prompt).mockResolvedValueOnce({uuid: 'create'})
 
     // When
-    const got = await manualMatchIds([EXTENSION_A, EXTENSION_A_2, EXTENSION_B], [REGISTRATION_A, REGISTRATION_A_2])
+    const got = await manualMatchIds({
+      local: [EXTENSION_A, EXTENSION_A_2, EXTENSION_B],
+      remote: [REGISTRATION_A, REGISTRATION_A_2],
+    })
 
     // Then
     const expected: ManualMatchResult = {result: 'pending-remote'}

packages/app/src/cli/services/environment/id-manual-matching.ts

@@ -1,13 +1,13 @@
-import {ExtensionRegistration} from '../dev/create-extension.js'
+import {LocalExtension} from './id-matching.js'
+import {selectRegistrationPrompt} from './prompts.js'
+import {RemoteRegistration} from './identifiers.js'
 import {IdentifiersExtensions} from '../../models/app/identifiers.js'
-import {Extension} from '../../models/app/extensions.js'
-import {ui} from '@shopify/cli-kit'
 
 export type ManualMatchResult =
   | {
       result: 'ok'
       identifiers: IdentifiersExtensions
-      toCreate: Extension[]
+      toCreate: LocalExtension[]
     }
   | {result: 'pending-remote'}
 
@@ -16,49 +16,33 @@ export type ManualMatchResult =
  * The user can also select to create a new remote extension instead of selecting an existing one.
  * Manual matching will only show extensions of the same type as possible matches.
  * At the end of this process, all remote extensions must be matched to suceed.
- * @param localExtensions - The local extensions to match
- * @param remoteExtensions - The remote extensions to match
+ * @param local - The local extensions to match
+ * @param remote - The remote extensions to match
  * @returns The result of the manual matching
  */
 export async function manualMatchIds(
-  localExtensions: Extension[],
-  remoteExtensions: ExtensionRegistration[],
+  options: {
+    local: LocalExtension[]
+    remote: RemoteRegistration[]
+  },
+  registrationIdField: 'id' | 'uuid' = 'uuid',
 ): Promise<ManualMatchResult> {
   const identifiers: {[key: string]: string} = {}
-  let pendingRemote = remoteExtensions
-  let pendingLocal = localExtensions
-  for (const extension of localExtensions) {
+  let pendingRemote = options.remote
+  let pendingLocal = options.local
+  const idField = registrationIdField
+  for (const extension of options.local) {
     const registrationsForType = pendingRemote.filter((reg) => reg.type === extension.graphQLType)
     if (registrationsForType.length === 0) continue
     // eslint-disable-next-line no-await-in-loop
-    const selected = await selectRegistrationPrompt(extension, registrationsForType)
+    const selected = await selectRegistrationPrompt(extension, registrationsForType, idField)
     if (!selected) continue
 
-    identifiers[extension.localIdentifier] = selected.uuid
-    pendingRemote = pendingRemote.filter((reg) => reg.uuid !== selected.uuid)
+    identifiers[extension.localIdentifier] = selected[idField]
+    pendingRemote = pendingRemote.filter((reg) => reg[idField] !== selected[idField])
     pendingLocal = pendingLocal.filter((reg) => reg.localIdentifier !== extension.localIdentifier)
   }
 
   if (pendingRemote.length > 0) return {result: 'pending-remote'}
   return {result: 'ok', identifiers, toCreate: pendingLocal}
 }
-
-export async function selectRegistrationPrompt(
-  extension: Extension,
-  registrations: ExtensionRegistration[],
-): Promise<ExtensionRegistration> {
-  const registrationList = registrations.map((reg) => ({
-    name: `Match it to ${reg.title} (ID: ${reg.id} on Shopify Partners)`,
-    value: reg.uuid,
-  }))
-  registrationList.push({name: 'Create new extension', value: 'create'})
-  const choice: {uuid: string} = await ui.prompt([
-    {
-      type: 'autocomplete',
-      name: 'uuid',
-      message: `How would you like to deploy your "${extension.localIdentifier}"?`,
-      choices: registrationList,
-    },
-  ])
-  return registrations.find((reg) => reg.uuid === choice.uuid)!
-}

packages/app/src/cli/services/environment/id-matching.test.ts

@@ -61,7 +61,7 @@ const EXTENSION_A: UIExtension = {
   type: 'checkout_post_purchase',
   graphQLType: 'CHECKOUT_POST_PURCHASE',
   configuration: {
-    name: '',
+    name: 'EXTENSION A',
     type: 'checkout_post_purchase',
     metafields: [],
     capabilities: {network_access: false, block_progress: false},
@@ -79,7 +79,7 @@ const EXTENSION_A_2: UIExtension = {
   type: 'checkout_post_purchase',
   graphQLType: 'CHECKOUT_POST_PURCHASE',
   configuration: {
-    name: '',
+    name: 'EXTENSION A 2',
     type: 'checkout_post_purchase',
     metafields: [],
     capabilities: {network_access: false, block_progress: false},
@@ -97,7 +97,7 @@ const EXTENSION_B: UIExtension = {
   type: 'product_subscription',
   graphQLType: 'SUBSCRIPTION_MANAGEMENT',
   configuration: {
-    name: '',
+    name: 'EXTENSION B',
     type: 'checkout_post_purchase',
     metafields: [],
     capabilities: {network_access: false, block_progress: false},
@@ -115,7 +115,7 @@ const EXTENSION_C: UIExtension = {
   type: 'theme',
   graphQLType: 'THEME_APP_EXTENSION',
   configuration: {
-    name: '',
+    name: 'EXTENSION C',
     type: 'checkout_post_purchase',
     metafields: [],
     capabilities: {network_access: false, block_progress: false},
@@ -133,7 +133,7 @@ const EXTENSION_D: UIExtension = {
   type: 'web_pixel_extension',
   graphQLType: 'WEB_PIXEL_EXTENSION',
   configuration: {
-    name: '',
+    name: 'EXTENSION D',
     type: 'checkout_post_purchase',
     metafields: [],
     capabilities: {network_access: false, block_progress: false},
@@ -146,7 +146,7 @@ const EXTENSION_D: UIExtension = {
 describe('automaticMatchmaking: case 3 some local extensions, no remote ones', () => {
   it('success and creates all local extensions', async () => {
     // When
-    const got = await automaticMatchmaking([EXTENSION_A, EXTENSION_B], [], {})
+    const got = await automaticMatchmaking([EXTENSION_A, EXTENSION_B], [], {}, 'uuid')
 
     // Then
     const expected = ok({
@@ -162,7 +162,7 @@ describe('automaticMatchmaking: case 3 some local extensions, no remote ones', (
 describe('automaticMatchmaking: case 3b some local extensions of the same type, no remote ones', () => {
   it('success and creates all local extensions', async () => {
     // When
-    const got = await automaticMatchmaking([EXTENSION_A, EXTENSION_A_2], [], {})
+    const got = await automaticMatchmaking([EXTENSION_A, EXTENSION_A_2], [], {}, 'uuid')
 
     // Then
     const expected = ok({
@@ -175,10 +175,26 @@ describe('automaticMatchmaking: case 3b some local extensions of the same type,
   })
 })
 
+describe('automaticMatchmaking: case 3c some local extensions of the same type, only one remote', () => {
+  it('success and creates all local extensions', async () => {
+    // When
+    const got = await automaticMatchmaking([EXTENSION_A, EXTENSION_A_2], [REGISTRATION_A], {}, 'uuid')
+
+    // Then
+    const expected = ok({
+      identifiers: {EXTENSION_A: 'UUID_A'},
+      pendingConfirmation: [],
+      toCreate: [EXTENSION_A_2],
+      toManualMatch: {local: [], remote: []},
+    })
+    expect(got).toEqual(expected)
+  })
+})
+
 describe('automaticMatchmaking: case 4 same number of extensions local and remote with matching types', () => {
   it('suceeds automatically', async () => {
     // When
-    const got = await automaticMatchmaking([EXTENSION_A, EXTENSION_B], [REGISTRATION_A, REGISTRATION_B], {})
+    const got = await automaticMatchmaking([EXTENSION_A, EXTENSION_B], [REGISTRATION_A, REGISTRATION_B], {}, 'uuid')
 
     // Then
     const expected = ok({
@@ -198,6 +214,7 @@ describe('automaticMatchmaking: case 5 more extensions local than remote, all re
       [EXTENSION_A, EXTENSION_B, EXTENSION_C, EXTENSION_D],
       [REGISTRATION_A, REGISTRATION_B],
       {},
+      'uuid',
     )
 
     // Then
@@ -214,27 +231,27 @@ describe('automaticMatchmaking: case 5 more extensions local than remote, all re
 describe('automaticMatchmaking: case 6 remote extensions have types not present locally', () => {
   it('throw error, invalid local environment', async () => {
     // When
-    const got = await automaticMatchmaking([EXTENSION_A, EXTENSION_B], [REGISTRATION_C, REGISTRATION_D], {})
+    const got = await automaticMatchmaking([EXTENSION_A, EXTENSION_B], [REGISTRATION_C, REGISTRATION_D], {}, 'uuid')
 
     // Then
-    expect(got).toEqual(err(new Error('invalid-environment')))
+    expect(got).toEqual(err('invalid-environment'))
   })
 })
 
 describe('automaticMatchmaking: case 7 some extensions match, but other are missing', () => {
   it('throw error, invalid local environment', async () => {
     // When
-    const got = await automaticMatchmaking([EXTENSION_A, EXTENSION_B], [REGISTRATION_A, REGISTRATION_C], {})
+    const got = await automaticMatchmaking([EXTENSION_A, EXTENSION_B], [REGISTRATION_A, REGISTRATION_C], {}, 'uuid')
 
     // Then
-    expect(got).toEqual(err(new Error('invalid-environment')))
+    expect(got).toEqual(err('invalid-environment'))
   })
 })
 
 describe('automaticMatchmaking: case 8 multiple extensions of the same type locally and remotely', () => {
   it('success and returns extensions pending manual match', async () => {
     // When
-    const got = await automaticMatchmaking([EXTENSION_A, EXTENSION_A_2], [REGISTRATION_A, REGISTRATION_A_2], {})
+    const got = await automaticMatchmaking([EXTENSION_A, EXTENSION_A_2], [REGISTRATION_A, REGISTRATION_A_2], {}, 'uuid')
 
     // Then
     const expected = ok({
@@ -254,6 +271,7 @@ describe('automaticMatchmaking: case 9 multiple extensions of the same type loca
       [EXTENSION_A, EXTENSION_A_2, EXTENSION_B],
       [REGISTRATION_A, REGISTRATION_A_2],
       {},
+      'uuid',
     )
 
     // Then
@@ -270,19 +288,24 @@ describe('automaticMatchmaking: case 9 multiple extensions of the same type loca
 describe('automaticMatchmaking: case 10 there are more remote than local extensions', () => {
   it('throw error, invalid local environment', async () => {
     // When
-    const got = await automaticMatchmaking([EXTENSION_A], [REGISTRATION_A, REGISTRATION_A_2], {})
+    const got = await automaticMatchmaking([EXTENSION_A], [REGISTRATION_A, REGISTRATION_A_2], {}, 'uuid')
 
     // Then
-    expect(got).toEqual(err(new Error('invalid-environment')))
+    expect(got).toEqual(err('invalid-environment'))
   })
 })
 
 describe('automaticMatchmaking: case 11 some extension have uuid, others can be matched', () => {
   it('suceeds automatically', async () => {
     // When
-    const got = await automaticMatchmaking([EXTENSION_A, EXTENSION_B], [REGISTRATION_A, REGISTRATION_B], {
-      EXTENSION_A: 'UUID_A',
-    })
+    const got = await automaticMatchmaking(
+      [EXTENSION_A, EXTENSION_B],
+      [REGISTRATION_A, REGISTRATION_B],
+      {
+        EXTENSION_A: 'UUID_A',
+      },
+      'uuid',
+    )
 
     // Then
     const expected = ok({
@@ -298,9 +321,14 @@ describe('automaticMatchmaking: case 11 some extension have uuid, others can be
 describe("automaticMatchmaking: case 12 some extension have uuid, but doesn't match a remote one", () => {
   it('suceeds rematching the extension to the correct UUID if the type is valid', async () => {
     // When
-    const got = await automaticMatchmaking([EXTENSION_A, EXTENSION_B], [REGISTRATION_A, REGISTRATION_B], {
-      EXTENSION_A: 'UUID_WRONG',
-    })
+    const got = await automaticMatchmaking(
+      [EXTENSION_A, EXTENSION_B],
+      [REGISTRATION_A, REGISTRATION_B],
+      {
+        EXTENSION_A: 'UUID_WRONG',
+      },
+      'uuid',
+    )
 
     // Then
     const expected = ok({
@@ -322,6 +350,7 @@ describe('automaticMatchmaking: case 13 duplicated extension types but some of t
       {
         EXTENSION_A: 'UUID_A',
       },
+      'uuid',
     )
 
     // Then
@@ -344,6 +373,7 @@ describe('automaticMatchmaking: case 14 a bit of everything', () => {
       {
         EXTENSION_D: 'UUID_D',
       },
+      'uuid',
     )
 
     // Then
@@ -362,7 +392,7 @@ describe('automaticMatchmaking: case 15 automatic matches with different names',
     // When
     const registrationNewA = {...REGISTRATION_A, title: 'A_NEW'}
     const registrationNewB = {...REGISTRATION_B, title: 'B_NEW'}
-    const got = await automaticMatchmaking([EXTENSION_A, EXTENSION_B], [registrationNewA, registrationNewB], {})
+    const got = await automaticMatchmaking([EXTENSION_A, EXTENSION_B], [registrationNewA, registrationNewB], {}, 'uuid')
 
     // Then
     const expected = ok({
@@ -381,9 +411,9 @@ describe('automaticMatchmaking: case 15 automatic matches with different names',
 describe('automaticMatchmaking: case 16 more remote than local extensions', () => {
   it('throw error, invalid local environment', async () => {
     // When
-    const got = await automaticMatchmaking([EXTENSION_A], [REGISTRATION_A, REGISTRATION_B], {})
+    const got = await automaticMatchmaking([EXTENSION_A], [REGISTRATION_A, REGISTRATION_B], {}, 'uuid')
 
     // Then
-    expect(got).toEqual(err(new Error('invalid-environment')))
+    expect(got).toEqual(err('invalid-environment'))
   })
 })