project/lib/ui5Framework/AbstractResolver.js

  1. const path = require("path");
  2. const log = require("@ui5/logger").getLogger("ui5Framework:AbstractResolver");
  3. const semver = require("semver");
  5. // Matches Semantic Versioning 2.0.0 versions
  6. // https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
  7. //
  8. // This needs to be aligned with the ui5.yaml JSON schema:
  9. // lib/validation/schema/specVersion/2.0/kind/project.json#/definitions/framework/properties/version/pattern
  10. //
  11. // eslint-disable-next-line max-len
  12. const SEMVER_VERSION_REGEXP = /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/;
  14. // Reduced Semantic Versioning pattern
  15. // Matches MAJOR.MINOR as a simple version range to be resolved to the latest patch
  16. const VERSION_RANGE_REGEXP = /^(0|[1-9]\d*)\.(0|[1-9]\d*)$/;
  18. /**
  19.  * Abstract Resolver
  20.  *
  21.  * @public
  22.  * @abstract
  23.  * @memberof module:@ui5/project.ui5Framework
  24.  */
  25. class AbstractResolver {
  26. 	/**
  27. 	 * @param {*} options options
  28. 	 * @param {string} options.version Framework version to use
  29. 	 * @param {string} [options.cwd=process.cwd()] Working directory to resolve configurations like .npmrc
  30. 	 * @param {string} [options.ui5HomeDir="~/.ui5"] UI5 home directory location. This will be used to store packages,
  31. 	 * metadata and configuration used by the resolvers. Relative to `process.cwd()`
  32. 	 */
  33. 	constructor({cwd, version, ui5HomeDir}) {
  34. 		if (new.target === AbstractResolver) {
  35. 			throw new TypeError("Class 'AbstractResolver' is abstract");
  36. 		}
  38. 		if (!version) {
  39. 			throw new Error(`AbstractResolver: Missing parameter "version"`);
  40. 		}
  42. 		this._ui5HomeDir = ui5HomeDir ? path.resolve(ui5HomeDir) : path.join(require("os").homedir(), ".ui5");
  43. 		this._cwd = cwd ? path.resolve(cwd) : process.cwd();
  44. 		this._version = version;
  45. 	}
  47. 	async _processLibrary(libraryName, libraryMetadata, errors) {
  48. 		// Check if library is already processed
  49. 		if (libraryMetadata[libraryName]) {
  50. 			return;
  51. 		}
  52. 		// Mark library as handled
  53. 		libraryMetadata[libraryName] = {};
  55. 		log.verbose("Processing " + libraryName);
  57. 		const promises = await this.handleLibrary(libraryName);
  59. 		const [metadata, {pkgPath}] = await Promise.all([
  60. 			promises.metadata.then((metadata) =>
  61. 				this._processDependencies(libraryName, metadata, libraryMetadata, errors)),
  62. 			promises.install
  63. 		]);
  65. 		// Add path to installed package to metadata
  66. 		metadata.path = pkgPath;
  68. 		// Add metadata entry
  69. 		libraryMetadata[libraryName] = metadata;
  70. 	}
  72. 	async _processDependencies(libraryName, metadata, libraryMetadata, errors) {
  73. 		if (metadata.dependencies.length > 0) {
  74. 			log.verbose("Processing dependencies of " + libraryName);
  75. 			await this._processLibraries(metadata.dependencies, libraryMetadata, errors);
  76. 			log.verbose("Done processing dependencies of " + libraryName);
  77. 		}
  78. 		return metadata;
  79. 	}
  81. 	async _processLibraries(libraryNames, libraryMetadata, errors) {
  82. 		const results = await Promise.all(libraryNames.map(async (libraryName) => {
  83. 			try {
  84. 				await this._processLibrary(libraryName, libraryMetadata, errors);
  85. 			} catch (err) {
  86. 				log.verbose(`Failed to process library ${libraryName}`);
  87. 				log.verbose(`Error: ${err.message}`);
  88. 				log.verbose(`Call stack: ${err.stack}`);
  89. 				return `Failed to resolve library ${libraryName}: ${err.message}`;
  90. 			}
  91. 		}));
  92. 		// Don't add empty results (success)
  93. 		errors.push(...results.filter(($) => $));
  94. 	}
  96. 	/**
  97. 	 * Library metadata entry
  98. 	 *
  99. 	 * @example
  100. 	 * const libraryMetadataEntry = {
  101. 	 *		"id": "@openui5/sap.ui.core",
  102. 	 *		"version": "1.75.0",
  103. 	 *		"path": "~/.ui5/framework/packages/@openui5/sap.ui.core/1.75.0",
  104. 	 *		"dependencies": [],
  105. 	 *		"optionalDependencies": []
  106. 	 * };
  107. 	 *
  108. 	 * @public
  109. 	 * @typedef {object} LibraryMetadataEntry
  110. 	 * @property {string} id Identifier
  111. 	 * @property {string} version Version
  112. 	 * @property {string} path Path
  113. 	 * @property {string[]} dependencies List of dependency ids
  114. 	 * @property {string[]} optionalDependencies List of optional dependency ids
  115. 	 * @memberof module:@ui5/project.ui5Framework
  116. 	 */
  117. 	/**
  118. 	 * Install result
  119. 	 *
  120. 	 * @example
  121. 	 * const resolverInstallResult = {
  122. 	 * 	"libraryMetadata": {
  123. 	 * 		"sap.ui.core": {
  124. 	 * 			// ...
  125. 	 * 		},
  126. 	 * 		"sap.m": {
  127. 	 * 			// ...
  128. 	 * 		}
  129. 	 * 	}
  130. 	 * };
  131. 	 *
  132. 	 * @public
  133. 	 * @typedef {object} ResolverInstallResult
  134. 	 * @property {object.<string, module:@ui5/project.ui5Framework.LibraryMetadataEntry>} libraryMetadata
  135. 	 *   Object containing all installed libraries with library name as key
  136. 	 * @memberof module:@ui5/project.ui5Framework
  137. 	 */
  138. 	/**
  139. 	 * Installs the provided libraries and their dependencies
  140. 	 *
  141. 	 * @example
  142. 	 * const resolver = new Sapui5Resolver({version: "1.76.0"});
  143. 	 * // Or for OpenUI5:
  144. 	 * // const resolver = new Openui5Resolver({version: "1.76.0"});
  145. 	 *
  146. 	 * resolver.install(["sap.ui.core", "sap.m"]).then(({libraryMetadata}) => {
  147. 	 * 	// Installation done
  148. 	 * }).catch((err) => {
  149. 	 * 	// Handle installation errors
  150. 	 * });
  151. 	 *
  152. 	 * @public
  153. 	 * @param {string[]} libraryNames List of library names to be installed
  154. 	 * @returns {module:@ui5/project.ui5Framework.ResolverInstallResult}
  155. 	 *   Resolves with an object containing the <code>libraryMetadata</code>
  156. 	 */
  157. 	async install(libraryNames) {
  158. 		const libraryMetadata = {};
  159. 		const errors = [];
  161. 		await this._processLibraries(libraryNames, libraryMetadata, errors);
  163. 		if (errors.length > 0) {
  164. 			throw new Error("Resolution of framework libraries failed with errors:\n" + errors.join("\n"));
  165. 		}
  167. 		return {
  168. 			libraryMetadata
  169. 		};
  170. 	}
  172. 	static async resolveVersion(version, {ui5HomeDir, cwd} = {}) {
  173. 		let spec;
  174. 		if (version === "latest") {
  175. 			spec = "*";
  176. 		} else if (VERSION_RANGE_REGEXP.test(version) || SEMVER_VERSION_REGEXP.test(version)) {
  177. 			spec = version;
  178. 		} else {
  179. 			throw new Error(`Framework version specifier "${version}" is incorrect or not supported`);
  180. 		}
  181. 		const versions = await this.fetchAllVersions({ui5HomeDir, cwd});
  182. 		const resolvedVersion = semver.maxSatisfying(versions, spec);
  183. 		if (!resolvedVersion) {
  184. 			if (semver.valid(spec)) {
  185. 				if (this.name === "Sapui5Resolver" && semver.lt(spec, "1.76.0")) {
  186. 					throw new Error(`Could not resolve framework version ${version}. ` +
  187. 						`Note that SAPUI5 framework libraries can only be consumed by the UI5 Tooling ` +
  188. 						`starting with SAPUI5 v1.76.0`);
  189. 				} else if (this.name === "Openui5Resolver" && semver.lt(spec, "1.52.5")) {
  190. 					throw new Error(`Could not resolve framework version ${version}. ` +
  191. 						`Note that OpenUI5 framework libraries can only be consumed by the UI5 Tooling ` +
  192. 						`starting with OpenUI5 v1.52.5`);
  193. 				}
  194. 			}
  195. 			throw new Error(`Could not resolve framework version ${version}`);
  196. 		}
  197. 		return resolvedVersion;
  198. 	}
  200. 	// To be implemented by resolver
  201. 	async getLibraryMetadata(libraryName) {
  202. 		throw new Error("AbstractResolver: getLibraryMetadata must be implemented!");
  203. 	}
  204. 	async handleLibrary(libraryName) {
  205. 		throw new Error("AbstractResolver: handleLibrary must be implemented!");
  206. 	}
  207. 	static fetchAllVersions(options) {
  208. 		throw new Error("AbstractResolver: static fetchAllVersions must be implemented!");
  209. 	}
  210. }
  212. if (process.env.NODE_ENV === "test") {
  213. 	// Export pattern for testing to be checked against JSON schema pattern
  214. 	AbstractResolver._SEMVER_VERSION_REGEXP = SEMVER_VERSION_REGEXP;
  215. }
  217. module.exports = AbstractResolver;