fix(remoteitems): fix direct request of remote items (#192)

* fix(remoteitems): fix direct request of remote items  (#192)

When requesting Remote items directly (opposed to indirectly as reference of another requested local
item), those remote items were not correctly handled. This led to empty responses, even though the
item itself was correctly fetched and put

---------

Co-authored-by: Emre Neumann <[email protected]>

Author: neo-reply-lukas

integrationtests/FSXAProxyApi.test.ts

@@ -5,6 +5,7 @@ import {
   FSXAContentMode,
   FSXAProxyApi,
   LogLevel,
+  Image,
   Page,
   QueryBuilderQuery,
   Reference,
@@ -488,6 +489,24 @@ describe('FSXAProxyAPI', () => {
         remotePageRefReference.value?.remoteProject
       )
     })
+    it('api returns remote element if directly requested', async function () {
+      const remoteMedia = createMediaPicture(undefined, "de_DE")
+      
+      await caasClient.addDocToCollection({
+        ...remoteMedia,
+        locale: {
+          identifier: 'de',
+          country: 'DE',
+          language: 'de',
+        },
+      })
+      const res: Image = await proxyAPI.fetchElement({
+        id: remoteMedia.identifier,
+        locale: 'de_DE',
+      })
+      expect(res).toBeDefined
+      expect(res.id).toBe(remoteMedia.identifier)
+    })
   })
 
   describe('fetchByFilter', () => {

src/modules/CaaSMapper.ts

@@ -1036,7 +1036,7 @@ export class CaaSMapper {
 
     // find resolved refs and puzzle them back together
     const mappedItems = findResolvedReferencesByIds(
-      items.map((item) => getItemId(item)),
+      items.map((item) => getItemId(item, remoteProjectId)),
       this.resolvedReferences
     )
 

src/modules/FSXAProxyApi.spec.ts

@@ -13,7 +13,7 @@ describe('FSXAProxyAPI', () => {
   beforeEach(() => {
     fetchMock.resetMocks()
     id = Faker.datatype.uuid()
-    locale = Faker.locale
+    locale = `${Faker.locale}_${Faker.locale.toUpperCase()}`
   })
   describe('The initialization', () => {
     it('should throw an error if the BASEURL is empty', () => {

src/modules/FSXAProxyApi.ts

@@ -148,7 +148,8 @@ export class FSXAProxyApi implements FSXAApi {
     mappedItems = denormalizeResolvedReferences(
       mappedItems,
       referenceMap,
-      resolvedReferences
+      resolvedReferences,
+      remoteProject
     )
 
     return mappedItems[0] as unknown as T
@@ -251,7 +252,8 @@ export class FSXAProxyApi implements FSXAApi {
     items = denormalizeResolvedReferences(
       items as (CaasApi_Item | MappedCaasItem)[],
       referenceMap!,
-      resolvedReferences!
+      resolvedReferences!,
+      remoteProject
     )
 
     return { page, pagesize, totalPages, size, items } as FetchResponse

src/modules/FSXARemoteApi.spec.ts

@@ -10,7 +10,12 @@ import {
 import { generateRandomConfig } from '../testutils/generateRandomConfig'
 
 import 'jest-fetch-mock'
-import { createDataEntry } from '../testutils'
+import {
+  createDataEntry,
+  createMediaPicture,
+  createMediaPictureReference,
+} from '../testutils'
+import { getMappedMediaPicture } from '../testutils/getMappedMediaPicture'
 require('jest-fetch-mock').enableFetchMocks()
 
 describe('FSXARemoteAPI', () => {
@@ -556,7 +561,7 @@ describe('FSXARemoteAPI', () => {
   })
   describe('fetchByFilter', () => {
     let remoteApi: FSXARemoteApi
-    let config: any
+    let config: ReturnType<typeof generateRandomConfig>
     let filters: QueryBuilderQuery[]
     let filterValue: string
     let filterField: string
@@ -765,6 +770,55 @@ describe('FSXARemoteAPI', () => {
         items,
       })
     })
+    it('should return items when fetching remote items', async () => {
+      const mainMedia = createMediaPicture(
+        undefined,
+        config.remotes.remote.locale
+      )
+      const referencedMedia = createMediaPicture(
+        undefined,
+        config.remotes.remote.locale
+      )
+
+      mainMedia.metaFormData.fsRef = createMediaPictureReference(
+        referencedMedia._id
+      )
+
+      const firstResponse = { _embedded: { 'rh:doc': [mainMedia] } }
+      const secondResponse = { _embedded: { 'rh:doc': [referencedMedia] } }
+
+      fetchMock
+        .mockResponseOnce(JSON.stringify(firstResponse))
+        .mockResponseOnce(JSON.stringify(secondResponse))
+
+      const actualRequest = await remoteApi.fetchByFilter({
+        filters,
+        locale: 'de_DE',
+        remoteProject: config.remotes.remote.id,
+      })
+
+      const mappedMainMedia = getMappedMediaPicture(
+        mainMedia,
+        config.remotes.remote.locale,
+        config.remotes.remote.id
+      )
+      const mappedReferencedMedia = getMappedMediaPicture(
+        referencedMedia,
+        config.remotes.remote.locale,
+        config.remotes.remote.id
+      )
+
+      mappedMainMedia.meta.fsRef = mappedReferencedMedia
+
+      expect(actualRequest).toBeDefined()
+      expect(actualRequest).toStrictEqual({
+        page: 1,
+        pagesize: 30,
+        size: undefined,
+        totalPages: undefined,
+        items: [mappedMainMedia],
+      })
+    })
   })
   describe('fetchNavigation', () => {
     let remoteApi: FSXARemoteApi

src/modules/FSXARemoteApi.ts

@@ -460,6 +460,11 @@ export class FSXARemoteApi implements FSXAApi {
       remoteProject && this.remotes
         ? this.remotes[remoteProject]?.locale
         : locale
+
+    const remoteProjectId = remoteProject
+      ? this.remotes[remoteProject]?.id
+      : undefined
+
     const {
       items,
       referenceMap = {},
@@ -473,7 +478,7 @@ export class FSXARemoteApi implements FSXAApi {
         },
       ],
       additionalParams,
-      remoteProject,
+      remoteProject: remoteProjectId,
       fetchOptions,
       filterContext,
       normalized: true,
@@ -489,7 +494,8 @@ export class FSXARemoteApi implements FSXAApi {
       : denormalizeResolvedReferences(
           items as (MappedCaasItem | CaasApi_Item)[],
           referenceMap,
-          resolvedReferences
+          resolvedReferences,
+          remoteProjectId
         )[0]
   }
 
@@ -661,7 +667,8 @@ export class FSXARemoteApi implements FSXAApi {
         : denormalizeResolvedReferences(
             mappedItems,
             referenceMap,
-            resolvedReferences
+            resolvedReferences,
+            remoteProjectId
           ),
       ...(normalized && { referenceMap }),
       ...(normalized && { resolvedReferences }),

src/modules/MappingUtils.ts

@@ -72,7 +72,8 @@ const imageMapForceResolution = ({
 const denormalizeResolvedReferences = (
   mappedItems: (CaasApi_Item | MappedCaasItem)[],
   referenceMap: ReferencedItemsInfo,
-  resolvedReferences: ResolvedReferencesInfo
+  resolvedReferences: ResolvedReferencesInfo,
+  remoteProjectId?: string
 ) => {
   if (!referenceMap || Object.keys(referenceMap).length === 0)
     return mappedItems
@@ -104,7 +105,7 @@ const denormalizeResolvedReferences = (
   // update mappedItems
   const queriedIds = mappedItems
     .filter((item) => !!item)
-    .map((item) => getItemId(item))
+    .map((item) => getItemId(item, remoteProjectId))
 
   return findResolvedReferencesByIds(queriedIds, resolvedReferences)
 }

src/testutils/generateRandomConfig.ts

@@ -12,8 +12,14 @@ export const generateRandomConfig = () => {
     ? FSXAContentMode.PREVIEW
     : FSXAContentMode.RELEASE
   const REMOTES = {
-    remote: { id: Faker.datatype.uuid(), locale: Faker.locale },
-    secondRemote: { id: Faker.datatype.uuid(), locale: Faker.locale },
+    remote: {
+      id: Faker.datatype.uuid(),
+      locale: `${Faker.locale}_${Faker.locale.toUpperCase()}`,
+    },
+    secondRemote: {
+      id: Faker.datatype.uuid(),
+      locale: `${Faker.locale}_${Faker.locale.toUpperCase()}`,
+    },
   }
 
   return {

src/testutils/getMappedMediaPicture.ts

@@ -0,0 +1,15 @@
+import { CaaSApi_Media_Picture, Image } from '../types'
+
+export const getMappedMediaPicture = (
+  caasMedia: CaaSApi_Media_Picture,
+  locale: string,
+  remoteProjectId?: string
+): Image => ({
+  type: "Image",
+  id: caasMedia.identifier,
+  previewId: `${caasMedia.identifier}.${locale}`,
+  meta: {},
+  description: caasMedia.description,
+  resolutions: {},
+  remoteProjectId
+})