fix: CPE loading changes from backend and not from workspace

.changeset/plenty-chairs-thank.md

@@ -0,0 +1,8 @@
+---
+"@sap-ux/adp-tooling": patch
+"@sap-ux/axios-extension": patch
+"@sap-ux-private/preview-middleware-client": patch
+"@sap-ux/preview-middleware": patch
+---
+
+CPE loading changes from backend and not from workspace

packages/adp-tooling/src/preview/adp-preview.ts

@@ -132,7 +132,7 @@ export class AdpPreview {
         }
         const buffer = zip.toBuffer();
 
-        this.mergedDescriptor = (await this.lrep.mergeAppDescriptorVariant(buffer))[this.descriptorVariantId];
+        this.mergedDescriptor = (await this.lrep.mergeAppDescriptorVariant(buffer, '//'))[this.descriptorVariantId];
     }
 
     /**

packages/adp-tooling/test/unit/preview/adp-preview.test.ts

@@ -126,7 +126,7 @@ describe('AdaptationProject', () => {
             .reply(200)
             .persist(true);
         nock(backend)
-            .put('/sap/bc/lrep/appdescr_variant_preview/')
+            .put('/sap/bc/lrep/appdescr_variant_preview/?workspacePath=//')
             .reply(200, {
                 'my.adaptation': mockMergedDescriptor
             })

packages/axios-extension/src/abap/lrep-service.ts

@@ -166,13 +166,24 @@ export class LayeredRepositoryService extends Axios implements Service {
      * Merge a given app descriptor variant with the stord app descriptor.
      *
      * @param appDescriptorVariant zip file containing an app descriptor variant
+     * @param workspacePath value for workspacePath URL parameter
      * @returns a promise with an object containing merged app descriptors with their id as keys.
      */
     public async mergeAppDescriptorVariant(
-        appDescriptorVariant: Buffer
+        appDescriptorVariant: Buffer,
+        workspacePath?: string
     ): Promise<{ [key: string]: MergedAppDescriptor }> {
+        const path = '/appdescr_variant_preview/';
+        const params = new URLSearchParams(this.defaults?.params);
+
+        if (workspacePath) {
+            params.append('workspacePath', workspacePath);
+        }
+
         try {
-            const response = await this.put('/appdescr_variant_preview/', appDescriptorVariant, {
+            const response = await this.put(path, appDescriptorVariant, {
+                paramsSerializer: (params) => decodeURIComponent(params.toString()),
+                params,
                 headers: {
                     'Content-Type': 'application/zip'
                 }

packages/axios-extension/test/abap/lrep-service.test.ts

@@ -6,7 +6,6 @@ import { LayeredRepositoryService, createForAbap } from '../../src';
 import type { AxiosError } from '../../src';
 import type { ToolsLogger } from '@sap-ux/logger';
 import * as Logger from '@sap-ux/logger';
-import { describe } from 'node:test';
 
 const loggerMock: ToolsLogger = {
     debug: jest.fn(),
@@ -264,14 +263,24 @@ describe('LayeredRepositoryService', () => {
     });
 
     describe('mergeAppDescriptorVariant', () => {
-        const mockResult = { hello: 'world' };
         test('merge valid app variant', async () => {
+            const mockResult = { hello: 'world', components: [{ url: '/webapp' }] };
             nock(server).put(`${LayeredRepositoryService.PATH}/appdescr_variant_preview/`).reply(200, mockResult);
 
             const mergedDescriptor = await service.mergeAppDescriptorVariant(Buffer.from('~test'));
             expect(mergedDescriptor).toEqual(mockResult);
         });
 
+        test('merge valid app variant with adjusted workspace path', async () => {
+            const mockResult = { hello: 'world', components: [{ url: '/' }] };
+            nock(server)
+                .put(`${LayeredRepositoryService.PATH}/appdescr_variant_preview/?workspacePath=//`)
+                .reply(200, mockResult);
+
+            const mergedDescriptor = await service.mergeAppDescriptorVariant(Buffer.from('~test'), '//');
+            expect(mergedDescriptor).toEqual(mockResult);
+        });
+
         test('error is thrown', async () => {
             nock(server).put(`${LayeredRepositoryService.PATH}/appdescr_variant_preview/`).reply(500);
             try {

packages/preview-middleware-client/src/flp/bootstrap.js

@@ -15,10 +15,16 @@ async function ushellBootstrap(fnCallback) {
         const response = await fetch(`${basePath}/resources/sap-ui-version.json`);
         const json = await response.json();
         const version = json?.libraries?.find((lib) => lib.name === 'sap.ui.core')?.version ?? '1.121.0';
-        const majorUi5Version = parseInt(version.split('.')[0], 10);
+        const [major, minor] = version.split('.');
+        const majorUi5Version = parseInt(major, 10);
+        const minorUi5Version = parseInt(minor, 10);
         if (majorUi5Version >= 2) {
             src = `${basePath}/resources/sap/ushell/bootstrap/sandbox2.js`;
         }
+
+        if (majorUi5Version === 1 && minorUi5Version < 72) {
+            removeAsyncHintsRequests();
+        }
     } catch (error) {
         console.warn('Failed to fetch sap-ui-version.json. Assuming it is a 1.x version.');
     }
@@ -33,6 +39,38 @@ async function ushellBootstrap(fnCallback) {
     }
 }
 
+/**
+ * For UI5 version 1.71 and below, we need to remove the asyncHints.requests
+ * to load the changes in an Adaptation project.
+ * This logic needs to be executed here to have a reliable check for
+ * UI5 version and remove the asyncHints.requests before the sandbox is loaded.
+ * The sandbox shell modifies the `window['sap-ushell-config']`.
+ */
+function removeAsyncHintsRequests() {
+    const obj = window['sap-ushell-config']['applications'];
+
+    if (!obj || typeof obj !== 'object') return;
+
+    const stack = [obj];
+
+    while (stack.length > 0) {
+        const current = stack.pop();
+
+        if (current.asyncHints) {
+            if (current.asyncHints.requests) {
+                current.asyncHints.requests = [];
+            }
+            return;
+        }
+
+        for (const key in current) {
+            if (typeof current[key] === 'object' && current[key] !== null) {
+                stack.push(current[key]);
+            }
+        }
+    }
+}
+
 // eslint-disable-next-line fiori-custom/sap-no-global-define
 window['sap-ui-config'] = {
     'xx-bootTask': ushellBootstrap

packages/preview-middleware/src/base/config.ts

@@ -7,6 +7,7 @@ import { readFileSync } from 'fs';
 import { mergeTestConfigDefaults } from './test';
 import { type Editor, create } from 'mem-fs-editor';
 import { create as createStorage } from 'mem-fs';
+import type { MergedAppDescriptor } from '@sap-ux/axios-extension';
 
 export interface CustomConnector {
     applyConnector: string;
@@ -33,7 +34,7 @@ export interface TemplateConfig {
             additionalInformation: string;
             applicationType: 'URL';
             url: string;
-            applicationDependencies?: { manifest: boolean };
+            applicationDependencies?: MergedAppDescriptor;
         }
     >;
     ui5: {
@@ -204,22 +205,34 @@ function getFlexSettings(): TemplateConfig['ui5']['flex'] {
  * @param manifest manifest of the additional target app
  * @param app configuration for the preview
  * @param logger logger instance
+ * @param descriptor descriptor of the additional target app
  */
-export async function addApp(templateConfig: TemplateConfig, manifest: Partial<Manifest>, app: App, logger: Logger) {
+export async function addApp(
+    templateConfig: TemplateConfig,
+    manifest: Partial<Manifest>,
+    app: App,
+    logger: Logger,
+    descriptor?: MergedAppDescriptor
+) {
     const id = manifest['sap.app']?.id ?? '';
+
     app.intent ??= {
         object: id.replace(/\./g, ''),
         action: 'preview'
     };
+
+    const appName = `${app.intent?.object}-${app.intent?.action}`;
     templateConfig.ui5.resources[id] = app.target;
-    templateConfig.apps[`${app.intent?.object}-${app.intent?.action}`] = {
+    templateConfig.apps[appName] = {
         title: (await getI18nTextFromProperty(app.local, manifest['sap.app']?.title, logger)) ?? id,
         description: (await getI18nTextFromProperty(app.local, manifest['sap.app']?.description, logger)) ?? '',
         additionalInformation: `SAPUI5.Component=${app.componentId ?? id}`,
         applicationType: 'URL',
-        url: app.target,
-        applicationDependencies: { manifest: true }
+        url: app.target
     };
+    if (descriptor) {
+        templateConfig.apps[appName].applicationDependencies = descriptor;
+    }
 }
 
 /**

packages/preview-middleware/src/base/flp.ts

@@ -18,6 +18,7 @@ import {
     type OperationType
 } from '@sap-ux/adp-tooling';
 import { isAppStudio, exposePort } from '@sap-ux/btp-utils';
+import type { MergedAppDescriptor } from '@sap-ux/axios-extension';
 
 import { deleteChange, readChanges, writeChange } from './flex';
 import { generateImportList, mergeTestConfigDefaults } from './test';
@@ -104,8 +105,14 @@ export class FlpSandbox {
      * @param manifest application manifest
      * @param componentId optional componentId e.g. for adaptation projects
      * @param resources optional additional resource mappings
+     * @param descriptor optional additional descriptor mappings
      */
-    async init(manifest: Manifest, componentId?: string, resources: Record<string, string> = {}): Promise<void> {
+    async init(
+        manifest: Manifest,
+        componentId?: string,
+        resources: Record<string, string> = {},
+        descriptor?: MergedAppDescriptor
+    ): Promise<void> {
         this.createFlexHandler();
         this.config.libs ??= await this.hasLocateReuseLibsScript();
         const id = manifest['sap.app'].id;
@@ -120,7 +127,8 @@ export class FlpSandbox {
                 local: '.',
                 intent: this.config.intent
             },
-            this.logger
+            this.logger,
+            descriptor
         );
         this.addStandardRoutes();
         if (this.rta) {
@@ -531,10 +539,8 @@ export async function initAdp(
         }
 
         const descriptor = adp.descriptor;
-        descriptor.asyncHints.requests = [];
         const { name, manifest } = descriptor;
-
-        await flp.init(manifest, name, adp.resources);
+        await flp.init(manifest, name, adp.resources, descriptor);
         flp.router.use(adp.descriptor.url, adp.proxy.bind(adp) as RequestHandler);
         flp.addOnChangeRequestHandler(adp.onChangeRequest.bind(adp));
         flp.router.use(json());

packages/preview-middleware/test/unit/base/__snapshots__/config.test.ts.snap

@@ -112,7 +112,7 @@ exports[`config generatePreviewFiles minimum settings 1`] = `
                     }
                 }
             },
-            applications:  {\\"app-preview\\":{\\"title\\":\\"My Simple App\\",\\"description\\":\\"This is a very simple application.\\",\\"additionalInformation\\":\\"SAPUI5.Component=test.fe.v2.app\\",\\"applicationType\\":\\"URL\\",\\"url\\":\\"..\\",\\"applicationDependencies\\":{\\"manifest\\":true}}}
+            applications:  {\\"app-preview\\":{\\"title\\":\\"My Simple App\\",\\"description\\":\\"This is a very simple application.\\",\\"additionalInformation\\":\\"SAPUI5.Component=test.fe.v2.app\\",\\"applicationType\\":\\"URL\\",\\"url\\":\\"..\\"}}
         };
     </script>
 
@@ -190,7 +190,7 @@ Object {
                     }
                 }
             },
-            applications:  {\\"simpleApp-preview\\":{\\"title\\":\\"My Simple App\\",\\"description\\":\\"This is a very simple application.\\",\\"additionalInformation\\":\\"SAPUI5.Component=test.fe.v2.app\\",\\"applicationType\\":\\"URL\\",\\"url\\":\\"/apps/simple-app\\",\\"applicationDependencies\\":{\\"manifest\\":true}},\\"testfev2other-preview\\":{\\"title\\":\\"My Other App\\",\\"description\\":\\"This is a very simple application.\\",\\"additionalInformation\\":\\"SAPUI5.Component=test.fe.v2.other\\",\\"applicationType\\":\\"URL\\",\\"url\\":\\"/apps/other-app\\",\\"applicationDependencies\\":{\\"manifest\\":true}}}
+            applications:  {\\"simpleApp-preview\\":{\\"title\\":\\"My Simple App\\",\\"description\\":\\"This is a very simple application.\\",\\"additionalInformation\\":\\"SAPUI5.Component=test.fe.v2.app\\",\\"applicationType\\":\\"URL\\",\\"url\\":\\"/apps/simple-app\\"},\\"testfev2other-preview\\":{\\"title\\":\\"My Other App\\",\\"description\\":\\"This is a very simple application.\\",\\"additionalInformation\\":\\"SAPUI5.Component=test.fe.v2.other\\",\\"applicationType\\":\\"URL\\",\\"url\\":\\"/apps/other-app\\"}}
         };
     </script>
 
@@ -271,7 +271,7 @@ Object {
                     }
                 }
             },
-            applications:  {\\"myapp-myaction\\":{\\"title\\":\\"My Simple App\\",\\"description\\":\\"This is a very simple application.\\",\\"additionalInformation\\":\\"SAPUI5.Component=test.fe.v2.app\\",\\"applicationType\\":\\"URL\\",\\"url\\":\\"..\\",\\"applicationDependencies\\":{\\"manifest\\":true}}}
+            applications:  {\\"myapp-myaction\\":{\\"title\\":\\"My Simple App\\",\\"description\\":\\"This is a very simple application.\\",\\"additionalInformation\\":\\"SAPUI5.Component=test.fe.v2.app\\",\\"applicationType\\":\\"URL\\",\\"url\\":\\"..\\"}}
         };
     </script>