project/lib/ui5Framework/Sapui5Resolver.js

  1. const path = require("path");
  2. const semver = require("semver");
  3. const AbstractResolver = require("./AbstractResolver");
  4. const Installer = require("./npm/Installer");
  5. const log = require("@ui5/logger").getLogger("normalizer:ui5Framework:Sapui5Resolver");
  7. const DIST_PKG_NAME = "@sapui5/distribution-metadata";
  9. /**
  10.  * Resolver for the SAPUI5 framework
  11.  *
  12.  * @public
  13.  * @memberof module:@ui5/project.ui5Framework
  14.  * @augments  module:@ui5/project.ui5Framework.AbstractResolver
  15.  */
  16. class Sapui5Resolver extends AbstractResolver {
  17. 	/**
  18. 	 * @param {*} options options
  19. 	 * @param {string} options.version SAPUI5 version to use
  20. 	 * @param {string} [options.cwd=process.cwd()] Working directory to resolve configurations like .npmrc
  21. 	 * @param {string} [options.ui5HomeDir="~/.ui5"] UI5 home directory location. This will be used to store packages,
  22. 	 * metadata and configuration used by the resolvers. Relative to `process.cwd()`
  23. 	 */
  24. 	constructor(options) {
  25. 		super(options);
  27. 		this._installer = new Installer({
  28. 			cwd: this._cwd,
  29. 			ui5HomeDir: this._ui5HomeDir
  30. 		});
  31. 		this._loadDistMetadata = null;
  32. 	}
  33. 	loadDistMetadata() {
  34. 		if (!this._loadDistMetadata) {
  35. 			this._loadDistMetadata = Promise.resolve().then(async () => {
  36. 				const version = this._version;
  37. 				log.verbose(`Installing ${DIST_PKG_NAME} in version ${version}...`);
  38. 				const pkgName = DIST_PKG_NAME;
  39. 				const {pkgPath} = await this._installer.installPackage({
  40. 					pkgName,
  41. 					version
  42. 				});
  44. 				const metadata = await this._installer.readJson(path.join(pkgPath, "metadata.json"));
  45. 				return metadata;
  46. 			});
  47. 		}
  48. 		return this._loadDistMetadata;
  49. 	}
  50. 	async getLibraryMetadata(libraryName) {
  51. 		const distMetadata = await this.loadDistMetadata();
  52. 		const metadata = distMetadata.libraries[libraryName];
  54. 		if (!metadata) {
  55. 			throw new Error(`Could not find library "${libraryName}"`);
  56. 		}
  58. 		if (metadata.npmPackageName.startsWith("@openui5/") &&
  59. 				semver.satisfies(this._version, "1.77.x")) {
  60. 			// TODO 3.0: Remove this workaround
  61. 			// 1.77.x (at least 1.77.0-1.77.2) distribution metadata.json is missing
  62. 			//	dependency information for all OpenUI5 libraries.
  63. 			// Therefore we need to request those from the registry like it is done
  64. 			//	for OpenUI5 projects.
  65. 			const Openui5Resolver = require("./Openui5Resolver");
  66. 			const openui5Resolver = new Openui5Resolver({
  67. 				cwd: this._cwd,
  68. 				version: metadata.version
  69. 			});
  70. 			const openui5Metadata = await openui5Resolver.getLibraryMetadata(libraryName);
  71. 			return {
  72. 				npmPackageName: openui5Metadata.id,
  73. 				version: openui5Metadata.version,
  74. 				dependencies: openui5Metadata.dependencies,
  75. 				optionalDependencies: openui5Metadata.optionalDependencies
  76. 			};
  77. 		}
  79. 		return metadata;
  80. 	}
  81. 	async handleLibrary(libraryName) {
  82. 		const metadata = await this.getLibraryMetadata(libraryName);
  84. 		return {
  85. 			metadata: Promise.resolve({
  86. 				id: metadata.npmPackageName,
  87. 				version: metadata.version,
  88. 				dependencies: metadata.dependencies,
  89. 				optionalDependencies: metadata.optionalDependencies
  90. 			}),
  91. 			// Trigger installation of package
  92. 			install: this._installer.installPackage({
  93. 				pkgName: metadata.npmPackageName,
  94. 				version: metadata.version
  95. 			})
  96. 		};
  97. 	}
  98. 	static async fetchAllVersions({ui5HomeDir, cwd} = {}) {
  99. 		const installer = new Installer({
  100. 			cwd: cwd ? path.resolve(cwd) : process.cwd(),
  101. 			ui5HomeDir:
  102. 				ui5HomeDir ? path.resolve(ui5HomeDir) :
  103. 					path.join(require("os").homedir(), ".ui5")
  104. 		});
  105. 		return await installer.fetchPackageVersions({pkgName: DIST_PKG_NAME});
  106. 	}
  107. }
  109. module.exports = Sapui5Resolver;