@gitkraken/core-gitlens 0.3.1 → 0.4.100

package/src/plus/integrations/providers/gitlab/gitlab.utils.ts

@@ -0,0 +1,80 @@
+import type { PullRequestUrlIdentity } from '../../../../git/utils/pullRequest.utils.js';
+import { equalsIgnoreCase } from '../../../../utils/string.js';
+import type { GitCloudHostIntegrationId, GitSelfManagedHostIntegrationId } from '../../constants.js';
+import type { GitLabUser } from './models.js';
+
+export type GitLabIntegrationIds =
+	| GitCloudHostIntegrationId.GitLab
+	| GitSelfManagedHostIntegrationId.CloudGitLabSelfHosted;
+
+export function isMaybeGitLabPullRequestUrl(url: string): boolean {
+	return getGitLabPullRequestIdentityFromMaybeUrl(url) != null;
+}
+
+export function getGitLabPullRequestIdentityFromMaybeUrl(
+	search: string,
+): (PullRequestUrlIdentity & { provider: undefined }) | undefined;
+export function getGitLabPullRequestIdentityFromMaybeUrl(
+	search: string,
+	id: GitLabIntegrationIds,
+): (PullRequestUrlIdentity & { provider: GitLabIntegrationIds }) | undefined;
+export function getGitLabPullRequestIdentityFromMaybeUrl(
+	search: string,
+	id?: GitLabIntegrationIds,
+): (PullRequestUrlIdentity & { provider: GitLabIntegrationIds | undefined }) | undefined {
+	let ownerAndRepo: string | undefined = undefined;
+	let prNumber: string | undefined = undefined;
+
+	let match = search.match(/([^/]+\/[^/]+)\/(?:-\/merge_requests)\/(\d+)/); // with org and rep name
+	if (match != null) {
+		ownerAndRepo = match[1];
+		prNumber = match[2];
+	}
+
+	if (prNumber == null) {
+		match = search.match(/(?:\/|^)(?:-\/merge_requests)\/(\d+)/); // without repo name
+		if (match != null) {
+			prNumber = match[1];
+		}
+	}
+
+	return prNumber != null ? { ownerAndRepo: ownerAndRepo, prNumber: prNumber, provider: id } : undefined;
+}
+
+/**
+ * Selects the GitLab user that authored a commit from a set of search results.
+ *
+ * GitLab has no way to resolve a commit's author to a user directly, so we search users by name/email and
+ * disambiguate here. To avoid showing a stranger's avatar when multiple users share a name (see #2205), we only
+ * return a user when we can identify them confidently — a matching public email, or a single exact name match.
+ * Otherwise we return `undefined` so avatar resolution falls back to the commit email's Gravatar.
+ */
+export function selectGitLabUserForCommit(
+	users: GitLabUser[],
+	authorName: string,
+	authorEmail: string | undefined,
+): GitLabUser | undefined {
+	if (users.length === 0) return undefined;
+
+	// Strongest signal: a public email that matches the commit email — unambiguous identity
+	if (authorEmail) {
+		const byEmail = users.find(u => u.publicEmail && equalsIgnoreCase(u.publicEmail, authorEmail));
+		if (byEmail != null) return byEmail;
+	}
+
+	// Otherwise fall back to an exact name match — but only when it's unambiguous
+	const nameMatches = users.filter(u => equalsIgnoreCase(u.name, authorName));
+	if (nameMatches.length === 1) return nameMatches[0];
+
+	// No matches, or multiple name matches we can't disambiguate by email — don't guess
+	return undefined;
+}
+
+/**
+ * Checks whether a repository's namespace belongs to the given org/group, including subgroups
+ * (e.g. namespace `parent/sub` matches org `parent`). Mirrors gkcli's `gitlabOrgMatches`, used to
+ * filter `getReposForCurrentUser` results since GitLab has no group-scoped repos endpoint.
+ */
+export function matchesGitLabOrgNamespace(namespace: string, org: string): boolean {
+	return namespace === org || namespace.startsWith(`${org}/`);
+}

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

