Merge pull request #3111 from scala-steward-org/reload-pr-body

Ensure PR bodies and titles are recreated when updating PRs

Author: alejandrohdezma

modules/core/src/main/scala/org/scalasteward/core/forge/ForgeApiAlg.scala

@@ -27,6 +27,8 @@ trait ForgeApiAlg[F[_]] {
 
   def createPullRequest(repo: Repo, data: NewPullRequestData): F[PullRequestOut]
 
+  def updatePullRequest(number: PullRequestNumber, repo: Repo, data: NewPullRequestData): F[Unit]
+
   def closePullRequest(repo: Repo, number: PullRequestNumber): F[PullRequestOut]
 
   def getBranch(repo: Repo, branch: Branch): F[BranchOut]

modules/core/src/main/scala/org/scalasteward/core/forge/azurerepos/AzureReposApiAlg.scala

@@ -54,6 +54,13 @@ final class AzureReposApiAlg[F[_]](
     } yield pullRequestOut
   }
 
+  override def updatePullRequest(
+      number: PullRequestNumber,
+      repo: Repo,
+      data: NewPullRequestData
+  ): F[Unit] =
+    logger.warn("Updating PRs is not yet supported for Azure Repos")
+
   // https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull-requests/update?view=azure-devops-rest-7.1
   override def closePullRequest(repo: Repo, number: PullRequestNumber): F[PullRequestOut] =
     client.patchWithBody[PullRequestOut, ClosePullRequestPayload](

modules/core/src/main/scala/org/scalasteward/core/forge/bitbucket/BitbucketApiAlg.scala

@@ -97,6 +97,13 @@ class BitbucketApiAlg[F[_]](
     } yield pullRequestOut
   }
 
+  override def updatePullRequest(
+      number: PullRequestNumber,
+      repo: Repo,
+      data: NewPullRequestData
+  ): F[Unit] =
+    logger.warn("Updating PRs is not yet supported for Bitbucket")
+
   override def getBranch(repo: Repo, branch: Branch): F[BranchOut] =
     client.get(url.branch(repo, branch), modify(repo))
 

modules/core/src/main/scala/org/scalasteward/core/forge/bitbucketserver/BitbucketServerApiAlg.scala

@@ -86,6 +86,13 @@ final class BitbucketServerApiAlg[F[_]](
     } yield pr.toPullRequestOut
   }
 
+  override def updatePullRequest(
+      number: PullRequestNumber,
+      repo: Repo,
+      data: NewPullRequestData
+  ): F[Unit] =
+    logger.warn("Updating PRs is not yet supported for Bitbucket Server")
+
   private def useDefaultReviewers(repo: Repo): F[List[Reviewer]] =
     if (config.useDefaultReviewers) getDefaultReviewers(repo) else F.pure(List.empty[Reviewer])
 

modules/core/src/main/scala/org/scalasteward/core/forge/gitea/GiteaApiAlg.scala

@@ -186,6 +186,13 @@ final class GiteaApiAlg[F[_]: HttpJsonClient](
         )
     } yield pullRequestOut(resp)
 
