@speedkit/cli 2.95.0 → 3.0.0

package/dist/services/query-builder/error/parse-config-speed-kit-error.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParseConfigSpeedKitError = void 0;
+const config_file_error_1 = require("../../error-handling/error/config-file-error");
+class ParseConfigSpeedKitError extends config_file_error_1.ConfigFileError {
+    constructor(message) {
+        super(message);
+        this.suggestions = ["please check file config_SpeedKit"];
+    }
+}
+exports.ParseConfigSpeedKitError = ParseConfigSpeedKitError;

package/dist/services/query-builder/query/parameter.d.ts

@@ -0,0 +1,4 @@
+export declare class Parameter {
+    readonly query: string;
+    constructor(app: string, parameterFilter: string, whitelistedFilter: string, blacklistedFilter: string, parameterReplaceFilter: string);
+}

package/dist/services/query-builder/query/parameter.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Parameter = void 0;
+class Parameter {
+    query;
+    constructor(app, parameterFilter, whitelistedFilter, blacklistedFilter, parameterReplaceFilter) {
+        const nowMinusOneMonth = new Date(new Date().setMonth(new Date().getMonth() - 1, new Date().getDate()));
+        const monthString = `${nowMinusOneMonth.getMonth() + 1 < 10 ? "0" : ""}${nowMinusOneMonth.getMonth() + 1}`;
+        const dateString = `${nowMinusOneMonth.getDate() < 10 ? "0" : ""}${nowMinusOneMonth.getDate()}`;
+        const date = `${nowMinusOneMonth.getFullYear()}-${monthString}-${dateString}`;
+        this.query = `
+with urlWithParams as (
+ select
+  url,
+  createdat,
+  split(url, '?')[1] as urlWithoutParams,
+  filter (
+      transform(
+        split(split(url, '?')[2], '&'),
+        (pair) -> split(pair, '=')[1]
+      ),
+      (key) -> ${parameterFilter}
+  ) as paramKeys
+from live.rum.pi
+where app = '${app}'
+  and date >= '${date}'
+  and cardinality(split(url, '?')) > 1
+  and (${whitelistedFilter})
+  and ${blacklistedFilter}
+), prepared as (
+select count(*) as PIs,
+  count(distinct url) as urls,
+  count(distinct ${parameterReplaceFilter}) as cachedUrls,
+  count(distinct urlWithoutParams) as uniqueWithoutParam,
+  paramKeys,
+  element_at(array_distinct(max_by(url, MD5(to_utf8(to_iso8601(createdat))), 500)), 1) as example1,
+  element_at(array_distinct(max_by(url, MD5(to_utf8(to_iso8601(createdat))), 500)), 2) as example2,
+  element_at(array_distinct(max_by(url, MD5(to_utf8(to_iso8601(createdat))), 500)), 3) as example3
+from urlWithParams
+group by paramKeys
+)
+
+select paramKeys, cachedUrls - uniqueWithoutParam as potentialGain, cachedUrls, PIs, example1, example2, example3
+from prepared
+where cardinality(paramKeys) > 0
+order by potentialGain desc, cachedUrls desc, PIs desc`;
+    }
+}
+exports.Parameter = Parameter;

package/dist/services/query-builder/query/prewarm.d.ts

@@ -0,0 +1,4 @@
+export declare class Prewarm {
+    readonly query: string;
+    constructor(app: string, whitelistedFilter: string, blacklistedFilter: string, parameterReplaceFilter: string);
+}

package/dist/services/query-builder/query/prewarm.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Prewarm = void 0;
+class Prewarm {
+    query;
+    constructor(app, whitelistedFilter, blacklistedFilter, parameterReplaceFilter) {
+        const now = new Date();
+        now.setDate(now.getDate() - 10);
+        const date = now.toISOString().split("T")[0];
+        this.query = `
+select url
+from (
+select regexp_replace(regexp_replace(${parameterReplaceFilter}, '(^[^&?]*)&','$1?'), '\\?$','') as url
+from live.rum.pi
+where app = '${app}'
+  and date >= '${date}'
+  and ${whitelistedFilter}
+  and ${blacklistedFilter})
+group by url
+order by count(*) desc`;
+    }
+}
+exports.Prewarm = Prewarm;

