[FIX] generateResourcesJson: Make resources.json generation deterministic

lib/lbt/resources/ResourceCollector.js

@@ -150,16 +150,25 @@ class ResourceCollector {
 		});
 	}
 
-	async determineResourceDetails({pool, debugResources, mergedResources, designtimeResources, supportResources}) {
+	async determineResourceDetails({
+		debugResources, mergedResources, designtimeResources, supportResources, debugBundles
+	}) {
 		const baseNames = new Set();
 		const debugFilter = new ResourceFilterList(debugResources);
 		const mergeFilter = new ResourceFilterList(mergedResources);
 		const designtimeFilter = new ResourceFilterList(designtimeResources);
 		const supportFilter = new ResourceFilterList(supportResources);
+		const debugBundleFilter = new ResourceFilterList(debugBundles);
 
 		const promises = [];
+		const nonBundledDebugResources = [];
 
 		for (const [name, info] of this._resources.entries()) {
+			if ( debugFilter.matches(name) ) {
+				info.isDebug = true;
+				log.verbose(`  found potential debug resource '${name}'`);
+			}
+
 			// log.verbose(`  checking ${name}`);
 			let m;
 			if ( m = LOCALE.exec(name) ) {
@@ -180,9 +189,14 @@ class ResourceCollector {
 			}
 
 			if ( /(?:\.js|\.view\.xml|\.control\.xml|\.fragment\.xml)$/.test(name) ) {
-				promises.push(
-					this.enrichWithDependencyInfo(info)
-				);
+				if ( (!info.isDebug || debugBundleFilter.matches(name)) ) {
+					// Only analyze non-debug files which are not special debug bundles (like sap-ui-core-dbg.js)
+					promises.push(
+						this.enrichWithDependencyInfo(info)
+					);
+				} else {
+					nonBundledDebugResources.push(info);
+				}
 			}
 
 			// set the module name for .properties and .json
@@ -197,11 +211,6 @@ class ResourceCollector {
 				}));
 			}
 
-			if ( debugFilter.matches(name) ) {
-				info.isDebug = true;
-				log.verbose(`  found potential debug resource '${name}'`);
-			}
-
 			if ( mergeFilter.matches(name) ) {
 				info.merged = true;
 				log.verbose(`  found potential merged resource '${name}'`);
@@ -226,7 +235,17 @@ class ResourceCollector {
 			}
 		}
 
-		return Promise.all(promises);
+		await Promise.all(promises);
+
+		for (let i = nonBundledDebugResources.length - 1; i >= 0; i--) {
+			const dbgInfo = nonBundledDebugResources[i];
+			const nonDebugName = ResourceInfoList.getNonDebugName(dbgInfo.name);
+			const nonDbgInfo = this._resources.get(nonDebugName);
+			const newDbgInfo = new ResourceInfo(dbgInfo.name);
+			newDbgInfo.copyFrom(null, nonDbgInfo);
+			newDbgInfo.copyFrom(null, dbgInfo);
+			this._resources.set(dbgInfo.name, newDbgInfo);
+		}
 	}
 
 	createOrphanFilters() {
@@ -253,19 +272,17 @@ class ResourceCollector {
 
 	groupResourcesByComponents(options) {
 		const orphanFilters = this.createOrphanFilters();
-		const debugBundlesFilter = new ResourceFilterList(options.debugBundles);
 		for (const resource of this._resources.values()) {
 			let contained = false;
 			for (const [prefix, list] of this._components.entries()) {
-				const isDebugBundle = debugBundlesFilter.matches(resource.name);
 				if ( resource.name.startsWith(prefix) ) {
-					list.add(resource, !isDebugBundle);
+					list.add(resource);
 					contained = true;
 				} else if ( orphanFilters.has(prefix) ) {
 					// log.verbose(`  checking '${resource.name}' against orphan filter ` +
 					// 	`'${orphanFilters.get(prefix)}' (${prefix})`);
 					if ( orphanFilters.get(prefix).matches(resource.name) ) {
-						list.add(resource, !isDebugBundle);
+						list.add(resource);
 						contained = true;
 					}
 				}

lib/lbt/resources/ResourceInfoList.js

@@ -1,7 +1,6 @@
 const ResourceInfo = require("./ResourceInfo");
 
 const DEBUG_RESOURCES_PATTERN = /-dbg((?:\.view|\.fragment|\.controller|\.designtime|\.support)?\.js|\.css)$/;
-const RESOURCES_PATTERN = /((?:\.view|\.fragment|\.controller|\.designtime|\.support)?\.js|\.css)$/;
 
 /**
  * A list of ResourceInfo objects, suitable for (but not dependent on) JSON serialization.
@@ -39,37 +38,12 @@ class ResourceInfoList {
 	 * Add ResourceInfo to list
 	 *
 	 * @param {ResourceInfo} info
-	 * @param {boolean} shareDebugInformation
 	 */
-	add(info, shareDebugInformation=true) {
+	add(info) {
 		const relativeName = ResourceInfoList.makePathRelativeTo(this.name, info.name);
-
 		// search for a resource with the same name
 		let myInfo = this.resourcesByName.get(relativeName);
 
-		if ( myInfo == null && shareDebugInformation) {
-			// when not found, check if the given resource is a debug resource and
-			// share the information with the non-dbg version
-			const nonDbgName = ResourceInfoList.getNonDebugName(relativeName);
-			const dbgName = ResourceInfoList.getDebugName(relativeName);
-			if ( nonDbgName != null && this.resourcesByName.has(nonDbgName) ) {
-				// copy from source
-				myInfo = new ResourceInfo(relativeName);
-				const source = this.resourcesByName.get(nonDbgName);
-				myInfo.copyFrom(this.name, source);
-				this.resources.push(myInfo);
-				this.resourcesByName.set(relativeName, myInfo);
-			} else if (dbgName != null && this.resourcesByName.has(dbgName)) {
-				// copy from debug
-				myInfo = new ResourceInfo(relativeName);
-				const source = this.resourcesByName.get(dbgName);
-				myInfo.copyFrom(this.name, source);
-				myInfo.module = ResourceInfoList.getNonDebugName(source.module);
-				this.resources.push(myInfo);
-				this.resourcesByName.set(relativeName, myInfo);
-			}
-		}
-
 		// this is the assumption, that the debug one is the same as the non-dbg one
 		if ( myInfo == null ) {
 			myInfo = new ResourceInfo(relativeName);
@@ -139,15 +113,6 @@ class ResourceInfoList {
 		}
 		return null;
 	}
-
-	static getDebugName(path) {
-		if ( RESOURCES_PATTERN.test(path) ) {
-			if (!path.replace(RESOURCES_PATTERN, "").endsWith("-dbg")) {
-				return path.replace( RESOURCES_PATTERN, "-dbg$1");
-			}
-		}
-		return null;
-	}
 }
 
 module.exports = ResourceInfoList;

lib/processors/resourceListCreator.js

@@ -73,7 +73,8 @@ const DEFAULT_SUPPORT_RESOURCES_FILTER = [
  * @type {string[]}
  */
 const DEBUG_BUNDLES = [
-	"sap-ui-core-dbg.js"
+	"sap-ui-core-dbg.js",
+	"sap-ui-core-nojQuery-dbg.js"
 ];
 
 /**
@@ -159,13 +160,12 @@ module.exports = async function({resources, options}) {
 		debugResources: options.debugResources,
 		mergedResources: options.mergedResources,
 		designtimeResources: options.designtimeResources,
-		supportResources: options.supportResources
+		supportResources: options.supportResources,
+		debugBundles: options.debugBundles
 	});
 
 	// group resources by components and create ResourceInfoLists
-	collector.groupResourcesByComponents({
-		debugBundles: options.debugBundles
-	});
+	collector.groupResourcesByComponents();
 
 	const resourceLists = [];
 

test/lib/lbt/resources/ResourceCollector.js

@@ -80,7 +80,7 @@ test.serial("groupResourcesByComponents: debugBundles", async (t) => {
 	});
 	await resourceCollector.visitResource({getPath: () => "/resources/testcomp/Component.js", getSize: async () => 13});
 	await resourceCollector.visitResource({getPath: () => "/resources/my/file.js", getSize: async () => 13});
-	resourceCollector.groupResourcesByComponents({debugBundles: [".*-dbg.js"]});
+	resourceCollector.groupResourcesByComponents();
 	t.is(resourceCollector.resources.size, 0, "all resources were deleted");
 });
 
@@ -89,7 +89,7 @@ test.serial("groupResourcesByComponents: theme", async (t) => {
 	await resourceCollector.visitResource({getPath: () => "/resources/themes/a/.theming", getSize: async () => 13});
 	t.is(resourceCollector.themePackages.size, 1, "1 theme was added");
 	await resourceCollector.determineResourceDetails({});
-	resourceCollector.groupResourcesByComponents({});
+	resourceCollector.groupResourcesByComponents();
 	t.is(resourceCollector.themePackages.get("themes/a/").resources.length, 1, "1 theme was grouped");
 });
 
@@ -111,20 +111,14 @@ test.serial("determineResourceDetails: properties", async (t) => {
 		getPath: () => "/resources/mylib/i18n/i18n.properties", getSize: async () => 13
 	});
 	await resourceCollector.determineResourceDetails({});
-	resourceCollector.groupResourcesByComponents({});
+	resourceCollector.groupResourcesByComponents();
 	const resources = resourceCollector.components.get("mylib/").resources;
 	t.deepEqual(resources.map((res) => res.i18nName),
 		[null, "i18n/i18n.properties", "i18n/i18n.properties"], "i18nName was set");
 });
 
 test.serial("determineResourceDetails: view.xml", async (t) => {
-	const resourceCollector = new ResourceCollector({
-		getModuleInfo: async (moduleInfo) => {
-			return {
-				name: "myName"
-			};
-		}
-	});
+	const resourceCollector = new ResourceCollector();
 	const enrichWithDependencyInfoStub = sinon.stub(resourceCollector, "enrichWithDependencyInfo")
 		.returns(Promise.resolve());
 	await resourceCollector.visitResource({getPath: () => "/resources/mylib/my.view.xml", getSize: async () => 13});
@@ -133,6 +127,72 @@ test.serial("determineResourceDetails: view.xml", async (t) => {
 	t.is(enrichWithDependencyInfoStub.getCall(0).args[0].name, "mylib/my.view.xml", "is called with view");
 });
 
+test.serial("determineResourceDetails: Debug bundle", async (t) => {
+	const resourceCollector = new ResourceCollector();
+
+	const enrichWithDependencyInfoStub = sinon.stub(resourceCollector, "enrichWithDependencyInfo").resolves();
+	await resourceCollector.visitResource({getPath: () => "/resources/MyBundle-dbg.js", getSize: async () => 13});
+
+	await resourceCollector.determineResourceDetails({
+		debugBundles: ["MyBundle-dbg.js"]
+	});
+	t.is(enrichWithDependencyInfoStub.callCount, 1, "enrichWithDependencyInfo is called once");
+	t.is(enrichWithDependencyInfoStub.getCall(0).args[0].name, "MyBundle-dbg.js",
+		"enrichWithDependencyInfo is called with debug bundle");
+});
+
+test.serial("determineResourceDetails: Debug files and non-debug files", async (t) => {
+	const resourceCollector = new ResourceCollector();
+
+	const enrichWithDependencyInfoStub = sinon.stub(resourceCollector, "enrichWithDependencyInfo")
+		.callsFake((resourceInfo) => {
+			// Simulate enriching resource info with dependency info to test whether it gets shared
+			// with the dbg resource alter on
+			resourceInfo.dynRequired = true;
+		});
+	await Promise.all([
+		"/resources/MyBundle-dbg.js",
+		"/resources/mylib/MyControlA-dbg.js",
+		"/resources/mylib/MyControlA.js",
+		"/resources/mylib/MyControlB.js",
+		"/resources/mylib/MyControlB-dbg.js"
+	].map((resourcePath) => {
+		return resourceCollector.visitResource({getPath: () => resourcePath, getSize: async () => 13});
+	}));
+
+	await resourceCollector.determineResourceDetails({
+		debugResources: ["**/*-dbg.js"],
+		debugBundles: ["MyBundle-dbg.js"]
+	});
+	t.is(enrichWithDependencyInfoStub.callCount, 3, "enrichWithDependencyInfo is called three times");
+	t.is(enrichWithDependencyInfoStub.getCall(0).args[0].name, "MyBundle-dbg.js",
+		"enrichWithDependencyInfo called with debug bundle");
+	t.is(enrichWithDependencyInfoStub.getCall(1).args[0].name, "mylib/MyControlA.js",
+		"enrichWithDependencyInfo called with non-debug control A");
+	t.is(enrichWithDependencyInfoStub.getCall(2).args[0].name, "mylib/MyControlB.js",
+		"enrichWithDependencyInfo called with non-debug control B");
+
+	t.is(resourceCollector._resources.get("MyBundle-dbg.js").isDebug, true, "MyBundle-dbg is a debug file");
+	t.is(resourceCollector._resources.get("MyBundle-dbg.js").dynRequired, true,
+		"MyBundle-dbg is flagged as dynRequired");
+
+	t.is(resourceCollector._resources.get("mylib/MyControlA.js").isDebug, false, "MyControlA is no debug file");
+	t.is(resourceCollector._resources.get("mylib/MyControlA.js").dynRequired, true,
+		"MyControlA is flagged as dynRequired");
+
+	t.is(resourceCollector._resources.get("mylib/MyControlA-dbg.js").isDebug, true, "MyControlA-dbg is a debug file");
+	t.is(resourceCollector._resources.get("mylib/MyControlA-dbg.js").dynRequired, true,
+		"MyControlA-dbg is flagged as dynRequired");
+
+	t.is(resourceCollector._resources.get("mylib/MyControlB.js").isDebug, false, "MyControlB is no debug file");
+	t.is(resourceCollector._resources.get("mylib/MyControlB.js").dynRequired, true,
+		"MyControlB is flagged as dynRequired");
+
+	t.is(resourceCollector._resources.get("mylib/MyControlB-dbg.js").isDebug, true, "MyControlB-dbg is a debug file");
+	t.is(resourceCollector._resources.get("mylib/MyControlB-dbg.js").dynRequired, true,
+		"MyControlB-dbg is flagged as dynRequired");
+});
+
 test.serial("enrichWithDependencyInfo: add infos to resourceinfo", async (t) => {
 	const resourceCollector = new ResourceCollector({
 		getModuleInfo: async () => {

test/lib/lbt/resources/ResourceInfoList.js

@@ -16,38 +16,28 @@ test("add: add new resources", (t) => {
 	t.falsy(result.module, "module is not set");
 });
 
-test("add: add source then debug resources", (t) => {
+test("add: add non-debug resource", (t) => {
 	const resourceInfoList = new ResourceInfoList("prefix");
 
-	resourceInfoList.add({name: "myfile.js", module: "myfile.js", size: 13});
+	resourceInfoList.add({name: "myfile.js", module: "myfile.js", size: 13, required: new Set(["some-dep.js"])});
 
-	const myInfo = {name: "myfile-dbg.js", size: 13};
-	resourceInfoList.add(myInfo);
-
-	t.is(resourceInfoList.resources.length, 2, "two entries");
+	t.is(resourceInfoList.resources.length, 1, "one resource added");
 
 	const result = resourceInfoList.resourcesByName.get("../myfile.js");
 	t.is(result.module, "myfile.js", "module is set");
-
-	const resultDbg = resourceInfoList.resourcesByName.get("../myfile-dbg.js");
-	t.is(resultDbg.module, "myfile.js", "module is set");
+	t.deepEqual(result.required, new Set(["some-dep.js"]), "module is set");
 });
 
-test("add: add debug then source resources", (t) => {
+test("add: add debug resources", (t) => {
 	const resourceInfoList = new ResourceInfoList("prefix");
 
-	resourceInfoList.add({name: "myfile-dbg.js", size: 13});
+	resourceInfoList.add({name: "myfile-dbg.js", size: 13, required: new Set(["some-dep.js"])});
 
-	const myInfo = {name: "myfile.js", module: "myfile.js", size: 13};
-	resourceInfoList.add(myInfo);
-
-	t.is(resourceInfoList.resources.length, 2, "two entries");
-
-	const result = resourceInfoList.resourcesByName.get("../myfile.js");
-	t.is(result.module, "myfile.js", "module is set");
+	t.is(resourceInfoList.resources.length, 1, "one resource added");
 
 	const resultDbg = resourceInfoList.resourcesByName.get("../myfile-dbg.js");
 	t.is(resultDbg.module, "myfile.js", "module is set");
+	t.deepEqual(resultDbg.required, new Set(["some-dep.js"]), "module is set");
 });
 
 test("add: add i18n resource", (t) => {