@sap-ux/preview-middleware 1.0.49 → 1.1.1

package/README.md

@@ -66,12 +66,13 @@ Array of additional application configurations:
 | `rta.endpoints.developerMode` | `boolean`  | optional         | `false`       | Flag to enable the runtime adaptation developer mode (only supported for adaptation projects) |
 
 ### [`test`](#configuration-option-test)
-| Option          | Value Type | Requirement Type | Default Value  | Description                                                                                                                                                                                                                                                                                                             |
-| --------------- |------------|------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `framework`     | `string`   | mandatory        | `undefined`    | Currently `OPA5`, `QUnit` (only QUnit 2.3.2 provided as third-party module using [OpenUI5](https://github.com/SAP/openui5/blob/master/THIRDPARTY.txt)/SAPUI5) and `Testsuite` are supported. `Testsuite` will generate a testsuite for all configured frameworks that can be be used with a test runner (such as karma) |
-| `path`          | `string`   | optional         | `(calculated)` | The mount point to be used for test suite. By default, `/test/opaTests.qunit.html` is used for `OPA5`, `/test/unitTests.qunit.html` is used for `QUnit`, and `/test/testsuite.qunit.html` is used for `Testsuite`                                                                                                       |
-| `init`          | `string`   | optional         | `undefined`    | The mount point to be used for custom test runner script                                                                                                                                                                                                                                                                |
-| `pattern`       | `string`   | optional         | `(calculated)` | Optional glob pattern to find the tests. By default, `/test/**/*Journey{,.gen}.{js,ts}` is used for `OPA5` and `/test/**/*Test.{js,ts}` is used for `QUnit` (not applicable for `Testsuite`)                                                                                                                                   |
+| Option            | Value Type | Requirement Type | Default Value  | Description                                                                                                                                                                                                                                                                                                             |
+|-------------------|------------|------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `framework`       | `string`   | mandatory        | `undefined`    | Currently `OPA5`, `QUnit` (only QUnit 2.3.2 provided as third-party module using [OpenUI5](https://github.com/SAP/openui5/blob/master/THIRDPARTY.txt)/SAPUI5) and `Testsuite` are supported. `Testsuite` will generate a testsuite for all configured frameworks that can be be used with a test runner (such as karma) |
+| `path`            | `string`   | optional         | `(calculated)` | The mount point to be used for test suite. By default, `/test/opaTests.qunit.html` is used for `OPA5`, `/test/unitTests.qunit.html` is used for `QUnit`, and `/test/testsuite.qunit.html` is used for `Testsuite`                                                                                                       |
+| `init`            | `string`   | optional         | `undefined`    | The mount point to be used for custom test runner script                                                                                                                                                                                                                                                                |
+| `pattern`         | `string`   | optional         | `(calculated)` | Optional glob pattern to find the tests. By default, `/test/**/*Journey{,.gen}.{js,ts}` is used for `OPA5` and `/test/**/*Test.{js,ts}` is used for `QUnit` (not applicable for `Testsuite`)                                                                                                                            |
+| `isolateJourneys` | `boolean`  | optional         | `false`        | Only applicable for `OPA5`. When `true` and a `Testsuite` is configured, each journey is added as a separate test page with a `?journey=` URL parameter. The OPA5 init script respects this parameter and loads only the specified journey, enabling isolated test runs per journey.                                    |
 
 
 ## [Usage](#usage)

package/dist/base/flp.d.ts

@@ -246,6 +246,8 @@ export declare class FlpSandbox {
      * @param config the test configuration
      * @param initTemplate the test runner template
      * @param testPaths the paths to the test files
+     * @param opa5Path optional relative path from testsuite to OPA5 HTML page
+     * @param journeyNamesForIsolation optional list of journey module paths for isolated runs
      * @private
      */
     private testSuiteJsGetHandler;
@@ -253,6 +255,7 @@ export declare class FlpSandbox {
      * If it is part of TestConfig, create a test suite for the test configurations.
      *
      * @param configs test configurations
+     * @param id application id from manifest
      * @private
      */
     private createTestSuite;

package/dist/base/flp.js

@@ -20,6 +20,15 @@ import { getIntegrationCard } from './utils/cards.js';
 import { createPropertiesI18nEntries } from '@sap-ux/i18n';
 import { AdaptationProjectType } from '@sap-ux/axios-extension';
 const DEFAULT_LIVERELOAD_PORT = 35729;
+/**
+ * Convert an application id to its namespace by replacing dots with slashes.
+ *
+ * @param id application id from manifest (e.g. 'test.fe.v2.app')
+ * @returns namespace string (e.g. 'test/fe/v2/app')
+ */
+function toNamespace(id) {
+    return id.replaceAll('.', '/');
+}
 /**
  * Class handling preview of a sandbox FLP.
  */
@@ -106,7 +115,7 @@ export class FlpSandbox {
         }
         if (this.test) {
             this.addTestRoutes(this.test.filter((config) => config.framework !== 'Testsuite'), id);
-            this.createTestSuite(this.test);
+            await this.createTestSuite(this.test, id);
         }
         if (this.flpConfig.enhancedHomePage) {
             this.addCDMRoute();
@@ -648,9 +657,11 @@ export class FlpSandbox {
      * @param config the test configuration
      * @param initTemplate the test runner template
      * @param testPaths the paths to the test files
+     * @param opa5Path optional relative path from testsuite to OPA5 HTML page
+     * @param journeyNamesForIsolation optional list of journey module paths for isolated runs
      * @private
      */
-    async testSuiteJsGetHandler(res, next, config, initTemplate, testPaths) {
+    async testSuiteJsGetHandler(res, next, config, initTemplate, testPaths, opa5Path, journeyNamesForIsolation) {
         const files = await this.project.byGlob(config.init.replace('.js', '.[jt]s'));
         if (files?.length > 0) {
             this.logger.warn(`Script returned at ${config.path} is loaded from the file system.`);
@@ -658,9 +669,9 @@ export class FlpSandbox {
         }
         else {
             this.logger.debug(`Serving test route: ${config.init}`);
-            const templateConfig = {
-                testPaths: testPaths
-            };
+            const templateConfig = opa5Path && journeyNamesForIsolation?.length
+                ? { testPaths, opa5Path, journeyNames: journeyNamesForIsolation }
+                : { testPaths };
             const js = render(initTemplate, templateConfig);
             this.sendResponse(res, 'application/javascript', 200, js);
         }
@@ -669,9 +680,10 @@ export class FlpSandbox {
      * If it is part of TestConfig, create a test suite for the test configurations.
      *
      * @param configs test configurations
+     * @param id application id from manifest
      * @private
      */
-    createTestSuite(configs) {
+    async createTestSuite(configs, id) {
         const testsuiteConfig = configs.find((config) => config.framework === 'Testsuite');
         if (!testsuiteConfig) {
             //silent skip: create a testsuite only if it is explicitly part of the test configuration
@@ -691,18 +703,36 @@ export class FlpSandbox {
             this.logger.debug(`Skip serving testsuite init script in favor of provided script: ${testsuiteConfig.init}`);
             return;
         }
+        const ns = toNamespace(id);
+        const qunitConfig = configs.find((c) => c.framework === 'QUnit');
+        const opa5Config = configs.find((c) => c.framework === 'OPA5');
+        const mergedOpa5Config = opa5Config ? mergeTestConfigDefaults(opa5Config) : undefined;
         const testPaths = [];
-        for (const testConfig of configs) {
-            if (testConfig.framework === 'Testsuite') {
-                continue;
+        let opa5Path;
+        let journeyNamesForIsolation;
+        if (qunitConfig) {
+            testPaths.push(posix.relative(posix.dirname(config.path), mergeTestConfigDefaults(qunitConfig).path));
+        }
+        if (mergedOpa5Config) {
+            if (mergedOpa5Config.isolateJourneys) {
+                try {
+                    const journeyFiles = await this.project.byGlob(mergedOpa5Config.pattern);
+                    journeyNamesForIsolation = generateImportList(ns, journeyFiles);
+                    opa5Path = posix.relative(posix.dirname(config.path), mergedOpa5Config.path);
+                }
+                catch (e) {
+                    this.logger.error(`Failed to discover journey files: ${e.message}. OPA5 page will be added to testsuite without isolated journeys.`);
+                    testPaths.push(posix.relative(posix.dirname(config.path), mergedOpa5Config.path));
+                }
+            }
+            else {
+                testPaths.push(posix.relative(posix.dirname(config.path), mergedOpa5Config.path));
             }
-            const mergedConfig = mergeTestConfigDefaults(testConfig);
-            testPaths.push(posix.relative(posix.dirname(config.path), mergedConfig.path));
         }
-        const initTemplate = readFileSync(join(__dirname, '../../templates/test/testsuite.qunit.js'), 'utf-8');
+        const initTemplate = readFileSync(join(__dirname, '../../templates/test/testsuite.qunit-init.ejs'), 'utf-8');
         this.logger.debug(`Add route for ${config.init}`);
         this.router.get(config.init, async (_req, res, next) => {
-            await this.testSuiteJsGetHandler(res, next, config, initTemplate, testPaths);
+            await this.testSuiteJsGetHandler(res, next, config, initTemplate, testPaths, opa5Path, journeyNamesForIsolation);
         });
     }
     /**
@@ -763,7 +793,13 @@ export class FlpSandbox {
         }
         else {
             const testFiles = await this.project.byGlob(config.pattern);
-            const templateConfig = { tests: generateImportList(ns, testFiles) };
+            if (testFiles.length === 0) {
+                this.logger.warn(`No test files found for pattern '${config.pattern}'.`);
+            }
+            const templateConfig = {
+                tests: generateImportList(ns, testFiles),
+                isolateJourneys: config.isolateJourneys === true
+            };
             const js = render(initTemplate, templateConfig);
             this.sendResponse(res, 'application/javascript', 200, js);
         }
@@ -775,7 +811,7 @@ export class FlpSandbox {
      * @param id application id from manifest
      */
     addTestRoutes(configs, id) {
-        const ns = id.replace(/\./g, '/');
+        const ns = toNamespace(id);
         const htmlTemplate = readFileSync(join(__dirname, '../../templates/test/qunit.ejs'), 'utf-8');
         for (const testConfig of configs) {
             const config = mergeTestConfigDefaults(testConfig);
@@ -789,7 +825,7 @@ export class FlpSandbox {
                 continue;
             }
             // add route for the init file
-            const initTemplate = readFileSync(join(__dirname, '../../templates/test/qunit.js'), 'utf-8');
+            const initTemplate = readFileSync(join(__dirname, '../../templates/test/qunit-init.ejs'), 'utf-8');
             this.logger.debug(`Add route for ${config.init}`);
             this.router.get(config.init, async (_req, res, next) => {
                 await this.testRunnerJsGetHandler(res, next, config, initTemplate, ns);

package/dist/base/test.js

@@ -3,19 +3,22 @@ const DEFAULTS = {
         path: '/test/unitTests.qunit.html',
         init: '/test/unitTests.qunit.js',
         pattern: '/test/**/*Test.{js,ts}',
-        framework: 'QUnit'
+        framework: 'QUnit',
+        isolateJourneys: false
     },
     opa5: {
         path: '/test/opaTests.qunit.html',
         init: '/test/opaTests.qunit.js',
         pattern: '/test/**/*Journey{,.gen}.{js,ts}',
-        framework: 'OPA5'
+        framework: 'OPA5',
+        isolateJourneys: false
     },
     testsuite: {
         path: '/test/testsuite.qunit.html',
         init: '/test/testsuite.qunit.js',
         pattern: '',
-        framework: 'Testsuite'
+        framework: 'Testsuite',
+        isolateJourneys: false
     }
 };
 /**

package/dist/types/index.d.ts

@@ -80,6 +80,11 @@ export interface TestConfig {
      * Pattern to match the test files
      */
     pattern?: string;
+    /**
+     * Optional: when true, each OPA5 journey runs in its own isolated test page.
+     * Only meaningful when framework is 'OPA5'.
+     */
+    isolateJourneys?: boolean;
 }
 /**
  * Test configuration that has been enriched with the defaults in case of missing values.
@@ -94,18 +99,21 @@ export type TestConfigDefaults = {
         init: '/test/unitTests.qunit.js';
         pattern: '/test/**/*Test.{js,ts}';
         framework: 'QUnit';
+        isolateJourneys: false;
     };
     opa5: {
         path: '/test/opaTests.qunit.html';
         init: '/test/opaTests.qunit.js';
         pattern: '/test/**/*Journey{,.gen}.{js,ts}';
         framework: 'OPA5';
+        isolateJourneys: false;
     };
     testsuite: {
         path: '/test/testsuite.qunit.html';
         init: '/test/testsuite.qunit.js';
         pattern: '';
         framework: 'Testsuite';
+        isolateJourneys: false;
     };
 };
 export type CardGeneratorConfig = {

package/package.json

@@ -10,7 +10,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Apreview-middleware"
   },
-  "version": "1.0.49",
+  "version": "1.1.1",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -28,12 +28,12 @@
     "mem-fs-editor": "9.4.0",
     "qrcode": "1.5.4",
     "@sap/bas-sdk": "3.13.10",
-    "@sap-ux/adp-tooling": "1.0.39",
+    "@sap-ux/adp-tooling": "1.0.40",
     "@sap-ux/btp-utils": "2.0.6",
-    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@1.0.10",
     "@sap-ux/feature-toggle": "1.0.5",
     "@sap-ux/logger": "1.0.3",
-    "@sap-ux/project-access": "2.1.9",
+    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@1.0.10",
+    "@sap-ux/project-access": "2.1.10",
     "@sap-ux/system-access": "1.0.10",
     "@sap-ux/i18n": "1.0.2"
   },
@@ -54,7 +54,7 @@
     "nock": "14.0.16",
     "npm-run-all2": "9.0.2",
     "supertest": "7.2.2",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@1.0.49",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@1.1.1",
     "@sap-ux-private/playwright": "1.0.6",
     "@sap-ux/axios-extension": "2.0.8",
     "@sap-ux/store": "2.0.6",

package/templates/test/{qunit.js → qunit-init.ejs}

@@ -17,13 +17,20 @@ sap.ui.loader.config({
 
 window.QUnit = Object.assign({}, window.QUnit, { config: { autostart: false } });
 
+<% if (locals.isolateJourneys) { -%>
+const knownJourneys = <%- JSON.stringify(tests) %>;
+const journeyParam = new URLSearchParams(window.location.search).get("journey");
+const modulesToRequire = (journeyParam && knownJourneys.includes(journeyParam)) ? [journeyParam] : knownJourneys;
+<% } else { -%>
+const modulesToRequire = <%- JSON.stringify(tests) %>;
+<% } -%>
 sap.ui.require([
     "sap/ui/thirdparty/qunit-2",
     "sap/ui/qunit/qunit-junit",
     "sap/ui/qunit/qunit-coverage"
 ], function (QUnit) {
     'use strict';
-    sap.ui.require(<%- JSON.stringify(tests) %>, function() {
+    sap.ui.require(modulesToRequire, function() {
         QUnit.start();
     });
-});
+});

package/templates/test/testsuite.qunit-init.ejs

@@ -0,0 +1,13 @@
+window.suite = function () {
+    const oSuite = new parent.jsUnitTestSuite();
+    var sContextPath = location.pathname.substring(0, location.pathname.lastIndexOf("/") + 1);
+<% for (const path of locals.testPaths) { -%>
+    oSuite.addTestPage(sContextPath + "<%- path %>");
+<% } -%>
+<% if (locals.opa5Path && locals.journeyNames && locals.journeyNames.length > 0) { -%>
+<% for (const name of locals.journeyNames) { -%>
+    oSuite.addTestPage(sContextPath + "<%- locals.opa5Path %>?journey=<%- name %>");
+<% } -%>
+<% } -%>
+    return oSuite;
+}

package/templates/test/testsuite.qunit.js

@@ -1,8 +0,0 @@
-window.suite = function () {
-    const oSuite = new parent.jsUnitTestSuite();
-    var sContextPath = location.pathname.substring(0, location.pathname.lastIndexOf("/") + 1);
-<% for (const path of locals.testPaths) { %>
-    oSuite.addTestPage(sContextPath + "<%- path %>");
-<% } %>
-    return oSuite;
-}