@speedkit/cli 4.27.0 → 4.27.2

package/dist/services/query-builder/query-builder-model.d.ts

@@ -16,6 +16,8 @@ export interface QueryFilterOptions {
 }
 export interface QueryBuilderContext extends ParameterOptions, PrewarmOptions, QueryFilterOptions {
     readonly app: string;
+    /** Athena data catalog the rum tables live in. */
+    readonly catalog?: string;
     readonly execute?: boolean;
     /** Report every rule the query leaves out, reduces or approximates. */
     readonly explain?: boolean;
@@ -26,6 +28,8 @@ export interface QueryBuilderContext extends ParameterOptions, PrewarmOptions, Q
     readonly quiet?: boolean;
 }
 export interface QueryBuilderFactoryContext extends ParameterOptions, PrewarmOptions, QueryFilterOptions {
+    /** Athena data catalog the rum tables live in. */
+    readonly catalog?: string;
     readonly configName: string;
     readonly customerPath: string;
     readonly execute?: boolean;
@@ -33,4 +37,6 @@ export interface QueryBuilderFactoryContext extends ParameterOptions, PrewarmOpt
     readonly explain?: boolean;
     readonly isWindows?: boolean;
     readonly quiet?: boolean;
+    /** Athena workgroup to execute in, when the query is executed at all. */
+    readonly workgroup?: string;
 }

package/dist/services/query-builder/query-builder-service.js

