@sap-ux/jest-environment-ui5 5.3.7 → 5.3.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/jest-environment-ui5",
-  "version": "5.3.7",
+  "version": "5.3.9",
   "description": "Jest matchers for files and folders",
   "repository": {
     "type": "git",
@@ -25,8 +25,7 @@
   "devDependencies": {
     "@ui5/cli": "^3",
     "@ui5/project": "^3.9.0",
-    "cross-env": "^7.0.3",
-    "jest": "^29.7.0"
+    "cross-env": "^7.0.3"
   },
   "scripts": {
     "clean": "rimraf --glob dist coverage *.tsbuildinfo",
@@ -34,18 +33,18 @@
     "lint": "eslint . --ext .js",
     "lint:fix": "eslint . --ext .js --fix",
     "test": "pnpm run test-ut && pnpm run testlatest",
-    "test-ut": "cross-env NODE_OPTIONS='--experimental-vm-modules' npx jest --ci --forceExit --detectOpenHandles --colors --passWithNoTests  --runInBand ",
+    "test-ut": "cross-env NODE_OPTIONS='--experimental-vm-modules' npx jest --ci --forceExit --detectOpenHandles --colors  --runInBand ",
     "test-e2e": "pnpm run testlatest && pnpm run test71 && pnpm run test84 && pnpm run test96 && pnpm run test108 && pnpm run test120 && pnpm run test124 && pnpm run test127",
     "link": "pnpm link --global",
     "unlink": "pnpm unlink --global",
-    "test71": "cross-env UI5_JEST_CONFIG=test/fixtures/ui5-1.71.yaml jest --config jest-ui5.config.js --ci --forceExit --detectOpenHandles --colors --passWithNoTests",
-    "test84": "cross-env UI5_JEST_CONFIG=test/fixtures/ui5-1.84.yaml jest --config jest-ui5.config.js --ci --forceExit --detectOpenHandles --colors --passWithNoTests",
-    "test96": "cross-env UI5_JEST_CONFIG=test/fixtures/ui5-1.96.yaml jest --config jest-ui5.config.js --ci --forceExit --detectOpenHandles --colors --passWithNoTests",
-    "test108": "cross-env UI5_JEST_CONFIG=test/fixtures/ui5-1.108.yaml jest --config jest-ui5.config.js --ci --forceExit --detectOpenHandles --colors --passWithNoTests",
-    "test120": "cross-env UI5_JEST_CONFIG=test/fixtures/ui5-1.120.yaml jest --config jest-ui5.config.js --ci --forceExit --detectOpenHandles --colors --passWithNoTests",
-    "test124": "cross-env UI5_JEST_CONFIG=test/fixtures/ui5-1.124.yaml jest --config jest-ui5.config.js --ci --forceExit --detectOpenHandles --colors --passWithNoTests",
-    "test127": "cross-env UI5_JEST_CONFIG=test/fixtures/ui5-1.127.yaml jest --config jest-ui5.config.js --ci --forceExit --detectOpenHandles --colors --passWithNoTests",
-    "testlatest": "cross-env UI5_JEST_CONFIG=test/fixtures/ui5.yaml jest --config jest-ui5.config.js --ci --forceExit --detectOpenHandles --colors --passWithNoTests",
-    "test20": "cross-env UI5_JEST_CONFIG=test/fixtures/ui5-2.0.yaml jest --config jest-ui5.config.js --ci --forceExit --detectOpenHandles --colors --passWithNoTests"
+    "test71": "cross-env UI5_JEST_CONFIG=test/fixtures/ui5-1.71.yaml jest --config jest-ui5.config.js --ci --forceExit --detectOpenHandles --colors",
+    "test84": "cross-env UI5_JEST_CONFIG=test/fixtures/ui5-1.84.yaml jest --config jest-ui5.config.js --ci --forceExit --detectOpenHandles --colors",
+    "test96": "cross-env UI5_JEST_CONFIG=test/fixtures/ui5-1.96.yaml jest --config jest-ui5.config.js --ci --forceExit --detectOpenHandles --colors",
+    "test108": "cross-env UI5_JEST_CONFIG=test/fixtures/ui5-1.108.yaml jest --config jest-ui5.config.js --ci --forceExit --detectOpenHandles --colors",
+    "test120": "cross-env UI5_JEST_CONFIG=test/fixtures/ui5-1.120.yaml jest --config jest-ui5.config.js --ci --forceExit --detectOpenHandles --colors",
+    "test124": "cross-env UI5_JEST_CONFIG=test/fixtures/ui5-1.124.yaml jest --config jest-ui5.config.js --ci --forceExit --detectOpenHandles --colors",
+    "test127": "cross-env UI5_JEST_CONFIG=test/fixtures/ui5-1.127.yaml jest --config jest-ui5.config.js --ci --forceExit --detectOpenHandles --colors",
+    "testlatest": "cross-env UI5_JEST_CONFIG=test/fixtures/ui5.yaml jest --config jest-ui5.config.js --ci --forceExit --detectOpenHandles --colors",
+    "test20": "cross-env UI5_JEST_CONFIG=test/fixtures/ui5-2.0.yaml jest --config jest-ui5.config.js --ci --forceExit --detectOpenHandles --colors"
   }
 }

