@gitkraken/core-gitlens 0.5.108 → 0.5.110

package/src/plus/integrations/models/gitHostIntegration.ts

@@ -1,7 +1,7 @@
 import type { CollectionMetadata, CollectionScopeFailure } from '@gitkraken/provider-apis';
 import type { Account, UnidentifiedAuthor } from '../../../git/models/author.js';
 import type { DefaultBranch } from '../../../git/models/defaultBranch.js';
-import type { IssueSearchCriteria, IssueShape, IssueStateFilter } from '../../../git/models/issue.js';
+import type { IssueSearchCriteria, IssueShape } from '../../../git/models/issue.js';
 import type { IssueOrPullRequestState as PullRequestState } from '../../../git/models/issueOrPullRequest.js';
 import type {
 	PullRequest,
@@ -20,7 +20,7 @@ import { getScopedLogger } from '../../../utils/logger.scoped.js';
 import type { PagedResult } from '../../../utils/paging.js';
 import type { ProviderAuthenticationSession } from '../authentication/models.js';
 import { toTokenWithInfo } from '../authentication/models.js';
-import { toCollectionScopeFailure } from '../collectionMetadata.js';
+import { throwIfCallerContractError, toCollectionScopeFailure } from '../collectionMetadata.js';
 import type { IntegrationIds } from '../constants.js';
 import { GitCloudHostIntegrationId, GitSelfManagedHostIntegrationId } from '../constants.js';
 import { toError } from '../errors.js';
@@ -56,6 +56,7 @@ import type {
 	ProviderPullRequestSearchPage,
 } from './integration.js';
 import { IntegrationBase } from './integration.js';
+import type { MyIssuesForReposOptions } from './issueReads.js';
 
 function isAzureDevOpsProvider(
 	providerId: IntegrationIds,
@@ -673,17 +674,7 @@ export abstract class GitHostIntegration<
 
 	async getMyIssuesForRepos(
 		reposOrRepoIds: ProviderReposInput,
-		options?: {
-			filters?: IssueFilter[];
-			cursor?: string;
-			customUrl?: string;
-			page?: number;
-			pageSize?: number;
-			/** When true, don't constrain to the current user's assigned issues even if the Assignee filter is set. */
-			includeAllAssignees?: boolean;
-			/** Issue states to include; when omitted the provider returns its default (open only). */
-			state?: IssueStateFilter;
-		},
+		options?: MyIssuesForReposOptions,
 		connectionId?: string,
 	): Promise<PagedResult<ProviderIssue> | undefined> {
 		return (await this.getMyIssuesForReposResult(reposOrRepoIds, options, connectionId))?.value;
@@ -697,15 +688,7 @@ export abstract class GitHostIntegration<
 	 */
 	async getMyIssuesForReposResult(
 		reposOrRepoIds: ProviderReposInput,
-		options?: {
-			filters?: IssueFilter[];
-			cursor?: string;
-			customUrl?: string;
-			page?: number;
-			pageSize?: number;
-			includeAllAssignees?: boolean;
-			state?: IssueStateFilter;
-		},
+		options?: MyIssuesForReposOptions,
 		connectionId?: string,
 	): Promise<IntegrationResult<(PagedResult<ProviderIssue> & { metadata?: CollectionMetadata }) | undefined>> {
 		const scope = getScopedLogger();
@@ -828,6 +811,7 @@ export abstract class GitHostIntegration<
 								page: projectInput.cursor == null ? options?.page : undefined,
 								pageSize: options?.pageSize,
 								states: states,
+								sort: options?.sort,
 							},
 						);
 						return { projectInput: projectInput, results: results };
@@ -838,6 +822,10 @@ export abstract class GitHostIntegration<
 					const outcome = settled[i];
 					const projectInput = projectInputs[i];
 					if (outcome.status !== 'fulfilled') {
+						// Errors that really are per-scope (auth, rate limit, a missing project) degrade below; one
+						// that is a fact about the call is re-thrown instead — see `throwIfCallerContractError`.
+						throwIfCallerContractError(outcome.reason);
+
 						truncated = true;
 						const failure = toCollectionScopeFailure(
 							{
@@ -963,6 +951,7 @@ export abstract class GitHostIntegration<
 								page: repoInput.cursor == null ? options?.page : undefined,
 								pageSize: options?.pageSize,
 								states: states,
+								sort: options?.sort,
 							},
 						);
 						return { repoInput: repoInput, results: results };
@@ -973,6 +962,11 @@ export abstract class GitHostIntegration<
 					const outcome = settled[i];
 					const repoInput = repoInputs[i];
 					if (outcome.status !== 'fulfilled') {
+						// See the project fan-out above. Reachable in practice even though the facade validates the
+						// key first — a self-managed GitLab can reject an `IssueSort` member the SDK declares, which
+						// is only discoverable from the response.
+						throwIfCallerContractError(outcome.reason);
+
 						truncated = true;
 						const failure = toCollectionScopeFailure(
 							{
@@ -1030,6 +1024,7 @@ export abstract class GitHostIntegration<
 				page: options?.page,
 				pageSize: options?.pageSize,
 				states: states,
+				sort: options?.sort,
 			});
 			return { value: result, duration: performance.now() - start };
 		} catch (ex) {
@@ -1050,15 +1045,7 @@ export abstract class GitHostIntegration<
 	 */
 	async getMyIssuesForReposAsShapesResult(
 		reposOrRepoIds: ProviderReposInput,
-		options?: {
-			filters?: IssueFilter[];
-			cursor?: string;
-			customUrl?: string;
-			page?: number;
-			pageSize?: number;
-			includeAllAssignees?: boolean;
-			state?: IssueStateFilter;
-		},
+		options?: MyIssuesForReposOptions,
 		connectionId?: string,
 	): Promise<IntegrationResult<(PagedResult<IssueShape> & { metadata?: CollectionMetadata }) | undefined>> {
 		const result = await this.getMyIssuesForReposResult(reposOrRepoIds, options, connectionId);
@@ -1768,6 +1755,35 @@ export abstract class GitHostIntegration<
 		cancellation?: AbortSignal,
 	): Promise<(number | undefined)[] | undefined>;
 
+	/** The PR twin of {@link countIssuesResult}: counts each scope's pull requests, transferring none. */
+	async countPullRequestsResult(
+		scopes: readonly { repos?: ProviderRepoInput[]; org?: string; criteria?: PullRequestSearchCriteria }[],
+		cancellation?: AbortSignal,
+		connectionId?: string,
+	): Promise<IntegrationResult<(number | undefined)[] | undefined>> {
+		const scope = getScopedLogger();
+		// `connectionId` targets a specific account (multi-account); omitted reads the primary.
+		const session = await this.resolveReadSession(connectionId, scope);
+		if (session == null) return undefined;
+
+		const start = performance.now();
+		try {
+			const counts = await this.countProviderPullRequests?.(session, scopes, cancellation);
+			this.resetRequestExceptionCount('countPullRequests');
+			return { value: counts, duration: performance.now() - start };
+		} catch (ex) {
+			this.handleProviderException('countPullRequests', ex, { scope: scope, connectionId: connectionId });
+			return { error: toError(ex), duration: performance.now() - start };
+		}
+	}
+
+	/** OPTIONAL, like {@link countProviderIssues}: only a provider that can count without fetching implements it. */
+	protected countProviderPullRequests?(
+		session: ProviderAuthenticationSession,
+		scopes: readonly { repos?: ProviderRepoInput[]; org?: string; criteria?: PullRequestSearchCriteria }[],
+		cancellation?: AbortSignal,
+	): Promise<(number | undefined)[] | undefined>;
+
 	getPullRequestIdentityFromMaybeUrl(search: string): PullRequestUrlIdentity | undefined {
 		return this.getProviderPullRequestIdentityFromMaybeUrl?.(search);
 	}

package/src/plus/integrations/models/integration.ts

@@ -81,6 +81,7 @@ type SyncReqUsecase = Exclude<
 	| 'getResourcesForUser'
 	| 'getSshSigningKeysForEmails'
 	| 'countIssues'
+	| 'countPullRequests'
 	| 'mergePullRequest'
 	| 'searchIssuesPage'
 	| 'searchPullRequestsPage'

package/src/plus/integrations/models/issueReads.ts

@@ -1,5 +1,5 @@
 import type { CollectionMetadata } from '@gitkraken/provider-apis';
-import type { IssueShape } from '../../../git/models/issue.js';
+import type { IssueShape, IssueSorting, IssueStateFilter } from '../../../git/models/issue.js';
 import type { IssueFilter } from '../providerFilters.js';
 
 /**
@@ -42,6 +42,58 @@ export type ProviderIssueSearchPage = {
 	totalCount?: number;
 };
 
+/**
+ * Options for an issue tracker's PROJECT-scoped read (`IssuesIntegration.getIssuesForProject*`), which is the
+ * only issue surface a tracker has — its issues live under resource -> project, so there is no account-wide read
+ * to pair this with.
+ *
+ * Named rather than repeated inline at each of the six declarations this shape appears in (the two public
+ * `Result` methods, the two protected provider cores, and their Jira/Linear/Trello overrides), so a field added
+ * here can't reach five of them and be forgotten in the sixth.
+ */
+export type IssuesForProjectOptions = {
+	/** The account handle to scope to, resolved per resource by the caller. Omitted reads every assignee. */
+	user?: string;
+	/** Validated by the caller against `ProviderMetadata.supportedIssueFilters`; unsupported refuses the read. */
+	filters?: IssueFilter[];
+	/**
+	 * How the provider should order the project's issues, as `field:direction`.
+	 *
+	 * Validated against `ProviderMetadata.supportedIssueSorts` — a tracker reports there, not under the
+	 * account-wide table. Note the caller reads MANY projects and merges them, so it additionally refuses a key
+	 * no normalized issue carries; this option orders one project's query.
+	 */
+	sort?: IssueSorting;
+};
+
+/**
+ * Options for the REPO-scoped issue read (`GitHostIntegration.getMyIssuesForRepos*`), the git-host counterpart of
+ * {@link IssuesForProjectOptions}.
+ *
+ * Named for the same reason that one is: the shape appears at three declarations — the public method, its
+ * result-returning core, and the shapes-returning core that maps it — and was previously spelled out inline at
+ * each, so `sort` had to be added three times and two of the copies grew a `See {@link getMyIssuesForRepos}`
+ * breadcrumb to admit they were the same contract. One name means a field added here reaches all three.
+ */
+export type MyIssuesForReposOptions = {
+	/** Validated by the caller against `ProviderMetadata.supportedIssueFilters`; unsupported refuses the read. */
+	filters?: IssueFilter[];
+	cursor?: string;
+	customUrl?: string;
+	page?: number;
+	pageSize?: number;
+	/** When true, don't constrain to the current user's assigned issues even if the Assignee filter is set. */
+	includeAllAssignees?: boolean;
+	/** Issue states to include; when omitted the provider returns its default (open only). */
+	state?: IssueStateFilter;
+	/**
+	 * How the provider should order the read. Forwarded to every query this read issues, so the ORDER WITHIN each
+	 * scope is the provider's; the union across scopes is not ordered here — the facade (`listIssuesPage`) owns
+	 * that, because it is also the layer that can refuse a key no merge can honor.
+	 */
+	sort?: IssueSorting;
+};
+
 /**
  * Options for the account-wide issue read. `includeAllAssignees` drops the "assigned to me" scoping so the
  * read broadens to issues assigned to anyone (the account-wide equivalent of the repo-scoped
@@ -70,4 +122,16 @@ export type SearchMyIssuesOptions = {
 	 */
 	org?: string;
 	project?: string;
+	/**
+	 * How the provider should order the read, as `field:direction`.
+	 *
+	 * Validated by the facade against `ProviderMetadata.supportedAccountWideIssueSorts` — a DIFFERENT table from
+	 * the repo-scoped one, because for GitLab the two reads are different APIs with different sort vocabularies —
+	 * and refused rather than downgraded when the provider can't express it.
+	 *
+	 * Supplied on every facade read, never omitted: an omitted sort leaves each provider's own default, which is
+	 * exactly the cross-provider incoherence this layer exists to remove. A provider that reaches this with
+	 * `undefined` was called directly, not through the facade, and keeps whatever order it had.
+	 */
+	sort?: IssueSorting;
 };

package/src/plus/integrations/models/issuesIntegration.ts

@@ -8,9 +8,10 @@ import { getScopedLogger } from '../../../utils/logger.scoped.js';
 import type { ProviderAuthenticationSession } from '../authentication/models.js';
 import type { IntegrationIds } from '../constants.js';
 import { toError } from '../errors.js';
-import type { IssueFilter, ProviderApiCollectionResult } from '../providers/models.js';
+import type { ProviderApiCollectionResult } from '../providers/models.js';
 import type { Integration, IntegrationResult, IntegrationType } from './integration.js';
 import { IntegrationBase } from './integration.js';
+import type { IssuesForProjectOptions } from './issueReads.js';
 
 export function isIssuesIntegration(integration: Integration): integration is IssuesIntegration {
 	return integration.type === 'issues';
@@ -135,7 +136,7 @@ export abstract class IssuesIntegration<
 	@trace()
 	async getIssuesForProject(
 		project: T,
-		options?: { user?: string; filters?: IssueFilter[] },
+		options?: IssuesForProjectOptions,
 		connectionId?: string,
 	): Promise<IssueShape[] | undefined> {
 		return (await this.getIssuesForProjectResult(project, options, connectionId))?.value;
@@ -148,7 +149,7 @@ export abstract class IssuesIntegration<
 	 */
 	async getIssuesForProjectResult(
 		project: T,
-		options?: { user?: string; filters?: IssueFilter[] },
+		options?: IssuesForProjectOptions,
 		connectionId?: string,
 	): Promise<IntegrationResult<IssueShape[] | undefined>> {
 		const scope = getScopedLogger();
@@ -174,7 +175,7 @@ export abstract class IssuesIntegration<
 	 */
 	async getIssuesForProjectWithTruncationResult(
 		project: T,
-		options?: { user?: string; filters?: IssueFilter[] },
+		options?: IssuesForProjectOptions,
 		connectionId?: string,
 	): Promise<
 		IntegrationResult<{ values: IssueShape[]; truncated: boolean; metadata?: CollectionMetadata } | undefined>
@@ -196,7 +197,7 @@ export abstract class IssuesIntegration<
 	protected abstract getProviderIssuesForProject(
 		session: ProviderAuthenticationSession,
 		project: T,
-		options?: { user?: string; filters?: IssueFilter[] },
+		options?: IssuesForProjectOptions,
 	): Promise<IssueShape[] | undefined>;
 
 	/**
@@ -208,7 +209,7 @@ export abstract class IssuesIntegration<
 	protected async getProviderIssuesForProjectWithTruncation(
 		session: ProviderAuthenticationSession,
 		project: T,
-		options?: { user?: string; filters?: IssueFilter[] },
+		options?: IssuesForProjectOptions,
 	): Promise<{ values: IssueShape[]; truncated: boolean; metadata?: CollectionMetadata } | undefined> {
 		const values = await this.getProviderIssuesForProject(session, project, options);
 		if (values == null) return undefined;

package/src/plus/integrations/providerFilters.ts

@@ -19,6 +19,8 @@ export type {
 	IssueSearchCapabilities,
 	IssueSearchCriteria,
 	IssueSearchRelationship,
+	IssueSortField,
+	IssueSorting,
 } from '../../git/models/issue.js';
 
 /**
@@ -26,4 +28,9 @@ export type {
  * same dependency-direction reason as the issue-search model above: provider API clients translate them below
  * this package and cannot import this facade.
  */
-export type { PullRequestSearchCapabilities, PullRequestSearchCriteria } from '../../git/models/pullRequest.js';
+export type {
+	PullRequestSearchCapabilities,
+	PullRequestSearchCriteria,
+	PullRequestSortField,
+	PullRequestSorting,
+} from '../../git/models/pullRequest.js';

package/src/plus/integrations/providers/accounts.ts

@@ -0,0 +1,34 @@
+import type { Account as ProviderAccount } from '@gitkraken/provider-apis';
+import type { IssueMember } from '../../../git/models/issue.js';
+import type { PullRequestMember } from '../../../git/models/pullRequest.js';
+
+export function toProviderAccount(account: PullRequestMember | IssueMember): ProviderAccount {
+	return {
+		id: account.id ?? null,
+		avatarUrl: account.avatarUrl ?? null,
+		name: account.name ?? null,
+		url: account.url ?? null,
+		// TODO: Implement these in our own model
+		email: '',
+		username: account.name ?? null,
+	};
+}
+
+export function fromProviderAccount(account: ProviderAccount | null): PullRequestMember | IssueMember {
+	return {
+		id: account?.id ?? '',
+		// An absent name stays absent. `'unknown'` was a display fallback invented in the provider layer, and a
+		// consumer couldn't tell it apart from a member genuinely named that — so it couldn't be undone where a
+		// name-shaped placeholder is wrong (rendering an avatar-only chip, or building an AI prompt, where
+		// `Assignees: unknown` reads as a real assignee). It also disagreed with {@link toIssueShape}, which
+		// collapsed the same absent name to `''` — same facade method, two fallbacks. Both now emit `undefined`.
+		name: account?.name ?? undefined,
+		avatarUrl: account?.avatarUrl ?? undefined,
+		// `url` is optional, so an absent one must be `undefined`, not `''`. `''` passes a `!= null` presence
+		// check and renders as a link to nowhere, and it disagreed with {@link toIssueShape} — which already
+		// collapses to `undefined` — even though BOTH mappers feed `listIssuesPage` (the repo-scoped path goes
+		// through `toIssueShape`, Azure's account-wide path through {@link fromProviderIssue}). Same facade
+		// method, two shapes. Matches {@link toProviderRepositoryShape}, which collapses every absent optional.
+		url: account?.url ?? undefined,
+	};
+}

package/src/plus/integrations/providers/azureDevOps.ts

@@ -1057,6 +1057,7 @@ export abstract class AzureDevOpsIntegrationBase<
 						...options,
 						...filter,
 						cursor: cursor,
+						sort: searchOptions?.sort,
 					}),
 				20,
 				{ providerId: this.id, resourceId: p.resourceId, projectId: p.name },