Merge pull request #6812 from Shopify/02-02-ignore_the_identifier_attribute_for_event_subscriptions_when_fetching_configs_from_the_remote_server

Ignore the identifier attribute for event subscriptions when fetching configs from the remote server

Author: karenxie

packages/app/src/cli/models/app/loader.test.ts

@@ -2090,7 +2090,7 @@ redirect_urls = [ "https://example.com/api/auth" ]
     const app = await loadTestingApp()
 
     // Then
-    expect(app.allExtensions).toHaveLength(5)
+    expect(app.allExtensions).toHaveLength(6)
     const extensionsConfig = app.allExtensions.map((ext) => ext.configuration)
     expect(extensionsConfig).toEqual([
       expect.objectContaining({
@@ -2106,6 +2106,9 @@ redirect_urls = [ "https://example.com/api/auth" ]
           api_version: '2023-07',
         },
       }),
+      expect.objectContaining({
+        name: 'for-testing',
+      }),
       expect.objectContaining({
         pos: {
           embedded: true,
@@ -2145,7 +2148,7 @@ redirect_urls = [ "https://example.com/api/auth" ]
     const app = await loadTestingApp({remoteFlags: []})
 
     // Then
-    expect(app.allExtensions).toHaveLength(6)
+    expect(app.allExtensions).toHaveLength(7)
     const extensionsConfig = app.allExtensions.map((ext) => ext.configuration)
     expect(extensionsConfig).toEqual([
       {
@@ -2168,6 +2171,9 @@ redirect_urls = [ "https://example.com/api/auth" ]
         },
         name: 'for-testing-webhooks',
       },
+      {
+        name: 'for-testing-webhooks',
+      },
       {
         application_url: 'https://example.com/lala',
         embedded: true,

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

@@ -12,6 +12,7 @@ import {PosSpecIdentifier} from './specifications/app_config_point_of_sale.js'
 import {PrivacyComplianceWebhooksSpecIdentifier} from './specifications/app_config_privacy_compliance_webhooks.js'
 import {WebhooksSpecIdentifier} from './specifications/app_config_webhook.js'
 import {WebhookSubscriptionSpecIdentifier} from './specifications/app_config_webhook_subscription.js'
+import {EventsSpecIdentifier} from './specifications/app_config_events.js'
 import {
   ExtensionBuildOptions,
   buildFunctionExtension,
@@ -44,6 +45,7 @@ export const CONFIG_EXTENSION_IDS: string[] = [
   PrivacyComplianceWebhooksSpecIdentifier,
   WebhookSubscriptionSpecIdentifier,
   WebhooksSpecIdentifier,
+  EventsSpecIdentifier,
 ]
 
 /**

packages/app/src/cli/models/extensions/load-specifications.ts

@@ -6,6 +6,7 @@ import appWebhooksSpec, {WebhooksSpecIdentifier} from './specifications/app_conf
 import appWebhookSubscriptionSpec, {
   WebhookSubscriptionSpecIdentifier,
 } from './specifications/app_config_webhook_subscription.js'
+import appEventsSpec, {EventsSpecIdentifier} from './specifications/app_config_events.js'
 import appBrandingSpec, {BrandingSpecIdentifier} from './specifications/app_config_branding.js'
 import appAccessSpec, {AppAccessSpecIdentifier} from './specifications/app_config_app_access.js'
 import appPrivacyComplienceSpec, {
@@ -32,6 +33,7 @@ const SORTED_CONFIGURATION_SPEC_IDENTIFIERS = [
   AppAccessSpecIdentifier,
   WebhooksSpecIdentifier,
   WebhookSubscriptionSpecIdentifier,
+  EventsSpecIdentifier,
   PrivacyComplianceWebhooksSpecIdentifier,
   AppProxySpecIdentifier,
   PosSpecIdentifier,
@@ -58,6 +60,7 @@ function loadSpecifications() {
     appPrivacyComplienceSpec,
     appWebhooksSpec,
     appWebhookSubscriptionSpec,
+    appEventsSpec,
   ]
   const moduleSpecs = [
     checkoutPostPurchaseSpec,

packages/app/src/cli/models/extensions/specifications/app_config_events.ts

@@ -0,0 +1,23 @@
+import {transformToEventsConfig, transformFromEventsConfig} from './transform/app_config_events.js'
+import {CustomTransformationConfig, createConfigExtensionSpecification} from '../specification.js'
+import {BaseSchemaWithoutHandle} from '../schemas.js'
+import {zod} from '@shopify/cli-kit/node/schema'
+
+export const EventsSpecIdentifier = 'events'
+
+const EventsTransformConfig: CustomTransformationConfig = {
+  forward: transformFromEventsConfig,
+  reverse: (content: object) => transformToEventsConfig(content),
+}
+
+const EventsSchema = BaseSchemaWithoutHandle.extend({
+  events: zod.any().optional(),
+})
+
+const appEventsSpec = createConfigExtensionSpecification({
+  identifier: EventsSpecIdentifier,
+  schema: EventsSchema,
+  transformConfig: EventsTransformConfig,
+})
+
+export default appEventsSpec

packages/app/src/cli/models/extensions/specifications/transform/app_config_events.test.ts

@@ -0,0 +1,86 @@
+import {transformToEventsConfig, transformFromEventsConfig} from './app_config_events.js'
+import {describe, expect, test} from 'vitest'
+
+describe('transformFromEventsConfig', () => {
+  test('returns content as-is without transformation', () => {
+    const content = {
+      events: {
+        api_version: '2024-01',
+        subscription: [{topic: 'orders/create', uri: 'https://example.com', actions: ['create']}],
+      },
+    }
+
+    const result = transformFromEventsConfig(content)
+
+    expect(result).toEqual(content)
+  })
+})
+
+describe('transformToEventsConfig', () => {
+  test('strips server-managed identifier field from subscriptions while preserving all other fields', () => {
+    const remoteContent = {
+      events: {
+        api_version: '2024-01',
+        subscription: [
+          {
+            topic: 'orders/create',
+            uri: 'https://example.com/webhook',
+            actions: ['create'],
+            identifier: 'id-1',
+          },
+          {
+            topic: 'products/update',
+            uri: 'https://example.com/webhook',
+            actions: ['update'],
+            handle: 'my-subscription',
+            triggers: ['product_updated'],
+            query: 'query { id }',
+            query_filter: 'status:active',
+            identifier: 'id-2',
+          },
+        ],
+      },
+    }
+
+    const result = transformToEventsConfig(remoteContent)
+
+    expect(result).toEqual({
+      events: {
+        api_version: '2024-01',
+        subscription: [
+          {
+            topic: 'orders/create',
+            uri: 'https://example.com/webhook',
+            actions: ['create'],
+          },
+          {
+            topic: 'products/update',
+            uri: 'https://example.com/webhook',
+            actions: ['update'],
+            handle: 'my-subscription',
+            triggers: ['product_updated'],
+            query: 'query { id }',
+            query_filter: 'status:active',
+          },
+        ],
+      },
+    })
+  })
+
+  test('handles missing subscription field', () => {
+    const remoteContent = {
+      events: {
+        api_version: '2024-01',
+      },
+    }
+
+    const result = transformToEventsConfig(remoteContent)
+
+    expect(result).toEqual({
+      events: {
+        api_version: '2024-01',
+        subscription: undefined,
+      },
+    })
+  })
+})

packages/app/src/cli/models/extensions/specifications/transform/app_config_events.ts

@@ -0,0 +1,30 @@
+import {getPathValue} from '@shopify/cli-kit/common/object'
+
+/**
+ * Transforms the events config from local to remote format.
+ * No transformation needed - local config is already in the correct format for the server.
+ * The 'identifier' field is server-managed and should not exist in local configs.
+ */
+export function transformFromEventsConfig(content: object) {
+  return content
+}
+
+/**
+ * Transforms the events config from remote to local format.
+ * Strips the server-managed 'identifier' field from subscriptions.
+ */
+export function transformToEventsConfig(content: object) {
+  const eventsConfig = getPathValue(content, 'events') as {api_version: string; subscription: object[]}
+  const apiVersion = getPathValue(eventsConfig, 'api_version')
+  const subscription = getPathValue(eventsConfig, 'subscription') as {identifier: string}[]
+
+  // Server always includes identifier - strip it for local TOML
+  const cleanedSubscriptions = subscription?.map((sub) => {
+    const {identifier, ...rest} = sub
+    return rest
+  })
+
+  const events = apiVersion || cleanedSubscriptions ? {api_version: apiVersion, subscription: cleanedSubscriptions} : {}
+
+  return {events}
+}