package/dist/services/query-builder/query-builder-factory.d.ts

@@ -0,0 +1,11 @@
+import { QueryBuilderService } from "./query-builder-service";
+import { QueryBuilderFactoryContext, QueryTpe } from "./query-builder-model";
+import { UserCliConfig } from "../../helpers/cli-config";
+export declare class QueryBuilderFactory {
+    private context;
+    private userConfig;
+    constructor(context: QueryBuilderFactoryContext, userConfig: UserCliConfig);
+    buildService(queryType: QueryTpe): Promise<QueryBuilderService>;
+    private getIntegrationFiles;
+    private getSpeedKitConfig;
+}

package/dist/services/query-builder/query-builder-factory.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryBuilderFactory = void 0;
+const query_builder_service_1 = require("./query-builder-service");
+const integration_api_1 = require("../integration-api");
+const files_1 = require("../../models/files");
+const get_parsed_config_1 = require("../../helpers/get-parsed-config");
+const cli_1 = require("../cli");
+const safe_1 = require("../../helpers/safe");
+const parse_config_speed_kit_error_1 = require("./error/parse-config-speed-kit-error");
+class QueryBuilderFactory {
+    context;
+    userConfig;
+    constructor(context, userConfig) {
+        this.context = context;
+        this.userConfig = userConfig;
+    }
+    async buildService(queryType) {
+        const cli = new cli_1.CliServiceFactory().getService();
+        const files = await this.getIntegrationFiles();
+        const app = files.getCustomerConfig().config.app;
+        const speedKitConfigFile = files.getByName(files_1.INTEGRATION_FILES.CONFIG.SPEED_KIT);
+        const speedKitConfig = this.getSpeedKitConfig(speedKitConfigFile.getContent());
+        const serviceContext = {
+            app,
+            queryType,
+            isWindows: this.context.isWindows,
+        };
+        return new query_builder_service_1.QueryBuilderService(serviceContext, speedKitConfig, cli);
+    }
+    async getIntegrationFiles() {
+        const integrationApiContext = new integration_api_1.IntegrationApiContext(this.context.customerPath, this.context.configName, ["config_SpeedKit"]);
+        const integrationApi = new integration_api_1.IntegrationApiFactory(integrationApiContext, this.userConfig).buildService();
+        return await integrationApi.run();
+    }
+    // todo create a customService to exchange parseSpeedKitConfig()
+    // this service then can also be used in: deploy/checks/pre-deploy
+    getSpeedKitConfig(fileContentString) {
+        const result = (0, safe_1.safe)(() => {
+            return (0, get_parsed_config_1.parseSpeedKitConfig)(fileContentString);
+        });
+        if (result.success !== true) {
+            throw new parse_config_speed_kit_error_1.ParseConfigSpeedKitError(result.error);
+        }
+        return result.data;
+    }
+}
+exports.QueryBuilderFactory = QueryBuilderFactory;

package/dist/services/query-builder/query-builder-model.d.ts

@@ -0,0 +1,20 @@
+export type QueryBuilderContext = {
+    isWindows?: boolean;
+    queryType: QueryTpe;
+    app: string;
+};
+export type QueryBuilderFactoryContext = {
+    readonly customerPath: string;
+    readonly configName: string;
+    readonly isWindows?: boolean;
+};
+export declare enum QueryTpe {
+    prewarm = "prewarm",
+    parameter = "parameter"
+}
+export type SpeedKitConfig = {
+    ruleSetConfig?: {
+        version?: string;
+    };
+    [key: string]: any;
+};

package/dist/services/query-builder/query-builder-model.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryTpe = void 0;
+var QueryTpe;
+(function (QueryTpe) {
+    QueryTpe["prewarm"] = "prewarm";
+    QueryTpe["parameter"] = "parameter";
+})(QueryTpe || (exports.QueryTpe = QueryTpe = {}));

package/dist/services/query-builder/query-builder-service.d.ts

