cds-plugin-ui5 0.7.0 → 0.7.2

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.7.2](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.7.1...cds-plugin-ui5@0.7.2) (2023-10-30)
+
+
+### Bug Fixes
+
+* **cds-plugin-ui5:** disable plugin for JEST test execution ([#906](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/906)) ([b2b3c01](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/b2b3c013368a7c87e3ee28972e7207d6bacd2d30)), closes [#901](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/901)
+
+
+
+
+
+## [0.7.1](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.7.0...cds-plugin-ui5@0.7.1) (2023-10-30)
+
+
+### Bug Fixes
+
+* **cds-plugin-ui5:** remove activation hook since it's not needed ([#900](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/900)) ([86fde7e](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/86fde7e1cd709c52fc32cee2184b18bf6ea3f16d)), closes [#899](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/899)
+
+
+
+
+
 # [0.7.0](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.6.14...cds-plugin-ui5@0.7.0) (2023-10-17)
 
 

package/README.md

@@ -146,6 +146,14 @@ module.exports = async ({ log, resources, options }) => {
 
 The returned app pages will be added to the welcome page within the respective mount path.
 
+## Hints
+
+This section includes hints for the usage of the `cds-plugin-ui5` with other tools.
+
+### JEST
+
+The `cds-plugin-ui5` doesn't work with JEST out of the box as it internally is using dynamic imports to load helpers from the UI5 tooling. JEST fails with a `segmentation fault` error and therefore, the `cds-plugin-ui5` is disabled when running in context of JEST. It can be forcefully enabled by setting the environment variable `CDS_PLUGIN_UI5_ACTIVE=true`. But in this case you need to at least use Node.js 21 (https://github.com/nodejs/node/issues/35889) and you need to enable the experimental support for ES modules (https://jestjs.io/docs/ecmascript-modules). This enables the `cds-plugin-ui5` to run in context of JEST.
+
 ## Support
 
 Please use the GitHub bug tracking system to post questions, bug reports or to create pull requests.

package/cds-plugin.js

@@ -1,7 +1,32 @@
+const log = require("./lib/log");
+
+// >> IMPORTANT <<
+//
+// JEST has issues with dynamic imports and will fail when they are used,
+// e.g. in the findUI5Modules the UI5 tooling is used which is implemented
+// using ES modules. To avoid issues when running JEST tests, the plugin
+// will be disabled by default but it can be enforced with CDS_PLUGIN_UI5_ACTIVE=true
+// since JEST supports ES modules when using Node.js 21 and the experimental
+// support for VM modules via:
+//
+//   > NODE_OPTIONS=--experimental-vm-modules jest
+//
+// Details can be found in the following issue:
+//   - https://github.com/ui5-community/ui5-ecosystem-showcase/issues/901
+//
+// To disable JEST we rely on env variables (see https://jestjs.io/docs/environment-variables)
+if (process.env.NODE_ENV === "test" && process.env.JEST_WORKER_ID && process.env.CDS_PLUGIN_UI5_ACTIVE !== "true") {
+	log.info("Skip execution of plugin because JEST is running tests! To force the execution of the plugin set env var CDS_PLUGIN_UI5_ACTIVE=true...");
+	return;
+}
+if (process.env.CDS_PLUGIN_UI5_ACTIVE === "false") {
+	log.info("Skip execution of plugin because it has been disabled by env var CDS_PLUGIN_UI5_ACTIVE!");
+	return;
+}
+
 // @sap/cds/lib/index.js#138: global.cds = cds // REVISIT: using global.cds seems wrong
 const cds = global.cds || require("@sap/cds"); // reuse already loaded cds!
 
-const log = require("./lib/log");
 const findUI5Modules = require("./lib/findUI5Modules");
 const createPatchedRouter = require("./lib/createPatchedRouter");
 const applyUI5Middleware = require("./lib/applyUI5Middleware");
@@ -160,12 +185,3 @@ if (!skip) {
 		bootstrapped();
 	});
 }
-
-// return callback for plugin activation
-module.exports = {
-	activate: function activate(conf) {
-		if (!skip) {
-			log.debug("activate", conf);
-		}
-	},
-};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cds-plugin-ui5",
-  "version": "0.7.0",
+  "version": "0.7.2",
   "description": "A CDS server plugin to inject the middlewares of all related UI5 tooling based projects.",
   "author": "Peter Muessig",
   "license": "Apache-2.0",
@@ -25,5 +25,5 @@
     "@sap/cds": ">=6.8.2",
     "express": ">=4.18.2"
   },
-  "gitHead": "df6d62f98ada9f7852931b7292070111717f3949"
+  "gitHead": "8ca55ef4efc1ecf9f51340e20f3d240c8f8fb2d2"
 }