[FEATURE] SNAPSHOT Consumption: Add cache-mode parameter (#633)

Expose cache-mode API parameter via CLI. See also:
SAP/ui5-project#607

---------

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

lib/cli/base.js

@@ -52,7 +52,7 @@ export default function(cli) {
  "config", "dependency-definition", "workspace-config", "workspace", "log-level",
 
  // tree.js, build.js & serve.js
- "framework-version",
+ "framework-version", "cache-mode",
 
  // build.js
  "dest",

lib/cli/commands/build.js

@@ -101,6 +101,15 @@ build.builder = function(cli) {
  describe: "Overrides the framework version defined by the project",
  type: "string"
  })
+ .option("cache-mode", {
+ describe:
+ "Cache mode to use when consuming SNAPSHOT versions of a framework: 'Default', 'Force', or 'Off'. " +
+ "The 'Default' behavior is to invalidate the cache after 9 hours. 'Force' uses the cache only and " +
+ "does not create any requests. 'Off' invalidates any existing cache and updates from the repository",
+ type: "string",
+ default: "Default",
+ choices: ["Default", "Force", "Off"]
+ })
  .option("experimental-css-variables", {
  describe:
  "Generate CSS variables (css-variables.css, css-variables.source.less)" +
@@ -129,12 +138,14 @@ async function handleBuild(argv) {
  graph = await graphFromStaticFile({
  filePath: argv.dependencyDefinition,
  rootConfigPath: argv.config,
- versionOverride: argv.frameworkVersion
+ versionOverride: argv.frameworkVersion,
+ cacheMode: argv.cacheMode,
  });
  } else {
  graph = await graphFromPackageDependencies({
  rootConfigPath: argv.config,
  versionOverride: argv.frameworkVersion,
+ cacheMode: argv.cacheMode,
  workspaceConfigPath: argv.workspaceConfig,
  workspaceName: argv.workspace === false ? null : argv.workspace,
  });

lib/cli/commands/serve.js

@@ -65,11 +65,20 @@ serve.builder = function(cli) {
  describe: "Overrides the framework version defined by the project",
  type: "string"
  })
+ .option("cache-mode", {
+ describe:
+ "Cache mode to use when consuming SNAPSHOT versions of a framework: 'Default', 'Force', or 'Off'. " +
+ "The 'Default' behavior is to invalidate the cache after 9 hours. 'Force' uses the cache only and " +
+ "does not create any requests. 'Off' invalidates any existing cache and updates from the repository",
+ type: "string",
+ default: "Default",
+ choices: ["Default", "Force", "Off"]
+ })
  .example("ui5 serve", "Start a web server for the current project")
  .example("ui5 serve --h2", "Enable the HTTP/2 protocol for the web server (requires SSL certificate)")
  .example("ui5 serve --config /path/to/ui5.yaml", "Use the project configuration from a custom path")
- .example("ui5 serve --translator static:/path/to/projectDependencies.yaml",
- "Use a \"static\" translator with translator parameters.")
+ .example("ui5 serve --dependency-definition /path/to/projectDependencies.yaml",
+ "Use a static dependency definition file")
  .example("ui5 serve --port 1337 --open tests/QUnit.html",
  "Listen to port 1337 and launch default browser with http://localhost:1337/test/QUnit.html");
 };
@@ -83,12 +92,14 @@ serve.handler = async function(argv) {
  if (argv.dependencyDefinition) {
  graph = await graphFromStaticFile({
  filePath: argv.dependencyDefinition,
- versionOverride: argv.frameworkVersion
+ versionOverride: argv.frameworkVersion,
+ cacheMode: argv.cacheMode,
  });
  } else {
  graph = await graphFromPackageDependencies({
  rootConfigPath: argv.config,
  versionOverride: argv.frameworkVersion,
+ cacheMode: argv.cacheMode,
  workspaceConfigPath: argv.workspaceConfig,
  workspaceName: argv.workspace === false ? null : argv.workspace,
  });

lib/cli/commands/tree.js

@@ -16,6 +16,15 @@ tree.builder = function(cli) {
  describe:
  "Overrides the framework version defined by the project",
  type: "string"
+ })
+ .option("cache-mode", {
+ describe:
+ "Cache mode to use when consuming SNAPSHOT versions of a framework: 'Default', 'Force', or 'Off'. " +
+ "The 'Default' behavior is to invalidate the cache after 9 hours. 'Force' uses the cache only and " +
+ "does not create any requests. 'Off' invalidates any existing cache and updates from the repository",
+ type: "string",
+ default: "Default",
+ choices: ["Default", "Force", "Off"]
  });
 };
 
@@ -30,12 +39,14 @@ tree.handler = async function(argv) {
  if (argv.dependencyDefinition) {
  graph = await graphFromStaticFile({
  filePath: argv.dependencyDefinition,
- versionOverride: argv.frameworkVersion
+ versionOverride: argv.frameworkVersion,
+ cacheMode: argv.cacheMode,
  });
  } else {
  graph = await graphFromPackageDependencies({
  rootConfigPath: argv.config,
  versionOverride: argv.frameworkVersion,
+ cacheMode: argv.cacheMode,
  workspaceConfigPath: argv.workspaceConfig,
  workspaceName: argv.workspace === false ? null : argv.workspace,
  });

test/lib/cli/commands/build.js

@@ -23,6 +23,8 @@ function getDefaultArgv() {
  "cleanDest": false,
  "experimental-css-variables": false,
  "experimentalCssVariables": false,
+ "cache-mode": "Default",
+ "cacheMode": "Default",
  "$0": "ui5"
  };
 }
@@ -127,6 +129,26 @@ test.serial("ui5 build --framework-version", async (t) => {
  versionOverride: "1.99.0",
  workspaceConfigPath: undefined,
  workspaceName: undefined,
+ cacheMode: "Default",
+ }, "generateProjectGraph.graphFromPackageDependencies got called with expected arguments"
+ );
+});
+
+test.serial("ui5 build --cache-mode", async (t) => {
+ const {build, argv, graphFromPackageDependenciesStub} = t.context;
+
+ argv.cacheMode = "Off";
+
+ await build.handler(argv);
+
+ t.deepEqual(
+ graphFromPackageDependenciesStub.getCall(0).args[0],
+ {
+ rootConfigPath: undefined,
+ versionOverride: undefined,
+ workspaceConfigPath: undefined,
+ workspaceName: undefined,
+ cacheMode: "Off",
  }, "generateProjectGraph.graphFromPackageDependencies got called with expected arguments"
  );
 });
@@ -145,6 +167,7 @@ test.serial("ui5 build --config", async (t) => {
  versionOverride: undefined,
  workspaceConfigPath: undefined,
  workspaceName: undefined,
+ cacheMode: "Default",
  }, "generateProjectGraph.graphFromPackageDependencies got called with expected arguments"
  );
 });
