renovate 44.198.2 → 44.199.0

package/dist/workers/repository/update/branch/index.js

@@ -1,61 +1,39 @@
-import { MANAGER_LOCKFILE_ERROR, PLATFORM_AUTHENTICATION_ERROR, PLATFORM_BAD_CREDENTIALS, REPOSITORY_CHANGED, SYSTEM_INSUFFICIENT_DISK_SPACE } from "../../../../constants/error-messages.js";
+import { MANAGER_LOCKFILE_ERROR, REPOSITORY_CHANGED } from "../../../../constants/error-messages.js";
 import { GlobalConfig } from "../../../../config/global.js";
 import { coerceArray } from "../../../../util/array.js";
 import { logger, removeMeta } from "../../../../logger/index.js";
-import { withoutUrlCredentials } from "../../../../util/url.js";
 import { compile } from "../../../../util/template/index.js";
-import { filterValidCommitTrailers } from "../../../../util/git/commit-trailers.js";
 import { isScheduledNow } from "./schedule.js";
 import { ExternalHostError } from "../../../../types/errors/external-host-error.js";
 import { getCount, isLimitReached } from "../../../global/limits.js";
-import { getElapsedMs } from "../../../../util/date.js";
 import { emojify } from "../../../../util/emoji.js";
 import { scm } from "../../../../modules/platform/scm.js";
-import { enforcesMinimumReleaseAge } from "../../../../modules/manager/index.js";
 import { platform } from "../../../../modules/platform/index.js";
+import { compileCommitBody, compileCommitTrailers } from "../../model/commit-body.js";
 import { ensureComment, ensureCommentRemoval } from "../../../../modules/platform/comment.js";
 import { embedChangelogs } from "../../changelog/index.js";
-import { getMergeConfidenceLevel, isActiveConfidenceLevel, satisfiesConfidenceLevel } from "../../../../util/merge-confidence/index.js";
-import { setConfidence, setStability } from "./status-checks.js";
+import { computeInternalChecksStatus, setConfidence, setStability } from "./status-checks.js";
 import { ensurePr, getPlatformPrOptions } from "../pr/index.js";
-import { calculateMinimumReleaseAgeMs } from "../../../../util/minimum-release-age.js";
 import { updateActionsLockfile } from "../../../../modules/manager/github-actions/artifacts.js";
 import { getAdditionalFiles } from "../../../../modules/manager/npm/post-update/index.js";
 import { checkAutoMerge } from "../pr/automerge.js";
 import { setArtifactErrorStatus } from "./artifacts.js";
 import { tryBranchAutomerge } from "./automerge.js";
 import { bumpVersions } from "./bump-versions.js";
-import { prAlreadyExisted } from "./check-existing.js";
+import { findClosedPrForModifiedBranch, prAlreadyExisted, rebaseCheck, userChangedTargetBranch } from "./check-existing.js";
 import { commitFilesToBranch } from "./commit.js";
+import { handleBranchError } from "./errors.js";
 import executePostUpgradeCommands from "./execute-post-upgrade-commands.js";
 import { getUpdatedPackageFiles } from "./get-updated.js";
 import { handleClosedPr, handleModifiedPr } from "./handle-existing.js";
-import { shouldReuseExistingBranch } from "./reuse.js";
-import { isNonEmptyString } from "@sindresorhus/is";
+import { prBlockedByToResult } from "./pr-blocked-by.js";
+import { decideBranchReuse, hasKeepUpdatedLabel, shouldReuseExistingBranch } from "./reuse.js";
 import { DateTime } from "luxon";
 //#region lib/workers/repository/update/branch/index.ts
 async function setBranchStatusChecks(config) {
 	await setStability(config);
 	await setConfidence(config);
 }
