vscode-pull-request-github/src/github/createPRViewProvider.ts at main · tamird/vscode-pull-request-github · GitHub

History

1629 lines (1429 loc) · 68.1 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

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

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

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

import * as vscode from 'vscode';

import {

byRemoteName,

FolderRepositoryManager,

PullRequestDefaults,

titleAndBodyFrom,

} from './folderRepositoryManager';

import { GitHubRepository, isRateLimitError, ViewerPermission } from './githubRepository';

import { IAccount, ILabel, IMilestone, IProject, isITeam, ITeam, MergeMethod, RepoAccessAndMergeMethods } from './interface';

import { BaseBranchMetadata, PullRequestGitHelper } from './pullRequestGitHelper';

import { PullRequestModel } from './pullRequestModel';

import { getDefaultMergeMethod } from './pullRequestOverview';

import { branchPicks, cachedBranchPicks, getAssigneesQuickPickItems, getLabelOptions, getMilestoneFromQuickPick, getProjectFromQuickPick, reviewersQuickPick } from './quickPicks';

import { ISSUE_EXPRESSION, parseIssueExpressionOutput, variableSubstitution } from './utils';

import { ChangeTemplateReply, DisplayLabel, PreReviewState } from './views';

import { RemoteInfo } from '../../common/types';

import { CancelCreatePullRequestNew, ChooseBaseRemoteAndBranchResult, ChooseCompareRemoteAndBranchResult, ChooseRemoteAndBranchArgs, CreateParamsNew, CreatePullRequestNew, TitleAndDescriptionArgs } from '../../common/views';

import type { Branch } from '../api/api';

import { debounce } from '../common/async';

import { GitHubServerType } from '../common/authentication';

import { emojify, ensureEmojis } from '../common/emoji';

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

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

import { Protocol } from '../common/protocol';

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

import {

ASSIGN_TO,

CREATE_BASE_BRANCH,

DEFAULT_CREATE_OPTION,

PR_SETTINGS_NAMESPACE,

PULL_REQUEST_DESCRIPTION,

PULL_REQUEST_LABELS,

PUSH_BRANCH,

SHOW_CREATE_PULL_REQUEST_CANCEL_CONFIRMATION

} from '../common/settingKeys';

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

import { asPromise, compareIgnoreCase, formatError, promiseWithTimeout } from '../common/utils';

import { generateUuid } from '../common/uuid';

import { IRequestMessage, WebviewViewBase } from '../common/webview';

import { PREVIOUS_CREATE_METHOD, RECENTLY_USED_BRANCHES, RecentlyUsedBranchesState } from '../extensionState';

import { CreatePullRequestDataModel } from '../view/createPullRequestDataModel';

export interface BasePullRequestDataModel {

baseOwner: string;

repositoryName: string;

}

