project/lib/ui5Framework/Sapui5Resolver.js

  1. import path from "node:path";
  2. import os from "node:os";
  3. import semver from "semver";
  4. import AbstractResolver from "./AbstractResolver.js";
  5. import Installer from "./npm/Installer.js";
  6. import {getLogger} from "@ui5/logger";
  7. const log = getLogger("ui5Framework:Sapui5Resolver");
  9. const DIST_PKG_NAME = "@sapui5/distribution-metadata";
  11. /**
  12.  * Resolver for the SAPUI5 framework
  13.  *
  14.  * @public
  15.  * @class
  16.  * @alias @ui5/project/ui5Framework/Sapui5Resolver
  17.  * @extends @ui5/project/ui5Framework/AbstractResolver
  18.  */
  19. class Sapui5Resolver extends AbstractResolver {
  20. 	/**
  21. 	 * @param {*} options options
  22. 	 * @param {string} options.version SAPUI5 version to use
  23. 	 * @param {string} [options.cwd=process.cwd()] Working directory to resolve configurations like .npmrc
  24. 	 * @param {string} [options.ui5HomeDir="~/.ui5"] UI5 home directory location. This will be used to store packages,
  25. 	 * metadata and configuration used by the resolvers. Relative to `process.cwd()`
  26. 	 * @param {string} [options.cacheDir] Where to store temp/cached packages.
  27. 	 * @param {string} [options.packagesDir] Where to install packages
  28. 	 * @param {string} [options.stagingDir] The staging directory for packages
  29. 	 */
  30. 	constructor(options) {
  31. 		super(options);
  33. 		const {cacheDir, packagesDir, stagingDir} = options;
  35. 		this._installer = new Installer({
  36. 			cwd: this._cwd,
  37. 			ui5HomeDir: this._ui5HomeDir,
  38. 			cacheDir, packagesDir, stagingDir
  39. 		});
  40. 		this._loadDistMetadata = null;
  41. 	}
  42. 	loadDistMetadata() {
  43. 		if (!this._loadDistMetadata) {
  44. 			this._loadDistMetadata = Promise.resolve().then(async () => {
  45. 				const version = this._version;
  46. 				log.verbose(`Installing ${DIST_PKG_NAME} in version ${version}...`);
  47. 				const pkgName = DIST_PKG_NAME;
  48. 				const {pkgPath} = await this._installer.installPackage({
  49. 					pkgName,
  50. 					version
  51. 				});
  53. 				const metadata = await this._installer.readJson(path.join(pkgPath, "metadata.json"));
  54. 				return metadata;
  55. 			});
  56. 		}
  57. 		return this._loadDistMetadata;
  58. 	}
  59. 	async getLibraryMetadata(libraryName) {
  60. 		const distMetadata = await this.loadDistMetadata();
  61. 		const metadata = distMetadata.libraries[libraryName];
  63. 		if (!metadata) {
  64. 			throw new Error(`Could not find library "${libraryName}"`);
  65. 		}
  67. 		if (metadata.npmPackageName.startsWith("@openui5/") &&
  68. 				semver.satisfies(this._version, "1.77.x")) {
  69. 			// TODO: Remove this workaround once SAPUI5 1.77.x isn't used anymore.
  70. 			//       As of Dec 2022 there are still ~80 downloads per week (npmjs.com stats).
  71. 			// 1.77.x (at least 1.77.0-1.77.2) distribution metadata.json is missing
  72. 			//	dependency information for all OpenUI5 libraries.
  73. 			// Therefore we need to request those from the registry like it is done
  74. 			//	for OpenUI5 projects.
  75. 			const {default: Openui5Resolver} = await import("./Openui5Resolver.js");
  76. 			const openui5Resolver = new Openui5Resolver({
  77. 				cwd: this._cwd,
  78. 				version: metadata.version
  79. 			});
  80. 			const openui5Metadata = await openui5Resolver.getLibraryMetadata(libraryName);
  81. 			return {
  82. 				npmPackageName: openui5Metadata.id,
  83. 				version: openui5Metadata.version,
  84. 				dependencies: openui5Metadata.dependencies,
  85. 				optionalDependencies: openui5Metadata.optionalDependencies
  86. 			};
  87. 		}
  89. 		return metadata;
  90. 	}
  91. 	async handleLibrary(libraryName) {
  92. 		const metadata = await this.getLibraryMetadata(libraryName);
  94. 		return {
  95. 			metadata: Promise.resolve({
  96. 				id: metadata.npmPackageName,
  97. 				version: metadata.version,
  98. 				dependencies: metadata.dependencies,
  99. 				optionalDependencies: metadata.optionalDependencies
  100. 			}),
  101. 			// Trigger installation of package
  102. 			install: this._installer.installPackage({
  103. 				pkgName: metadata.npmPackageName,
  104. 				version: metadata.version
  105. 			})
  106. 		};
  107. 	}
  108. 	static async fetchAllVersions(options) {
  109. 		const installer = this._getInstaller(options);
  110. 		return await installer.fetchPackageVersions({pkgName: DIST_PKG_NAME});
  111. 	}
  113. 	static async fetchAllTags(options) {
  114. 		const installer = this._getInstaller(options);
  115. 		return installer.fetchPackageDistTags({pkgName: DIST_PKG_NAME});
  116. 	}
  118. 	static _getInstaller({ui5HomeDir, cwd} = {}) {
  119. 		return new Installer({
  120. 			cwd: cwd ? path.resolve(cwd) : process.cwd(),
  121. 			ui5HomeDir:
  122. 				ui5HomeDir ? path.resolve(ui5HomeDir) :
  123. 					path.join(os.homedir(), ".ui5")
  124. 		});
  125. 	}
  126. }
  128. export default Sapui5Resolver;