@speedkit/cli 4.20.5 → 4.22.0

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

@@ -1,391 +0,0 @@
-import { BaseBundle } from 'rum/BaseBundle';
-{{#if hasSoftNavigations}}
-import { SpaBundle } from 'rum/SpaBundle';
-{{/if}}
-
-{{#if useGATracking}}
-import { GAEcommerceTrackingPlugin } from 'rum/GAEcommerceTrackingPlugin';
-{{/if}}
-import { ClickPlugin } from "rum/ClickPlugin";
-import { HostTrackingPlugin } from "rum/HostTrackingPlugin";
-{{#if isPOV}}
-import { UserFrictionPlugin } from "rum/UserFrictionPlugin";
-{{/if}}
-
-import { PredictivePreloading } from 'predictive-preloading/predictivePreloading';
-
-!function() {
-  if (window !== window.top) {
-    return;
-  }
-{{#if isOxid}}
-
-  var pageTypeSent = false;
-{{/if}}
-
-  var defaultCurrency = 'EUR'; // TODO: verify default currency
-
-  window.SpeedKit = window.SpeedKit || {};
-  SpeedKit.rumPlugins = SpeedKit.rumPlugins || [];
-  SpeedKit.rumPlugins.push(
-    new BaseBundle({{#if isPOV}}
-      {
-        resourceTimingsOptions: {
-          rules: [
-            // TODO: check if this is the correct endpoint for the main API requests
-            {
-              // API Requests
-              url: ["https://{{production.host}}"],
-              initiatorTypes: ["fetch", "xmlhttprequest"],
-            },
-            // TODO: check if other 3rd party requests need to be added here
-            {
-              // Critical resources
-              onlyTrackRenderBlocking: true,
-            },
-          ],
-        },
-      }
-    {{/if}}),
-{{#if hasSoftNavigations}}
-  {{#if convertSoftToHardNavigations}}
-    new SpaBundle({
-      enforceHardNavigation: {
-        /**
-         * @todo add selectors or urls to filter links that should never be converted
-         *
-         * @param url {string}
-         * @param element {HTMLAnchorElement}
-         * @returns {boolean}
-         */
-        filter: (url, element) => {
-          // var isMainMenu = element.closest("#MAIN_NAVIGATION_MENU,.burger-menu-body");
-          // if(isMainMenu) return false
-
-          // checks if the currentSite is enabled and an active site
-          var isActiveSite =
-            SpeedKit.isPageTypeEnabled(location.href) ||
-            (speedKit.activeSites ?? []).some((rule) => SpeedKit.testSpeedKitRule(rule, location, speedKit));
-          return isActiveSite;
-        },
-      },
-    }), // Soft Navigation Tracking using History API
-    {{else}}
-      new SpaBundle(), // Soft Navigation Tracking using History API
-  {{/if}}
-{{/if}}
-{{#if useGATracking}}
-    new GAEcommerceTrackingPlugin({
-      defaultCurrency: defaultCurrency,
-  {{#if isShopify}}
-      trackConfirmation: false, // No ecConversion tracking as it is already handled by the Speed Kit Extension for Shopify
-  {{/if}}
-    }),
-{{/if}}
-    new ClickPlugin(),
-    new HostTrackingPlugin(),
-  {{#if isPOV}}
-    new UserFrictionPlugin(),
-  {{/if}}
-{{#if isShopify}}
-    {
-      key: "loggedIn",
-      type: "PiDimension",
-      on: "window.ShopifyAnalytics",
-      set: function () {
-        return !!window.ShopifyAnalytics?.meta?.page?.customerId;
-      },
-    },
-    {
-      key: "pageType",
-      type: "PiDimension",
-      on: "window.ShopifyAnalytics",
-      set: function () {
-        return window.ShopifyAnalytics?.meta?.page?.pageType;
-      },
-    },
-{{else}}
-    {
-      key: 'loggedIn',
-      type: 'PiDimension',
-{{#if useGATracking}}
-      on: 'dataLayer',
-      set: function(pushedEvent) {
-        return pushedEvent?.isLoggedIn;
-      },
-{{else}}
-      // TODO: set proper 'on' event listener
-      set: function() {
-        // TODO: return value
-      },
-{{/if}}
-    },
-    {
-      key: 'pageType',
-      type: 'PiDimension',
-  {{#if useGATracking}}
-      on: 'dataLayer',
-      set: function (pushedEvent) {
-        // TODO: verify event property
-      {{#if isOxid}}
-        var pageType = pushedEvent?.ecomm_pagetype;
-        if (pageType) {
-          pageTypeSent = true;
-          return pageType;
-        }
-      {{else}}
-        return pushedEvent?.pageCategory;
-      {{/if}}
-      },
-  {{else}}
-      // TODO: set proper 'on' event listener
-      set: function() {
-      {{#if isOxid}}
-        var pageType; // TODO: assign value
-        if (pageType) {
-          pageTypeSent = true;
-          return pageType;
-        }
-      {{else}}
-        // TODO: return value
-      {{/if}}
-      },
-  {{/if}}
-    },
-{{#if isOxid}}
-    // OXID eShop specific fallback tracking for page type using URL:
-    {
-      key: "pageType",
-      type: "PiDimension",
-      on: "leavePage",
-      set: function () {
-        if (pageTypeSent) return;
-
-        var pageType = "";
-
-        // Use first segment of the url path as page type if pageType was not identified yet
-        var firstPathnameSegment = location.pathname.match(/^\/([^/]+)/);
-        if (firstPathnameSegment) {
-          pageType = firstPathnameSegment[1];
-        }
-
-        // Extend page type by value of cl query parameter as it also can point to the type of the page
-        var clParam = new URL(location.href).searchParams.get("cl");
-        if (clParam) {
-          pageType += "_" + clParam;
-        }
-
-        return pageType.toLowerCase();
-      },
-    },
-{{/if}}
-{{/if}}
-{{#if addSSR}}
-  {
-    on: "nextTick",
-    track: function (controller) {
-      controller.trackCustomEvent(
-        "viewportSize",
-        JSON.stringify({ innerWidth: window.innerWidth, innerHeight: window.innerHeight }),
-        0,
-      );
-    },
-  },
-{{/if}}
-{{#if useGATracking}}
-
-    // TODO: remove or adapt if events are not properly covered by GAEcommerceTrackingPlugin
-    // {
-    //   key: 'ecAddToCart',
-    //   on: 'dataLayer',
-    //   append: function (pushedEvent) {
-    //     if (!pushedEvent?.ecommerce?.add?.products) {
-    //       // Ignore, because the passed event was not a 'addToCart' event.
-    //       return;
-    //     }
-    //
-    //     var aTCProductsArray = [];
-    //     var ecommerce = pushedEvent.ecommerce;
-    //     var currencyCode = ecommerce.currencyCode;
-    //
-    //     // iterate over all added products
-    //     for (var i = 0; i < ecommerce.add.products.length; i++) {
-    //       aTCProductsArray.push({
-    //         id: ecommerce.add.products[i].id, // optional – remove if no id is available
-    //         currencyCode: currencyCode || defaultCurrency,
-    //         price: Number(ecommerce.add.products[i].price),
-    //         quantity: Number(ecommerce.add.products[i].quantity) || 1,
-    //        });
-    //     }
-    //
-    //     if (aTCProductsArray.length > 0) {
-    //       return aTCProductsArray;
-    //     }
-    //   },
-    // },
-    //
-    // // Confirmation tracking
-    // {
-    //   key: 'ecConversion',
-    //   on: 'dataLayer',
-    //   set: function (pushedEvent) {
-    //     if (!pushedEvent?.ecommerce?.purchase) {
-    //       // Ignore, because the passed event was not a 'purchase' event.
-    //       return;
-    //     }
-    //
-    //     var purchase = pushedEvent.ecommerce.purchase;
-    //     if (!purchase.actionField) {
-    //       return;
-    //     }
-    //
-    //     var orderId = purchase.actionField.id;
-    //     var orderValue = String(purchase.actionField.revenue).replace(',', '.');
-    //     return {
-    //       id: String(orderId),
-    //       currencyCode: defaultCurrency,
-    //       revenue: Number(orderValue),
-    //     };
-    //   },
-    // },
-{{else}}
-
-  {{#if isShopify}}
-    // No custom ecAddToCart tracking event needed as it is already handled by the speed-kit-config/ShopifyPlugin
-    // No custom ecConversion tracking event as it is already handled by the Speed Kit Extension for Shopify
-  {{else}}
-    {
-      key: 'ecAddToCart',
-      // TODO: set proper 'on' event listener
-      append: function() {
-        // var itemId = ...;
-        // var itemPrice = ...;
-        // var itemCurrency = ...;
-        // var itemQuantity = ...;
-        //
-        // return {
-        //   id: String(itemId), // optional – remove if no id is available
-        //   price: Number(itemPrice),
-        //   currencyCode: itemCurrency || defaultCurrency,
-        //   quantity: Number(itemQuantity) || 1,
-        // }
-      },
-    },
-    {
-      key: 'ecConversion',
-      // TODO: set proper 'on' event listener
-      set: function() {
-        // var orderId = ...;
-        // var orderValue = ...;
-        // var orderCurrency = ...;
-        //
-        // return {
-        //   id: String(orderId),
-        //   currencyCode: orderCurrency || defaultCurrency,
-        //   revenue: Number(orderValue),
-        // };
-      },
-    },
-  {{/if}}
-{{/if}}
-{{#if isPlentymarkets}}
-  {
-    on: "domInteractive",
-    track: function (controller) {
-      var SSR = document.querySelector('[data-server-rendered="true"]');
-      controller.trackCustomEvent("serverRendered", !!SSR);
-    },
-  },
-{{/if}}
-  );
-{{#if isPlentymarkets}}
-
-  /* ==== */
-
-  // Plentymarkets specific:
-
-  // code for dynamic blacklisting upon user logging in
-  function sendCookiesToSpeedKit() {
-    try {
-      if (navigator.serviceWorker?.controller) {
-        navigator.serviceWorker.controller.postMessage({
-          type: 'send-cookies',
-          data: document.cookie,
-          event: 'domLoaded',
-        });
-      }
-    } catch (e) {}
-  }
-
-  function setBlacklistCookie() {
-    var expires = (new Date(Date.now() + 30*24*60*60000));
-    document.cookie = "baqend-speedkit-blacklist=true; path=/; expires=" + expires.toGMTString();
-    localStorage.setItem('baqend-speedkit-blacklist', 'true');
-  }
-
-  function removeBlacklistCookie() {
-    document.cookie = "baqend-speedkit-blacklist=; path=/; expires=Thu, 01 Jan 1970 00:00:00 UTC";
-    localStorage.removeItem('baqend-speedkit-blacklist');
-  }
-
-  function onDomInteractive(cb) {
-    if (document.readyState !== 'loading') {
-      return setTimeout(cb, 0);
-    }
-    document.addEventListener('DOMContentLoaded', cb);
-  }
-
-  function blacklistIfLoggedIn() {
-    // TODO: replace with customer-specific selector
-    var loggedIn = document.querySelector('#accountMenuList');
-    if (!loggedIn) {
-      removeBlacklistCookie();
-    } else {
-      setBlacklistCookie();
-    }
-    sendCookiesToSpeedKit();
-  }
-
-  function onJSdone(cb) {
-    onDomInteractive(function() {
-      // resolve if element is already there
-      // TODO: replace with customer-specific selector
-      if (document.querySelector('#newsletterSignup')) {
-        cb();
-      }
-
-      var MutationObserver = window.MutationObserver || window.WebKitMutationObserver || window.MozMutationObserver;
-
-      // TODO: replace with customer-specific selector
-      if (!MutationObserver || !document.querySelector('header')) {
-        return;
-      }
-
-      var observer = new MutationObserver(function(mutations) {
-        mutations.forEach(function(mutation) {
-          // TODO: replace with customer-specific selector
-          if(mutation.target.id ==="newsletterSignup") {
-            cb();
-          }
-        });
-      });
-
-      // TODO: replace with customer-specific selector
-      var target = document.querySelector('header');
-      observer.observe(target, {
-        attributes: true,
-        childList: true,
-        characterData: true,
-        subtree:true,
-      });
-    });
-  }
-
-  onJSdone(function() {
-    blacklistIfLoggedIn();
-  });
-{{/if}}
-
-  // TODO: check if prerendering needs to be scoped to certain pages
-  new PredictivePreloading({ prerender: true });
-}();

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

@@ -1,209 +0,0 @@
-const { message } = require("baqend");
-
-const pageToCheck = "https://{{production.host}}/"; // TODO change to the actual page to check
-const maintenancePageRegex = /maintenance\.{{appName}}/g; // TODO change to the actual regex to identify maintenance mode
-
-/*
-create the job with the following data object:
-the slack webhook token can be pulled from this page:
-https://api.slack.com/apps/A090W8Q33TR/incoming-webhooks
-{
-  "updateStatus": true,
-  "slackToken": "<webhook slack token from the downtime detection app>",
-  "dryRun": true
-}
- */
-
-/**
- * Checks the status of a given page to determine if it is down or healthy.
- *
- * @param {Object} db - The database connection or object used for reference or logging.
- * @param {string} pageToCheck - The URL or identifier of the page to check the status for.
- * @param {RegExp} maintenancePageRegex - A regular expression to identify if the page is in maintenance mode.
- * @return {Promise<{ state: string }>} An object representing the state of the page, where "state" is either "healthy" or "downtime".
- */
-async function checkStatus(db, pageToCheck, maintenancePageRegex) {
-  const pageDown = await isPageDown(pageToCheck, maintenancePageRegex);
-
-  if (!pageDown) {
-    return { state: "healthy" };
-  }
-
-  return { state: "downtime" };
-}
-
-/**
- *  Hook to test the current status
- * @param {baqend} db - the baqend instance
- * @return {Promise<void>}
- */
-async function get(db, req, res) {
-  if (db.User.me?.key !== "1") throw new Abort("Unauthorized");
-  res.json(await checkStatus(db, pageToCheck, maintenancePageRegex));
-}
-
-{{{{raw}}}}
-/**
- * Hook which is executed by the cron job
- * @param {baqend} db - the baqend instance
- * @param {{status: string, error: Error, data?: { state: "healthy" | "downtime", revId?: string } | null}} status - The latest status of this scheduled run
- * @param {{ data: { slackToken?: string, dryRun?: boolean }}} job - The job definition
- * @return {Promise<void>}
- */
-{{{{/raw}}}}
-async function run(db, status, job) {
-  const newStatus = await checkStatus(db, pageToCheck, maintenancePageRegex);
-  newStatus.revId = status?.data?.revId ?? null;
-
-  db.log.info(`Downtime detection resulted in actual: ${newStatus.state}, previous: ${status.data?.state}`);
-
-  const domain = new URL(pageToCheck).hostname;
-  if (newStatus.state === "healthy" && status.data?.state === "downtime") {
-    if (!job.data.dryRun) {
-      try {
-        await resumeJob(db, newStatus.revId);
-        db.log.info(`Downtime detection resumed job ${newStatus.revId} for ${domain}`);
-      } catch (e) {
-        db.log.warn(
-          `Downtime detection failed to resume job ${newStatus.revId} for ${domain}, scheduling a new job instead`,
-          e,
-        );
-        const revId = await scheduleJob(db, domain, "deployment", 0);
-        db.log.info(`Downtime detection started new job ${revId} for ${domain}`);
-      }
-      newStatus.revId = null;
-    }
-    sendSlackMessage(job.data.slackToken, `A downtime was resolved on ${domain}, deployment job resumed.`).catch((e) =>
-      db.log.warn("Can't send slack message", e),
-    );
-  }
-
-  if (newStatus.state === "downtime" && status.data?.state === "healthy") {
-    if (!job.data.dryRun) {
-      // block refresh while the page is down
-      newStatus.revId = await scheduleJob(db, domain, "deployment", 12 * 60 * 60 * 1000);
-      db.log.info(`Downtime detection scheduled new job ${newStatus.revId} for ${domain}`);
-    }
-    sendSlackMessage(job.data.slackToken, `A downtime was detected on ${domain}, deployment job scheduled.`).catch(
-      (e) => db.log.warn("Can't send slack message", e),
-    );
-  }
-
-  // persisted by the job itself
-  status.error = null;
-  status.data = newStatus;
-}
-
-/**
- * Schedules a job to handle downtime detection for a given domain.
- *
- * @param {Object} db - The database connection or message dispatch object used for sending messages.
- * @param {string} domain - The domain for which the downtime job should be scheduled.
- * @param {string} jobType - The type of job to be scheduled.
- * @param {number} [delay=0] - The delay (in milliseconds) before the job is executed.
- * @return {Promise<string>} A promise that resolves to the unique identifier of the scheduled job.
- */
-async function scheduleJob(db, domain, jobType, delay = 0) {
-  const data = {
-    name: `Downtime ${domain}`,
-    type: jobType,
-    filter: {
-      contentTypes: ["document"],
-      origins: [`https://${domain}`],
-    },
-    triggeredBy: "DowntimeDetection",
-    scheduleIn: delay,
-  };
-
-  const msg = new message.RevalidateAssets(data);
-  const response = await db.send(msg);
-  const jobId = response.entity.statusId;
-
-  return jobId;
-}
-
-/**
- * Resumes a job by updating its status to "RUNNING".
- *
- * @param {baqend} db - The baqend instance
- * @param {string} jobId - The unique identifier of the job to be resumed.
- * @return {Promise<void>} A promise that resolves once the job status update has been sent.
- */
-async function resumeJob(db, jobId) {
-  const msg = new message.EditRevalidationJob(jobId, { status: "RUNNING" });
-  try {
-    await db.send(msg);
-  } catch (e) {
-    if (e.status === 200) {
-      return; // there is a bug in the server that it currently returns 200 instead of 204 that confuse the SDK
-    }
-    throw e;
-  }
-}
-
-/**
- * Returns whether the landing page is not reachable.
- *
- * @param {string} landingPage The page to test.
- * @param {RegExp} maintenancePageRegex The pattern used to identify redirects to maintenance page.
- * @param retry The number of already failed tries to load the page.
- * @returns `true` if the landing page is not reachable, `false` otherwise.
- */
-async function isPageDown(landingPage, maintenancePageRegex, retry = 0) {
-  const res = await fetch(landingPage, { redirect: "manual" });
-
-  // Valid response
-  if (res.status < 300) {
-    return false;
-  }
-
-  // Redirect
-  if (res.status < 400) {
-    return isMaintenanceRedirect(res, maintenancePageRegex);
-  }
-
-  // Error
-  if (retry > 3) {
-    return true;
-  }
-
-  // Retry after error
-  await sleep(10000);
-  return isPageDown(landingPage, maintenancePageRegex, retry + 1);
-}
-
-/**
- * Returns whether the response redirects to the maintenance page.
- *
- * @param res {Response} The fetch result of
- * @param maintenancePageRegex The page to identify redirects to maintenance page.
- */
-async function isMaintenanceRedirect(res, maintenancePageRegex) {
-  const location = res.headers.get("Location") || "";
-  return !!location.match(maintenancePageRegex);
-}
-
-async function sleep(milliseconds) {
-  return new Promise((res) => setTimeout(res, milliseconds));
-}
-
-/**
- * Sends a message to a Slack channel using the provided webhook token.
- *
- * @param {string} token - The Slack webhook URL to which the message will be sent.
- * @param {string} message - The message content to be sent to the Slack channel.
- * @return {Promise<void>} A promise resolving to the response of the fetch request.
- */
-async function sendSlackMessage(token, message) {
-  if (!token) {
-    return;
-  }
-  const body = JSON.stringify({
-    username: "Downtime Detection",
-    text: message,
-  });
-  await fetch(token, { method: "POST", body });
-}
-
-exports.get = get;
-exports.run = run;