package/src/env/mockXHR.js

@@ -15,8 +15,8 @@ function createMockXHR(globalWindow, pathMappingFn, shimmedFilePath, mockData, X
 
     /**
      * Handles the real XHR send.
-     * @param mockXHR The mock XHR object.
-     * @param data The data to send.
+     * @param {object} mockXHR The mock XHR object.
+     * @param {object} data The data to send.
      */
     function handleRealXHRSend(mockXHR, data) {
         realXhr.addEventListener('load', function () {

package/src/env/ui5loader.js

@@ -599,6 +599,7 @@
      * @param {string} sUrlPrefix path to the resource
      */
     function registerResourcePath(sResourceNamePrefix, sUrlPrefix) {
+
         sResourceNamePrefix = String(sResourceNamePrefix || "");
 
         if ( sUrlPrefix == null ) {
@@ -625,7 +626,9 @@
         if ( sUrlPrefix.slice(-1) !== '/' ) {
             sUrlPrefix += '/';
         }
-
+        if(sUrlPrefix === "./" && sResourceNamePrefix === "") {
+            sUrlPrefix = "";
+        }
         mUrlPrefixes[sResourceNamePrefix] = {
             url: sUrlPrefix,
             // calculate absolute URL, only to be used by 'guessResourceName'
@@ -995,12 +998,7 @@
                     const oShim = mShims[this.name],
                         sExport = oShim && (Array.isArray(oShim.exports) ? oShim.exports[0] : oShim.exports);
                     // best guess for thirdparty modules or legacy modules that don't use sap.ui.define
-					if(this.name === "sap/ui/thirdparty/crossroads.js") {
-						this.content = window.crossroads;
-					} else {
-                    	this.content = getGlobalProperty( sExport || urnToUI5(this.name) );
-                	}
-
+                    this.content = getGlobalProperty(sExport || urnToUI5(this.name));
                 }
                 return this.content;
             }
@@ -1765,13 +1763,14 @@
 						})
 					}
                     const output = oModule.data.call(__global);
-					if(output && mShims[oModule.name] && mShims[oModule.name].exports && Object.keys(output).length > 0 && !global[mShims[oModule.name].exports]) {
-						// if(global[mShims[oModule.name].exports] ) {
-						// 	global[mShims[oModule.name].exports] = {...global[mShims[oModule.name].exports], ...output}
-						// } else {
-							global[mShims[oModule.name].exports] = output;
-						//}
-
+					if(output && mShims[oModule.name] && mShims[oModule.name].exports && Object.keys(output).length > 0) {
+						if(global[mShims[oModule.name].exports] ) {
+							global[mShims[oModule.name].exports] = {...global[mShims[oModule.name].exports], ...output}
+						} else if(output[mShims[oModule.name].exports] !== undefined) {
+                            global[mShims[oModule.name].exports] = output[mShims[oModule.name].exports];
+                        } else {
+						    global[mShims[oModule.name].exports] = output;
+						}
 					}
 					else if(output && Object.keys(output).length > 0) {
 						if( Object.keys(oModule.content).length === 0) {

package/src/index.js

@@ -89,9 +89,7 @@ class UI5DOMEnvironment extends JSDOMEnvironment {
         window['sap-ui-no-preload'] = !this.useOptimized;
         window.requireFn(path.join(__dirname, 'env', 'ui5loader'));
         if (this.testEnvironmentOptions.isV2) {
-            const scriptTag = window.document.createElement('script');
-            scriptTag.setAttribute('src', './ui5loader-autoconfig.js');
-            window.document.head.appendChild(scriptTag);
+            window.requireFn(window.jestUI5.resolvePath('ui5loader-autoconfig.js'));
         } else {
             window['sap-ui-config'].excludejquerycompat = true;
             sap.ui.requireSync('ui5loader-autoconfig');
@@ -111,7 +109,6 @@ class UI5DOMEnvironment extends JSDOMEnvironment {
             }
         }
         sap.ui.loader.config({ async: true });
-        delete window['sap-ui-config'].resourceRoots;
 
         if (!this.testEnvironmentOptions.isV2) {
             this.core = sap.ui.requireSync('sap/ui/core/Core');
@@ -146,11 +143,25 @@ class UI5DOMEnvironment extends JSDOMEnvironment {
      * @param {boolean} allowCSS Whether to allow the UI5 CSS to be loaded
      */
     overwriteUi5Lib(resolve, allowCSS) {
+        const that = this;
         sap.ui.require(
             ['sap/ui/core/Lib'],
             function (Lib) {
                 const fnInit = Lib.init;
+                const fnLoad = Lib._load;
+                Lib._load = function (mSettings) {
+                    if (that.testEnvironmentOptions.shimManifests) {
+                        const name = typeof mSettings === 'string' ? mSettings : mSettings.name;
+                        that.shimManifestFile(name);
+                    }
+
+                    return fnLoad.call(this, mSettings);
+                };
                 Lib.init = function (mSettings) {
+                    if (that.testEnvironmentOptions.shimManifests) {
+                        that.shimManifestFile(mSettings.name);
+                    }
+
                     mSettings.noLibraryCSS = !allowCSS;
                     return fnInit.call(this, mSettings);
                 };
@@ -162,6 +173,23 @@ class UI5DOMEnvironment extends JSDOMEnvironment {
         );
     }
 
+    /**
+     * Register a shimmed manifest file for the given name.
+     * @param name The name of the library to shim
+     */
+    shimManifestFile(name) {
+        window.jestUI5.mockUrl(
+            name.replaceAll('.', '/') + '/' + 'manifest.json',
+            JSON.stringify({
+                'sap.ui5': {
+                    library: {
+                        css: false
+                    }
+                }
+            })
+        );
+    }
+
     /**
      * @returns {object} The VM Context for the current environment
      */

package/src/utils/ui5MappingStrategy.js

@@ -2,6 +2,52 @@ const path = require('path');
 let pathMappingFn = null;
 let ui5VersionCache = null;
 
+/**
+ * Processes the resources of a UI5 project and updates the path mapping.
+ * @param {object} resources The resources to process.
+ * @param {object} ui5PathMapping The mapping object to update.
+ * @param {boolean} isRootProject Whether the project is the root project.
+ * @param {boolean} isReusableLibrary Whether the project is a reusable library.
+ * @param {string} namespace The namespace of the project.
+ * @param {string} sourceDirectory The source directory of the project.
+ */
+function processDependencyResources(
+    resources,
+    ui5PathMapping,
+    isRootProject,
+    isReusableLibrary,
+    namespace,
+    sourceDirectory
+) {
+    for (const resource of resources) {
+        const resourcePath = resource.getPath().replace(/\/resources\/|\/test-resources\//g, '');
+        let itemPath;
+        if (sourceDirectory) {
+            itemPath = path.join(sourceDirectory, resourcePath);
+        } else {
+            itemPath = resource.getSourceMetadata?.().fsPath ?? resourcePath;
+        }
+
+        let targetPath = resourcePath.replace(/\\/g, '/');
+        if (targetPath.endsWith('.js')) {
+            targetPath = targetPath.replace('.js', '');
+            ui5PathMapping[targetPath + '.js'] = itemPath;
+        }
+
+        if (isRootProject || isReusableLibrary) {
+            if (targetPath.endsWith('.ts')) {
+                targetPath = targetPath.replace('.ts', '');
+                ui5PathMapping[targetPath + '.ts'] = itemPath;
+            }
+            if (namespace && !targetPath.startsWith(namespace)) {
+                targetPath = path.posix.join(namespace, targetPath);
+            }
+        }
+
+        ui5PathMapping[targetPath] = itemPath;
+    }
+}
+
 /**
  * Retrieves the file map from the UI5 project.
  * @param {object} graph  The graph object.
@@ -12,17 +58,22 @@ async function getFileMapFromUI5(graph, rootProject) {
     let ui5PathMapping = {};
     let ui5VersionInfo = {
         name: 'SAPUI5 Distribution',
-        version: rootProject._config.framework.version,
+        version: rootProject._config.framework?.version ?? '1.0.0',
         'buildTimestamp': '202412051614',
         'scmRevision': '',
         'libraries': []
     };
 
     await graph.traverseBreadthFirst(async ({ project: dependency }) => {
-        const reader = dependency.getReader({ style: 'runtime' });
-        const sourcePath = dependency.getSourcePath();
-        const namespace = dependency.getNamespace();
+        const dependencyType = dependency.getType();
+        const isReusableLibrary = dependencyType === 'library' && !dependency.isFrameworkProject();
         const isRootProject = dependency.getName() === rootProject.getName();
+        const reader = dependency.getReader({ style: isReusableLibrary || isRootProject ? 'flat' : 'runtime' });
+        let sourcePath;
+        if (dependencyType !== 'module') {
+            sourcePath = dependency.getSourcePath();
+        }
+        const namespace = dependency.getNamespace();
         ui5VersionInfo.libraries.push({
             name: dependency.getName(),
             version: dependency.getVersion(),
@@ -30,29 +81,7 @@ async function getFileMapFromUI5(graph, rootProject) {
             scmRevision: ''
         });
         let resources = await reader.byGlob(`**/*.{ts,tsx,js,xml,properties,json}`);
-
-        for (const resource of resources) {
-            const resourcePath = resource.getPath().replace(/\/resources\/|\/test-resources\//g, '');
-            const itemPath = path.join(sourcePath, resourcePath);
-
-            let targetPath = resourcePath.replace(/\\/g, '/');
-            if (targetPath.endsWith('.js')) {
-                targetPath = targetPath.replace('.js', '');
-                ui5PathMapping[targetPath + '.js'] = itemPath;
-            }
-
-            if (isRootProject) {
-                if (targetPath.endsWith('.ts')) {
-                    targetPath = targetPath.replace('.ts', '');
-                    ui5PathMapping[targetPath + '.ts'] = itemPath;
-                }
-                if (!targetPath.startsWith(namespace)) {
-                    targetPath = path.posix.join(namespace, targetPath);
-                }
-            }
-
-            ui5PathMapping[targetPath] = itemPath;
-        }
+        processDependencyResources(resources, ui5PathMapping, isRootProject, isReusableLibrary, namespace, sourcePath);
     });
     return { ui5PathMapping, ui5VersionInfo };
 }