test(project): Add case for dependency content changes

This test should cover a scenario with an application depending on a library.
Specifically, we're directly modifying the contents of the library
which should have effects on the application because a custom task will detect it
and modify the application's resources. The application is expected to get rebuilt.

Author: maxreichmann

packages/project/test/fixtures/application.a/task.dependency-change.js

@@ -0,0 +1,36 @@
+// This is a modified version of the compileLicenseSummary example of the UI5 CLI.
+// (https://github.com/UI5/cli/blob/b72919469d856508dd757ecf325a5fb45f15e56d/internal/documentation/docs/pages/extensibility/CustomTasks.md#example-libtaskscompilelicensesummaryjs)
+
+module.exports = async function ({dependencies, log, taskUtil, workspace, options: {projectNamespace}}) {
+	const {createResource} = taskUtil.resourceFactory;
+    const projectsVisited = new Set();
+
+    async function processProject(project) {
+		return Promise.all(taskUtil.getDependencies().map(async (projectName) => {
+            if (projectName !== "library.d") {
+				return;
+			}
+			if (projectsVisited.has(projectName)) {
+                return;
+            }
+            projectsVisited.add(projectName);
+            const project = taskUtil.getProject(projectName);
+			const newLibraryFile = await project.getReader().byGlob("**/newLibraryFile.js");
+			if (newLibraryFile.length > 0) {
+				console.log('New Library file found. We are in #4 build.');
+				// Change content of application.a:
+				const applicationResource = await workspace.byPath("/resources/id1/controller/Base.controller.js");
+				const content = (await applicationResource.getString()) + "\n console.log('something new');";
+				await workspace.write(createResource({
+        			path: "/controller/Base.controller.js",
+        			string: content
+    			}));
+            } else {
+				console.log(`New Library file not found. We are still in an earlier build.`);
+            }
+            return processProject(project);
+        }));
+    }
+    // Start processing dependencies of the root project
+    await processProject(taskUtil.getProject());
+};

packages/project/test/fixtures/application.a/ui5-customTask-dependency-change.yaml

@@ -0,0 +1,18 @@
+---
+specVersion: "2.3"
+type: application
+metadata:
+  name: application.a
+builder:  
+  customTasks:
+    - name: dependency-change
+      afterTask: minify
+---
+specVersion: "5.0"
+kind: extension
+type: task
+metadata:
+  name: dependency-change
+task:
+  path: task.dependency-change.js
+

packages/project/test/fixtures/application.a/webapp/controller/Base.controller.js

@@ -0,0 +1,67 @@
+sap.ui.define(["sap/ui/core/mvc/Controller", "sap/ui/core/UIComponent", "sap/ui/core/routing/History"], function (Controller, UIComponent, History) {
+	"use strict";
+
+	return Controller.extend("com.myorg.myapp.controller.BaseController", {
+		/**
+		 * Convenience method to get the components' router instance.
+		 * @returns {sap.m.routing.Router} The router instance
+		 */
+		getRouter: function () {
+			return UIComponent.getRouterFor(this);
+		},
+
+		/**
+		 * Convenience method for getting the i18n resource bundle of the component.
+		 * @returns {Promise<sap.base.i18n.ResourceBundle>} The i18n resource bundle of the component
+		 */
+		getResourceBundle: function () {
+			const oModel = this.getOwnerComponent().getModel("i18n");
+			return oModel.getResourceBundle();
+		},
+
+		/**
+		 * Convenience method for getting the view model by name in every controller of the application.
+		 * @param {string} [sName] The model name
+		 * @returns {sap.ui.model.Model} The model instance
+		 */
+		getModel: function (sName) {
+			return this.getView().getModel(sName);
+		},
+
+		/**
+		 * Convenience method for setting the view model in every controller of the application.
+		 * @param {sap.ui.model.Model} oModel The model instance
+		 * @param {string} [sName] The model name
+		 * @returns {sap.ui.core.mvc.Controller} The current base controller instance
+		 */
+		setModel: function (oModel, sName) {
+			this.getView().setModel(oModel, sName);
+			return this;
+		},
+
+		/**
+		 * Convenience method for triggering the navigation to a specific target.
+		 * @public
+		 * @param {string} sName Target name
+		 * @param {object} [oParameters] Navigation parameters
+		 * @param {boolean} [bReplace] Defines if the hash should be replaced (no browser history entry) or set (browser history entry)
+		 */
+		navTo: function (sName, oParameters, bReplace) {
+			this.getRouter().navTo(sName, oParameters, undefined, bReplace);
+		},
+
+		/**
+		 * Convenience event handler for navigating back.
+		 * It there is a history entry we go one step back in the browser history
+		 * If not, it will replace the current entry of the browser history with the main route.
+		 */
+		onNavBack: function () {
+			const sPreviousHash = History.getInstance().getPreviousHash();
+			if (sPreviousHash !== undefined) {
+				window.history.go(-1);
+			} else {
+				this.getRouter().navTo("main", {}, undefined, true);
+			}
+		}
+	});
+});

