@speedkit/cli 2.63.0 → 2.65.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [2.65.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.64.0...v2.65.0) (2024-11-01)
+
+
+### Features
+
+* adding success to default blacklist as requested by Sven ([7e9cc40](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/7e9cc4020b4a564044ea4817905bd3450586e623))
+
+# [2.64.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.63.0...v2.64.0) (2024-11-01)
+
+
+### Features
+
+* **deploy:** add preDeployCheck for customVariation and customDevice ([eda9271](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/eda92715c21963a97b907795fecaa06e579d5629))
+
 # [2.63.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.62.1...v2.63.0) (2024-11-01)
 
 

package/README.md

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

package/dist/services/customer-config/templates/config_SpeedKit.js.hbs

@@ -175,6 +175,7 @@
           /amazon/i,
           /ratepay/i,
           /payone/i,
+          /success/i,
 
           // Admin:
           /\/admin/i,

package/dist/services/deploy/checks/pre-deploy/device-detection-changed-check.d.ts

@@ -0,0 +1,18 @@
+import { FileListInterface, CustomerConfig } from "../../../integration-api";
+import { CliServiceInterface } from "../../../cli";
+import { ConfigApiService } from "../../../config-api";
+export declare class DeviceDetectionChangedCheck {
+    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 checkForChangedDeviceDetection;
+    private evaluateLocalAndRemoteSpeedKit;
+    private getActiveInstallResource;
+    private buildBrowserMock;
+    safeFileContentWrapper(fileContent: string): string;
+}

package/dist/services/deploy/checks/pre-deploy/device-detection-changed-check.js

@@ -0,0 +1,189 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeviceDetectionChangedCheck = 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");
+const evaluate_sk_config_error_1 = require("../../error/evaluate-sk-config-error");
+class DeviceDetectionChangedCheck {
+    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() {
+        if (
+        // do not check for environments other than production
+        !this.isProduction ||
+            // do not check if speedKitConfigFile is not to be deployed
+            !this.fileList.hasFile(files_1.INTEGRATION_FILES.CONFIG.SPEED_KIT) ||
+            this.fileList
+                .getByName(files_1.INTEGRATION_FILES.CONFIG.SPEED_KIT)
+                .shouldSkipFile()) {
+            return;
+        }
+        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 for customDeviceDetection");
+        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.checkForChangedDeviceDetection(speedKitConfigFile, activeSpeedKitConfig);
+        });
+        if (changesResponse.success === false) {
+            this.cli.endAction(cli_1.CliActionStatus.FAILED);
+            this.cli.writeError(`Unable to evaluate changes: ${changesResponse.error}`);
+            return;
+        }
+        const changes = changesResponse.data.map((value) => {
+            return "config_SpeedKit." + value;
+        });
+        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(`Detected change in ${changes.join(" | ")}. ${this.cli.style.red("Was this checked by QA?")}`, false);
+        if (!result) {
+            this.cli.exit(0);
+        }
+    }
+    checkForChangedDeviceDetection(speedKitConfigFile, activeSpeedKitConfig) {
+        const changes = [];
+        const { localSpeedKit, remoteSpeedKit } = this.evaluateLocalAndRemoteSpeedKit(this.customerConfig.origins[0], speedKitConfigFile, activeSpeedKitConfig);
+        if ((localSpeedKit.detectDevice && !remoteSpeedKit.detectDevice) ||
+            (!localSpeedKit.detectDevice && remoteSpeedKit.detectDevice)) {
+            changes.push("detectDevice");
+        }
+        if (localSpeedKit.detectDevice &&
+            remoteSpeedKit.detectDevice &&
+            localSpeedKit.detectDevice.toString() !==
+                remoteSpeedKit.detectDevice.toString()) {
+            changes.push("detectDevice");
+        }
+        if ((localSpeedKit.customVariation && !remoteSpeedKit.customVariation) ||
+            (!localSpeedKit.customVariation && remoteSpeedKit.customVariation)) {
+            changes.push("customVariation");
+        }
+        if (localSpeedKit.customVariation && remoteSpeedKit.customVariation) {
+            const localFunctionsAsString = localSpeedKit.customVariation
+                .map((rule) => {
+                return rule.variationFunction.toString();
+            })
+                .join("|");
+            const remoteFunctionsAsString = remoteSpeedKit.customVariation
+                .map((rule) => {
+                return rule.variationFunction.toString();
+            })
+                .join("|");
+            if (localFunctionsAsString !== remoteFunctionsAsString) {
+                changes.push("customVariation");
+            }
+        }
+        return changes;
+    }
+    evaluateLocalAndRemoteSpeedKit(origin, speedKitConfigFile, activeSpeedKitConfig) {
+        const localBrowserContext = this.buildBrowserMock(origin, this.customerConfig.app);
+        vm.runInNewContext(this.safeFileContentWrapper(speedKitConfigFile.getContent()), localBrowserContext, {
+            filename: speedKitConfigFile.path,
+            displayErrors: false,
+            breakOnSigint: true,
+        });
+        const remoteBrowserContext = this.buildBrowserMock(origin, this.customerConfig.app);
+        vm.runInNewContext(this.safeFileContentWrapper(activeSpeedKitConfig), remoteBrowserContext, {
+            displayErrors: false,
+            breakOnSigint: true,
+        });
+        if (localBrowserContext.vmError !== null) {
+            throw new evaluate_sk_config_error_1.EvaluateSkConfigError(`[config_Speedkit.js] ${localBrowserContext.vmError?.message}`);
+        }
+        if (remoteBrowserContext.vmError !== null) {
+            throw new evaluate_sk_config_error_1.EvaluateSkConfigError(`[remote_config] ${JSON.stringify(remoteBrowserContext.vmError?.message)}`);
+        }
+        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 install resource");
+            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,
+            navigator: {
+                userAgent: "",
+                connection: {},
+                cookieEnabled: false,
+                languages: [],
+                online: true,
+            },
+            top: {},
+        };
+        window.top = window;
+        const document = {
+            cookie: "",
+            querySelector: () => { },
+            querySelectorAll: () => { },
+            createElement: () => { },
+            addEventListener: () => { },
+            head: {},
+            body: {},
+        };
+        document.head = document;
+        document.body = document;
+        return {
+            vmError: null,
+            ...window,
+            window,
+            document,
+            navigator: { userAgent: "" },
+            localStorage: {
+                getItem: () => { },
+                setItem: () => { },
+            },
+            JSON: JSON,
+            decodeURIComponent: decodeURIComponent,
+            URL: URL,
+        };
+    }
+    safeFileContentWrapper(fileContent) {
+        return `
+      try{
+        ${fileContent}
+      } catch (error){
+        vmError = error
+      }
+    `;
+    }
+}
+exports.DeviceDetectionChangedCheck = DeviceDetectionChangedCheck;

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

