@speedkit/cli 2.67.0 → 2.69.0

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+# [2.69.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.68.0...v2.69.0) (2024-12-11)
+
+
+### Bug Fixes
+
+* createProfileFolder if not exists ([e820a45](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/e820a45f6c4398b646f609c6d072d8d7775e4ac9))
+
+
+### Features
+
+* create dynamic browserProfile from last session ([cce0f99](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/cce0f995fb6ee8d9c84818d93ef1db50a6bd7820))
+* **diff:** add .html-extension so idea can have syntaxHighlighting ([748bc25](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/748bc2541a7d6b6a521b2eecf8e22666aefe68b4))
+* load last browserConfig and create a fresh profile with it ([878a420](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/878a42027b15a43d59f438bc34a88f8b10a652e6))
+* **onboarding:** filter unwanted configKeys from previous configs ([b3f08a0](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/b3f08a09d05fe6689fd826a03e5702559c5c6a68))
+
+# [2.68.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.67.0...v2.68.0) (2024-12-11)
+
+
+### Bug Fixes
+
+* do not set forceInstall to true by default ([4cd7138](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/4cd7138e2deb44a8a33920c3fa888a77401dcd2c))
+
+
+### Features
+
+* **onboarding:** add current DBToken to local docHandlerRuntime ([bd7d164](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/bd7d16420dd3bab22f76d34878ddfdfc2a0edc03))
+* **wizard:** remove custom doc-handler creation on lambda server-side rendering usage ([a4f5bff](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/a4f5bff6591e376a089c6f9acb70239fce133eac))
+
 # [2.67.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.66.0...v2.67.0) (2024-12-10)
 
 

package/README.md

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

package/dist/helpers/cli-config.d.ts

