@speedkit/cli 2.47.0 → 2.48.0

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+# [2.48.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.47.1...v2.48.0) (2024-07-26)
+
+
+### Features
+
+* **config-wizard:** add support for scrapingbee ([c8fe5a1](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/c8fe5a1b45c06fc373cbf868ef6fb6204cadc0fc))
+* **config-wizard:** add support for scrapingbee ([1286550](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/1286550a41fd48a0effee9c4c8f5b424dc8cb864))
+* **config-wizard:** add support for scrapingbee ([f1a6ba3](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/f1a6ba3dcf42ee5715943e5c7a923464c81b77db))
+
+## [2.47.1](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.47.0...v2.47.1) (2024-07-24)
+
+
+### Bug Fixes
+
+* **diff-service:** resolve escaped spaces issue for macos ([1cf2d57](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/1cf2d577ab4ba15f3bd53394d95b2fa53e28fcd5))
+
 # [2.47.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.46.0...v2.47.0) (2024-07-24)
 
 

package/README.md

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

package/dist/helpers/normalize.d.ts

@@ -39,3 +39,9 @@ export declare function transformNoValueParameters(url: URL, manipulatedUrl: URL
  * @returns The normalized URL.
  */
 export declare function normalize(urlString: string, withParameterSorting: boolean): string;
+/**
+ * Remove backslashes before spaces from given string.
+ *
+ * @param string_
+ */
+export declare function unescapeSpaces(string_: string): string;

package/dist/helpers/normalize.js

@@ -4,6 +4,7 @@ exports.sortParameters = sortParameters;
 exports.convertNotEncodedParameters = convertNotEncodedParameters;
 exports.transformNoValueParameters = transformNoValueParameters;
 exports.normalize = normalize;
+exports.unescapeSpaces = unescapeSpaces;
 const node_url_1 = require("node:url");
 /**
  * Sorts all urls params manually.
@@ -113,3 +114,11 @@ function normalize(urlString, withParameterSorting) {
     transformNoValueParameters(new node_url_1.URL(urlString), url);
     return url.toString();
 }
+/**
+ * Remove backslashes before spaces from given string.
+ *
+ * @param string_
+ */
+function unescapeSpaces(string_) {
+    return string_.replaceAll("\\ ", " ");
+}

package/dist/models/os.d.ts

@@ -0,0 +1 @@
+export declare const DEFAULT_INTELLIJ_IDEA_PATH_MACOS = "/Applications/IntelliJ IDEA.app/Contents/MacOS";

package/dist/models/os.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_INTELLIJ_IDEA_PATH_MACOS = void 0;
+exports.DEFAULT_INTELLIJ_IDEA_PATH_MACOS = "/Applications/IntelliJ IDEA.app/Contents/MacOS";

package/dist/services/customer-config/customer-config-service-model.d.ts

@@ -32,6 +32,7 @@ export interface CustomerConfigSettings {
     shadowDomCustomElementPrefix?: string;
     activateRumTracking?: boolean;
     useGATracking?: boolean;
+    useScrapingBee?: boolean;
     withGoogleOptimize?: boolean;
     activateCfRocketLoaderWorkaround?: boolean;
     isShopify?: boolean;

package/dist/services/customer-config/customer-config-service.d.ts

@@ -24,5 +24,6 @@ export declare class CustomerConfigService {
     private downloadAndSaveFile;
     private getConfigSettings;
     handleDocumentHandler({ addPreRendering }: CustomerConfigSettings): Promise<void>;
+    logWarnings(configSettings: CustomerConfigSettings): Promise<void>;
     generateConfig(): Promise<void>;
 }

package/dist/services/customer-config/customer-config-service.js

@@ -161,7 +161,7 @@ class CustomerConfigService {
         }
     }
     async getConfigSettings() {
-        let { production, staging, subRouteScope, includeServiceWorker, activateImageOptimisation, removeLazyLoading, addPreRendering, supportShadowDomInPreRendering, shadowDomCustomElementPrefix, activateRumTracking, useGATracking, withGoogleOptimize, activateCfRocketLoaderWorkaround, isShopify, isShopware, isSalesforce, isPlentymarkets, shopifyId, } = {};
+        let { production, staging, subRouteScope, includeServiceWorker, activateImageOptimisation, removeLazyLoading, addPreRendering, supportShadowDomInPreRendering, shadowDomCustomElementPrefix, activateRumTracking, useGATracking, useScrapingBee, withGoogleOptimize, activateCfRocketLoaderWorkaround, isShopify, isShopware, isSalesforce, isPlentymarkets, shopifyId, } = {};
         this.appName = await this.cli.prompt(`Enter SK App Name:`, {
             validator: (input) => /^[\da-z]+(?:-[\da-z]+)*$/.test(input) ? "" : "No valid kebab-case",
             defaultAnswer: this.appName,
@@ -214,6 +214,7 @@ class CustomerConfigService {
                 shadowDomCustomElementPrefix = await this.cli.prompt("Please specify the prefix of the custom elements used (e.g. o2 uses tef-): ", { defaultAnswer: "custom-" });
             }
         }
+        useScrapingBee = await this.cli.confirm("Do customer responses differ geo-location-based (ScrapingBee will be needed to fetch documents)?", false);
         activateRumTracking = await this.cli.confirm("Activate RUM Tracking?");
         if (activateRumTracking && !isShopify) {
             useGATracking = await this.cli.confirm("Add Tracking based on Google Analytics' DataLayer?");
@@ -235,6 +236,7 @@ class CustomerConfigService {
             shadowDomCustomElementPrefix,
             activateRumTracking,
             useGATracking,
+            useScrapingBee,
             withGoogleOptimize,
             activateCfRocketLoaderWorkaround,
             isShopify,
@@ -269,6 +271,16 @@ class CustomerConfigService {
     `);
         }
     }
+    async logWarnings(configSettings) {
+        if (configSettings.useScrapingBee) {
+            this.cli.writeWarning(`
+      ⚠️ MANUAL ACTION NEEDED ⚠️
+
+      Remember to set it up the variation in the orestes config.
+      See more info here: https://www.notion.so/baqend/How-to-use-Scraping-Bee-in-the-orestes-config-b94d8571e1a04c9e8310810df55a9a62
+    `);
+        }
+    }
     async generateConfig() {
         this.cli.write("\nLet's generate a config...\n");
         const configSettings = await this.getConfigSettings();
@@ -278,6 +290,7 @@ class CustomerConfigService {
         }
         await this.compileHandlebarsFiles(configSettings);
         await this.handleDocumentHandler(configSettings);
+        await this.logWarnings(configSettings);
         this.cli.writeSuccess("\nConfig generation completed 👏\n");
     }
 }

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

@@ -74,6 +74,18 @@
     split: CURRENT_HOST_CONFIG.split,
     splitTestId: CURRENT_HOST_CONFIG.splitTestId,
     disabled: !CURRENT_HOST_CONFIG.enabled{{#if addPreRendering}} || isTablet(){{/if}},
+{{#if useScrapingBee}}
+    customVariation: [
+      {
+        variationFunction: function (request, device, cookies) {
+          if (device === "desktop") {
+            return "proxycrawl";
+          }
+          return "proxycrawlmobile";
+        },
+      },
+    ],
+{{/if}}
     enabledSites: [
       {
         pathname: [

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

@@ -56,6 +56,13 @@ const config = {
       return `Tablet viewport is unsupported: ${url}`;
     }
 
+    {{/if}}
+    {{#if useScrapingBee}}
+      // dynamically blacklist not 200 status codes from ScrapingBee
+      const spbStatusCode = headers["Spb-initial-status-code"];
+      if (spbStatusCode && spbStatusCode !== "200") {
+        return `initial status code unequal to 200 received from scrapingbee: ${url} ${spbStatusCode}`;
+      }
     {{/if}}
     return false;
   },

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

@@ -6,6 +6,8 @@ const node_path_1 = tslib_1.__importDefault(require("node:path"));
 const promises_1 = tslib_1.__importStar(require("node:fs/promises"));
 const node_child_process_1 = require("node:child_process");
 const file_helper_1 = require("../../helpers/file-helper");
+const normalize_1 = require("../../helpers/normalize");
+const os_1 = require("../../models/os");
 class DiffService {
     cli;
     diffExecutablePath;
@@ -113,10 +115,11 @@ class DiffService {
             }
             return false;
         }
-        const isWindows = process.platform.startsWith("win");
         let ideaCommandAvailable;
         try {
-            (0, node_child_process_1.execSync)(`idea diff "${localPath}" "${remotePath}"`);
+            (0, node_child_process_1.execSync)(`idea diff "${localPath}" "${remotePath}"`, {
+                stdio: ["pipe", "ignore", "pipe"], // prevent output of "/bin/sh: idea: command not found"
+            });
             ideaCommandAvailable = true;
         }
         catch {
@@ -124,17 +127,20 @@ class DiffService {
         }
         try {
             if (!ideaCommandAvailable) {
+                const isWindows = process.platform.startsWith("win");
                 if (isWindows) {
                     (0, node_child_process_1.execSync)(`"%IDEA_INITIAL_DIRECTORY%\\idea" diff ${localPath} ${remotePath}`, { stdio: "pipe" });
                 }
                 else {
-                    (0, node_child_process_1.execSync)(`"$IDEA_INITIAL_DIRECTORY/idea" diff ${localPath} ${remotePath}`, { stdio: "pipe" });
+                    const ideaInitialDirectory = (0, normalize_1.unescapeSpaces)(process.env.IDEA_INITIAL_DIRECTORY ||
+                        os_1.DEFAULT_INTELLIJ_IDEA_PATH_MACOS);
+                    (0, node_child_process_1.execSync)(`"${ideaInitialDirectory}/idea" diff ${localPath} ${remotePath}`, { stdio: "pipe" });
                 }
             }
             return false;
         }
         catch (error) {
-            this.cli.writeError(`Error executing diff command: ${error.message}`);
+            this.cli.writeError(`Error executing diff command: ${error.message} (diff/diff-service)`);
             return false;
         }
     }

package/dist/services/diff-service.js

@@ -6,6 +6,8 @@ const fs = tslib_1.__importStar(require("node:fs/promises"));
 const node_child_process_1 = require("node:child_process");
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
 const file_helper_1 = require("../helpers/file-helper");
+const normalize_1 = require("../helpers/normalize");
+const os_1 = require("../models/os");
 /**
  * @deprecated
  */
@@ -86,10 +88,11 @@ class DiffService {
         else if (hide) {
             return true;
         }
-        const isWindows = process.platform.startsWith("win");
         let ideaCommandAvailable;
         try {
-            (0, node_child_process_1.execSync)(`idea diff "${filePath1}" "${filePath2}"`, { stdio: "pipe" });
+            (0, node_child_process_1.execSync)(`idea diff "${filePath1}" "${filePath2}"`, {
+                stdio: ["pipe", "ignore", "pipe"], // prevent output of "/bin/sh: idea: command not found"
+            });
             ideaCommandAvailable = true;
         }
         catch {
@@ -97,16 +100,19 @@ class DiffService {
         }
         try {
             if (!ideaCommandAvailable) {
+                const isWindows = process.platform.startsWith("win");
                 if (isWindows) {
                     (0, node_child_process_1.execSync)(`"%IDEA_INITIAL_DIRECTORY%\\idea" diff ${filePath1} ${filePath2}`, { stdio: "pipe" });
                 }
                 else {
-                    (0, node_child_process_1.execSync)(`"$IDEA_INITIAL_DIRECTORY/idea" diff ${filePath1} ${filePath2}`, { stdio: "pipe" });
+                    const ideaInitialDirectory = (0, normalize_1.unescapeSpaces)(process.env.IDEA_INITIAL_DIRECTORY ||
+                        os_1.DEFAULT_INTELLIJ_IDEA_PATH_MACOS);
+                    (0, node_child_process_1.execSync)(`"${ideaInitialDirectory}/idea" diff ${filePath1} ${filePath2}`, { stdio: "pipe" });
                 }
             }
         }
         catch (error) {
-            this.cli.writeError(`Error executing diff command: ${error.message}`);
+            this.cli.writeError(`Error executing diff command: ${error.message} (services/diff-service)`);
             this.cli.exit(1);
         }
         return true;

package/oclif.manifest.json

@@ -712,5 +712,5 @@
       ]
     }
   },
-  "version": "2.47.0"
+  "version": "2.48.0"
 }

package/package.json

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