@speedkit/cli 2.29.1 → 2.30.1

package/CHANGELOG.md

@@ -1,3 +1,20 @@
+## [2.30.1](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.30.0...v2.30.1) (2024-06-03)
+
+
+### Bug Fixes
+
+* **onboarding:** install resource regex ([3fe4ef9](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/3fe4ef9aadaedef45edd2a91f07ab8bb14b00687))
+* **split-change-check:** allow void return type for active install resource getter ([ed39aab](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/ed39aab739b85830f8d5c1ef57d57b5b794beb7b))
+* **split-change-check:** prevent deployment abort if origin do not exist yet ([32c722f](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/32c722f4c2af2c41a0a3bf6ee5aced3bb0b64c05))
+* **split-change-check:** replace try catch with simple active install resource check ([d588122](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/d588122a8dd91accde473c2b8eaedcfdb7b9460f))
+
+# [2.30.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.29.1...v2.30.0) (2024-05-29)
+
+
+### Features
+
+* **onboarding:** optimise start domain handling ([4128094](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/4128094f16fc208085654e4b8fc84d44f7c85307))
+
 ## [2.29.1](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.29.0...v2.29.1) (2024-05-29)
 
 

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @speedkit/cli
 $ sk COMMAND
 running command...
 $ sk (--version)
-@speedkit/cli/2.29.1 linux-x64 node-v20.14.0
+@speedkit/cli/2.30.1 linux-x64 node-v20.14.0
 $ sk --help [COMMAND]
 USAGE
   $ sk COMMAND
@@ -133,7 +133,7 @@ DESCRIPTION
 EXAMPLES
   $ sk build-parameter-query <customerPath> -c <configName>
 
-  $ sk build-parameter-query customer/decathlon.de -c production
+  $ sk build-parameter-query customers/decathlon.de -c production
 ```
 
 ## `sk build-prewarm-query CUSTOMERPATH`
@@ -156,7 +156,7 @@ DESCRIPTION
 EXAMPLES
   $ sk build-prewarm-query <customerPath> -c <configName>
 
-  $ sk build-prewarm-query customer/decathlon.de -c production
+  $ sk build-prewarm-query customers/decathlon.de -c production
 ```
 
 ## `sk deploy CUSTOMERPATH`
@@ -182,7 +182,7 @@ DESCRIPTION
 EXAMPLES
   $ sk deploy <customerPath> -c <configName> -t <slackToken> -a <artifacts> -d <dryRun>
 
-  $ sk deploy customer/decathlon.de -c production -t someSlackToken -a dynamic,SpeedKit -d
+  $ sk deploy customers/decathlon.de -c production -t someSlackToken -a dynamic,SpeedKit -d
 ```
 
 ## `sk diff-url-parameters PAGEURL`
@@ -232,7 +232,7 @@ DESCRIPTION
 EXAMPLES
   $ sk documentHandler <customerPath> -c <configName>
 
-  $ sk deploy customer/decathlon.de -c production
+  $ sk deploy customers/decathlon.de -c production
 ```
 
 ## `sk find-pops APP`
@@ -364,13 +364,14 @@ Start a local dev environment for building and testing the Speed Kit configurati
 
 ```
 USAGE
-  $ sk onboarding CUSTOMERPATH [-c <value>] [-l] [-v] [-s]
+  $ sk onboarding CUSTOMERPATH [-c <value>] [-d <value>] [-l] [-v] [-s]
 
 ARGUMENTS
   CUSTOMERPATH  The customer config path
 
 FLAGS
   -c, --configName=<value>           [default: production] The costumer config name
+  -d, --domain=<value>               Startup domain (optional)
   -l, --local                        Run with local documentHandler
   -s, --ignoreContentSecurityPolicy  Removes header/meta "content-security-policy" for origin-responses
   -v, --verboseLevel                 Show all messages
@@ -379,9 +380,9 @@ DESCRIPTION
   Start a local dev environment for building and testing the Speed Kit configuration
 
 EXAMPLES
-  $ sk onboarding <customerPath> -c <configName>
+  $ sk onboarding <customerPath> -c <configName> -d <domain>
 
-  $ sk onboarding customer/decathlon.de -c production
+  $ sk onboarding customers/decathlon.de -c production -d www.decathlon.de
 ```
 
 ## `sk param-diff PAGEURL`
