cds-plugin-ui5 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 0.1.0 (2023-05-26)
+
+
+### Features
+
+* **cds-plugin-ui5:** initial poc for UI5 cds-plugin ([#746](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/746)) ([70a7477](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/70a7477410ef8a75bc994f117cc0d7fcffef2fed))

package/LICENSE

@@ -0,0 +1,253 @@
+/*
+ * ----------------------------------------------------------------------------
+ * "THE DERIVED BEER-WARE LICENSE" (Revision 1):
+ * You can do whatever you want with this stuff. When you like it, just buy
+ * Volker Buzek (@vobu) a beer or buy Peter Muessig (@pmuessig) a coke when
+ * you see one of them.
+ *
+ * Inspired by the official: https://fedoraproject.org/wiki/Licensing/Beerware
+ *
+ * "THE BEER-WARE LICENSE" (Revision 42):
+ * <phk@FreeBSD.ORG> wrote this file. As long as you retain this notice you
+ * can do whatever you want with this stuff. If we meet some day, and you think
+ * this stuff is worth it, you can buy me a beer in return Poul-Henning Kamp
+ * ----------------------------------------------------------------------------
+ */
+
+---
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+------------------------------------------------------------------------------
+APIs
+
+This project may include APIs to SAP or third party products or services. The use of these APIs, products and services may be subject to additional agreements. In no event shall the application of the Apache Software License, v.2 to this project grant any rights in or to these APIs, products or services that would alter, expand, be inconsistent with, or supersede any terms of these additional agreements. “API” means application programming interfaces, as well as their respective specifications and implementing code that allows other software products to communicate with or call on SAP or third party products or services (for example, SAP Enterprise Services, BAPIs, Idocs, RFCs and ABAP calls or other user exits) and may be made available through SAP or third party products, SDKs, documentation or other media.
+
+------------------------------------------------------------------------------
+SUBCOMPONENTS
+
+This project includes the following subcomponents that are subject to separate license terms.
+Your use of these subcomponents is subject to the separate license terms applicable to
+each subcomponent.
+
+Component: deploy.sh
+Licensor: Domenic Denicola
+Website: https://gist.github.com/domenic/ec8b0fc8ab45f39403dd/e445116166c79d7ac35eb38a5d348d546f3d1620
+License: MIT License
+<year> = 2018
+<copyright holders> = Domenic Denicola
+
+------------------------------------------------------------------------------
+
+The MIT License (MIT)
+
+Copyright <YEAR> <COPYRIGHT HOLDER>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+------------------------------------------------------------------------------

package/README.md

@@ -0,0 +1,28 @@
+# cds-plugin-ui5
+
+The `cds-plugin-ui5` is a CAP server `cds-plugin` which enables the integration of UI5 tooling based (UI5 freestyle or Fiori elements) projects into the CAP server via the UI5 tooling express middlewares. The UI5 or Fiori elements projects just need to be located in the `app` folder of the CAP server or be dependency of the CAP server.
+
+> :construction: **Note**
+> This cds-plugin is still work in progress and not final yet!
+
+## Usage
+
+Add a `devDependency` to the `cds-plugin-ui5` to your CAP server project:
+
+```sh
+npm add cds-plugin-ui5 -D
+```
+
+That's it!
+
+## Support
+
+Please use the GitHub bug tracking system to post questions, bug reports or to create pull requests.
+
+## Contributing
+
+Any type of contribution (code contributions, pull requests, issues) to this set of tooling extensions will be equally appreciated.
+
+## License
+
+This work is [dual-licensed](../../LICENSE) under Apache 2.0 and the Derived Beer-ware License. The official license will be Apache 2.0 but finally you can choose between one of them if you use this work.

package/cds-plugin.js

@@ -0,0 +1,113 @@
+const path = require("path");
+const fs = require("fs");
+const yaml = require("js-yaml");
+
+const cds = require("@sap/cds");
+const { Router } = require("express");
+
+const applyUI5Middleware = require("./lib/applyUI5Middleware");
+
+// marker that the cds-plugin-ui5 plugin is running
+// to disable the ui5-middleware-cap if used in apps
+process.env["cds-plugin-ui5"] = true;
+
+cds.on("bootstrap", async (app) => {
+	console.log("[cds-ui5-plugin] bootstrap");
+
+	// prepare the _app_links to add links dynamically
+	const links = (app._app_links = app._app_links || []);
+
+	// lookup the app folder
+	const appDirs = [];
+	appDirs.push(
+		...fs
+			.readdirSync(path.join(process.cwd(), "app"), { withFileTypes: true })
+			.filter((f) => f.isDirectory() && fs.existsSync(path.join(process.cwd(), "app", f.name, "ui5.yaml")))
+			.map((f) => path.join(process.cwd(), "app", f.name))
+	);
+
+	// lookup the UI5 dependencies
+	const pkgJson = require(path.join(process.cwd(), "package.json"));
+	const deps = [];
+	deps.push(...Object.keys(pkgJson.dependencies || {}));
+	deps.push(...Object.keys(pkgJson.devDependencies || {}));
+	//deps.push(...Object.keys(pkgJson.peerDependencies || {}));
+	//deps.push(...Object.keys(pkgJson.optionalDependencies || {}));
+	appDirs.push(
+		...deps.filter((dep) => {
+			try {
+				require.resolve(`${dep}/ui5.yaml`, {
+					paths: [process.cwd()],
+				});
+				return true;
+			} catch (e) {
+				return false;
+			}
+		})
+	);
+
+	// if apps are available, attach the middlewares of the UI5 apps
+	// to the express of the CAP server via a express router
+	if (appDirs) {
+		for await (const appDir of appDirs) {
+			// read the ui5.yaml file to extract the configuration
+			const ui5YamlPath = require.resolve(path.join(appDir, "ui5.yaml"), {
+				paths: [process.cwd()],
+			});
+			let ui5Configs;
+			try {
+				const content = fs.readFileSync(ui5YamlPath, "utf-8");
+				ui5Configs = yaml.loadAll(content);
+			} catch (err) {
+				if (err.name === "YAMLException") {
+					console.error(`Failed to read ${ui5YamlPath}!`);
+				}
+				throw err;
+			}
+
+			// by default the mount path is derived from the metadata/name
+			// and can be overridden by customConfiguration/mountPath
+			const ui5Config = ui5Configs?.[0];
+			let mountPath = ui5Config?.customConfiguration?.mountPath || ui5Config?.metadata?.name;
+			if (!/^\//.test(mountPath)) {
+				mountPath = `/${mountPath}`; // always start with /
+			}
+
+			// mounting the Router for the application to the CAP server
+			console.log(`Mounting ${mountPath} to UI5 app ${appDir}`);
+			const modulePath = path.dirname(ui5YamlPath);
+
+			// create the router and get rid of the mount path
+			const router = new Router();
+			router.use(function (req, res, next) {
+				req.originalUrl = req.url;
+				req.baseUrl = "/";
+				next();
+			});
+
+			// apply the UI5 middlewares to the router and
+			// retrieve the available HTML pages
+			const pages = await applyUI5Middleware(router, {
+				basePath: modulePath,
+				configPath: modulePath,
+			});
+
+			// append the HTML pages to the links
+			pages.forEach((page) => {
+				const prefix = mountPath !== "/" ? mountPath : "";
+				links.push(`${prefix}${page.getPath()}`);
+				console.log(`${prefix}${page.getPath()}`);
+			});
+
+			// mount the router to the determined mount path
+			app.use(`${mountPath}`, router);
+		}
+	}
+});
+
+// mount static resources and common middlewares...
+module.exports = {
+	activate: function activate(conf) {
+		console.log("[cds-ui5-plugin] activate", conf);
+	},
+};

package/lib/applyUI5Middleware.js

@@ -0,0 +1,58 @@
+const path = require("path");
+
+// inspired by https://github.com/SAP/karma-ui5/blob/main/lib/framework.js#L466-L522
+module.exports = async function applyUI5Middleware(router, { basePath, configPath }) {
+	const { graphFromPackageDependencies } = await import("@ui5/project/graph");
+	const { createReaderCollection } = await import("@ui5/fs/resourceFactory");
+
+	const graph = await graphFromPackageDependencies({
+		workspaceName: process.env["ui5-workspace"],
+		cwd: basePath,
+		rootConfigPath: configPath ? path.resolve(configPath, "ui5.yaml") : undefined,
+	});
+
+	const rootProject = graph.getRoot();
+
+	const readers = [];
+	await graph.traverseBreadthFirst(async function ({ project: dep }) {
+		if (dep.getName() === rootProject.getName()) {
+			// Ignore root project
+			return;
+		}
+		readers.push(dep.getReader({ style: "runtime" }));
+	});
+
+	const dependencies = createReaderCollection({
+		name: `Dependency reader collection for project ${rootProject.getName()}`,
+		readers,
+	});
+
+	const rootReader = rootProject.getReader({ style: "runtime" });
+
+	// TODO change to ReaderCollection once duplicates are sorted out
+	const combo = createReaderCollection({
+		name: "server - prioritize workspace over dependencies",
+		readers: [rootReader, dependencies],
+	});
+	const resources = {
+		rootProject: rootReader,
+		dependencies: dependencies,
+		all: combo,
+	};
+
+	// TODO: rework ui5-server API and make public
+	const MiddlewareManager = (await import("@ui5/server/internal/MiddlewareManager")).default;
+	const middlewareManager = new MiddlewareManager({
+		graph,
+		rootProject,
+		resources,
+		options: {
+			//sendSAPTargetCSP,
+			//serveCSPReports,
+			//simpleIndex: true
+		},
+	});
+	await middlewareManager.applyMiddleware(router);
+
+	return await rootReader.byGlob("**/*.html");
+};

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "cds-plugin-ui5",
+  "version": "0.1.0",
+  "description": "A CAP server cds-plugin to inject the middlewares of all related UI5 tooling based projects.",
+  "author": "Peter Muessig",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ui5-community/ui5-ecosystem-showcase.git",
+    "directory": "packages/cds-plugin-ui5"
+  },
+  "dependencies": {
+    "@ui5/fs": "^3.0.3",
+    "@ui5/project": "^3.3.0",
+    "@ui5/server": "^3.1.2",
+    "js-yaml": "^4.1.0"
+  },
+  "devDependencies": {
+    "@sap/cds": "^6.8.1",
+    "express": "^4.18.2"
+  },
+  "peerDependencies": {
+    "@sap/cds": ">=6.8.1",
+    "express": ">=4.18.2"
+  },
+  "gitHead": "4284aeb6a796456dba9e0ef4f6a2a8d7fd064f3d"
+}