Preview support for UI5 2.x (#2192)

* dynamic ushell src * require sap ushell * review comments * Create preview-2.0.md * add window type * eslint * fix: eslint * fix: eslint, review comments * fix: run-time error with bootstrap * fix: move call of initConnectors * unit test for bootstrap * fix: sap.ui.define wrapper * cleanup of container type * obsolete code * added error handling if version info is not found * reverting change in ui5-proxy * eslint fixes * fix erroneous usage of sap-ui-version.json * refactoring of VersionInfo.load() usage --------- Co-authored-by: Tobias Queck <[email protected]> Co-authored-by: D048415 <[email protected]> Co-authored-by: Klaus Keller <[email protected]> Co-authored-by: Dominik Heim <[email protected]>
SAP · Jul 31, 2024 · ab2e5a0 · ab2e5a0
1 parent 13d5ee5
commit ab2e5a0
Show file tree

Hide file tree

Showing 23 changed files with 232 additions and 113 deletions.
diff --git a/.changeset/preview-2.0.md b/.changeset/preview-2.0.md
@@ -0,0 +1,6 @@
+---
+"@sap-ux-private/preview-middleware-client": patch
+"@sap-ux/preview-middleware": patch
+---
+
+Preview support for UI5 2.x 
diff --git a/packages/preview-middleware-client/src/adp/init.ts b/packages/preview-middleware-client/src/adp/init.ts
@@ -14,9 +14,10 @@ import VersionInfo from 'sap/ui/VersionInfo';
 import { getUI5VersionValidationMessage } from './ui5-version-utils';
 import UI5Element from 'sap/ui/dt/Element';
 import { getError } from '../cpe/error-utils';
+import type {SingleVersionInfo} from '../../types/global';
 
 export default async function (rta: RuntimeAuthoring) {
-    const { version } = (await VersionInfo.load()) as { version: string };
+    const version = (await VersionInfo.load({library:'sap.ui.core'}) as SingleVersionInfo)?.version;
     const versionParts = version.split('.');
     const minor = parseInt(versionParts[1], 10);
     const flexSettings = rta.getFlexSettings();

diff --git a/packages/preview-middleware-client/src/cpe/connector-service.ts b/packages/preview-middleware-client/src/cpe/connector-service.ts
@@ -1,6 +1,7 @@
 import { ExternalAction, storageFileChanged } from '@sap-ux-private/control-property-editor-common';
 import { ActionSenderFunction } from './types';
 import VersionInfo from 'sap/ui/VersionInfo';
+import type {SingleVersionInfo} from '../../types/global';
 
 /**
  * A Class of WorkspaceConnectorService
@@ -12,7 +13,7 @@ export class WorkspaceConnectorService {
      * @param sendAction action sender function
      */
     public async init(sendAction: ActionSenderFunction): Promise<void> {
-        const { version } = (await VersionInfo.load()) as { version: string };
+        const version = (await VersionInfo.load({library:'sap.ui.core'}) as SingleVersionInfo)?.version;
         const versionParts = version.split('.');
         const minor = parseInt(versionParts[1], 10);
         if (minor > 72) {

diff --git a/packages/preview-middleware-client/src/cpe/outline/nodes.ts b/packages/preview-middleware-client/src/cpe/outline/nodes.ts
@@ -3,6 +3,7 @@ import type { OutlineViewNode } from 'sap/ui/rta/command/OutlineService';
 import type { Scenario } from 'sap/ui/fl/Scenario';
 import { isEditable, isReuseComponent } from './utils';
 import VersionInfo from 'sap/ui/VersionInfo';
+import type {SingleVersionInfo} from '../../../types/global';
 
 interface AdditionalData {
     text?: string;
@@ -87,7 +88,7 @@ export async function transformNodes(
 ): Promise<OutlineNode[]> {
     const stack = [...input];
     const items: OutlineNode[] = [];
-    const { version } = (await VersionInfo.load()) as { version: string };
+    const version = (await VersionInfo.load({library:'sap.ui.core'}) as SingleVersionInfo)?.version;
     const versionParts = version.split('.');
     const minor = parseInt(versionParts[1], 10);
     while (stack.length) {

diff --git a/packages/preview-middleware-client/src/flp/WorkspaceConnector.ts b/packages/preview-middleware-client/src/flp/WorkspaceConnector.ts
@@ -2,6 +2,7 @@ import merge from 'sap/base/util/merge';
 import ObjectStorageConnector from 'sap/ui/fl/write/api/connectors/ObjectStorageConnector';
 import Layer from 'sap/ui/fl/Layer';
 import VersionInfo from 'sap/ui/VersionInfo';
+import type {SingleVersionInfo} from '../../types/global';
 import { CHANGES_API_PATH, FlexChange, getFlexSettings } from './common';
 
 const connector = merge({}, ObjectStorageConnector, {
@@ -69,8 +70,8 @@ const connector = merge({}, ObjectStorageConnector, {
     loadFeatures: async function () {
         const features = await ObjectStorageConnector.loadFeatures();
 
-        const ui5Version = (await VersionInfo.load()) as { version: string };
-        const [majorVersion, minorVersion] = ui5Version.version.split('.').map((v: string) => parseInt(v, 10));
+        const version = (await VersionInfo.load({library:'sap.ui.core'}) as SingleVersionInfo)?.version;
+        const [majorVersion, minorVersion] = version.split('.').map((v: string) => parseInt(v, 10));
         features.isVariantAdaptationEnabled = majorVersion >= 1 && minorVersion >= 90;
         const settings = getFlexSettings();
         if (settings?.developerMode) {

diff --git a/packages/preview-middleware-client/src/flp/bootstrap.js b/packages/preview-middleware-client/src/flp/bootstrap.js
@@ -0,0 +1,38 @@
+/* eslint-disable @typescript-eslint/no-unsafe-assignment,
+                  @typescript-eslint/no-unsafe-member-access,
+                  @typescript-eslint/no-unsafe-assignment,
+                  @typescript-eslint/no-unsafe-argument,
+                  no-console */
+
+/**
+ * Calculates the script content for accessing the right sap/ushell/bootstrap sandbox.
+ * @param fnCallback {Function} The callback function to be executed after the bootstrap is loaded.
+ */
+async function ushellBootstrap(fnCallback) {
+    let src = '/test-resources/sap/ushell/bootstrap/sandbox.js';
+    try {
+        const response = await fetch('/resources/sap-ui-version.json');
+        const json = await response.json();
+        const version = json?.libraries?.find((lib) => lib.name === 'sap.ui.core')?.version;
+        const major = version ? parseInt(version.split('.')[0], 10) : 2;
+        if (major >= 2) {
+            src = '/resources/sap/ushell/bootstrap/sandbox2.js';
+        }
+    } catch (error) {
+        console.warn('Failed to fetch sap-ui-version.json. Assuming it is a 1.x version.');
+    }
+
+    // eslint-disable-next-line fiori-custom/sap-no-dom-access,fiori-custom/sap-browser-api-warning
+    const shellBootstrap = document.getElementById('sap-ushell-bootstrap');
+    if (shellBootstrap) {
+        shellBootstrap.onload = () => {
+            window['sap-ui-config']['xx-bootTask'](fnCallback);
+        };
+        shellBootstrap.setAttribute('src', src);
+    }
+}
+
+// eslint-disable-next-line fiori-custom/sap-no-global-define
+window['sap-ui-config'] = {
+    'xx-bootTask': ushellBootstrap
+};
diff --git a/packages/preview-middleware-client/src/flp/init.ts b/packages/preview-middleware-client/src/flp/init.ts
@@ -7,6 +7,10 @@ import IconPool from 'sap/ui/core/IconPool';
 import ResourceBundle from 'sap/base/i18n/ResourceBundle';
 import AppState from 'sap/ushell/services/AppState';
 import { getManifestAppdescr } from '../adp/api-handler';
+import VersionInfo from 'sap/ui/VersionInfo';
+import { getError } from '../cpe/error-utils';
+import initConnectors from './initConnectors';
+import type {SingleVersionInfo} from '../../types/global';
 
 /**
  * SAPUI5 delivered namespaces from https://ui5.sap.com/#/api/sap
@@ -264,16 +268,16 @@ export async function init({
     customInit?: string | null;
 }): Promise<void> {
     const urlParams = new URLSearchParams(window.location.search);
-    const container = sap?.ushell?.Container ?? (sap.ui.require('sap/ushell/Container') as typeof sap.ushell.Container);
+    const container = sap?.ushell?.Container ?? sap.ui.require('sap/ushell/Container');
     let scenario: string = '';
+    const version = (await VersionInfo.load({library:'sap.ui.core'}) as SingleVersionInfo)?.version;
     // Register RTA if configured
     if (flex) {
         const flexSettings = JSON.parse(flex) as FlexSettings;
         scenario = flexSettings.scenario;
         container.attachRendererCreatedEvent(async function () {
             const lifecycleService = await container.getServiceAsync<AppLifeCycle>('AppLifeCycle');
             lifecycleService.attachAppLoaded((event) => {
-                const version = sap.ui.version;
                 const minor = parseInt(version.split('.')[1], 10);
                 const view = event.getParameter('componentInstance');
                 const flexSettings = JSON.parse(flex) as FlexSettings;
@@ -317,6 +321,9 @@ export async function init({
         await registerComponentDependencyPaths(JSON.parse(appUrls), urlParams);
     }
 
+    // Load rta connector
+    await initConnectors();
+
     // Load custom initialization module
     if (customInit) {
         sap.ui.require([customInit]);
@@ -326,15 +333,22 @@ export async function init({
     const resourceBundle = await loadI18nResourceBundle(scenario as Scenario);
     setI18nTitle(resourceBundle);
     registerSAPFonts();
-    const renderer = await container.createRenderer(undefined, true);
+    const major = version ? parseInt(version.split('.')[0], 10) : 2;
+
+    const renderer =
+        major < 2
+            ? await container.createRenderer(undefined, true)
+            : await container.createRendererInternal(undefined, true);
     renderer.placeAt('content');
 }
-
 const bootstrapConfig = document.getElementById('sap-ui-bootstrap');
 if (bootstrapConfig) {
     init({
         appUrls: bootstrapConfig.getAttribute('data-open-ux-preview-libs-manifests'),
         flex: bootstrapConfig.getAttribute('data-open-ux-preview-flex-settings'),
         customInit: bootstrapConfig.getAttribute('data-open-ux-preview-customInit')
-    }).catch(() => Log.error('Sandbox initialization failed.'));
+    }).catch((e) => {
+        const error = getError(e);
+        Log.error('Sandbox initialization failed: ' + error.message);
+    });
 }
diff --git a/packages/preview-middleware-client/src/flp/initConnectors.ts b/packages/preview-middleware-client/src/flp/initConnectors.ts
@@ -1,3 +1,6 @@
+import VersionInfo from 'sap/ui/VersionInfo';
+import type {SingleVersionInfo} from '../../types/global';
+
 /**
  * Initializes UI5 connectors based on the current UI5 version.
  *
@@ -7,13 +10,14 @@
  *
  * @example
  * intiConnectors(); // Simply call the function without any arguments.
- * @returns {void}
  */
-export function initConnectors(): void {
-    const version = sap.ui.version;
-    const minor = parseInt(version.split('.')[1], 10);
+export default async function initConnectors(): Promise<void> {
+    const version = (await VersionInfo.load({library:'sap.ui.core'}) as SingleVersionInfo)?.version;
+    const versionArray = version ? version.split('.') : ['2', '99'];
+    const minor = parseInt(versionArray[1], 10);
+    const major = parseInt(versionArray[0], 10);
 
-    if (minor < 72) {
+    if (major === 1 && minor < 72) {
         sap.ui.require(['open/ux/preview/client/flp/enableFakeConnector'], function (enableFakeConnector: () => void) {
             enableFakeConnector();
         });
@@ -26,5 +30,3 @@ export function initConnectors(): void {
         );
     }
 }
-
-initConnectors();
diff --git a/packages/preview-middleware-client/test/__mock__/window.ts b/packages/preview-middleware-client/test/__mock__/window.ts
@@ -26,6 +26,7 @@ export const sapMock = {
     ushell: {
         Container: {
             createRenderer: jest.fn().mockReturnValue({ placeAt: jest.fn() }),
+            createRendererInternal: jest.fn().mockReturnValue({ placeAt: jest.fn() }),
             attachRendererCreatedEvent: jest.fn(),
             getServiceAsync: jest.fn()
         }

diff --git a/packages/preview-middleware-client/test/unit/adp/init.test.ts b/packages/preview-middleware-client/test/unit/adp/init.test.ts
@@ -65,7 +65,7 @@ describe('adp', () => {
             return { dispose: jest.fn(), sendAction: jest.fn() };
         });
         const enableTelemetry = jest.spyOn(common, 'enableTelemetry');
-        VersionInfo.load.mockResolvedValue({ version: '1.118.1' });
+        VersionInfo.load.mockResolvedValue({name: 'sap.ui.core', version: '1.118.1' });
 
         await init(rtaMock as unknown as RuntimeAuthoring);
 
@@ -93,7 +93,7 @@ describe('adp', () => {
             return { dispose: jest.fn(), sendAction: sendActionMock };
         });
 
-        VersionInfo.load.mockResolvedValue({ version: '1.70.0' });
+        VersionInfo.load.mockResolvedValue({name: 'sap.ui.core', version: '1.70.0' });
 
         await init(rtaMock as unknown as RuntimeAuthoring);
 
@@ -133,7 +133,7 @@ describe('adp', () => {
             'application-app-preview-component---fin.ar.lineitems.display.appView': mockUI5Element
         });
 
-        VersionInfo.load.mockResolvedValue({ version: '1.123.1' });
+        VersionInfo.load.mockResolvedValue({name: 'sap.ui.core', version: '1.123.1' });
 
         await init(rtaMock as unknown as RuntimeAuthoring);
 
@@ -172,7 +172,7 @@ describe('adp', () => {
 
         Element.registry.filter.mockReturnValue([mockUI5Element]);
 
-        VersionInfo.load.mockResolvedValue({ version: '1.118.1' });
+        VersionInfo.load.mockResolvedValue({name: 'sap.ui.core', version: '1.118.1' });
 
         await init(rtaMock as unknown as RuntimeAuthoring);
 

diff --git a/packages/preview-middleware-client/test/unit/cpe/connector-service.test.ts b/packages/preview-middleware-client/test/unit/cpe/connector-service.test.ts
@@ -13,7 +13,7 @@ describe('connector-service', () => {
         fetchMock.mockRestore();
     });
     test('init - ui5 > v1.72', async () => {
-        VersionInfo.load.mockResolvedValue({ version: '1.120.4' });
+        VersionInfo.load.mockResolvedValue({ name: 'sap.ui.core', version: '1.120.4' });
         const wsConnector = new WorkspaceConnectorService();
         await wsConnector.init(sendActionMock);
 
@@ -25,7 +25,7 @@ describe('connector-service', () => {
     });
 
     test('init - ui5 < v1.72', async () => {
-        VersionInfo.load.mockResolvedValue({ version: '1.71.67' });
+        VersionInfo.load.mockResolvedValue({name: 'sap.ui.core', version: '1.71.67' });
         const wsConnector = new WorkspaceConnectorService();
         await wsConnector.init(sendActionMock);
 

diff --git a/packages/preview-middleware-client/test/unit/cpe/outline/nodes.test.ts b/packages/preview-middleware-client/test/unit/cpe/outline/nodes.test.ts
@@ -34,7 +34,7 @@ describe('outline nodes', () => {
     });
 
     beforeAll(() => {
-        VersionInfo.load.mockResolvedValue({ version: '1.118.1' });
+        VersionInfo.load.mockResolvedValue({name: 'sap.ui.core', version: '1.118.1' });
     })
 
     describe('transformNodes', () => {

diff --git a/packages/preview-middleware-client/test/unit/flp/WorkspaceConnector.test.ts b/packages/preview-middleware-client/test/unit/flp/WorkspaceConnector.test.ts
@@ -97,19 +97,19 @@ describe('flp/WorkspaceConnector', () => {
         });
 
         test('version >= 1.90, no developerMode', async () => {
-            VersionInfo.load.mockResolvedValueOnce({ version: '1.118.1' });
+            VersionInfo.load.mockResolvedValueOnce({name: 'sap.ui.core', version: '1.118.1' });
             const features = await connector.loadFeatures();
             expect(features.isVariantAdaptationEnabled).toBe(true);
         });
 
         test('version < 1.90', async () => {
-            VersionInfo.load.mockResolvedValueOnce({ version: '1.89.3' });
+            VersionInfo.load.mockResolvedValueOnce({name: 'sap.ui.core', version: '1.89.3' });
             const features = await connector.loadFeatures();
             expect(features.isVariantAdaptationEnabled).toBe(false);
         });
 
         test('version >= 1.90, developerMode=true', async () => {
-            VersionInfo.load.mockResolvedValueOnce({ version: '1.118.1' });
+            VersionInfo.load.mockResolvedValueOnce({name: 'sap.ui.core', version: '1.118.1' });
             documentMock.getElementById.mockReturnValueOnce({
                 getAttribute: () => JSON.stringify({ developerMode: true })
             });
@@ -118,7 +118,7 @@ describe('flp/WorkspaceConnector', () => {
         });
 
         test('scenario=ADAPTATION_PROJECT', async () => {
-            VersionInfo.load.mockResolvedValueOnce({ version: '1.118.1' });
+            VersionInfo.load.mockResolvedValueOnce({name: 'sap.ui.core', version: '1.118.1' });
             documentMock.getElementById.mockReturnValueOnce({
                 getAttribute: () => JSON.stringify({ scenario: 'ADAPTATION_PROJECT' })
             });

diff --git a/packages/preview-middleware-client/test/unit/flp/bootstrap.test.ts b/packages/preview-middleware-client/test/unit/flp/bootstrap.test.ts
@@ -0,0 +1,47 @@
+import { documentMock } from 'mock/window';
+import '../../../src/flp/bootstrap';
+import { Window } from '../../../types/global';
+
+describe('flp/ushellBootstrap', () => {
+    const htmlElement = {
+        onload: jest.fn(),
+        setAttribute: jest.fn()
+    };
+    documentMock.getElementById.mockReturnValue(htmlElement);
+    const fetchMock = jest.spyOn(global, 'fetch');
+
+    const ushellBootstrap = (window as unknown as Window)['sap-ui-config']['xx-bootTask'];
+
+    afterEach(() => {
+        jest.clearAllMocks();
+    });
+
+    test('xx-boottask defined', () => {
+        expect(ushellBootstrap).toBeDefined();
+    });
+
+    test('ushell src when ui5 version is 1.x', async () => {
+        fetchMock.mockResolvedValueOnce({
+            json: () => Promise.resolve({ libraries: [{name: 'sap.ui.core', version: '1.126.0'}] })
+        } as jest.Mocked<Response>);
+
+        await ushellBootstrap(() => {});
+        expect(htmlElement.setAttribute).toHaveBeenCalledWith('src', '/test-resources/sap/ushell/bootstrap/sandbox.js');
+    });
+
+    test('ushell src when ui5 version is 2.0', async () => {
+        fetchMock.mockResolvedValue({
+            json: () => Promise.resolve({ libraries: [{name: 'sap.ui.core', version: '2.0.0'}] })
+        } as jest.Mocked<Response>);
+
+        await ushellBootstrap(() => {});
+        expect(htmlElement.setAttribute).toHaveBeenCalledWith('src', '/resources/sap/ushell/bootstrap/sandbox2.js');
+    });
+
+    test('fetching version failed', async () => {
+        fetchMock.mockRejectedValueOnce('404');
+
+        await ushellBootstrap(() => {});
+        expect(htmlElement.setAttribute).toHaveBeenCalledWith('src', '/test-resources/sap/ushell/bootstrap/sandbox.js');
+    });
+});