@ui5/builder 3.0.0-alpha.9 → 3.0.0-beta.2

package/lib/lbt/analyzer/JSModuleAnalyzer.js

@@ -1,12 +1,21 @@
-"use strict";
-
-const {Syntax, VisitorKeys} = require("../utils/parseUtils");
-const escope = require("escope");
-const ModuleName = require("../utils/ModuleName");
-const {Format: ModuleFormat} = require("../resources/ModuleInfo");
-const UI5ClientConstants = require("../UI5ClientConstants");
-const {findOwnProperty, getLocation, getPropertyKey, isMethodCall, isString} = require("../utils/ASTUtils");
-const log = require("@ui5/logger").getLogger("lbt:analyzer:JSModuleAnalyzer");
+import {Syntax, VisitorKeys} from "../utils/parseUtils.js";
+import escope from "escope";
+import {fromUI5LegacyName, fromRequireJSName, resolveRelativeRequireJSName} from "../utils/ModuleName.js";
+import moduleInfo from "../resources/ModuleInfo.js";
+const ModuleFormat = moduleInfo.Format;
+import {MODULE__JQUERY_SAP_GLOBAL, MODULE__UI5LOADER_AUTOCONFIG} from "../UI5ClientConstants.js";
+import {
+	findOwnProperty,
+	getLocation,
+	getPropertyKey,
+	isMethodCall,
+	isString,
+	getStringValue,
+} from "../utils/ASTUtils.js";
+
+import logger from "@ui5/logger";
+
+const log = logger.getLogger("lbt:analyzer:JSModuleAnalyzer");
 
 // ------------------------------------------------------------------------------------------------------------------
 
