@madgex/fert 2.1.0 → 2.2.2

package/README.md

@@ -216,3 +216,5 @@ Here are the default npm scripts in a Fert-scaffolded project.
 ```
 
 Its expected that a Jenkins pipeline will run `fert publish` to send all built assets to the Asset Store API.
+
+.

package/bin/utils/cpid-matches-git-remote.js

@@ -0,0 +1,58 @@
+const simpleGit = require('simple-git');
+const chalk = require('chalk');
+const Hoek = require('@hapi/hoek');
+const dedent = require('dedent');
+
+/**
+ * Validates client property ID found in the fert config against the git url and the package name.
+ * All three should match. Mismatched CPIDs can lead to destructive publication.
+ *
+ * @function validateCpId
+ *
+ * @async
+ *
+ * @param {Object} fertConfig an object containing client branding configuration.
+ *
+ * @returns {Boolean} Returns true if the CPIDs found in the fert config, git url, and package.json are the same
+ *
+ */
+
+exports.cpIdMatchesGitRemote = async (fertConfig, workingDir) => {
+  // Validate that the working directory is a git repository
+  const simpleGitOptions = {
+    baseDir: fertConfig.workingDir,
+  };
+  const git = simpleGit(simpleGitOptions);
+  Hoek.assert(await git.checkIsRepo(), `${workingDir} is not a git repository`);
+
+  // Validate that the CPID in the fert config matches the CPID in the git remote URL
+  try {
+    const remoteUrl = await git.listRemote(['--get-url']);
+    const parts = remoteUrl.split('/');
+    const repo = parts[parts.length - 1].trim();
+    const remoteUrlCpid = repo.split('madgex-')[1].trim().replace('.git', '');
+
+    if (remoteUrlCpid == fertConfig.clientPropertyId) {
+      return true;
+    }
+
+    // Big ugly console message for high visibility.
+    console.log(
+      dedent`
+        ${chalk.bgRed.bold(
+          '💀 💀 💀 Client Property IDs do not match! 💀 💀 💀 '
+        )}
+        ${chalk.red('CPID from fert.config.js:')} ${fertConfig.clientPropertyId}
+        ${chalk.red('CPID from Git remote URL:')} ${remoteUrlCpid}
+        ${chalk.bgYellow.bold(
+          '🤓 Please ensure that the Client Property Id from the fert.config.js and the git remote match 🧐 '
+        )}\n
+      `
+    );
+  } catch (error) {
+    console.log(error);
+    console.log(chalk.red('CPID could not be validated'));
+  }
+
+  return false;
+};

package/bin/utils/index.js

@@ -5,6 +5,7 @@ const chalk = require('chalk');
 const uuidValidator = require('uuid-validate');
 const Hoek = require('@hapi/hoek');
 const { cpidLookup } = require('./cpid-lookup');
+const { cpIdMatchesGitRemote } = require('./cpid-matches-git-remote');
 const { resolveExternalAssets } = require('./resolve-external-assets');
 const { log } = require('./logging');
 const { CONFIG_API } = require('../../constants');
@@ -41,17 +42,32 @@ exports.resolveConfig = async (root, options = {}) => {
   };
 
   const workingDir = root ? path.resolve(root) : path.resolve(process.cwd());
+
   const fertConfig = Hoek.applyToDefaults(
     defaults,
     this.loadConfigFromFile(workingDir)
   );
-  const client = await cpidLookup(fertConfig.clientPropertyId, options);
 
+  // Check Fert cpid is valid
   Hoek.assert(
     uuidValidator(fertConfig.clientPropertyId),
     `Invalid clientPropertyId specified in fert.config.js: ${fertConfig.clientPropertyId}`
   );
 
+  // Check Fert cpid matches git's remote
+
+  const fertCpidMatchesGitRemote = await cpIdMatchesGitRemote(
+    fertConfig,
+    workingDir
+  );
+
+  Hoek.assert(
+    fertCpidMatchesGitRemote,
+    `CPID mismatch, please correct before retrying: ${fertConfig.clientPropertyId}`
+  );
+
+  const client = await cpidLookup(fertConfig.clientPropertyId);
+
   fertConfig.externalAssets = resolveExternalAssets(fertConfig.externalAssets);
 
   fertConfig.config = await exports.getConfig(fertConfig.clientPropertyId, [

package/bin/utils/lookup-cf-distribution-ids.js

@@ -4,7 +4,7 @@ const {
 } = require('@aws-sdk/client-cloudfront');
 const { persistentCacheWithTtl } = require('./persistent-cache-with-ttl');
 const assert = require('node:assert');
-const { ONE_WEEK } = require('../../constants');
+const { ONE_WEEK, AWS_REGION } = require('../../constants');
 const { log } = require('../utils/logging');
 
 const cache = new persistentCacheWithTtl('cf-distribution-cache', {
@@ -12,7 +12,7 @@ const cache = new persistentCacheWithTtl('cf-distribution-cache', {
 });
 
 exports.doGetAllCloudFrontDistributions = async () => {
-  const cloudfront = new CloudFrontClient();
+  const cloudfront = new CloudFrontClient({ region: AWS_REGION });
   const distributions = [];
 
   let Marker = '';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@madgex/fert",
-  "version": "2.1.0",
+  "version": "2.2.2",
   "description": "Tool to help build the V6 branding",
   "bin": {
     "fert": "./bin/cli.js"
@@ -40,6 +40,7 @@
     "chokidar": "^3.5.3",
     "dayjs": "^1.11.10",
     "debug": "^4.3.4",
+    "dedent": "^1.5.3",
     "flat-cache": "^4.0.0",
     "form-data": "^4.0.0",
     "lodash": "^4.17.21",
@@ -49,6 +50,7 @@
     "prompts": "^2.4.2",
     "rimraf": "^5.0.5",
     "sass": "^1.69.5",
+    "simple-git": "^3.24.0",
     "simple-update-notifier": "^2.0.0",
     "style-dictionary": "3.9.0",
     "uuid-validate": "^0.0.3",