Merge pull request #6281 from Shopify/08-19-change_how_webhook_subscription_uid_is_generated

Change how Webhook Subscription UID is generated

Author: isaacroldan

packages/app/src/cli/models/extensions/extension-instance.test.ts

@@ -531,12 +531,24 @@ describe('draftMessages', async () => {
       expect(extensionInstance.uid).toBe(nonRandomUUID(extensionInstance.handle))
     })
 
-    test('returns non-random UUID based on handle when strategy is dynamic', async () => {
+    test('returns a custom string when strategy is dynamic and it is a webhook subscription extension without filters', async () => {
       // Given
       const extensionInstance = await testSingleWebhookSubscriptionExtension()
+      // Then
+      expect(extensionInstance.uid).toBe('orders/delete::undefined::https://my-app.com/webhooks')
+    })
 
+    test('returns a custom string when strategy is dynamic and it is a webhook subscription extension with filters', async () => {
+      // Given
+      const extensionInstance = await testSingleWebhookSubscriptionExtension({
+        config: {
+          topic: 'orders/delete',
+          uri: 'https://my-app.com/webhooks',
+          filter: '123',
+        },
+      })
       // Then
-      expect(extensionInstance.uid).toBe(nonRandomUUID(extensionInstance.handle))
+      expect(extensionInstance.uid).toBe('orders/delete::123::https://my-app.com/webhooks')
     })
   })
 })

packages/app/src/cli/models/extensions/extension-instance.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 
-import {BaseConfigType, MAX_EXTENSION_HANDLE_LENGTH} from './schemas.js'
+import {BaseConfigType, MAX_EXTENSION_HANDLE_LENGTH, MAX_UID_LENGTH} from './schemas.js'
 import {FunctionConfigType} from './specifications/function.js'
 import {ExtensionFeature, ExtensionSpecification} from './specification.js'
 import {SingleWebhookSubscriptionType} from './specifications/app_config_webhook_schemas/webhooks_schema.js'
@@ -508,7 +508,19 @@ export class ExtensionInstance<TConfiguration extends BaseConfigType = BaseConfi
       case 'uuid':
         return this.configuration.uid ?? nonRandomUUID(this.handle)
       case 'dynamic':
-        return nonRandomUUID(this.handle)
+        // NOTE: This is a temporary special case for webhook subscriptions.
+        // We're directly checking for webhook properties and casting the configuration
+        // instead of using a proper dynamic strategy implementation.
+        // To remove this special case:
+        // 1. Implement a proper dynamic UID strategy for webhooks in the server-side specification
+        // 2. Update the CLI to use that strategy instead of this hardcoded logic
+        // Related issues: PR #559094 in old Core repo
+        if ('topic' in this.configuration && 'uri' in this.configuration) {
+          const subscription = this.configuration as unknown as SingleWebhookSubscriptionType
+          return `${subscription.topic}::${subscription.filter}::${subscription.uri}`.substring(0, MAX_UID_LENGTH)
+        } else {
+          return nonRandomUUID(JSON.stringify(this.configuration))
+        }
     }
   }
 }

packages/app/src/cli/models/extensions/schemas.ts

@@ -1,6 +1,7 @@
 import {zod} from '@shopify/cli-kit/node/schema'
 
 export const MAX_EXTENSION_HANDLE_LENGTH = 50
+export const MAX_UID_LENGTH = 250
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type ZodSchemaType<T> = zod.ZodType<T, any, any>