@@ -64,7 +73,7 @@ const EnrichedVisitorKeys = (function() {
 		BreakStatement: [],
 		CallExpression: [], // special handling
 		CatchClause: ["param", "body"],
-		ChainExpression: [],
+		ChainExpression: ["expression"],
 		ClassBody: [],
 		ClassDeclaration: [],
 		ClassExpression: [],
@@ -114,7 +123,7 @@ const EnrichedVisitorKeys = (function() {
 		ImportSpecifier: [], // imported, local
 		Literal: [],
 		LabeledStatement: [],
-		LogicalExpression: [],
+		LogicalExpression: ["right"],
 		MemberExpression: [],
 		MetaProperty: toBeDone(["meta", "property"]),
 		MethodDefinition: [],
@@ -126,10 +135,10 @@ const EnrichedVisitorKeys = (function() {
 		 * All properties in an object pattern are executed.
 		 */
 		ObjectPattern: [], // properties
-		// PrivateIdentifier: [], // will come with ES2022
+		PrivateIdentifier: [],
 		Program: [],
 		Property: [],
-		// PropertyDefinition: [], // will come with ES2022
+		PropertyDefinition: [],
 		/*
 		 * argument of the rest element is always executed under the same condition as the rest element itself
 		 */
@@ -137,7 +146,7 @@ const EnrichedVisitorKeys = (function() {
 		ReturnStatement: [],
 		SequenceExpression: [],
 		SpreadElement: [], // the argument of the spread operator always needs to be evaluated - argument
-		// StaticBlock: [], // will come with ES2022
+		StaticBlock: [],
 		Super: [],
 		SwitchStatement: [],
 		SwitchCase: ["test", "consequent"], // test and consequent are executed only conditionally
@@ -187,15 +196,6 @@ const EnrichedVisitorKeys = (function() {
 			return;
 		}
 
-		// Ignore new ES2022 syntax as we currently use ES2021 (see parseUtils.js)
-		if (
-			type === "PrivateIdentifier" ||
-			type === "PropertyDefinition" ||
-			type === "StaticBlock"
-		) {
-			return;
-		}
-
 		const visitorKeys = VisitorKeys[type];
 		const condKeys = TempKeys[type];
 		if ( condKeys === undefined ) {
@@ -350,13 +350,13 @@ class JSModuleAnalyzer {
 
 		// depending on the used module APIs, add an implicit dependency to the loader entry module
 		if ( info.format === ModuleFormat.UI5_LEGACY ) {
-			info.addImplicitDependency(UI5ClientConstants.MODULE__JQUERY_SAP_GLOBAL);
+			info.addImplicitDependency(MODULE__JQUERY_SAP_GLOBAL);
 		} else if ( info.format === ModuleFormat.UI5_DEFINE ) {
 			// Note: the implicit dependency for sap.ui.define modules points to the standard UI5
 			// loader config module. A more general approach would be to add a dependency to the loader
 			// only, but then standard configuration would be missed by dependency resolution
 			// (to be clarified)
-			info.addImplicitDependency(UI5ClientConstants.MODULE__UI5LOADER_AUTOCONFIG);
+			info.addImplicitDependency(MODULE__UI5LOADER_AUTOCONFIG);
 		}
 
 		if ( !bIsUi5Module ) {
@@ -526,6 +526,15 @@ class JSModuleAnalyzer {
 				}
 				break;
 
+			case Syntax.PropertyDefinition:
+
+				// Instance properties (static=false) are only initialized when an instance is created (conditional)
+				// but a computed key is always evaluated on class initialization (eager)
+				visit(node.key, conditional);
+				visit(node.value, !node.static || conditional);
+
+				break;
+
 			default:
 				if ( condKeys == null ) {
 					log.error("Unhandled AST node type " + node.type, node);
@@ -541,21 +550,27 @@ class JSModuleAnalyzer {
 
 		function onDeclare(node) {
 			const args = node.arguments;
-			if ( args.length > 0 && isString(args[0]) ) {
-				const name = ModuleName.fromUI5LegacyName( args[0].value );
-				if ( nModuleDeclarations === 1 && !mainModuleFound) {
-					// if this is the first declaration, then this is the main module declaration
-					// note that this overrides an already given name
-					setMainModuleInfo(name, getDocumentation(node));
-				} else if ( nModuleDeclarations > 1 && name === info.name ) {
-					// ignore duplicate declarations (e.g. in behavior file of design time controls)
-					log.warn(`duplicate declaration of module name at ${getLocation(args)} in ${name}`);
+			if (args.length > 0) {
+				const value = getStringValue(args[0]);
+				if (value !== undefined) {
+					const name = fromUI5LegacyName(value);
+					if ( nModuleDeclarations === 1 && !mainModuleFound) {
+						// if this is the first declaration, then this is the main module declaration
+						// note that this overrides an already given name
+						setMainModuleInfo(name, getDocumentation(node));
+					} else if ( nModuleDeclarations > 1 && name === info.name ) {
+						// ignore duplicate declarations (e.g. in behavior file of design time controls)
+						log.warn(`duplicate declaration of module name at ${getLocation(args)} in ${name}`);
+					} else {
+						// otherwise it is just a submodule declaration
+						info.addSubModule(name);
+					}
+					return;
 				} else {
-					// otherwise it is just a submodule declaration
-					info.addSubModule(name);
+					log.error("jQuery.sap.declare: module name could not be determined from first argument:", args[0]);
 				}
 			} else {
-				log.error("jQuery.sap.declare: module name could not be determined from first argument:", args[0]);
+				log.error("jQuery.sap.declare: module name could not be determined, no arguments are given");
 			}
 		}
 
@@ -569,20 +584,26 @@ class JSModuleAnalyzer {
 
 			// determine the name of the module
 			let name = null;
-			if ( i < nArgs && isString(args[i]) ) {
-				name = ModuleName.fromRequireJSName( args[i++].value );
-				if ( name === defaultName ) {
-					// hardcoded name equals the file name, so this definition qualifies as main module definition
-					setMainModuleInfo(name, desc);
-				} else {
-					info.addSubModule(name);
-					if ( candidateName == null ) {
-						// remember the name and description in case no other module qualifies as main module
-						candidateName = name;
-						candidateDescription = desc;
+			if ( i < nArgs ) {
+				const value = getStringValue( args[i] );
+				if ( value !== undefined ) {
+					name = fromRequireJSName(value);
+					if ( name === defaultName ) {
+						// hardcoded name equals the file name, so this definition qualifies as main module definition
+						setMainModuleInfo(name, desc);
+					} else {
+						info.addSubModule(name);
+						if ( candidateName == null ) {
+							// remember the name and description in case no other module qualifies as main module
+							candidateName = name;
+							candidateDescription = desc;
+						}
 					}
+					i++;
 				}
-			} else {
+			}
+
+			if ( !name ) {
 				nUnnamedDefines++;
 				if ( nUnnamedDefines > 1 ) {
 					throw new Error(
@@ -614,15 +635,25 @@ class JSModuleAnalyzer {
 				// UI5 signature with one or many required modules
 				for (let i = 0; i < nArgs; i++) {
 					const arg = args[i];
-					if ( isString(arg) ) {
-						const requiredModuleName = ModuleName.fromUI5LegacyName( arg.value );
+					const value = getStringValue(arg);
+					if ( value !== undefined ) {
+						const requiredModuleName = fromUI5LegacyName( value );
 						info.addDependency(requiredModuleName, conditional);
-					} else if ( arg.type == Syntax.ConditionalExpression &&
-									isString(arg.consequent) && isString(arg.alternate) ) {
-						const requiredModuleName1 = ModuleName.fromUI5LegacyName( arg.consequent.value );
-						info.addDependency(requiredModuleName1, true);
-						const requiredModuleName2 = ModuleName.fromUI5LegacyName( arg.alternate.value );
-						info.addDependency(requiredModuleName2, true);
+					} else if ( arg.type == Syntax.ConditionalExpression) {
+						const consequentValue = getStringValue(arg.consequent);
+						const alternateValue = getStringValue(arg.alternate);
+						if ( consequentValue !== undefined ) {
+							const requiredModuleName1 = fromUI5LegacyName( consequentValue );
+							info.addDependency(requiredModuleName1, true);
+						}
+						if ( alternateValue !== undefined ) {
+							const requiredModuleName2 = fromUI5LegacyName( alternateValue );
+							info.addDependency(requiredModuleName2, true);
+						}
+						if ( consequentValue === undefined || alternateValue === undefined ) {
+							log.verbose("jQuery.sap.require: cannot evaluate dynamic arguments: ", arg && arg.type);
+							info.dynamicDependencies = true;
+						}
 					} else {
 						log.verbose("jQuery.sap.require: cannot evaluate dynamic arguments: ", arg && arg.type);
 						info.dynamicDependencies = true;
@@ -637,9 +668,10 @@ class JSModuleAnalyzer {
 			const i = 0;
 
 			if ( i < nArgs ) {
-				if ( isString(args[i]) ) {
+				const value = getStringValue(args[i]);
+				if ( value !== undefined ) {
 					// sap.ui.requireSync does not support relative dependencies
-					const moduleName = ModuleName.fromRequireJSName( args[i].value );
+					const moduleName = fromRequireJSName( value );
 					info.addDependency(moduleName, conditional);
 				} else {
 					log.verbose("sap.ui.requireSync: cannot evaluate dynamic arguments: ", args[i] && args[i].type);
@@ -654,18 +686,24 @@ class JSModuleAnalyzer {
 			let i = 0;
 
 			// determine the name of the module
-			if ( i < nArgs && isString(args[i]) ) {
-				const moduleName = ModuleName.fromRequireJSName( args[i++].value );
-				info.addSubModule(moduleName);
-
-				// add dependencies
-				// to correctly identify dependencies e.g. of a library-preload
-				const elementArg = args[i++];
-				if (elementArg && elementArg.type === Syntax.ArrayExpression) {
-					elementArg.elements.forEach((element) => {
-						const dependencyName = ModuleName.resolveRelativeRequireJSName(moduleName, element.value);
-						info.addDependency(dependencyName, conditional);
-					});
+			if ( i < nArgs ) {
+				const value = getStringValue(args[i++]);
+				if ( value !== undefined ) {
+					const moduleName = fromRequireJSName( value );
+					info.addSubModule(moduleName);
+
+					// add dependencies
+					// to correctly identify dependencies e.g. of a library-preload
+					const elementArg = args[i++];
+					if (elementArg && elementArg.type === Syntax.ArrayExpression) {
+						elementArg.elements.forEach((element) => {
+							const dependencyName = resolveRelativeRequireJSName(moduleName,
+								getStringValue(element));
+							info.addDependency(dependencyName, conditional);
+						});
+					}
+				} else {
+					log.warn("sap.ui.predefine call has a non supported type for module name (ignored)");
 				}
 			} else {
 				log.warn("sap.ui.predefine call is missing a module name (ignored)");
@@ -692,8 +730,11 @@ class JSModuleAnalyzer {
 			if ( modules && modules.type == Syntax.ObjectExpression ) {
 				modules.properties.forEach( function(property) {
 					let	moduleName = getPropertyKey(property);
+					if ( !moduleName ) {
+						return;
+					}
 					if ( namesUseLegacyNotation ) {
-						moduleName = ModuleName.fromUI5LegacyName(moduleName);
+						moduleName = fromUI5LegacyName(moduleName);
 					}
 					info.addSubModule(moduleName);
 				});
@@ -705,16 +746,17 @@ class JSModuleAnalyzer {
 		function analyzeDependencyArray(array, conditional, name) {
 			// console.log(array);
 			array.forEach( (item) => {
-				if ( isString(item) ) {
+				const value = getStringValue(item);
+				if ( value !== undefined ) {
 					// ignore special AMD dependencies (require, exports, module)
-					if ( SPECIAL_AMD_DEPENDENCIES.indexOf(item.value) >= 0 ) {
+					if ( SPECIAL_AMD_DEPENDENCIES.indexOf(value) >= 0 ) {
 						return;
 					}
 					let requiredModule;
 					if (name == null) {
-						requiredModule = ModuleName.fromRequireJSName( item.value );
+						requiredModule = fromRequireJSName( value );
 					} else {
-						requiredModule = ModuleName.resolveRelativeRequireJSName(name, item.value);
+						requiredModule = resolveRelativeRequireJSName(name, value);
 					}
 					info.addDependency( requiredModule, conditional );
 				} else {
@@ -766,4 +808,4 @@ class JSModuleAnalyzer {
 }
 
 
-module.exports = JSModuleAnalyzer;
+export default JSModuleAnalyzer;

package/lib/lbt/analyzer/SmartTemplateAnalyzer.js

@@ -23,13 +23,13 @@
  * This class can handle multiple concurrent analysis calls, it has no instance state other than the pool
  * (which is readonly).
  */
-"use strict";
 
-const ModuleName = require("../utils/ModuleName");
-const SapUiDefine = require("../calls/SapUiDefine");
-const {parseJS, Syntax} = require("../utils/parseUtils");
-const {getValue, isMethodCall, isString} = require("../utils/ASTUtils");
-const log = require("@ui5/logger").getLogger("lbt:analyzer:SmartTemplateAnalyzer");
+import {fromUI5LegacyName} from "../utils/ModuleName.js";
+import SapUiDefine from "../calls/SapUiDefine.js";
+import {parseJS, Syntax} from "../utils/parseUtils.js";
+import {getValue, isMethodCall, getStringValue} from "../utils/ASTUtils.js";
+import logger from "@ui5/logger";
+const log = logger.getLogger("lbt:analyzer:SmartTemplateAnalyzer");
 
 // ---------------------------------------------------------------------------------------------------------
 
@@ -84,7 +84,7 @@ class TemplateComponentAnalyzer {
 		const st = (manifest && manifest["sap.ui.generic.app"]) || {};
 		function recursePage(page) {
 			if ( page.component && page.component.name ) {
-				const module = ModuleName.fromUI5LegacyName( page.component.name + ".Component" );
+				const module = fromUI5LegacyName( page.component.name + ".Component" );
 				log.verbose("template app: add dependency to template component %s", module);
 				info.addDependency(module);
 				promises.push( that._analyzeTemplateComponent(module, page, info) );
@@ -113,7 +113,7 @@ class TemplateComponentAnalyzer {
 			const templateName = (pageConfig.component && pageConfig.component.settings &&
 									pageConfig.component.settings.templateName) || defaultTemplateName;
 			if ( templateName ) {
-				const templateModuleName = ModuleName.fromUI5LegacyName( templateName, ".view.xml" );
+				const templateModuleName = fromUI5LegacyName( templateName, ".view.xml" );
 				log.verbose("template app: add dependency to template view %s", templateModuleName);
 				appInfo.addDependency(templateModuleName);
 			}
@@ -134,25 +134,36 @@ class TemplateComponentAnalyzer {
 			const TA = defineCall.findImportName("sap/suite/ui/generic/template/lib/TemplateAssembler.js");
 			// console.log("local name for TemplateAssembler: %s", TA);
 			if ( TA && defineCall.factory ) {
-				defineCall.factory.body.body.forEach( (stmt) => {
-					if ( stmt.type === Syntax.ReturnStatement &&
-							isMethodCall(stmt.argument, [TA, "getTemplateComponent"]) &&
-							stmt.argument.arguments.length > 2 &&
-							stmt.argument.arguments[2].type === "ObjectExpression" ) {
-						templateName = this._analyzeTemplateClassDefinition(stmt.argument.arguments[2]) || templateName;
+				if (defineCall.factory.type === Syntax.ArrowFunctionExpression &&
+					defineCall.factory.expression === true) {
+					if ( this._isTemplateClassDefinition(TA, defineCall.factory.body) ) {
+						templateName =
+							this._analyzeTemplateClassDefinition(defineCall.factory.body.arguments[2]) || templateName;
 					}
-				});
+				} else {
+					defineCall.factory.body.body.forEach( (stmt) => {
+						if ( stmt.type === Syntax.ReturnStatement &&
+							this._isTemplateClassDefinition(TA, stmt.argument)
+						) {
+							templateName =
+								this._analyzeTemplateClassDefinition(stmt.argument.arguments[2]) || templateName;
+						}
+					});
+				}
 			}
 		}
 		return templateName;
 	}
 
+	_isTemplateClassDefinition(TA, node) {
+		return isMethodCall(node, [TA, "getTemplateComponent"]) &&
+			node.arguments.length > 2 &&
+			node.arguments[2].type === "ObjectExpression";
+	}
+
 	_analyzeTemplateClassDefinition(clazz) {
-		const defaultValue = getValue(clazz, ["metadata", "properties", "templateName", "defaultValue"]);
-		if ( isString(defaultValue) ) {
-			return defaultValue.value;
-		}
+		return getStringValue(getValue(clazz, ["metadata", "properties", "templateName", "defaultValue"]));
 	}
 }
 
-module.exports = TemplateComponentAnalyzer;
+export default TemplateComponentAnalyzer;

package/lib/lbt/analyzer/XMLCompositeAnalyzer.js

@@ -1,10 +1,10 @@
-"use strict";
 
-const {Syntax} = require("../utils/parseUtils");
-const SapUiDefine = require("../calls/SapUiDefine");
-const {getValue, isMethodCall, isString} = require("../utils/ASTUtils");
-const ModuleName = require("../utils/ModuleName");
-const log = require("@ui5/logger").getLogger("lbt:analyzer:XMLCompositeAnalyzer");
+import {Syntax} from "../utils/parseUtils.js";
+import SapUiDefine from "../calls/SapUiDefine.js";
+import {getValue, isMethodCall, getStringValue} from "../utils/ASTUtils.js";
+import {fromUI5LegacyName} from "../utils/ModuleName.js";
+import logger from "@ui5/logger";
+const log = logger.getLogger("lbt:analyzer:XMLCompositeAnalyzer");
 
 const CALL_DEFINE = ["define"];
 const CALL_SAP_UI_DEFINE = ["sap", "ui", "define"];
@@ -19,18 +19,30 @@ class XMLCompositeAnalyzer {
 			const XMLC = defineCall.findImportName("sap/ui/core/XMLComposite.js");
 			// console.log("local name for XMLComposite: %s", XMLC);
 			if ( XMLC && defineCall.factory ) {
-				defineCall.factory.body.body.forEach( (stmt) => {
-					if ( stmt.type === Syntax.VariableDeclaration ) {
-						stmt.declarations.forEach( (decl) => {
-							fragmentName = this._checkForXMLCClassDefinition( XMLC, decl.init ) || fragmentName;
-						});
-					} else if ( stmt.type === Syntax.ExpressionStatement &&
-								stmt.expression.type === Syntax.AssignmentExpression ) {
-						fragmentName = this._checkForXMLCClassDefinition( XMLC, stmt.expression.right ) || fragmentName;
-					}
-				});
-				if ( fragmentName ) {
-					const fragmentModule = ModuleName.fromUI5LegacyName( fragmentName, ".control.xml" );
+				if (defineCall.factory.type === Syntax.ArrowFunctionExpression &&
+					defineCall.factory.expression === true) {
+					fragmentName = this._checkForXMLCClassDefinition(XMLC, defineCall.factory.body);
+				} else {
+					defineCall.factory.body.body.forEach((stmt) => {
+						if (stmt.type === Syntax.VariableDeclaration) {
+							stmt.declarations.forEach((decl) => {
+								fragmentName = this._checkForXMLCClassDefinition(XMLC, decl.init) || fragmentName;
+							});
+						} else if (
+							stmt.type === Syntax.ReturnStatement &&
+							( stmt?.argument?.type === Syntax.CallExpression && stmt.argument.arguments?.length > 1 &&
+								stmt.argument.arguments[1].type === Syntax.ObjectExpression)) {
+							fragmentName =
+								this._checkForXMLCClassDefinition(XMLC, stmt.argument) || fragmentName;
+						} else if (stmt.type === Syntax.ExpressionStatement &&
+							stmt.expression.type === Syntax.AssignmentExpression) {
+							fragmentName =
+								this._checkForXMLCClassDefinition(XMLC, stmt.expression.right) || fragmentName;
+						}
+					});
+				}
+				if (fragmentName) {
+					const fragmentModule = fromUI5LegacyName(fragmentName, ".control.xml");
 					log.verbose("fragment control: add dependency to template fragment %s", fragmentModule);
 					info.addDependency(fragmentModule);
 				}
@@ -42,8 +54,9 @@ class XMLCompositeAnalyzer {
 		let fragmentName;
 		if ( isMethodCall(stmt, [XMLC, "extend"]) ) {
 			// log.verbose(stmt);
-			if ( stmt.arguments.length > 0 && isString(stmt.arguments[0]) ) {
-				fragmentName = stmt.arguments[0].value;
+			const value = getStringValue(stmt.arguments[0]);
+			if ( stmt.arguments.length > 0 && value ) {
+				fragmentName = value;
 			}
 			if ( stmt.arguments.length > 1 && stmt.arguments[1].type === Syntax.ObjectExpression ) {
 				fragmentName = this._analyzeXMLCClassDefinition(stmt.arguments[1]) || fragmentName;
@@ -54,12 +67,9 @@ class XMLCompositeAnalyzer {
 
 	_analyzeXMLCClassDefinition(clazz) {
 		// log.verbose(clazz);
-		const fragmentName = getValue(clazz, ["fragment"]);
-		if ( isString(fragmentName) ) {
-			return fragmentName.value;
-		}
+		return getStringValue(getValue(clazz, ["fragment"]));
 	}
 }
 
 
-module.exports = XMLCompositeAnalyzer;
+export default XMLCompositeAnalyzer;