/*---------------------------------------------------------------------------------------------

* Copyright (c) Microsoft Corporation. All rights reserved.

* Licensed under the MIT License. See License.txt in the project root for license information.

*--------------------------------------------------------------------------------------------*/

import * as buffer from 'buffer';

import * as path from 'path';

import equals from 'fast-deep-equal';

import gql from 'graphql-tag';

import * as vscode from 'vscode';

import { OctokitCommon } from './common';

import { ConflictResolutionModel } from './conflictResolutionModel';

import { CredentialStore } from './credentials';

import { showEmptyCommitWebview } from './emptyCommitWebview';

import { FolderRepositoryManager } from './folderRepositoryManager';

import { GitHubRepository, GraphQLError, GraphQLErrorType } from './githubRepository';

import {

AddCommentResponse,

AddReactionResponse,

AddReviewRequestResponse as AddReviewsResponse,

AddReviewThreadResponse,

ConvertPullRequestToDraftResponse,

DeleteReactionResponse,

DeleteReviewResponse,

DequeuePullRequestResponse,

EditCommentResponse,

EnqueuePullRequestResponse,

FileContentResponse,

GetReviewRequestsResponse,

MergeMethod as GraphQLMergeMethod,

LatestReviewCommitResponse,

MarkPullRequestReadyForReviewResponse,

MergePullRequestInput,

MergePullRequestResponse,

PendingReviewIdResponse,

PullRequestCommentsResponse,

PullRequestFilesResponse,

PullRequestMergabilityResponse,

ReactionGroup,

ResolveReviewThreadResponse,

ReviewThread,

StartReviewResponse,

SubmitReviewResponse,

TimelineEventsResponse,

UnresolveReviewThreadResponse,

UpdateIssueResponse,

UpdatePullRequestBranchResponse,

} from './graphql';

import {

AccountType,

ConvertToDraft,

GithubItemStateEnum,

IAccount,

IGitTreeItem,

IRawFileChange,

IRawFileContent,

ISuggestedReviewer,

ITeam,

MergeMethod,

MergeQueueEntry,

PullRequest,

PullRequestChecks,

PullRequestMergeability,

PullRequestReviewRequirement,

ReadyForReview,

ReviewEventEnum,

} from './interface';

import { IssueChangeEvent, IssueModel } from './issueModel';

import { compareCommits } from './loggingOctokit';

import {

convertRESTPullRequestToRawPullRequest,

convertRESTReviewEvent,

getReactionGroup,

insertNewCommitsSinceReview,

parseAccount,

parseCombinedTimelineEvents,

parseGraphQLComment,

parseGraphQLReaction,

parseGraphQLReviewers,

parseGraphQLReviewEvent,

parseGraphQLReviewThread,

parseMergeability,

parseMergeQueueEntry,

RestAccount,

restPaginate,

} from './utils';

import { Repository } from '../api/api';

import { COPILOT_ACCOUNTS, DiffSide, IComment, IReviewThread, SubjectType, ViewedState } from '../common/comment';

import { getGitChangeType, getModifiedContentFromDiffHunk, parseDiff } from '../common/diffHunk';

import { commands } from '../common/executeCommands';

import { GitChangeType, InMemFileChange, SlimFileChange } from '../common/file';

import { GitHubRef } from '../common/githubRef';

import Logger from '../common/logger';

import { Remote } from '../common/remote';

import { DEFAULT_MERGE_METHOD, PR_SETTINGS_NAMESPACE } from '../common/settingKeys';

import { ITelemetry } from '../common/telemetry';

import { ClosedEvent, EventType, ReviewEvent, TimelineEvent } from '../common/timelineEvent';

import { resolvePath, Schemes, toGitHubCommitUri, toPRUri, toReviewUri } from '../common/uri';

import { formatError, isDescendant } from '../common/utils';

import { InMemFileChangeModel, RemoteFileChangeModel } from '../view/fileChangeModel';

interface IPullRequestModel {

head: GitHubRef | null;

}

export interface IResolvedPullRequestModel extends IPullRequestModel {

head: GitHubRef;

}

export interface ReviewThreadChangeEvent {

added: IReviewThread[];

changed: IReviewThread[];

removed: IReviewThread[];

}

