@speedkit/cli 2.60.0 → 2.61.0

package/CHANGELOG.md

@@ -1,3 +1,14 @@
+# [2.61.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.60.0...v2.61.0) (2024-10-18)
+
+
+### Features
+
+* **customer-config:** add predictive preload package as default load handler feature ([9196dee](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/9196dee51d601c486ff8fc71d8c2b9c43f24817d))
+* **customer-config:** update predictive preload package usage ([598824e](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/598824e93e12b4e474a60ef26f4cc1c997a5c8d7))
+* **diff:** exchange tryCatch with safeMethod ([2cf32bc](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/2cf32bc4a4686153e29e8211ff97b65dd27742c1))
+* **diffing:** add custom diffEndpoint for integrationDevtools ([b5b9b9e](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/b5b9b9e9ccb8bc1244551eb95d619fce4614c189))
+* **diffing:** diffing show error case if remote fetch failed ([6447d53](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/6447d5325057d59559f85833c4e1332460e85c92))
+
 # [2.60.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.59.0...v2.60.0) (2024-10-14)
 
 

package/README.md

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

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

@@ -6,6 +6,8 @@ import { HistoryApiPlugin } from 'rum/HistoryApiPlugin';
 import { GAEcommerceTrackingPlugin } from 'rum/GAEcommerceTrackingPlugin';
 {{/if}}
 
+import { PredictivePreloading } from 'predictive-preloading/predictivePreloading';
+
 !function() {
   if (window !== window.top) {
     return;
@@ -562,4 +564,8 @@ import { GAEcommerceTrackingPlugin } from 'rum/GAEcommerceTrackingPlugin';
     });
   }
 {{/if}}
+
+  new PredictivePreloading({
+    // TODO: configure according to the needs of the customer
+  });
 }();

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

@@ -0,0 +1,10 @@
+import { DiffService } from "../../diff";
+import { DocumentHandlerServer } from "../../document-handler-runtime/document-handler-server";
+import { Crawler } from "../virtual-orestes-app/crawler";
+export declare class DiffAgainstCurrentPage {
+    private diffService;
+    private documentHandlerRuntime;
+    private crawler;
+    constructor(diffService: DiffService, documentHandlerRuntime: DocumentHandlerServer, crawler: Crawler);
+    postDiff(currentHtml: string, currentUrl: string, variant?: string, transform?: boolean): Promise<boolean>;
+}

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

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DiffAgainstCurrentPage = void 0;
+class DiffAgainstCurrentPage {
+    diffService;
+    documentHandlerRuntime;
+    crawler;
+    constructor(diffService, documentHandlerRuntime, crawler) {
+        this.diffService = diffService;
+        this.documentHandlerRuntime = documentHandlerRuntime;
+        this.crawler = crawler;
+    }
+    async postDiff(currentHtml, currentUrl, variant = "DEFAULT", transform = false) {
+        const originResponse = await this.crawler.fetchRemote(currentUrl, variant.toUpperCase());
+        let originHtml = await originResponse?.text();
+        if (!originHtml) {
+            throw new Error("Could not fetch remote page");
+        }
+        if (transform) {
+            // todo check if the currentHTML is already transformed
+            const currentDocumentHandlerResponse = await this.documentHandlerRuntime.transform(currentHtml, variant, currentUrl, {});
+            currentHtml = currentDocumentHandlerResponse.body;
+            const originDocumentHandlerResponse = await this.documentHandlerRuntime.transform(originHtml, variant, currentUrl, {});
+            originHtml = originDocumentHandlerResponse.body;
+        }
+        const remoteFilePath = await this.diffService.writeContentToTemporalFile(`remote-${variant}`, originHtml);
+        const localFilePath = await this.diffService.writeContentToTemporalFile("current", currentHtml);
+        return await this.diffService.executeDiff(localFilePath, remoteFilePath);
+    }
+}
+exports.DiffAgainstCurrentPage = DiffAgainstCurrentPage;

package/dist/services/onboarding/dashboard/index.d.ts

@@ -5,14 +5,16 @@ import { CustomerConfig } from "../../integration-api";
 import { RequestDiffService } from "./request-diff-service";
 import { Cache } from "../request-cache/cache";
 import { AthenaService } from "../../athena";
+import { DiffAgainstCurrentPage } from "./diff-against-current-page";
 export declare class Dashboard {
     private customerConfig;
     private parameterQueryBuilder;
     private athenaClient;
     private requestDiffService;
+    private currentPageDiff;
     private cache;
     private athenaLastResult;
-    constructor(customerConfig: CustomerConfig, parameterQueryBuilder: ParameterQueryBuilder, athenaClient: AthenaService, requestDiffService: RequestDiffService, cache: Cache);
+    constructor(customerConfig: CustomerConfig, parameterQueryBuilder: ParameterQueryBuilder, athenaClient: AthenaService, requestDiffService: RequestDiffService, currentPageDiff: DiffAgainstCurrentPage, cache: Cache);
     getResponse(request: Protocol.Network.Request): Promise<BaqendResponse>;
     private createBaqendResponse;
 }