@@ -470,7 +471,7 @@ DESCRIPTION
 EXAMPLES
   $ sk pull <customerPath>
 
-  $ sk pull customer/decathlon.de -c production
+  $ sk pull customers/decathlon.de -c production
 ```
 
 ## `sk wpt-launcher URLS TESTID`

package/dist/commands/onboarding.js

@@ -9,12 +9,12 @@ class Onboarding extends core_1.Command {
     static flags = onboarding_1.OnboardingContext.flags;
     static args = cli_parameters_1.CLI_CUSTOMER_CONFIG;
     static examples = [
-        `$ sk onboarding <${cli_parameters_1.CLIParameters.CustomerPath}> -${cli_parameters_1.CLIParametersChar.ConfigName} <${cli_parameters_1.CLIParameters.ConfigName}>`,
-        `$ sk onboarding ${cli_parameters_1.CLIParametersExample.CustomerPath} -${cli_parameters_1.CLIParametersChar.ConfigName} ${cli_parameters_1.CLIParametersExample.ConfigName}`,
+        `$ sk onboarding <${cli_parameters_1.CLIParameters.CustomerPath}> -${cli_parameters_1.CLIParametersChar.ConfigName} <${cli_parameters_1.CLIParameters.ConfigName}> -${cli_parameters_1.CLIParametersChar.Domain} <${cli_parameters_1.CLIParameters.Domain}>`,
+        `$ sk onboarding ${cli_parameters_1.CLIParametersExample.CustomerPath} -${cli_parameters_1.CLIParametersChar.ConfigName} ${cli_parameters_1.CLIParametersExample.ConfigName} -${cli_parameters_1.CLIParametersChar.Domain} ${cli_parameters_1.CLIParametersExample.Domain}`,
     ];
     async run() {
-        const { args: { customerPath }, flags: { configName, local, verboseLevel, ignoreContentSecurityPolicy }, } = await this.parse(Onboarding);
-        const service = await new onboarding_1.OnboardingServiceFactory(new onboarding_1.OnboardingContext(customerPath, configName, local, verboseLevel, ignoreContentSecurityPolicy), new cli_config_1.CliConfig(this.config).load()).getService();
+        const { args: { customerPath }, flags: { configName, domain, local, verboseLevel, ignoreContentSecurityPolicy, }, } = await this.parse(Onboarding);
+        const service = await new onboarding_1.OnboardingServiceFactory(new onboarding_1.OnboardingContext(customerPath, configName, domain, local, verboseLevel, ignoreContentSecurityPolicy), new cli_config_1.CliConfig(this.config).load()).getService();
         await service.run();
     }
 }

package/dist/models/cli-parameters.d.ts

@@ -8,6 +8,7 @@ export declare enum CLIParameters {
     CustomerPath = "customerPath",
     CustomersDirectory = "customersDirectory",
     Delay = "delay",
+    Domain = "domain",
     DryRun = "dryRun",
     Group = "group",
     HideDiff = "hideDiff",
@@ -33,6 +34,7 @@ export declare enum CLIParametersChar {
     CustomerPath = "p",
     CustomersDirectory = "d",
     Delay = "d",
+    Domain = "d",
     DryRun = "d",
     Group = "g",
     HideDiff = "h",
@@ -51,9 +53,10 @@ export declare enum CLIParametersExample {
     ConfigName = "production",
     ContentTypes = "image,style",
     Cookies = "consentCookies",
-    CustomerPath = "customer/decathlon.de",
+    CustomerPath = "customers/decathlon.de",
     CustomersDirectory = "customers",
     Delay = "1200",
+    Domain = "www.decathlon.de",
     Group = "B",
     Ips = "151.101.120.194",
     Mobile = "Y",

package/dist/models/cli-parameters.js

@@ -13,6 +13,7 @@ var CLIParameters;
     CLIParameters["CustomerPath"] = "customerPath";
     CLIParameters["CustomersDirectory"] = "customersDirectory";
     CLIParameters["Delay"] = "delay";
+    CLIParameters["Domain"] = "domain";
     CLIParameters["DryRun"] = "dryRun";
     CLIParameters["Group"] = "group";
     CLIParameters["HideDiff"] = "hideDiff";
@@ -40,6 +41,7 @@ var CLIParametersChar;
     CLIParametersChar["CustomerPath"] = "p";
     CLIParametersChar["CustomersDirectory"] = "d";
     CLIParametersChar["Delay"] = "d";
+    CLIParametersChar["Domain"] = "d";
     CLIParametersChar["DryRun"] = "d";
     CLIParametersChar["Group"] = "g";
     CLIParametersChar["HideDiff"] = "h";
@@ -60,9 +62,10 @@ var CLIParametersExample;
     CLIParametersExample["ConfigName"] = "production";
     CLIParametersExample["ContentTypes"] = "image,style";
     CLIParametersExample["Cookies"] = "consentCookies";
-    CLIParametersExample["CustomerPath"] = "customer/decathlon.de";
+    CLIParametersExample["CustomerPath"] = "customers/decathlon.de";
     CLIParametersExample["CustomersDirectory"] = "customers";
     CLIParametersExample["Delay"] = "1200";
+    CLIParametersExample["Domain"] = "www.decathlon.de";
     CLIParametersExample["Group"] = "B";
     CLIParametersExample["Ips"] = "151.101.120.194";
     CLIParametersExample["Mobile"] = "Y";

package/dist/services/deploy/checks/pre-deploy/split-change-check.js

@@ -22,21 +22,23 @@ class SplitChangeCheck {
         this.isProduction = isProduction;
     }
     async check() {
-        this.cli.startAction("check SplitTestId");
         if (
-        // do not check for others then production
+        // do not check for environments other than production
         !this.isProduction ||
-            // check if we deploy a speedKitConfigFile
+            // do not check if speedKitConfigFile is not to be deployed
             !this.fileList.hasFile(files_1.INTEGRATION_FILES.CONFIG.SPEED_KIT) ||
-            // check if we skipped the speedKitConfigFile
             this.fileList
                 .getByName(files_1.INTEGRATION_FILES.CONFIG.SPEED_KIT)
                 .shouldSkipFile()) {
-            this.cli.endAction(cli_1.CliActionStatus.SKIPPED);
             return;
         }
-        const speedKitConfigFile = this.fileList.getByName(files_1.INTEGRATION_FILES.CONFIG.SPEED_KIT);
         const activeInstallResource = await this.getActiveInstallResource();
+        // do not check if there is no active install resource to be updated
+        if (!activeInstallResource) {
+            return;
+        }
+        this.cli.startAction("Checking Split Test ID");
+        const speedKitConfigFile = this.fileList.getByName(files_1.INTEGRATION_FILES.CONFIG.SPEED_KIT);
         const activeSpeedKitConfig = activeInstallResource[speedKitConfigFile.remoteKey];
         const changesResponse = (0, safe_1.safe)(() => {
             return this.checkSplitsForEachOrigin(speedKitConfigFile, activeSpeedKitConfig);
@@ -132,7 +134,7 @@ class SplitChangeCheck {
         const activeInstallResourceResponse = await (0, safe_1.safe)(this.configApi.getActiveInstall(this.configName));
         if (activeInstallResourceResponse.success !== true) {
             this.cli.endAction(cli_1.CliActionStatus.FAILED);
-            this.cli.writeError("Could not load active installResource");
+            this.cli.writeError("Could not load active install resource");
             this.cli.exit(1);
             return;
         }

package/dist/services/integration-api/struct/customer-config.js

@@ -32,7 +32,7 @@ class CustomerConfig {
     }
     static createFrom(configFile, configName) {
         const { app, origins, domain, swPath, scope, appDomain, installPath, installParams, name, forceInstall, chromeFlags, dependencies, } = configFile;
-        return new CustomerConfig(new RequiredParameter("app", app).isString().getValue(), new RequiredParameter("origins", origins).isArray().getValue(), new RequiredParameter("domain", domain).isString().getValue(), new RequiredParameter("swPath", swPath).isString().getValue(), new RequiredParameter("scope", scope).isString().getValue(), appDomain || `${app}.app.baqend.com`, installPath ||
+        return new CustomerConfig(new RequiredParameter("app", app).isString().getValue(), new RequiredParameter("origins", origins).isArray().getValue(), domain, new RequiredParameter("swPath", swPath).isString().getValue(), new RequiredParameter("scope", scope).isString().getValue(), appDomain || `${app}.app.baqend.com`, installPath ||
             `https://${app}.app.baqend.com/v1/speedkit/install.js?d=${name || configName}`, installParams || 'async="" crossorigin="anonymous"', name, forceInstall || true, chromeFlags, dependencies || {});
     }
 }