@@ -8,6 +8,7 @@ export type UserCliConfig = {
     ideaDirectory: string;
     slackToken: string;
     testApp: string;
+    tempFolder: string;
 };
 export declare class CliConfig {
     private config;

package/dist/helpers/cli-config.js

@@ -28,6 +28,7 @@ class CliConfig {
         ideaDirectory: "",
         slackToken: "",
         testApp: "",
+        tempFolder: "/tmp",
     };
     constructor(config) {
         this.config = config;
@@ -38,6 +39,7 @@ class CliConfig {
         // override config from environment
         this.loadConfigFromEnvironment();
         this.resolveExtensionConfigPaths();
+        this.userCliConfig.tempFolder = this.config.cacheDir;
         return this.userCliConfig;
     }
     createEmptyConfigFile() {

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

@@ -23,7 +23,6 @@ export declare class CustomerConfigService {
     private shouldFileBeOverwritten;
     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

@@ -207,7 +207,7 @@ class CustomerConfigService {
         }
         activateImageOptimisation = await this.cli.confirm("Activate Image Optimisation?", false);
         removeLazyLoading = await this.cli.confirm("Remove Lazy-Loading?");
-        if (await this.cli.confirm("Add Pre-Rendering? This requires a set-up Lambda function to work. Also requires a DOM-based DocumentHandler.", false)) {
+        if (await this.cli.confirm("Add Pre-Rendering? This requires a set-up Lambda function to work. Also requires usage of the DOM-based DocumentHandler.", false)) {
             addPreRendering = true;
             if (await this.cli.confirm("Does the customer utilize Shadow DOMs? If so additional handling for this will be added.", false)) {
                 supportShadowDomInPreRendering = true;
@@ -250,31 +250,6 @@ class CustomerConfigService {
             shopifyId,
         };
     }
-    async handleDocumentHandler({ addPreRendering }) {
-        /*
-          TODO:
-           remove this custom DocumentHandler handling as soon as the DOM-parsing DocumentHandler has been released
-           and can be controlled/activated by the DocumentHandler Config properly
-         */
-        if (addPreRendering) {
-            const documentHandlerBranchName = "dom-parser/develop";
-            const customDocumentHandlerOutputPath = path.join(this.outputDirPath, "custom_documentHandler.js");
-            this.cli.writeWarning(`
-      ⚠️ MANUAL ACTION NEEDED ⚠️
-
-      Your config needs the DOM-parsing DocumentHandler which has not been publicly released yet.
-
-      Working Branch: ${this.cli.codeStyle(documentHandlerBranchName)} (https://gitlab.orestes.info/baqend/document-handler/-/tree/${documentHandlerBranchName})
-
-      Please add it to your newly created config directory manually:
-
-      1. ${this.cli.codeStyle(`git clone -b ${documentHandlerBranchName} git@vm.orestes.info:baqend/document-handler.git`)}
-      2. ${this.cli.codeStyle(`cd ./document-handler`)}
-      3. ${this.cli.codeStyle(`npm ci && npm run build`)}
-      4. ${this.cli.codeStyle(`cp ./dist/DocumentHandler.js ${customDocumentHandlerOutputPath}`)}
-    `);
-        }
-    }
     async logWarnings(configSettings) {
         if (configSettings.useScrapingBee) {
             this.cli.writeWarning(`
@@ -293,7 +268,6 @@ class CustomerConfigService {
             this.templates.push("downtimeDetection.js.hbs");
         }
         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_documentHandler.js.hbs

@@ -172,7 +172,7 @@ const config = {
   {{/unless}}
 }
 
-const documentHandler = new DocumentHandler({
+const documentHandler = new {{#if addPreRendering}}DomDocumentHandler{{else}}DocumentHandler{{/if}}({
   ...config,
   app: APP,
   dynamicFetcher: DYNAMIC_FETCHER,

package/dist/services/document-handler-runtime/document-handler-server.d.ts

@@ -1,6 +1,7 @@
 import { BundleService } from "../bundler";
 import { CliService } from "../cli";
 import { CustomerConfig, FileListInterface } from "../integration-api";
+import { EntityManager } from "baqend";
 import { DocumentHandlerResponse } from "./server/document-handler-response";
 export declare class DocumentHandlerServer {
     private customerConfig;
@@ -8,10 +9,11 @@ export declare class DocumentHandlerServer {
     private bundler;
     private cli;
     private verboseLevel;
+    private entityManager?;
     private documentHandlerCode;
     private documentHandlerConfigCode;
     private database;
-    constructor(customerConfig: CustomerConfig, files: FileListInterface, bundler: BundleService, cli: CliService, verboseLevel?: boolean);
+    constructor(customerConfig: CustomerConfig, files: FileListInterface, bundler: BundleService, cli: CliService, verboseLevel?: boolean, entityManager?: EntityManager);
     transform(html: string, variation: string, url: string, headers: {
         [name: string]: string;
     }): Promise<DocumentHandlerResponse>;

package/dist/services/document-handler-runtime/document-handler-server.js

@@ -21,15 +21,17 @@ class DocumentHandlerServer {
     bundler;
     cli;
     verboseLevel;
+    entityManager;
     documentHandlerCode;
     documentHandlerConfigCode;
     database;
-    constructor(customerConfig, files, bundler, cli, verboseLevel = false) {
+    constructor(customerConfig, files, bundler, cli, verboseLevel = false, entityManager) {
         this.customerConfig = customerConfig;
         this.files = files;
         this.bundler = bundler;
         this.cli = cli;
         this.verboseLevel = verboseLevel;
+        this.entityManager = entityManager;
     }
     async transform(html, variation, url, headers) {
         if (!this.documentHandlerCode) {
@@ -160,6 +162,9 @@ class DocumentHandlerServer {
             const vmContext = { console: vmConsole, module: { exports: {} } };
             vm.runInNewContext(databaseCode, vmContext);
             this.database = vmContext.module.exports;
+            if (this.entityManager) {
+                this.database.token = this.entityManager.token;
+            }
         }
         return this.database;
     }

package/dist/services/document-handler-runtime/factory/document-handler-runtime-service-factory.js

@@ -8,6 +8,8 @@ const cli_1 = require("../../cli");
 const required_file_not_found_error_1 = tslib_1.__importDefault(require("../error/required-file-not-found-error"));
 const document_handler_server_1 = require("../document-handler-server");
 const bundler_1 = require("../../bundler");
+const entity_manager_factory_1 = require("../../config-api/entity-manager-factory");
+const safe_1 = require("../../../helpers/safe");
 class DocumentHandlerRuntimeServiceFactory {
     context;
     cliConfig;
@@ -35,7 +37,8 @@ class DocumentHandlerRuntimeServiceFactory {
         const customerConfig = this.getCustomerConfig(files);
         const bundler = new bundler_1.BundleServiceFactory().buildService();
         const cliService = new cli_1.CliServiceFactory().getService();
-        return new document_handler_server_1.DocumentHandlerServer(customerConfig, files, bundler, cliService, this.context.verboseLevel);
+        const entityManagerResult = await (0, safe_1.safe)(new entity_manager_factory_1.EntityManagerFactory().getEntityManager(customerConfig.app));
+        return new document_handler_server_1.DocumentHandlerServer(customerConfig, files, bundler, cliService, this.context.verboseLevel, entityManagerResult.success ? entityManagerResult.data : null);
     }
     prepareIntegrationApi() {
         const integrationApiContext = new integration_api_1.IntegrationApiContext(this.context.customerPath, this.context.configName, this.context.fileDependencies, [".git", ".idea", "node_modules"]);

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

@@ -33,7 +33,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(), 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 || {});
+            `https://${app}.app.baqend.com/v1/speedkit/install.js?d=${name || configName}`, installParams || 'async="" crossorigin="anonymous"', name, forceInstall || false, chromeFlags, dependencies || {});
     }
 }
 exports.CustomerConfig = CustomerConfig;

package/dist/services/onboarding/browser/config/browser-config.d.ts

@@ -0,0 +1,27 @@
+import { UserCliConfig } from "../../../../helpers/cli-config";
+/**
+ * this class makes sure you always start skOnboarding with a fresh browser,
+ * but still keep your window/devtools-configuration
+ */
+export declare class BrowserConfig {
+    private userConfig;
+    constructor(userConfig: UserCliConfig);
+    /**
+     * create a new temporary profileFolder
+     * load browserConfigJsonFile from last profileFolder
+     * delete older profiles
+     */
+    loadProfileTempDir(): string;
+    /**
+     * load latest browserConfig and put it into newly created profilePath
+     */
+    private createProfileDirWithLatestConfig;
+    private sortFoldersByDate;
+    /**
+     * remove keys we don't need
+     *
+     * @param configString
+     * @private
+     */
+    private cleanUpLastConfig;
+}

package/dist/services/onboarding/browser/config/browser-config.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrowserConfig = void 0;
+const tslib_1 = require("tslib");
+const node_path_1 = tslib_1.__importDefault(require("node:path"));
+const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
+const chromeProfilesParentFolder = "chrome_profile";
+const keysToRemove = new Set([
+    "sessions",
+    "extensions",
+    "in_product_help",
+    "history_clusters",
+    "media",
+    "profile",
+    "protection",
+]);
+/**
+ * this class makes sure you always start skOnboarding with a fresh browser,
+ * but still keep your window/devtools-configuration
+ */
+class BrowserConfig {
+    userConfig;
+    constructor(userConfig) {
+        this.userConfig = userConfig;
+    }
+    /**
+     * create a new temporary profileFolder
+     * load browserConfigJsonFile from last profileFolder
+     * delete older profiles
+     */
+    loadProfileTempDir() {
+        const chromeProfilePath = node_path_1.default.resolve(this.userConfig.tempFolder, chromeProfilesParentFolder, String(Date.now()));
+        const chromeProfilesParentFolderPath = node_path_1.default.resolve(this.userConfig.tempFolder, chromeProfilesParentFolder);
+        // create parentFolder if not exists
+        if (!node_fs_1.default.existsSync(chromeProfilesParentFolderPath)) {
+            node_fs_1.default.mkdirSync(chromeProfilesParentFolderPath, { recursive: true });
+        }
+        // load older profiles
+        const chromeProfileFolders = node_fs_1.default.readdirSync(chromeProfilesParentFolderPath);
+        if (!chromeProfileFolders || chromeProfileFolders.length === 0) {
+            return chromeProfilePath;
+        }
+        const sortedFolders = this.sortFoldersByDate(chromeProfileFolders);
+        this.createProfileDirWithLatestConfig(sortedFolders, chromeProfilesParentFolderPath, chromeProfilePath);
+        return chromeProfilePath;
+    }
+    /**
+     * load latest browserConfig and put it into newly created profilePath
+     */
+    createProfileDirWithLatestConfig(sortedFolders, chromeTemporaryFolderPath, chromeProfilePath) {
+        let foundLatestFolder = false;
+        for (const folderName of sortedFolders) {
+            const preferencesPath = node_path_1.default.resolve(chromeTemporaryFolderPath, folderName, "Default", "Preferences");
+            // look for chrome preferences in latest profileFolder
+            // delete folders not containing any profiles
+            // delete all older folders after we found latest profile
+            if (!node_fs_1.default.existsSync(preferencesPath) || foundLatestFolder) {
+                node_fs_1.default.rmSync(node_path_1.default.resolve(chromeTemporaryFolderPath, folderName), {
+                    recursive: true,
+                    force: true,
+                });
+                continue;
+            }
+            // return latest found config
+            const lastConfigString = this.cleanUpLastConfig(node_fs_1.default.readFileSync(preferencesPath, "utf8"));
+            node_fs_1.default.mkdirSync(node_path_1.default.resolve(chromeProfilePath, "Default"), {
+                recursive: true,
+            });
+            node_fs_1.default.writeFileSync(node_path_1.default.resolve(chromeProfilePath, "Default", "Preferences"), lastConfigString, { encoding: "utf-8" });
+            // after adding latest profile to new profile
+            // delete folder where we got the latest config from
+            node_fs_1.default.rmSync(node_path_1.default.resolve(chromeTemporaryFolderPath, folderName), {
+                recursive: true,
+                force: true,
+            });
+            foundLatestFolder = true;
+        }
+    }
+    sortFoldersByDate(chromeProfileFolders) {
+        return chromeProfileFolders.sort((a, b) => {
+            return Number.parseInt(b) - Number.parseInt(a);
+        });
+    }
+    /**
+     * remove keys we don't need
+     *
+     * @param configString
+     * @private
+     */
+    cleanUpLastConfig(configString) {
+        const config = JSON.parse(configString);
+        const newConfig = {};
+        for (const key in config) {
+            if (keysToRemove.has(key)) {
+                continue;
+            }
+            newConfig[key] = config[key];
+        }
+        return JSON.stringify(newConfig);
+    }
+}
+exports.BrowserConfig = BrowserConfig;

package/dist/services/onboarding/dashboard/diff-against-current-page.js

@@ -32,8 +32,8 @@ class DiffAgainstCurrentPage {
             originHtml = originDocumentHandlerResponse.body;
         }
         this.cli.endAction(cli_1.CliActionStatus.COMPLETED);
-        const remoteFilePath = await this.diffService.writeContentToTemporalFile(`remote-${variant}`, originHtml);
-        const localFilePath = await this.diffService.writeContentToTemporalFile("current", currentHtml);
+        const remoteFilePath = await this.diffService.writeContentToTemporalFile(`remote-${variant}.html`, originHtml);
+        const localFilePath = await this.diffService.writeContentToTemporalFile("current.html", currentHtml);
         return await this.diffService.executeDiff(localFilePath, remoteFilePath);
     }
 }

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SpeedKitInstallRegex = exports.USER_AGENT = exports.OnboardingContext = exports.BrowserContext = exports.CDP_SESSION = exports.BROWSER_EVENTS = void 0;
 const core_1 = require("@oclif/core");
 const cli_parameters_1 = require("../../models/cli-parameters");
+const browser_config_1 = require("./browser/config/browser-config");
 const DEFAULT_BROWSER_ARGS = [
     "--enable-features=Translate,NetworkService",
     "--no-first-run",
@@ -57,6 +58,11 @@ class BrowserContext {
         if (userConfig?.chromeUserProfilePath) {
             browserArguments.push(`--user-data-dir=${userConfig?.chromeUserProfilePath}`);
         }
+        else {
+            const browserConfig = new browser_config_1.BrowserConfig(this.userConfig);
+            const temporaryProfileDirectory = browserConfig.loadProfileTempDir();
+            browserArguments.push(`--user-data-dir=${temporaryProfileDirectory}`);
+        }
         this.browserArgs = [
             ...browserArguments,
             `--unsafely-treat-insecure-origin-as-secure=${domain}`,

package/oclif.manifest.json

@@ -712,5 +712,5 @@
       ]
     }
   },
-  "version": "2.67.0"
+  "version": "2.69.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@speedkit/cli",
   "description": "Speed Kit CLI",
-  "version": "2.67.0",
+  "version": "2.69.0",
   "author": {
     "name": "Baqend.com",
     "email": "info@baqend.com"
@@ -92,9 +92,7 @@
     "parse5": "7.1",
     "parse5-htmlparser2-tree-adapter": "7.0.0",
     "puppeteer": "^22.6.5",
-    "puppeteer-core": "^22.6.5",
     "puppeteer-extra": "^3.3.6",
-    "puppeteer-extra-plugin-user-preferences": "^2.4.1",
     "strip-comments": "^2.0.1",
     "uuid": "^9.0.1",
     "esbuild": "^0.20.2",