@@ -0,0 +1,10 @@
+import { QueryBuilderContext, SpeedKitConfig } from "./query-builder-model";
+import { CliServiceInterface } from "../cli";
+export declare class QueryBuilderService {
+    private context;
+    private speedKitConfig;
+    private cli;
+    constructor(context: QueryBuilderContext, speedKitConfig: SpeedKitConfig, cli: CliServiceInterface);
+    run(): Promise<void>;
+    private buildQuery;
+}

package/dist/services/query-builder/query-builder-service.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryBuilderService = void 0;
+const tslib_1 = require("tslib");
+const get_parsed_config_1 = require("../../helpers/get-parsed-config");
+const build_query_helper_1 = require("../../helpers/build-query-helper");
+const clipboardy_cjs_1 = tslib_1.__importDefault(require("clipboardy-cjs"));
+const query_builder_model_1 = require("./query-builder-model");
+const prewarm_1 = require("./query/prewarm");
+const parameter_1 = require("./query/parameter");
+const cli_1 = require("../cli");
+class QueryBuilderService {
+    context;
+    speedKitConfig;
+    cli;
+    constructor(context, speedKitConfig, cli) {
+        this.context = context;
+        this.speedKitConfig = speedKitConfig;
+        this.cli = cli;
+    }
+    async run() {
+        this.cli.startAction(`build ${this.context.queryType}-query`);
+        const parameters = (0, build_query_helper_1.getStrippedParameters)(this.speedKitConfig);
+        const parameterReplaceFilter = (0, build_query_helper_1.getParameterReplaceFilter)(parameters, (0, get_parsed_config_1.getSpeedKitConfigVersion)(this.speedKitConfig));
+        const whitelistedFilter = (0, build_query_helper_1.getWhitelistedFilter)(this.speedKitConfig);
+        const blacklistedFilter = (0, build_query_helper_1.getBlacklistedFilter)(this.speedKitConfig);
+        const skConfigVersion = (0, get_parsed_config_1.getSpeedKitConfigVersion)(this.speedKitConfig);
+        const parameterFilter = (0, build_query_helper_1.getParameterFilter)(parameters, skConfigVersion);
+        const result = this.buildQuery(this.context.app, parameterFilter, whitelistedFilter, blacklistedFilter, parameterReplaceFilter);
+        this.cli.endAction(cli_1.CliActionStatus.COMPLETED);
+        if (!this.context.isWindows) {
+            clipboardy_cjs_1.default.writeSync(result);
+        }
+        this.cli.write(this.cli.style.dim.italic(result));
+        if (!this.context.isWindows) {
+            this.cli.writeSuccess("Result has been copied to the clipboard 📋");
+        }
+    }
+    buildQuery(app, parameterFilter, whitelistedFilter, blacklistedFilter, parameterReplaceFilter) {
+        if (this.context.queryType === query_builder_model_1.QueryTpe.prewarm) {
+            return new prewarm_1.Prewarm(app, whitelistedFilter, blacklistedFilter, parameterReplaceFilter).query;
+        }
+        if (this.context.queryType === query_builder_model_1.QueryTpe.parameter) {
+            return new parameter_1.Parameter(app, parameterFilter, whitelistedFilter, blacklistedFilter, parameterReplaceFilter).query;
+        }
+    }
+}
+exports.QueryBuilderService = QueryBuilderService;

package/oclif.manifest.json

@@ -107,28 +107,41 @@
           "multiple": false,
           "type": "option"
         },
