[FEATURE] Enhance generateFlexChangeBundle task to add new 'flexBundle' property to the manifest.json

lib/tasks/bundlers/generateFlexChangesBundle.js

@@ -14,7 +14,7 @@ import semver from "semver";
  * at runtime.
  * If a change bundle is created, "sap.ui.fl" is added as a dependency to the manifest.json if not already present -
  * if the dependency is already listed but lazy-loaded, lazy loading is disabled.
- * If minUI5Version >= 1.73 flexibility-bundle.json will be create.
+ * If minUI5Version >= 1.73 flexibility-bundle.json is created.
  * If there are control variants and minUI5Version < 1.73 build will break and throw an error.
  *
  * @public
@@ -38,29 +38,34 @@ export default async function({workspace, taskUtil, options = {}}) {
 		pathPrefix = `/resources/${namespace}`;
 	}
 
-	function updateJson(data) {
-		// ensure the existence of the libs section in the dependencies
+	function updateJson(data, bBundleCreated) {
 		data["sap.ui5"] = data["sap.ui5"] || {};
-		data["sap.ui5"].dependencies = data["sap.ui5"].dependencies || {};
-		const mLibs = data["sap.ui5"].dependencies.libs = data["sap.ui5"].dependencies.libs || {};
-
-		if (mLibs["sap.ui.fl"]) {
-			log.verbose("sap.ui.fl found in manifest.json");
-			if (mLibs["sap.ui.fl"].lazy) {
-				log.verbose("sap.ui.fl 'lazy' attribute found in manifest.json, setting it to false...");
-				mLibs["sap.ui.fl"].lazy = false;
+		// explicit set the flag to inform the runtime if a bundle is present before the preload can be interpreted
+		data["sap.ui5"].flexBundle = bBundleCreated;
+
+		if (bBundleCreated) {
+			// ensure the existence of the libs section in the dependencies
+			data["sap.ui5"].dependencies = data["sap.ui5"].dependencies || {};
+			const mLibs = data["sap.ui5"].dependencies.libs = data["sap.ui5"].dependencies.libs || {};
+
+			if (mLibs["sap.ui.fl"]) {
+				log.verbose("sap.ui.fl found in manifest.json");
+				if (mLibs["sap.ui.fl"].lazy) {
+					log.verbose("sap.ui.fl 'lazy' attribute found in manifest.json, setting it to false...");
+					mLibs["sap.ui.fl"].lazy = false;
+				}
+			} else {
+				log.verbose("sap.ui.fl not found in manifest.json, inserting it...");
+				mLibs["sap.ui.fl"] = {};
 			}
-		} else {
-			log.verbose("sap.ui.fl not found in manifest.json, inserting it...");
-			mLibs["sap.ui.fl"] = {};
 		}
 	}
 
-	async function updateFLdependency() {
+	async function updateManifestWithFlDependencyAndFlexBundleFlag(bBundleCreated) {
 		const manifestResource = await workspace.byPath(`${pathPrefix}/manifest.json`);
 		const manifestContent = JSON.parse(await manifestResource.getString());
 
-		updateJson(manifestContent);
+		updateJson(manifestContent, bBundleCreated);
 		manifestResource.setString(JSON.stringify(manifestContent, null, "\t"));
 
 		await workspace.write(manifestResource);
@@ -83,6 +88,10 @@ export default async function({workspace, taskUtil, options = {}}) {
 	log.verbose("Collecting flexibility changes");
 	const allResources = await workspace.byGlob(
 		`${pathPrefix}/changes/*.{change,variant,ctrl_variant,ctrl_variant_change,ctrl_variant_management_change}`);
+
+	let bBundleCreated = false;
+	let manifestUpdated = false;
+
 	if (allResources.length > 0) {
 		const versionArray = await readManifestMinUI5Version();
 		const versions = versionArray.map((version) => semver.coerce(version));
@@ -108,10 +117,10 @@ export default async function({workspace, taskUtil, options = {}}) {
 			log.verbose("Writing flexibility changes bundle");
 			return workspace.write(resource);
 		}));
-		// Add the sap.ui.fl dependency if a bundle has been created
-		if (processedResources.length > 0) {
-			await updateFLdependency();
-		}
+		// Add the sap.ui.fl dependency if a bundle has been created and flag if a bundle was created
+		bBundleCreated = processedResources.length > 0;
+		await updateManifestWithFlDependencyAndFlexBundleFlag(bBundleCreated);
+		manifestUpdated = true;
 
 		// Do not write bundled source files to build result
 		if (taskUtil) {
@@ -120,4 +129,9 @@ export default async function({workspace, taskUtil, options = {}}) {
 			});
 		}
 	}
+
+	// Always append the flexBundle flag to the manifest.json, even if no bundle was created
+	if (!manifestUpdated) {
+		await updateManifestWithFlDependencyAndFlexBundleFlag(bBundleCreated);
+	}
 }

test/expected/build/application.a/dest-deps-excl/manifest.json

@@ -1,13 +1,18 @@
 {
-    "_version": "1.1.0",
-    "sap.app": {
-        "_version": "1.1.0",
-        "id": "id1",
-        "type": "application",
-        "applicationVersion": {
-            "version": "1.2.2"
-        },
-        "embeds": ["embedded"],
-        "title": "{{title}}"
-    }
+	"_version": "1.1.0",
+	"sap.app": {
+		"_version": "1.1.0",
+		"id": "id1",
+		"type": "application",
+		"applicationVersion": {
+			"version": "1.2.2"
+		},
+		"embeds": [
+			"embedded"
+		],
+		"title": "{{title}}"
+	},
+	"sap.ui5": {
+		"flexBundle": false
+	}
 }

test/expected/build/application.a/dest-deps/manifest.json

@@ -1,13 +1,18 @@
 {
-    "_version": "1.1.0",
-    "sap.app": {
-        "_version": "1.1.0",
-        "id": "id1",
-        "type": "application",
-        "applicationVersion": {
-            "version": "1.2.2"
-        },
-        "embeds": ["embedded"],
-        "title": "{{title}}"
-    }
+	"_version": "1.1.0",
+	"sap.app": {
+		"_version": "1.1.0",
+		"id": "id1",
+		"type": "application",
+		"applicationVersion": {
+			"version": "1.2.2"
+		},
+		"embeds": [
+			"embedded"
+		],
+		"title": "{{title}}"
+	},
+	"sap.ui5": {
+		"flexBundle": false
+	}
 }

test/expected/build/application.a/dest-depself/manifest.json

@@ -1,13 +1,18 @@
 {
-    "_version": "1.1.0",
-    "sap.app": {
-        "_version": "1.1.0",
-        "id": "id1",
-        "type": "application",
-        "applicationVersion": {
-            "version": "1.2.2"
-        },
-        "embeds": ["embedded"],
-        "title": "{{title}}"
-    }
+	"_version": "1.1.0",
+	"sap.app": {
+		"_version": "1.1.0",
+		"id": "id1",
+		"type": "application",
+		"applicationVersion": {
+			"version": "1.2.2"
+		},
+		"embeds": [
+			"embedded"
+		],
+		"title": "{{title}}"
+	},
+	"sap.ui5": {
+		"flexBundle": false
+	}
 }

test/expected/build/application.a/dest-self/manifest.json

@@ -1,13 +1,18 @@
 {
-    "_version": "1.1.0",
-    "sap.app": {
-        "_version": "1.1.0",
-        "id": "id1",
-        "type": "application",
-        "applicationVersion": {
-            "version": "1.2.2"
-        },
-        "embeds": ["embedded"],
-        "title": "{{title}}"
-    }
+	"_version": "1.1.0",
+	"sap.app": {
+		"_version": "1.1.0",
+		"id": "id1",
+		"type": "application",
+		"applicationVersion": {
+			"version": "1.2.2"
+		},
+		"embeds": [
+			"embedded"
+		],
+		"title": "{{title}}"
+	},
+	"sap.ui5": {
+		"flexBundle": false
+	}
 }

test/expected/build/application.a/dest/manifest.json

@@ -1,13 +1,18 @@
 {
-    "_version": "1.1.0",
-    "sap.app": {
-        "_version": "1.1.0",
-        "id": "id1",
-        "type": "application",
-        "applicationVersion": {
-            "version": "1.2.2"
-        },
-        "embeds": ["embedded"],
-        "title": "{{title}}"
-    }
+	"_version": "1.1.0",
+	"sap.app": {
+		"_version": "1.1.0",
+		"id": "id1",
+		"type": "application",
+		"applicationVersion": {
+			"version": "1.2.2"
+		},
+		"embeds": [
+			"embedded"
+		],
+		"title": "{{title}}"
+	},
+	"sap.ui5": {
+		"flexBundle": false
+	}
 }

test/expected/build/application.g/cachebuster/manifest.json

@@ -1,14 +1,19 @@
 {
-    "_version": "1.1.0",
-    "sap.app": {
-        "_version": "1.1.0",
-        "id": "application.g",
-        "type": "application",
-        "applicationVersion": {
-            "version": "1.0.0"
-        },
-        "embeds": ["embedded"],
-        "title": "{{title}}"
-    },
-    "customCopyrightString": "Some fancy copyright"
-}
+	"_version": "1.1.0",
+	"sap.app": {
+		"_version": "1.1.0",
+		"id": "application.g",
+		"type": "application",
+		"applicationVersion": {
+			"version": "1.0.0"
+		},
+		"embeds": [
+			"embedded"
+		],
+		"title": "{{title}}"
+	},
+	"customCopyrightString": "Some fancy copyright",
+	"sap.ui5": {
+		"flexBundle": false
+	}
+}

test/expected/build/application.g/dest/manifest.json

@@ -1,14 +1,19 @@
 {
-    "_version": "1.1.0",
-    "sap.app": {
-        "_version": "1.1.0",
-        "id": "application.g",
-        "type": "application",
-        "applicationVersion": {
-            "version": "1.0.0"
-        },
-        "embeds": ["embedded"],
-        "title": "{{title}}"
-    },
-    "customCopyrightString": "Some fancy copyright"
-}
+	"_version": "1.1.0",
+	"sap.app": {
+		"_version": "1.1.0",
+		"id": "application.g",
+		"type": "application",
+		"applicationVersion": {
+			"version": "1.0.0"
+		},
+		"embeds": [
+			"embedded"
+		],
+		"title": "{{title}}"
+	},
+	"customCopyrightString": "Some fancy copyright",
+	"sap.ui5": {
+		"flexBundle": false
+	}
+}

test/expected/build/application.h/dest/manifest.json

@@ -1,13 +1,18 @@
 {
-    "_version": "1.1.0",
-    "sap.app": {
-        "_version": "1.1.0",
-        "id": "application.h",
-        "type": "application",
-        "applicationVersion": {
-            "version": "1.2.2"
-        },
-        "embeds": ["embedded"],
-        "title": "{{title}}"
-    }
-}
+	"_version": "1.1.0",
+	"sap.app": {
+		"_version": "1.1.0",
+		"id": "application.h",
+		"type": "application",
+		"applicationVersion": {
+			"version": "1.2.2"
+		},
+		"embeds": [
+			"embedded"
+		],
+		"title": "{{title}}"
+	},
+	"sap.ui5": {
+		"flexBundle": false
+	}
+}