Improves AI error messages (#4227)

Author: eamodio

src/constants.subscription.ts

@@ -8,7 +8,7 @@ export const enum SubscriptionPlanId {
 	CommunityWithAccount = 'community-with-account',
 	Pro = 'pro',
 	Advanced = 'advanced',
-	Teams = 'teams',
+	Business = 'teams', // teams is the old name for Business; do not change
 	Enterprise = 'enterprise',
 }
 

src/plus/ai/aiProviderService.ts

@@ -13,6 +13,7 @@ import {
 	vscodeProviderDescriptor,
 	xAIProviderDescriptor,
 } from '../../constants.ai';
+import { SubscriptionPlanId } from '../../constants.subscription';
 import type { AIGenerateDraftEventData, Source, TelemetryEvents } from '../../constants.telemetry';
 import type { Container } from '../../container';
 import {
@@ -46,6 +47,7 @@ import { getSettledValue, getSettledValues } from '../../system/promise';
 import { PromiseCache } from '../../system/promiseCache';
 import type { ServerConnection } from '../gk/serverConnection';
 import { ensureFeatureAccess } from '../gk/utils/-webview/acount.utils';
+import { compareSubscriptionPlans, getSubscriptionPlanTier, isSubscriptionPaid } from '../gk/utils/subscription.utils';
 import type {
 	AIActionType,
 	AIModel,
@@ -933,11 +935,27 @@ export class AIProviderService implements Disposable {
 						void window.showErrorMessage(ex.message);
 						return undefined;
 
-					case AIErrorReason.Entitlement:
-						void window.showErrorMessage(
-							'You do not have the required entitlement or are over the limits to use this AI feature',
+					case AIErrorReason.Entitlement: {
+						const sub = await this.container.subscription.getSubscription();
+
+						const plan = isSubscriptionPaid(sub)
+							? compareSubscriptionPlans(sub.plan.actual.id, SubscriptionPlanId.Advanced) <= 0
+								? SubscriptionPlanId.Business
+								: SubscriptionPlanId.Advanced
+							: SubscriptionPlanId.Pro;
+
+						const upgrade = { title: `Upgrade to ${getSubscriptionPlanTier(plan)}` };
+						const result = await window.showErrorMessage(
+							'You do not have the required entitlement to use this AI feature. Please upgrade your plan and try again.',
+							upgrade,
 						);
+
+						if (result === upgrade) {
+							void this.container.subscription.upgrade(plan, source);
+						}
+
 						return undefined;
+					}
 					case AIErrorReason.RequestTooLarge: {
 						const switchModel: MessageItem = { title: 'Switch Model' };
 						const result = await window.showErrorMessage(

src/plus/ai/gitkrakenProvider.ts

@@ -151,9 +151,8 @@ export class GitKrakenProvider extends OpenAICompatibleProvider<typeof provider.
 					}
 
 					throw new AIError(
-						entitlementId === 'ai.tokens.weekly'
-							? AIErrorReason.UserQuotaExceeded
-							: AIErrorReason.Entitlement,
+						// If there is an `entitlementValue` then we are over the limit, otherwise it is an entitlement error
+						data?.entitlementValue ? AIErrorReason.UserQuotaExceeded : AIErrorReason.Entitlement,
 						new Error(`(${this.name}) ${status}.${code}: ${message}`),
 					);
 				}

src/plus/gk/__debug__accountDebug.ts

@@ -65,8 +65,8 @@ type SimulateQuickPickItem = QuickPickItemOfT<
 			expiredPaid?: boolean;
 			planId?:
 				| SubscriptionPlanId.Pro
-				| SubscriptionPlanId.Teams
 				| SubscriptionPlanId.Advanced
+				| SubscriptionPlanId.Business
 				| SubscriptionPlanId.Enterprise;
 			featurePreviews?: never;
 	  }
@@ -198,7 +198,7 @@ class AccountDebug {
 					label: 'Business',
 					description: 'Business plan, account',
 					iconPath: new ThemeIcon('blank'),
-					item: { state: SubscriptionState.Paid, planId: SubscriptionPlanId.Teams },
+					item: { state: SubscriptionState.Paid, planId: SubscriptionPlanId.Business },
 				},
 				{
 					label: 'Enterprise',

src/plus/gk/utils/checkin.utils.ts

@@ -162,7 +162,7 @@ function convertLicenseTypeToPlanId(licenseType: GKLicenseType): SubscriptionPla
 		case 'bundle-teams':
 		case 'gitkraken_v1-teams':
 		case 'gitkraken-v1-teams':
-			return SubscriptionPlanId.Teams;
+			return SubscriptionPlanId.Business;
 		case 'gitlens-advanced':
 		case 'bundle-advanced':
 		case 'gitkraken_v1-advanced':

src/plus/gk/utils/subscription.utils.ts

@@ -89,7 +89,7 @@ export function computeSubscriptionState(subscription: Optional<Subscription, 's
 
 			case SubscriptionPlanId.Pro:
 			case SubscriptionPlanId.Advanced:
-			case SubscriptionPlanId.Teams:
+			case SubscriptionPlanId.Business:
 			case SubscriptionPlanId.Enterprise:
 				return SubscriptionState.Paid;
 		}
@@ -113,7 +113,7 @@ export function computeSubscriptionState(subscription: Optional<Subscription, 's
 
 		case SubscriptionPlanId.Pro:
 		case SubscriptionPlanId.Advanced:
-		case SubscriptionPlanId.Teams:
+		case SubscriptionPlanId.Business:
 		case SubscriptionPlanId.Enterprise:
 			return actual.id === SubscriptionPlanId.Community
 				? SubscriptionState.ProPreview
@@ -156,7 +156,7 @@ export function getSubscriptionPlanTier(
 			return 'Pro';
 		case SubscriptionPlanId.Advanced:
 			return 'Advanced';
-		case SubscriptionPlanId.Teams:
+		case SubscriptionPlanId.Business:
 			return 'Business';
 		case SubscriptionPlanId.Enterprise:
 			return 'Enterprise';
@@ -169,7 +169,7 @@ export function getSubscriptionPlanTierType(id: SubscriptionPlanId): 'PRO' | 'AD
 	switch (id) {
 		case SubscriptionPlanId.Advanced:
 			return 'ADVANCED';
-		case SubscriptionPlanId.Teams:
+		case SubscriptionPlanId.Business:
 			return 'BUSINESS';
 		case SubscriptionPlanId.Enterprise:
 			return 'ENTERPRISE';
@@ -184,7 +184,7 @@ const plansPriority = new Map<SubscriptionPlanId | undefined, number>([
 	[SubscriptionPlanId.CommunityWithAccount, 1],
 	[SubscriptionPlanId.Pro, 2],
 	[SubscriptionPlanId.Advanced, 3],
-	[SubscriptionPlanId.Teams, 4],
+	[SubscriptionPlanId.Business, 4],
 	[SubscriptionPlanId.Enterprise, 5],
 ]);