[FEATURE][PoC] Add UI5 Workspace support

Implementing UI5/cli#157

Author: RandomByte

lib/graph/Workspace.js

@@ -0,0 +1,113 @@
+import fs from "graceful-fs";
+import path from "node:path";
+import {promisify} from "node:util";
+import logger from "@ui5/logger";
+
+const readFile = promisify(fs.readFile);
+const log = logger.getLogger("graph:Workspace");
+
+/**
+ * Workspace representation
+ *
+ * @public
+ * @class
+ * @alias @ui5/project/graph/Workspace
+ */
+class Workspace {
+	/**
+	 * @param {object} options
+	 * @param {object} options.cwd
+	 * @param {object} options.workspaceConfiguration Workspace configuration
+	 * @param {string} options.workspaceConfiguration.specVersion
+	 * @param {object} options.workspaceConfiguration.metadata
+	 * @param {object} options.workspaceConfiguration.dependencyManagement
+	 */
+	constructor({cwd, workspaceConfiguration}) {
+		const {specVersion, metadata, dependencyManagement} = workspaceConfiguration;
+		if (!cwd || !specVersion || !metadata?.name) {
+			throw new Error("[Workspace] One or more mandatory parameters not provided");
+		}
+
+		this._name = metadata.name;
+		this._cwd = cwd;
+		this._dependencyManagement = dependencyManagement;
+	}
+
+	async getNode(id) {
+		const nodes = await this._resolveDependencyResolutionPaths();
+		return nodes[id];
+	}
+
+	_getResolvedNodes() {
+		if (this._pResolvedNodes) {
+			return this._pResolvedNodes;
+		}
+
+		return this._pResolvedNodes = this._resolveNodes();
+	}
+	async _resolveNodes() {
+		if (!this._dependencyManagement?.resolutions?.length) {
+			return [];
+		}
+
+		const resolvedNodes = await Promise.all(this._dependencyManagement.resolutions.map(async (resolutionConfig) => {
+			if (!resolutionConfig.path) {
+				throw new Error(
+					`Missing property 'path' in dependency resolution configuration of workspace ${this._name}`);
+			}
+			const nodes = await this._getNodesFromPath(resolutionConfig.path);
+
+			if (!Array.isArray(nodes) && resolutionConfig.configuration) {
+				nodes.configuration = resolutionConfig.configuration;
+			}
+			return nodes;
+		}));
+
+		// Flatten array since workspaces might have lead to nested arrays
+		return Array.prototype.concat.apply([], resolvedNodes);
+	}
+
+	async _getNodesFromPath(cwd, relPath, resolveWorkspace = true) {
+		const nodePath = path.join(this._cwd, relPath);
+		const pkg = await this._readPackageJson(nodePath);
+		if (pkg.workspaces?.length) {
+			if (!resolveWorkspace) {
+				log.info(`Ignoring nested package workspace of module ${pkg.name} at ${nodePath}`);
+				return [];
+			}
+			return Promise.all(pkg.workspaces.map(async (workspacePath) => {
+				const nodes = this._getNodesFromPath(nodePath, workspacePath, false);
+				if (nodes.lengh > 1) {
+					throw new Error(
+						`Package workspace of module ${pkg.name} at ${nodePath} ` +
+						`unexpectedly resolved to multiple modules`);
+				}
+				return nodes[0];
+			}));
+		} else {
+			return this._getNodeFromPackage(pkg, nodePath);
+		}
+	}
+
+	_getNodeFromPackage(pkg, path) {
+		return {
+			id: pkg.name,
+			version: pkg.version,
+			path: path
+		};
+	}
+
+	/**
+	 * Reads the package.json file and returns its content
+	 *
+	 * @private
+	 * @param {string} modulePath Path to the module containing the package.json
+	 * @returns {object} Package json content
+	 */
+	async _readPackageJson(modulePath) {
+		const content = await readFile(path.join(modulePath, "package.json"), "utf8");
+		return JSON.parse(content);
+	}
+}
+
+export default Workspace;

lib/graph/projectGraphBuilder.js

@@ -95,9 +95,10 @@ function validateNode(node) {
  * @function default
  * @static
  * @param {@ui5/project/graph/ProjectGraphBuilder~NodeProvider} nodeProvider
+ * @param {@ui5/project/graph/Workspace} workspace
  * @returns {@ui5/project/graph/ProjectGraph} A new project graph instance
  */
-async function projectGraphBuilder(nodeProvider) {
+async function projectGraphBuilder(nodeProvider, workspace) {
 	const shimCollection = new ShimCollection();
 	const moduleCollection = {};