@gitkraken/core-gitlens 0.5.109 → 0.5.110

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

@@ -41,26 +41,22 @@ import type {
 	SetPullRequestInput,
 	Trello,
 } from '@gitkraken/provider-apis';
-import entityIdentifiersModule from '@gitkraken/provider-apis/entity-identifiers';
-import providerUtilsModule from '@gitkraken/provider-apis/provider-utils';
+import { EntityIdentifierUtils } from '@gitkraken/provider-apis/entity-identifiers';
+import { GitProviderUtils } from '@gitkraken/provider-apis/provider-utils';
 import { githubSearchResultLimit } from '../../git-github/api/config.js';
 import type { Account as UserAccount } from '../../../git/models/author.js';
-import type { IssueMember, IssueProject, IssueShape, IssueStateFilter } from '../../../git/models/issue.js';
+import type { IssueProject, IssueShape, IssueStateFilter } from '../../../git/models/issue.js';
 import { Issue, RepositoryAccessLevel } from '../../../git/models/issue.js';
 import type {
-	PullRequestMember,
 	PullRequestRef,
 	PullRequestRefs,
 	PullRequestRepositoryIdentityDescriptor,
-	PullRequestReviewer,
 	PullRequestState,
 	PullRequestStateFilter,
 } from '../../../git/models/pullRequest.js';
 import {
 	PullRequest,
 	PullRequestMergeableState,
-	PullRequestReviewDecision,
-	PullRequestReviewState,
 	PullRequestStatusCheckRollupState,
 } from '../../../git/models/pullRequest.js';
 import type { Provider, ProviderReference } from '../../../git/models/remoteProvider.js';
@@ -75,7 +71,12 @@ import {
 	IssuesCloudHostIntegrationId,
 } from '../constants.js';
 import type { Integration, IntegrationType } from '../models/integration.js';
-import type { IssueSearchCapabilities, IssueSorting, PullRequestSearchCapabilities } from '../providerFilters.js';
+import type {
+	IssueSearchCapabilities,
+	IssueSorting,
+	PullRequestSearchCapabilities,
+	PullRequestSorting,
+} from '../providerFilters.js';
 import { IssueFilter, PullRequestFilter } from '../providerFilters.js';
 
 export { IssueFilter, PullRequestFilter } from '../providerFilters.js';
@@ -87,10 +88,13 @@ export type {
 	IssueSorting,
 	PullRequestSearchCapabilities,
 	PullRequestSearchCriteria,
+	PullRequestSortField,
+	PullRequestSorting,
 } from '../providerFilters.js';
 import type { ProviderRepositoryShape } from '../results.js';
 
 export type { ProviderOrganization, ProviderRepositoryShape } from '../results.js';
+import { fromProviderAccount, toProviderAccount } from './accounts.js';
 import {
 	azureAccountWideIssueSorts,
 	azureIssueSorts,
@@ -102,6 +106,15 @@ import {
 	linearIssueSorts,
 	trelloIssueSorts,
 } from './issueSorts.js';
+import type { ProviderPullRequestReview, ProviderPullRequestReviews } from './pullRequestReviews.js';
+import {
+	fromPullRequestReviewDecision,
+	providerPullRequestReviewStateDismissed,
+	toCompletedReviews,
+	toProviderReviewDecision,
+	toProviderReviews,
+	toReviewRequests,
+} from './pullRequestReviews.js';
 import { getEntityIdentifierInput } from './utils.js';
 
 type GitBuildStatusState = GitBuildStatusStateType;
@@ -110,9 +123,6 @@ type GitPullRequestMergeableState = GitPullRequestMergeableStateType;
 type GitPullRequestReviewState = GitPullRequestReviewStateType;
 type GitPullRequestState = GitPullRequestStateType;
 
-const { EntityIdentifierUtils } = entityIdentifiersModule;
-const { GitProviderUtils } = providerUtilsModule;
-
 // Local runtime copies of the `@gitkraken/provider-apis` string enums. Duplicated (not imported as
 // values) because the SDK ships as CJS whose named enum exports can't be statically imported as ESM
 // values from the bundled `dist`. Exported so the enum-parity test can deep-equal them against the
@@ -191,7 +201,7 @@ export function isRepoIdsInput(input: unknown): input is (string | number)[] {
 	);
 }
 
