Adds access step to some features

Author: axosoft-ramint

contributions.json

@@ -4906,7 +4906,7 @@
 			}
 		},
 		"gitlens.views.ai.generateChangelog": {
-			"label": "Generate Changelog",
+			"label": "Generate Changelog (Preview)",
 			"icon": "$(sparkle)",
 			"menus": {
 				"view/item/context": [

package.json

@@ -7833,7 +7833,7 @@
 			},
 			{
 				"command": "gitlens.views.ai.generateChangelog",
-				"title": "Generate Changelog",
+				"title": "Generate Changelog (Preview)",
 				"icon": "$(sparkle)"
 			},
 			{

src/features.ts

@@ -30,7 +30,17 @@ export type RepoFeatureAccess =
 			visibility?: RepositoryVisibility;
 	  };
 
-export type PlusFeatures = 'timeline' | 'worktrees' | 'graph' | 'launchpad' | 'startWork' | 'associateIssueWithBranch';
+export type PlusFeatures =
+	| 'timeline'
+	| 'worktrees'
+	| 'graph'
+	| 'launchpad'
+	| 'startWork'
+	| 'associateIssueWithBranch'
+	| 'generateStashMessage'
+	| 'explainCommit'
+	| 'cloudPatchGenerateTitleAndDescription';
+export type AdvancedFeatures = 'generateChangelog';
 
 export type FeaturePreviews = 'graph';
 export const featurePreviews: FeaturePreviews[] = ['graph'];

src/git/gitProviderService.ts

@@ -16,7 +16,7 @@ import { GlyphChars, Schemes } from '../constants';
 import { SubscriptionPlanId } from '../constants.subscription';
 import type { Container } from '../container';
 import { AccessDeniedError, ProviderNotFoundError, ProviderNotSupportedError } from '../errors';
-import type { FeatureAccess, Features, PlusFeatures, RepoFeatureAccess } from '../features';
+import type { AdvancedFeatures, FeatureAccess, Features, PlusFeatures, RepoFeatureAccess } from '../features';
 import type { Subscription } from '../plus/gk/models/subscription';
 import type { SubscriptionChangeEvent } from '../plus/gk/subscriptionService';
 import { isSubscriptionPaidPlan } from '../plus/gk/utils/subscription.utils';
@@ -722,17 +722,26 @@ export class GitProviderService implements Disposable {
 		return this._subscription ?? (this._subscription = await this.container.subscription.getSubscription());
 	}
 
-	private _accessCache = new Map<PlusFeatures | undefined, Promise<FeatureAccess>>();
+	private _accessCache = new Map<PlusFeatures | AdvancedFeatures | undefined, Promise<FeatureAccess>>();
 	private _accessCacheByRepo = new Map<string /* path */, Promise<RepoFeatureAccess>>();
 	private clearAccessCache(): void {
 		this._accessCache.clear();
 		this._accessCacheByRepo.clear();
 	}
 
-	async access(feature: PlusFeatures | undefined, repoPath: string | Uri): Promise<RepoFeatureAccess>;
-	async access(feature?: PlusFeatures, repoPath?: string | Uri): Promise<FeatureAccess | RepoFeatureAccess>;
+	async access(
+		feature: PlusFeatures | AdvancedFeatures | undefined,
+		repoPath: string | Uri,
+	): Promise<RepoFeatureAccess>;
+	async access(
+		feature?: PlusFeatures | AdvancedFeatures,
+		repoPath?: string | Uri,
+	): Promise<FeatureAccess | RepoFeatureAccess>;
 	@debug({ exit: true })
-	async access(feature?: PlusFeatures, repoPath?: string | Uri): Promise<FeatureAccess | RepoFeatureAccess> {
+	async access(
+		feature?: PlusFeatures | AdvancedFeatures,
+		repoPath?: string | Uri,
+	): Promise<FeatureAccess | RepoFeatureAccess> {
 		if (repoPath == null) {
 			let access = this._accessCache.get(feature);
 			if (access == null) {
@@ -754,14 +763,17 @@ export class GitProviderService implements Disposable {
 		return access;
 	}
 
-	private async accessCore(feature: PlusFeatures | undefined, repoPath: string | Uri): Promise<RepoFeatureAccess>;
 	private async accessCore(
-		feature?: PlusFeatures,
+		feature: PlusFeatures | AdvancedFeatures | undefined,
+		repoPath: string | Uri,
+	): Promise<RepoFeatureAccess>;
+	private async accessCore(
+		feature?: PlusFeatures | AdvancedFeatures,
 		repoPath?: string | Uri,
 	): Promise<FeatureAccess | RepoFeatureAccess>;
 	@debug({ exit: true })
 	private async accessCore(
-		feature?: PlusFeatures,
+		feature?: PlusFeatures | AdvancedFeatures,
 		repoPath?: string | Uri,
 	): Promise<FeatureAccess | RepoFeatureAccess> {
 		const subscription = await this.getSubscription();
@@ -775,7 +787,15 @@ export class GitProviderService implements Disposable {
 			return { allowed: subscription.account?.verified !== false, subscription: { current: subscription } };
 		}
 
-		if (feature === 'launchpad' || feature === 'startWork' || feature === 'associateIssueWithBranch') {
+		if (
+			feature === 'launchpad' ||
+			feature === 'startWork' ||
+			feature === 'associateIssueWithBranch' ||
+			feature === 'generateStashMessage' ||
+			feature === 'explainCommit' ||
+			feature === 'cloudPatchGenerateTitleAndDescription' ||
+			feature === 'generateChangelog'
+		) {
 			return { allowed: false, subscription: { current: subscription, required: SubscriptionPlanId.Pro } };
 		}
 
@@ -850,7 +870,7 @@ export class GitProviderService implements Disposable {
 		return getRepoAccess.call(this, repoPath, true);
 	}
 
-	async ensureAccess(feature: PlusFeatures, repoPath?: string): Promise<void> {
+	async ensureAccess(feature: PlusFeatures | AdvancedFeatures, repoPath?: string): Promise<void> {
 		const { allowed, subscription } = await this.access(feature, repoPath);
 		if (allowed === false) throw new AccessDeniedError(subscription.current, subscription.required);
 	}

src/plus/ai/aiProviderService.ts

@@ -5,6 +5,7 @@ import { primaryAIProviders } from '../../constants.ai';
 import type { AIGenerateDraftEventData, Source, TelemetryEvents } from '../../constants.telemetry';
 import type { Container } from '../../container';
 import { CancellationError } from '../../errors';
+import type { AdvancedFeatures, PlusFeatures } from '../../features';
 import type { GitCommit } from '../../git/models/commit';
 import { isCommit } from '../../git/models/commit';
 import type { GitRevisionReference } from '../../git/models/reference';
@@ -13,6 +14,7 @@ import { uncommitted, uncommittedStaged } from '../../git/models/revision';
 import { assertsCommitHasFullDetails } from '../../git/utils/commit.utils';
 import { showAIModelPicker } from '../../quickpicks/aiModelPicker';
 import { configuration } from '../../system/-webview/configuration';
+import { getContext } from '../../system/-webview/context';
 import type { Storage } from '../../system/-webview/storage';
 import { supportedInVSCodeVersion } from '../../system/-webview/vscode';
 import { debounce } from '../../system/function/debounce';
@@ -22,6 +24,7 @@ import { lazy } from '../../system/lazy';
 import type { Deferred } from '../../system/promise';
 import { getSettledValue } from '../../system/promise';
 import type { ServerConnection } from '../gk/serverConnection';
+import { ensureFeatureAccess } from '../gk/utils/-webview/acount.utils';
 import type { AIActionType, AIModel, AIModelDescriptor } from './models/model';
 import type { PromptTemplateContext } from './models/promptTemplates';
 import type { AIProvider, AIRequestResult } from './models/provider';
@@ -284,11 +287,56 @@ export class AIProviderService implements Disposable {
 		return model;
 	}
 
+	private async ensureOrgAccess(): Promise<boolean> {
+		const orgEnabled = getContext('gitlens:gk:organization:ai:enabled');
+		if (orgEnabled === false) {
+			await window.showErrorMessage(`AI features have been disabled for your organization.`);
+			return false;
+		}
+
+		return true;
+	}
+
+	private async ensureFeatureAccess(
+		feature:
+			| 'generateStashMessage'
+			| 'explainCommit'
+			| 'cloudPatchGenerateTitleAndDescription'
+			| 'generateChangelog',
+		title: string,
+		source: Source,
+	): Promise<boolean> {
+		if (!(await this.ensureOrgAccess())) return false;
+
+		if (
+			!(await ensureFeatureAccess(
+				this.container,
+				title,
+				feature satisfies PlusFeatures | AdvancedFeatures,
+				source,
+			))
+		) {
+			return false;
+		}
+
+		return true;
+	}
+
 	async explainCommit(
 		commitOrRevision: GitRevisionReference | GitCommit,
 		sourceContext: Source & { type: TelemetryEvents['ai/explain']['changeType'] },
 		options?: { cancellation?: CancellationToken; progress?: ProgressOptions },
 	): Promise<AISummarizeResult | undefined> {
+		if (
+			!(await this.ensureFeatureAccess(
+				'explainCommit' satisfies PlusFeatures,
+				'Explaining commits requires an account with Pro access.',
+				sourceContext,
+			))
+		) {
+			return undefined;
+		}
+
 		const diff = await this.container.git.diff(commitOrRevision.repoPath).getDiff?.(commitOrRevision.ref);
 		if (!diff?.contents) throw new Error('No changes found to explain.');
 
@@ -339,6 +387,8 @@ export class AIProviderService implements Disposable {
 			progress?: ProgressOptions;
 		},
 	): Promise<AISummarizeResult | undefined> {
+		if (!(await this.ensureOrgAccess())) return undefined;
+
 		const changes: string | undefined = await this.getChanges(changesOrRepo);
 		if (changes == null) return undefined;
 
@@ -377,6 +427,18 @@ export class AIProviderService implements Disposable {
 			codeSuggestion?: boolean;
 		},
 	): Promise<AISummarizeResult | undefined> {
+		if (
+			!(await this.ensureFeatureAccess(
+				'cloudPatchGenerateTitleAndDescription' satisfies PlusFeatures,
+				`Generating ${
+					options?.codeSuggestion ? 'code suggestion' : 'cloud patch'
+				} descriptions requires an account with Pro access.`,
+				sourceContext,
+			))
+		) {
+			return undefined;
+		}
+
 		const changes: string | undefined = await this.getChanges(changesOrRepo);
 		if (changes == null) return undefined;
 
@@ -423,6 +485,16 @@ export class AIProviderService implements Disposable {
 			progress?: ProgressOptions;
 		},
 	): Promise<AISummarizeResult | undefined> {
+		if (
+			!(await this.ensureFeatureAccess(
+				'generateStashMessage' satisfies PlusFeatures,
+				'Generating stash messages requires an account with Pro access.',
+				source,
+			))
+		) {
+			return undefined;
+		}
+
 		const changes: string | undefined = await this.getChanges(changesOrRepo);
 		if (changes == null) {
 			options?.generating?.cancel();
@@ -458,6 +530,16 @@ export class AIProviderService implements Disposable {
 		source: Source,
 		options?: { cancellation?: CancellationToken; progress?: ProgressOptions },
 	): Promise<AIResult | undefined> {
+		if (
+			!(await this.ensureFeatureAccess(
+				'generateChangelog' satisfies AdvancedFeatures,
+				'Generating changelogs requires an account with Pro access.',
+				source,
+			))
+		) {
+			return undefined;
+		}
+
 		const result = await this.sendRequest(
 			'generate-changelog',
 			async () => ({

src/plus/gk/subscriptionService.ts

@@ -882,10 +882,10 @@ export class SubscriptionService implements Disposable {
 	}
 
 	@log()
-	async upgrade(source: Source | undefined, plan?: SubscriptionPlanId): Promise<void> {
+	async upgrade(source: Source | undefined, plan?: SubscriptionPlanId): Promise<boolean> {
 		const scope = getLogScope();
 
-		if (!(await ensurePlusFeaturesEnabled())) return;
+		if (!(await ensurePlusFeaturesEnabled())) return false;
 
 		let aborted = false;
 		const promo = await this.container.productConfig.getApplicablePromo(this._subscription.state);
@@ -919,7 +919,7 @@ export class SubscriptionService implements Disposable {
 						getSubscriptionPlanPriority(this._subscription.plan.effective.id) >=
 							getSubscriptionPlanPriority(plan ?? SubscriptionPlanId.Pro)
 					) {
-						return;
+						return true;
 					}
 				}
 			} catch {}
@@ -982,7 +982,7 @@ export class SubscriptionService implements Disposable {
 		aborted = !(await openUrl(this.container.urls.getGkDevUrl('purchase/checkout', query)));
 
 		if (aborted) {
-			return;
+			return false;
 		}
 
 		telemetry?.dispose();
@@ -1016,6 +1016,8 @@ export class SubscriptionService implements Disposable {
 		if (refresh) {
 			void this.checkUpdatedSubscription(source);
 		}
+
+		return true;
 	}
 
 	@gate<SubscriptionService['validate']>(o => `${o?.force ?? false}`)

src/plus/gk/utils/-webview/acount.utils.ts

@@ -1,6 +1,8 @@
+import type { Uri } from 'vscode';
 import { window } from 'vscode';
 import type { Source } from '../../../../constants.telemetry';
 import type { Container } from '../../../../container';
+import type { AdvancedFeatures, PlusFeatures } from '../../../../features';
 
 export async function ensureAccount(container: Container, title: string, source: Source): Promise<boolean> {
 	while (true) {
@@ -52,3 +54,37 @@ export async function ensureAccount(container: Container, title: string, source:
 
 	return true;
 }
+
+export async function ensureFeatureAccess(
+	container: Container,
+	title: string,
+	feature: PlusFeatures | AdvancedFeatures,
+	source: Source,
+	repoPath?: string | Uri,
+): Promise<boolean> {
+	if (!(await ensureAccount(container, title, source))) return false;
+
+	while (true) {
+		const access = await container.git.access(feature, repoPath);
+		if (access.allowed) break;
+
+		const upgrade = { title: 'Upgrade to Pro' };
+		const cancel = { title: 'Cancel', isCloseAffordance: true };
+		const result = await window.showWarningMessage(
+			`${title}\n\nUpgrade to Pro to access this feature.`,
+			{ modal: true },
+			upgrade,
+			cancel,
+		);
+
+		if (result === upgrade) {
+			if (await container.subscription.upgrade(source)) {
+				continue;
+			}
+		}
+
+		return false;
+	}
+
+	return true;
+}