@speedkit/cli 2.23.1 → 2.24.0

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+# [2.24.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.23.2...v2.24.0) (2024-04-17)
+
+
+### Features
+
+* **deploy:** add more detailed browserContext for vm ([4a32740](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/4a32740947c14b9c5d083ab022d3bcd6aa7d9113))
+* **deploy:** catch error on splitTestIdCheck ([34844bd](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/34844bddf2ecc165ebc62e38ddca43be8c8763f2))
+* **deploy:** implement splitChangeDetection ([ab0a56b](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/ab0a56bf43f8d5e20fd9d0a6669ae2a04180e232))
+
+## [2.23.2](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.23.1...v2.23.2) (2024-04-16)
+
+
+### Bug Fixes
+
+* **onboarding:** disable parameter dashboard temporarily ([c71bd4f](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/c71bd4faae3a38c7884d5bfcf20a48e7be2ccbe1))
+
 ## [2.23.1](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.23.0...v2.23.1) (2024-04-12)
 
 

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @speedkit/cli
 $ sk COMMAND
 running command...
 $ sk (--version)
-@speedkit/cli/2.23.1 linux-x64 node-v20.12.2
+@speedkit/cli/2.24.0 linux-x64 node-v20.12.2
 $ sk --help [COMMAND]
 USAGE
   $ sk COMMAND

package/dist/services/cli/cli-service-model.d.ts

@@ -1,5 +1,6 @@
 import { table } from "@oclif/core/lib/cli-ux/styled/table";
 import { Options } from "cli-progress";