@@ -17,6 +17,7 @@ const integration_api_1 = require("../integration-api");
 const split_change_check_1 = require("./checks/pre-deploy/split-change-check");
 const config_api_1 = require("../config-api");
 const deprecated_deployment_detection_check_1 = require("./checks/post-deploy/deprecated-deployment-detection-check");
+const device_detection_changed_check_1 = require("./checks/pre-deploy/device-detection-changed-check");
 class DeployServiceFactory {
     context;
     cliConfig;
@@ -50,6 +51,7 @@ class DeployServiceFactory {
             new server_config_handler_1.default(configApi, diffService, cliService),
         ], cliService, [
             new split_change_check_1.SplitChangeCheck(cliService, files, configApi, customer, configName, this.context.isProduction),
+            new device_detection_changed_check_1.DeviceDetectionChangedCheck(cliService, files, configApi, customer, configName, this.context.isProduction),
         ], this.getPostDeployChecks(files, cliService, configApi, customer.app), this.context.dryRun);
     }
     getConfigApi(app) {

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

@@ -10,3 +10,20 @@ export type Change = {
     old: string;
     new: string;
 };
+export type speedKitVariationRule = {
+    contentType?: string[];
+    host?: string[];
+    pathname?: Array<string | RegExp>;
+    url?: Array<string | RegExp>;
+};
+export type speedKitVariationRules = {
+    rules?: speedKitVariationRule;
+    variationFunction: (request: Request, device: string, cookies: Map<string, string>) => string;
+};
+export type speedKit = {
+    split: number;
+    splitTestId: string;
+    userAgentDetection?: boolean;
+    detectDevice?: (doc: Document) => string | null;
+    customVariation?: speedKitVariationRules[];
+};

package/oclif.manifest.json

@@ -712,5 +712,5 @@
       ]
     }
   },
-  "version": "2.63.0"
+  "version": "2.65.0"
 }

package/package.json

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