export abstract class BaseCreatePullRequestViewProvider<T extends BasePullRequestDataModel = BasePullRequestDataModel> extends WebviewViewBase implements vscode.WebviewViewProvider {

protected static readonly ID = 'CreatePullRequestViewProvider';

public override readonly viewType = 'github:createPullRequestWebview';

protected _onDone = new vscode.EventEmitter<PullRequestModel | undefined>();

readonly onDone: vscode.Event<PullRequestModel | undefined> = this._onDone.event;

protected _firstLoad: boolean = true;

constructor(

protected readonly telemetry: ITelemetry,

protected readonly model: T,

extensionUri: vscode.Uri,

protected readonly _folderRepositoryManager: FolderRepositoryManager,

protected readonly _pullRequestDefaults: PullRequestDefaults,

protected _defaultCompareBranch: string

) {

super(extensionUri);

}

public override resolveWebviewView(

webviewView: vscode.WebviewView,

_context: vscode.WebviewViewResolveContext,

_token: vscode.CancellationToken,

) {

super.resolveWebviewView(webviewView, _context, _token);

webviewView.webview.html = this._getHtmlForWebview();

if (this._firstLoad) {

this._firstLoad = false;

// Reset any stored state.

return this.initializeParams(true);

} else {

return this.initializeParams();

}

public override show() {

super.show();

}

public static withProgress<R>(task: (progress: vscode.Progress<{ message?: string; increment?: number }>, token: vscode.CancellationToken) => Thenable<R>) {

return vscode.window.withProgress({ location: { viewId: 'github:createPullRequestWebview' } }, task);

}

protected async getPullRequestDefaultLabels(defaultBaseRemote: RemoteInfo): Promise<ILabel[]> {

const pullRequestLabelSettings = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).inspect<string[]>(PULL_REQUEST_LABELS);

if (!pullRequestLabelSettings) {

return [];

}

const defaultLabelValues = new Array<string>();

if (pullRequestLabelSettings.workspaceValue) {

defaultLabelValues.push(...pullRequestLabelSettings.workspaceValue);

}

if (pullRequestLabelSettings.globalValue) {

defaultLabelValues.push(...pullRequestLabelSettings.globalValue);

}

// Return early if no config present

if (!defaultLabelValues || defaultLabelValues.length === 0) {

return [];

}

// Fetch labels from the repo and filter with case-sensitive comparison to be safe,

// dropping any labels that don't exist on the repo.

// TODO: @alexr00 - Add a cache for this.

const labels = await this._folderRepositoryManager.getLabels(undefined, { owner: defaultBaseRemote.owner, repo: defaultBaseRemote.repositoryName });

const defaultLabels = labels.filter(label => defaultLabelValues.includes(label.name));

return defaultLabels;

}

protected abstract getTitleAndDescription(compareBranch: Branch, baseBranch: string): Promise<{ title: string, description: string }>;

protected async getMergeConfiguration(owner: string, name: string, refetch: boolean = false): Promise<RepoAccessAndMergeMethods | undefined> {

const repo = await this._folderRepositoryManager.createGitHubRepositoryFromOwnerName(owner, name);

if (!repo) {

return undefined;

}

return repo.getRepoAccessAndMergeMethods(refetch);

}

protected saveRecentlyUsedBranch(owner: string, repositoryName: string, branchName: string): void {

const repoKey = `${owner}/${repositoryName}`;

const state = this._folderRepositoryManager.context.workspaceState.get<RecentlyUsedBranchesState>(RECENTLY_USED_BRANCHES, { branches: {} });

// Get the current list for this repo

let recentBranches = state.branches[repoKey] || [];

// Remove the branch if it's already in the list

recentBranches = recentBranches.filter(b => b !== branchName);

// Add it to the front

recentBranches.unshift(branchName);

// Limit to 10 branches

recentBranches = recentBranches.slice(0, 10);

// Save back to state

state.branches[repoKey] = recentBranches;

this._folderRepositoryManager.context.workspaceState.update(RECENTLY_USED_BRANCHES, state);

}

private initializeWhenVisibleDisposable: vscode.Disposable | undefined;

public async initializeParams(reset: boolean = false): Promise<void> {

if (this._view?.visible === false && this.initializeWhenVisibleDisposable === undefined) {

this.initializeWhenVisibleDisposable = this._view?.onDidChangeVisibility(() => {

this.initializeWhenVisibleDisposable?.dispose();

this.initializeWhenVisibleDisposable = undefined;

void this.initializeParams();

});

return;

}

if (reset) {

// First clear all state ASAP

this._postMessage({ command: 'reset' });

}

await this.initializeParamsPromise();

}

private _alreadyInitializing: Promise<CreateParamsNew> | undefined;

private async initializeParamsPromise(): Promise<CreateParamsNew> {

if (!this._alreadyInitializing) {

this._alreadyInitializing = this.doInitializeParams();

this._alreadyInitializing.then(() => {

this._alreadyInitializing = undefined;

});

}

return this._alreadyInitializing;

}

protected abstract detectBaseMetadata(defaultCompareBranch: Branch): Promise<BaseBranchMetadata | undefined>;

// Called once the detected base branch is known, before getTitleAndDescription runs.

// Subclasses can override to update model state that getTitleAndDescription depends on.

protected onBaseBranchDetected(_baseOwner: string, _baseBranch: string): void { }

protected getTitleAndDescriptionProvider(name?: string) {

return this._folderRepositoryManager.getTitleAndDescriptionProvider(name);

}

protected async getCreateParams(): Promise<CreateParamsNew> {

const defaultCompareBranch = await this._folderRepositoryManager.repository.getBranch(this._defaultCompareBranch);

const [detectedBaseMetadata, remotes, defaultOrigin] = await Promise.all([

this.detectBaseMetadata(defaultCompareBranch),

this._folderRepositoryManager.getGitHubRemotes(),

this._folderRepositoryManager.getOrigin(defaultCompareBranch),

ensureEmojis(this._folderRepositoryManager.context)

]);

const defaultBaseRemote: RemoteInfo = {

owner: detectedBaseMetadata?.owner ?? this._pullRequestDefaults.owner,

repositoryName: detectedBaseMetadata?.repositoryName ?? this._pullRequestDefaults.repo,

};

const defaultCompareRemote: RemoteInfo = {

owner: defaultOrigin.remote.owner,

repositoryName: defaultOrigin.remote.repositoryName,

};

const defaultBaseBranch = detectedBaseMetadata?.branch ?? this._pullRequestDefaults.base;

// Notify subclasses so they can update model state before getTitleAndDescription runs.

this.onBaseBranchDetected(defaultBaseRemote.owner, defaultBaseBranch);

let defaultTitleAndDescription: { title: string; description: string };

let mergeConfiguration: RepoAccessAndMergeMethods | undefined;

let viewerPermission: ViewerPermission;

let mergeQueueMethodForBranch: MergeMethod | undefined;

let labels: ILabel[];

try {

[defaultTitleAndDescription, mergeConfiguration, viewerPermission, mergeQueueMethodForBranch, labels] = await Promise.all([

this.getTitleAndDescription(defaultCompareBranch, defaultBaseBranch),

this.getMergeConfiguration(defaultBaseRemote.owner, defaultBaseRemote.repositoryName),

defaultOrigin.getViewerPermission(),

this._folderRepositoryManager.mergeQueueMethodForBranch(defaultBaseBranch, defaultBaseRemote.owner, defaultBaseRemote.repositoryName),

this.getPullRequestDefaultLabels(defaultBaseRemote)

]);

} catch (e) {

if (isRateLimitError(e)) {

vscode.window.showErrorMessage(vscode.l10n.t('GitHub API rate limit exceeded. Please wait and try again.'));

}

Logger.error(`Error initializing create pull request view: ${e}`, BaseCreatePullRequestViewProvider.ID);

return {

canModifyBranches: true,

defaultBaseRemote,

defaultBaseBranch,

defaultCompareRemote,

defaultCompareBranch: this._defaultCompareBranch,

defaultTitle: '',

defaultDescription: '',

baseHasMergeQueue: false,

remoteCount: remotes.length,

autoMergeDefault: false,

createError: '',

isDraftDefault: false,

isDarkTheme: vscode.window.activeColorTheme.kind === vscode.ColorThemeKind.Dark,

generateTitleAndDescriptionTitle: undefined,

creating: false,

initializeWithGeneratedTitleAndDescription: false,

preReviewState: PreReviewState.None,

preReviewer: undefined,

reviewing: false,

usingTemplate: false,

};

}

const defaultCreateOption = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<'lastUsed' | 'create' | 'createDraft' | 'createAutoMerge'>(DEFAULT_CREATE_OPTION, 'lastUsed');

const lastCreateMethod: { autoMerge: boolean, mergeMethod: MergeMethod | undefined, isDraft: boolean } | undefined = this._folderRepositoryManager.context.workspaceState.get<{ autoMerge: boolean, mergeMethod: MergeMethod, isDraft } | undefined>(PREVIOUS_CREATE_METHOD, undefined);

const repoMergeMethod = mergeConfiguration ? getDefaultMergeMethod(mergeConfiguration.mergeMethodsAvailability) : 'merge' as MergeMethod;

// default values are for 'create'

let defaultMergeMethod: MergeMethod = repoMergeMethod;

let isDraftDefault: boolean = false;

let autoMergeDefault: boolean = false;

defaultMergeMethod = (defaultCreateOption === 'lastUsed' && lastCreateMethod?.mergeMethod) ? lastCreateMethod?.mergeMethod : repoMergeMethod;

if (defaultCreateOption === 'lastUsed') {

defaultMergeMethod = lastCreateMethod?.mergeMethod ?? repoMergeMethod;

isDraftDefault = !!lastCreateMethod?.isDraft;

autoMergeDefault = !!mergeConfiguration?.viewerCanAutoMerge && !!lastCreateMethod?.autoMerge;

} else if (defaultCreateOption === 'createDraft') {

isDraftDefault = true;

} else if (defaultCreateOption === 'createAutoMerge') {

autoMergeDefault = !!mergeConfiguration?.viewerCanAutoMerge;

}

commands.setContext(contexts.CREATE_PR_PERMISSIONS, viewerPermission);

const descriptionSource = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<'commit' | 'template' | 'none' | 'Copilot'>(PULL_REQUEST_DESCRIPTION);

const useCopilot: boolean = !!this.getTitleAndDescriptionProvider('Copilot') && (descriptionSource === 'Copilot');

const usingTemplate: boolean = descriptionSource === 'template';

const defaultTitleAndDescriptionProvider = this.getTitleAndDescriptionProvider()?.title;

if (defaultTitleAndDescriptionProvider) {

/* __GDPR__

"pr.defaultTitleAndDescriptionProvider" : {

"providerTitle" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }

}

this.telemetry.sendTelemetryEvent('pr.defaultTitleAndDescriptionProvider', { providerTitle: defaultTitleAndDescriptionProvider });

}

const preReviewer = this._folderRepositoryManager.getAutoReviewer();

this.labels = labels.map(label => ({ ...label, displayName: emojify(label.name) }));

const params: CreateParamsNew = {

canModifyBranches: true,

defaultBaseRemote,

defaultBaseBranch,

defaultCompareRemote,

defaultCompareBranch: this._defaultCompareBranch,

defaultTitle: defaultTitleAndDescription.title,

defaultDescription: defaultTitleAndDescription.description,

defaultMergeMethod,

baseHasMergeQueue: !!mergeQueueMethodForBranch,

remoteCount: remotes.length,

allowAutoMerge: mergeConfiguration?.viewerCanAutoMerge,

mergeMethodsAvailability: mergeConfiguration?.mergeMethodsAvailability,

autoMergeDefault,

createError: '',

labels: this.labels,

isDraftDefault,

isDarkTheme: vscode.window.activeColorTheme.kind === vscode.ColorThemeKind.Dark,

generateTitleAndDescriptionTitle: defaultTitleAndDescriptionProvider,

creating: false,

initializeWithGeneratedTitleAndDescription: useCopilot,

preReviewState: PreReviewState.None,

preReviewer: preReviewer?.title,

reviewing: false,

usingTemplate

};

return params;

}

private async doInitializeParams(): Promise<CreateParamsNew> {

const params = await this.getCreateParams();

Logger.appendLine(`Initializing "create" view: ${JSON.stringify(params)}`, BaseCreatePullRequestViewProvider.ID);

this._postMessage({

command: 'pr.initialize',

params,

});

return params;

}

private async autoAssign(pr: PullRequestModel): Promise<void> {

const configuration = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<string | undefined>(ASSIGN_TO);

if (!configuration) {

return;

}

const resolved = variableSubstitution(configuration, pr, undefined, (await this._folderRepositoryManager.getCurrentUser(pr.githubRepository))?.login);

if (!resolved) {

return;

}

try {

const user = await pr.githubRepository.resolveUser(resolved);

if (user) {

await pr.replaceAssignees([user]);

}

} catch (e) {

Logger.error(`Unable to assign pull request to user ${resolved}.`, BaseCreatePullRequestViewProvider.ID);

}

private async enableAutoMerge(pr: PullRequestModel, autoMerge: boolean, automergeMethod: MergeMethod | undefined): Promise<void> {

if (autoMerge && automergeMethod) {

return pr.enableAutoMerge(automergeMethod);

}

private async setLabels(pr: PullRequestModel, labels: ILabel[]): Promise<void> {

if (labels.length > 0) {

await pr.setLabels(labels.map(label => label.name));

}

private async setAssignees(pr: PullRequestModel, assignees: IAccount[]): Promise<void> {

if (assignees.length) {

await pr.replaceAssignees(assignees);

} else {

await this.autoAssign(pr);

}

private async setReviewers(pr: PullRequestModel, reviewers: (IAccount | ITeam)[]): Promise<void> {

if (reviewers.length) {

const users: IAccount[] = [];

const teams: ITeam[] = [];

for (const reviewer of reviewers) {

if (isITeam(reviewer)) {

teams.push(reviewer);

} else {

users.push(reviewer);

}

await pr.requestReview(users, teams, true);

}

private setMilestone(pr: PullRequestModel, milestone: IMilestone | undefined) {

if (milestone) {

return pr.updateMilestone(milestone.id);

}

private setProjects(pr: PullRequestModel, projects: IProject[]) {

if (projects.length) {

return pr.updateProjects(projects);

}

private async getBaseRemote(): Promise<GitHubRemote> {

return (await this._folderRepositoryManager.getGitHubRemotes()).find(remote => compareIgnoreCase(remote.owner, this.model.baseOwner) === 0 && compareIgnoreCase(remote.repositoryName, this.model.repositoryName) === 0)!;

}

private getBaseGitHubRepo(): GitHubRepository | undefined {

return this._folderRepositoryManager.gitHubRepositories.find(repo => compareIgnoreCase(repo.remote.owner, this.model.baseOwner) === 0 && compareIgnoreCase(repo.remote.repositoryName, this.model.repositoryName) === 0);

}

private milestone: IMilestone | undefined;

public async addMilestone(): Promise<void> {

const remote = await this.getBaseRemote();

const repo = this._folderRepositoryManager.gitHubRepositories.find(repo => repo.remote.remoteName === remote.remoteName)!;

return getMilestoneFromQuickPick(this._folderRepositoryManager, repo, this.milestone, (milestone) => {

this.milestone = milestone;

return this._postMessage({

command: 'set-milestone',

params: { milestone: this.milestone }

});

}

private reviewers: (IAccount | ITeam)[] = [];

public async addReviewers(): Promise<void> {

let quickPick: vscode.QuickPick<vscode.QuickPickItem & {

user?: IAccount | ITeam | undefined;

}> | undefined;

const remote = await this.getBaseRemote();

try {

const repo = this._folderRepositoryManager.gitHubRepositories.find(repo => repo.remote.remoteName === remote.remoteName)!;

const [metadata, author, teamsCount] = await Promise.all([repo?.getMetadata(), this._folderRepositoryManager.getCurrentUser(), this._folderRepositoryManager.getOrgTeamsCount(repo)]);

quickPick = await reviewersQuickPick(this._folderRepositoryManager, remote.remoteName, !!metadata?.organization, teamsCount, author, this.reviewers.map(reviewer => { return { reviewer, state: 'REQUESTED' }; }), []);

quickPick.busy = false;

const acceptPromise = asPromise<void>(quickPick.onDidAccept).then(() => {

return quickPick!.selectedItems.filter(item => item.user) as (vscode.QuickPickItem & { user: IAccount | ITeam })[] | undefined;

});

const hidePromise = asPromise<void>(quickPick.onDidHide);

const allReviewers = await Promise.race<(vscode.QuickPickItem & { user: IAccount | ITeam })[] | void>([acceptPromise, hidePromise]);

quickPick.busy = true;

if (allReviewers) {

this.reviewers = allReviewers.map(item => item.user);

this._postMessage({

command: 'set-reviewers',

params: { reviewers: this.reviewers }

});

}

} catch (e) {

Logger.error(`Failed to add reviewers: ${formatError(e)}`, BaseCreatePullRequestViewProvider.ID);

vscode.window.showErrorMessage(formatError(e));

} finally {

quickPick?.hide();

quickPick?.dispose();

}

private assignees: IAccount[] = [];

public async addAssignees(): Promise<void> {

const remote = await this.getBaseRemote();

const currentRepo = this._folderRepositoryManager.gitHubRepositories.find(repo => repo.remote.owner === remote.owner && repo.remote.repositoryName === remote.repositoryName);

const assigneesToAdd = await vscode.window.showQuickPick(getAssigneesQuickPickItems(this._folderRepositoryManager, currentRepo, remote.remoteName, this.assignees, undefined, true),

{ canPickMany: true, matchOnDescription: true, placeHolder: vscode.l10n.t('Add assignees') });

if (assigneesToAdd) {

const seenNewAssignees = new Set<string>();

const addedAssignees = assigneesToAdd.map(assignee => assignee.user).filter<IAccount>((assignee): assignee is IAccount => {

if (assignee && !seenNewAssignees.has(assignee.login)) {

seenNewAssignees.add(assignee.login);

return true;

}

return false;

});

this.assignees = addedAssignees;

this._postMessage({

command: 'set-assignees',

params: { assignees: this.assignees }

});

}

private projects: IProject[] = [];

public async addProjects(): Promise<void> {

const githubRepo = this.getBaseGitHubRepo();

if (!githubRepo) {

return;

}

await new Promise<void>((resolve) => {

getProjectFromQuickPick(this._folderRepositoryManager, githubRepo, this.projects, async (projects) => {

this.projects = projects;

this._postMessage({

command: 'set-projects',

params: { projects: this.projects }

});

resolve();

});

}

private labels: DisplayLabel[] = [];

public async addLabels(): Promise<void> {

let newLabels: DisplayLabel[] = [];

const labelsToAdd = await vscode.window.showQuickPick<vscode.QuickPickItem & { name: string }>(

getLabelOptions(this._folderRepositoryManager, this.labels, this.model.baseOwner, this.model.repositoryName).then(options => {

newLabels = options.newLabels;

return options.labelPicks;

}),

{ canPickMany: true, matchOnDescription: true, placeHolder: vscode.l10n.t('Apply labels') },

);

if (labelsToAdd) {

const addedLabels: DisplayLabel[] = labelsToAdd.map(label => newLabels.find(l => l.name === label.name)!);

this.labels = addedLabels;

this._postMessage({

command: 'set-labels',

params: { labels: this.labels }

});

}

private async removeLabel(message: IRequestMessage<{ label: ILabel }>,): Promise<void> {

const { label } = message.args;

if (!label)

return;

const previousLabelsLength = this.labels.length;

this.labels = this.labels.filter(l => l.name !== label.name);

if (previousLabelsLength === this.labels.length)

return;

this._postMessage({

command: 'set-labels',

params: { labels: this.labels }

});

}

public async createFromCommand(isDraft: boolean, autoMerge: boolean, autoMergeMethod: MergeMethod | undefined, mergeWhenReady?: boolean) {

const params: Partial<CreateParamsNew> = {

isDraft,

autoMerge,

autoMergeMethod: mergeWhenReady ? 'merge' : autoMergeMethod,

creating: true

};

return this._postMessage({

command: 'create',

params

});

}

protected abstract create(message: IRequestMessage<CreatePullRequestNew>): Promise<void>;

protected async postCreate(message: IRequestMessage<CreatePullRequestNew>, createdPR: PullRequestModel) {

return Promise.all([

this.setLabels(createdPR, message.args.labels),

this.enableAutoMerge(createdPR, message.args.autoMerge, message.args.autoMergeMethod),

this.setAssignees(createdPR, message.args.assignees),

this.setReviewers(createdPR, message.args.reviewers),

this.setMilestone(createdPR, message.args.milestone),

this.setProjects(createdPR, message.args.projects)]);

}

private async cancel(message: IRequestMessage<CancelCreatePullRequestNew>) {

if (message.args.hasUnsavedChanges

&& vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<boolean>(SHOW_CREATE_PULL_REQUEST_CANCEL_CONFIRMATION, true)) {

const discard = vscode.l10n.t('Discard');

const dontAskAgain = vscode.l10n.t('Don\'t Ask Again');

const result = await vscode.window.showWarningMessage(

vscode.l10n.t('Are you sure you want to cancel creating this pull request?'),

{ modal: true, detail: vscode.l10n.t('Your unsaved changes to this pull request will be lost.') },

discard,

dontAskAgain

);

if (result !== discard && result !== dontAskAgain) {

return this._replyMessage(message, { cancelled: false });

}

if (result === dontAskAgain) {

await vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).update(SHOW_CREATE_PULL_REQUEST_CANCEL_CONFIRMATION, false, vscode.ConfigurationTarget.Global);

}

// Reply before firing _onDone so the webview receives the message before

// the panel is disposed (disposing clears _webview, making _replyMessage a no-op).

this._replyMessage(message, { cancelled: true });

this._onDone.fire(undefined);

// Re-fetch the automerge info so that it's updated for next time.

await this.getMergeConfiguration(message.args.owner, message.args.repo, true);

}

private async openDescriptionSettings(): Promise<void> {

return vscode.commands.executeCommand('workbench.action.openSettings', 'githubPullRequests.pullRequestDescription');

}

protected override async _onDidReceiveMessage(message: IRequestMessage<any>) {

const result = await super._onDidReceiveMessage(message);

if (result !== this.MESSAGE_UNHANDLED) {

return;

}

switch (message.command) {

case 'pr.requestInitialize':

return this.initializeParamsPromise();

case 'pr.cancelCreate':

return this.cancel(message);

case 'pr.create':

return this.create(message);

case 'pr.changeLabels':

return this.addLabels();

case 'pr.changeReviewers':

return this.addReviewers();

case 'pr.changeAssignees':

return this.addAssignees();

case 'pr.changeMilestone':

return this.addMilestone();

case 'pr.changeProjects':

return this.addProjects();

case 'pr.removeLabel':

return this.removeLabel(message);

case 'pr.openDescriptionSettings':

return this.openDescriptionSettings();

default:

return this.MESSAGE_UNHANDLED;

}

override dispose() {

super.dispose();

this._postMessage({ command: 'reset' });

}

private _getHtmlForWebview() {

const nonce = generateUuid();

const uri = vscode.Uri.joinPath(this._extensionUri, 'dist', 'webview-create-pr-view-new.js');

return `<!DOCTYPE html>

<head>

<title>Create Pull Request</title>

</head>

<body>

</body>

</html>`;

}

function serializeRemoteInfo(remote: { owner: string, repositoryName: string }) {

return { owner: remote.owner, repositoryName: remote.repositoryName };

}

export class CreatePullRequestViewProvider extends BaseCreatePullRequestViewProvider<CreatePullRequestDataModel> implements vscode.WebviewViewProvider {

public override readonly viewType = 'github:createPullRequestWebview';

constructor(

telemetry: ITelemetry,

model: CreatePullRequestDataModel,

extensionUri: vscode.Uri,

folderRepositoryManager: FolderRepositoryManager,

pullRequestDefaults: PullRequestDefaults,

) {

super(telemetry, model, extensionUri, folderRepositoryManager, pullRequestDefaults, model.compareBranch);

this._register(this.model.onDidChange(async (e) => {

let baseRemote: RemoteInfo | undefined;

let baseBranch: string | undefined;

if (e.baseOwner) {

const gitHubRemote = this._folderRepositoryManager.findRepo(repo => compareIgnoreCase(repo.remote.owner, e.baseOwner!) === 0 && compareIgnoreCase(repo.remote.repositoryName, this.model.repositoryName) === 0)?.remote;

baseRemote = gitHubRemote ? serializeRemoteInfo(gitHubRemote) : undefined;

baseBranch = this.model.baseBranch;

}

if (e.baseBranch) {

baseBranch = e.baseBranch;

}

let compareRemote: RemoteInfo | undefined;

let compareBranch: string | undefined;

if (e.compareOwner) {

const gitHubRemote = this._folderRepositoryManager.findRepo(repo => compareIgnoreCase(repo.remote.owner, e.compareOwner!) === 0 && compareIgnoreCase(repo.remote.repositoryName, this.model.repositoryName) === 0)?.remote;

compareRemote = gitHubRemote ? serializeRemoteInfo(gitHubRemote) : undefined;

compareBranch = this.model.compareBranch;

}

if (e.compareBranch) {

compareBranch = e.compareBranch;

}

const params: Partial<CreateParamsNew> = {

baseRemote,

baseBranch,

compareRemote,

compareBranch,

warning: await this.existingPRMessage(),

};

// TODO: consider updating title and description

return this._postMessage({

command: 'pr.initialize',

params,

});

}));

}

private async existingPRMessage(): Promise<string | undefined> {

const [existingPR, hasUpstream] = await Promise.all([PullRequestGitHelper.getMatchingPullRequestMetadataForBranch(this._folderRepositoryManager.repository, this.model.compareBranch), this.model.getCompareHasUpstream()]);

if (!existingPR || !hasUpstream) {

return undefined;

}

const [pr, compareBranch] = await Promise.all([this._folderRepositoryManager.resolvePullRequest(existingPR.owner, existingPR.repositoryName, existingPR.prNumber), this._folderRepositoryManager.repository.getBranch(this.model.compareBranch)]);

return (pr?.head?.sha === compareBranch.commit) ? vscode.l10n.t('A pull request already exists for this branch.') : undefined;

}

public async setDefaultCompareBranch(compareBranch: Branch | undefined) {

if (!compareBranch?.name) {

return;

}

this._defaultCompareBranch = compareBranch.name;

this.model.setCompareBranch(compareBranch.name);

this.changeBranch(compareBranch.name, false).then(async titleAndDescription => {

const params: Partial<CreateParamsNew> = {

defaultTitle: titleAndDescription.title,

defaultDescription: titleAndDescription.description,

compareBranch: compareBranch.name,

defaultCompareBranch: compareBranch.name,

warning: await this.existingPRMessage(),

};

return this._postMessage({

command: 'pr.initialize',

params,

});

}

public override show(compareBranch?: Branch): void {

if (compareBranch) {

this.setDefaultCompareBranch(compareBranch); // don't await, view will be updated when the branch is changed

}

super.show();

}

private async getTotalGitHubCommits(compareBranch: Branch, baseBranchName: string): Promise<{ commit: { message: string }; parents: { sha: string }[] }[] | undefined> {

const origin = await this._folderRepositoryManager.getOrigin(compareBranch);

if (compareBranch.upstream) {

const headRepo = this._folderRepositoryManager.findRepo(byRemoteName(compareBranch.upstream.remote));

if (headRepo) {

const headBranch = `${headRepo.remote.owner}:${compareBranch.name ?? ''}`;

const baseBranch = `${this._pullRequestDefaults.owner}:${baseBranchName}`;

const compareResult = await origin.compareCommits(baseBranch, headBranch);

return compareResult?.commits;

}

return undefined;

}

protected async getTitleAndDescription(compareBranch: Branch, baseBranch: string): Promise<{ title: string, description: string }> {

let title: string = '';

let description: string = '';

const descriptionSource = vscode.workspace.getConfiguration(PR_SETTINGS_NAMESPACE).get<'commit' | 'template' | 'branchName' | 'none' | 'Copilot'>(PULL_REQUEST_DESCRIPTION);

if (descriptionSource === 'none') {

return { title, description };

}

const name = compareBranch.name;

const branchNameTitle = (name: string) => {

const nameWithSpaces = name.replace(/[-_]/g, ' ');

return `${nameWithSpaces.charAt(0).toUpperCase()}${nameWithSpaces.slice(1)}`;

};

// If branchName is selected, use the branch name as the title

if (descriptionSource === 'branchName') {

if (name) {

title = branchNameTitle(name);

}

return { title, description };

}

// Use same default as GitHub, if there is only one commit, use the commit, otherwise use the branch name, as long as it is not the default branch.

// By default, the base branch we use for comparison is the base branch of origin. Compare this to the

// compare branch if it has a GitHub remote.

const origin = await this._folderRepositoryManager.getOrigin(compareBranch);

let useBranchName = this._pullRequestDefaults.base === compareBranch.name;

Logger.debug(`Compare branch name: ${compareBranch.name}, Base branch name: ${this._pullRequestDefaults.base}`, CreatePullRequestViewProvider.ID);

try {

const [totalCommits, lastCommit, pullRequestTemplate] = await Promise.all([

this.getTotalGitHubCommits(compareBranch, baseBranch),

name ? titleAndBodyFrom(promiseWithTimeout(this._folderRepositoryManager.getTipCommitMessage(name), 5000)) : undefined,

descriptionSource === 'template' ? this.getPullRequestTemplate() : undefined

]);

let totalNonMergeCommitsCount: number | undefined = totalCommits?.filter(commit => commit.parents.length < 2).length;

// If we couldn't determine the number of commits from GitHub (e.g. no upstream, or the compare API

// call failed), fall back to the local git log so that we can still match github.com's behavior of

// using the branch name when there is more than one commit.

if (totalNonMergeCommitsCount === undefined) {

try {

const localCommits = await this.model.gitCommits();

totalNonMergeCommitsCount = localCommits.filter(commit => commit.parents.length < 2).length;

} catch (e) {

Logger.debug(`Failed to retrieve local git commits as fallback for PR title for branch ${name}: ${e}`, CreatePullRequestViewProvider.ID);

}

Logger.debug(`Total commits: ${totalNonMergeCommitsCount}`, CreatePullRequestViewProvider.ID);

if (totalNonMergeCommitsCount === undefined) {

// We couldn't determine the number of commits at all. Use the last commit as the title and description.

useBranchName = false;

} else if (totalNonMergeCommitsCount > 1) {

const defaultBranch = await origin.getDefaultBranch();

useBranchName = defaultBranch !== compareBranch.name;

}

if (name && !lastCommit) {

Logger.appendLine('Timeout getting last commit message', CreatePullRequestViewProvider.ID);

/* __GDPR__

"pr.create.getCommitTimeout" : {}

this.telemetry.sendTelemetryEvent('pr.create.getCommitTimeout');

}

// Set title

if (useBranchName && name) {

title = branchNameTitle(name);

} else if (name && lastCommit) {

title = lastCommit.title;

}

// Set description

// Match GitHub.com behavior: only use the commit body when there is a single commit.

if (pullRequestTemplate && lastCommit?.body && !useBranchName) {

description = `${lastCommit.body}\n\n${pullRequestTemplate}`;

} else if (pullRequestTemplate) {

description = pullRequestTemplate;

} else if (lastCommit?.body && !useBranchName && (this._pullRequestDefaults.base !== compareBranch.name)) {

description = lastCommit.body;

}

// If the description is empty, check to see if the title of the PR contains something that looks like an issue

if (!description) {

const issueExpMatch = title.match(ISSUE_EXPRESSION);

const match = parseIssueExpressionOutput(issueExpMatch);

if (match?.issueNumber && !match.name && !match.owner) {

description = `#${match.issueNumber}`;

const prefix = title.substr(0, title.indexOf(issueExpMatch![0]));

const keyWordMatch = prefix.match(ISSUE_CLOSING_KEYWORDS);

if (keyWordMatch) {

description = `${keyWordMatch[0]} ${description}`;

}

} catch (e) {

// Ignore and fall back to commit message

Logger.debug(`Error while getting total commits: ${e}`, CreatePullRequestViewProvider.ID);

}

return { title, description };

}

private async getPullRequestTemplate(): Promise<string | undefined> {

return this._folderRepositoryManager.getPullRequestTemplateBody(this.model.baseOwner);

}

private async changeTemplate(message: IRequestMessage<any>): Promise<void> {

const templates = await this._folderRepositoryManager.getAllPullRequestTemplates(this.model.baseOwner);

if (!templates || templates.length === 0) {

// No templates found - show helpful options

const learnMore = vscode.l10n.t('Learn More');

const createTemplate = vscode.l10n.t('Create Template');

const selected = await vscode.window.showQuickPick(

[

{

label: createTemplate,

description: vscode.l10n.t('Create a new pull request template')

{

label: learnMore,

description: vscode.l10n.t('Open GitHub documentation')

}

{

placeHolder: vscode.l10n.t('No pull request templates found'),

ignoreFocusOut: true

}

);

if (selected?.label === learnMore) {

vscode.env.openExternal(vscode.Uri.parse('https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository'));

} else if (selected?.label === createTemplate) {

await this.createPullRequestTemplate();

}

return this._replyMessage(message, undefined);

}

// Multiple templates exist - show quick pick

const selectedTemplate = await vscode.window.showQuickPick(

templates.map((template, index) => {

// Try to extract a meaningful name from the template (first line or first few chars)

const firstLine = template.split('\n')[0].trim();

const label = firstLine || vscode.l10n.t('Template {0}', index + 1);

return {

label: label.substring(0, 50) + (label.length > 50 ? '...' : ''),

description: vscode.l10n.t('{0} characters', template.length),

template: template

};

}),

{

placeHolder: vscode.l10n.t('Select a pull request template'),

ignoreFocusOut: true

}

);

if (selectedTemplate) {

const reply: ChangeTemplateReply = {

description: selectedTemplate.template

};

return this._replyMessage(message, reply);

}

return this._replyMessage(message, undefined);

}

private async createPullRequestTemplate(): Promise<void> {

// Show options for where to create the template

const templateLocations = [

{

label: '.github/pull_request_template.md',

description: vscode.l10n.t('Default location for a single template')

{

label: 'docs/pull_request_template.md',

description: vscode.l10n.t('Alternative location in docs folder')

{

label: '.github/PULL_REQUEST_TEMPLATE/template.md',

description: vscode.l10n.t('For multiple templates')

}

];

const selected = await vscode.window.showQuickPick(templateLocations, {

placeHolder: vscode.l10n.t('Choose where to create the pull request template'),

ignoreFocusOut: true

});

if (!selected) {

return;

}

// Get the repository root

const workspaceFolder = this._folderRepositoryManager.repository.rootUri;

const templatePath = vscode.Uri.joinPath(workspaceFolder, selected.label);

// Default template content

const templateContent = `## Sample Pull Request Template Description

This is a sample pull request template. You can customize it to fit your project's needs.

Don't forget to commit your template file to the repository so that it can be used for future pull requests!

try {

// Ensure all parent directories exist by creating them step by step

const pathParts = selected.label.split('/');

let currentPath = workspaceFolder;

// Create each directory in the path (excluding the file name)

for (let i = 0; i < pathParts.length - 1; i++) {

currentPath = vscode.Uri.joinPath(currentPath, pathParts[i]);

try {

await vscode.workspace.fs.createDirectory(currentPath);

} catch (e) {

// Re-throw if it's not a FileSystemError about the directory already existing

if (e instanceof vscode.FileSystemError && e.code !== 'FileExists') {

throw e;

}

// Directory already exists, which is fine

View remainder of file in raw view

vscode-pull-request-github/src/github/createPRViewProvider.ts at main · tamird/vscode-pull-request-github · GitHub

Expand file tree

Breadcrumbs

createPRViewProvider.ts

Latest commit

History

Breadcrumbs

createPRViewProvider.ts

File metadata and controls