Implements getAccountForCommit for Bitbucket

(#4192)

Author: sergeibbb

src/plus/integrations/providers/bitbucket.ts

@@ -1,7 +1,7 @@
 import type { AuthenticationSession, CancellationToken } from 'vscode';
 import { md5 } from '@env/crypto';
 import { HostingIntegrationId } from '../../../constants.integrations';
-import type { Account } from '../../../git/models/author';
+import type { Account, UnidentifiedAuthor } from '../../../git/models/author';
 import type { DefaultBranch } from '../../../git/models/defaultBranch';
 import type { Issue, IssueShape } from '../../../git/models/issue';
 import type { IssueOrPullRequest, IssueOrPullRequestType } from '../../../git/models/issueOrPullRequest';
@@ -49,14 +49,24 @@ export class BitbucketIntegration extends HostingIntegration<
 	}
 
 	protected override async getProviderAccountForCommit(
-		_session: AuthenticationSession,
-		_repo: BitbucketRepositoryDescriptor,
-		_rev: string,
-		_options?: {
+		{ accessToken }: AuthenticationSession,
+		repo: BitbucketRepositoryDescriptor,
+		rev: string,
+		options?: {
 			avatarSize?: number;
 		},
-	): Promise<Account | undefined> {
-		return Promise.resolve(undefined);
+	): Promise<Account | UnidentifiedAuthor | undefined> {
+		return (await this.container.bitbucket)?.getAccountForCommit(
+			this,
+			accessToken,
+			repo.owner,
+			repo.name,
+			rev,
+			this.apiBaseUrl,
+			{
+				avatarSize: options?.avatarSize,
+			},
+		);
 	}
 
 	protected override async getProviderAccountForEmail(

src/plus/integrations/providers/bitbucket/bitbucket.ts

@@ -13,6 +13,7 @@ import {
 	RequestClientError,
 	RequestNotFoundError,
 } from '../../../../errors';
+import type { Account, CommitAuthor, UnidentifiedAuthor } from '../../../../git/models/author';
 import type { Issue } from '../../../../git/models/issue';
 import type { IssueOrPullRequest, IssueOrPullRequestType } from '../../../../git/models/issueOrPullRequest';
 import type { PullRequest } from '../../../../git/models/pullRequest';
@@ -28,8 +29,13 @@ import { maybeStopWatch } from '../../../../system/stopwatch';
 import type { BitbucketServerPullRequest } from '../bitbucket-server/models';
 import { normalizeBitbucketServerPullRequest } from '../bitbucket-server/models';
 import { fromProviderPullRequest } from '../models';
-import type { BitbucketIssue, BitbucketPullRequest, BitbucketRepository } from './models';
-import { bitbucketIssueStateToState, fromBitbucketIssue, fromBitbucketPullRequest } from './models';
+import type { BitbucketCommit, BitbucketIssue, BitbucketPullRequest, BitbucketRepository } from './models';
+import {
+	bitbucketIssueStateToState,
+	fromBitbucketIssue,
+	fromBitbucketPullRequest,
+	parseRawBitbucketAuthor,
+} from './models';
 
 export class BitbucketApi implements Disposable {
 	private readonly _disposable: Disposable;
@@ -456,6 +462,63 @@ export class BitbucketApi implements Disposable {
 		}
 	}
 
+	@debug<BitbucketApi['getAccountForCommit']>({ args: { 0: p => p.name, 1: '<token>' } })
+	async getAccountForCommit(
+		provider: Provider,
+		token: string,
+		owner: string,
+		repo: string,
+		rev: string,
+		baseUrl: string,
+		_options?: {
+			avatarSize?: number;
+		},
+		cancellation?: CancellationToken,
+	): Promise<Account | UnidentifiedAuthor | undefined> {
+		const scope = getLogScope();
+
+		try {
+			const commit = await this.request<BitbucketCommit>(
+				provider,
+				token,
+				baseUrl,
+				`repositories/${owner}/${repo}/commit/${rev}`,
+				{
+					method: 'GET',
+				},
+				scope,
+				cancellation,
+			);
+			if (!commit) {
+				return undefined;
+			}
+
+			const { name, email } = parseRawBitbucketAuthor(commit.author.raw);
+			const commitAuthor: CommitAuthor = {
+				provider: provider,
+				id: commit.author.user?.account_id,
+				username: commit.author.user?.nickname,
+				name: commit.author.user?.display_name || name,
+				email: email,
+				avatarUrl: commit.author.user?.links?.avatar?.href,
+			};
+			if (commitAuthor.id != null && commitAuthor.username != null) {
+				return {
+					...commitAuthor,
+					id: commitAuthor.id,
+				} satisfies Account;
+			}
+			return {
+				...commitAuthor,
+				id: undefined,
+				username: undefined,
+			} satisfies UnidentifiedAuthor;
+		} catch (ex) {
+			Logger.error(ex, scope);
+			return undefined;
+		}
+	}
+
 	private async request<T>(
 		provider: Provider,
 		token: string,

src/plus/integrations/providers/bitbucket/models.ts

@@ -104,6 +104,12 @@ export interface BitbucketRepository {
 	};
 }
 
+interface BitbucketCommitAuthor {
+	type: 'author';
+	raw: string;
+	user: BitbucketUser;
+}
+
 type BitbucketMergeStrategy =
 	| 'merge_commit'
 	| 'squash'
@@ -118,7 +124,45 @@ interface BitbucketBranch {
 	default_merge_strategy?: BitbucketMergeStrategy;
 }
 
-interface BitbucketPullRequestCommit {
+// It parses a raw author sitring like "Sergei Shmakov GK <[email protected]>" to name and email
+const parseRawBitbucketAuthorRegex = /^(.*) <(.*)>$/;
+export function parseRawBitbucketAuthor(raw: string): { name: string; email: string } {
+	const match = raw.match(parseRawBitbucketAuthorRegex);
+	if (match) {
+		return { name: match[1], email: match[2] };
+	}
+	return { name: raw, email: '' };
+}
+
+export interface BitbucketCommit {
+	type: 'commit';
+	author: BitbucketCommitAuthor;
+	date: string;
+	hash: string;
+	links: {
+		approve: BitbucketLink;
+		comments: BitbucketLink;
+		diff: BitbucketLink;
+		html: BitbucketLink;
+		self: BitbucketLink;
+		statuses: BitbucketLink;
+	};
+	message: string;
+	parents: BitbucketBriefCommit[];
+	participants: BitbucketPullRequestParticipant[];
+	rendered: {
+		message: string;
+	};
+	repository: BitbucketRepository;
+	summary: {
+		type: 'rendered';
+		raw: string;
+		markup: string;
+		html: string;
+	};
+}
+
+interface BitbucketBriefCommit {
 	type: 'commit';
 	hash: string;
 	links: {
@@ -144,7 +188,7 @@ export interface BitbucketPullRequest {
 	title: string;
 	description: string;
 	state: BitbucketPullRequestState;
-	merge_commit: null | BitbucketPullRequestCommit;
+	merge_commit: null | BitbucketBriefCommit;
 	comment_count: number;
 	task_count: number;
 	close_source_branch: boolean;
@@ -155,12 +199,12 @@ export interface BitbucketPullRequest {
 	updated_on: string;
 	destination: {
 		branch: BitbucketBranch;
-		commit: BitbucketPullRequestCommit;
+		commit: BitbucketBriefCommit;
 		repository: BitbucketRepository;
 	};
 	source: {
 		branch: BitbucketBranch;
-		commit: BitbucketPullRequestCommit;
+		commit: BitbucketBriefCommit;
 		repository: BitbucketRepository;
 	};
 	summary: {