@gitkraken/core-gitlens 0.3.0 → 0.4.0

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

@@ -0,0 +1,445 @@
+import type { IssueRepository } from '../../../../git/models/issue.js';
+import { Issue, RepositoryAccessLevel } from '../../../../git/models/issue.js';
+import type { IssueOrPullRequestState } from '../../../../git/models/issueOrPullRequest.js';
+import type { PullRequestMember, PullRequestReviewer } from '../../../../git/models/pullRequest.js';
+import {
+	PullRequest,
+	PullRequestMergeableState,
+	PullRequestReviewDecision,
+	PullRequestReviewState,
+} from '../../../../git/models/pullRequest.js';
+import type { Provider } from '../../../../git/models/remoteProvider.js';
+import type { ResourceDescriptor } from '../../../../git/models/resourceDescriptor.js';
+
+export interface BitbucketRepositoryDescriptor extends ResourceDescriptor {
+	owner: string;
+	name: string;
+}
+
+export interface BitbucketWorkspaceDescriptor extends ResourceDescriptor {
+	id: string;
+	name: string;
+	slug: string;
+}
+
+export type BitbucketPullRequestState = 'OPEN' | 'DECLINED' | 'MERGED' | 'SUPERSEDED';
+
+interface BitbucketLink {
+	href: string;
+	name?: string;
+}
+
+interface BitbucketUser {
+	type: 'user';
+	uuid: string;
+	display_name: string;
+	account_id?: string;
+	nickname?: string;
+	links: {
+		self: BitbucketLink;
+		avatar: BitbucketLink;
+		html: BitbucketLink;
+	};
+}
+
+interface BitbucketWorkspace {
+	type: 'workspace';
+	uuid: string;
+	name: string;
+	slug: string;
+	links: {
+		self: BitbucketLink;
+		html: BitbucketLink;
+		avatar: BitbucketLink;
+	};
+}
+
+interface BitbucketProject {
+	type: 'project';
+	key: string;
+	uuid: string;
+	name: string;
+	links: {
+		self: BitbucketLink;
+		html: BitbucketLink;
+		avatar: BitbucketLink;
+	};
+}
+
+interface BitbucketPullRequestParticipant {
+	type: 'participant';
+	user: BitbucketUser;
+	role: 'PARTICIPANT' | 'REVIEWER';
+	approved: boolean;
+	state: null | 'approved' | 'changes_requested';
+	participated_on: null | string;
+}
+
+export interface BitbucketRepository {
+	type: 'repository';
+	uuid: string;
+	full_name: string;
+	name: string;
+	slug: string;
+	description?: string;
+	is_private: boolean;
+	parent: null | BitbucketRepository;
+	scm: 'git';
+	owner: BitbucketUser;
+	workspace: BitbucketWorkspace;
+	project: BitbucketProject;
+	created_on: string;
+	updated_on: string;
+	size: number;
+	language: string;
+	has_issues: boolean;
+	has_wiki: boolean;
+	fork_policy: 'allow_forks' | 'no_public_forks' | 'no_forks';
+	website: string;
+	mainbranch?: BitbucketBranch;
+	links: {
+		self: BitbucketLink;
+		html: BitbucketLink;
+		avatar: BitbucketLink;
+	};
+}
+
+interface BitbucketCommitAuthor {
+	type: 'author';
+	raw: string;
+	user: BitbucketUser;
+}
+
+type BitbucketMergeStrategy =
+	| 'merge_commit'
+	| 'squash'
+	| 'fast_forward'
+	| 'squash_fast_forward'
+	| 'rebase_fast_forward'
+	| 'rebase_merge';
+
+interface BitbucketBranch {
+	name: string;
+	merge_strategies?: BitbucketMergeStrategy[];
+	default_merge_strategy?: BitbucketMergeStrategy;
+}
+
+// It parses a raw author sitring like "Sergei Shmakov GK <sergei.shmakov@gitkraken.com>" 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 extends BitbucketBriefCommit {
+	author: BitbucketCommitAuthor;
+	date: 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: {
+		self: BitbucketLink;
+		html: BitbucketLink;
+	};
+}
+
+export type BitbucketIssueState =
+	| 'submitted'
+	| 'new'
+	| 'open'
+	| 'resolved'
+	| 'on hold'
+	| 'invalid'
+	| 'duplicate'
+	| 'wontfix'
+	| 'closed';
+
+export interface BitbucketPullRequest {
+	type: 'pullrequest';
+	id: number;
+	title: string;
+	description: string;
+	state: BitbucketPullRequestState;
+	merge_commit: null | BitbucketBriefCommit;
+	comment_count: number;
+	task_count: number;
+	close_source_branch: boolean;
+	closed_by: BitbucketUser | null;
+	author: BitbucketUser;
+	reason: string;
+	created_on: string;
+	updated_on: string;
+	destination: {
+		branch: BitbucketBranch;
+		commit: BitbucketBriefCommit;
+		repository: BitbucketRepository;
+	};
+	source: {
+		branch: BitbucketBranch;
+		commit: BitbucketBriefCommit;
+		repository: BitbucketRepository;
+	};
+	summary: {
+		type: 'rendered';
+		raw: string;
+		markup: string;
+		html: string;
+	};
+	reviewers?: BitbucketUser[];
+	participants?: BitbucketPullRequestParticipant[];
+	links: {
+		self: BitbucketLink;
+		html: BitbucketLink;
+		commits: BitbucketLink;
+		approve: BitbucketLink;
+		'request-changes': BitbucketLink;
+		diff: BitbucketLink;
+		diffstat: BitbucketLink;
+		comments: BitbucketLink;
+		activity: BitbucketLink;
+		merge: BitbucketLink;
+		decline: BitbucketLink;
+		statuses: BitbucketLink;
+	};
+}
+
+export interface BitbucketIssue {
+	type: string;
+	id: number;
+	title: string;
+	reporter: BitbucketUser;
+	assignee?: BitbucketUser;
+	state: BitbucketIssueState;
+	created_on: string;
+	updated_on: string;
+	repository: BitbucketRepository;
+	votes?: number;
+	content: {
+		raw: string;
+		markup: string;
+		html: string;
+	};
+	links: {
+		self: BitbucketLink;
+		html: BitbucketLink;
+		comments: BitbucketLink;
+		attachments: BitbucketLink;
+		watch: BitbucketLink;
+		vote: BitbucketLink;
+	};
+}
+
+export function bitbucketPullRequestStateToState(state: BitbucketPullRequestState): IssueOrPullRequestState {
+	switch (state) {
+		case 'DECLINED':
+		case 'SUPERSEDED':
+			return 'closed';
+		case 'MERGED':
+			return 'merged';
+		case 'OPEN':
+		default:
+			return 'opened';
+	}
+}
+
+export function bitbucketIssueStateToState(state: BitbucketIssueState): IssueOrPullRequestState {
+	switch (state) {
+		case 'resolved':
+		case 'invalid':
+		case 'duplicate':
+		case 'wontfix':
+		case 'closed':
+			return 'closed';
+		case 'submitted':
+		case 'new':
+		case 'open':
+		case 'on hold':
+		default:
+			return 'opened';
+	}
+}
+
+export function isClosedBitbucketPullRequestState(state: BitbucketPullRequestState): boolean {
+	return bitbucketPullRequestStateToState(state) !== 'opened';
+}
+
+export function isClosedBitbucketIssueState(state: BitbucketIssueState): boolean {
+	return bitbucketIssueStateToState(state) !== 'opened';
+}
+
+export function fromBitbucketUser(user: BitbucketUser): PullRequestMember {
+	return {
+		avatarUrl: user.links.avatar.href,
+		name: user.display_name,
+		url: user.links.html.href,
+		id: user.uuid,
+	};
+}
+
+export function fromBitbucketParticipantToReviewer(
+	prt: BitbucketPullRequestParticipant,
+	closedBy: BitbucketUser | null,
+	prState: BitbucketPullRequestState,
+): PullRequestReviewer {
+	return {
+		reviewer: fromBitbucketUser(prt.user),
+		state: prt.approved
+			? PullRequestReviewState.Approved
+			: prt.state === 'changes_requested'
+				? PullRequestReviewState.ChangesRequested
+				: prt.participated_on != null
+					? PullRequestReviewState.Commented
+					: prt.user.uuid === closedBy?.uuid && prState === 'DECLINED'
+						? PullRequestReviewState.Dismissed
+						: PullRequestReviewState.ReviewRequested,
+	};
+}
+
+function getBitbucketReviewDecision(pr: BitbucketPullRequest): PullRequestReviewDecision | undefined {
+	if (!pr.participants?.length && pr.reviewers?.length) {
+		return PullRequestReviewDecision.ReviewRequired;
+	}
+	if (!pr.participants) {
+		return undefined;
+	}
+
+	let hasReviews = false;
+	let hasChangeRequests = false;
+	let hasApprovals = false;
+	for (const prt of pr.participants) {
+		if (prt.participated_on != null) {
+			hasReviews = true;
+		}
+		if (prt.approved) {
+			hasApprovals = true;
+		}
+		if (prt.state === 'changes_requested') {
+			hasChangeRequests = true;
+		}
+	}
+	if (hasChangeRequests) return PullRequestReviewDecision.ChangesRequested;
+	if (hasApprovals) return PullRequestReviewDecision.Approved;
+	if (hasReviews) return undefined; // not approved, not rejected, but reviewed
+	return PullRequestReviewDecision.ReviewRequired; // nobody has reviewed yet.
+}
+
+function fromBitbucketRepository(repo: BitbucketRepository): IssueRepository {
+	return {
+		owner: repo.full_name.split('/')[0],
+		repo: repo.name,
+		id: repo.uuid,
+		// TODO: Remove this assumption once actual access level is available
+		accessLevel: RepositoryAccessLevel.Write,
+	};
+}
+
+export function fromBitbucketIssue(issue: BitbucketIssue, provider: Provider): Issue {
+	return new Issue(
+		provider,
+		issue.id.toString(),
+		issue.id.toString(),
+		issue.title,
+		issue.links.html.href,
+		new Date(issue.created_on),
+		new Date(issue.updated_on),
+		isClosedBitbucketIssueState(issue.state),
+		bitbucketIssueStateToState(issue.state),
+		fromBitbucketUser(issue.reporter),
+		issue.assignee ? [fromBitbucketUser(issue.assignee)] : [],
+		fromBitbucketRepository(issue.repository),
+		undefined, // closedDate
+		undefined, // labels
+		undefined, // commentsCount
+		issue.votes, // thumbsUpCount
+		issue.content.html, // body
+		!issue.repository?.project
+			? undefined
+			: {
+					id: issue.repository.project.uuid,
+					name: issue.repository.project.name,
+					resourceId: issue.repository.project.uuid,
+					resourceName: issue.repository.project.name,
+				},
+	);
+}
+
+export function fromBitbucketPullRequest(pr: BitbucketPullRequest, provider: Provider): PullRequest {
+	return new PullRequest(
+		provider,
+		fromBitbucketUser(pr.author),
+		pr.id.toString(),
+		pr.id.toString(),
+		pr.title,
+		pr.links.html.href,
+		fromBitbucketRepository(pr.destination.repository),
+		bitbucketPullRequestStateToState(pr.state),
+		new Date(pr.created_on),
+		new Date(pr.updated_on),
+		pr.closed_by ? new Date(pr.updated_on) : undefined,
+		pr.state === 'MERGED' ? new Date(pr.updated_on) : undefined,
+		// TODO: Remove this assumption once actual mergeable state is available
+		PullRequestMergeableState.Mergeable, // mergeableState
+		undefined, // viewerCanUpdate
+		{
+			base: {
+				branch: pr.destination.branch.name,
+				sha: pr.destination.commit.hash,
+				repo: pr.destination.repository.name,
+				owner: pr.destination.repository.full_name.split('/')[0],
+				exists: true,
+				url: pr.destination.repository.links.html.href,
+			},
+			head: {
+				branch: pr.source.branch.name,
+				sha: pr.source.commit.hash,
+				repo: pr.source.repository.name,
+				owner: pr.source.repository.full_name.split('/')[0],
+				exists: true,
+				url: pr.source.repository.links.html.href,
+			},
+			isCrossRepository: pr.source.repository.uuid !== pr.destination.repository.uuid,
+		},
+		undefined, // isDraft
+		undefined, // additions
+		undefined, // deletions
+		undefined, // commentsCount
+		undefined, // thumbsCount
+		getBitbucketReviewDecision(pr),
+		pr.participants // reviewRequests:PullRequestReviewer[]
+			?.filter(prt => prt.role === 'REVIEWER')
+			.map(prt => fromBitbucketParticipantToReviewer(prt, pr.closed_by, pr.state))
+			.filter(rv => rv.state === PullRequestReviewState.ReviewRequested),
+		pr.participants // latestReviews:PullRequestReviewer[]
+			?.filter(prt => prt.participated_on != null)
+			.map(prt => fromBitbucketParticipantToReviewer(prt, pr.closed_by, pr.state)),
+		undefined, // assignees:PullRequestMember[] -- it looks like there is no such thing as assignees on Bitbucket
+		undefined, // PullRequestStatusCheckRollupState
+		undefined, // IssueProject
+	);
+}

