fix: replace repository do-while loop with recursion (#976)

lib/workers/repository/index.js

@@ -24,30 +24,26 @@ function pinDependenciesFirst(a, b) {
   return a.branchName > b.branchName;
 }
 
-async function renovateRepository(repoConfig, token) {
+async function renovateRepositoryInner(repoConfig, token, count = 1) {
   let config = { ...repoConfig };
   const { logger } = config;
-  config.tmpDir = tmp.dirSync({ unsafeCleanup: true });
-  config.errors = [];
-  config.warnings = [];
-  logger.trace({ config }, 'renovateRepository');
-  try {
-    let branchList;
-    let baseBranchUpdated;
-    let loopCount = 1;
-    do {
-      logger.debug(`renovateRepository loop ${loopCount}`);
-      baseBranchUpdated = false;
+  // istanbul ignore if
+  if (count > 5) {
+    // This is an arbitrary number added in to cut short any unintended infinite recursion
+    throw new Error('Existing renovateRepositoryInner after 5 loops');
+  }
+  logger.info(`renovateRepository loop ${count}`);
+  let branchList = [];
   config = await apis.initApis(config, token);
   config = await apis.mergeRenovateJson(config);
   if (config.enabled === false) {
     logger.debug('repository is disabled');
     await cleanup.pruneStaleBranches(config, []);
-        return;
+    return null;
   }
   if (config.isFork && !config.renovateJsonPresent) {
     logger.debug('repository is a fork and not manually configured');
-        return;
+    return null;
   }
   if (config.baseBranch) {
     // Renovate should read content and target PRs here
@@ -86,11 +82,14 @@ async function renovateRepository(repoConfig, token) {
           throw new Error('no package files');
         }
       }
-          return;
+      return null;
     }
-        logger.debug(
-          `Detected ${config.packageFiles
-            .length} package files: ${config.packageFiles}`
+    logger.info(
+      {
+        packageFiles: config.packageFiles,
+        count: config.packageFiles.length,
+      },
+      `Detected package files`
     );
   }
   logger.debug('Resolving package files and content');
@@ -113,6 +112,7 @@ async function renovateRepository(repoConfig, token) {
     // eslint-disable-next-line no-loop-function
     branchUpgrades.sort(pinDependenciesFirst);
     const branchStartTime = process.hrtime();
+    branchList = branchUpgrades.map(upgrade => upgrade.branchName);
     for (const branchUpgrade of branchUpgrades) {
       const branchResult = await branchWorker.processBranch(
         branchUpgrade,
@@ -122,32 +122,42 @@ async function renovateRepository(repoConfig, token) {
       if (branchResult === 'automerged') {
         // Stop procesing other branches because base branch has been changed by an automerge
         logger.info('Restarting repo renovation after automerge');
-            baseBranchUpdated = true;
-            break;
+        return renovateRepositoryInner(repoConfig, token, count + 1);
       } else if (branchResult === 'lockFileError') {
         logger.info('Lock file error - stopping branch updates');
-            break;
+        return branchList;
       } else if (branchUpgrade.type === 'pin') {
         logger.info(
           'Stopping branch processing until Pin Dependencies is merged'
         );
-            break;
+        return branchList;
       }
     }
     logger.info(
       { seconds: convertHrTime(process.hrtime(branchStartTime)).seconds },
       'Finished updating branches'
     );
-        branchList = branchUpgrades.map(upgrade => upgrade.branchName);
-        logger.debug(`branchList=${branchList}`);
   } else {
     await onboarding.ensurePr(config, branchUpgrades);
     logger.info('"Configure Renovate" PR needs to be closed first');
     branchList = [`${config.branchPrefix}configure`];
   }
-      loopCount += 1;
-    } while (baseBranchUpdated);
+  logger.debug(`branchList=${branchList}`);
+  return branchList;
+}
+
+async function renovateRepository(repoConfig, token) {
+  const config = { ...repoConfig };
+  const { logger } = config;
+  logger.trace({ config }, 'renovateRepository');
+  config.tmpDir = tmp.dirSync({ unsafeCleanup: true });
+  config.errors = [];
+  config.warnings = [];
+  try {
+    const branchList = await renovateRepositoryInner(config, token);
+    if (branchList) {
       await cleanup.pruneStaleBranches(config, branchList);
+    }
   } catch (err) {
     // Swallow this error so that other repositories can be processed
     if (err.message === 'uninitiated') {