@speedkit/cli 2.27.0 → 2.28.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [2.28.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.27.0...v2.28.0) (2024-05-22)
+
+
+### Features
+
+* **customer-config:** remove old deployment detection ([a3661c7](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/a3661c7db68ade9907b15caaa1edf370e51783ca))
+
 # [2.27.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.26.0...v2.27.0) (2024-05-03)
 
 

package/README.md

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

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

@@ -264,9 +264,6 @@ class CustomerConfigService {
     async generateConfig() {
         this.cli.write("\nLet's generate a config...\n");
         const configSettings = await this.getConfigSettings();
-        if (configSettings.isSalesforce) {
-            this.templates.push("deploymentDetection.es6.hbs");
-        }
         const addDowntimeDetection = await this.cli.confirm("Add Downtime Detection?", false);
         if (addDowntimeDetection) {
             this.templates.push("downtimeDetection.js.hbs");

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

@@ -87,11 +87,7 @@ const config = {
 {{else}}
   delayScriptPath: "/speed-kit-dom-ready.js",
 {{/if}}
-{{#if isSalesforce}}
-  executeDeploymentDetection: false, // Salesforce specific => deploymentDetection.es6 is being used instead
-{{else}}
   executeDeploymentDetection: true,
-{{/if}}
 {{#unless addPreRendering}}
   {{#if removeLazyLoading}}
   lazyLoadList,

package/oclif.manifest.json

@@ -667,5 +667,5 @@
       ]
     }
   },
-  "version": "2.27.0"
+  "version": "2.28.0"
 }

package/package.json

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

package/dist/services/customer-config/templates/deploymentDetection.es6.hbs

@@ -1,303 +0,0 @@
-// Salesforce specific:
-
-const { run: executeRefresh } = require('./speedKit.CronJob');
-const fetch = require('node-fetch');
-
-const minutesToMilliseconds = (minutes) => {
-  return minutes * 60000;
-}
-
-const LOCALES_BY_LAYOUT = [
-  // TODO: adjust/replace this exemplary list
-  ExampleLayoutA: ["de_DE", "en_DE"],
-  ExampleLayoutB: ["en_US"],
-];
-const ASSET_SUB_PATHS = [
-  // These assets are expected to be found via the following base URL:
-  //  https://<ORIGIN>/on/demandware.static/Sites-<LAYOUT>-Site/-/<LOCALE>/v<VERSION>/...
-
-  // TODO: adjust/replace this exemplary list
-
-  // JS:
-  "js/main.js",
-  "internal/jscript/dwanalytics-(.*).js",
-
-  // CSS:
-  "css/style.css",
-];
-
-function getAssetList() {
-  return Object.entries(LOCALES_BY_LAYOUT).flatMap(([layout, locales]) =>
-    locales.flatMap((locale) =>
-      ASSET_SUB_PATHS.map(
-        (subPath) =>
-{{#if staging.host}}
-          `^https://(?:{{production.host}}|{{staging.host}})/on/demandware.static/Sites-${layout}-Site/-/${locale}/v(\\d{13})/${subPath}`,
-{{else}}
-          `^https://{{production.host}}/on/demandware.static/Sites-${layout}-Site/-/${locale}/v(\\d{13})/${subPath}`,
-{{/if}}
-      ),
-  );
-}
-
-const deploymentConfig = {
-  slack: "<1Password deployment token>",
-  origins: [
-    // Production:
-    "https://{{production.host}}",
-{{#if staging.host}}
-
-    // Staging:
-    "https://{{staging.host}}",
-{{/if}}
-
-    // TODO: also check for other origins like e.g. https://*.my.salesforce.com
-  ],
-  jobType: "deployment", // "instant" | "deployment"
-
-  // configure how long the origin deployment takes in milliseconds:
-  deploymentDelay: minutesToMilliseconds(15),
-
-  // throttling the HTML refresh:
-  revalidationDelay: minutesToMilliseconds(0),
-
-  compareVersionStrings: false, // Compares version strings of the new and previous assets and only triggers deployment, when the current is newer. The version must be the first group in the regex
-  compareContentHashes: true,
-
-  assetList: [
-    ...getAssetList(),
-
-    // TODO: add additional non-demandware asset urls as needed
-  ],
-}
-
-function getQuery(assetRegex, origin) {
-  const query = getBaseQuery(origin);
-  query.url = { "$regex": assetRegex };
-  return query;
-}
-
-function getBaseQuery(...origins) {
-  return {
-    "contentType": { "$in": ["script", "style"] },
-    "variation": "DEFAULT",
-    "origin": { "$in": origins },
-  };
-}
-
-const DEPLOYMENT_REFRESH_JOB_ID_TEMPLATE = '/db/jobs.Definition/deployment-refresh'
-const DEPLOYMENT_CHECKER_JOB_ID = '/db/jobs.Definition/deployment-check'
-const MINUTE = 60 * 1000;
-
-exports.get = async function(db, req, res) {
-  if (!db.User.me || db.User.me.key !== '1') {
-    throw new Abort("Unauthorized");
-  }
-
-  const assetsByOrigin = {};
-
-  for (const origin of deploymentConfig.origins) {
-    assetsByOrigin[origin] = await Promise.all(deploymentConfig.assetList.map(async asset => {
-      const { url } = await findAsset(db, asset, origin) || { url: null };
-      return url;
-    }))
-  }
-
-  res.json(assetsByOrigin);
-}
-
-
-exports.post = async function(db, req, res) {
-  if (!db.User.me || db.User.me.key !== '1') {
-    throw new Abort("Unauthorized");
-  }
-
-  const deploymentJobs = await Promise.all(deploymentConfig.origins.map(
-    origin => createDeploymentJob(db, deploymentConfig, origin)));
-
-  const deploymentChecker = await (new db['jobs.Definition']({
-    id: DEPLOYMENT_CHECKER_JOB_ID,
-    module: 'deploymentDetection',
-    cronpattern: '42 */10 * * * *',
-    startsAt: new Date(),
-  }).save().catch(e => e.message));
-
-  res.json({ deploymentChecker, deploymentJobs });
-}
-
-function getDeploymentJobId(origin) {
-  const originWithoutSlashes = origin.replace(/https:/g, '').replace(/\//g, '');
-  return `${DEPLOYMENT_REFRESH_JOB_ID_TEMPLATE}-${originWithoutSlashes}`;
-}
-
-function getDeploymentJobName(origin) {
-  const originWithoutSlashes = origin.replace(/https:/g, '').replace(/\//g, '');
-  return `Deployment ${originWithoutSlashes}`
-}
-
-function createDeploymentJob(db, deploymentConfig, origin) {
-  return (new db['jobs.Definition']({
-    id: getDeploymentJobId(origin),
-    module: 'speedKit.CronJob',
-    cronpattern: '*/60 */24 */30 */12 *',
-    startsAt: new Date(),
-    expiresAt: new Date(1970,0, 1),
-    data: {
-      "name": getDeploymentJobName(origin),
-      "jobType": deploymentConfig.jobType || "deployment",
-      "filter": {
-        "contentTypes": [ "document" ],
-        "origin": [ origin ],
-      },
-      "scheduleIn": deploymentConfig.deploymentDelay,
-      "revalidationDelay": deploymentConfig.revalidationDelay,
-    },
-  }).save({ force: true }).catch(e => e.message));
-}
-
-exports.run = async function triggerRefreshAfterDeployment(db, status) {
-  const interval = new Date(Date.now() - 10 * MINUTE - 10);
-  const origins = await findNewAsset(db, interval, deploymentConfig.origins);
-  const app = db.connection.host;
-
-  if (origins.size === 0) {
-    status.data = {refreshing: false, reason: "no new asset" };
-    return;
-  }
-
-  const data = status.data = {};
-  for (const origin of origins) {
-    try {
-      const changedAsset = await getChangedAssets(db, origin);
-      if (!changedAsset) {
-        data[origin] = {
-          refreshing: false, origin, reason: "asset hash not changed",
-        };
-        continue;
-      }
-
-      const reason = `Asset changed: ${changedAsset}`;
-      fetch(deploymentConfig.slack, {
-        username: 'Deployment Detection',
-        method: 'post',
-        body: JSON.stringify({text: `Deployment on ${app} on ${origin} detected. Starting HTML ${deploymentConfig.jobType || "deployment"} Refresh. ${reason}`}),
-      }).catch(db.log.warn);
-
-      await runDeploymentJob(db, origin, reason);
-
-      data[origin] = {
-        refreshing: true, origin, latestAsset: changedAsset,
-      };
-    } catch (e) {
-      fetch(deploymentConfig.slack, {
-        username: 'Deployment Detection',
-        method: 'post',
-        body: JSON.stringify({text: `Deployment detection on ${app} and ${origin} failed. ${e.message}`}),
-      }).catch(db.log.warn);
-      data[origin] = {
-        refreshing: false, origin, reason: e.stack,
-      };
-    }
-  }
-  return data;
-};
-
-async function getChangedAssets(db, origin) {
-  for (const urlRegex of deploymentConfig.assetList) {
-    const interval = new Date(Date.now() - 10 * MINUTE - 10);
-    const current = await findAsset(db, urlRegex, origin, interval);
-    const previous = await findAsset(db, urlRegex, origin, null, interval);
-
-    if (!current) {
-      continue;
-    }
-
-    // trigger deployment since we see a new matching asset
-    if (!previous) {
-      return current.url;
-    }
-
-    if (deploymentConfig.compareContentHashes) {
-      if (current.contentHash === previous.contentHash) {
-        continue;
-      }
-
-      if (await hasCachedAsset(db, current, urlRegex, interval)) {
-        db.log.info('contentHash already known', {current, previous});
-        continue;
-      }
-    }
-
-    if (deploymentConfig.compareVersionStrings) {
-      const prevVersion = previous.url.match(urlRegex)[1];
-      const currentVersion = current.url.match(urlRegex)[1];
-      if (currentVersion < prevVersion) {
-        db.log.info('content version has not increased', {current, previous});
-        continue;
-      }
-    }
-
-    return current.url;
-  }
-
-  return false;
-}
-
-async function findAsset(db, urlRegex, origin, from, to) {
-  return await db["speedKit.Asset"].find()
-    .where(getQuery(urlRegex, origin))
-    .le('createdAt', to || new Date(Date.now() + MINUTE))
-    .gt('createdAt', from || new Date(1970, 0, 1))
-    .descending('createdAt')
-    .singleResult();
-}
-
-async function findNewAsset(db, from, origins) {
-  const result = await db["speedKit.Asset"].find()
-    .where(getBaseQuery(...origins))
-    .gt('createdAt', from || new Date(1970, 0, 1))
-    .resultList();
-
-  return new Set(result.map(asset => asset.origin));
-}
-
-async function hasAssetChanged(asset1, asset2) {
-  const res1 = await fetch(asset1.url);
-  const text1 = await res1.text();
-
-  const res2 = await fetch(asset2.url);
-  const text2 = await res2.text();
-
-  return text1 !== text2;
-}
-
-/**
- * Check whether we have seen the hash before
- */
-async function hasCachedAsset(db, asset, urlRegex, to) {
-  return (await db["speedKit.Asset"].find()
-    .where(getQuery(urlRegex, asset.origin))
-    .equal('contentType', asset.contentType)
-    .equal('variation', asset.variation)
-    .equal('contentHash', asset.contentHash)
-    .le('createdAt', to || new Date(Date.now() + MINUTE))
-    .count()
-  ) > 0;
-}
-
-async function runDeploymentJob(db, origin, reason) {
-  const status = new db['jobs.Status']();
-  const jobId = getDeploymentJobId(origin);
-  const cronjob = await db['jobs.Definition'].load(jobId);
-  // TODO: quite hacky right now we may need a way to pass additional parameters to the run job code
-  cronjob.data.reason = reason;
-  status.cronjob = cronjob;
-
-  try {
-    await executeRefresh(db, status, cronjob);
-  } catch(error) {
-    status.status = 'failed';
-    status.error = error;
-    await status.save();
-  }
-}