+  override def updatePullRequest(
+      number: PullRequestNumber,
+      repo: Repo,
+      data: NewPullRequestData
+  ): F[Unit] =
+    logger.warn("Updating PRs is not yet supported for Gitea")
+
   override def closePullRequest(repo: Repo, number: PullRequestNumber): F[PullRequestOut] = {
     val edit = EditPullRequestOption(state = "closed")
     client

modules/core/src/main/scala/org/scalasteward/core/forge/github/PullRequestPayload.scala renamed to modules/core/src/main/scala/org/scalasteward/core/forge/github/CreatePullRequestPayload.scala

@@ -21,18 +21,18 @@ import io.circe.generic.semiauto.deriveEncoder
 import org.scalasteward.core.forge.data.NewPullRequestData
 import org.scalasteward.core.git.Branch
 
-final case class PullRequestPayload(
+final case class CreatePullRequestPayload(
     title: String,
     body: String,
     head: String,
     base: Branch,
     draft: Boolean
 )
-object PullRequestPayload {
-  implicit val encoder: Encoder[PullRequestPayload] = deriveEncoder
+object CreatePullRequestPayload {
+  implicit val encoder: Encoder[CreatePullRequestPayload] = deriveEncoder
 
-  def from(newPullRequestData: NewPullRequestData): PullRequestPayload =
-    PullRequestPayload(
+  def from(newPullRequestData: NewPullRequestData): CreatePullRequestPayload =
+    CreatePullRequestPayload(
       title = newPullRequestData.title,
       body = newPullRequestData.body,
       head = newPullRequestData.head,

modules/core/src/main/scala/org/scalasteward/core/forge/github/GitHubApiAlg.scala

@@ -38,17 +38,21 @@ final class GitHubApiAlg[F[_]](
 ) extends ForgeApiAlg[F] {
   private val url = new Url(gitHubApiHost)
 
-  /** https://developer.github.com/v3/repos/forks/#create-a-fork */
+  /** https://docs.github.com/en/rest/repos/forks?apiVersion=2022-11-28#create-a-fork */
   override def createFork(repo: Repo): F[RepoOut] =
     client.post[RepoOut](url.forks(repo), modify(repo)).flatTap { repoOut =>
       F.raiseWhen(repoOut.parent.exists(_.archived))(RepositoryArchived(repo))
     }
 
-  /** https://developer.github.com/v3/pulls/#create-a-pull-request */
+  /** https://docs.github.com/en/rest/pulls?apiVersion=2022-11-28#create-a-pull-request */
   override def createPullRequest(repo: Repo, data: NewPullRequestData): F[PullRequestOut] = {
-    val payload = PullRequestPayload.from(data)
+    val payload = CreatePullRequestPayload.from(data)
     val create = client
-      .postWithBody[PullRequestOut, PullRequestPayload](url.pulls(repo), payload, modify(repo))
+      .postWithBody[PullRequestOut, CreatePullRequestPayload](
+        uri = url.pulls(repo),
+        body = payload,
+        modify = modify(repo)
+      )
       .adaptErr(SecondaryRateLimitExceeded.fromThrowable)
 
     for {
@@ -61,29 +65,53 @@ final class GitHubApiAlg[F[_]](
     } yield pullRequestOut
   }
 
-  /** https://developer.github.com/v3/repos/branches/#get-branch */
+  /** https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#update-a-pull-request */
+  override def updatePullRequest(
+      number: PullRequestNumber,
+      repo: Repo,
+      data: NewPullRequestData
+  ): F[Unit] = {
+    val payload = UpdatePullRequestPayload.from(data)
+
+    val update = client
+      .patchWithBody[PullRequestOut, UpdatePullRequestPayload](
+        uri = url.pull(repo, number),
+        body = payload,
+        modify = modify(repo)
+      )
+      .adaptErr(SecondaryRateLimitExceeded.fromThrowable)
+
+    for {
+      _ <- update
+      _ <- F.whenA(data.labels.nonEmpty)(labelPullRequest(repo, number, data.labels))
+      _ <- F.whenA(data.assignees.nonEmpty)(addAssignees(repo, number, data.assignees))
+      _ <- F.whenA(data.reviewers.nonEmpty)(addReviewers(repo, number, data.reviewers))
+    } yield ()
+  }
+
+  /** https://docs.github.com/en/rest/repos/branches?apiVersion=2022-11-28#get-branch */
   override def getBranch(repo: Repo, branch: Branch): F[BranchOut] =
     client.get(url.branches(repo, branch), modify(repo))
 
-  /** https://developer.github.com/v3/repos/#get */
+  /** https://docs.github.com/en/rest/repos?apiVersion=2022-11-28#get */
   override def getRepo(repo: Repo): F[RepoOut] =
     client.get[RepoOut](url.repos(repo), modify(repo)).flatTap { repoOut =>
       F.raiseWhen(repoOut.archived)(RepositoryArchived(repo))
     }
 
-  /** https://developer.github.com/v3/pulls/#list-pull-requests */
+  /** https://docs.github.com/en/rest/pulls?apiVersion=2022-11-28#list-pull-requests */
   override def listPullRequests(repo: Repo, head: String, base: Branch): F[List[PullRequestOut]] =
     client.get(url.listPullRequests(repo, head, base), modify(repo))
 
-  /** https://developer.github.com/v3/pulls/#update-a-pull-request */
+  /** https://docs.github.com/en/rest/pulls?apiVersion=2022-11-28#update-a-pull-request */
   override def closePullRequest(repo: Repo, number: PullRequestNumber): F[PullRequestOut] =
     client.patchWithBody[PullRequestOut, UpdateState](
       url.pull(repo, number),
       UpdateState(PullRequestState.Closed),
       modify(repo)
     )
 
-  /** https://developer.github.com/v3/issues#create-an-issue-comment */
+  /** https://docs.github.com/en/rest/issues?apiVersion=2022-11-28#create-an-issue-comment */
   override def commentPullRequest(
       repo: Repo,
       number: PullRequestNumber,
@@ -92,7 +120,8 @@ final class GitHubApiAlg[F[_]](
     client
       .postWithBody(url.comments(repo, number), Comment(comment), modify(repo))
 
-  /** https://docs.github.com/en/rest/reference/issues#add-labels-to-an-issue */
+  /** https://docs.github.com/en/rest/reference/issues?apiVersion=2022-11-28#add-labels-to-an-issue
+    */
   private def labelPullRequest(
       repo: Repo,
       number: PullRequestNumber,

modules/core/src/main/scala/org/scalasteward/core/forge/github/UpdatePullRequestPayload.scala

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2018-2023 Scala Steward contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.scalasteward.core.forge.github
+
+import io.circe.Encoder
+import io.circe.generic.semiauto.deriveEncoder
+import org.scalasteward.core.forge.data.NewPullRequestData
+
+final case class UpdatePullRequestPayload(
+    title: String,
+    body: String
+)
+object UpdatePullRequestPayload {
+  implicit val encoder: Encoder[UpdatePullRequestPayload] = deriveEncoder
+
+  def from(newPullRequestData: NewPullRequestData): UpdatePullRequestPayload =
+    UpdatePullRequestPayload(
+      title = newPullRequestData.title,
+      body = newPullRequestData.body
+    )
+}

modules/core/src/main/scala/org/scalasteward/core/forge/gitlab/GitLabApiAlg.scala

@@ -248,6 +248,13 @@ final class GitLabApiAlg[F[_]: Parallel](
     updatedMergeRequest.map(_.pullRequestOut)
   }
 
+  override def updatePullRequest(
+      number: PullRequestNumber,
+      repo: Repo,
+      data: NewPullRequestData
+  ): F[Unit] =
+    logger.warn("Updating PRs is not yet supported for GitLab")
+
   private def mergePipelineUponSuccess(repo: Repo, mr: MergeRequestOut): F[MergeRequestOut] =
     mr match {
       case mr if mr.mergeStatus === GitLabMergeStatus.CanBeMerged =>

modules/core/src/main/scala/org/scalasteward/core/nurture/NurtureAlg.scala

@@ -17,7 +17,7 @@
 package org.scalasteward.core.nurture
 
 import cats.effect.Concurrent
-import cats.implicits._
+import cats.syntax.all._
 import cats.{Applicative, Id}
 import org.scalasteward.core.application.Config.ForgeCfg
 import org.scalasteward.core.coursier.CoursierAlg
@@ -99,7 +99,7 @@ final class NurtureAlg[F[_]](config: ForgeCfg)(implicit
           logger.info(s"PR ${pr.html_url} is closed") >>
             deleteRemoteBranch(data.repo, data.updateBranch).as(Ignored)
         case Some(pr) if !pr.state.isClosed =>
-          logger.info(s"Found PR ${pr.html_url}") >> updatePullRequest(data)
+          logger.info(s"Found PR ${pr.html_url}") >> updatePullRequest(data, pr.number)
         case _ =>
           applyNewUpdate(data).flatTap {
             case Created(newPrNumber) => closeObsoletePullRequests(data, newPrNumber)
@@ -262,14 +262,14 @@ final class NurtureAlg[F[_]](config: ForgeCfg)(implicit
       _ <- logger.info(s"Created PR ${pr.html_url}")
     } yield Created(pr.number)
 
-  private def updatePullRequest(data: UpdateData): F[ProcessResult] =
+  private def updatePullRequest(data: UpdateData, number: PullRequestNumber): F[ProcessResult] =
     if (data.repoConfig.updatePullRequestsOrDefault =!= PullRequestUpdateStrategy.Never)
       gitAlg.returnToCurrentBranch(data.repo) {
-        for {
-          _ <- gitAlg.checkoutBranch(data.repo, data.updateBranch)
-          update <- shouldBeUpdated(data)
-          result <- if (update) mergeAndApplyAgain(data) else F.pure[ProcessResult](Ignored)
-        } yield result
+        gitAlg.checkoutBranch(data.repo, data.updateBranch) >>
+          shouldBeUpdated(data).ifM(
+            ifTrue = mergeAndApplyAgain(number, data),
+            ifFalse = (Ignored: ProcessResult).pure
+          )
       }
     else
       logger.info("PR updates are disabled by flag").as(Ignored)
@@ -293,7 +293,7 @@ final class NurtureAlg[F[_]](config: ForgeCfg)(implicit
     result.flatMap { case (update, msg) => logger.info(msg).as(update) }
   }
 
-  private def mergeAndApplyAgain(data: UpdateData): F[ProcessResult] =
+  private def mergeAndApplyAgain(number: PullRequestNumber, data: UpdateData): F[ProcessResult] =
     for {
       _ <- logger.info(
         s"Merge branch ${data.baseBranch.name} into ${data.updateBranch.name} and apply again"
@@ -307,6 +307,8 @@ final class NurtureAlg[F[_]](config: ForgeCfg)(implicit
       editCommits = edits.flatMap(_.commits)
       commits = maybeRevertCommit.toList ++ maybeMergeCommit.toList ++ editCommits
       result <- pushCommits(data, commits)
+      requestData <- preparePullRequest(data, edits)
+      _ <- forgeApiAlg.updatePullRequest(number: PullRequestNumber, data.repo, requestData)
     } yield result
 
 }