@ui5/project
Version:
UI5 CLI - Project
245 lines (220 loc) • 7.58 kB
JavaScript
import fsPath from "node:path";
import ComponentProject from "../ComponentProject.js";
import {createReader} from "@ui5/fs/resourceFactory";
/**
* Application
*
* @public
* @class
* @alias @ui5/project/specifications/types/Application
* @extends @ui5/project/specifications/ComponentProject
* @hideconstructor
*/
class Application extends ComponentProject {
constructor(parameters) {
super(parameters);
this._pManifests = Object.create(null);
this._webappPath = "webapp";
this._isRuntimeNamespaced = false;
}
/* === Attributes === */
/**
* Get the cachebuster signature type configuration of the project
*
* @returns {string} <code>time</code> or <code>hash</code>
*/
getCachebusterSignatureType() {
return this._config.builder && this._config.builder.cachebuster &&
this._config.builder.cachebuster.signatureType || "time";
}
/**
* Get the path of the project's source directory. This might not be POSIX-style on some platforms.
*
* @public
* @returns {string} Absolute path to the source directory of the project
*/
getSourcePath() {
return fsPath.join(this.getRootPath(), this._webappPath);
}
/* === Resource Access === */
/**
* Get a resource reader for the sources of the project (excluding any test resources)
*
* @param {string[]} excludes List of glob patterns to exclude
* @returns {@ui5/fs/ReaderCollection} Reader collection
*/
_getSourceReader(excludes) {
return createReader({
fsBasePath: this.getSourcePath(),
virBasePath: `/resources/${this._namespace}/`,
name: `Source reader for application project ${this.getName()}`,
project: this,
excludes
});
}
_getTestReader() {
return null; // Applications do not have a dedicated test directory
}
/**
* Get a resource reader for the sources of the project (excluding any test resources)
* without a virtual base path
*
* @returns {@ui5/fs/ReaderCollection} Reader collection
*/
_getRawSourceReader() {
return createReader({
fsBasePath: this.getSourcePath(),
virBasePath: "/",
name: `Raw source reader for application project ${this.getName()}`,
project: this
});
}
/* === Internals === */
/**
* @private
* @param {object} config Configuration object
*/
async _configureAndValidatePaths(config) {
await super._configureAndValidatePaths(config);
if (config.resources && config.resources.configuration &&
config.resources.configuration.paths && config.resources.configuration.paths.webapp) {
this._webappPath = config.resources.configuration.paths.webapp;
}
this._log.verbose(`Path mapping for application project ${this.getName()}:`);
this._log.verbose(` Physical root path: ${this.getRootPath()}`);
this._log.verbose(` Mapped to: ${this._webappPath}`);
if (!(await this._dirExists("/" + this._webappPath))) {
throw new Error(
`Unable to find source directory '${this._webappPath}' in application project ${this.getName()}`);
}
}
/**
* @private
* @param {object} config Configuration object
* @param {object} buildDescription Cache metadata object
*/
async _parseConfiguration(config, buildDescription) {
await super._parseConfiguration(config, buildDescription);
if (buildDescription) {
this._namespace = buildDescription.namespace;
return;
}
this._namespace = await this._getNamespace();
}
/**
* Determine application namespace either based on a project`s
* manifest.json or manifest.appdescr_variant (fallback if present)
*
* @returns {string} Namespace of the project
* @throws {Error} if namespace can not be determined
*/
async _getNamespace() {
try {
return await this._getNamespaceFromManifestJson();
} catch (manifestJsonError) {
if (manifestJsonError.code !== "ENOENT") {
throw manifestJsonError;
}
// No manifest.json present
// => attempt fallback to manifest.appdescr_variant (typical for App Variants)
try {
return await this._getNamespaceFromManifestAppDescVariant();
} catch (appDescVarError) {
if (appDescVarError.code === "ENOENT") {
// Fallback not possible: No manifest.appdescr_variant present
// => Throw error indicating missing manifest.json
// (do not mention manifest.appdescr_variant since it is only
// relevant for the rather "uncommon" App Variants)
throw new Error(
`Could not find required manifest.json for project ` +
`${this.getName()}: ${manifestJsonError.message}\n\n` +
`If you are about to start a new project, please refer to:\n` +
`https://ui5.github.io/cli/v4/pages/GettingStarted/#starting-a-new-project`, {
cause: manifestJsonError
});
}
throw appDescVarError;
}
}
}
/**
* Determine application namespace by checking manifest.json.
* Any maven placeholders are resolved from the projects pom.xml
*
* @returns {string} Namespace of the project
* @throws {Error} if namespace can not be determined
*/
async _getNamespaceFromManifestJson() {
const manifest = await this._getManifest("/manifest.json");
let appId;
// check for a proper sap.app/id in manifest.json to determine namespace
if (manifest["sap.app"] && manifest["sap.app"].id) {
appId = manifest["sap.app"].id;
} else {
throw new Error(
`No sap.app/id configuration found in manifest.json of project ${this.getName()}`);
}
if (this._hasMavenPlaceholder(appId)) {
try {
appId = await this._resolveMavenPlaceholder(appId);
} catch (err) {
throw new Error(
`Failed to resolve namespace of project ${this.getName()}: ${err.message}`);
}
}
const namespace = appId.replace(/\./g, "/");
this._log.verbose(
`Namespace of project ${this.getName()} is ${namespace} (from manifest.json)`);
return namespace;
}
/**
* Determine application namespace by checking manifest.appdescr_variant.
*
* @returns {string} Namespace of the project
* @throws {Error} if namespace can not be determined
*/
async _getNamespaceFromManifestAppDescVariant() {
const manifest = await this._getManifest("/manifest.appdescr_variant");
let appId;
// check for the id property in manifest.appdescr_variant to determine namespace
if (manifest && manifest.id) {
appId = manifest.id;
} else {
throw new Error(
`No "id" property found in manifest.appdescr_variant of project ${this.getName()}`);
}
const namespace = appId.replace(/\./g, "/");
this._log.verbose(
`Namespace of project ${this.getName()} is ${namespace} (from manifest.appdescr_variant)`);
return namespace;
}
/**
* Reads and parses a JSON file with the provided name from the projects source directory
*
* @param {string} filePath Name of the JSON file to read. Typically "manifest.json" or "manifest.appdescr_variant"
* @returns {Promise<object>} resolves with an object containing the content requested manifest file
*/
async _getManifest(filePath) {
if (this._pManifests[filePath]) {
return this._pManifests[filePath];
}
return this._pManifests[filePath] = this._getRawSourceReader().byPath(filePath)
.then(async (resource) => {
if (!resource) {
const error = new Error(
`Could not find resource ${filePath} in project ${this.getName()}`);
error.code = "ENOENT"; // "File or directory does not exist"
throw error;
}
return JSON.parse(await resource.getString());
}).catch((err) => {
if (err.code === "ENOENT") {
throw err;
}
throw new Error(
`Failed to read ${filePath} for project ` +
`${this.getName()}: ${err.message}`);
});
}
}
export default Application;