+import chalk from "chalk";
 export declare class CliContext {
     readonly quiet: boolean;
     constructor(quiet?: boolean);
@@ -10,6 +11,7 @@ export declare enum CliActionStatus {
     SKIPPED = "skipped"
 }
 export interface CliServiceInterface {
+    style: chalk.Chalk;
     code(code: string, buffered?: boolean): void;
     codeStyle(code: string): string;
     comment(message: string, buffered?: boolean): void;

package/dist/services/cli/cli-service.d.ts

@@ -4,17 +4,7 @@ import { Options } from "cli-progress";
 import { CliActionStatus, CliServiceInterface } from "./cli-service-model";
 export declare class CliService implements CliServiceInterface {
     private readonly quiet;
-    style: chalk.Chalk & chalk.ChalkFunction & {
-        supportsColor: false | chalk.ColorSupport;
-        Level: chalk.Level;
-        Color: ("white" | "black" | "blue" | "yellow" | "green" | "red" | "magenta" | "cyan" | "gray" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright" | "whiteBright" | "grey") | ("bgBlack" | "bgRed" | "bgGreen" | "bgYellow" | "bgBlue" | "bgMagenta" | "bgCyan" | "bgWhite" | "bgGray" | "bgBlackBright" | "bgRedBright" | "bgGreenBright" | "bgYellowBright" | "bgBlueBright" | "bgMagentaBright" | "bgCyanBright" | "bgWhiteBright" | "bgGrey");
-        ForegroundColor: "white" | "black" | "blue" | "yellow" | "green" | "red" | "magenta" | "cyan" | "gray" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright" | "whiteBright" | "grey";
-        BackgroundColor: "bgBlack" | "bgRed" | "bgGreen" | "bgYellow" | "bgBlue" | "bgMagenta" | "bgCyan" | "bgWhite" | "bgGray" | "bgBlackBright" | "bgRedBright" | "bgGreenBright" | "bgYellowBright" | "bgBlueBright" | "bgMagentaBright" | "bgCyanBright" | "bgWhiteBright" | "bgGrey";
-        Modifiers: "bold" | "hidden" | "underline" | "dim" | "italic" | "strikethrough" | "visible" | "reset" | "inverse";
-        stderr: chalk.Chalk & {
-            supportsColor: false | chalk.ColorSupport;
-        };
-    };
+    style: chalk.Chalk;
     private buffer;
     private progressBar?;
     constructor(quiet?: boolean);

package/dist/services/cli/cli-service.js

@@ -115,7 +115,9 @@ class CliService {
         this.progressBar.stop();
     }
     table(data, columns, options) {
+        this.spacer();
         core_1.ux.table(data, columns, options);
+        this.spacer();
     }
     updateProgress(current, payload) {
         if (this.quiet) {

package/dist/services/deploy/checks/post-deploy/revalidated-module-check.d.ts

@@ -1,6 +1,6 @@
 import { CliService } from "../../../cli";
 import ConfigApiService from "../../../config-api/config-api-service";
-import PostDeployCheckInterface from "../../interface/post-deploy-check-interface";
+import { PostDeployCheckInterface } from "../../deploy-service-model";
 export default class RevalidatedModuleCheck implements PostDeployCheckInterface {
     private readonly configApi;
     private cli;

package/dist/services/deploy/checks/post-deploy/save-files-check.d.ts

@@ -1,6 +1,6 @@
 import { CliService } from "../../../cli";
-import PostDeployCheckInterface from "../../interface/post-deploy-check-interface";
 import { FileListInterface } from "../../../integration-api/integration-api-model";
+import { PostDeployCheckInterface } from "../../deploy-service-model";
 export default class SaveFilesCheck implements PostDeployCheckInterface {
     private fileList;
     private readonly cli;

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

@@ -0,0 +1,18 @@
+import { FileListInterface } from "../../../integration-api/integration-api-model";
+import { CliServiceInterface } from "../../../cli";
+import ConfigApiService from "../../../config-api/config-api-service";
+import CustomerConfig from "../../../integration-api/struct/customer-config";
+export declare class SplitChangeCheck {
+    private cli;
+    private fileList;
+    private configApi;
+    private customerConfig;
+    private configName;
+    private isProduction;
+    constructor(cli: CliServiceInterface, fileList: FileListInterface, configApi: ConfigApiService, customerConfig: CustomerConfig, configName: string, isProduction: boolean);
+    check(): Promise<void>;
+    private checkSplitsForEachOrigin;
+    private evaluateLocalAndRemoteSpeedKit;
+    private getActiveInstallResource;
+    private buildBrowserMock;
+}

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

@@ -0,0 +1,178 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SplitChangeCheck = void 0;
+const tslib_1 = require("tslib");
+const cli_1 = require("../../../cli");
+const files_1 = require("../../../../models/files");
+const vm = tslib_1.__importStar(require("node:vm"));
+const safe_1 = require("../../../../helpers/safe");
+class SplitChangeCheck {
+    cli;
+    fileList;
+    configApi;
+    customerConfig;
+    configName;
+    isProduction;
+    constructor(cli, fileList, configApi, customerConfig, configName, isProduction) {
+        this.cli = cli;
+        this.fileList = fileList;
+        this.configApi = configApi;
+        this.customerConfig = customerConfig;
+        this.configName = configName;
+        this.isProduction = isProduction;
+    }
+    async check() {
+        this.cli.startAction("check SplitTestId");
+        if (
+        // do not check for others then production
+        !this.isProduction ||
+            // check if we deploy a speedKitConfigFile
+            !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();
+        const activeSpeedKitConfig = activeInstallResource[speedKitConfigFile.remoteKey];
+        const changesResponse = (0, safe_1.safe)(() => {
+            return this.checkSplitsForEachOrigin(speedKitConfigFile, activeSpeedKitConfig);
+        });
+        if (changesResponse.success === false) {
+            this.cli.endAction(cli_1.CliActionStatus.FAILED);
+            this.cli.writeError(`Unable to evaluate changes: ${changesResponse.error}`);
+            if (changesResponse.errorObj) {
+                console.error(changesResponse.errorObj);
+            }
+            return;
+        }
+        const changes = changesResponse.data;
+        this.cli.endAction(cli_1.CliActionStatus.COMPLETED);
+        if (changes.length === 0) {
+            return;
+        }
+        this.cli.table(changes, { origin: {}, type: {}, old: {}, new: {} });
+        const result = await this.cli.confirm("Split change detected. Do you want to continue?", false);
+        if (!result) {
+            this.cli.exit(0);
+        }
+    }
+    checkSplitsForEachOrigin(speedKitConfigFile, activeSpeedKitConfig) {
+        const changes = [];
+        for (const origin of this.customerConfig.origins) {
+            const { localSpeedKit, remoteSpeedKit } = this.evaluateLocalAndRemoteSpeedKit(origin, speedKitConfigFile, activeSpeedKitConfig);
+            // check for split change
+            if (localSpeedKit.split !== remoteSpeedKit.split) {
+                changes.push({
+                    origin,
+                    type: "split",
+                    new: this.cli.style.green(localSpeedKit.split),
+                    old: remoteSpeedKit.split,
+                });
+            }
+            // check for splitId change
+            if (localSpeedKit.splitTestId !== remoteSpeedKit.splitTestId) {
+                changes.push({
+                    origin,
+                    type: "splitTestId",
+                    new: this.cli.style.green(localSpeedKit.splitTestId),
+                    old: remoteSpeedKit.splitTestId,
+                });
+            }
+            // check for split change without splitId change
+            if (localSpeedKit.split !== remoteSpeedKit.split &&
+                localSpeedKit.splitTestId === remoteSpeedKit.splitTestId) {
+                changes.push({
+                    origin,
+                    type: this.cli.style.yellow("split changed\nwithout id change"),
+                    new: `${localSpeedKit.split}\n${this.cli.style.red(localSpeedKit.splitTestId)}`,
+                    old: `${remoteSpeedKit.split}\n${remoteSpeedKit.splitTestId}`,
+                });
+            }
+            // check for splitId change without split change
+            if (localSpeedKit.split === remoteSpeedKit.split &&
+                localSpeedKit.splitTestId !== remoteSpeedKit.splitTestId) {
+                changes.push({
+                    origin,
+                    type: this.cli.style.yellow("id changed\nwithout split change"),
+                    new: `${this.cli.style.red(localSpeedKit.split)}\n${localSpeedKit.splitTestId}`,
+                    old: `${remoteSpeedKit.split}\n${remoteSpeedKit.splitTestId}`,
+                });
+            }
+            // check for invalid split value
+            if (localSpeedKit.split > 1 || localSpeedKit.split < 0) {
+                changes.push({
+                    origin,
+                    type: this.cli.style.red("invalid"),
+                    new: this.cli.style.red(localSpeedKit.split),
+                    old: remoteSpeedKit.split,
+                });
+            }
+        }
+        return changes;
+    }
+    evaluateLocalAndRemoteSpeedKit(origin, speedKitConfigFile, activeSpeedKitConfig) {
+        const localBrowserContext = this.buildBrowserMock(origin, this.customerConfig.app);
+        vm.runInNewContext(speedKitConfigFile.getContent(), localBrowserContext, {
+            filename: speedKitConfigFile.path,
+            displayErrors: true,
+        });
+        const remoteBrowserContext = this.buildBrowserMock(origin, this.customerConfig.app);
+        vm.runInNewContext(activeSpeedKitConfig, remoteBrowserContext, {
+            displayErrors: true,
+        });
+        const localSpeedKit = localBrowserContext.window.speedKit;
+        const remoteSpeedKit = remoteBrowserContext.window.speedKit;
+        return { localSpeedKit, remoteSpeedKit };
+    }
+    async getActiveInstallResource() {
+        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.exit(1);
+            return;
+        }
+        return activeInstallResourceResponse.data;
+    }
+    buildBrowserMock(origin, app) {
+        const originUrl = new URL(origin);
+        const window = {
+            location: originUrl,
+            APP: app,
+            speedKit: {
+                split: undefined,
+                splitTestId: undefined,
+            },
+            serviceWorkerUrl: "",
+            screen: { width: 0, height: 0 },
+            devicePixelRatio: 1,
+            top: {},
+        };
+        window.top = window;
+        const document = {
+            cookie: "",
+            querySelector: () => { },
+            querySelectorAll: () => { },
+            createElement: () => { },
+            addEventListener: () => { },
+            head: {},
+            body: {},
+        };
+        document.head = document;
+        document.body = document;
+        return {
+            ...window,
+            window,
+            document,
+            navigator: { userAgent: "" },
+            localStorage: { getItem: () => { }, setItem: () => { } },
+            JSON: JSON,
+            decodeURIComponent: decodeURIComponent,
+        };
+    }
+}
+exports.SplitChangeCheck = SplitChangeCheck;

package/dist/services/deploy/context/deploy-context.d.ts

@@ -4,6 +4,7 @@ export default class DeployContext {
     readonly slackToken?: string;
     readonly dryRun: boolean;
     readonly artifacts?: string[];
+    readonly isProduction: boolean;
     constructor(customerPath: string, configName?: string, slackToken?: string, artifacts?: string, dryRun?: boolean);
     hasArtifacts(): boolean;
 }

package/dist/services/deploy/context/deploy-context.js

@@ -11,12 +11,14 @@ class DeployContext {
     slackToken;
     dryRun;
     artifacts;
+    isProduction;
     constructor(customerPath, configName = DEFAULT_CONFIG_NAME, slackToken, artifacts, dryRun = false) {
         this.customerPath = customerPath;
         this.configName = configName;
         this.slackToken = slackToken;
         this.dryRun = dryRun;
         this.artifacts = artifacts ? artifacts.split(ARTIFACTS_SEPARATOR) : [];
+        this.isProduction = configName.toLowerCase().includes("prod");
     }
     hasArtifacts() {
         return this.artifacts?.length > 0;

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

@@ -17,6 +17,7 @@ const deleted_file_check_1 = tslib_1.__importDefault(require("./handler/install-
 const module_handler_1 = tslib_1.__importDefault(require("./handler/module-handler"));
 const deployment_detection_modifier_1 = tslib_1.__importDefault(require("./handler/module-modifier/deployment-detection-modifier"));
 const server_config_handler_1 = tslib_1.__importDefault(require("./handler/server-config-handler"));
+const split_change_check_1 = require("./checks/pre-deploy/split-change-check");
 class DeployServiceFactory {
     context;
     cliConfig;
@@ -48,7 +49,9 @@ class DeployServiceFactory {
                 new deployment_detection_modifier_1.default(slackToken),
             ]),
             new server_config_handler_1.default(configApi, diffService, cliService),
-        ], cliService, this.getPostDeployChecks(files, cliService, configApi, customer.app), this.context.dryRun);
+        ], cliService, [
+            new split_change_check_1.SplitChangeCheck(cliService, files, configApi, customer, configName, this.context.isProduction),
+        ], this.getPostDeployChecks(files, cliService, configApi, customer.app), this.context.dryRun);
     }
     getConfigApi(app) {
         const configApiContext = new config_api_context_1.default(app);

package/dist/services/deploy/deploy-service-model.d.ts

@@ -0,0 +1,12 @@
+export interface PostDeployCheckInterface {
+    check(): Promise<void>;
+}
+export interface PreDeployCheckInterface {
+    check(): Promise<void>;
+}
+export type Change = {
+    origin: string;
+    type: string;
+    old: string;
+    new: string;
+};

package/dist/services/deploy/deploy-service.d.ts

@@ -1,17 +1,18 @@
 import DeployHandlerInterface from "./interface/deploy-handler-interface";
 import { CliService } from "../cli";
-import PostDeployCheckInterface from "./interface/post-deploy-check-interface";
-import AbstractAsyncErrorHandlingService from "../error-handling/abstract/abstract-async-error-handling-service";
 import { FileListInterface } from "../integration-api/integration-api-model";
-export default class DeployService extends AbstractAsyncErrorHandlingService {
+import { PostDeployCheckInterface, PreDeployCheckInterface } from "./deploy-service-model";
+export default class DeployService {
     private readonly fileList;
     private readonly deployHandler;
     private readonly cli;
-    private readonly dryRun;
+    private readonly preDeployChecks;
     private readonly postDeployChecks;
-    constructor(fileList: FileListInterface, deployHandler: DeployHandlerInterface[], cli: CliService, postDeployChecks: PostDeployCheckInterface[], dryRun: boolean);
-    _run(): Promise<void>;
+    private readonly dryRun;
+    constructor(fileList: FileListInterface, deployHandler: DeployHandlerInterface[], cli: CliService, preDeployChecks: PreDeployCheckInterface[], postDeployChecks: PostDeployCheckInterface[], dryRun: boolean);
+    run(): Promise<void>;
     private handleType;
     private uploadType;
+    private runPreDeployChecks;
     private runPostDeployChecks;
 }

package/dist/services/deploy/deploy-service.js

@@ -1,22 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const abstract_async_error_handling_service_1 = tslib_1.__importDefault(require("../error-handling/abstract/abstract-async-error-handling-service"));
-class DeployService extends abstract_async_error_handling_service_1.default {
+class DeployService {
     fileList;
     deployHandler;
     cli;
-    dryRun = false;
+    preDeployChecks;
     postDeployChecks;
-    constructor(fileList, deployHandler, cli, postDeployChecks, dryRun) {
-        super();
+    dryRun;
+    constructor(fileList, deployHandler, cli, preDeployChecks, postDeployChecks, dryRun) {
         this.fileList = fileList;
         this.deployHandler = deployHandler;
         this.cli = cli;
+        this.preDeployChecks = preDeployChecks;
         this.postDeployChecks = postDeployChecks;
         this.dryRun = dryRun;
     }
-    async _run() {
+    async run() {
         const types = this.fileList.getTypes();
         this.cli.spacer();
         this.cli.write(`App: "${this.fileList.getCustomerConfig().config.app}", Install: "${this.fileList.getCustomerConfig().config.name}"`);
@@ -25,6 +24,7 @@ class DeployService extends abstract_async_error_handling_service_1.default {
         for (const type of types) {
             await this.handleType(type);
         }
+        await this.runPreDeployChecks();
         if (this.dryRun) {
             this.cli.comment("dryRunFlag -d is set, skip upload");
         }
@@ -51,6 +51,11 @@ class DeployService extends abstract_async_error_handling_service_1.default {
             }
         }
     }
+    async runPreDeployChecks() {
+        for (const preDeploy of this.preDeployChecks) {
+            await preDeploy.check();
+        }
+    }
     async runPostDeployChecks() {
         for (let iterator = 0; iterator < this.postDeployChecks.length; iterator++) {
             const check = this.postDeployChecks[iterator];

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

@@ -109,7 +109,12 @@ class OnboardingServiceFactory {
         const athenaClient = await this.getAthenaClient();
         if (athenaClient) {
             handlers.push(new dashboard_request_1.DashboardRequest(new dashboard_1.Dashboard(customerConfig, parameterQueryBuilder, athenaClient, requestDiffService, cache)));
-            browserContext.startParameterDashboard = true;
+            /**
+             *   todo check error `Cannot read properties of undefined (reading 'mainFrame')`
+             *   until this is fixed, we need to deaktivate the parameter dashboard
+             *   See ticket: https://www.notion.so/baqend/d3749c5796d647f5892aa5ebfa2fd75f?v=306744f97b924ce29f59a2a3779a045c&p=728aae13a9a94c10807f368143b7dabf&pm=s
+             **/
+            // browserContext.startParameterDashboard = true;
         }
         return new fetch_event_handler_1.FetchEventHandler(handlers, customerConfig, cli, configApi);
     }

package/oclif.manifest.json

@@ -660,5 +660,5 @@
       ]
     }
   },
-  "version": "2.23.1"
+  "version": "2.24.0"
 }

package/package.json

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

package/dist/services/deploy/interface/post-deploy-check-interface.d.ts

@@ -1,3 +0,0 @@
-export default interface PostDeployCheckInterface {
-    check(): Promise<void>;
-}