@speedkit/cli 4.25.2 → 4.27.0

package/oclif.manifest.json

@@ -13,6 +13,7 @@
       "examples": [
         "$ 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"
       ],
       "flags": {
@@ -26,18 +27,82 @@
           "multiple": false,
           "type": "option"
         },
+        "days": {
+          "char": "d",
+          "description": "Number of days the query looks back",
+          "name": "days",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "excludeNoindex": {
+          "description": "Exclude page impressions of pages marked noindex",
+          "name": "excludeNoindex",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "excludeSuspicious": {
+          "description": "Exclude page impressions Speed Kit classified as suspicious",
+          "name": "excludeSuspicious",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "explain": {
+          "description": "Account for every rule the query leaves out, reduces or approximates",
+          "name": "explain",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "hardNavigationsOnly": {
+          "description": "Exclude soft (SPA) navigations",
+          "name": "hardNavigationsOnly",
+          "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": [
+            "variation"
+          ],
+          "name": "device",
+          "required": false,
+          "delimiter": ",",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "options": [
+            "desktop",
+            "mobile",
+            "tablet"
+          ],
+          "type": "option"
+        },
         "variation": {
           "char": "v",
+          "description": "Pair every url of the list with each of these variations. For the custom variations no traffic can reveal, e.g. 'desktop-pdp-a,mobile-pdp-a'",
+          "exclusive": [
+            "device"
+          ],
           "name": "variation",
-          "default": "default",
+          "required": false,
+          "delimiter": ",",
           "hasDynamicHelp": false,
-          "multiple": false,
+          "multiple": true,
           "type": "option"
         },
         "variationPath": {
           "char": "p",
           "description": "path to variations.csv",
           "exclusive": [
+            "device",
             "variation"
           ],
           "name": "variationPath",
@@ -81,102 +146,6 @@
         "auto-prewarm.js"
       ]
     },
-    "build-parameter-query": {
-      "aliases": [],
-      "args": {
-        "customerPath": {
-          "description": "The customer config path",
-          "name": "customerPath",
-          "required": true
-        }
-      },
-      "description": "Build a parameter query that can be executed in Athena",
-      "examples": [
-        "$ sk build-parameter-query <customerPath> -c <configName>",
-        "$ sk build-parameter-query customers/decathlon.de -c production"
-      ],
-      "flags": {
-        "configName": {
-          "char": "c",
-          "description": "The costumer config name",
-          "name": "configName",
-          "required": false,
-          "default": "production",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "build-parameter-query",
-      "pluginAlias": "@speedkit/cli",
-      "pluginName": "@speedkit/cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "build-parameter-query.js"
-      ]
-    },
-    "build-prewarm-query": {
-      "aliases": [],
-      "args": {
-        "customerPath": {
-          "description": "The customer config path",
-          "name": "customerPath",
-          "required": true
-        }
-      },
-      "description": "Build a prewarm query that can be executed in Athena",
-      "examples": [
-        "$ sk build-prewarm-query <customerPath> -c <configName>",
-        "$ sk build-prewarm-query customers/decathlon.de -c production"
-      ],
-      "flags": {
-        "configName": {
-          "char": "c",
-          "description": "The costumer config name",
-          "name": "configName",
-          "required": false,
-          "default": "production",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "quiet": {
-          "char": "q",
-          "description": "Output only the raw query without clipboard copy or styling",
-          "name": "quiet",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "execute": {
-          "char": "e",
-          "description": "Execute the query directly and write the result to a <app>-<date>-prewarm.csv file",
-          "name": "execute",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "build-prewarm-query",
-      "pluginAlias": "@speedkit/cli",
-      "pluginName": "@speedkit/cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "build-prewarm-query.js"
-      ]
-    },
     "deploy": {
       "aliases": [],
       "args": {
@@ -458,6 +427,14 @@
         "$ sk generate-pop-config --coverage 95 --pop-limit 6 --traffic-share 2 --deploy appName"
       ],
       "flags": {
+        "days": {
+          "description": "Number of days the query looks back",
+          "name": "days",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "coverage": {
           "char": "c",
           "description": "The percentage of traffic which should be covered through prewarming.",
@@ -768,8 +745,8 @@
       "flags": {
         "variation": {
           "char": "v",
+          "description": "Warm every url of the list in each of these variations, e.g. 'desktop,mobile'. Ignored for a list that names a variation itself",
           "name": "variation",
-          "default": "default",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -884,7 +861,7 @@
       "examples": [
         "$ sk revalidate <app> --pattern <regex> [--pattern <regex>] [--dryRun] [--wait]",
         "$ sk revalidate example-shop --pattern '^https://www\\.example\\.com/en/.*-c(?:1234|5678)(?:/|\\?|$)' --dryRun",
-        "$ sk revalidate example-shop --pattern '^https://www\\.example\\.com/en/.*-c1234(?:/|\\?|$)' --wait",
+        "$ sk revalidate example-shop --pattern '^https://www\\.example\\.com/en/.*-c1234(?:/|\\?|$)' --type PURGE --wait",
         "$ sk revalidate example-shop --prefix https://www.example.com/en/ --dryRun"
       ],
       "flags": {
@@ -910,9 +887,9 @@
           "type": "option"
         },
         "type": {
-          "description": "PURGE drops the entries and does not rebuild them, which is what an out-of-scope URL needs.",
+          "description": "REFRESH revalidates against origin and keeps serving the cached copy meanwhile. A URL that went out of scope needs PURGE instead: it drops the entries and does not rebuild them, which is the only type that stops serving for good.",
           "name": "type",
-          "default": "PURGE",
+          "default": "REFRESH",
           "hasDynamicHelp": false,
           "multiple": false,
           "options": [
@@ -937,7 +914,7 @@
           "type": "boolean"
         },
         "yes": {
-          "description": "Skip the confirmation a job above 100 assets asks for. Required in a non-interactive shell.",
+          "description": "Skip the confirmation a dropping job above 100 assets asks for. Required in a non-interactive shell.",
           "name": "yes",
           "allowNo": false,
           "type": "boolean"
@@ -1312,7 +1289,280 @@
         "extension",
         "update.js"
       ]
+    },
+    "query:parameter": {
+      "aliases": [
+        "build-parameter-query"
+      ],
+      "args": {
+        "customerPath": {
+          "description": "The customer config path",
+          "name": "customerPath",
+          "required": true
+        }
+      },
+      "deprecateAliases": true,
+      "description": "Build a parameter query that can be executed in Athena",
+      "examples": [
+        "$ sk query parameter <customerPath> -c <configName>",
+        "$ sk query parameter customers/decathlon.de -c production",
+        "$ sk query parameter customers/decathlon.de --explain"
+      ],
+      "flags": {
+        "configName": {
+          "char": "c",
+          "description": "The costumer config name",
+          "name": "configName",
+          "required": false,
+          "default": "production",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "days": {
+          "char": "d",
+          "description": "Number of days the query looks back",
+          "name": "days",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "excludeNoindex": {
+          "description": "Exclude page impressions of pages marked noindex",
+          "name": "excludeNoindex",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "excludeSuspicious": {
+          "description": "Exclude page impressions Speed Kit classified as suspicious",
+          "name": "excludeSuspicious",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "explain": {
+          "description": "Account for every rule the query leaves out, reduces or approximates",
+          "name": "explain",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "hardNavigationsOnly": {
+          "description": "Exclude soft (SPA) navigations",
+          "name": "hardNavigationsOnly",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "execute": {
+          "char": "e",
+          "description": "Execute the query directly and write the result to a <app>-<date>-<query>.csv file",
+          "name": "execute",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "quiet": {
+          "char": "q",
+          "description": "Output only the raw query without clipboard copy or styling",
+          "name": "quiet",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "bySet": {
+          "description": "Rank whole sets of parameters instead of single parameters, to see which ones travel together",
+          "name": "bySet",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "minImpressions": {
+          "description": "Leave out parameters seen on fewer page impressions than this",
+          "name": "minImpressions",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "query:parameter",
+      "pluginAlias": "@speedkit/cli",
+      "pluginName": "@speedkit/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "query",
+        "parameter.js"
+      ]
+    },
+    "query:prewarm": {
+      "aliases": [
+        "build-prewarm-query"
+      ],
+      "args": {
+        "customerPath": {
+          "description": "The customer config path",
+          "name": "customerPath",
+          "required": true
+        }
+      },
+      "deprecateAliases": true,
+      "description": "Build a prewarm query that can be executed in Athena",
+      "examples": [
+        "$ sk query prewarm <customerPath> -c <configName>",
+        "$ sk query prewarm customers/decathlon.de -c production",
+        "$ sk query prewarm customers/decathlon.de --explain",
+        "$ sk query prewarm customers/decathlon.de --match '^/p/'",
+        "$ sk query prewarm customers/decathlon.de --device desktop,mobile",
+        "$ sk query prewarm customers/decathlon.de -v MOBILE,DESKTOP",
+        "$ sk query prewarm customers/decathlon.de --count"
+      ],
+      "flags": {
+        "configName": {
+          "char": "c",
+          "description": "The costumer config name",
+          "name": "configName",
+          "required": false,
+          "default": "production",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "days": {
+          "char": "d",
+          "description": "Number of days the query looks back",
+          "name": "days",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "excludeNoindex": {
+          "description": "Exclude page impressions of pages marked noindex",
+          "name": "excludeNoindex",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "excludeSuspicious": {
+          "description": "Exclude page impressions Speed Kit classified as suspicious",
+          "name": "excludeSuspicious",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "explain": {
+          "description": "Account for every rule the query leaves out, reduces or approximates",
+          "name": "explain",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "hardNavigationsOnly": {
+          "description": "Exclude soft (SPA) navigations",
+          "name": "hardNavigationsOnly",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "execute": {
+          "char": "e",
+          "description": "Execute the query directly and write the result to a <app>-<date>-<query>.csv file",
+          "name": "execute",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "quiet": {
+          "char": "q",
+          "description": "Output only the raw query without clipboard copy or styling",
+          "name": "quiet",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "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": [
+            "variation"
+          ],
+          "name": "device",
+          "required": false,
+          "delimiter": ",",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "options": [
+            "desktop",
+            "mobile",
+            "tablet"
+          ],
+          "type": "option"
+        },
+        "variation": {
+          "char": "v",
+          "description": "Pair every url of the list with each of these variations. For the custom variations no traffic can reveal, e.g. 'desktop-pdp-a,mobile-pdp-a'",
+          "exclusive": [
+            "device"
+          ],
+          "name": "variation",
+          "required": false,
+          "delimiter": ",",
+          "hasDynamicHelp": false,
+          "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",
+          "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"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "query:prewarm",
+      "pluginAlias": "@speedkit/cli",
+      "pluginName": "@speedkit/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "query",
+        "prewarm.js"
+      ]
     }
   },
-  "version": "4.25.2"
+  "version": "4.27.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@speedkit/cli",
   "description": "Speed Kit CLI",
-  "version": "4.25.2",
+  "version": "4.27.0",
   "author": {
     "name": "Baqend.com",
     "email": "info@baqend.com"
@@ -27,7 +27,9 @@
     "prepack": "npm run build",
     "test": "mocha",
     "coverage": "nyc mocha",
-    "coverage:report": "nyc --reporter cobertura mocha"
+    "coverage:report": "nyc --reporter cobertura mocha",
+    "test:golden": "UPDATE_GOLDEN=1 mocha --grep \"golden queries\"",
+    "snapshot:queries": "node scripts/snapshot-customer-queries.mjs"
   },
   "mocha": {
     "reporter": "xunit",
@@ -69,6 +71,11 @@
         "./dist/hooks/init/dns-result-order.js"
       ]
     },
+    "topics": {
+      "query": {
+        "description": "Build the Athena queries a customer config implies"
+      }
+    },
     "bin": "sk",
     "dirname": "speed-kit-cli",
     "plugins": [
@@ -99,6 +106,7 @@
     "@oclif/plugin-help": "^6.2.45",
     "@oclif/plugin-not-found": "^3.2.81",
     "@oclif/plugin-warn-if-update-available": "^3.1.61",
+    "@speedkit/rules": "^1.3.0-0",
     "baqend": "^4.2.5",
     "chalk": "^5.6.2",
     "chokidar": "^5.0.0",
@@ -129,6 +137,7 @@
     "parse5-htmlparser2-tree-adapter": "^7.0.0",
     "puppeteer": "^24.41.0",
     "puppeteer-extra": "^3.3.6",
+    "refa": "^0.12.1",
     "semver": "^7.7.4",
     "spinnies": "^0.5.1",
     "strip-comments": "^2.0.1",

package/dist/commands/build-parameter-query.d.ts

@@ -1,14 +0,0 @@
-import { Command } from "@oclif/core";
-export default class BuildParameterQuery extends Command {
-    static args: {
-        customerPath: import("@oclif/core/interfaces").Arg<string, {
-            exists?: boolean;
-        }>;
-    };
-    static description: string;
-    static examples: string[];
-    static flags: {
-        configName: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-    };
-    run(): Promise<void>;
-}

package/dist/commands/build-parameter-query.js

@@ -1,25 +0,0 @@
-import { Command } from "@oclif/core";
-import { CLI_CONFIG_NAME, CLI_CUSTOMER_CONFIG, CLIParameters, CLIParametersChar, CLIParametersExample, } from "../models/cli-parameters.js";
-import { QueryBuilderFactory } from "../services/query-builder/query-builder-factory.js";
-import { CliConfig } from "../helpers/cli-config.js";
-import { QueryTpe } from "../services/query-builder/query-builder-model.js";
-export default class BuildParameterQuery extends Command {
-    static args = CLI_CUSTOMER_CONFIG;
-    static description = "Build a parameter query that can be executed in Athena";
-    static examples = [
-        `$ sk build-parameter-query <${CLIParameters.CustomerPath}> -${CLIParametersChar.ConfigName} <${CLIParameters.ConfigName}>`,
-        `$ sk build-parameter-query ${CLIParametersExample.CustomerPath} -${CLIParametersChar.ConfigName} ${CLIParametersExample.ConfigName}`,
-    ];
-    static flags = {
-        ...CLI_CONFIG_NAME,
-    };
-    async run() {
-        const { args: { customerPath }, flags: { configName }, } = await this.parse(BuildParameterQuery);
-        const service = await new QueryBuilderFactory({
-            configName,
-            customerPath,
-            isWindows: this.config.windows,
-        }, new CliConfig(this.config).load()).buildService(QueryTpe.parameter);
-        await service.run();
-    }
-}

package/dist/commands/build-prewarm-query.d.ts

@@ -1,16 +0,0 @@
-import { Command } from "@oclif/core";
-export default class BuildPrewarmQuery extends Command {
-    static args: {
-        customerPath: import("@oclif/core/interfaces").Arg<string, {
-            exists?: boolean;
-        }>;
-    };
-    static description: string;
-    static examples: string[];
-    static flags: {
-        quiet: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        execute: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        configName: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-    };
-    run(): Promise<void>;
-}

package/dist/commands/build-prewarm-query.js

@@ -1,37 +0,0 @@
-import { Command, Flags } from "@oclif/core";
-import { CLI_CONFIG_NAME, CLI_CUSTOMER_CONFIG, CLIParameters, CLIParametersChar, CLIParametersExample, } from "../models/cli-parameters.js";
-import { CliConfig } from "../helpers/cli-config.js";
-import { QueryBuilderFactory } from "../services/query-builder/query-builder-factory.js";
-import { QueryTpe } from "../services/query-builder/query-builder-model.js";
-export default class BuildPrewarmQuery extends Command {
-    static args = CLI_CUSTOMER_CONFIG;
-    static description = "Build a prewarm query that can be executed in Athena";
-    static examples = [
-        `$ sk build-prewarm-query <${CLIParameters.CustomerPath}> -${CLIParametersChar.ConfigName} <${CLIParameters.ConfigName}>`,
-        `$ sk build-prewarm-query ${CLIParametersExample.CustomerPath} -${CLIParametersChar.ConfigName} ${CLIParametersExample.ConfigName}`,
-    ];
-    static flags = {
-        ...CLI_CONFIG_NAME,
-        quiet: Flags.boolean({
-            char: "q",
-            description: "Output only the raw query without clipboard copy or styling",
-            default: false,
-        }),
-        execute: Flags.boolean({
-            char: "e",
-            description: "Execute the query directly and write the result to a <app>-<date>-prewarm.csv file",
-            default: false,
-        }),
-    };
-    async run() {
-        const { args: { customerPath }, flags: { configName, quiet, execute }, } = await this.parse(BuildPrewarmQuery);
-        const service = await new QueryBuilderFactory({
-            configName,
-            customerPath,
-            isWindows: this.config.windows,
-            quiet,
-            execute,
-        }, new CliConfig(this.config).load()).buildService(QueryTpe.prewarm);
-        await service.run();
-    }
-}