package/dist/services/onboarding/fetch-events/customer-domain-document-response.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomerDomainDocumentResponse = void 0;
+const onboarding_model_1 = require("../onboarding-model");
 const origin_response_1 = require("../browser/origin-response");
 /**
  * Intercepts any request to the customersOrigin and equivalent requests to baqendAssetApi
@@ -109,7 +110,7 @@ class CustomerDomainDocumentResponse {
         return text.includes("speed-kit-dynamic");
     }
     rewriteInstallResource(text) {
-        text = text.replace(/<script(?:.(?!<\/script>))*app\.baqend\.com\/v1\/speedkit\/install.js(?:.|(?!<\/script>))*<\/script>/, "");
+        text = text.replace(onboarding_model_1.SpeedKitInstallRegex, "");
         return text.replace(/<\s*head\b[^>]*>/, (head) => {
             return `${head}\n<script src="${this.customerConfig.installPath}" ${this.customerConfig.installParams}></script>`;
         });

package/dist/services/onboarding/onboarding-model.d.ts

@@ -20,6 +20,7 @@ export interface FetchRequestPausedEventHandler {
 export declare class OnboardingContext {
     readonly customerPath: string;
     readonly configName: string;
+    readonly domain: string;
     readonly local: boolean;
     readonly verboseLevel?: boolean;
     readonly ignoreContentSecurityPolicy: boolean;
@@ -28,7 +29,7 @@ export declare class OnboardingContext {
     readonly DEFAULT_DOCUMENT_HANDLER_PATH = "https://www.baqend.com/speed-kit-handler/latest/DocumentHandler.js";
     readonly DEFAULT_SNIPPET_PATH = "https://www.baqend.com/speed-kit/latest/snippet.js";
     readonly DEFAULT_SW_PATH = "https://www.baqend.com/speed-kit/latest/sw.js";
-    constructor(customerPath: string, configName: string, local: boolean, verboseLevel?: boolean, ignoreContentSecurityPolicy?: boolean);
+    constructor(customerPath: string, configName: string, domain: string, local: boolean, verboseLevel?: boolean, ignoreContentSecurityPolicy?: boolean);
 }
 export type SpeedKitServerConfigAuthentication = {
     password: string;
@@ -72,3 +73,4 @@ export declare const USER_AGENT: {
     DESKTOP: string;
     MOBILE: string;
 };
+export declare const SpeedKitInstallRegex: RegExp;

package/dist/services/onboarding/onboarding-model.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.USER_AGENT = exports.OnboardingContext = exports.BrowserContext = void 0;
+exports.SpeedKitInstallRegex = exports.USER_AGENT = exports.OnboardingContext = exports.BrowserContext = void 0;
 const core_1 = require("@oclif/core");
 const cli_parameters_1 = require("../../models/cli-parameters");
 const DEFAULT_BROWSER_ARGS = [
@@ -42,11 +42,16 @@ exports.BrowserContext = BrowserContext;
 class OnboardingContext {
     customerPath;
     configName;
+    domain;
     local;
     verboseLevel;
     ignoreContentSecurityPolicy;
     static flags = {
         ...cli_parameters_1.CLI_CONFIG_NAME,
+        [cli_parameters_1.CLIParameters.Domain]: core_1.Flags.string({
+            char: cli_parameters_1.CLIParametersChar.Domain,
+            description: "Startup domain (optional)",
+        }),
         local: core_1.Flags.boolean({
             char: "l",
             default: false,
@@ -67,9 +72,10 @@ class OnboardingContext {
     DEFAULT_DOCUMENT_HANDLER_PATH = "https://www.baqend.com/speed-kit-handler/latest/DocumentHandler.js";
     DEFAULT_SNIPPET_PATH = "https://www.baqend.com/speed-kit/latest/snippet.js";
     DEFAULT_SW_PATH = "https://www.baqend.com/speed-kit/latest/sw.js";
-    constructor(customerPath, configName, local, verboseLevel, ignoreContentSecurityPolicy = false) {
+    constructor(customerPath, configName, domain, local, verboseLevel, ignoreContentSecurityPolicy = false) {
         this.customerPath = customerPath;
         this.configName = configName;
+        this.domain = domain;
         this.local = local;
         this.verboseLevel = verboseLevel;
         this.ignoreContentSecurityPolicy = ignoreContentSecurityPolicy;
@@ -80,3 +86,4 @@ exports.USER_AGENT = {
     DESKTOP: "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.79 Safari/537.36 (compatible; SpeedKit/1.0)",
     MOBILE: "Mozilla/5.0 (Linux; Android 7.1.1; ONEPLUS A5000 Build/NMF26X) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/60.0.3112.107 Mobile Safari/537.36 (compatible; SpeedKit/1.0)",
 };
+exports.SpeedKitInstallRegex = /<script(?:(?!<\/script>).)*app\.baqend\.com\/v1\/speedkit\/install.js(?:(?!<\/script>).)*<\/script>/s;

package/dist/services/onboarding/onboarding-service-factory.d.ts

@@ -13,4 +13,5 @@ export declare class OnboardingServiceFactory {
     private getSpeedKitServerConfig;
     private getIntegrationFiles;
     private getUrlForTest;
+    private ensureHttps;
 }

package/dist/services/onboarding/onboarding-service-factory.js

@@ -147,13 +147,23 @@ class OnboardingServiceFactory {
         ]);
     }
     async getUrlForTest(customerConfig, cli) {
-        let domainToStart = customerConfig.origins[0];
-        if (customerConfig.origins.length > 1) {
-            domainToStart = await cli.select("select domain to start", customerConfig.origins.map((origin) => {
-                return { name: origin, value: origin };
-            }));
+        // Consider startup domain based on the following priority:
+        // 1. domain flag (-d)
+        // 2. customerConfig.domain
+        // 3. customerConfig.origins (prompt selection if more than 1 entry)
+        let domainToStart = this.context.domain || customerConfig.domain;
+        if (!domainToStart) {
+            domainToStart = customerConfig.origins[0];
+            if (customerConfig.origins.length > 1) {
+                domainToStart = await cli.select("Select domain to start", customerConfig.origins.map((origin) => {
+                    return { name: origin, value: origin };
+                }));
+            }
         }
-        return domainToStart;
+        return this.ensureHttps(domainToStart);
+    }
+    ensureHttps(url = "") {
+        return url.startsWith("https://") ? url : `https://${url}`;
     }
 }
 exports.OnboardingServiceFactory = OnboardingServiceFactory;

package/dist/services/onboarding/virtual-orestes-app/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.VirtualOrestesApp = void 0;
 const baqend_response_1 = require("../browser/baqend-response");
 const safe_1 = require("../../../helpers/safe");
+const onboarding_model_1 = require("../onboarding-model");
 class VirtualOrestesApp {
     customerConfig;
     crawler;
@@ -181,7 +182,7 @@ class VirtualOrestesApp {
         return text.includes("<html");
     }
     rewriteInstallResource(text) {
-        text = text.replace(/<script(?:.(?!<\/script>))*app\.baqend\.com\/v1\/speedkit\/install.js(?:.|(?!<\/script>))*<\/script>/, "");
+        text = text.replace(onboarding_model_1.SpeedKitInstallRegex, "");
         return text.replace(/<\s*head\b[^>]*>/, (head) => {
             return `${head}\n<script src="${this.customerConfig.installPath}" ${this.customerConfig.installParams}></script>`;
         });

package/oclif.manifest.json

@@ -12,7 +12,7 @@
       "description": "Build a parameter query that can be executed in Athena",
       "examples": [
         "$ sk build-parameter-query <customerPath> -c <configName>",
-        "$ sk build-parameter-query customer/decathlon.de -c production"
+        "$ sk build-parameter-query customers/decathlon.de -c production"
       ],
       "flags": {
         "configName": {
@@ -52,7 +52,7 @@
       "description": "Build a prewarm query that can be executed in Athena",
       "examples": [
         "$ sk build-prewarm-query <customerPath> -c <configName>",
-        "$ sk build-prewarm-query customer/decathlon.de -c production"
+        "$ sk build-prewarm-query customers/decathlon.de -c production"
       ],
       "flags": {
         "configName": {
@@ -92,7 +92,7 @@
       "description": "Deploys the specified customer config while comparing to the live version before",
       "examples": [
         "$ sk deploy <customerPath> -c <configName> -t <slackToken> -a <artifacts> -d <dryRun>",
-        "$ sk deploy customer/decathlon.de -c production -t someSlackToken -a dynamic,SpeedKit -d"
+        "$ sk deploy customers/decathlon.de -c production -t someSlackToken -a dynamic,SpeedKit -d"
       ],
       "flags": {
         "configName": {
@@ -196,7 +196,7 @@
       "description": "Creates testable documentHandler in folder {CUSTOMER_PATH}/test/src/",
       "examples": [
         "$ sk documentHandler <customerPath> -c <configName>",
-        "$ sk deploy customer/decathlon.de -c production"
+        "$ sk deploy customers/decathlon.de -c production"
       ],
       "flags": {
         "configName": {
@@ -433,8 +433,8 @@
       },
       "description": "Start a local dev environment for building and testing the Speed Kit configuration",
       "examples": [
-        "$ sk onboarding <customerPath> -c <configName>",
-        "$ sk onboarding customer/decathlon.de -c production"
+        "$ sk onboarding <customerPath> -c <configName> -d <domain>",
+        "$ sk onboarding customers/decathlon.de -c production -d www.decathlon.de"
       ],
       "flags": {
         "configName": {
@@ -446,6 +446,14 @@
           "multiple": false,
           "type": "option"
         },
+        "domain": {
+          "char": "d",
+          "description": "Startup domain (optional)",
+          "name": "domain",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "local": {
           "char": "l",
           "description": "Run with local documentHandler",
@@ -579,7 +587,7 @@
       "description": "Pull the specified customer config from orestes",
       "examples": [
         "$ sk pull <customerPath>",
-        "$ sk pull customer/decathlon.de -c production"
+        "$ sk pull customers/decathlon.de -c production"
       ],
       "flags": {
         "configName": {
@@ -667,5 +675,5 @@
       ]
     }
   },
-  "version": "2.29.1"
+  "version": "2.30.1"
 }

package/package.json

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