package/dist/services/onboarding/dashboard/index.js

@@ -10,13 +10,15 @@ class Dashboard {
     parameterQueryBuilder;
     athenaClient;
     requestDiffService;
+    currentPageDiff;
     cache;
     athenaLastResult = null;
-    constructor(customerConfig, parameterQueryBuilder, athenaClient, requestDiffService, cache) {
+    constructor(customerConfig, parameterQueryBuilder, athenaClient, requestDiffService, currentPageDiff, cache) {
         this.customerConfig = customerConfig;
         this.parameterQueryBuilder = parameterQueryBuilder;
         this.athenaClient = athenaClient;
         this.requestDiffService = requestDiffService;
+        this.currentPageDiff = currentPageDiff;
         this.cache = cache;
     }
     async getResponse(request) {
@@ -69,6 +71,19 @@ class Dashboard {
             const data = JSON.parse(postData);
             return this.requestDiffService.postDiff(requestOrigin, data.url, data.paramKeys, data.autoDiff);
         }
+        if (url.pathname.startsWith("/variant-diff")) {
+            const postData = request.postData;
+            const data = JSON.parse(postData);
+            const currentHtml = data.currentHtml;
+            const currentUrl = data.currentUrl;
+            const variant = data.variant || "DEFAULT";
+            const transform = data.transform || false;
+            const diffResult = await (0, safe_1.safe)(this.currentPageDiff.postDiff(currentHtml, currentUrl, variant, transform));
+            if (diffResult.success === true) {
+                return this.createBaqendResponse(requestOrigin, JSON.stringify({ success: true }), "application/json; charset=UTF-8", [], 200);
+            }
+            return this.createBaqendResponse(requestOrigin, JSON.stringify({ success: false, error: diffResult.error }), "application/json; charset=UTF-8", [], 500);
+        }
         if (url.pathname.startsWith("/cache/get")) {
             const response = [];
             for (const [url, baqendResponse] of this.cache.getAll()) {

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

@@ -40,6 +40,7 @@ const config_api_1 = require("../config-api");
 const fs = tslib_1.__importStar(require("node:fs"));
 const path = tslib_1.__importStar(require("node:path"));
 const static_recipe_1 = require("../integration-api/virtual/static-recipe");
+const diff_against_current_page_1 = require("./dashboard/diff-against-current-page");
 class OnboardingServiceFactory {
     context;
     cliConfig;
@@ -113,6 +114,7 @@ class OnboardingServiceFactory {
     async getFetchEventHandler(files, customerConfig, documentHandler, cache, cli, browserContext, athenaClient) {
         const configApi = this.getConfigApi(customerConfig.app);
         const serverConfig = await this.getSpeedKitServerConfig(configApi, cli);
+        const crawler = new crawler_1.Crawler(cli, serverConfig);
         const parameterQueryBuilder = new parameter_query_builder_1.ParameterQueryBuilder(customerConfig, files.getByName(files_1.INTEGRATION_FILES.CONFIG.SPEED_KIT));
         const DiffService = new diff_1.DiffServiceFactory(new diff_1.DiffContext(this.cliConfig.diffExec, this.cliConfig.diffExecTemplate)).getService();
         const requestDiffService = new request_diff_service_1.RequestDiffService(DiffService, documentHandler);
@@ -124,12 +126,11 @@ class OnboardingServiceFactory {
             new speed_kit_service_worker_js_1.SpeedKitServiceWorkerJs(customerConfig, files.getByName(files_1.INTEGRATION_FILES.CUSTOM.SW)),
         ];
         if (this.context.local) {
-            const crawler = new crawler_1.Crawler(cli, serverConfig);
             const orestesApp = new virtual_orestes_app_1.VirtualOrestesApp(customerConfig, crawler, documentHandler, cache, cli);
             handlers.push(new speed_kit_asset_request_1.SpeedKitAssetRequest(customerConfig, orestesApp), new speed_kit_rum_pi_request_1.SpeedKitRumPiRequest(customerConfig, cache, cli));
         }
         if (athenaClient) {
-            handlers.push(new dashboard_request_1.DashboardRequest(new dashboard_1.Dashboard(customerConfig, parameterQueryBuilder, athenaClient, requestDiffService, cache)));
+            handlers.push(new dashboard_request_1.DashboardRequest(new dashboard_1.Dashboard(customerConfig, parameterQueryBuilder, athenaClient, requestDiffService, new diff_against_current_page_1.DiffAgainstCurrentPage(DiffService, documentHandler, crawler), cache)));
         }
         return new fetch_event_handler_1.FetchEventHandler(handlers, customerConfig, cli, configApi);
     }

package/oclif.manifest.json

@@ -712,5 +712,5 @@
       ]
     }
   },
-  "version": "2.60.0"
+  "version": "2.61.0"
 }

package/package.json

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