chore: corrected currency update logic to prevent mixing major and minor update (#2464)

ref https://jsw.ibm.com/browse/INSTA-84235

Author: aryamohanan

bin/dependencies/currency/update-currencies.js

@@ -9,7 +9,7 @@ const path = require('path');
 const semver = require('semver');
 const { execSync } = require('child_process');
 const fs = require('fs');
-const currencies = require(path.join(__dirname, '..', '..', '..', 'currencies.json'));
+const currenciesPath = path.join(__dirname, '..', '..', '..', 'currencies.json');
 const utils = require('../utils');
 const MAJOR_UPDATES_MODE = process.env.MAJOR_UPDATES_MODE ? process.env.MAJOR_UPDATES_MODE === 'true' : false;
 const BRANCH = process.env.BRANCH;
@@ -18,94 +18,109 @@ const cwd = path.join(__dirname, '..', '..', '..');
 const DRY_RUN = process.env.DRY_RUN === 'true';
 
 if (!BRANCH) throw new Error('Please set env variable "BRANCH".');
-let branchName = BRANCH;
+
+const loadCurrencies = () => {
+  delete require.cache[require.resolve(currenciesPath)];
+  return require(currenciesPath);
+};
+
+let currencies = loadCurrencies();
 
 console.log(`MAJOR_UPDATES_MODE: ${MAJOR_UPDATES_MODE}`);
 console.log(`BRANCH: ${BRANCH}`);
 console.log(`SKIP_PUSH: ${SKIP_PUSH}`);
+console.log('==============\n');
 
 if (!MAJOR_UPDATES_MODE) {
-  console.log('Preparing patch/minor updates...');
-  utils.prepareGitEnvironment(branchName, cwd, BRANCH === 'main', DRY_RUN);
+  console.log('[INIT] Preparing batch (patch/minor) updates...');
+  utils.prepareGitEnvironment(BRANCH, cwd, BRANCH === 'main', DRY_RUN);
 }
 
-currencies.forEach(currency => {
-  console.log(`Checking currency update for ${currency.name}`);
+currencies.forEach(originalCurrency => {
+  let currency = originalCurrency;
+
+  if (MAJOR_UPDATES_MODE) {
+    utils.prepareGitEnvironment('main', cwd, true, DRY_RUN);
+
+    currencies = loadCurrencies();
+    currency = currencies.find(c => c.name === originalCurrency.name);
+  }
+
+  console.log(`-----------${currency.name}-----------`);
 
   if (currency.ignoreUpdates) {
-    console.log(`Skipping ${currency.name}. ignoreUpdates is set.`);
+    console.log(`[SKIP] ${currency.name}. ignoreUpdates is set.`);
     return;
   }
 
   const { version: installedVersion, versionObj: installedVersionObj } = utils.getLatestInstalledVersion(currency);
 
   if (!installedVersion) {
-    console.log(`Skipping ${currency.name}. Seems to be a core dependency.`);
+    console.log(`[SKIP] ${currency.name}. No installed version(core dependency).`);
     return;
   }
 
   const latestVersion = utils.getLatestVersion({
     pkgName: currency.name,
-    installedVersion: installedVersion,
+    installedVersion,
     isBeta: currency.isBeta
   });
 
   if (latestVersion === installedVersion) {
-    console.log(
-      `Skipping ${currency.name}. Installed version is ${installedVersion}. Latest version is ${latestVersion}`
-    );
+    console.log(`[UP-TO-DATE] ${currency.name} already up-to-date (${installedVersion})`);
     return;
   }
 
-  console.log(`Latest version: ${latestVersion}`);
-  console.log(`Installed version: ${installedVersion}`);
+  const isMajorUpdate = semver.major(latestVersion) !== semver.major(installedVersion);
+
+  console.log(`[UPDATE] ${currency.name}: ${installedVersion} → ${latestVersion}`);
 
-  const isMajorUpdate = semver.major(latestVersion) === semver.major(installedVersion);
+  if (MAJOR_UPDATES_MODE && !isMajorUpdate) {
+    console.log('[SKIP] Not a major update');
+    return;
+  }
 
-  if (!MAJOR_UPDATES_MODE && !isMajorUpdate) {
-    console.log(`Skipping ${currency.name}. Major updates not allowed.`);
+  if (!MAJOR_UPDATES_MODE && isMajorUpdate) {
+    console.log(`[SKIP] ${currency.name}. Major updates not allowed.`);
     return;
   }
 
+  let branchName = BRANCH;
+
   if (MAJOR_UPDATES_MODE) {
-    if (semver.major(latestVersion) === semver.major(installedVersion)) {
-      console.log(`Skipping ${currency.name}. No major update available.`);
+    if (!isMajorUpdate) {
+      console.log(`[SKIP] ${currency.name}. No major update available.`);
       return;
     }
 
-    console.log(`Major update available for ${currency.name}.`);
+    console.log(`[UPDATE] Major update available for ${currency.name}.`);
     branchName = utils.createBranchName(BRANCH, currency.name, latestVersion);
 
     if (utils.branchExists(branchName, cwd)) {
-      console.log(`Skipping ${currency.name}. Branch exists.`);
+      console.log(`[SKIP] Branch exists: ${branchName}`);
       return;
     }
 
-    utils.prepareGitEnvironment(branchName, cwd, BRANCH === 'main');
+    utils.prepareGitEnvironment(branchName, cwd, BRANCH === 'main', DRY_RUN);
   }
 
   // 1. update currencies.json versions array
-  const installedVersionIndex = currency.versions.findIndex(vObj => {
+  const installedIndex = currency.versions.findIndex(vObj => {
     const v = typeof vObj === 'string' ? vObj : vObj.v;
     return v === installedVersion;
   });
 
-  if (MAJOR_UPDATES_MODE && isMajorUpdate) {
-    const newVersionObj =
-      typeof installedVersionObj === 'string' ? latestVersion : { ...installedVersionObj, v: latestVersion };
-    currency.versions.unshift(newVersionObj);
-  } else {
-    currency.versions = currency.versions.filter(vObj => {
-      const v = typeof vObj === 'string' ? vObj : vObj.v;
-      return v !== installedVersion;
-    });
-    const newVersionObj =
-      typeof installedVersionObj === 'string' ? latestVersion : { ...installedVersionObj, v: latestVersion };
-    currency.versions.splice(installedVersionIndex, 0, newVersionObj);
-  }
+  const newVersionObj =
+    typeof installedVersionObj === 'string' ? latestVersion : { ...installedVersionObj, v: latestVersion };
+
+  currency.versions = currency.versions.filter(vObj => {
+    const v = typeof vObj === 'string' ? vObj : vObj.v;
+    return v !== installedVersion;
+  });
+  currency.versions.splice(installedIndex, 0, newVersionObj);
 
   if (!DRY_RUN) {
-    fs.writeFileSync(path.join(__dirname, '..', '..', '..', 'currencies.json'), JSON.stringify(currencies, null, 2));
+    fs.writeFileSync(currenciesPath, JSON.stringify(currencies, null, 2));
   } else {
     console.log(`[DRY RUN] Updated currencies.json with ${currency.name} version ${latestVersion}`);
   }
@@ -125,31 +140,27 @@ currencies.forEach(currency => {
     try {
       execSync("git add 'currencies.json'", { cwd });
       execSync(`git commit -m "build: bumped ${currency.name} from ${installedVersion} to ${latestVersion}"`, { cwd });
-    } catch (error) {
-      console.error(`Failed to commit changes: ${error.message}`);
+    } catch (err) {
+      console.error(`[ERROR] Commit failed: ${err.message}`);
     }
-  } else {
-    // eslint-disable-next-line max-len
-    console.log(
-      `[DRY RUN] git commit -m "build: bumped ${currency.name} from ${installedVersion} to ${latestVersion}"`
-    );
   }
 });
 
 // For non-major updates, push all changes at once
 if (!MAJOR_UPDATES_MODE) {
-  if (utils.hasCommits(branchName, cwd)) {
+  if (utils.hasCommits(BRANCH, cwd)) {
     if (!SKIP_PUSH) {
       try {
-        execSync(`git push origin ${branchName} --no-verify`, { cwd });
-        // eslint-disable-next-line max-len
+        execSync(`git push origin ${BRANCH} --no-verify`, { cwd });
         const prTitle = '[Currency Bot] Bumped patch/minor dependencies';
-        execSync(`gh pr create --base main --head ${branchName} --title "${prTitle}" --body "Tada!"`, { cwd });
+        execSync(`gh pr create --base main --head ${BRANCH} --title "${prTitle}" --body "Tada!"`, { cwd });
+
+        console.log('[DONE] Currency PR created');
       } catch (error) {
-        console.error(`Failed to push changes: ${error.message}`);
+        console.error(`[ERROR] Failed to push changes:: ${error.message}`);
       }
     }
   } else {
-    console.log(`Branch ${branchName} has no commits.`);
+    console.log(`Branch ${BRANCH} has no commits.`);
   }
 }