@ui5/builder
Version:
UI5 CLI - Builder
664 lines (581 loc) • 20.8 kB
JavaScript
import posixPath from "node:path/posix";
import semver from "semver";
const {SemVer: Version} = semver;
import {getLogger} from "@ui5/logger";
const log = getLogger("builder:processors:manifestCreator");
import Resource from "@ui5/fs/Resource";
import xml2js from "xml2js";
import analyzeLibraryJS from "../lbt/analyzer/analyzeLibraryJS.js";
/*
* A single parse instance to be used by all invocations (TODO check reentrance capa of xml2js)
*/
const parser = new xml2js.Parser({
// explicitChildren: true,
preserveChildrenOrder: true,
xmlns: true
});
// const APP_DESCRIPTOR_V3 = new Version("1.2.0");
const APP_DESCRIPTOR_V3_SECTION_SAP_APP = new Version("1.2.0");
const APP_DESCRIPTOR_V3_OTHER_SECTIONS = new Version("1.1.0");
const APP_DESCRIPTOR_V5 = new Version("1.4.0");
const APP_DESCRIPTOR_V10 = new Version("1.9.0");
const APP_DESCRIPTOR_V22 = new Version("1.21.0");
// namespaces used in .library files
const XMLNS_UILIB = "http://www.sap.com/sap.ui.library.xsd";
const XMLNS_OWNERSHIP = "http://www.sap.com/ui5/buildext/ownership";
const XMLNS_MANIFEST = "http://www.sap.com/ui5/buildext/manifest";
const XMLNS_THIRDPARTY = "http://www.sap.com/ui5/buildext/thirdparty";
function getAttribute(node, attr) {
return (node.$ && node.$[attr] && node.$[attr].value) || null;
}
function getBooleanAttribute(node, attr) {
return getAttribute(node, attr) === "true";
}
function findChild(node, tagName, namespaceURI) {
if ( node &&
Array.isArray(node[tagName]) &&
node[tagName].length > 0 &&
(namespaceURI == null || (node[tagName][0].$ns && node[tagName][0].$ns.uri === namespaceURI)) ) {
return node[tagName][0];
}
}
function findChildren(node, tagName, namespaceURI) {
const children = node && node[tagName];
if ( Array.isArray(children) ) {
return children.filter((child) => (namespaceURI == null || (child.$ns && child.$ns.uri === namespaceURI)));
}
return [];
}
function getChildTextContent(node, tagName, defaultValue) {
const child = findChild(node, tagName);
return child ? (child._ || "") : defaultValue;
}
class Dependency {
constructor(xml) {
this.xml = xml;
}
getLibraryName() {
return getChildTextContent(this.xml, "libraryName");
}
getVersion() {
return getChildTextContent(this.xml, "version");
}
isLazy() {
return "true" === getChildTextContent(this.xml, "lazy");
}
}
class Library {
constructor(xml) {
this.xml = xml;
}
getVersion() {
return getChildTextContent(this.xml, "version");
}
getName() {
return getChildTextContent(this.xml, "name");
}
getTitle() {
return getChildTextContent(this.xml, "title");
}
getDocumentation() {
return getChildTextContent(this.xml, "documentation");
}
getDependencies() {
const container = findChild(this.xml, "dependencies");
const deps = findChildren(container, "dependency") || [];
return deps.map((dep) => new Dependency(dep));
}
getAppData(tagName, namespace) {
const appData = findChild(this.xml, "appData", XMLNS_UILIB);
return findChild(appData, tagName, namespace);
}
static async from(resource) {
const content = await resource.getString();
return new Promise( (resolve, reject) => {
parser.parseString(content, (err, xml) => {
if ( err ) {
reject(err);
return;
}
resolve(new Library(xml.library));
});
});
}
}
class LibraryBundle {
/**
*
* @param {string} prefix
* @param {@ui5/fs/Resource[]} resources
*/
constructor(prefix, resources) {
this.prefix = prefix;
this.resources = resources.filter((res) => res.getPath().startsWith(prefix));
}
/**
*
* @param {string} name
* @returns {@ui5/fs/Resource}
*/
findResource(name) {
return this.resources.find((res) => res.getPath() === this.prefix + name);
}
/**
*
* @param {RegExp} pattern
* @returns {@ui5/fs/Resource[]}
*/
getResources(pattern) {
return this.resources.filter((res) => pattern == null || pattern.test(res.getPath()));
}
}
/*
* Creates the library manifest.json file for a UILibrary.
*/
async function createManifest(
libraryResource, libBundle, descriptorVersion, _include3rdParty, omitMinVersions, getProjectVersion
) {
// create a Library wrapper around the .library XML
const library = await Library.from(libraryResource);
const libraryPathPrefix = posixPath.dirname(libraryResource.getPath()) + "/";
// collect information from library.js file
const libraryJSInfo = await analyzeLibraryJS(libBundle.findResource("library.js"));
const includeSupportedLocalesInformation = descriptorVersion.compare(APP_DESCRIPTOR_V22) >= 0;
/**
* cache for supported locales
*
* @see createI18nSection
*/
const i18nToSupportedLocales = new Map();
const manifestAppData = library.getAppData("manifest", XMLNS_MANIFEST);
const sapFioriAppData = findChild(manifestAppData, "sap.fiori");
function sectionVersion(candidateVersion) {
// _version property for nested sections became optional with AppDescriptor V5
if ( descriptorVersion.compare(APP_DESCRIPTOR_V5) < 0 ) {
return candidateVersion.toString();
}
// return undefined
}
function createSapApp() {
function hasManifest(componentPath) {
const manifestPath = componentPath + "/manifest.json";
const manifestResource = libBundle.findResource(manifestPath.substring(libraryPathPrefix.length));
if ( manifestResource == null ) {
log.verbose(" Component has no accompanying manifest.json, don't list it as 'embedded'");
return false;
}
return true;
}
function findEmbeddedComponents() {
const result = [];
const components = libBundle.getResources(/^\/(?:[^/]+\/)*Component\.js$/);
for (const comp of components) {
const componentPath = posixPath.dirname(comp.getPath());
log.verbose(`Checking component at ${componentPath}`);
if ( componentPath.startsWith(libraryPathPrefix) && hasManifest(componentPath) ) {
result.push( componentPath.substring(libraryPathPrefix.length) );
} else if ( libraryPathPrefix === "/resources/sap/apf/" ) {
log.verbose(`Package ${componentPath} contains both '*.library' and 'Component.js'. ` +
`This is a known issue but can't be solved due to backward compatibility.`);
} else if (
libraryPathPrefix === (componentPath + "/") &&
libraryPathPrefix !== "/resources/sap/ui/core/"
) {
log.error(`Package ${componentPath} contains both '*.library' and 'Component.js'. ` +
`This is not supported by manifests, therefore the component won't be ` +
`listed in the library's manifest.`);
}
}
return result.sort();
}
function isValid(version) {
return version && version !== "@version@" && version !== "${version}";
}
function getLibraryTitle() {
if ( library.getTitle() ) {
return library.getTitle();
}
if ( library.getDocumentation() ) {
let desc = library.getDocumentation();
// remove all tags
let prevDesc;
do { // Safely strip tags (https://codeql.github.com/codeql-query-help/javascript/js-incomplete-multi-character-sanitization/#example)
prevDesc = desc;
desc = desc.replace(/\s+/g, " ").replace(/<\/?[a-zA-Z][a-zA-Z0-9_$.]*(\s[^>]*)>/g, "");
} while (prevDesc !== desc);
// extract summary (first sentence)
const m = /^([\w\W]+?[.;!?])[^a-zA-Z0-9_$]/.exec(desc);
return m ? m[1] : desc;
}
return library.getName();
}
function getDefaultACH() {
const ownership = library.getAppData("ownership", XMLNS_OWNERSHIP);
for (const comp of findChildren(ownership, "component")) {
if ( comp._ ) {
return comp._;
}
}
}
function offline() {
let result = sapFioriAppData == null ? true : false;
const offlineElement = findChild(manifestAppData, "offline");
if ( offlineElement ) {
result = offlineElement._ === "true";
}
return result;
}
function sourceTemplate() {
const sourceTemplateElement = findChild(manifestAppData, "sourceTemplate");
if ( sourceTemplateElement ) {
return {
"id": getChildTextContent(sourceTemplateElement, "id"),
"version": getChildTextContent(sourceTemplateElement, "version")
};
}
}
function openSourceComponents() {
const embeddedOSComponents = new Set();
const osComponents = [];
for (const osCompElem of findChildren(manifestAppData, "openSourceComponent")) {
const name = getAttribute(osCompElem, "name");
const packagedWithMySelf = getBooleanAttribute(osCompElem, "packagedWithMySelf");
osComponents.push({
name: name,
packagedWithMySelf,
version: packagedWithMySelf ? getAttribute(osCompElem, "version") : undefined
});
if ( packagedWithMySelf ) {
embeddedOSComponents.add(name);
}
}
if ( _include3rdParty ) {
// also merge all thirdparty libs, but only with the name - version info is not available
// only merge in if no lib with the same name has been declared already
const thirdpartyAppData = library.getAppData("thirdparty", XMLNS_THIRDPARTY);
for (const thirdPartyElem of findChildren(thirdpartyAppData, "lib")) {
const osCompName = getAttribute(thirdPartyElem, "name");
if ( !embeddedOSComponents.has(osCompName) ) {
embeddedOSComponents.add(osCompName);
osComponents.push({
name: osCompName,
packagedWithMySelf: true,
version: getAttribute(thirdPartyElem, "version") || "0.0.0"
});
}
}
}
return osComponents.length > 0 ? osComponents : undefined;
}
const i18nText = getChildTextContent(manifestAppData, "i18n");
let i18n;
if (typeof i18nText === "string") {
i18n = createI18nSection(i18nText, i18nToSupportedLocales);
log.verbose(`sap.app/i18n taken from .library appData: '${i18nText}'`);
}
const sapApp = {
_version: sectionVersion(APP_DESCRIPTOR_V3_SECTION_SAP_APP),
id: library.getName(),
type: "library",
embeds: findEmbeddedComponents(),
i18n,
applicationVersion: {
version: isValid(library.getVersion()) ? library.getVersion() : getProjectVersion(library.getName())
},
title: getLibraryTitle(),
description: library.getDocumentation(),
ach: getDefaultACH(), // optional, might be undefined
resources: "resources.json",
offline: offline(),
sourceTemplate: sourceTemplate(),
openSourceComponents: openSourceComponents()
};
log.verbose(` sap.app/id taken from .library: '${sapApp.id}'`);
log.verbose(` sap.app/embeds determined from resources:`, sapApp.embeds);
log.verbose(` sap.app/i18n taken from .library appData:`, sapApp.i18n);
log.verbose(` sap.app/ach taken from .library appData/ownership: '${sapApp.ach}'`);
return sapApp;
}
function createSapUi() {
function deviceTypes() {
const deviceTypesElement = findChild(manifestAppData, "deviceTypes");
if ( deviceTypesElement ) {
return {
desktop: getBooleanAttribute(deviceTypesElement, "desktop"),
tablet: getBooleanAttribute(deviceTypesElement, "tablet"),
phone: getBooleanAttribute(deviceTypesElement, "phone"),
};
}
}
function collectThemes() {
const themes = Object.create(null);
// find theme resources and determine theme names from their paths
libBundle.getResources(/(?:[^/]+\/)*themes\//).forEach((res) => {
if ( !res.getPath().startsWith(libraryPathPrefix + "themes/") ) {
// only consider themes within direct "themes" sub-directory
return;
}
const match = /\/themes\/([^/]+)\//.exec(res.getPath());
if ( match ) {
themes[match[1]] = true;
}
});
// merge with supportedTheme info from .library file
const elems = findChildren(manifestAppData, "supportedTheme");
if ( elems ) {
elems.forEach((elem) => {
if ( elem._ ) {
themes[elem._];
}
});
}
return Object.keys(themes).sort();
}
const sapUi = {
_version: sectionVersion(APP_DESCRIPTOR_V3_OTHER_SECTIONS),
technology: "UI5",
deviceTypes: deviceTypes(),
supportedThemes: collectThemes()
};
log.verbose(` sap.ui/supportedThemes determined from resources: '${sapUi.supportedThemes.join(", ")}'`);
return sapUi;
}
function createSapUI5() {
function getUI5Version() {
return normalizeVersion(getProjectVersion("sap.ui.core"));
}
function dependencies() {
const dependencies = {
minUI5Version: omitMinVersions ? "" : getUI5Version(),
libs: {
}
};
if ( library.getDependencies() != null ) {
for (const dep of library.getDependencies()) {
dependencies.libs[dep.getLibraryName()] = {
minVersion: omitMinVersions ? "" : getProjectVersion(dep.getLibraryName()),
lazy: dep.isLazy() || undefined // suppress default (false)
};
}
}
log.verbose(` sap.ui5/dependencies/libs determined from .library dependencies:`, dependencies.libs);
return dependencies;
}
function contentDensities() {
const contentDensitiesElement = findChild(manifestAppData, "contentDensities");
if ( contentDensitiesElement != null ) {
const contentDensities = {
cozy: getBooleanAttribute(contentDensitiesElement, "cozy"),
compact: getBooleanAttribute(contentDensitiesElement, "compact")
};
log.verbose(` sap.ui5/contentDensities property taken from .library appData:`, contentDensities);
return contentDensities;
}
}
function createLibraryMetadata() {
if ( descriptorVersion.compare(APP_DESCRIPTOR_V10) < 0 ) {
log.verbose(` Target descriptor version ${descriptorVersion}: skipping sap.ui5/library information`);
}
log.verbose(` Target descriptor version ${descriptorVersion}: include sap.ui5/library information`);
const sapUi5AppData = findChild(manifestAppData, "sap.ui5");
const libraryAppData = findChild(sapUi5AppData, "library");
// i18n:
// - from .library/appData/manifest/sap.ui5/library/i18n
// - from library resources (if "messagebundle.properties" exists)
function i18n() {
let i18n = getChildTextContent(libraryAppData, "i18n");
if ( typeof i18n === "string") {
if ( i18n === "false" ) {
return false;
} else if ( i18n === "true" ) {
i18n = "messagebundle.properties";
}
// log.verbose(" sap.ui5/library/i18n property taken from .library appData: '%s'", library.i18n);
} else {
if ( libBundle.findResource("messagebundle.properties") != null ) {
// log.verbose(" sap.ui5/library/i18n property determined from resources: '%s'", library.i18n);
i18n = "messagebundle.properties";
} else {
// i18n not defined and no messagebundle.properties
return false;
}
}
return createI18nSection(i18n, i18nToSupportedLocales);
}
// css:
// - from .library/appData/manifest/sap.ui5/library/css
// - from library.js/initLibrary/noLibraryCSS
function css() {
const cssElement = findChild(libraryAppData, "css");
if ( cssElement != null ) {
const css = cssElement._;
if ( css === "false" ) {
log.verbose(` sap.ui5/library/css property taken from .library appData: 'false'`);
return false;
}
} else if ( libraryJSInfo.noLibraryCSS ) {
log.verbose(` sap.ui5/library/css property extracted from library.js: 'false'`);
return false;
}
}
// content
// - from library.js/initLibrary/ (types|elements|controls|interfaces)
function content() {
const libraryJS = libraryJSInfo;
if ( libraryJS.controls || libraryJS.elements || libraryJS.interfaces || libraryJS.types ) {
return {
controls: libraryJS.controls,
elements: libraryJS.elements,
types: libraryJS.types,
interfaces: libraryJS.interfaces
};
}
}
const libraryMetadata = {
i18n: i18n(),
css: css(),
content: content()
};
if (process.env.UI5_CLI_EXPERIMENTAL_BUNDLE_INFO_PRELOAD) {
// Add flag indicating that the (currently experimental) bundleVersion 2 preload bundling is used
libraryMetadata.bundleVersion = 2;
}
return libraryMetadata;
}
const sapUI5 = {
_version: sectionVersion(APP_DESCRIPTOR_V3_OTHER_SECTIONS),
dependencies: dependencies(),
contentDensities: contentDensities(),
library: createLibraryMetadata()
};
return sapUI5;
}
/**
* Creates an i18n section:
* - either using bundleUrl and supportedLocales
* - or the i18n String
*
* @param {string} i18n bundle url, e.g. "messagebundle.properties"
* @param {Map<string, Set<string>>} i18nToSupportedLocales cache to determine the supportedLocales only once
* @returns {{bundleUrl: string, supportedLocales: string[]}|null|string} json structure with bundleUrl and
* supportedLocales or the i18n String if not a ".properties" file.
* <code>null</code> if given i18n String is <code>null</code>
*/
function createI18nSection(i18n, i18nToSupportedLocales) {
if (i18n === undefined) {
return undefined;
}
if (!i18n.endsWith(".properties")) {
return i18n;
}
// if the supported locales information should not be included use i18n text
if (!includeSupportedLocalesInformation) {
return i18n;
}
let supportedLocales = i18nToSupportedLocales.get(i18n);
if (!supportedLocales) {
supportedLocales = new Set();
if (libBundle.findResource(i18n) != null) {
supportedLocales.add("");
}
const i18nPathPrefix = i18n.substring(0, i18n.length - ".properties".length) + "_";
// e.g. i18n/i18n_
libBundle.getResources().forEach((resource) => {
const resPath = resource.getPath();
// e.g. sap/ui/mine/i18n/i18n_en.properties
const indexOfI18nPathPrefix = resPath.lastIndexOf(i18nPathPrefix);
if (resPath.endsWith(".properties") && indexOfI18nPathPrefix >= 0) {
const i18nPath = resPath.substring(indexOfI18nPathPrefix + i18nPathPrefix.length,
resPath.length - ".properties".length);
if (!i18nPath.includes(".")) {
supportedLocales.add(i18nPath.replace(/_/g, "-"));
}
}
});
i18nToSupportedLocales.set(i18n, supportedLocales);
}
const supportedLocalesArray = Array.from(supportedLocales);
supportedLocalesArray.sort();
return {
bundleUrl: i18n,
supportedLocales: supportedLocalesArray,
fallbackLocale: supportedLocalesArray.length === 1 ? supportedLocalesArray[0] : undefined
};
}
function createSapFiori() {
// collect registrationIds if present
function registrationIds() {
const ids = [];
for (const regid of findChildren(sapFioriAppData, "registrationId")) {
ids.push(regid._);
}
return ids.length > 0 ? ids : undefined;
}
if ( sapFioriAppData != null ) {
return {
_version: sectionVersion(APP_DESCRIPTOR_V3_OTHER_SECTIONS),
registrationIds: registrationIds(),
archeType: getChildTextContent(sapFioriAppData, "archeType", "reuseComponent")
};
}
}
function createSapPlatformABAP() {
const sapPlatformABAPElement = findChild(manifestAppData, "sap.platform.abap");
if ( sapPlatformABAPElement ) {
return {
_version: sectionVersion(APP_DESCRIPTOR_V3_OTHER_SECTIONS),
uri: getChildTextContent(sapPlatformABAPElement, "uri")
};
}
}
function createSapPlatformHCP() {
const sapPlatformHCPElement = findChild(manifestAppData, "sap.platform.hcp");
if ( sapPlatformHCPElement ) {
return {
_version: sectionVersion(APP_DESCRIPTOR_V3_OTHER_SECTIONS),
uri: getChildTextContent(sapPlatformHCPElement, "uri")
};
}
}
function normalizeVersion(version) {
if ( version == null ) {
return version;
}
const v = new Version(version);
return v.major + "." + v.minor;
}
return {
"_version": descriptorVersion.toString(),
"sap.app": createSapApp(),
"sap.ui": createSapUi(),
"sap.ui5": createSapUI5(),
"sap.fiori": createSapFiori(),
"sap.platform.abap": createSapPlatformABAP(),
"sap.platform.hcp": createSapPlatformHCP()
};
}
export default function({libraryResource, resources, getProjectVersion, options}) {
// merge options with defaults
options = Object.assign({
descriptorVersion: APP_DESCRIPTOR_V22.toString(),
include3rdParty: true,
prettyPrint: true,
omitMinVersions: false
}, options);
const resourcePathPrefix = libraryResource.getPath().slice(0, -".library".length);
const libBundle = new LibraryBundle(resourcePathPrefix, resources);
// check whether a manifest exists already
const manifestResource = libBundle.findResource("manifest.json");
if ( manifestResource != null ) {
log.verbose(`Library manifest already exists at '${manifestResource.getPath()}', skipping generation`);
return Promise.resolve(null); // a fulfillment of null indicates that no manifest has been created
}
return createManifest(libraryResource, libBundle, new Version(options.descriptorVersion), options.include3rdParty,
options.omitMinVersions, getProjectVersion)
.then((manifest) => {
return new Resource({
path: resourcePathPrefix + "manifest.json",
string: JSON.stringify(manifest, null, options.prettyPrint ? " " : undefined)
});
});
}