packages/project/test/lib/build/ProjectBuilder.integration.js

@@ -361,6 +361,90 @@ test.serial.skip("Build application.a (multiple custom tasks 2)", async (t) => {
 	await t.throwsAsync(fs.readFile(`${destPath}/test.js`, {encoding: "utf8"}));
 });
 
+test.skip.serial("Build application.a (dependency content changes)", async (t) => {
+	const fixtureTester = new FixtureTester(t, "application.a");
+	const destPath = fixtureTester.destPath;
+
+	// This test should cover a scenario with an application depending on a library.
+	// Specifically, we're directly modifying the contents of the library
+	// which should have effects on the application because a custom task will detect it
+	// and modify the application's resources. The application is expected to get rebuilt.
+
+	// #1 build (no cache, no changes, no dependencies)
+	await fixtureTester.buildProject({
+		graphConfig: {rootConfigPath: "ui5-customTask-dependency-change.yaml"},
+		config: {destPath, cleanDest: true},
+		assertions: {
+			projects: {
+				"application.a": {}
+			}
+		}
+	});
+
+
+	// #2 build (with cache, no changes, no dependencies)
+	await fixtureTester.buildProject({
+		graphConfig: {rootConfigPath: "ui5-customTask-dependency-change.yaml"},
+		config: {destPath, cleanDest: true},
+		assertions: {
+			projects: {}
+		}
+	});
+
+
+	// Change content of library.d (this will not affect application.a):
+	const someJsOfLibrary = `${fixtureTester.fixturePath}/node_modules/library.d/main/src/library/d/some.js`;
+	await fs.appendFile(someJsOfLibrary, `\ntest("line added");\n`);
+
+	// #3 build (with cache, with changes, with dependencies)
+	await fixtureTester.buildProject({
+		graphConfig: {rootConfigPath: "ui5-customTask-dependency-change.yaml"},
+		config: {destPath, cleanDest: true, dependencyIncludes: {includeAllDependencies: true}},
+		assertions: {
+			projects: {
+				"library.d": {},
+				"library.a": {},
+				"library.b": {},
+				"library.c": {},
+			}
+		}
+	});
+
+	// Check if library contains correct changed content:
+	const builtFileContent = await fs.readFile(`${destPath}/resources/library/d/some.js`, {encoding: "utf8"});
+	t.true(builtFileContent.includes(`test("line added");`), "Build dest contains changed file content");
+
+
+	// Change content of library.d again (this time it affects application.a):
+	await fs.writeFile(`${fixtureTester.fixturePath}/node_modules/library.d/main/src/library/d/newLibraryFile.js`,
+		`console.log("SOME NEW CONTENT");`);
+
+	// #4 build (no cache, with changes, with dependencies)
+	// This build should execute the custom task "task.dependency-change.js" again which now detects "newLibraryFile.js"
+	// and modifies a resource of application.a (namely Base.controller.js).
+	await fixtureTester.buildProject({
+		graphConfig: {rootConfigPath: "ui5-customTask-dependency-change.yaml"},
+		config: {destPath, cleanDest: true, dependencyIncludes: {includeAllDependencies: true}},
+		assertions: {
+			projects: {
+				"library.d": {},
+				"application.a": { // FIXME: currently failing (getting skipped entirely)
+					skippedTasks: [
+						"enhanceManifest",
+						"escapeNonAsciiCharacters",
+						"generateFlexChangesBundle",
+						"replaceCopyright",
+					]
+				},
+			}
+		}
+	});
+
+	// Check that application.a contains correct changed content (Base.controller.js):
+	const builtFileContent2 = await fs.readFile(`${destPath}/controller/Base.controller.js`, {encoding: "utf8"});
+	t.true(builtFileContent2.includes(`console.log('something new');`), "Build dest contains changed file content");
+});
+
 test.serial("Build library.d project multiple times", async (t) => {
 	const fixtureTester = new FixtureTester(t, "library.d");
 	const destPath = fixtureTester.destPath;