package/src/plus/integrations/providers/bitbucket-server/models.ts

@@ -0,0 +1,252 @@
+import { GitPullRequestMergeableState, GitPullRequestReviewState, GitPullRequestState } from '@gitkraken/provider-apis';
+import type { ProviderAccount, ProviderPullRequest } from '../models.js';
+
+export interface BitbucketServerLink {
+	href: string;
+}
+
+export interface NamedBitbucketServerLink<T extends string = string> extends BitbucketServerLink {
+	name: T;
+}
+
+export interface BitbucketServerPagedResponse<T> {
+	values: T[];
+	size: number;
+	limit: number;
+	isLastPage: boolean;
+	nextPageStart: number;
+	start: number;
+}
+
+export interface BitbucketServerPullRequestRef {
+	id: string;
+	displayId: string;
+	latestCommit: string;
+	type: string;
+	repository: {
+		slug: string;
+		id: number;
+		name: string;
+		hierarchyId: string;
+		scmId: string;
+		state: string;
+		statusMessage: string;
+		forkable: boolean;
+		project: {
+			key: string;
+			id: number;
+			name: string;
+			public: boolean;
+			type: string;
+			links: {
+				self: BitbucketServerLink[];
+			};
+		};
+		public: boolean;
+		archived: boolean;
+		links: {
+			clone: NamedBitbucketServerLink[];
+			self: BitbucketServerLink[];
+		};
+	};
+}
+
+export interface BitbucketAuthor {
+	name: string;
+	emailAddress: string;
+	id: undefined;
+}
+
+export interface BitbucketServerUser {
+	name: string;
+	emailAddress: string;
+	active: boolean;
+	displayName: string;
+	id: number;
+	slug: string;
+	type: string;
+	links: {
+		self: BitbucketServerLink[];
+	};
+	avatarUrl?: string;
+}
+
+export interface BitbucketServerPullRequestUser {
+	user: BitbucketServerUser;
+	lastReviewedCommit?: string;
+	role: 'REVIEWER' | 'AUTHOR' | 'PARTICIPANT';
+	approved: boolean;
+	status: 'UNAPPROVED' | 'NEEDS_WORK' | 'APPROVED';
+}
+
+export interface BitbucketServerBriefCommit {
+	displayId: string;
+	id: string;
+}
+
+export interface BitbucketServerCommit extends BitbucketServerBriefCommit {
+	author: BitbucketServerUser | BitbucketAuthor;
+	authorTimestamp: number;
+	committer: BitbucketServerUser | BitbucketAuthor;
+	committerTimestamp: number;
+	message: string;
+	parents: (BitbucketServerCommit | BitbucketServerBriefCommit)[];
+}
+
+export interface BitbucketServerPullRequest {
+	id: number;
+	version: number;
+	title: string;
+	description: string;
+	state: 'OPEN' | 'MERGED' | 'DECLINED';
+	open: boolean;
+	closed: boolean;
+	createdDate: number;
+	updatedDate: number;
+	closedDate: number | null;
+	fromRef: BitbucketServerPullRequestRef;
+	toRef: BitbucketServerPullRequestRef;
+	locked: boolean;
+	author: BitbucketServerPullRequestUser;
+	reviewers: BitbucketServerPullRequestUser[];
+	participants: BitbucketServerPullRequestUser[];
+	properties: {
+		mergeResult: {
+			outcome: string;
+			current: boolean;
+		};
+		resolvedTaskCount: number;
+		commentCount: number;
+		openTaskCount: number;
+	};
+	links: {
+		self: BitbucketServerLink[];
+	};
+}
+
+const normalizeUser = (user: BitbucketServerUser): ProviderAccount => ({
+	name: user.displayName,
+	email: user.emailAddress,
+	avatarUrl: user.avatarUrl ?? null,
+	id: user.id.toString(),
+	username: user.name,
+	url: user.links.self[0].href,
+});
+
+const reviewDecisionWeightByReviewState = {
+	[GitPullRequestReviewState.Approved]: 0,
+	[GitPullRequestReviewState.Commented]: 1,
+	[GitPullRequestReviewState.ReviewRequested]: 2,
+	[GitPullRequestReviewState.ChangesRequested]: 3,
+};
+
+export const summarizeReviewDecision = (
+	reviews: { state: GitPullRequestReviewState }[] | null,
+): GitPullRequestReviewState | null => {
+	if (!reviews || reviews.length === 0) {
+		return null;
+	}
+
+	return reviews.reduce(
+		(prev: GitPullRequestReviewState, review) =>
+			reviewDecisionWeightByReviewState[review.state] > reviewDecisionWeightByReviewState[prev]
+				? review.state
+				: prev,
+		GitPullRequestReviewState.Approved,
+	);
+};
+
+export const normalizeBitbucketServerPullRequest = (pr: BitbucketServerPullRequest): ProviderPullRequest => {
+	const bitbucketStateToGitState = {
+		OPEN: GitPullRequestState.Open,
+		MERGED: GitPullRequestState.Merged,
+		DECLINED: GitPullRequestState.Closed,
+	};
+
+	const reviewerStatusToGitState = {
+		UNAPPROVED: GitPullRequestReviewState.ReviewRequested,
+		NEEDS_WORK: GitPullRequestReviewState.ChangesRequested,
+		APPROVED: GitPullRequestReviewState.Approved,
+	};
+
+	const reviews = pr.reviewers.map(reviewer => ({
+		reviewer: normalizeUser(reviewer.user),
+		state: reviewerStatusToGitState[reviewer.status],
+	}));
+
+	const baseSSHUrl = pr.toRef.repository.links.clone.find(link => link.name === 'ssh')?.href ?? null;
+	let baseHTTPSUrl = pr.toRef.repository.links.clone.find(link => link.name === 'https')?.href ?? null;
+	if (!baseHTTPSUrl) {
+		baseHTTPSUrl = pr.toRef.repository.links.clone.find(link => link.name === 'http')?.href ?? null;
+	}
+
+	const headSSHUrl = pr.fromRef.repository.links.clone.find(link => link.name === 'ssh')?.href ?? null;
+	let headHTTPSUrl = pr.fromRef.repository.links.clone.find(link => link.name === 'https')?.href ?? null;
+	if (!headHTTPSUrl) {
+		headHTTPSUrl = pr.fromRef.repository.links.clone.find(link => link.name === 'http')?.href ?? null;
+	}
+
+	return {
+		id: pr.id.toString(),
+		number: pr.id,
+		title: pr.title,
+		description: pr.description ?? null,
+		url: pr.links.self[0].href,
+		state: bitbucketStateToGitState[pr.state],
+		isDraft: false,
+		createdDate: new Date(pr.createdDate),
+		updatedDate: new Date(pr.updatedDate),
+		closedDate: pr.closedDate ? new Date(pr.closedDate) : null,
+		mergedDate: pr.state === 'MERGED' && pr.closedDate ? new Date(pr.closedDate) : null,
+		baseRef: {
+			name: pr.toRef.displayId,
+			oid: pr.toRef.latestCommit,
+		},
+		headRef: {
+			name: pr.fromRef.displayId,
+			oid: pr.fromRef.latestCommit,
+		},
+		commentCount: pr.properties?.commentCount,
+		upvoteCount: null,
+		commitCount: null,
+		fileCount: null,
+		additions: null,
+		deletions: null,
+		author: normalizeUser(pr.author.user),
+		assignees: null,
+		reviews: reviews,
+		reviewDecision: summarizeReviewDecision(reviews),
+		repository: {
+			id: pr.toRef.repository.id.toString(),
+			name: pr.toRef.repository.name,
+			owner: {
+				login: pr.toRef.repository.project.key,
+			},
+			remoteInfo:
+				baseHTTPSUrl && baseSSHUrl
+					? {
+							cloneUrlHTTPS: baseHTTPSUrl,
+							cloneUrlSSH: baseSSHUrl,
+						}
+					: null,
+		},
+		headRepository: {
+			id: pr.fromRef.repository.id.toString(),
+			name: pr.fromRef.repository.name,
+			owner: {
+				login: pr.fromRef.repository.project.key,
+			},
+			remoteInfo:
+				headHTTPSUrl && headSSHUrl
+					? {
+							cloneUrlHTTPS: headHTTPSUrl,
+							cloneUrlSSH: headSSHUrl,
+						}
+					: null,
+		},
+		headCommit: null,
+		mergeableState: GitPullRequestMergeableState.Unknown,
+		permissions: null,
+		version: pr.version,
+	};
+};