feat: add update pull request command

Add command to update pull request title and body.

Author: KnisterPeter

src/command.ts

@@ -26,7 +26,7 @@ export abstract class Command {
 export abstract class TokenCommand extends Command {
 
   @inject
-  protected githubManager: WorkflowManager;
+  protected workflowManager: WorkflowManager;
 
   @inject('vscode.WorkspaceFolder')
   protected folder: vscode.WorkspaceFolder;
@@ -35,7 +35,7 @@ export abstract class TokenCommand extends Command {
   private channel: vscode.OutputChannel;
 
   public async run(...args: any[]): Promise<void> {
-    if (!(this.githubManager && this.githubManager.connected && this.folder)) {
+    if (!(this.workflowManager && this.workflowManager.connected && this.folder)) {
       this.track('execute without token');
       vscode.window.showWarningMessage('Please setup your Github Personal Access Token '
         + 'and open a GitHub project in your workspace');

src/commands/browse.ts

@@ -11,7 +11,7 @@ export class BrowseProject extends TokenCommand {
 
   @showProgress
   protected async runWithToken(): Promise<void> {
-    const url = await this.githubManager.getRepositoryUrl();
+    const url = await this.workflowManager.getRepositoryUrl();
     await vscode.commands.executeCommand('vscode.open', vscode.Uri.parse(url));
   }
 
@@ -24,7 +24,7 @@ export class BrowseOpenIssues extends TokenCommand {
 
   @showProgress
   protected async runWithToken(): Promise<void> {
-    const issues = await this.githubManager.issues();
+    const issues = await this.workflowManager.issues();
     if (issues.length > 0) {
       const selected = await vscode.window.showQuickPick(issues.map(issue => ({
         label: `${issue.title}`,
@@ -52,7 +52,7 @@ export class BrowseCurrentFile extends TokenCommand {
     if (vscode.workspace.workspaceFolders && editor) {
       const file = editor.document.fileName.substring(vscode.workspace.workspaceFolders[0].uri.fsPath.length);
       const line = editor.selection.active.line;
-      const uri = vscode.Uri.parse(await this.githubManager.getGithubFileUrl(file, line));
+      const uri = vscode.Uri.parse(await this.workflowManager.getGithubFileUrl(file, line));
       vscode.commands.executeCommand('vscode.open', uri);
     }
   }

src/commands/pull-requests.ts

@@ -14,7 +14,7 @@ abstract class PullRequestCommand extends TokenCommand {
   protected git: Git;
 
   protected async selectPullRequest(): Promise<PullRequest | undefined> {
-    const pullRequests = await this.githubManager.listPullRequests();
+    const pullRequests = await this.workflowManager.listPullRequests();
     const items = pullRequests.map(pullRequest => ({
       label: pullRequest.title,
       description: `#${pullRequest.number}`,
@@ -81,7 +81,7 @@ export class BrowseSimpleRequest extends PullRequestCommand {
 
   @showProgress
   protected async runWithToken(): Promise<void> {
-    const pullRequest = await this.githubManager.getPullRequestForCurrentBranch();
+    const pullRequest = await this.workflowManager.getPullRequestForCurrentBranch();
     if (pullRequest) {
       await vscode.commands.executeCommand('vscode.open', vscode.Uri.parse(pullRequest.url));
     } else {
@@ -124,7 +124,7 @@ export class CreatePullRequestWithParameters extends PullRequestCommand {
     if (!this.requireRemoteTrackingBranch()) {
       return;
     }
-    const pullRequest = await this.githubManager.createPullRequestFromData({
+    const pullRequest = await this.workflowManager.createPullRequestFromData({
       sourceBranch,
       targetBranch,
       title,
@@ -151,7 +151,7 @@ export class CreateSimplePullRequest extends PullRequestCommand {
     if (!this.requireRemoteTrackingBranch()) {
       return;
     }
-    const pullRequest = await this.githubManager.createPullRequest();
+    const pullRequest = await this.workflowManager.createPullRequest();
     if (pullRequest) {
       this.statusBarManager.updateStatus();
       this.showPullRequestNotification(pullRequest);
@@ -183,7 +183,7 @@ export class CreatePullRequest extends PullRequestCommand {
     if (!branch) {
       return;
     }
-    const pullRequest = await this.githubManager.createPullRequest({
+    const pullRequest = await this.workflowManager.createPullRequest({
       owner,
       repository: repo,
       branch
@@ -195,7 +195,7 @@ export class CreatePullRequest extends PullRequestCommand {
   }
 
   private async getRepository(): Promise<{label: string, repo: { defaultBranch: string }} | undefined> {
-    const repository = await this.githubManager.getRepository();
+    const repository = await this.workflowManager.getRepository();
     const items = [{
       label: repository.name,
       description: '',
@@ -249,7 +249,7 @@ export class MergePullRequest extends PullRequestCommand {
       return config.preferedMergeMethod;
     }
     const items: { label: string; description: string; method: MergeMethod; }[] = [];
-    const enabledMethods = await this.githubManager.getEnabledMergeMethods();
+    const enabledMethods = await this.workflowManager.getEnabledMergeMethods();
     if (enabledMethods.has('merge')) {
       items.push({
         label: 'Create merge commit',
@@ -277,11 +277,11 @@ export class MergePullRequest extends PullRequestCommand {
 
   @showProgress
   protected async runWithToken(): Promise<void> {
-    const pullRequest = await this.githubManager.getPullRequestForCurrentBranch();
+    const pullRequest = await this.workflowManager.getPullRequestForCurrentBranch();
     if (pullRequest && pullRequest.mergeable) {
       const method = await this.getMergeMethdod();
       if (method) {
-        if (await this.githubManager.mergePullRequest(pullRequest, method)) {
+        if (await this.workflowManager.mergePullRequest(pullRequest, method)) {
           this.statusBarManager.updateStatus();
           vscode.window.showInformationMessage(`Successfully merged`);
         } else {
@@ -295,3 +295,20 @@ export class MergePullRequest extends PullRequestCommand {
   }
 
 }
+
+@component({eager: true})
+export class UpdatePullRequest extends PullRequestCommand {
+
+  public id = 'vscode-github.updatePullRequest';
+
+  @showProgress
+  protected async runWithToken(): Promise<void> {
+    const pullRequest = await this.workflowManager.getPullRequestForCurrentBranch();
+    if (pullRequest) {
+      await this.workflowManager.updatePullRequest(pullRequest);
+    } else {
+      vscode.window.showInformationMessage('No pull request for current branch found');
+    }
+  }
+
+}

src/commands/user.ts

@@ -20,11 +20,11 @@ export class AddAssignee extends UserCommand {
 
   @showProgress
   protected async runWithToken(): Promise<void> {
-    const pullRequest = await this.githubManager.getPullRequestForCurrentBranch();
+    const pullRequest = await this.workflowManager.getPullRequestForCurrentBranch();
     if (pullRequest) {
       const user = await this.getUser();
       if (user) {
-        await this.githubManager.addAssignee(pullRequest, user);
+        await this.workflowManager.addAssignee(pullRequest, user);
         vscode.window.showInformationMessage(`Successfully assigned ${user} to the pull request`);
       }
     } else {
@@ -41,9 +41,9 @@ export class RemoveAssignee extends UserCommand {
 
   @showProgress
   protected async runWithToken(): Promise<void> {
-    const pullRequest = await this.githubManager.getPullRequestForCurrentBranch();
+    const pullRequest = await this.workflowManager.getPullRequestForCurrentBranch();
     if (pullRequest) {
-      await this.githubManager.removeAssignee(pullRequest);
+      await this.workflowManager.removeAssignee(pullRequest);
       vscode.window.showInformationMessage(`Successfully unassigned the pull request`);
     } else {
       vscode.window.showWarningMessage('No pull request for current brach');
@@ -59,11 +59,11 @@ export class RequestReview extends UserCommand {
 
   @showProgress
   protected async runWithToken(): Promise<void> {
-    const pullRequest = await this.githubManager.getPullRequestForCurrentBranch();
+    const pullRequest = await this.workflowManager.getPullRequestForCurrentBranch();
     if (pullRequest) {
       const user = await this.getUser();
       if (user) {
-        await this.githubManager.requestReview(pullRequest.number, user);
+        await this.workflowManager.requestReview(pullRequest.number, user);
         vscode.window.showInformationMessage(`Successfully requested review from ${user}`);
       }
     } else {
@@ -80,11 +80,11 @@ export class DeleteReviewRequest extends UserCommand {
 
   @showProgress
   protected async runWithToken(): Promise<void> {
-    const pullRequest = await this.githubManager.getPullRequestForCurrentBranch();
+    const pullRequest = await this.workflowManager.getPullRequestForCurrentBranch();
     if (pullRequest) {
       const user = await this.getUser();
       if (user) {
-        await this.githubManager.deleteReviewRequest(pullRequest.number, user);
+        await this.workflowManager.deleteReviewRequest(pullRequest.number, user);
         vscode.window.showInformationMessage(`Successfully canceled review request from ${user}`);
       }
     } else {

src/provider/github/index.ts

@@ -14,6 +14,8 @@ export interface GitHub {
   createPullRequest(owner: string, repo: string, body: CreatePullRequestBody):
     Promise<GitHubResponse<PullRequestStruct>>;
 
+  updatePullRequest(owner: string, repo: string, number: number, body: UpdatePullRequestBody): Promise<void>;
+
   getStatusForRef(owner: string, repo: string, ref: string): Promise<GitHubResponse<CombinedStatus>>;
 
   mergePullRequest(owner: string, repo: string, number: number, body: Merge): Promise<GitHubResponse<MergeResult>>;
@@ -41,6 +43,12 @@ export interface GitHubResponse<T> {
   body: T;
 }
 
+export interface UpdatePullRequestBody {
+  title?: string;
+  body?: string;
+  state?: 'open' | 'closed';
+}
+
 export interface UserResponse {
   id: number;
   login: string;
@@ -257,6 +265,9 @@ namespace impl {
     @Post('/repos/:owner/:repo/pulls')
     public createPullRequest(): any {/* */}
 
+    @Patch('/repos/:owner/:repo/pulls/:number')
+    public updatePullRequest(): any {/* */}
+
     @Get('/repos/:owner/:repo/commits/:ref/status')
     public getStatusForRef(): any {/* */}
 

src/provider/github/pull-request.ts

@@ -5,7 +5,8 @@ import {
   MergeResult,
   RequestReviewBody,
   CancelReviewBody,
-  Comment
+  Comment,
+  UpdateBody
 } from '../pull-request';
 import { GitHub, PullRequestStruct } from './index';
 import { GithubRepository } from './repository';
@@ -59,6 +60,19 @@ export class GithubPullRequest implements PullRequest {
     this.struct = struct;
   }
 
+  public async update(body: UpdateBody): Promise<void> {
+    await this.client.updatePullRequest(
+      this.repository.owner,
+      this.repository.repository,
+      this.number,
+      {
+        title: body.title,
+        body: body.body,
+        state: body.state
+      }
+    );
+  }
+
   public async getComments(): Promise<Response<Comment[]>> {
     const response = await this.client.getPullRequestComments(
       this.repository.owner,

src/provider/gitlab/merge-request.ts

@@ -5,9 +5,10 @@ import {
   MergeResult,
   RequestReviewBody,
   CancelReviewBody,
-  Comment
+  Comment,
+  UpdateBody
 } from '../pull-request';
-import { GitLab, MergeRequest } from './api';
+import { GitLab, MergeRequest, UpdateMergeRequestBody } from './api';
 import { GitLabRepository } from './repository';
 import { GitLabUser } from './user';
 
@@ -68,6 +69,34 @@ export class GitLabMergeRequest implements PullRequest {
     this.mergeRequest = mergeRequest;
   }
 
+  public async update(body: UpdateBody): Promise<void> {
+    const gitlabBody: UpdateMergeRequestBody = {};
+    if (body.title) {
+      gitlabBody.title = body.title;
+    }
+    if (body.body) {
+      gitlabBody.description = body.body;
+    }
+    if (body.state) {
+      const mapState = (state: UpdateBody['state']): UpdateMergeRequestBody['state_event'] => {
+        switch (state) {
+          case 'open':
+            return 'reopen';
+          case 'closed':
+            return 'close';
+          default:
+            return undefined;
+          }
+      };
+      gitlabBody.state_event = mapState(body.state);
+    }
+    await this.client.updateMergeRequest(
+      encodeURIComponent(this.repository.pathWithNamespace),
+      this.mergeRequest.iid,
+      gitlabBody
+    );
+  }
+
   public async getComments(): Promise<Response<Comment[]>> {
     throw new Error('Method not implemented.');
   }

src/provider/pull-request.ts

@@ -12,6 +12,7 @@ export interface PullRequest {
   targetBranch: string;
   mergeable?: boolean|null;
 
+  update(body: UpdateBody): Promise<void>;
   getComments(): Promise<Response<Comment[]>>;
   merge(body: MergeBody): Promise<Response<MergeResult>>;
   assign(assignees: User[]): Promise<void>;
@@ -32,6 +33,12 @@ export interface MergeResult {
   message: string;
 }
 
+export interface UpdateBody {
+  title?: string;
+  body?: string;
+  state?: 'open' | 'closed';
+}
+
 export interface RequestReviewBody {
   reviewers: string[];
 }

src/workflow-manager.ts

@@ -169,6 +169,31 @@ export class WorkflowManager {
     }
   }
 
+  public async updatePullRequest(pullRequest: PullRequest): Promise<void> {
+    if (await this.hasPullRequestForCurrentBranch()) {
+      return undefined;
+    }
+    const branch = await this.git.getCurrentBranch();
+    if (!branch) {
+      throw new Error('No current branch');
+    }
+    this.log(`Update pull request on branch '${branch}'`);
+    const firstCommit = await this.git.getFirstCommitOnBranch(branch, pullRequest.targetBranch);
+    this.log(`First commit on branch '${firstCommit}'`);
+    const requestBody = await this.git.getPullRequestBody(firstCommit);
+    if (requestBody === undefined) {
+      vscode.window.showWarningMessage(
+        `For some unknown reason no pull request body could be build; Aborting operation`);
+      return undefined;
+    }
+    if (requestBody !== pullRequest.body) {
+      await pullRequest.update({
+        title: await this.git.getCommitMessage(firstCommit),
+        body: requestBody
+      });
+    }
+  }
+
   public async listPullRequests(): Promise<PullRequest[]> {
     const repository = await this.getRepository();
     const parameters: ListPullRequestsParameters = {