-async function rebaseCheck(config, branchPr) {
-	if (branchPr.title?.startsWith("rebase!")) {
-		logger.debug(`Manual rebase requested via PR title for #${branchPr.number}`);
-		return true;
-	}
-	if (!!branchPr.labels?.includes(config.rebaseLabel)) {
-		logger.debug(`Manual rebase requested via PR labels for #${branchPr.number}`);
-		/* v8 ignore next -- needs test */
-		if (GlobalConfig.get("dryRun")) logger.info(`DRY-RUN: Would delete label ${config.rebaseLabel} from #${branchPr.number}`);
-		else await platform.deleteLabel(branchPr.number, config.rebaseLabel);
-		return true;
-	}
-	if (!!branchPr.bodyStruct?.rebaseRequested) {
-		logger.debug(`Manual rebase requested via PR checkbox for #${branchPr.number}`);
-		return true;
-	}
-	return false;
-}
 async function deleteBranchSilently(branchName) {
 	try {
 		await scm.deleteBranch(branchName);
@@ -67,22 +45,6 @@ async function deleteBranchSilently(branchName) {
 		}, "Branch auto-remove failed");
 	}
 }
-/**
-* The minimum release age which Renovate has to check for `upgrade`, which is
-* `0` for lock file maintenance if the package manager enforces it itself.
-*/
-async function getMinimumReleaseAgeMsToCheck(upgrade) {
-	const minimumReleaseAgeMs = calculateMinimumReleaseAgeMs(upgrade);
-	if (!minimumReleaseAgeMs || !upgrade.isLockFileMaintenance) return minimumReleaseAgeMs;
-	if (!await enforcesMinimumReleaseAge(upgrade.manager, upgrade)) return minimumReleaseAgeMs;
-	logger.debug(`Lock file maintenance of ${upgrade.packageFile}: the package manager enforces the minimum release age`);
-	return 0;
-}
-function userChangedTargetBranch(pr) {
-	const oldTargetBranch = pr.bodyStruct?.debugData?.targetBranch;
-	if (oldTargetBranch && pr.targetBranch) return pr.targetBranch !== oldTargetBranch;
-	return false;
-}
 async function processBranch(branchConfig, forceRebase = false) {
 	let commitSha = null;
 	let config = { ...branchConfig };
@@ -114,7 +76,6 @@ async function processBranch(branchConfig, forceRebase = false) {
 		config.rebaseRequested = await rebaseCheck(config, branchPr);
 		logger.debug(`PR rebase requested=${config.rebaseRequested}`);
 	}
-	const keepUpdatedLabel = config.keepUpdatedLabel;
 	const pendingRebaseTopic = emojify(":warning: Rebase not applied");
 	const artifactErrorTopic = emojify(":warning: Artifact update problem");
 	const artifactNoticeTopic = emojify(":information_source: Artifact update notice");
@@ -230,38 +191,10 @@ async function processBranch(branchConfig, forceRebase = false) {
 						result: "pr-edited"
 					};
 				}
-			} else if (branchIsModified && !dependencyDashboardCheck) {
-				const oldPr = await platform.findPr({
-					branchName: config.branchName,
-					state: "!open",
-					targetBranch: config.baseBranch
-				});
-				if (!oldPr) {
-					logger.debug("Branch has been edited but found no PR - skipping");
-					return {
-						branchExists,
-						result: "pr-edited"
-					};
-				}
-				const branchSha = await scm.getBranchCommit(config.branchName);
-				const oldPrSha = oldPr?.sha;
-				if (!oldPrSha || oldPrSha === branchSha) logger.debug({
-					oldPrNumber: oldPr.number,
-					oldPrSha,
-					branchSha
-				}, "Found old PR matching this branch - will override it");
-				else {
-					logger.debug({
-						oldPrNumber: oldPr.number,
-						oldPrSha,
-						branchSha
-					}, "Found old PR but the SHA is different");
-					return {
-						branchExists,
-						result: "pr-edited"
-					};
-				}
-			}
+			} else if (branchIsModified && !dependencyDashboardCheck && !await findClosedPrForModifiedBranch(config)) return {
+				branchExists,
+				result: "pr-edited"
+			};
 		}
 		config.isScheduledNow = isScheduledNow(config, "schedule");
 		if (!config.isScheduledNow && !dependencyDashboardCheck) {
@@ -289,65 +222,10 @@ async function processBranch(branchConfig, forceRebase = false) {
 			}
 			logger.debug("Branch + PR exists but is not scheduled -- will update if necessary");
 		}