-export type ProviderPullRequest = GitPullRequest;
+export type ProviderPullRequest = Omit<GitPullRequest, 'reviews'> & { reviews: ProviderPullRequestReviews };
 export type ProviderRepository = GitRepository;
 export type ProviderIssue = ProviderApiIssue;
 export type ProviderEnterpriseOptions = EnterpriseOptions;
@@ -859,19 +869,36 @@ const githubIssueSearchCapabilities: IssueSearchCapabilities = {
 	sorts: githubIssueSorts,
 };
 
+/**
+ * The ordering vocabulary of GitHub's filtered PR search: `created` and `updated`, both directions.
+ *
+ * Hand-declared rather than derived from `@gitkraken/provider-apis` (which has no PR-sort surface), and narrower
+ * than the issue set on purpose: the merged relationship × state facets can only be re-ordered by a field a
+ * `PullRequestShape` carries (see `getPullRequestComparator`), and GitHub PRs have no priority and no relevance
+ * that orders stably under the result ceiling. A parity test pins this to `gitHubPullRequestSortQualifiers`' keys
+ * so the capability can't outrun the emitter.
+ */
+const githubPullRequestSorts: PullRequestSorting[] = ['updated:desc', 'updated:asc', 'created:desc', 'created:asc'];
+
 /** GitHub and GHE use the same filtered pull-request search syntax and result ceiling. */
 const githubPullRequestSearchCapabilities: PullRequestSearchCapabilities = {
 	relationships: [
 		PullRequestFilter.Author,
 		PullRequestFilter.Assignee,
 		PullRequestFilter.ReviewRequested,
+		PullRequestFilter.Reviewed,
 		PullRequestFilter.Mention,
 	],
 	states: ['open', 'closed', 'merged', 'all'],
 	text: true,
+	updatedAfter: true,
+	createdAfter: true,
 	includeArchived: true,
+	draft: true,
 	repositoryScope: true,
 	organizationScope: true,
+	// `sort:updated`, `sort:updated-asc`, `sort:created-desc`, `sort:created-asc` — see `githubPullRequestSorts`.
+	sorts: githubPullRequestSorts,
 };
 
 export const providersMetadata: ProvidersMetadata = {
@@ -894,6 +921,7 @@ export const providersMetadata: ProvidersMetadata = {
 			PullRequestFilter.Author,
 			PullRequestFilter.Assignee,
 			PullRequestFilter.ReviewRequested,
+			PullRequestFilter.Reviewed,
 			PullRequestFilter.Mention,
 		],
 		supportedPullRequestSearch: githubPullRequestSearchCapabilities,
@@ -930,6 +958,7 @@ export const providersMetadata: ProvidersMetadata = {
 			PullRequestFilter.Author,
 			PullRequestFilter.Assignee,
 			PullRequestFilter.ReviewRequested,
+			PullRequestFilter.Reviewed,
 			PullRequestFilter.Mention,
 		],
 		supportedPullRequestSearch: githubPullRequestSearchCapabilities,
@@ -1320,22 +1349,6 @@ export const fromProviderBuildStatusState = {
 	[GitBuildStatusState.Warning]: undefined,
 };
 
-export const toProviderPullRequestReviewState = {
-	[PullRequestReviewState.Approved]: GitPullRequestReviewState.Approved,
-	[PullRequestReviewState.ChangesRequested]: GitPullRequestReviewState.ChangesRequested,
-	[PullRequestReviewState.Commented]: GitPullRequestReviewState.Commented,
-	[PullRequestReviewState.ReviewRequested]: GitPullRequestReviewState.ReviewRequested,
-	[PullRequestReviewState.Dismissed]: null,
-	[PullRequestReviewState.Pending]: null,
-};
-
-export const fromProviderPullRequestReviewState = {
-	[GitPullRequestReviewState.Approved]: PullRequestReviewState.Approved,
-	[GitPullRequestReviewState.ChangesRequested]: PullRequestReviewState.ChangesRequested,
-	[GitPullRequestReviewState.Commented]: PullRequestReviewState.Commented,
-	[GitPullRequestReviewState.ReviewRequested]: PullRequestReviewState.ReviewRequested,
-};
-
 export const toProviderPullRequestMergeableState = {
 	[PullRequestMergeableState.Mergeable]: GitPullRequestMergeableState.Mergeable,
 	[PullRequestMergeableState.Conflicting]: GitPullRequestMergeableState.Conflicts,
@@ -1355,68 +1368,6 @@ export const fromProviderPullRequestMergeableState = {
 	[GitPullRequestMergeableState.Unstable]: PullRequestMergeableState.Unknown,
 };
 
-export function toProviderReviews(reviewers: PullRequestReviewer[]): ProviderPullRequest['reviews'] {
-	return reviewers
-		.filter(r => r.state !== PullRequestReviewState.Dismissed && r.state !== PullRequestReviewState.Pending)
-		.map(reviewer => ({
-			reviewer: toProviderAccount(reviewer.reviewer),
-			state: toProviderPullRequestReviewState[reviewer.state] ?? GitPullRequestReviewState.ReviewRequested,
-		}));
-}
-
-export function toReviewRequests(reviews: ProviderPullRequest['reviews']): PullRequestReviewer[] | undefined {
-	return reviews == null
-		? undefined
-		: reviews
-				?.filter(r => r.state === GitPullRequestReviewState.ReviewRequested)
-				.map(r => ({
-					isCodeOwner: false, // TODO: Find this value, and implement in the shared lib if needed
-					reviewer: fromProviderAccount(r.reviewer),
-					state: PullRequestReviewState.ReviewRequested,
-				}));
-}
-
-export function toCompletedReviews(reviews: ProviderPullRequest['reviews']): PullRequestReviewer[] | undefined {
-	return reviews == null
-		? undefined
-		: reviews
-				?.filter(r => r.state !== GitPullRequestReviewState.ReviewRequested)
-				.map(r => ({
-					isCodeOwner: false, // TODO: Find this value, and implement in the shared lib if needed
-					reviewer: fromProviderAccount(r.reviewer),
-					state: fromProviderPullRequestReviewState[r.state],
-				}));
-}
-
-export function toProviderReviewDecision(
-	reviewDecision?: PullRequestReviewDecision,
-	reviewers?: PullRequestReviewer[],
-): GitPullRequestReviewState | null {
-	switch (reviewDecision) {
-		case PullRequestReviewDecision.Approved:
-			return GitPullRequestReviewState.Approved;
-		case PullRequestReviewDecision.ChangesRequested:
-			return GitPullRequestReviewState.ChangesRequested;
-		case PullRequestReviewDecision.ReviewRequired:
-			return GitPullRequestReviewState.ReviewRequested;
-		default: {
-			if (reviewers?.some(r => r.state === PullRequestReviewState.ReviewRequested)) {
-				return GitPullRequestReviewState.ReviewRequested;
-			} else if (reviewers?.some(r => r.state === PullRequestReviewState.Commented)) {
-				return GitPullRequestReviewState.Commented;
-			}
-			return null;
-		}
-	}
-}
-
-export const fromPullRequestReviewDecision = {
-	[GitPullRequestReviewState.Approved]: PullRequestReviewDecision.Approved,
-	[GitPullRequestReviewState.ChangesRequested]: PullRequestReviewDecision.ChangesRequested,
-	[GitPullRequestReviewState.Commented]: undefined,
-	[GitPullRequestReviewState.ReviewRequested]: PullRequestReviewDecision.ReviewRequired,
-};
-
 export function toProviderPullRequestState(state: PullRequestState): GitPullRequestState {
 	return state === 'opened'
 		? GitPullRequestState.Open
@@ -1541,7 +1492,11 @@ export function toProviderPullRequest(pr: PullRequest): ProviderPullRequest {
 						name: pr.refs.head.branch,
 						oid: pr.refs.head.sha,
 					},
-		reviews: toProviderReviews(prReviews),
+		// `null` when the source carried no review data at all, rather than the empty array a lite read would
+		// otherwise produce: `toCompletedReviews`/`toReviewRequests` map `null` back to `undefined`, which is what
+		// lets a consumer tell "nobody has reviewed this" from "this read never fetched reviews" (see
+		// `PullRequestShape.latestReviews`). An empty array from a full projection stays an empty array.
+		reviews: pr.reviewRequests == null && pr.latestReviews == null ? null : toProviderReviews(prReviews),
 		reviewDecision: toProviderReviewDecision(pr.reviewDecision, prReviews),
 		repository:
 			pr.repository != null
@@ -1740,46 +1695,31 @@ export function fromProviderIssue(
 }
 
 export function toProviderPullRequestWithUniqueId(pr: PullRequest): PullRequestWithUniqueID {
+	const { reviews, ...providerPr } = toProviderPullRequest(pr);
 	return {
-		...toProviderPullRequest(pr),
+		...providerPr,
+		// The SDK boundary: `getActionablePullRequests` categorizes by review state and only knows
+		// provider-apis' own vocabulary, so the locally-added dismissed state is dropped here rather than
+		// handed over as a value it would fall through on. Our own projection keeps it — see
+		// `providerPullRequestReviewStateDismissed`. `commitOid` rides along on the surviving reviews: it is an
+		// extra property the SDK ignores, not a value it could misread.
+		reviews:
+			reviews?.filter(
+				(r): r is ProviderPullRequestReview & { state: GitPullRequestReviewState } =>
+					r.state !== providerPullRequestReviewStateDismissed,
+			) ?? null,
 		uuid: EntityIdentifierUtils.encode(getEntityIdentifierInput(pr)),
 	};
 }
 
-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,
-	};
-}
-
 export type ProviderActionablePullRequest = ActionablePullRequest;
 
-export type EnrichablePullRequest = ProviderPullRequest & {
+/**
+ * Built on the SDK's `GitPullRequest`, NOT the local {@link ProviderPullRequest} widening: this is handed to
+ * `getActionablePullRequests`, which categorizes by review state and only knows provider-apis' vocabulary.
+ * {@link toProviderPullRequestWithUniqueId} is what narrows `reviews` down to it.
+ */
+export type EnrichablePullRequest = GitPullRequest & {
 	uuid: string;
 	type: 'pullrequest';
 	provider: ProviderReference;

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

@@ -0,0 +1,122 @@
+import type { GitPullRequest } from '@gitkraken/provider-apis';
+import { GitPullRequestReviewState } from '@gitkraken/provider-apis';
+import type { PullRequestReviewer } from '../../../git/models/pullRequest.js';
+import { PullRequestReviewDecision, PullRequestReviewState } from '../../../git/models/pullRequest.js';
+import { fromProviderAccount, toProviderAccount } from './accounts.js';
+
+/**
+ * The GitLens-local extension of provider-apis' review shape, in two parts: a `DISMISSED` state the upstream
+ * `GitPullRequestReviewState` has no member for, and the head-commit oid a review was submitted against
+ * (optional, so a raw SDK review stays assignable — only the GitHub path populates it).
+ *
+ * Both exist for the same case: on GitHub the `dismiss stale reviews` rule flips an approval to dismissed on
+ * the next push, which is exactly the "the PR moved past my review" situation the oid detects. Dropping such a
+ * review instead would hand a consumer a PR out of the `reviewed-by:@me` set with no review row at all,
+ * indistinguishable from never having reviewed it.
+ */
+export const providerPullRequestReviewStateDismissed = 'DISMISSED' as const;
+export type ProviderPullRequestReview = Omit<NonNullable<GitPullRequest['reviews']>[number], 'state'> & {
+	state: GitPullRequestReviewState | typeof providerPullRequestReviewStateDismissed;
+	commitOid?: string;
+};
+/**
+ * The review list as it travels on {@link ProviderPullRequest}: `null` when the read carried no review data at
+ * all, as opposed to an empty array for a pull request nobody has reviewed.
+ */
+export type ProviderPullRequestReviews = ProviderPullRequestReview[] | null;
+
+export const toProviderPullRequestReviewState = {
+	[PullRequestReviewState.Approved]: GitPullRequestReviewState.Approved,
+	[PullRequestReviewState.ChangesRequested]: GitPullRequestReviewState.ChangesRequested,
+	[PullRequestReviewState.Commented]: GitPullRequestReviewState.Commented,
+	[PullRequestReviewState.ReviewRequested]: GitPullRequestReviewState.ReviewRequested,
+	[PullRequestReviewState.Dismissed]: providerPullRequestReviewStateDismissed,
+	// A review the author started but never submitted. Visible only to that author and carrying no verdict, so
+	// it stays unmapped and is dropped by the projection.
+	[PullRequestReviewState.Pending]: null,
+};
+
+export const fromProviderPullRequestReviewState = {
+	[GitPullRequestReviewState.Approved]: PullRequestReviewState.Approved,
+	[GitPullRequestReviewState.ChangesRequested]: PullRequestReviewState.ChangesRequested,
+	[GitPullRequestReviewState.Commented]: PullRequestReviewState.Commented,
+	[GitPullRequestReviewState.ReviewRequested]: PullRequestReviewState.ReviewRequested,
+	[providerPullRequestReviewStateDismissed]: PullRequestReviewState.Dismissed,
+};
+
+export function toProviderReviews(reviewers: PullRequestReviewer[]): ProviderPullRequestReviews {
+	// Only `Pending` maps to null (see `toProviderPullRequestReviewState`), so this drops exactly the reviews
+	// that carry no verdict rather than defaulting them to `ReviewRequested` — which would report an unsubmitted
+	// draft as a pending request from that reviewer.
+	return reviewers
+		.filter(r => r.state !== PullRequestReviewState.Pending)
+		.map(reviewer => ({
+			reviewer: toProviderAccount(reviewer.reviewer),
+			state: toProviderPullRequestReviewState[reviewer.state] ?? GitPullRequestReviewState.ReviewRequested,
+			commitOid: reviewer.commitOid,
+		}));
+}
+
+export function toReviewRequests(reviews: ProviderPullRequestReviews): PullRequestReviewer[] | undefined {
+	return reviews == null
+		? undefined
+		: reviews
+				?.filter(r => r.state === GitPullRequestReviewState.ReviewRequested)
+				.map(r => ({
+					isCodeOwner: false, // TODO: Find this value, and implement in the shared lib if needed
+					reviewer: fromProviderAccount(r.reviewer),
+					state: PullRequestReviewState.ReviewRequested,
+				}));
+}
+
+export function toCompletedReviews(reviews: ProviderPullRequestReviews): PullRequestReviewer[] | undefined {
+	return reviews == null
+		? undefined
+		: reviews
+				?.filter(
+					r =>
+						r.state !== GitPullRequestReviewState.ReviewRequested &&
+						// provider-apis' own GitHub normalizer maps only its four known states, so a review it has no
+						// member for (a real `DISMISSED` one, which its `latestReviews(first: 100)` selection does
+						// return) arrives with `state: undefined` — a value its type says cannot happen. Publishing it
+						// would put an unswitchable state on `PullRequestShape.latestReviews`, and mapping back would
+						// hit `toProviderReviews`' fallback and report a dismissed review as an outstanding request.
+						// Our own GitHub path never lands here: it carries `providerPullRequestReviewStateDismissed`.
+						fromProviderPullRequestReviewState[r.state] != null,
+				)
+				.map(r => ({
+					isCodeOwner: false, // TODO: Find this value, and implement in the shared lib if needed
+					reviewer: fromProviderAccount(r.reviewer),
+					state: fromProviderPullRequestReviewState[r.state],
+					commitOid: r.commitOid,
+				}));
+}
+
+export function toProviderReviewDecision(
+	reviewDecision?: PullRequestReviewDecision,
+	reviewers?: PullRequestReviewer[],
+): GitPullRequestReviewState | null {
+	switch (reviewDecision) {
+		case PullRequestReviewDecision.Approved:
+			return GitPullRequestReviewState.Approved;
+		case PullRequestReviewDecision.ChangesRequested:
+			return GitPullRequestReviewState.ChangesRequested;
+		case PullRequestReviewDecision.ReviewRequired:
+			return GitPullRequestReviewState.ReviewRequested;
+		default: {
+			if (reviewers?.some(r => r.state === PullRequestReviewState.ReviewRequested)) {
+				return GitPullRequestReviewState.ReviewRequested;
+			} else if (reviewers?.some(r => r.state === PullRequestReviewState.Commented)) {
+				return GitPullRequestReviewState.Commented;
+			}
+			return null;
+		}
+	}
+}
+
+export const fromPullRequestReviewDecision = {
+	[GitPullRequestReviewState.Approved]: PullRequestReviewDecision.Approved,
+	[GitPullRequestReviewState.ChangesRequested]: PullRequestReviewDecision.ChangesRequested,
+	[GitPullRequestReviewState.Commented]: undefined,
+	[GitPullRequestReviewState.ReviewRequested]: PullRequestReviewDecision.ReviewRequired,
+};