@@ -0,0 +1,271 @@
+import type { PullRequestRefs, PullRequestState } from '../../../../git/models/pullRequest.js';
+import { PullRequest, PullRequestMergeableState } from '../../../../git/models/pullRequest.js';
+import type { Provider } from '../../../../git/models/remoteProvider.js';
+import type { Integration } from '../../models/integration.js';
+import type { ProviderPullRequest } from '../models.js';
+import { fromProviderPullRequest } from '../models.js';
+
+export interface GitLabUser {
+	id: number;
+	name: string;
+	username: string;
+	publicEmail: string | undefined;
+	state: string;
+	avatarUrl: string | undefined;
+	webUrl: string;
+}
+
+/** A user's SSH key as returned by `GET /users/:id/keys`. */
+export interface GitLabSshKey {
+	id: number;
+	title: string;
+	key: string;
+	created_at: string;
+	expires_at: string | null;
+	/** Whether the key can be used for authentication, signing, or both. */
+	usage_type: 'auth' | 'signing' | 'auth_and_signing';
+}
+
+export interface GitLabCommit {
+	id: string;
+	short_id: string;
+	created_at: Date;
+	parent_ids: string[];
+	title: string;
+	message: string;
+	author_name: string;
+	author_email: string;
+	authored_date: Date;
+	committer_name: string;
+	committer_email: string;
+	committed_date: Date;
+	status: string;
+	project_id: number;
+}
+
+export interface GitLabIssue {
+	iid: string;
+	author: {
+		name: string;
+		avatarUrl: string | null;
+		webUrl: string;
+	} | null;
+	title: string;
+	description: string;
+	createdAt: string;
+	updatedAt: string;
+	closedAt: string;
+	webUrl: string;
+	state: 'opened' | 'closed' | 'locked';
+}
+
+export interface GitLabMergeRequest {
+	iid: string;
+	author: {
+		id: string;
+		name: string;
+		avatarUrl: string | null;
+		webUrl: string;
+	} | null;
+	title: string;
+	description: string | null;
+	state: GitLabMergeRequestState;
+	createdAt: string;
+	updatedAt: string;
+	mergedAt: string | null;
+	webUrl: string;
+}
+
+export interface GitLabRepositoryStub {
+	id: string;
+	fullPath: string;
+	webUrl: string;
+}
+
+export interface GitLabMergeRequestFull extends GitLabMergeRequest {
+	id: string;
+	targetBranch: string;
+	sourceBranch: string;
+	diffRefs: {
+		baseSha: string | null;
+		headSha: string;
+	} | null;
+	project: GitLabRepositoryStub;
+	sourceProject: GitLabRepositoryStub | null;
+}
+
+export type GitLabMergeRequestState = 'opened' | 'closed' | 'locked' | 'merged';
+
+export function fromGitLabMergeRequestState(state: GitLabMergeRequestState): PullRequestState {
+	return state === 'locked' ? 'closed' : state;
+}
+
+export function toGitLabMergeRequestState(state: PullRequestState): GitLabMergeRequestState {
+	return state;
+}
+
+export interface GitLabMergeRequestREST {
+	id: number;
+	iid: number;
+	author: {
+		id: string;
+		name: string;
+		avatar_url?: string;
+		web_url: string;
+	} | null;
+	title: string;
+	description: string;
+	state: GitLabMergeRequestState;
+	created_at: string;
+	updated_at: string;
+	closed_at: string | null;
+	merged_at: string | null;
+	diff_refs: {
+		base_sha: string;
+		head_sha: string;
+		start_sha: string;
+	};
+	source_branch: string;
+	source_project_id: number;
+	target_branch: string;
+	target_project_id: number;
+	web_url: string;
+}
+
+export function fromGitLabMergeRequestREST(
+	pr: GitLabMergeRequestREST,
+	provider: Provider,
+	repo: { owner: string; repo: string },
+): PullRequest {
+	return new PullRequest(
+		provider,
+		{
+			id: pr.author?.id ?? '',
+			// An absent author stays absent — no invented `'Unknown'` name, no `''` url/avatar. See
+			// `PullRequestMember.name`.
+			name: pr.author?.name ?? undefined,
+			avatarUrl: pr.author?.avatar_url ?? undefined,
+			url: pr.author?.web_url ?? undefined,
+		},
+		String(pr.iid),
+		undefined,
+		pr.title,
+		pr.web_url,
+		repo,
+		fromGitLabMergeRequestState(pr.state),
+		new Date(pr.created_at),
+		new Date(pr.updated_at),
+		pr.closed_at == null ? undefined : new Date(pr.closed_at),
+		pr.merged_at == null ? undefined : new Date(pr.merged_at),
+	);
+}
+
+export interface GitLabProjectREST {
+	namespace: {
+		path: string;
+		full_path: string;
+	};
+	path: string;
+
+	forked_from_project?: {
+		namespace: {
+			path: string;
+			full_path: string;
+		};
+		path: string;
+	};
+}
+
+export function fromGitLabMergeRequestProvidersApi(pr: ProviderPullRequest, provider: Integration): PullRequest {
+	const wrappedPr: ProviderPullRequest = {
+		...pr,
+		// @gitkraken/providers-api returns global ID as id, while allover GitLens we use internal ID (iid) that is returned as `number`:
+		id: String(pr.number),
+		// Substitute some defaults that are needed to enable PRs because @gitkraken/providers-api always returns null here:
+		// Discussed: https://github.com/gitkraken/provider-apis-package-js/blob/6ee521eb6b46bbb759d9c68646979c3b25681d90/src/providers/gitlab/gitlab.ts#L597
+		permissions: pr.permissions ?? {
+			canMerge: true,
+			canMergeAndBypassProtections: false,
+		},
+	};
+	return fromProviderPullRequest(wrappedPr, provider);
+}
+
+export function fromGitLabMergeRequest(pr: GitLabMergeRequestFull, provider: Provider): PullRequest {
+	let avatarUrl: string | undefined;
+	try {
+		avatarUrl = new URL(pr.author?.avatarUrl ?? '').toString();
+	} catch {
+		try {
+			const authorUrl = new URL(pr.author?.webUrl ?? '');
+			authorUrl.pathname = '';
+			authorUrl.search = '';
+			authorUrl.hash = '';
+			avatarUrl = pr.author?.avatarUrl ? authorUrl.toString() + pr.author?.avatarUrl : undefined;
+		} catch {
+			avatarUrl = undefined;
+		}
+	}
+	const [owner, repo] = pr.project.fullPath.split('/');
+
+	return new PullRequest(
+		provider,
+		{
+			// author
+			id: pr.author?.id ?? '',
+			// An absent author stays absent — no invented `'Unknown'` name, no `''` url. See `PullRequestMember.name`.
+			name: pr.author?.name ?? undefined,
+			avatarUrl: avatarUrl,
+			url: pr.author?.webUrl ?? undefined,
+		},
+		pr.iid, // id
+		pr.id, // nodeId
+		pr.title,
+		pr.webUrl || '',
+		{
+			// IssueRepository
+			owner: owner,
+			repo: repo,
+			url: pr.project.webUrl,
+		},
+		fromGitLabMergeRequestState(pr.state), // PullRequestState
+		new Date(pr.createdAt),
+		new Date(pr.updatedAt),
+		// TODO@eamodio this isn't right, but GitLab doesn't seem to provide a closedAt on merge requests in GraphQL
+		pr.state !== 'closed' ? undefined : new Date(pr.updatedAt),
+		pr.mergedAt == null ? undefined : new Date(pr.mergedAt),
+		PullRequestMergeableState.Unknown,
+		undefined, // viewerCanUpdate
+		fromGitLabMergeRequestRefs(pr), // PullRequestRefs
+	);
+}
+
+function fromGitLabMergeRequestRefs(pr: GitLabMergeRequestFull): PullRequestRefs | undefined {
+	if (pr.sourceProject == null) {
+		return undefined;
+	}
+	// GitLab terminology: sourceBranch = branch with changes (head), targetBranch = merge target (base)
+	return {
+		head: {
+			owner: getRepoNamespace(pr.sourceProject.fullPath),
+			branch: pr.sourceBranch,
+			exists: true,
+			url: pr.sourceProject.webUrl,
+			repo: pr.sourceProject.fullPath,
+			sha: pr.diffRefs?.headSha || '',
+		},
+		base: {
+			owner: getRepoNamespace(pr.project.fullPath),
+			branch: pr.targetBranch,
+			exists: true,
+			url: pr.project.webUrl,
+			repo: pr.project.fullPath,
+			sha: pr.diffRefs?.baseSha || '',
+		},
+		isCrossRepository: pr.sourceProject.id !== pr.project.id,
+	};
+}
+
+function getRepoNamespace(projectFullPath: string) {
+	return projectFullPath.split('/').slice(0, -1).join('/');
+}