-		if (config.upgrades.some((upgrade) => isNonEmptyString(upgrade.minimumReleaseAge) || isNonEmptyString(upgrade.minimumReleaseAgeExtracted) || isActiveConfidenceLevel(upgrade.minimumConfidence))) {
-			const depNamesWithoutReleaseTimestamp = {
-				"timestamp-required": [],
-				"timestamp-optional": []
-			};
-			config.stabilityStatus = "green";
-			for (const upgrade of config.upgrades) {
-				const minimumReleaseAgeMs = await getMinimumReleaseAgeMsToCheck(upgrade);
-				if (minimumReleaseAgeMs) {
-					const minimumReleaseAgeBehaviour = upgrade.minimumReleaseAgeBehaviour ?? "timestamp-required";
-					if (upgrade.releaseTimestamp) {
-						const timeElapsed = getElapsedMs(upgrade.releaseTimestamp);
-						if (timeElapsed < minimumReleaseAgeMs) {
-							logger.debug({
-								depName: upgrade.depName,
-								timeElapsed,
-								minimumReleaseAge: upgrade.minimumReleaseAge
-							}, "Update has not passed minimum release age");
-							config.stabilityStatus = "yellow";
-							continue;
-						}
-					} else if (minimumReleaseAgeBehaviour === "timestamp-required") {
-						depNamesWithoutReleaseTimestamp["timestamp-required"].push({
-							depName: upgrade.depName,
-							updateType: upgrade.updateType
-						});
-						config.stabilityStatus = "yellow";
-						continue;
-					} else depNamesWithoutReleaseTimestamp["timestamp-optional"].push({
-						depName: upgrade.depName,
-						updateType: upgrade.updateType
-					});
-				}
-				const datasource = upgrade.datasource;
-				const depName = upgrade.depName;
-				const packageName = upgrade.packageName;
-				const minimumConfidence = upgrade.minimumConfidence;
-				const updateType = upgrade.updateType;
-				const currentVersion = upgrade.currentVersion;
-				const newVersion = upgrade.newVersion;
-				if (isActiveConfidenceLevel(minimumConfidence)) {
-					const confidence = await getMergeConfidenceLevel(datasource, packageName, currentVersion, newVersion, updateType) ?? "neutral";
-					if (satisfiesConfidenceLevel(confidence, minimumConfidence)) config.confidenceStatus = "green";
-					else {
-						logger.debug({
-							depName,
-							confidence,
-							minimumConfidence
-						}, "Update does not meet minimum confidence scores");
-						config.confidenceStatus = "yellow";
-						continue;
-					}
-				}
-			}
-			if (depNamesWithoutReleaseTimestamp["timestamp-required"].length) logger.once.debug({ updates: depNamesWithoutReleaseTimestamp["timestamp-required"] }, `Marking ${depNamesWithoutReleaseTimestamp["timestamp-required"].length} release(s) as pending, as they do not have a releaseTimestamp and we're running with minimumReleaseAgeBehaviour=timestamp-required`);
-			if (depNamesWithoutReleaseTimestamp["timestamp-optional"].length) {
-				logger.once.warn("Some upgrade(s) did not have a releaseTimestamp, but as we're running with minimumReleaseAgeBehaviour=timestamp-optional, proceeding. See debug logs for more information");
-				logger.once.debug({ updates: depNamesWithoutReleaseTimestamp["timestamp-optional"] }, `${depNamesWithoutReleaseTimestamp["timestamp-optional"].length} upgrade(s) did not have a releaseTimestamp, but as we're running with minimumReleaseAgeBehaviour=timestamp-optional, proceeding`);
-			}
+		const internalChecksStatus = await computeInternalChecksStatus(config);
+		if (internalChecksStatus) {
+			config.stabilityStatus = internalChecksStatus.stabilityStatus;
+			config.confidenceStatus = internalChecksStatus.confidenceStatus;
 			if (!dependencyDashboardCheck && !branchExists && config.stabilityStatus === "yellow" && ["not-pending", "status-success"].includes(config.prCreation)) {
 				logger.debug("Skipping branch creation due to internal status checks not met");
 				return {
@@ -356,37 +234,21 @@ async function processBranch(branchConfig, forceRebase = false) {
 				};
 			}
 		}
-		let userRebaseRequested = dependencyDashboardCheck === "rebase" || !!config.dependencyDashboardRebaseAllOpen || !!config.rebaseRequested;
-		const userApproveAllPendingPR = !!config.dependencyDashboardAllPending;
-		const userOpenAllRateLimtedPR = !!config.dependencyDashboardAllRateLimited;
-		const userOpenAllSchedulePendingPR = !!config.dependencyDashboardAllAwaitingSchedule;
-		if (forceRebase) {
-			logger.debug("Force rebase because branch needs updating");
-			config.reuseExistingBranch = false;
-		} else if (userRebaseRequested) {
-			logger.debug("User has requested rebase");
-			config.reuseExistingBranch = false;
-		} else if (dependencyDashboardCheck === "global-config") {
-			logger.debug(`Manual create/rebase requested via checkedBranches`);
-			config.reuseExistingBranch = false;
-			userRebaseRequested = true;
-		} else if (userApproveAllPendingPR) logger.debug("A user manually approved all pending PRs via the Dependency Dashboard.");
-		else if (userOpenAllRateLimtedPR) logger.debug("A user manually approved all rate-limited PRs via the Dependency Dashboard.");
-		else if (userOpenAllSchedulePendingPR) logger.debug("A user manually requested all awaiting schedule PRs via the Dependency Dashboard.");
-		else if (branchExists && config.rebaseWhen === "never" && !(keepUpdatedLabel && branchPr?.labels?.includes(keepUpdatedLabel)) && !dependencyDashboardCheck) {
-			logger.debug("rebaseWhen=never so skipping branch update check");
-			return {
-				branchExists,
-				prNo: branchPr?.number,
-				result: "no-work"
-			};
-		} else if (branchPr?.targetBranch && branchPr.targetBranch !== config.baseBranch) {
-			logger.debug("Base branch changed by user, rebasing the branch onto new base");
-			config.reuseExistingBranch = false;
-		} else if (config.cacheFingerprintMatch === "no-match") {
-			logger.debug("Cache fingerprint does not match, cannot reuse existing branch");
-			config.reuseExistingBranch = false;
-		} else config = await shouldReuseExistingBranch(config);
+		const reuseDecision = decideBranchReuse({
+			config,
+			branchPr,
+			branchExists,
+			dependencyDashboardCheck,
+			forceRebase
+		});
+		const { userRebaseRequested } = reuseDecision;
+		if (reuseDecision.action === "skip-update") return {
+			branchExists,
+			prNo: branchPr?.number,
+			result: "no-work"
+		};
+		if (reuseDecision.action === "no-reuse") config.reuseExistingBranch = false;
+		else if (reuseDecision.action === "check-reuse") config = await shouldReuseExistingBranch(config, branchPr);
 		logger.debug(`Using reuseExistingBranch: ${config.reuseExistingBranch}`);
 		if (!(config.reuseExistingBranch && config.cacheFingerprintMatch === "matched")) {
 			await scm.checkoutBranch(config.baseBranch);
@@ -458,19 +320,12 @@ async function processBranch(branchConfig, forceRebase = false) {
 			const forcedManually = userRebaseRequested || !branchExists;
 			config.isConflicted ??= branchExists && await scm.isBranchConflicted(config.baseBranch, config.branchName);
 			config.forceCommit = forcedManually || config.isConflicted;
-			if (config.commitBody) {
-				const commitBody = compile(config.commitBody, {
-					...config,
-					logJSON: config.upgrades[0].logJSON,
-					releases: config.upgrades[0].releases
-				});
-				config.commitMessage = `${config.commitMessage}\n\n${withoutUrlCredentials(commitBody)}`;
-				logger.trace(`commitMessage: ${JSON.stringify(config.commitMessage)}`);
-			}
-			if (config.commitTrailers) {
-				config.commitTrailers = filterValidCommitTrailers(config.commitTrailers.map((trailer) => withoutUrlCredentials(compile(trailer, config))));
-				logger.trace(`commitTrailers: ${JSON.stringify(config.commitTrailers)}`);
-			}
+			config.commitMessage = compileCommitBody(config, config.commitMessage, {
+				...config,
+				logJSON: config.upgrades[0].logJSON,
+				releases: config.upgrades[0].releases
+			});
+			config.commitTrailers = compileCommitTrailers(config, config);
 			commitSha = await commitFilesToBranch(config);
 			await scm.checkoutBranch(config.baseBranch);
 			updatesVerified = true;
@@ -515,7 +370,7 @@ async function processBranch(branchConfig, forceRebase = false) {
 			};
 		}
 		if (!config.artifactErrors?.length && (!commitSha || config.ignoreTests)) {
-			const mergeStatus = await tryBranchAutomerge(config);
+			const mergeStatus = await tryBranchAutomerge(config, branchPr);
 			logger.debug(`mergeStatus=${mergeStatus}`);
 			if (mergeStatus === "automerged") {
 				if (GlobalConfig.get("dryRun")) logger.info(`DRY-RUN: Would delete branch${config.branchName}`);
@@ -539,7 +394,7 @@ async function processBranch(branchConfig, forceRebase = false) {
 			}
 			if (mergeStatus === "stale" && ["conflicted", "never"].includes(config.rebaseWhen) && 
 			/* v8 ignore next -- needs test */
-			!(keepUpdatedLabel && branchPr?.labels?.includes(keepUpdatedLabel))) {
+			!hasKeepUpdatedLabel(config, branchPr)) {
 				logger.warn("Branch cannot automerge because it is behind base branch and rebaseWhen setting disallows rebasing - raising a PR instead");
 				config.forcePr = true;
 				config.branchAutomergeFailureMessage = mergeStatus;
@@ -551,91 +406,12 @@ async function processBranch(branchConfig, forceRebase = false) {
 			}
 		}
 	} catch (err) {
-		/* v8 ignore if -- needs test */
-		if (err.statusCode === 404) {
-			logger.debug({ err }, "Received a 404 error - aborting run");
-			throw new Error(REPOSITORY_CHANGED);
-		}
-		/* v8 ignore if -- needs test */
-		if (err.message === "rate-limit-exceeded") {
-			logger.debug("Passing rate-limit-exceeded error up");
-			throw err;
-		}
-		if (err.message === "repository-changed") {
-			logger.debug("Passing repository-changed error up");
-			throw err;
-		}
-		/* v8 ignore if -- needs test */
-		if (err.message?.startsWith("remote: Invalid username or password")) {
-			logger.debug("Throwing bad credentials");
-			throw new Error(PLATFORM_BAD_CREDENTIALS);
-		}
-		/* v8 ignore if -- needs test */
-		if (err.message?.startsWith("ssh_exchange_identification: Connection closed by remote host")) {
-			logger.debug("Throwing bad credentials");
-			throw new Error(PLATFORM_BAD_CREDENTIALS);
-		}
-		/* v8 ignore if -- needs test */
-		if (err.message === "bad-credentials") {
-			logger.debug("Passing bad-credentials error up");
-			throw err;
-		}
-		/* v8 ignore if -- needs test */
-		if (err.message === "integration-unauthorized") {
-			logger.debug("Passing integration-unauthorized error up");
-			throw err;
-		}
-		if (err.message === "lockfile-error") {
-			logger.debug("Passing lockfile-error up");
-			throw err;
-		}
-		if (err.message === "pr-already-in-merge-queue") {
-			logger.debug("Branch PR is in the merge queue - skipping branch update");
-			return {
-				branchExists,
-				prNo: branchPr?.number,
-				result: "done",
-				commitSha
-			};
-		}
-		/* v8 ignore if -- needs test */
-		if (err.message?.includes("space left on device")) throw new Error(SYSTEM_INSUFFICIENT_DISK_SPACE);
-		/* v8 ignore if -- needs test */
-		if (err.message === "disk-space") {
-			logger.debug("Passing disk-space error up");
-			throw err;
-		}
-		/* v8 ignore if -- needs test */
-		if (err.message.startsWith("Resource not accessible by integration")) {
-			logger.debug("Passing 403 error up");
-			throw err;
-		}
-		/* v8 ignore next -- needs test */
-		if (err.message === "update-failure") logger.warn("Error updating branch: update failure");
-		else if (err.message.startsWith("bundler-")) return {
-			branchExists: true,
-			updatesVerified,
-			prNo: branchPr?.number,
-			result: "error",
-			commitSha
-		};
-		else if (err.message?.includes("fatal: Authentication failed")) throw new Error(PLATFORM_AUTHENTICATION_ERROR);
-		else if (err.message?.includes("fatal: bad revision")) {
-			logger.debug({ err }, "Aborting job due to bad revision error");
-			throw new Error(REPOSITORY_CHANGED);
-		} else if (err.message === "config-validation") {
-			logger.debug("Passing config validation error up");
-			throw err;
-		} else if (err.message === "temporary-error") {
-			logger.debug("Passing TEMPORARY_ERROR error up");
-			throw err;
-		} else if (!(err instanceof ExternalHostError)) logger.warn({ err }, `Error updating branch`);
-		return {
+		return handleBranchError(err, {
 			branchExists,
 			prNo: branchPr?.number,
-			result: "error",
-			commitSha
-		};
+			commitSha,
+			updatesVerified
+		});
 	}
 	try {
 		logger.debug("Ensuring PR");
@@ -643,45 +419,10 @@ async function processBranch(branchConfig, forceRebase = false) {
 		const ensurePrResult = await ensurePr(config);
 		if (ensurePrResult.type === "without-pr") {
 			const { prBlockedBy } = ensurePrResult;
-			branchPr = null;
-			if (prBlockedBy === "RateLimited" && !config.isVulnerabilityAlert) {
-				logger.debug("Reached PR limit - skipping PR creation");
-				return {
-					branchExists,
-					prBlockedBy,
-					result: "pr-limit-reached",
-					commitSha
-				};
-			}
-			if (prBlockedBy === "NeedsApproval") return {
-				branchExists,
-				prBlockedBy,
-				result: "needs-pr-approval",
-				commitSha
-			};
-			if (prBlockedBy === "AwaitingTests") return {
-				branchExists,
-				prBlockedBy,
-				result: "pending",
-				commitSha
-			};
-			if (prBlockedBy === "BranchAutomerge") return {
-				branchExists,
-				prBlockedBy,
-				result: "done",
-				commitSha
-			};
-			if (prBlockedBy === "Error") return {
-				branchExists,
-				prBlockedBy,
-				result: "error",
-				commitSha
-			};
-			logger.warn({ prBlockedBy }, "Unknown PrBlockedBy result");
 			return {
 				branchExists,
 				prBlockedBy,
-				result: "error",
+				result: prBlockedByToResult(prBlockedBy, config.isVulnerabilityAlert),
 				commitSha
 			};
 		}