@@ -44,10 +44,10 @@ export class QueryBuilderService {
         this.cli.startAction(action, `build ${this.context.queryType}-query`);
         const result = safe(() => this.build());
         if (result.success !== true) {
+            // Fail the action before throwing: the spinner is a timer, and one left
+            // running keeps the process alive with nothing to do.
             this.cli.failAction(action, result.error);
-            this.cli.writeError(result.error);
-            console.error(result.errorObj);
-            return;
+            throw result.errorObj ?? new Error(result.error);
         }
         this.cli.successAction(action);
         const query = result.data;
@@ -99,6 +99,7 @@ export class QueryBuilderService {
     build() {
         const input = {
             app: this.context.app,
+            catalog: this.context.catalog,
             bySet: this.context.bySet,
             count: this.context.count,
             days: this.context.days ?? DEFAULT_QUERY_DAYS[this.context.queryType],
@@ -178,9 +179,12 @@ export class QueryBuilderService {
         this.cli.startAction("QUERY:COUNT", "count the pre-warm list");
         const result = await safe(this.runQuery(query));
         if (result.success !== true) {
+            // Thrown, not reported and swallowed. A count that did not run is a
+            // failed command, and something driving this from a script — a CI job
+            // reading the exit code — has no other way to find that out. Printing
+            // the message and exiting 0 made a broken query look like a clean run.
             this.cli.failAction("QUERY:COUNT");
-            this.cli.writeError(result.error);
-            return;
+            throw result.errorObj ?? new Error(result.error);
         }
         this.cli.successAction("QUERY:COUNT");
         const rows = result.data;
@@ -210,9 +214,10 @@ export class QueryBuilderService {
         this.cli.startAction("QUERY:EXECUTE", "execute query and export csv");
         const result = await safe(this.runQuery(query));
         if (result.success !== true) {
+            // Thrown for the same reason as the count path: an export that produced
+            // no file must not exit 0.
             this.cli.failAction("QUERY:EXECUTE");
-            this.cli.writeError(result.error);
-            return;
+            throw result.errorObj ?? new Error(result.error);
         }
         const rows = result.data;
         const date = new Date().toISOString().split("T")[0];

package/dist/services/query-builder/query-builder-service.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/services/query-builder/query-builder-service.spec.js

@@ -0,0 +1,65 @@
+import { expect } from "chai";
+import { describe, it } from "mocha";
+import { QueryBuilderService } from "./query-builder-service.js";
+import { QueryType } from "./query-builder-model.js";
+import { parseRuleSets } from "./rules/index.js";
+/** Records the actions so a left-running spinner shows up as a missing fail. */
+function recordingCli() {
+    const calls = [];
+    const cli = {
+        comment: () => calls.push("comment"),
+        failAction: (name) => calls.push(`fail:${name}`),
+        startAction: (name) => calls.push(`start:${name}`),
+        successAction: (name) => calls.push(`success:${name}`),
+        table: () => calls.push("table"),
+        writeError: (message) => calls.push(`error:${message}`),
+        writeSuccess: () => calls.push("success"),
+        writeWarning: () => calls.push("warning"),
+    };
+    return { calls, cli };
+}
+/** An Athena that always refuses, the way a bad catalog or workgroup does. */
+const refusingAthena = {
+    getResult: () => Promise.reject(new Error("The Amazon Athena query failed to run with error message: CATALOG_NOT_FOUND")),
+};
+function countService(cli) {
+    return new QueryBuilderService({
+        app: "obi-de",
+        count: true,
+        hosts: ["www.obi.de"],
+        queryType: QueryType.prewarm,
+        quiet: true,
+    }, 
+    // The real parser on an empty config: a hand-rolled stand-in would fail the
+    // build step and the test would pass for the wrong reason.
+    parseRuleSets({}), cli, refusingAthena);
+}
+describe("QueryBuilderService — a query that could not run", () => {
+    // Regression: this used to print the message and return, so the process
+    // exited 0. A CI job counting urls then reported success with no count, and
+    // the pipeline that read it had no way to tell a broken query from an empty
+    // one.
+    it("fails the command instead of exiting cleanly", async () => {
+        const { cli } = recordingCli();
+        const outcome = await countService(cli)
+            .run()
+            .then(() => "resolved")
+            .catch(() => "rejected");
+        expect(outcome).to.equal("rejected");
+    });
+    it("carries the reason, so the log says what went wrong", async () => {
+        const { cli } = recordingCli();
+        const error = await countService(cli)
+            .run()
+            .then(() => undefined)
+            .catch((thrown) => thrown);
+        expect(error?.message).to.contain("CATALOG_NOT_FOUND");
+    });
+    it("ends the spinner before throwing — it is a timer that holds the process open", async () => {
+        const { calls, cli } = recordingCli();
+        await countService(cli)
+            .run()
+            .catch(() => undefined);
+        expect(calls).to.contain("fail:QUERY:COUNT");
+    });
+});

package/dist/services/query-builder/query-command.d.ts

@@ -8,12 +8,14 @@ import { QueryFilterOptions, QueryType } from "./query-builder-model.js";
  * the two the caller gives rather than the list the builder works on.
  */
 export interface QueryCommandFlags extends ParameterOptions, Omit<PrewarmOptions, "devices" | "variations">, QueryFilterOptions {
+    readonly catalog?: string;
     readonly configName: string;
     readonly device?: readonly string[];
     readonly execute?: boolean;
     readonly explain?: boolean;
     readonly quiet?: boolean;
     readonly variation?: readonly string[];
+    readonly workgroup?: string;
 }
 /**
  * Builds one of the config-derived queries and hands it over.

package/dist/services/query-builder/query-command.js

@@ -12,6 +12,7 @@ import { normalizeDevices } from "./queries/device.js";
 export async function runQuery(queryType, customerPath, flags, config) {
     const service = await new QueryBuilderFactory({
         bySet: flags.bySet,
+        catalog: flags.catalog,
         configName: flags.configName,
         count: flags.count,
         customerPath,
@@ -30,6 +31,7 @@ export async function runQuery(queryType, customerPath, flags, config) {
         minImpressions: flags.minImpressions,
         quiet: flags.quiet,
         variations: flags.variation,
+        workgroup: flags.workgroup,
     }, new CliConfig(config).load()).buildService(queryType);
     await service.run();
 }

package/oclif.manifest.json

@@ -14,9 +14,30 @@
         "$ sk auto-prewarm <customerPath> -c <configName>",
         "$ sk auto-prewarm customers/decathlon.de -c production",
         "$ sk auto-prewarm customers/decathlon.de --device desktop,mobile",
-        "$ sk auto-prewarm customers/decathlon.de -v MOBILE,DESKTOP"
+        "$ sk auto-prewarm customers/decathlon.de -v MOBILE,DESKTOP",
+        "$ sk auto-prewarm customers/decathlon.de --limit 5000 --minHits 5",
+        "$ sk auto-prewarm customers/decathlon.de --workgroup prewarming"
       ],
       "flags": {
+        "catalog": {
+          "description": "Athena data catalog holding the rum tables. Names the catalog both in the query and in the context it runs in, so the two always agree",
+          "env": "SK_ATHENA_CATALOG",
+          "name": "catalog",
+          "required": false,
+          "default": "live",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "workgroup": {
+          "description": "Athena workgroup to run the query in, e.g. 'prewarming'. Defaults to the account's default workgroup",
+          "env": "SK_ATHENA_WORKGROUP",
+          "name": "workgroup",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "configName": {
           "char": "c",
           "description": "The costumer config name",
@@ -60,14 +81,6 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "match": {
-          "description": "Keep only urls whose path matches this regular expression, e.g. '^/p/'. The path is matched with its query string, the way a version 1 pathname rule matches it, so '[?&]size=' works too. Repeat the flag to keep the urls matching any of several patterns, and start a pattern with (?i) to match case-insensitively",
-          "name": "match",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": true,
-          "type": "option"
-        },
         "device": {
           "description": "Split the list by device class, so every url is warmed in the variations it was actually requested in. A class not named is left out",
           "exclusive": [
@@ -98,6 +111,36 @@
           "multiple": true,
           "type": "option"
         },
+        "excludeNotFound": {
+          "description": "Leave out urls the origin answers with a 404 more often than not",
+          "name": "excludeNotFound",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "limit": {
+          "description": "Keep only the most requested urls",
+          "name": "limit",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "match": {
+          "description": "Keep only urls whose path matches this regular expression, e.g. '^/p/'. The path is matched with its query string, the way a version 1 pathname rule matches it, so '[?&]size=' works too. Repeat the flag to keep the urls matching any of several patterns, and start a pattern with (?i) to match case-insensitively",
+          "name": "match",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
+        "minHits": {
+          "description": "Keep only urls requested at least this often in the window",
+          "name": "minHits",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "variationPath": {
           "char": "p",
           "description": "path to variations.csv",
@@ -1309,6 +1352,25 @@
         "$ sk query parameter customers/decathlon.de --explain"
       ],
       "flags": {
+        "catalog": {
+          "description": "Athena data catalog holding the rum tables. Names the catalog both in the query and in the context it runs in, so the two always agree",
+          "env": "SK_ATHENA_CATALOG",
+          "name": "catalog",
+          "required": false,
+          "default": "live",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "workgroup": {
+          "description": "Athena workgroup to run the query in, e.g. 'prewarming'. Defaults to the account's default workgroup",
+          "env": "SK_ATHENA_WORKGROUP",
+          "name": "workgroup",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "configName": {
           "char": "c",
           "description": "The costumer config name",
@@ -1420,6 +1482,25 @@
         "$ sk query prewarm customers/decathlon.de --count"
       ],
       "flags": {
+        "catalog": {
+          "description": "Athena data catalog holding the rum tables. Names the catalog both in the query and in the context it runs in, so the two always agree",
+          "env": "SK_ATHENA_CATALOG",
+          "name": "catalog",
+          "required": false,
+          "default": "live",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "workgroup": {
+          "description": "Athena workgroup to run the query in, e.g. 'prewarming'. Defaults to the account's default workgroup",
+          "env": "SK_ATHENA_WORKGROUP",
+          "name": "workgroup",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "configName": {
           "char": "c",
           "description": "The costumer config name",
@@ -1507,15 +1588,6 @@
           "multiple": true,
           "type": "option"
         },
-        "count": {
-          "description": "Run the query and report how large the list is instead of what is in it: urls, the impressions they stand for, and a row per variation where the list carries variations. Every other flag still applies, so this counts the list the same command would produce",
-          "exclusive": [
-            "execute"
-          ],
-          "name": "count",
-          "allowNo": false,
-          "type": "boolean"
-        },
         "excludeNotFound": {
           "description": "Leave out urls the origin answers with a 404 more often than not",
           "name": "excludeNotFound",
@@ -1545,6 +1617,15 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "count": {
+          "description": "Run the query and report how large the list is instead of what is in it: urls, the impressions they stand for, and a row per variation where the list carries variations. Every other flag still applies, so this counts the list the same command would produce",
+          "exclusive": [
+            "execute"
+          ],
+          "name": "count",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -1564,5 +1645,5 @@
       ]
     }
   },
-  "version": "4.27.0"
+  "version": "4.27.2"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@speedkit/cli",
   "description": "Speed Kit CLI",
-  "version": "4.27.0",
+  "version": "4.27.2",
   "author": {
     "name": "Baqend.com",
     "email": "info@baqend.com"