[FEATURE] Sapui5MavenSnapshotResolver: Expose cacheMode parameter through all APIs

lib/graph/graph.js

@@ -31,6 +31,8 @@ const log = getLogger("generateProjectGraph");
  * 		Whether framework dependencies should be added to the graph
  * @param {string} [options.workspaceName]
  * 		Name of the workspace configuration that should be used if any is provided
+ * @param {module:@ui5/project/ui5Framework/maven/CacheMode} [options.cacheMode]
+ *      Cache mode to use when consuming SNAPSHOT versions of a framework
  * @param {string} [options.workspaceConfigPath=ui5-workspace.yaml]
  * 		Workspace configuration file to use if no object has been provided
  * @param {@ui5/project/graph/Workspace~Configuration} [options.workspaceConfiguration]
@@ -40,7 +42,7 @@ const log = getLogger("generateProjectGraph");
  */
 export async function graphFromPackageDependencies({
 	cwd, rootConfiguration, rootConfigPath,
-	versionOverride, resolveFrameworkDependencies = true,
+	versionOverride, cacheMode, resolveFrameworkDependencies = true,
 	workspaceName /* TODO 4.0: default workspaceName to "default" ? */,
 	workspaceConfiguration, workspaceConfigPath = "ui5-workspace.yaml"
 }) {
@@ -71,7 +73,7 @@ export async function graphFromPackageDependencies({
 	const projectGraph = await projectGraphBuilder(provider, workspace);
 
 	if (resolveFrameworkDependencies) {
-		await ui5Framework.enrichProjectGraph(projectGraph, {versionOverride, workspace});
+		await ui5Framework.enrichProjectGraph(projectGraph, {versionOverride, cacheMode, workspace});
 	}
 
 	return projectGraph;
@@ -93,14 +95,16 @@ export async function graphFromPackageDependencies({
  *		Configuration file to use for the root module instead the default ui5.yaml. Either a path relative to
  *		<code>cwd</code> or an absolute path. In both case, platform-specific path segment separators must be used.
  * @param {string} [options.versionOverride] Framework version to use instead of the one defined in the root project
+ * @param {module:@ui5/project/ui5Framework/maven/CacheMode} [options.cacheMode]
+ *      Cache mode to use when consuming SNAPSHOT versions
  * @param {string} [options.resolveFrameworkDependencies=true]
  *		Whether framework dependencies should be added to the graph
  * @returns {Promise<@ui5/project/graph/ProjectGraph>} Promise resolving to a Project Graph instance
  */
 export async function graphFromStaticFile({
 	filePath = "projectDependencies.yaml", cwd,
 	rootConfiguration, rootConfigPath,
-	versionOverride, resolveFrameworkDependencies = true
+	versionOverride, cacheMode, resolveFrameworkDependencies = true
 }) {
 	log.verbose(`Creating project graph using static file...`);
 	const {
@@ -121,7 +125,7 @@ export async function graphFromStaticFile({
 	const projectGraph = await projectGraphBuilder(provider);
 
 	if (resolveFrameworkDependencies) {
-		await ui5Framework.enrichProjectGraph(projectGraph, {versionOverride});
+		await ui5Framework.enrichProjectGraph(projectGraph, {versionOverride, cacheMode});
 	}
 
 	return projectGraph;
@@ -143,14 +147,16 @@ export async function graphFromStaticFile({
  *		Configuration file to use for the root module instead the default ui5.yaml. Either a path relative to
  *		<code>cwd</code> or an absolute path. In both case, platform-specific path segment separators must be used.
  * @param {string} [options.versionOverride] Framework version to use instead of the one defined in the root project
+ * @param {module:@ui5/project/ui5Framework/maven/CacheMode} [options.cacheMode]
+ *      Cache mode to use when consuming SNAPSHOT versions
  * @param {string} [options.resolveFrameworkDependencies=true]
  *		Whether framework dependencies should be added to the graph
  * @returns {Promise<@ui5/project/graph/ProjectGraph>} Promise resolving to a Project Graph instance
 */
 export async function graphFromObject({
 	dependencyTree, cwd,
 	rootConfiguration, rootConfigPath,
-	versionOverride, resolveFrameworkDependencies = true
+	versionOverride, cacheMode, resolveFrameworkDependencies = true
 }) {
 	log.verbose(`Creating project graph using object...`);
 	const {
@@ -169,7 +175,7 @@ export async function graphFromObject({
 	const projectGraph = await projectGraphBuilder(dependencyTreeProvider);
 
 	if (resolveFrameworkDependencies) {
-		await ui5Framework.enrichProjectGraph(projectGraph, {versionOverride});
+		await ui5Framework.enrichProjectGraph(projectGraph, {versionOverride, cacheMode});
 	}
 
 	return projectGraph;

lib/graph/helpers/ui5Framework.js

@@ -280,15 +280,15 @@ export default {
 	 * @param {object} [options]
 	 * @param {string} [options.versionOverride] Framework version to use instead of the root projects framework
 	 *   version
+	 * @param {module:@ui5/project/ui5Framework/maven/CacheMode} [options.cacheMode]
+ 	 *   Cache mode to use when consuming SNAPSHOT versions
 	 * @param {@ui5/project/graph/Workspace} [options.workspace]
 	 *   Optional workspace instance to use for overriding node resolutions
-	 * @param {object} [options.resolverConfig]
-	 *   Optional configuration object to use for the resolvers
 	 * @returns {Promise<@ui5/project/graph/ProjectGraph>}
 	 *   Promise resolving with the given graph instance to allow method chaining
 	 */
 	enrichProjectGraph: async function(projectGraph, options = {}) {
-		const {workspace} = options;
+		const {workspace, cacheMode} = options;
 		const rootProject = projectGraph.getRoot();
 		const frameworkName = rootProject.getFrameworkName();
 		const frameworkVersion = rootProject.getFrameworkVersion();
@@ -369,7 +369,7 @@ export default {
 			cwd: rootProject.getRootPath(),
 			version,
 			providedLibraryMetadata,
-			...options.resolverConfig,
+			cacheMode
 		});
 
 		let startTime;

lib/ui5Framework/Sapui5MavenSnapshotResolver.js

@@ -33,8 +33,8 @@ class Sapui5MavenSnapshotResolver extends AbstractResolver {
 	 * @param {string} [options.cwd=process.cwd()] Current working directory
 	 * @param {string} [options.ui5HomeDir="~/.ui5"] UI5 home directory location. This will be used to store packages,
 	 * metadata and configuration used by the resolvers. Relative to `process.cwd()`
-	 * @param {string} [options.cacheMode="default"] Can be "default" (cache everything, invalidate after 9 hours),
-	 * 	"off" (do not cache) and "force" (use cache only - no requests)
+	 * @param {module:@ui5/project/ui5Framework/maven/CacheMode} [options.cacheMode=Default]
+	 * Cache mode to use
 	 */
 	constructor(options) {
 		super(options);
@@ -136,10 +136,10 @@ class Sapui5MavenSnapshotResolver extends AbstractResolver {
 		snapshotEndpointUrl = process.env.UI5_MAVEN_SNAPSHOT_ENDPOINT_URL || snapshotEndpointUrl;
 
 		if (!snapshotEndpointUrl) {
-			// If we resolve the settings.xml at this point, we'd need to always ask the end
-			// user for confirmation. In some cases where the resources are already cached,
-			// this is not necessary and we could skip it as a real request to the repository won't
-			// be made.
+			// Here we return a function which returns a promise that resolves with the URL.
+			// If we would already start resolving the settings.xml at this point, we'd need to always ask the
+			// end user for confirmation whether the resolved URL should be used. In some cases where the resources
+			// are already cached, this is actually not necessary and could be skipped
 			return Sapui5MavenSnapshotResolver._resolveSnapshotEndpointUrl;
 		} else {
 			return () => Promise.resolve(snapshotEndpointUrl);

lib/ui5Framework/maven/CacheMode.js

@@ -0,0 +1,18 @@
+
+
+/**
+ * Cache modes for maven consumption
+ *
+ * @public
+ * @readonly
+ * @enum {string}
+ * @property {string} Default Cache everything, invalidate after 9 hours
+ * @property {string} Force Use cache only
+ * @property {string} Off Do not use the cache
+ * @module @ui5/project/ui5Framework/maven/CacheMode
+ */
+export default {
+	Default: "Default",
+	Force: "Force",
+	Off: "Off"
+};

lib/ui5Framework/maven/Installer.js

@@ -6,6 +6,7 @@ const StreamZip = _StreamZip.async;
 import {promisify} from "node:util";
 import Registry from "./Registry.js";
 import AbstractInstaller from "../AbstractInstaller.js";
+import CacheMode from "./CacheMode.js";
 import {rimraf} from "rimraf";
 const stat = promisify(fs.stat);
 const readFile = promisify(fs.readFile);
@@ -26,10 +27,9 @@ class Installer extends AbstractInstaller {
 	 * @param {Function} parameters.snapshotEndpointUrlCb Callback that returns a Promise <string>,
 	 * 	resolving to the Maven repository URL.
 	 * 	Example: <code>https://registry.corp/vendor/build-snapshots/</code>
-	 * @param {string} [parameters.cacheMode="default"] Can be "default" (cache everything, invalidate after 9 hours),
-	 * 	"off" (do not cache), "force" (use cache only - no requests)
+	 * @param {module:@ui5/project/ui5Framework/maven/CacheMode} [parameters.cacheMode=Default] Cache mode to use
 	 */
-	constructor({ui5HomeDir, snapshotEndpointUrlCb, cacheMode = "default"}) {
+	constructor({ui5HomeDir, snapshotEndpointUrlCb, cacheMode = CacheMode.Default}) {
 		super(ui5HomeDir);
 
 		this._artifactsDir = path.join(ui5HomeDir, "framework", "artifacts");
@@ -43,6 +43,10 @@ class Installer extends AbstractInstaller {
 		if (!this._snapshotEndpointUrlCb) {
 			throw new Error(`Installer: Missing Snapshot-Endpoint URL callback parameter`);
 		}
+		if (!Object.values(CacheMode).includes(cacheMode)) {
+			throw new Error(`Installer: Invalid value '${cacheMode}' for cacheMode parameter. ` +
+				`Must be one of ${Object.values(CacheMode).join(", ")}`);
+		}
 
 		log.verbose(`Installing Maven artifacts to: ${this._artifactsDir}`);
 		log.verbose(`Installing Packages to: ${this._packagesDir}`);
@@ -119,16 +123,16 @@ class Installer extends AbstractInstaller {
 		return this._synchronize("metadata-" + fsId, async () => {
 			const localMetadata = await this._getLocalArtifactMetadata(fsId);
 
-			if (this._cacheMode === "force" && !localMetadata.revision) {
+			if (this._cacheMode === CacheMode.Force && !localMetadata.revision) {
 				throw new Error(`Could not find artifact ` +
 					`${logId} in local cache`);
 			}
 
 			const now = new Date().getTime();
 			const timeSinceLastCheck = now - localMetadata.lastCheck;
 
-			if (this._cacheMode !== "force" &&
-				(timeSinceLastCheck > CACHE_TIME || this._cacheMode === "off")) {
+			if (this._cacheMode !== CacheMode.Force &&
+				(timeSinceLastCheck > CACHE_TIME || this._cacheMode === CacheMode.Off)) {
 				// No cached metadata (-> timeSinceLastCheck equals time since 1970) or
 				// too old metadata or disabled cache
 				// => Retrieve metadata from repository

package.json

@@ -24,6 +24,7 @@
 		"./ui5Framework/Sapui5MavenSnapshotResolver": "./lib/ui5Framework/Sapui5MavenSnapshotResolver.js",
 		"./ui5Framework/Openui5Resolver": "./lib/ui5Framework/Openui5Resolver.js",
 		"./ui5Framework/Sapui5Resolver": "./lib/ui5Framework/Sapui5Resolver.js",
+		"./ui5Framework/maven/CacheMode": "./lib/ui5Framework/maven/CacheMode.js",
 		"./validation/validator": "./lib/validation/validator.js",
 		"./validation/ValidationError": "./lib/validation/ValidationError.js",
 		"./graph/ProjectGraph": "./lib/graph/ProjectGraph.js",

test/lib/graph/graph.integration.js

@@ -4,6 +4,7 @@ import path from "node:path";
 import sinonGlobal from "sinon";
 import esmock from "esmock";
 import Workspace from "../../../lib/graph/Workspace.js";
+import CacheMode from "../../../lib/ui5Framework/maven/CacheMode.js";
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 const fixturesPath = path.join(__dirname, "..", "..", "fixtures");
@@ -253,7 +254,8 @@ test.serial("graphFromPackageDependencies with inactive workspace file at custom
 		rootConfigPath: "/rootConfigPath",
 		versionOverride: "versionOverride",
 		workspaceName: "default",
-		workspaceConfigPath: path.join(libraryHPath, "custom-ui5-workspace.yaml")
+		workspaceConfigPath: path.join(libraryHPath, "custom-ui5-workspace.yaml"),
+		cacheMode: CacheMode.Force
 	});
 
 	t.is(res, "graph");
@@ -276,6 +278,7 @@ test.serial("graphFromPackageDependencies with inactive workspace file at custom
 		"enrichProjectGraph got called with graph");
 	t.deepEqual(enrichProjectGraphStub.getCall(0).args[1], {
 		versionOverride: "versionOverride",
-		workspace: null
+		workspace: null,
+		cacheMode: "Force"
 	}, "enrichProjectGraph got called with correct options");
 });

test/lib/graph/graph.js

@@ -3,6 +3,7 @@ import {fileURLToPath} from "node:url";
 import path from "node:path";
 import sinonGlobal from "sinon";
 import esmock from "esmock";
+import CacheMode from "../../../lib/ui5Framework/maven/CacheMode.js";
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const fixturesPath = path.join(__dirname, "..", "..", "fixtures");
@@ -57,7 +58,8 @@ test.serial("graphFromPackageDependencies", async (t) => {
 		cwd: "cwd",
 		rootConfiguration: "rootConfiguration",
 		rootConfigPath: "/rootConfigPath",
-		versionOverride: "versionOverride"
+		versionOverride: "versionOverride",
+		cacheMode: CacheMode.Off
 	});
 
 	t.is(res, "graph");
@@ -81,7 +83,8 @@ test.serial("graphFromPackageDependencies", async (t) => {
 		"enrichProjectGraph got called with graph");
 	t.deepEqual(enrichProjectGraphStub.getCall(0).args[1], {
 		versionOverride: "versionOverride",
-		workspace: undefined
+		workspace: undefined,
+		cacheMode: "Off"
 	}, "enrichProjectGraph got called with correct options");
 });
 
@@ -98,6 +101,7 @@ test.serial("graphFromPackageDependencies with workspace name", async (t) => {
 		rootConfigPath: "/rootConfigPath",
 		versionOverride: "versionOverride",
 		workspaceName: "dolphin",
+		cacheMode: CacheMode.Off
 	});
 
 	t.is(res, "graph");
@@ -128,7 +132,8 @@ test.serial("graphFromPackageDependencies with workspace name", async (t) => {
 		"enrichProjectGraph got called with graph");
 	t.deepEqual(enrichProjectGraphStub.getCall(0).args[1], {
 		versionOverride: "versionOverride",
-		workspace: "workspace"
+		workspace: "workspace",
+		cacheMode: "Off"
 	}, "enrichProjectGraph got called with correct options");
 });
 
@@ -225,6 +230,7 @@ test.serial("graphFromPackageDependencies with empty workspace", async (t) => {
 		rootConfigPath: "/rootConfigPath",
 		versionOverride: "versionOverride",
 		workspaceName: "dolphin",
+		cacheMode: CacheMode.Off
 	});
 
 	t.is(res, "graph");
@@ -255,7 +261,8 @@ test.serial("graphFromPackageDependencies with empty workspace", async (t) => {
 		"enrichProjectGraph got called with graph");
 	t.deepEqual(enrichProjectGraphStub.getCall(0).args[1], {
 		versionOverride: "versionOverride",
-		workspace: null
+		workspace: null,
+		cacheMode: "Off"
 	}, "enrichProjectGraph got called with correct options");
 });
 
@@ -290,7 +297,8 @@ test.serial("graphFromStaticFile", async (t) => {
 		filePath: "file/path",
 		rootConfiguration: "rootConfiguration",
 		rootConfigPath: "/rootConfigPath",
-		versionOverride: "versionOverride"
+		versionOverride: "versionOverride",
+		cacheMode: CacheMode.Off
 	});
 
 	t.is(res, "graph");
@@ -316,7 +324,8 @@ test.serial("graphFromStaticFile", async (t) => {
 	t.is(enrichProjectGraphStub.getCall(0).args[0], "graph",
 		"enrichProjectGraph got called with graph");
 	t.deepEqual(enrichProjectGraphStub.getCall(0).args[1], {
-		versionOverride: "versionOverride"
+		versionOverride: "versionOverride",
+		cacheMode: "Off"
 	}, "enrichProjectGraph got called with correct options");
 });
 
@@ -351,7 +360,8 @@ test.serial("usingObject", async (t) => {
 		dependencyTree: "dependencyTree",
 		rootConfiguration: "rootConfiguration",
 		rootConfigPath: "/rootConfigPath",
-		versionOverride: "versionOverride"
+		versionOverride: "versionOverride",
+		cacheMode: "Off"
 	});
 
 	t.is(res, "graph");
@@ -371,7 +381,8 @@ test.serial("usingObject", async (t) => {
 	t.is(enrichProjectGraphStub.getCall(0).args[0], "graph",
 		"enrichProjectGraph got called with graph");
 	t.deepEqual(enrichProjectGraphStub.getCall(0).args[1], {
-		versionOverride: "versionOverride"
+		versionOverride: "versionOverride",
+		cacheMode: "Off"
 	}, "enrichProjectGraph got called with correct options");
 });