Merge pull request #4150 from Shopify/explore-webhook-matching-stable-2

[stable] Match webhooks by comparing relative and absolute paths

.changeset/metal-bikes-smell.md

@@ -0,0 +1,5 @@
+---
+'@shopify/app': patch
+---
+
+Fix an issue with webhooks being recreated during deploy

packages/app/src/cli/services/context/identifiers-extensions.test.ts

@@ -1154,7 +1154,7 @@ describe('ensureNonUuidManagedExtensionsIds: for extensions managed in the TOML'
     const config = {
       topic: 'orders/delete',
       api_version: '2024-01',
-      uri: 'https://my-app.com/webhooks',
+      uri: '/webhooks',
       include_fields: ['id'],
       filter: 'id:*',
     }
@@ -1172,7 +1172,8 @@ describe('ensureNonUuidManagedExtensionsIds: for extensions managed in the TOML'
       title: 'Webhook Subscription',
       type: 'WEBHOOK_SUBSCRIPTION',
       activeVersion: {
-        config: JSON.stringify(config),
+        // use absolute path here to test that it matches both absolute and relative paths from the local config
+        config: JSON.stringify({...config, uri: 'https://my-app.com/webhooks'}),
       },
     }
 

packages/app/src/cli/services/context/identifiers-extensions.ts

@@ -161,9 +161,10 @@ function matchWebhooks(remoteSource: RemoteSource, extension: ExtensionInstance)
   const remoteVersionConfig = remoteSource.activeVersion?.config
   const remoteVersionConfigObj = remoteVersionConfig ? JSON.parse(remoteVersionConfig) : {}
   const localConfig = extension.configuration as unknown as SingleWebhookSubscriptionType
+  const remoteUri: string = remoteVersionConfigObj.uri || ''
   return (
     remoteVersionConfigObj.topic === localConfig.topic &&
-    remoteVersionConfigObj.uri === localConfig.uri &&
+    remoteUri.endsWith(localConfig.uri) &&
     remoteVersionConfigObj.filter === localConfig.filter
   )
 }