@@ -163,6 +186,7 @@ test.serial("ui5 build --workspace", async (t) => {
  versionOverride: undefined,
  workspaceConfigPath: undefined,
  workspaceName: "dolphin",
+ cacheMode: "Default",
  }, "generateProjectGraph.graphFromPackageDependencies got called with expected arguments"
  );
 });
@@ -181,6 +205,7 @@ test.serial("ui5 build --no-workspace", async (t) => {
  versionOverride: undefined,
  workspaceConfigPath: undefined,
  workspaceName: null,
+ cacheMode: "Default",
  }, "generateProjectGraph.graphFromPackageDependencies got called with expected arguments"
  );
 });
@@ -200,6 +225,7 @@ test.serial("ui5 build --workspace-config", async (t) => {
  versionOverride: undefined,
  workspaceConfigPath: fakePath,
  workspaceName: undefined,
+ cacheMode: "Default",
  }, "generateProjectGraph.graphFromPackageDependencies got called with expected arguments"
  );
 });
@@ -217,6 +243,7 @@ test.serial("ui5 build --dependency-definition", async (t) => {
  filePath: "dependencies.yaml",
  rootConfigPath: undefined,
  versionOverride: undefined,
+ cacheMode: "Default",
  }, "generateProjectGraph.graphFromStaticFile got called with expected arguments"
  );
 });
@@ -235,6 +262,7 @@ test.serial("ui5 build --dependency-definition --config", async (t) => {
  filePath: "dependencies.yaml",
  rootConfigPath: "ui5-test.yaml",
  versionOverride: undefined,
+ cacheMode: "Default",
  }, "generateProjectGraph.graphFromStaticFile got called with expected arguments"
  );
 });
@@ -254,6 +282,7 @@ test.serial("ui5 build --dependency-definition --config --framework-version", as
  filePath: "dependencies.yaml",
  rootConfigPath: "ui5-test.yaml",
  versionOverride: "1.99.0",
+ cacheMode: "Default",
  }, "generateProjectGraph.graphFromStaticFile got called with expected arguments"
  );
 });

