enrich Memora store dropdown with displayName via individual store detail calls

Author: varadarajan-tw

packages/destination-actions/src/destinations/memora/upsertProfile/__tests__/index.test.ts

@@ -653,7 +653,7 @@ describe('Memora.upsertProfile', () => {
 
   describe('dynamicFields', () => {
     describe('memora_store', () => {
-      it('should fetch and return memory stores from Control Plane', async () => {
+      it('should fetch and return memory stores with details from Control Plane', async () => {
         nock(BASE_URL)
           .get(`/${API_VERSION}/ControlPlane/Stores?pageSize=100&orderBy=ASC`)
           .matchHeader('X-Pre-Auth-Context', 'AC1234567890')
@@ -665,18 +665,71 @@ describe('Memora.upsertProfile', () => {
             }
           })
 
+        nock(BASE_URL)
+          .get(`/${API_VERSION}/ControlPlane/Stores/store-1`)
+          .matchHeader('X-Pre-Auth-Context', 'AC1234567890')
+          .reply(200, { id: 'store-1', displayName: 'Store One' })
+
+        nock(BASE_URL)
+          .get(`/${API_VERSION}/ControlPlane/Stores/store-2`)
+          .matchHeader('X-Pre-Auth-Context', 'AC1234567890')
+          .reply(200, { id: 'store-2', displayName: 'Store Two' })
+
+        nock(BASE_URL)
+          .get(`/${API_VERSION}/ControlPlane/Stores/store-3`)
+          .matchHeader('X-Pre-Auth-Context', 'AC1234567890')
+          .reply(200, { id: 'store-3', displayName: 'Store Three' })
+
         const result = (await testDestination.testDynamicField('upsertProfile', 'memora_store', {
           settings: defaultSettings,
           payload: {}
         })) as any
 
         expect(result?.choices).toEqual([
-          { label: 'store-1', value: 'store-1' },
-          { label: 'store-2', value: 'store-2' },
-          { label: 'store-3', value: 'store-3' }
+          { label: 'Store One', value: 'store-1' },
+          { label: 'Store Two', value: 'store-2' },
+          { label: 'Store Three', value: 'store-3' }
         ])
       })
 
+      it('should fall back to store id when displayName is empty', async () => {
+        nock(BASE_URL)
+          .get(`/${API_VERSION}/ControlPlane/Stores?pageSize=100&orderBy=ASC`)
+          .reply(200, { stores: ['store-no-name'] })
+
+        nock(BASE_URL)
+          .get(`/${API_VERSION}/ControlPlane/Stores/store-no-name`)
+          .reply(200, { id: 'store-no-name', displayName: '' })
+
+        const result = (await testDestination.testDynamicField('upsertProfile', 'memora_store', {
+          settings: defaultSettings,
+          payload: {}
+        })) as any
+
+        expect(result?.choices).toEqual([{ label: 'store-no-name', value: 'store-no-name' }])
+      })
+
+      it('should not include X-Pre-Auth-Context header in store detail requests when twilioAccount is not set', async () => {
+        const settingsNoTwilio = { username: 'test-api-key', password: 'test-api-secret' }
+
+        nock(BASE_URL)
+          .get(`/${API_VERSION}/ControlPlane/Stores?pageSize=100&orderBy=ASC`)
+          .matchHeader('X-Pre-Auth-Context', (val) => val === undefined)
+          .reply(200, { stores: ['store-1'] })
+
+        nock(BASE_URL)
+          .get(`/${API_VERSION}/ControlPlane/Stores/store-1`)
+          .matchHeader('X-Pre-Auth-Context', (val) => val === undefined)
+          .reply(200, { id: 'store-1', displayName: 'Store One' })
+
+        const result = (await testDestination.testDynamicField('upsertProfile', 'memora_store', {
+          settings: settingsNoTwilio,
+          payload: {}
+        })) as any
+
+        expect(result?.choices).toEqual([{ label: 'Store One', value: 'store-1' }])
+      })
+
       it('should handle empty stores list', async () => {
         nock(BASE_URL)
           .get(`/${API_VERSION}/ControlPlane/Stores?pageSize=100&orderBy=ASC`)
@@ -693,6 +746,26 @@ describe('Memora.upsertProfile', () => {
         expect(result?.choices).toEqual([])
       })
 
+      it('should return error when a store detail request fails', async () => {
+        nock(BASE_URL)
+          .get(`/${API_VERSION}/ControlPlane/Stores?pageSize=100&orderBy=ASC`)
+          .reply(200, { stores: ['store-1'] })
+
+        nock(BASE_URL)
+          .get(`/${API_VERSION}/ControlPlane/Stores/store-1`)
+          .reply(500, { message: 'Internal server error' })
+
+        const result = (await testDestination.testDynamicField('upsertProfile', 'memora_store', {
+          settings: defaultSettings,
+          payload: {}
+        })) as any
+
+        expect(result?.choices).toEqual([])
+        expect(result?.error).toBeDefined()
+        expect(result?.error?.message).toContain('Unable to fetch memora stores')
+        expect(result?.error?.code).toBe('FETCH_ERROR')
+      })
+
       it('should return error message when API call fails', async () => {
         nock(BASE_URL)
           .get(`/${API_VERSION}/ControlPlane/Stores?pageSize=100&orderBy=ASC`)
@@ -706,6 +779,7 @@ describe('Memora.upsertProfile', () => {
         expect(result?.choices).toEqual([])
         expect(result?.error).toBeDefined()
         expect(result?.error?.message).toContain('Unable to fetch memora stores')
+        expect(result?.error?.message).toContain('Enter the memora store ID manually.')
         expect(result?.error?.code).toBe('FETCH_ERROR')
       })
     })

packages/destination-actions/src/destinations/memora/upsertProfile/index.ts

@@ -305,6 +305,11 @@ interface MemoraStoresResponse {
   }
 }
 
+interface MemoraStoreDetails {
+  displayName: string
+  id: string
+}
+
 interface TraitDefinition {
   dataType: string
   description?: string
@@ -378,9 +383,26 @@ async function fetchMemoraStores(request: RequestClient, settings: Settings) {
 
     const stores = response?.data?.stores || []
 
-    const choices = stores.map((storeId: string) => ({
-      label: storeId,
-      value: storeId
+    // This is not the most efficient way to get store details, but the Control Plane API does not currently provide an endpoint to list stores with their details in a single call.
+    // We need to make individual calls to get store details in order to display more information in the dropdown (e.g. store name).
+    // Fortunately, most accounts will have a small number of stores (max 5), so this should not be a major performance issue. If we find that this is causing performance problems, we can consider caching store details or adding an endpoint to the Control Plane API to list stores with their details.
+    const memoraStores = await Promise.all(
+      stores.map((storeId: string) => {
+        return request<MemoraStoreDetails>(`${BASE_URL}/${API_VERSION}/ControlPlane/Stores/${storeId}`, {
+          method: 'GET',
+          headers: {
+            ...(settings.twilioAccount && { 'X-Pre-Auth-Context': settings.twilioAccount })
+          },
+          username: settings.username,
+          password: settings.password,
+          skipResponseCloning: true
+        })
+      })
+    )
+
+    const choices = memoraStores.map((store) => ({
+      label: store.data?.displayName || store.data?.id,
+      value: store.data?.id
     }))
 
     return {
@@ -391,7 +413,7 @@ async function fetchMemoraStores(request: RequestClient, settings: Settings) {
     return {
       choices: [],
       error: {
-        message: 'Unable to fetch memora stores. You can still manually enter a memora store ID.',
+        message: 'Unable to fetch memora stores. Enter the memora store ID manually.',
         code: 'FETCH_ERROR'
       }
     }