-        "artifacts": {
-          "char": "a",
-          "description": "Whitelist of files to deploy",
-          "name": "artifacts",
+        "useTestConfig": {
+          "char": "t",
+          "description": "Override app with configured testApp",
+          "name": "useTestConfig",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "domain": {
+          "char": "d",
+          "description": "Startup domain (optional)",
+          "name": "domain",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "dryRun": {
-          "char": "d",
-          "description": "Do not deploy changes",
-          "name": "dryRun",
+        "local": {
+          "char": "l",
+          "description": "Run with local documentHandler",
+          "name": "local",
           "allowNo": false,
           "type": "boolean"
         },
-        "slackToken": {
-          "char": "t",
-          "description": "Slack hook found on 1Pass",
-          "name": "slackToken",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
+        "verboseLevel": {
+          "char": "v",
+          "description": "Show all messages",
+          "name": "verboseLevel",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "ignoreContentSecurityPolicy": {
+          "char": "s",
+          "description": "Removes header/meta \"content-security-policy\" for origin-responses",
+          "name": "ignoreContentSecurityPolicy",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -458,6 +471,13 @@
           "multiple": false,
           "type": "option"
         },
+        "useTestConfig": {
+          "char": "t",
+          "description": "Override app with configured testApp",
+          "name": "useTestConfig",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "domain": {
           "char": "d",
           "description": "Startup domain (optional)",
@@ -712,5 +732,5 @@
       ]
     }
   },
-  "version": "2.95.0"
+  "version": "3.0.0"
 }

package/package.json

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

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

@@ -1,62 +0,0 @@
-/**
- * Shop/Frontend system in use:
-{{#if isShopify}}
- * - Shopify
-{{else if isShopware}}
- * - Shopware
-{{else if isSalesforce}}
- * - Salesforce Commerce Cloud
-{{else if isOxid}}
-  * - OXID eShop
-{{else if isPlentymarkets}}
- * - Plentymarkets
-{{else}}
- * - TODO: enter name of system in use
-{{/if}}
- */
-
-const shared = {
-  app: "{{appName}}",
-  domain: "{{production.host}}",
-  origins: [
-    "https://{{production.host}}",
-  ],
-{{#if isShopify}}
-  shopifyId: "{{shopifyId}}", // Shopify specific
-  swPath: "/apps/speed-kit/sw.js", // Shopify specific
-{{else}}
-  swPath: "/wrapper-sw.js",
-{{/if}}
-{{#if subRouteScope}}
-  scope: "/{{subRouteScope}}/",
-{{else}}
-  scope: "/",
-{{/if}}
-};
-
-module.exports = {
-  test: {
-    ...shared,
-    app: process.env.TEST_APP,
-    name: shared.app,
-    forceInstall: true,
-  },
-{{#if staging.host}}
-  staging: {
-    ...shared,
-    name: "staging",
-    domain: "{{staging.host}}",
-    origins: [
-      "https://{{staging.host}}",
-    ],
-    forceInstall: {{staging.forceInstall}}, // use when our setup is not present yet
-    // bypassDeactivation: false, // comment out when SK deactivation should not be bypassed
-  },
-{{/if}}
-  production: {
-    ...shared,
-    name: "production",
-    forceInstall: {{production.forceInstall}}, // use when our setup is not present yet
-    // bypassDeactivation: false, // comment out when SK deactivation should not be bypassed
-  },
-};

package/dist/services/deploy/handler/module-modifier/deployment-detection-modifier.d.ts

@@ -1,9 +0,0 @@
-import RuntimeModifier from "../../interface/runtime-modifier";
-import { ModuleInterface } from "../../../integration-api/integration-api-model";
-export default class DeploymentDetectionModifier implements RuntimeModifier {
-    private readonly slackToken;
-    constructor(slackToken?: string);
-    canModify(file: ModuleInterface): boolean;
-    modify(file: ModuleInterface): void;
-    revert(file: ModuleInterface): void;
-}

package/dist/services/deploy/handler/module-modifier/deployment-detection-modifier.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const FILE = "deploymentDetection";
-const SLACK_TOKEN_PLACEHOLDER = "<1Password deployment token>";
-class DeploymentDetectionModifier {
-    slackToken;
-    constructor(slackToken) {
-        this.slackToken = slackToken;
-    }
-    canModify(file) {
-        return file.name === FILE;
-    }
-    modify(file) {
-        if (this.slackToken) {
-            file.setContent(file.getContent().replace(SLACK_TOKEN_PLACEHOLDER, this.slackToken));
-        }
-    }
-    revert(file) {
-        if (this.slackToken) {
-            file.setContent(file.getContent().replace(this.slackToken, SLACK_TOKEN_PLACEHOLDER));
-        }
-    }
-}
-exports.default = DeploymentDetectionModifier;