test/lib/cli/commands/serve.js

@@ -24,6 +24,8 @@ function getDefaultArgv() {
  "sapCspPolicies": false,
  "serve-csp-reports": false,
  "serveCspReports": false,
+ "cache-mode": "Default",
+ "cacheMode": "Default",
  "$0": "ui5"
  };
 }
@@ -87,6 +89,7 @@ test.serial("ui5 serve: default", async (t) => {
  t.deepEqual(graph.graphFromPackageDependencies.getCall(0).args, [{
  rootConfigPath: undefined, versionOverride: undefined,
  workspaceConfigPath: undefined, workspaceName: undefined,
+ cacheMode: "Default",
  }]);
 
  t.is(t.context.consoleOutput, `Server started
@@ -132,6 +135,7 @@ test.serial("ui5 serve --h2", async (t) => {
  t.deepEqual(graph.graphFromPackageDependencies.getCall(0).args, [{
  rootConfigPath: undefined, versionOverride: undefined,
  workspaceConfigPath: undefined, workspaceName: undefined,
+ cacheMode: "Default",
  }]);
 
  t.is(t.context.consoleOutput, `Server started
@@ -173,6 +177,7 @@ test.serial("ui5 serve --accept-remote-connections", async (t) => {
  t.deepEqual(graph.graphFromPackageDependencies.getCall(0).args, [{
  rootConfigPath: undefined, versionOverride: undefined,
  workspaceConfigPath: undefined, workspaceName: undefined,
+ cacheMode: "Default",
  }]);
 
  t.is(t.context.consoleOutput, `
@@ -216,6 +221,7 @@ test.serial("ui5 serve --open", async (t) => {
  t.deepEqual(graph.graphFromPackageDependencies.getCall(0).args, [{
  rootConfigPath: undefined, versionOverride: undefined,
  workspaceConfigPath: undefined, workspaceName: undefined,
+ cacheMode: "Default",
  }]);
 
  t.is(t.context.consoleOutput, `Server started
@@ -256,6 +262,7 @@ test.serial("ui5 serve --open (opens default url)", async (t) => {
  t.deepEqual(graph.graphFromPackageDependencies.getCall(0).args, [{
  rootConfigPath: undefined, versionOverride: undefined,
  workspaceConfigPath: undefined, workspaceName: undefined,
+ cacheMode: "Default",
  }]);
 
  t.is(t.context.consoleOutput, `Server started
@@ -297,6 +304,7 @@ test.serial("ui5 serve --config", async (t) => {
  t.deepEqual(graph.graphFromPackageDependencies.getCall(0).args, [{
  rootConfigPath: fakePath, versionOverride: undefined,
  workspaceConfigPath: undefined, workspaceName: undefined,
+ cacheMode: "Default",
  }]);
 
  t.is(t.context.consoleOutput, `Server started
@@ -332,6 +340,7 @@ test.serial("ui5 serve --dependency-definition", async (t) => {
  t.is(graph.graphFromStaticFile.callCount, 1);
  t.deepEqual(graph.graphFromStaticFile.getCall(0).args, [{
  filePath: fakePath, versionOverride: undefined,
+ cacheMode: "Default",
  }]);
 
  t.is(t.context.consoleOutput, `Server started
@@ -367,6 +376,43 @@ test.serial("ui5 serve --framework-version", async (t) => {
  t.deepEqual(graph.graphFromPackageDependencies.getCall(0).args, [{
  rootConfigPath: undefined, versionOverride: "1.234.5",
  workspaceConfigPath: undefined, workspaceName: undefined,
+ cacheMode: "Default",
+ }]);
+
+ t.is(t.context.consoleOutput, `Server started
+URL: http://localhost:8080
+`);
+
+ t.is(server.serve.callCount, 1);
+ t.deepEqual(server.serve.getCall(0).args, [
+ fakeGraph,
+ {
+ acceptRemoteConnections: false,
+ cert: undefined,
+ changePortIfInUse: true,
+ h2: false,
+ key: undefined,
+ port: 8080,
+ sendSAPTargetCSP: false,
+ serveCSPReports: false,
+ simpleIndex: false,
+ }
+ ]);
+});
+
+test.serial("ui5 serve --cache-mode", async (t) => {
+ const {argv, serve, graph, server, fakeGraph} = t.context;
+
+ argv.cacheMode = "Force";
+
+ await serve.handler(argv);
+
+ t.is(graph.graphFromStaticFile.callCount, 0);
+ t.is(graph.graphFromPackageDependencies.callCount, 1);
+ t.deepEqual(graph.graphFromPackageDependencies.getCall(0).args, [{
+ rootConfigPath: undefined, versionOverride: undefined,
+ workspaceConfigPath: undefined, workspaceName: undefined,
+ cacheMode: "Force",
  }]);
 
  t.is(t.context.consoleOutput, `Server started
@@ -402,6 +448,7 @@ test.serial("ui5 serve --workspace", async (t) => {
  t.deepEqual(graph.graphFromPackageDependencies.getCall(0).args, [{
  rootConfigPath: undefined, versionOverride: undefined,
  workspaceConfigPath: undefined, workspaceName: "dolphin",
+ cacheMode: "Default",
  }]);
 
  t.is(t.context.consoleOutput, `Server started
@@ -437,6 +484,7 @@ test.serial("ui5 serve --no-workspace", async (t) => {
  t.deepEqual(graph.graphFromPackageDependencies.getCall(0).args, [{
  rootConfigPath: undefined, versionOverride: undefined,
  workspaceConfigPath: undefined, workspaceName: null,
+ cacheMode: "Default",
  }]);
 
  t.is(t.context.consoleOutput, `Server started
@@ -473,6 +521,7 @@ test.serial("ui5 serve --workspace-config", async (t) => {
  t.deepEqual(graph.graphFromPackageDependencies.getCall(0).args, [{
  rootConfigPath: undefined, versionOverride: undefined,
  workspaceConfigPath: fakePath, workspaceName: undefined,
+ cacheMode: "Default",
  }]);
 
  t.is(t.context.consoleOutput, `Server started
@@ -508,6 +557,7 @@ test.serial("ui5 serve --sap-csp-policies", async (t) => {
  t.deepEqual(graph.graphFromPackageDependencies.getCall(0).args, [{
  rootConfigPath: undefined, versionOverride: undefined,
  workspaceConfigPath: undefined, workspaceName: undefined,
+ cacheMode: "Default",
  }]);
 
  t.is(t.context.consoleOutput, `Server started
@@ -543,6 +593,7 @@ test.serial("ui5 serve --serve-csp-reports", async (t) => {
  t.deepEqual(graph.graphFromPackageDependencies.getCall(0).args, [{
  rootConfigPath: undefined, versionOverride: undefined,
  workspaceConfigPath: undefined, workspaceName: undefined,
+ cacheMode: "Default",
  }]);
 
  t.is(t.context.consoleOutput, `Server started
@@ -578,6 +629,7 @@ test.serial("ui5 serve --simple-index", async (t) => {
  t.deepEqual(graph.graphFromPackageDependencies.getCall(0).args, [{
  rootConfigPath: undefined, versionOverride: undefined,
  workspaceConfigPath: undefined, workspaceName: undefined,
+ cacheMode: "Default",
  }]);
 
  t.is(t.context.consoleOutput, `Server started
@@ -620,6 +672,7 @@ test.serial("ui5 serve with ui5.yaml port setting", async (t) => {
  t.deepEqual(graph.graphFromPackageDependencies.getCall(0).args, [{
  rootConfigPath: undefined, versionOverride: undefined,
  workspaceConfigPath: undefined, workspaceName: undefined,
+ cacheMode: "Default",
  }]);
 
  t.is(t.context.consoleOutput, `Server started
@@ -669,6 +722,7 @@ test.serial("ui5 serve --h2 with ui5.yaml port setting", async (t) => {
  t.deepEqual(graph.graphFromPackageDependencies.getCall(0).args, [{
  rootConfigPath: undefined, versionOverride: undefined,
  workspaceConfigPath: undefined, workspaceName: undefined,
+ cacheMode: "Default",
  }]);
 
  t.is(t.context.consoleOutput, `Server started
@@ -725,6 +779,7 @@ test.serial("ui5 serve --h2 with ui5.yaml port setting and port CLI argument", a
  t.deepEqual(graph.graphFromPackageDependencies.getCall(0).args, [{
  rootConfigPath: undefined, versionOverride: undefined,
  workspaceConfigPath: undefined, workspaceName: undefined,
+ cacheMode: "Default",
  }]);
 
  t.is(t.context.consoleOutput, `Server started