[INTERNAL] ui5framework resolvers: Add resolveVersion/getLibraryMetadata

Author: matz3

lib/ui5Framework/AbstractResolver.js

@@ -1,5 +1,8 @@
 const path = require("path");
 const log = require("@ui5/logger").getLogger("ui5Framework:AbstractResolver");
+const semver = require("semver");
+
+const versionRegExp = /^(0|[1-9]\d*)\.(0|[1-9]\d*)(?:\.(0|[1-9]\d*))?$/;
 
 /**
  * Abstract Resolver
@@ -151,10 +154,38 @@ class AbstractResolver {
 		};
 	}
 
+	/**
+	 *
+	 * @param {string} version
+	 * @param {Object} options
+	 */
+	static async resolveVersion(version, {ui5HomeDir, cwd} = {}) {
+		let spec;
+		if (version === "latest") {
+			spec = "*";
+		} else if (versionRegExp.test(version)) {
+			spec = version;
+		} else {
+			throw new Error(`Framework version specifier "${version}" is incorrect or not supported`);
+		}
+		const versions = await this.fetchAllVersions({ui5HomeDir, cwd});
+		const resolvedVersion = semver.maxSatisfying(versions, spec);
+		if (!resolvedVersion) {
+			throw new Error(`Could not resolve framework version ${version}`);
+		}
+		return resolvedVersion;
+	}
+
 	// To be implemented by resolver
+	async getLibraryMetadata(libraryName) {
+		throw new Error("AbstractResolver: getLibraryMetadata must be implemented!");
+	}
 	async handleLibrary(libraryName) {
 		throw new Error("AbstractResolver: handleLibrary must be implemented!");
 	}
+	static fetchAllVersions(options) {
+		throw new Error("AbstractResolver: static fetchAllVersions must be implemented!");
+	}
 }
 
 module.exports = AbstractResolver;

lib/ui5Framework/Openui5Resolver.js

@@ -1,6 +1,11 @@
+const path = require("path");
+
 const AbstractResolver = require("./AbstractResolver");
 const Installer = require("./npm/Installer");
 
+const OPENUI5_CORE_PACKAGE = "@openui5/sap.ui.core";
+
+
 /**
  * Resolver for the OpenUI5 framework
  *
@@ -30,7 +35,7 @@ class Openui5Resolver extends AbstractResolver {
 	static _getLibaryName(pkgName) {
 		return pkgName.replace(/^@openui5\//, "");
 	}
-	_getLibraryMetadata(libraryName) {
+	getLibraryMetadata(libraryName) {
 		if (!this._loadLibraryMetadata[libraryName]) {
 			this._loadLibraryMetadata[libraryName] = Promise.resolve().then(async () => {
 				// Trigger manifest request to gather transitive dependencies
@@ -64,14 +69,23 @@ class Openui5Resolver extends AbstractResolver {
 		const pkgName = Openui5Resolver._getNpmPackageName(libraryName);
 		return {
 			// Trigger metadata request
-			metadata: this._getLibraryMetadata(libraryName),
+			metadata: this.getLibraryMetadata(libraryName),
 			// Also trigger installation of package
 			install: this._installer.installPackage({
 				pkgName,
 				version: this._version
 			})
 		};
 	}
+	static async fetchAllVersions({ui5HomeDir, cwd} = {}) {
+		const installer = new Installer({
+			cwd: cwd ? path.resolve(cwd) : process.cwd(),
+			ui5HomeDir:
+				ui5HomeDir ? path.resolve(ui5HomeDir) :
+					path.join(require("os").homedir(), ".ui5")
+		});
+		return await installer.fetchPackageVersions({pkgName: OPENUI5_CORE_PACKAGE});
+	}
 }
 
 module.exports = Openui5Resolver;

lib/ui5Framework/Sapui5Resolver.js

@@ -45,12 +45,16 @@ class Sapui5Resolver extends AbstractResolver {
 		}
 		return this._loadDistMetadata;
 	}
-	async handleLibrary(libraryName) {
+	async getLibraryMetadata(libraryName) {
 		const distMetadata = await this.loadDistMetadata();
 		const metadata = distMetadata.libraries[libraryName];
 		if (!metadata) {
 			throw new Error(`Could not find library "${libraryName}"`);
 		}
+		return metadata;
+	}
+	async handleLibrary(libraryName) {
+		const metadata = await this.getLibraryMetadata(libraryName);
 
 		return {
 			metadata: Promise.resolve({
@@ -66,6 +70,15 @@ class Sapui5Resolver extends AbstractResolver {
 			})
 		};
 	}
+	static async fetchAllVersions({ui5HomeDir, cwd} = {}) {
+		const installer = new Installer({
+			cwd: cwd ? path.resolve(cwd) : process.cwd(),
+			ui5HomeDir:
+				ui5HomeDir ? path.resolve(ui5HomeDir) :
+					path.join(require("os").homedir(), ".ui5")
+		});
+		return await installer.fetchPackageVersions({pkgName: DIST_PKG_NAME});
+	}
 }
 
 module.exports = Sapui5Resolver;

lib/ui5Framework/npm/Installer.js

@@ -31,6 +31,11 @@ class Installer {
 		return JSON.parse(await readFile(jsonPath, {encoding: "utf8"}));
 	}
 
+	async fetchPackageVersions({pkgName}) {
+		const packument = await this._registry.requestPackagePackument(pkgName);
+		return Object.keys(packument.versions);
+	}
+
 	async fetchPackageManifest({pkgName, version}) {
 		const targetDir = this._getTargetDirForPackage({pkgName, version});
 		try {

lib/ui5Framework/npm/Registry.js

@@ -13,6 +13,9 @@ class Registry {
 		this._cwd = cwd;
 		this._cacheDir = cacheDir;
 	}
+	requestPackagePackument(pkgName) {
+		return this._pacote.packument(pkgName, this._getPacoteOptions());
+	}
 	requestPackageManifest(pkgName, version) {
 		return this._pacote.manifest(`${pkgName}@${version}`, this._getPacoteOptions());
 	}

package-lock.json

@@ -115,6 +115,7 @@
 		"read-pkg": "^5.2.0",
 		"read-pkg-up": "^7.0.1",
 		"resolve": "^1.15.1",
+		"semver": "^7.1.3",
 		"string.prototype.matchall": "^4.0.2"
 	},
 	"devDependencies": {