fix(platform): compare target refs before updating (#23094)

renovatebot · Jul 4, 2023 · 1700467 · 1700467
1 parent 3b6ffa9
commit 1700467
Show file tree

Hide file tree

Showing 7 changed files with 62 additions and 49 deletions.
diff --git a/lib/modules/platform/azure/__snapshots__/index.spec.ts.snap b/lib/modules/platform/azure/__snapshots__/index.spec.ts.snap
@@ -280,7 +280,6 @@ exports[`modules/platform/azure/index updatePr(prNo, title, body, platformOption
     {
       "description": "Hello world again",
       "status": 2,
-      "targetRefName": undefined,
       "title": "The New Title",
     },
     "1",
@@ -303,7 +302,6 @@ exports[`modules/platform/azure/index updatePr(prNo, title, body, platformOption
   [
     {
       "description": "Hello world again",
-      "targetRefName": undefined,
       "title": "The New Title",
     },
     "1",
@@ -330,7 +328,6 @@ exports[`modules/platform/azure/index updatePr(prNo, title, body, platformOption
 [
   [
     {
-      "targetRefName": undefined,
       "title": "The New Title - autoclose",
     },
     "1",

diff --git a/lib/modules/platform/azure/index.ts b/lib/modules/platform/azure/index.ts
@@ -521,9 +521,12 @@ export async function updatePr({
   const azureApiGit = await azureApi.gitApi();
   const objToUpdate: GitPullRequest = {
     title,
-    targetRefName: getNewBranchName(targetBranch),
   };
 
+  if (targetBranch) {
+    objToUpdate.targetRefName = getNewBranchName(targetBranch);
+  }
+
   if (body) {
     objToUpdate.description = max4000Chars(sanitize(body));
   }

diff --git a/lib/modules/platform/bitbucket-server/index.ts b/lib/modules/platform/bitbucket-server/index.ts
@@ -864,26 +864,26 @@ export async function updatePr({
       throw Object.assign(new Error(REPOSITORY_NOT_FOUND), { statusCode: 404 });
     }
 
+    const body: any = {
+      title,
+      description,
+      version: pr.version,
+      reviewers: pr.reviewers
+        ?.filter((name: string) => !bitbucketInvalidReviewers?.includes(name))
+        .map((name: string) => ({ user: { name } })),
+    };
+    if (targetBranch) {
+      body.toRef = {
+        id: getNewBranchName(targetBranch),
+      };
+    }
+
     const { body: updatedPr } = await bitbucketServerHttp.putJson<{
       version: number;
       state: string;
     }>(
       `./rest/api/1.0/projects/${config.projectKey}/repos/${config.repositorySlug}/pull-requests/${prNo}`,
-      {
-        body: {
-          title,
-          description,
-          version: pr.version,
-          reviewers: pr.reviewers
-            ?.filter(
-              (name: string) => !bitbucketInvalidReviewers?.includes(name)
-            )
-            .map((name: string) => ({ user: { name } })),
-          toRef: {
-            id: getNewBranchName(targetBranch),
-          },
-        },
-      }
+      { body }
     );
 
     updatePrVersion(prNo, updatedPr.version);

diff --git a/lib/modules/platform/bitbucket/index.ts b/lib/modules/platform/bitbucket/index.ts
@@ -945,20 +945,22 @@ export async function updatePr({
   ).body;
 
   try {
+    const body: any = {
+      title,
+      description: sanitize(description),
+      reviewers: pr.reviewers,
+    };
+    if (targetBranch) {
+      body.destination = {
+        branch: {
+          name: targetBranch,
+        },
+      };
+    }
+
     await bitbucketHttp.putJson(
       `/2.0/repositories/${config.repository}/pullrequests/${prNo}`,
-      {
-        body: {
-          title,
-          description: sanitize(description),
-          reviewers: pr.reviewers,
-          destination: {
-            branch: {
-              name: targetBranch,
-            },
-          },
-        },
-      }
+      { body }
     );
   } catch (err) {
     // Try sanitizing reviewers

diff --git a/lib/modules/platform/gitea/index.ts b/lib/modules/platform/gitea/index.ts
@@ -43,6 +43,7 @@ import type {
   Label,
   PR,
   PRMergeMethod,
+  PRUpdateParams,
   Repo,
   RepoSortMethod,
   SortMethod,
@@ -629,12 +630,16 @@ const platform: Platform = {
       title = DRAFT_PREFIX + title;
     }
 
-    await helper.updatePR(config.repository, number, {
+    const prUpdateParams: PRUpdateParams = {
       title,
-      base: targetBranch,
       ...(body && { body }),
       ...(state && { state }),
-    });
+    };
+    if (targetBranch) {
+      prUpdateParams.base = targetBranch;
+    }
+
+    await helper.updatePR(config.repository, number, prUpdateParams);
   },
 
   async mergePr({ id, strategy }: MergePRConfig): Promise<boolean> {

diff --git a/lib/modules/platform/gitlab/index.ts b/lib/modules/platform/gitlab/index.ts
@@ -712,16 +712,19 @@ export async function updatePr({
     ['open']: 'reopen',
     // TODO: null check (#7154)
   }[state!];
+
+  const body: any = {
+    title,
+    description: sanitize(description),
+    ...(newState && { state_event: newState }),
+  };
+  if (targetBranch) {
+    body.target_branch = targetBranch;
+  }
+
   await gitlabApi.putJson(
     `projects/${config.repository}/merge_requests/${iid}`,
-    {
-      body: {
-        title,
-        description: sanitize(description),
-        ...(newState && { state_event: newState }),
-        target_branch: targetBranch,
-      },
-    }
+    { body }
   );
 
   await tryPrAutomerge(iid, platformOptions);

diff --git a/lib/workers/repository/update/pr/index.ts b/lib/workers/repository/update/pr/index.ts
@@ -12,6 +12,7 @@ import {
   PlatformPrOptions,
   Pr,
   PrDebugData,
+  UpdatePrConfig,
   platform,
 } from '../../../../modules/platform';
 import { ensureComment } from '../../../../modules/platform/comment';
@@ -357,6 +358,13 @@ export async function ensurePr(
         );
         return { type: 'with-pr', pr: existingPr };
       }
+
+      const updatePrConfig: UpdatePrConfig = {
+        number: existingPr.number,
+        prTitle,
+        prBody,
+        platformOptions: getPlatformPrOptions(config),
+      };
       // PR must need updating
       if (existingPr?.targetBranch !== config.baseBranch) {
         logger.debug(
@@ -367,6 +375,7 @@ export async function ensurePr(
           },
           'PR base branch has changed'
         );
+        updatePrConfig.targetBranch = config.baseBranch;
       }
       if (existingPrTitle !== newPrTitle) {
         logger.debug(
@@ -390,13 +399,7 @@ export async function ensurePr(
         logger.info(`DRY-RUN: Would update PR #${existingPr.number}`);
         return { type: 'with-pr', pr: existingPr };
       } else {
-        await platform.updatePr({
-          number: existingPr.number,
-          prTitle,
-          prBody,
-          platformOptions: getPlatformPrOptions(config),
-          targetBranch: config.baseBranch,
-        });
+        await platform.updatePr(updatePrConfig);
         logger.info({ pr: existingPr.number, prTitle }, `PR updated`);
         setPrCache(branchName, prBodyFingerprint, true);
       }