@speedkit/cli 4.26.0 → 4.27.0

package/dist/services/query-builder/sql/spec/predicate.spec.js

@@ -0,0 +1,78 @@
+import { expect } from "chai";
+import { describe, it } from "mocha";
+import { and, FALSE, isFalse, isTrue, leaf, not, or, predicateKey, TRUE, } from "../predicate.js";
+const a = leaf("a");
+const b = leaf("b");
+const c = leaf("c");
+describe("predicate and", () => {
+    it("should be true without operands", () => {
+        expect(isTrue(and())).to.equal(true);
+    });
+    it("should return the only operand unwrapped", () => {
+        expect(and(a)).to.deep.equal(a);
+    });
+    it("should drop true operands", () => {
+        expect(and(a, TRUE, b)).to.deep.equal({
+            children: [a, b],
+            kind: "and",
+        });
+    });
+    it("should collapse to false on a false operand", () => {
+        expect(isFalse(and(a, FALSE))).to.equal(true);
+    });
+    it("should flatten nested conjunctions", () => {
+        expect(and(a, and(b, c))).to.deep.equal({
+            children: [a, b, c],
+            kind: "and",
+        });
+    });
+    it("should remove duplicate operands", () => {
+        expect(and(a, b, leaf("a"))).to.deep.equal({
+            children: [a, b],
+            kind: "and",
+        });
+    });
+    it("should collapse to false on contradicting operands", () => {
+        expect(isFalse(and(a, b, not(leaf("a"))))).to.equal(true);
+    });
+    it("should keep a disjunction as an operand", () => {
+        expect(and(a, or(b, c))).to.deep.equal({
+            children: [a, { children: [b, c], kind: "or" }],
+            kind: "and",
+        });
+    });
+});
+describe("predicate or", () => {
+    it("should be false without operands", () => {
+        expect(isFalse(or())).to.equal(true);
+    });
+    it("should drop false operands", () => {
+        expect(or(a, FALSE, b)).to.deep.equal({
+            children: [a, b],
+            kind: "or",
+        });
+    });
+    it("should collapse to true on a true operand", () => {
+        expect(isTrue(or(a, TRUE))).to.equal(true);
+    });
+    it("should collapse to true on complementary operands", () => {
+        expect(isTrue(or(a, not(leaf("a"))))).to.equal(true);
+    });
+});
+describe("predicate not", () => {
+    it("should collapse a double negation", () => {
+        expect(not(not(a))).to.deep.equal(a);
+    });
+    it("should negate the constants", () => {
+        expect(isFalse(not(TRUE))).to.equal(true);
+        expect(isTrue(not(FALSE))).to.equal(true);
+    });
+});
+describe("predicateKey", () => {
+    it("should not depend on the operand order", () => {
+        expect(predicateKey(and(a, b))).to.equal(predicateKey(and(b, a)));
+    });
+    it("should differ between and and or", () => {
+        expect(predicateKey(and(a, b))).to.not.equal(predicateKey(or(a, b)));
+    });
+});

package/dist/services/query-builder/sql/spec/regex.spec.d.ts

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

package/dist/services/query-builder/sql/spec/regex.spec.js

@@ -0,0 +1,62 @@
+import { expect } from "chai";
+import { describe, it } from "mocha";
+import { escapeRegexLiteral, toAthenaRegex } from "../regex.js";
+describe("toAthenaRegex", () => {
+    it("should keep a plain pattern", () => {
+        expect(toAthenaRegex(/^\/products\/\d+$/).pattern).to.equal(String.raw `^/products/\d+$`);
+    });
+    it("should move the i flag into the pattern", () => {
+        expect(toAthenaRegex(/^\/p\//i).pattern).to.equal(String.raw `(?i)^/p/`);
+    });
+    it("should combine the flags in a single group", () => {
+        expect(toAthenaRegex(/a.b/ims).pattern).to.equal("(?ims)a.b");
+    });
+    it("should ignore flags without a pattern equivalent", () => {
+        expect(toAthenaRegex(/abc/g).pattern).to.equal("abc");
+    });
+    it("should unescape a slash", () => {
+        expect(toAthenaRegex(/\/de\/shop/i).pattern).to.equal("(?i)/de/shop");
+    });
+    it("should keep an escaped backslash", () => {
+        expect(toAthenaRegex(/a\\b/).pattern).to.equal(String.raw `a\\b`);
+    });
+    it("should not warn about a pattern it fully supports", () => {
+        expect(toAthenaRegex(/^\/(shop|store)\/[a-z-]+$/i).warnings).to.deep.equal([]);
+    });
+    it("should keep lookahead without a warning", () => {
+        const { pattern, warnings } = toAthenaRegex(/^[^?]*\/(\?|$)/i);
+        expect(pattern).to.equal(String.raw `(?i)^[^?]*/(\?|$)`);
+        expect(warnings).to.deep.equal([]);
+    });
+    it("should warn about lookbehind", () => {
+        const { warnings } = toAthenaRegex(/(?<=\/de)\/shop/i);
+        expect(warnings).to.have.lengthOf(1);
+        expect(warnings[0]).to.contain("lookbehind");
+    });
+    it("should warn about a back reference", () => {
+        const { warnings } = toAthenaRegex(/(a)\1/);
+        expect(warnings).to.have.lengthOf(1);
+        expect(warnings[0]).to.contain("back reference");
+    });
+    it("should not read a back reference inside a character class", () => {
+        // Written through the constructor because TypeScript rejects the literal.
+        const inClass = new RegExp(String.raw `[\1]`);
+        expect(toAthenaRegex(inClass).warnings).to.deep.equal([]);
+    });
+    it("should warn about a unicode property escape", () => {
+        const { warnings } = toAthenaRegex(/\p{Letter}/u);
+        expect(warnings).to.have.lengthOf(1);
+        expect(warnings[0]).to.contain("unicode property");
+    });
+    it("should report each construct once", () => {
+        expect(toAthenaRegex(/(a)\1(b)\2/).warnings).to.have.lengthOf(1);
+    });
+});
+describe("escapeRegexLiteral", () => {
+    it("should escape the regex metacharacters", () => {
+        expect(escapeRegexLiteral("utm_source?")).to.equal(String.raw `utm_source\?`);
+    });
+    it("should leave a plain parameter name alone", () => {
+        expect(escapeRegexLiteral("gclid")).to.equal("gclid");
+    });
+});

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"
@@ -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.26.0"
+  "version": "4.27.0"
 }