export interface FileViewedStateChangeEvent {

changed: {

fileName: string;

viewed: ViewedState;

}[];

}

export type FileViewedState = { [key: string]: ViewedState };

type TreeDataMode = '100644' | '100755' | '120000';

const BATCH_SIZE = 50;

export class PullRequestModel extends IssueModel<PullRequest> implements IPullRequestModel {

static override ID = 'PullRequestModel';

public isDraft?: boolean;

public reviewers?: (IAccount | ITeam)[];

public localBranchName?: string;

public mergeBase?: string;

public mergeQueueEntry?: MergeQueueEntry;

public conflicts?: string[];

public suggestedReviewers?: ISuggestedReviewer[];

public hasChangesSinceLastReview?: boolean;

private _showChangesSinceReview: boolean;

private _hasPendingReview: boolean = false;

private _onDidChangePendingReviewState: vscode.EventEmitter<boolean> = this._register(new vscode.EventEmitter<boolean>());

public onDidChangePendingReviewState = this._onDidChangePendingReviewState.event;

private _reviewThreadsCache: IReviewThread[] | undefined;

private _reviewThreadsCacheInitialized = false;

private _onDidChangeReviewThreads = this._register(new vscode.EventEmitter<ReviewThreadChangeEvent>());

public onDidChangeReviewThreads = this._onDidChangeReviewThreads.event;

private _fileChangeViewedState: FileViewedState = {};

private _viewedFiles: Set<string> = new Set();

private _unviewedFiles: Set<string> = new Set();

private _onDidChangeFileViewedState = this._register(new vscode.EventEmitter<FileViewedStateChangeEvent>());

public onDidChangeFileViewedState = this._onDidChangeFileViewedState.event;

private _onDidChangeChangesSinceReview = this._register(new vscode.EventEmitter<void>());

public onDidChangeChangesSinceReview = this._onDidChangeChangesSinceReview.event;

private _hasComments: boolean;

private _comments: readonly IComment[] | undefined;

// Whether the pull request is currently checked out locally

private _isActive: boolean;

public get isActive(): boolean {

return this._isActive;

}

public set isActive(isActive: boolean) {

this._isActive = isActive;

}

constructor(

private readonly credentialStore: CredentialStore,

telemetry: ITelemetry,

githubRepository: GitHubRepository,

remote: Remote,

item: PullRequest,

isActive?: boolean,

) {

super(telemetry, githubRepository, remote, item, true);

this.isActive = !!isActive;

this._showChangesSinceReview = false;

this.update(item);

}

public clear() {

this.comments = [];

this._reviewThreadsCacheInitialized = false;

this._reviewThreadsCache = undefined;

}

public async initializeReviewThreadCache(): Promise<IReviewThread[]> {

const threads = await this.getReviewThreads();

this._reviewThreadsCacheInitialized = true;

return threads;

}

public get reviewThreadsCache(): IReviewThread[] {

return this._reviewThreadsCache ?? [];

}

public get reviewThreadsCacheReady(): boolean {

return this._reviewThreadsCacheInitialized;

}

public get hasPendingReview(): boolean {

return this._hasPendingReview;

}

public set hasPendingReview(hasPendingReview: boolean) {

if (this._hasPendingReview !== hasPendingReview) {

this._hasPendingReview = hasPendingReview;

this._onDidChangePendingReviewState.fire(this._hasPendingReview);

}

}

public get showChangesSinceReview() {

return this._showChangesSinceReview;

}

public set showChangesSinceReview(isChangesSinceReview: boolean) {

if (this._showChangesSinceReview !== isChangesSinceReview) {

this._showChangesSinceReview = isChangesSinceReview;

this._fileChanges.clear();

this._onDidChangeChangesSinceReview.fire();

}

}

get comments(): readonly IComment[] {

return this._comments ?? [];

}

set comments(comments: readonly IComment[]) {

this._comments = comments;

this._onDidChange.fire({ comments: true });

}

get fileChangeViewedState(): FileViewedState {

return this._fileChangeViewedState;

}

public isRemoteHeadDeleted?: boolean;

public head: GitHubRef | null;

public isRemoteBaseDeleted?: boolean;

public base: GitHubRef;

protected override stateToStateEnum(state: string) {

let newState = GithubItemStateEnum.Closed;

if (state.toLowerCase() === 'open') {

newState = GithubItemStateEnum.Open;

} else if (state.toLowerCase() === 'merged' || this.item.merged) {

newState = GithubItemStateEnum.Merged;

}

return newState;

}

protected override doUpdate(item: PullRequest): IssueChangeEvent {

const changes = super.doUpdate(item) as IssueChangeEvent;

if (this.isDraft !== item.isDraft) {

changes.draft = true;

this.isDraft = item.isDraft;

}

this.suggestedReviewers = item.suggestedReviewers;

if (item.isRemoteHeadDeleted != null) {

this.isRemoteHeadDeleted = item.isRemoteHeadDeleted;

}

if (item.head) {

this.head = new GitHubRef(item.head.ref, item.head.label, item.head.sha, item.head.repo.cloneUrl, item.head.repo.owner, item.head.repo.name, item.head.repo.isInOrganization);

}

if (item.isRemoteBaseDeleted != null) {

this.isRemoteBaseDeleted = item.isRemoteBaseDeleted;

}

if (item.base) {

this.base = new GitHubRef(item.base.ref, item.base!.label, item.base!.sha, item.base!.repo.cloneUrl, item.base.repo.owner, item.base.repo.name, item.base.repo.isInOrganization);

}

if (item.mergeQueueEntry !== undefined) {

this.mergeQueueEntry = item.mergeQueueEntry ?? undefined;

}

if (item.hasComments !== undefined) {

this._hasComments = item.hasComments;

}

return changes;

}

/**

* Validate if the pull request has a valid HEAD.

* Use only when the method can fail silently, otherwise use `validatePullRequestModel`

*/

isResolved(): this is IResolvedPullRequestModel {

return !!this.head;

}

/**

* Validate if the pull request has a valid HEAD. Show a warning message to users when the pull request is invalid.

* @param message Human readable action execution failure message.

*/

validatePullRequestModel(message?: string): this is IResolvedPullRequestModel {

if (!!this.head) {

return true;

}

const reason = vscode.l10n.t('There is no upstream branch for Pull Request #{0}. View it on GitHub for more details', this.number);

if (message) {

message += `: ${reason}`;

} else {

message = reason;

}

const openString = vscode.l10n.t('Open on GitHub');

vscode.window.showWarningMessage(message, openString).then(action => {

if (action && action === openString) {

vscode.commands.executeCommand('vscode.open', vscode.Uri.parse(this.html_url));

}

});

return false;

}

protected override updateIssueInput(id: string): Object {

return {

pullRequestId: id,

};

}

protected override updateIssueSchema(schema: any): any {

return schema.UpdatePullRequest;

}

/**

* Approve the pull request.

* @param message Optional approval comment text.

*/

async approve(repository: Repository, message?: string): Promise<ReviewEvent> {

// Check that the remote head of the PR branch matches the local head of the PR branch

let remoteHead: string | undefined;

let localHead: string | undefined;

let rejectMessage: string | undefined;

if (this.isActive) {

localHead = repository.state.HEAD?.commit;

remoteHead = (await this.githubRepository.getPullRequest(this.number))?.head?.sha;

rejectMessage = vscode.l10n.t('The remote head of the pull request branch has changed. Please pull the latest changes from the remote branch before approving.');

} else {

localHead = this.head?.sha;

remoteHead = (await this.githubRepository.getPullRequest(this.number))?.head?.sha;

rejectMessage = vscode.l10n.t('The remote head of the pull request branch has changed. Please refresh the pull request before approving.');

}

if (!remoteHead || remoteHead !== localHead) {

return Promise.reject(rejectMessage);

}

const action: Promise<ReviewEvent> = (await this.getPendingReviewId())

? this.submitReview(ReviewEventEnum.Approve, message)

: this.createReview(ReviewEventEnum.Approve, message);

return action.then(x => {

/* __GDPR__

"pr.approve" : {}

*/

this._telemetry.sendTelemetryEvent('pr.approve');

this._onDidChange.fire({ comments: true, timeline: true });

return x;

});

}

/**

* Request changes on the pull request.

* @param message Optional comment text to leave with the review.

*/

async requestChanges(message?: string): Promise<ReviewEvent> {

const action: ReviewEvent = (await this.getPendingReviewId())

? await this.submitReview(ReviewEventEnum.RequestChanges, message)

: await this.createReview(ReviewEventEnum.RequestChanges, message);

/* __GDPR__

"pr.requestChanges" : {}

*/

this._telemetry.sendTelemetryEvent('pr.requestChanges');

this._onDidChange.fire({ timeline: true, comments: true });

return action;

}

async merge(

repository: Repository,

title?: string,

description?: string,

method?: 'merge' | 'squash' | 'rebase',

email?: string

): Promise<{ merged: boolean, message: string, timeline?: TimelineEvent[] }> {

Logger.debug(`Merging PR: ${this.number} method: ${method} for user: "${email}" - enter`, PullRequestModel.ID);

const { mutate, schema } = await this.githubRepository.ensure();

const workingDirectorySHA = repository.state.HEAD?.commit;

const mergingPRSHA = this.head?.sha;

const workingDirectoryIsDirty = repository.state.workingTreeChanges.length > 0;

let expectedHeadOid: string | undefined = this.head?.sha;

if (this.isActive) {

// We're on the branch of the pr being merged.

expectedHeadOid = workingDirectorySHA;

if (workingDirectorySHA !== mergingPRSHA) {

// We are looking at different commit than what will be merged

const { ahead } = repository.state.HEAD!;

const pluralMessage = vscode.l10n.t('You have {0} unpushed commits on this pull request branch.\n\nWould you like to proceed anyway?', ahead ?? 'unknown');

const singularMessage = vscode.l10n.t('You have 1 unpushed commit on this pull request branch.\n\nWould you like to proceed anyway?');

if (ahead &&

(await vscode.window.showWarningMessage(

ahead > 1 ? pluralMessage : singularMessage,

{ modal: true },

vscode.l10n.t('Yes'),

)) === undefined) {

return {

merged: false,

message: vscode.l10n.t('unpushed changes'),

};

}

}

if (workingDirectoryIsDirty) {

// We have made changes to the PR that are not committed

if (

(await vscode.window.showWarningMessage(

vscode.l10n.t('You have uncommitted changes on this pull request branch.\n\n Would you like to proceed anyway?'),

{ modal: true },

vscode.l10n.t('Yes'),

)) === undefined

) {

return {

merged: false,

message: vscode.l10n.t('uncommitted changes'),

};

}

}

}

const input: MergePullRequestInput = {

pullRequestId: this.graphNodeId,

commitHeadline: title,

commitBody: description,

expectedHeadOid,

authorEmail: email,

mergeMethod:

(method?.toUpperCase() ??

vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<'merge' | 'squash' | 'rebase'>(DEFAULT_MERGE_METHOD, 'merge')?.toUpperCase()) as GraphQLMergeMethod,

};

return mutate<MergePullRequestResponse>({

mutation: schema.MergePullRequest,

variables: {

input

}

})

.then(async (result) => {

Logger.debug(`Merging PR: ${this.number} - done`, PullRequestModel.ID);

/* __GDPR__

"pr.merge.success" : {}

*/

this._telemetry.sendTelemetryEvent('pr.merge.success');

this._onDidChange.fire({ state: true });

return { merged: true, message: '', timeline: await parseCombinedTimelineEvents(result.data?.mergePullRequest.pullRequest.timelineItems.nodes ?? [], await this.getCopilotTimelineEvents(), this.githubRepository) };

})

.catch(e => {

/* __GDPR__

"pr.merge.failure" : {}

*/

this._telemetry.sendTelemetryErrorEvent('pr.merge.failure');

const graphQLErrors = e.graphQLErrors as GraphQLError[] | undefined;

if (graphQLErrors?.length && graphQLErrors.find(error => error.type === GraphQLErrorType.Unprocessable && error.message?.includes('Head branch was modified'))) {

return { merged: false, message: vscode.l10n.t('Head branch was modified. Pull, review, then try again.') };

} else {

throw e;

}

});

}

/**

* Close the pull request.

*/

override async close(): Promise<{ item: PullRequest; closedEvent: ClosedEvent }> {

const { octokit, remote } = await this.githubRepository.ensure();

const ret = await octokit.call(octokit.api.pulls.update, {

owner: remote.owner,

repo: remote.repositoryName,

pull_number: this.number,

state: 'closed',

});

/* __GDPR__

"pr.close" : {}

*/

this._telemetry.sendTelemetryEvent('pr.close');

const user = await this.githubRepository.getAuthenticatedUser();

this.state = this.stateToStateEnum(ret.data.state);

// Fire the event with a delay as GitHub needs some time to propagate the changes, we want to make sure any listeners of the event will get the right info when they query

setTimeout(() => this._onDidChange.fire({ state: true }), 1500);

return {

item: convertRESTPullRequestToRawPullRequest(ret.data, this.githubRepository),

closedEvent: {

createdAt: ret.data.closed_at ?? '',

event: EventType.Closed,

id: `${ret.data.id}`,

actor: {

login: user.login,

avatarUrl: user.avatarUrl,

url: user.url

}

}

};

}

/**

* Create a new review.

* @param event The type of review to create, an approval, request for changes, or comment.

* @param message The summary comment text.

*/

private async createReview(event: ReviewEventEnum, message?: string): Promise<ReviewEvent> {

const { octokit, remote } = await this.githubRepository.ensure();

const { data } = await octokit.call(octokit.api.pulls.createReview, {

owner: remote.owner,

repo: remote.repositoryName,

pull_number: this.number,

event: event,

body: message,

});

this._onDidChange.fire({ timeline: true });

return convertRESTReviewEvent(data as OctokitCommon.PullsCreateReviewResponseData, this.githubRepository);

}

/**

* Submit an existing review.

* @param event The type of review to create, an approval, request for changes, or comment.

* @param body The summary comment text.

*/

async submitReview(event?: ReviewEventEnum, body?: string): Promise<ReviewEvent> {

let pendingReviewId = await this.getPendingReviewId();

const { mutate, schema } = await this.githubRepository.ensure();

if (!pendingReviewId && (event === ReviewEventEnum.Comment)) {

// Create a new review so that we can comment on it.

pendingReviewId = await this.startReview();

}

if (pendingReviewId) {

const { data } = await mutate<SubmitReviewResponse>({

mutation: schema.SubmitReview,

variables: {

id: pendingReviewId,

event: event || ReviewEventEnum.Comment,

body,

},

});

this.hasPendingReview = false;

await this.updateDraftModeContext();

const reviewEvent = parseGraphQLReviewEvent(data!.submitPullRequestReview.pullRequestReview, this.githubRepository);

const threadWithComment = (this._reviewThreadsCache ?? []).find(thread =>

thread.comments.length ? (thread.comments[0].pullRequestReviewId === reviewEvent.id) : undefined,

);

if (threadWithComment) {

threadWithComment.comments = reviewEvent.comments;

threadWithComment.viewerCanResolve = true;

this._onDidChangeReviewThreads.fire({ added: [], changed: [threadWithComment], removed: [] });

}

this._onDidChange.fire({ timeline: true, comments: true });

return reviewEvent;

} else {

throw new Error(`Submitting review failed, no pending review for current pull request: ${this.number}.`);

}

}

/**

* Query to see if there is an existing review.

*/

async getPendingReviewId(): Promise<string | undefined> {

const { query, schema } = await this.githubRepository.ensure();

const currentUser = (await this.githubRepository.getAuthenticatedUser()).login;

try {

const { data } = await query<PendingReviewIdResponse>({

query: schema.GetPendingReviewId,

variables: {

pullRequestId: this.item.graphNodeId,

author: currentUser,

},

});

return data.node.reviews.nodes.length > 0 ? data.node.reviews.nodes[0].id : undefined;

} catch (error) {

return;

}

}

async getViewerLatestReviewCommit(): Promise<{ sha: string } | undefined> {

Logger.debug(`Fetch viewers latest review commit`, IssueModel.ID);

const { query, remote, schema } = await this.githubRepository.ensure();

const currentUser = (await this.githubRepository.getAuthenticatedUser()).login;

try {

const { data } = await query<LatestReviewCommitResponse>({

query: schema.LatestReviewCommit,

variables: {

owner: remote.owner,

name: remote.repositoryName,

number: this.number,

author: currentUser,

},

});

if (data.repository === null) {

Logger.error('Unexpected null repository while getting last review commit', PullRequestModel.ID);

}

const latestReview = data.repository?.pullRequest.reviews.nodes[0];

return latestReview ? {

sha: latestReview.commit.oid,

} : undefined;

}

catch (e) {

return undefined;

}

}

/**

* Delete an existing in progress review.

*/

async deleteReview(): Promise<{ deletedReviewId: number; deletedReviewComments: IComment[] }> {

const pendingReviewId = await this.getPendingReviewId();

if (!pendingReviewId) {

throw new Error(`No pending review found for pull request #${this.number}.`);

}

const { mutate, schema } = await this.githubRepository.ensure();

const { data } = await mutate<DeleteReviewResponse>({

mutation: schema.DeleteReview,

variables: {

input: { pullRequestReviewId: pendingReviewId },

},

});

const { comments, databaseId } = data!.deletePullRequestReview.pullRequestReview;

const deletedReviewComments = comments.nodes.map(comment => parseGraphQLComment(comment, false, false, this.githubRepository));

// Update local state: remove all draft comments (and their threads if emptied) that belonged to the deleted review

const deletedCommentIds = new Set(deletedReviewComments.map(c => c.id));

const changedThreads: IReviewThread[] = [];

const removedThreads: IReviewThread[] = [];

if (!this._reviewThreadsCache) {

this._reviewThreadsCache = [];

}

for (let i = this._reviewThreadsCache.length - 1; i >= 0; i--) {

const thread = this._reviewThreadsCache[i];

const originalLength = thread.comments.length;

thread.comments = thread.comments.filter(c => !deletedCommentIds.has(c.id));

if (thread.comments.length === 0 && originalLength > 0) {

// Entire thread was composed only of comments from the deleted review; remove it.

this._reviewThreadsCache.splice(i, 1);

removedThreads.push(thread);

} else if (thread.comments.length !== originalLength) {

changedThreads.push(thread);

}

}

if (changedThreads.length > 0 || removedThreads.length > 0) {

this._onDidChangeReviewThreads.fire({ added: [], changed: changedThreads, removed: removedThreads });

}

// Remove from flat comments collection

if (this._comments) {

this.comments = this._comments.filter(c => !deletedCommentIds.has(c.id));

}

this.hasPendingReview = false;

await this.updateDraftModeContext();

// Fire change event to update timeline & comment views

this._onDidChange.fire({ timeline: true, comments: true });

return {

deletedReviewId: databaseId,

deletedReviewComments,

};

}

/**

* Start a new review.

* @param initialComment The comment text and position information to begin the review with

* @param commitId The optional commit id to start the review on. Defaults to using the current head commit.

*/

async startReview(commitId?: string): Promise<string> {

const { mutate, schema } = await this.githubRepository.ensure();

const { data } = await mutate<StartReviewResponse>({

mutation: schema.StartReview,

variables: {

input: {

body: '',

pullRequestId: this.item.graphNodeId,

commitOID: commitId || this.head?.sha,

},

},

});

if (!data) {

throw new Error('Failed to start review');

}

this.hasPendingReview = true;

return data.addPullRequestReview.pullRequestReview.id;

}

/**

* Creates a new review thread, either adding it to an existing pending review, or creating

* a new review.

* @param body The body of the thread's first comment.

* @param commentPath The path to the file being commented on.

* @param startLine The start line on which to add the comment.

* @param endLine The end line on which to add the comment.

* @param side The side the comment should be deleted on, i.e. the original or modified file.

* @param suppressDraftModeUpdate If a draft mode change should event should be suppressed. In the

* case of a single comment add, the review is created and then immediately submitted, so this prevents

* a "Pending" label from flashing on the comment.

* @returns The new review thread object.

*/

async createReviewThread(

body: string,

commentPath: string,

startLine: number | undefined,

endLine: number | undefined,

side: DiffSide,

suppressDraftModeUpdate?: boolean,

): Promise<IReviewThread | undefined> {

if (!this.validatePullRequestModel('Creating comment failed')) {

return;

}

const pendingReviewId = await this.getPendingReviewId();

const { mutate, schema } = await this.githubRepository.ensure();

const { data } = await mutate<AddReviewThreadResponse>({

mutation: schema.AddReviewThread,

variables: {

input: {

path: commentPath,

body,

pullRequestId: this.graphNodeId,

pullRequestReviewId: pendingReviewId,

startLine: startLine === endLine ? undefined : startLine,

line: endLine,

side,

subjectType: (startLine === undefined || endLine === undefined) ? SubjectType.FILE : SubjectType.LINE

}

}

}, { mutation: schema.LegacyAddReviewThread, deleteProps: ['subjectType'] });

if (!data) {

throw new Error('Creating review thread failed.');

}

if (!data.addPullRequestReviewThread.thread) {

throw new Error('File has been deleted.');

}

if (!suppressDraftModeUpdate) {

this.hasPendingReview = true;

await this.updateDraftModeContext();

}

const thread = data.addPullRequestReviewThread.thread;

const newThread = parseGraphQLReviewThread(thread, this.githubRepository);

if (!this._reviewThreadsCache) {

this._reviewThreadsCache = [];

}

this._reviewThreadsCache.push(newThread);

this._onDidChangeReviewThreads.fire({ added: [newThread], changed: [], removed: [] });

this._onDidChange.fire({ timeline: true });

return newThread;

}

/**

* Creates a new comment in reply to an existing comment

* @param body The text of the comment to be created

* @param inReplyTo The id of the comment this is in reply to

* @param isSingleComment Whether this is a single comment, i.e. one that

* will be immediately submitted and so should not show a pending label

* @param commitId The commit id the comment was made on

* @returns The new comment

*/

async createCommentReply(

body: string,

inReplyTo: string,

isSingleComment: boolean,

commitId?: string,

): Promise<IComment | undefined> {

if (!this.validatePullRequestModel('Creating comment failed')) {

return;

}

let pendingReviewId = await this.getPendingReviewId();

if (!pendingReviewId) {

pendingReviewId = await this.startReview(commitId);

}

const { mutate, schema } = await this.githubRepository.ensure();

const { data } = await mutate<AddCommentResponse>({

mutation: schema.AddComment,

variables: {

input: {

pullRequestReviewId: pendingReviewId,

body,

inReplyTo,

commitOID: commitId || this.head?.sha,

},

},

});

if (!data) {

throw new Error('Creating comment reply failed.');

}

const { comment } = data.addPullRequestReviewComment;

const newComment = parseGraphQLComment(comment, false, false, this.githubRepository);

if (isSingleComment) {

newComment.isDraft = false;

}

const threadWithComment = this._reviewThreadsCache?.find(thread =>

thread.comments.some(comment => comment.graphNodeId === inReplyTo),

);

if (threadWithComment) {

threadWithComment.comments.push(newComment);

this._onDidChangeReviewThreads.fire({ added: [], changed: [threadWithComment], removed: [] });

}

this._onDidChange.fire({ timeline: true, comments: true });

return newComment;

}

/**

* Check whether there is an existing pending review and update the context key to control what comment actions are shown.

*/

async validateDraftMode(): Promise<boolean> {

const inDraftMode = !!(await this.getPendingReviewId());

if (inDraftMode !== this.hasPendingReview) {

this.hasPendingReview = inDraftMode;

}

await this.updateDraftModeContext();

return inDraftMode;

}

private async updateDraftModeContext() {

if (this.isActive) {

await vscode.commands.executeCommand('setContext', 'reviewInDraftMode', this.hasPendingReview);

}

}

/**

* Get the timeline events of a pull request, including comments, reviews, commits, merges, deletes, and assigns.

*/

async getTimelineEvents(): Promise<TimelineEvent[]> {

const getTimelineEvents = async () => {

Logger.debug(`Fetch timeline events of PR #${this.number} - enter`, PullRequestModel.ID);

const { query, remote, schema } = await this.githubRepository.ensure();

try {

const { data } = await query<TimelineEventsResponse>({

query: schema.TimelineEvents,

variables: {

owner: remote.owner,

name: remote.repositoryName,

number: this.number,

},

});

if (data.repository === null) {

Logger.error('Unexpected null repository when fetching timeline', PullRequestModel.ID);

}

return data;

} catch (e) {

Logger.error(`Failed to get pull request timeline events: ${e}`, PullRequestModel.ID);

console.log(e);

return undefined;

}

};

const [data, latestReviewCommitInfo, currentUser, reviewThreads] = await Promise.all([

getTimelineEvents(),

this.getViewerLatestReviewCommit(),

// eslint-disable-next-line @typescript-eslint/await-thenable

(await this.githubRepository.getAuthenticatedUser()).login,

this.getReviewThreads()

]);

const ret = data?.repository?.pullRequest.timelineItems.nodes ?? [];

const events = await parseCombinedTimelineEvents(ret, await this.getCopilotTimelineEvents(true), this.githubRepository);

this.addReviewTimelineEventComments(events, reviewThreads);

insertNewCommitsSinceReview(events, latestReviewCommitInfo?.sha, currentUser, this.head);

Logger.debug(`Fetch timeline events of PR #${this.number} - done`, PullRequestModel.ID);

this.timelineEvents = events;

return events;

}

async getActivityTimelineEvents(): Promise<TimelineEvent[]> {

Logger.debug(`Fetch timeline events of PR #${this.number} - enter`, PullRequestModel.ID);

const { query, remote, schema } = await this.githubRepository.ensure();

try {

const { data } = await query<TimelineEventsResponse>({

query: schema.PullRequestActivityTimelineEvents,

variables: {

owner: remote.owner,

name: remote.repositoryName,

number: this.number,

},

});

if (data.repository === null) {

Logger.error('Unexpected null repository when fetching timeline', PullRequestModel.ID);

}

return parseCombinedTimelineEvents(data.repository?.pullRequest.timelineItems.nodes ?? [], [], this.githubRepository);

} catch (e) {

Logger.error(`Failed to get pull request timeline events: ${e}`, PullRequestModel.ID);

console.log(e);

return [];

}

}

private addReviewTimelineEventComments(events: TimelineEvent[], reviewThreads: IReviewThread[]): void {

interface CommentNode extends IComment {

childComments?: CommentNode[];

}

const reviewEvents = events.filter((e): e is ReviewEvent => e.event === EventType.Reviewed);

const reviewComments = reviewThreads.reduce((previous, current) => (previous as IComment[]).concat(current.comments), []);

const reviewEventsById = reviewEvents.reduce((index, evt) => {

index[evt.id] = evt;

evt.comments = [];

return index;

}, {} as { [key: number]: ReviewEvent });

const commentsById = reviewComments.reduce((index, evt) => {

index[evt.id] = evt;

return index;

}, {} as { [key: number]: CommentNode });

const roots: CommentNode[] = [];

let i = reviewComments.length;

while (i-- > 0) {

const c: CommentNode = reviewComments[i];

if (!c.inReplyToId) {

roots.unshift(c);

continue;

}

const parent = commentsById[c.inReplyToId];

parent.childComments = parent.childComments || [];

parent.childComments = [c, ...(c.childComments || []), ...parent.childComments];

}

roots.forEach(c => {

const review = reviewEventsById[c.pullRequestReviewId!];

if (review) {

review.comments = review.comments.concat(c).concat(c.childComments || []);

}

});

reviewThreads.forEach(thread => {

if (!thread.prReviewDatabaseId || !reviewEventsById[thread.prReviewDatabaseId]) {

return;

}

const prReviewThreadEvent = reviewEventsById[thread.prReviewDatabaseId];

prReviewThreadEvent.reviewThread = {

threadId: thread.id,

canResolve: thread.viewerCanResolve,

canUnresolve: thread.viewerCanUnresolve,

isResolved: thread.isResolved

};

});

const pendingReview = reviewEvents.filter(r => r.state?.toLowerCase() === 'pending')[0];

if (pendingReview) {

// Ensures that pending comments made in reply to other reviews are included for the pending review

pendingReview.comments = reviewComments.filter(c => c.isDraft);

}

}

/**

* Edit an existing review comment.

* @param comment The comment to edit

* @param text The new comment text