@speedkit/cli 2.89.0 → 2.91.0

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [2.91.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.90.0...v2.91.0) (2025-07-08)
+
+
+### Features
+
+* **wizard:** templates ([6d328fd](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/6d328fd400769e329f80c89edc6f34185e8ed04d))
+
+# [2.90.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.89.0...v2.90.0) (2025-07-08)
+
+
+### Features
+
+* **config-wizard:** add new  "affid" affiliate id tracking param to the strip query param list ([eefc936](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/eefc93665c993af2a1369062029196f9a4b3ee61))
+* **config-wizard:** add new  "affid" affiliate id tracking param to the strip query param list ([9028cc4](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/9028cc499d65bdd5ee4f1e3d7ffa8515df0cd1e7))
+
 # [2.89.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.88.0...v2.89.0) (2025-07-04)
 
 

package/README.md

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

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

@@ -371,6 +371,7 @@
         "yclid", // Yandex Click ID
         "zanpid", // AWIN (former Zanox Affiliate Network)
         /^(mb|nb|nx|ny)$/,
+        /^affid$/i, // Affiliate ID
         /^WT\./, // WebTrends
         /^[gw]braid$/, // Google's iOS web-to-app campaign measurement
         /^bv(state|messageType|notificationId|recipientDomain)$/, // Bazaarvoice

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

@@ -1,77 +1,156 @@
-const fetch = require('node-fetch');
-const { SLACK_WEB_HOOK_URL, APP_API_TOKEN } = require('./parameters');
+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
+}
+ */
 
 /**
- * Run this as a CRON job every 5 minutes.
+ * Checks the status of a given page to determine if it is down or healthy.
  *
- * NOTE: Do not forget to change page specific parts for your customer!
- * NOTE: Do not forget to create the parameters module with slack URL and admin API token
+ * @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 call(db, data, req) {
-  const landingPage = 'https://{{production.host}}/';
-  const maintenancePageRegex = /maintenance\.{{appName}}/g;
+async function checkStatus(db, pageToCheck, maintenancePageRegex) {
+  const pageDown = await isPageDown(pageToCheck, maintenancePageRegex);
 
-  const landingPageDown = await isLandingPageDown(landingPage, maintenancePageRegex);
-
-  if (!landingPageDown) {
-    return { status: 'success' };
+  if (!pageDown) {
+    return { state: "healthy" };
   }
 
-  loginAdmin(db);
+  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));
+}
 
-  const deactivated = await deactiveSpeedKit(db);
-  if (deactivated) {
-    notifyBaqend(landingPage);
+{{{{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),
+    );
   }
 
-  return { status: 'downtime' };
+  // persisted by the job itself
+  status.error = null;
+  status.data = newStatus;
 }
 
 /**
- * Logs in an admin.
+ * Schedules a job to handle downtime detection for a given domain.
  *
- * @param db The database to perform the login with
+ * @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 loginAdmin(db) {
-  await db.loginWithToken(APP_API_TOKEN);
-}
-
-function notifyBaqend(landingPage) {
-  const body = JSON.stringify({
-    "username": 'Downtime Detection',
-    "text": `Speed Kit was deactivated due to downtime of ${landingPage}`,
-  });
-  return fetch(SLACK_WEB_HOOK_URL, { method: 'POST', body })
+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;
 }
 
 /**
- * Deactivates Speed Kit via the config.
+ * 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 deactiveSpeedKit(db) {
-  const config = (await db.send(new db.message.GetOrestesConfig())).entity;
-
-  if (!config.speedKit.enabled) {
-    // Speed Kit already deactivated
-    return false;
+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;
   }
-
-  // Deactivate Speed Kit
-  config.speedKit.enabled = false;
-  const configUpdate = new db.message.UpdateOrestesConfig(config).ifMatch(config.revision.version);
-  await db.send(configUpdate);
-  return true;
 }
 
 /**
  * Returns whether the landing page is not reachable.
  *
- * @param landingPage The page to test.
- * @param maintenancePageRegex The page to identify redirects to maintenance page.
+ * @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 isLandingPageDown(landingPage, maintenancePageRegex, retry = 0) {
-  const res = await fetch(landingPage);
+async function isPageDown(landingPage, maintenancePageRegex, retry = 0) {
+  const res = await fetch(landingPage, { redirect: "manual" });
 
   // Valid response
   if (res.status < 300) {
@@ -90,21 +169,41 @@ async function isLandingPageDown(landingPage, maintenancePageRegex, retry = 0) {
 
   // Retry after error
   await sleep(10000);
-  return isLandingPageDown(retry + 1);
+  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 maintenancePageRegex.test(location);
+  const location = res.headers.get("Location") || "";
+  return !!location.match(maintenancePageRegex);
 }
 
 async function sleep(milliseconds) {
-  return new Promise(res => setTimeout(res, 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.call = call;
+exports.get = get;
+exports.run = run;

package/oclif.manifest.json

@@ -712,5 +712,5 @@
       ]
     }
   },
-  "version": "2.89.0"
+  "version": "2.91.0"
 }

package/package.json

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