Refactor Module. Add support for dependency and collection shims

Author: RandomByte

lib/Module.js renamed to lib/graph/Module.js

@@ -4,12 +4,12 @@ const {promisify} = require("util");
 const readFile = promisify(fs.readFile);
 const jsyaml = require("js-yaml");
 const resourceFactory = require("@ui5/fs").resourceFactory;
-const Project = require("./specifications/Project");
-const Extension = require("./specifications/Extension");
-const Configuration = require("./specifications/Configuration");
-const {validate} = require("./validation/validator");
+const Project = require("../specifications/Project");
+const Extension = require("../specifications/Extension");
+const Configuration = require("../specifications/Configuration");
+const {validate} = require("../validation/validator");
 
-const log = require("@ui5/logger").getLogger("Module");
+const log = require("@ui5/logger").getLogger("graph:Module");
 
 const defaultConfigPath = "ui5.yaml";
 
@@ -26,12 +26,12 @@ class Module {
 	 * @param {string} [parameters.configPath=ui5.yaml]
 	 *						Either a path relative to `modulePath` which will be resolved by @ui5/fs (default),
 	 *						or an absolute File System path to the project configuration file.
-	 * @param {object} [parameters.configuration]
-	 * 						Configuration object to use. If supplied, no ui5.yaml will be read
+	 * @param {object|object[]} [parameters.configuration]
+	 * 						Configuration object or array of objects to use. If supplied, no ui5.yaml will be read
 	 * @param {@ui5/project.graph.ShimCollection} [parameters.shimCollection]
 	 *						Collection of shims that might be relevant for this module
 	 */
-	constructor({id, version, modulePath, configPath = defaultConfigPath, configuration, shimCollection}) {
+	constructor({id, version, modulePath, configPath = defaultConfigPath, configuration = [], shimCollection}) {
 		if (!id) {
 			throw new Error(`Could not create Module: Missing or empty parameter 'id'`);
 		}
@@ -47,7 +47,11 @@ class Module {
 		this._modulePath = modulePath;
 		this._configPath = configPath;
 		this._dependencies = {};
-		this._suppliedConfig = configuration;
+
+		if (!Array.isArray(configuration)) {
+			configuration = [configuration];
+		}
+		this._suppliedConfigs = configuration;
 
 		if (shimCollection) {
 			// Retrieve and clone shims in constructor
@@ -80,61 +84,74 @@ class Module {
 		return this._modulePath;
 	}
 
-	getDependencies() {
-		return [];
+	async getSpecifications() {
+		if (this._pGetSpecifications) {
+			return this._pGetSpecifications;
+		}
+
+		return this._pGetSpecifications = this._getSpecifications();
 	}
 
-	async getProject() {
-		const configs = await this.getConfigurations();
-		// getConfigurations promises us to return none or exactly one project configuration
-		const projectConfig = configs.find((config) => {
-			return config.getKind() === "project";
-		});
+	async _getSpecifications() {
+		const configs = await this._getConfigurations();
 
-		if (projectConfig) {
-			return new Project({
-				id: this.getId(),
-				version: this.getVersion(),
-				modulePath: this.getPath(),
-				configuration: projectConfig
-			});
-		}
-	}
+		let project;
+		const extensions = [];
+		configs.forEach((configuration) => {
+			const kind = configuration.getKind();
 
-	async getExtensions() {
-		const configs = await this.getConfigurations();
-		const extensionConfigs = configs.filter((config) => {
-			return config.getKind() === "extension";
-		});
-		return extensionConfigs.map((config) => {
-			return new Extension({
-				id: this.getId(),
-				version: this.getVersion(),
-				modulePath: this.getPath(),
-				configuration: config
-			});
+			switch (kind) {
+			case "project":
+				if (project) {
+					throw new Error(
+						`Invalid configuration for module ${this.getId()}: Per module there ` +
+						`must be no more than one configuration of kind 'project'`);
+				}
+				log.verbose(`Module ${this.getId()} contains project ${configuration.getName()}`);
+				project = new Project({
+					id: this.getId(),
+					version: this.getVersion(),
+					modulePath: this.getPath(),
+					configuration
+				});
+				break;
+			case "extension":
+				log.verbose(`Module ${this.getId()} contains extension ${configuration.getName()}`);
+				extensions.push(new Extension({
+					id: this.getId(),
+					version: this.getVersion(),
+					modulePath: this.getPath(),
+					configuration
+				}));
+				break;
+			default:
+				throw new Error(
+					`Encountered unexpected specification configuration of kind ${kind} ` +
+					`Supported kinds are 'project' and 'extension'`);
+			}
 		});
+
+		return {
+			project,
+			extensions
+		};
 	}
 
 	/**
 	* Configuration
 	*/
-	async getConfigurations() {
-		if (this._pGetConfigurations) {
-			return this._pGetConfigurations;
-		}
-
-		return this._pGetConfigurations = this._getConfigurations();
-	}
-
 	async _getConfigurations() {
 		let configurations;
-		if (this._suppliedConfig) {
-			configurations = [await this._createConfigurationInstance(this._suppliedConfig)];
-		} else {
-			configurations = await this._loadProjectConfiguration();
+
+		configurations = await this._getSuppliedConfigurations();
+
+		if (!configurations || !configurations.length) {
+			configurations = await this._getYamlConfigurations();
 		}
-		return configurations;
+		if (!configurations || !configurations.length) {
+			configurations = await this._getShimConfigurations();
+		}
+		return configurations || [];
 	}
 
 	async _createConfigurationInstance(config) {
@@ -146,7 +163,7 @@ class Module {
 		return new Configuration(config);
 	}
 
-	async _createProjectConfigurationFromShim() {
+	async _createConfigurationFromShim() {
 		const config = this._applyShims();
 		if (config) {
 			this._normalizeConfig(config);
@@ -166,16 +183,30 @@ class Module {
 		return config;
 	}
 
-	async _loadProjectConfiguration() {
+	async _getSuppliedConfigurations() {
+		if (this._suppliedConfigs.length) {
+			log.verbose(`Configuration for module ${this.getId()} has been supplied directly`);
+			return await Promise.all(this._suppliedConfigs.map(async (config) => {
+				return this._createConfigurationInstance(config);
+			}));
+		}
+	}
+
+	async _getShimConfigurations() {
+		// No project configuration found
+		//	=> Try to create one from shims
+		const shimConfiguration = await this._createConfigurationFromShim();
+		if (shimConfiguration) {
+			log.verbose(`Created configuration from shim extensions for module ${this.getId()}`);
+			return [shimConfiguration];
+		}
+	}
+
+	async _getYamlConfigurations() {
 		const configs = await this._readConfigFile();
 
 		if (!configs || !configs.length) {
-			// No project configuration found
-			//	=> Try to create one from shims
-			const shimConfiguration = await this._createProjectConfigurationFromShim();
-			if (shimConfiguration) {
-				return [shimConfiguration];
-			}
+			log.verbose(`Could not find a configuration file for module ${this.getId()}`);
 			return [];
 		}
 
@@ -209,13 +240,6 @@ class Module {
 		const configurations = [];
 		if (projectConfigs.length) {
 			configurations.push(await this._createConfigurationInstance(projectConfigs[0]));
-		} else {
-			// No project configuration found
-			//	=> Try to create one from shims
-			const shimConfiguration = await this._createProjectConfigurationFromShim();
-			if (shimConfiguration) {
-				configurations.push(shimConfiguration);
-			}
 		}
 
 		await Promise.all(extensionConfigs.map(async (config) => {

lib/graph/ProjectGraph.js

@@ -81,6 +81,9 @@ class ProjectGraph {
 		}
 	}
 
+	getDependencies(projectName) {
+		return Object.keys(this._adjList[projectName]);
+	}
 
 	/**
 	 * Callback for graph traversal operations
@@ -147,7 +150,7 @@ class ProjectGraph {
 
 				return visited[projectName] = (async () => {
 					const newPredecessors = [...predecessors, projectName];
-					const dependencies = Object.keys(this._adjList[projectName]);
+					const dependencies = this.getDependencies(projectName);
 
 					queue.push({
 						projectNames: dependencies,
@@ -194,7 +197,7 @@ class ProjectGraph {
 		}
 		return visited[projectName] = (async () => {
 			const newPredecessors = [...predecessors, projectName];
-			const dependencies = Object.keys(this._adjList[projectName]);
+			const dependencies = this.getDependencies(projectName);
 			await Promise.all(dependencies.map((depName) => {
 				return this._traverseDepthFirst(depName, visited, newPredecessors, callback);
 			}));

lib/graph/ShimCollection.js

@@ -40,8 +40,8 @@ class ShimCollection {
 		return this._configShims[moduleId];
 	}
 
-	getDependencyShims(moduleId) {
-		return this._dependencyShims[moduleId];
+	getAllDependencyShims() {
+		return this._dependencyShims;
 	}
 
 	getCollectionShims(moduleId) {