Improves promo metadata

Author: eamodio

src/commands/quickCommand.steps.ts

@@ -2634,20 +2634,8 @@ export async function* ensureAccessStep<
 	} else {
 		if (access.subscription.required == null) return access;
 
-		let detail;
-		const promo = getApplicablePromo(access.subscription.current.state);
-		if (promo != null) {
-			// NOTE: Don't add a default case, so that if we add a new promo the build will break without handling it
-			switch (promo.key) {
-				case 'pro50':
-					detail = '$(star-full) Limited-Time Sale: Save 33% or more on your 1st seat of Pro';
-					break;
-				case 'launchpad':
-				case 'launchpad-extended':
-					detail = `$(rocket) Launchpad Sale: Save 75% or more on GitLens Pro`;
-					break;
-			}
-		}
+		const promo = getApplicablePromo(access.subscription.current.state, 'gate');
+		const detail = promo?.quickpick.detail;
 
 		placeholder = 'Pro feature — requires a trial or paid plan for use on privately-hosted repos';
 		if (isSubscriptionPaidPlan(access.subscription.required) && access.subscription.current.account != null) {

src/git/gitProviderService.ts

@@ -779,7 +779,7 @@ export class GitProviderService implements Disposable {
 
 		if (feature === 'launchpad') {
 			// If our launchpad graduation promo is active allow access for everyone
-			if (getApplicablePromo(subscription.state, 'launchpad')) {
+			if (getApplicablePromo(subscription.state, undefined, 'launchpad')) {
 				return { allowed: true, subscription: { current: subscription } };
 			}
 			return { allowed: false, subscription: { current: subscription, required: SubscriptionPlanId.Pro } };

src/plus/gk/account/promos.ts

@@ -1,15 +1,21 @@
 import type { PromoKeys } from '../../../constants.subscription';
 import { SubscriptionState } from '../../../constants.subscription';
 
+export type PromoLocation = 'account' | 'badge' | 'gate' | 'home';
+
 export interface Promo {
 	readonly key: PromoKeys;
 	readonly code?: string;
 	readonly states?: SubscriptionState[];
 	readonly expiresOn?: number;
 	readonly startsOn?: number;
 
-	readonly command?: `command:${string}`;
-	readonly commandTooltip?: string;
+	readonly command?: {
+		command?: `command:${string}`;
+		tooltip: string;
+	};
+	readonly locations?: PromoLocation[];
+	readonly quickpick: { detail: string };
 }
 
 // Must be ordered by applicable order
@@ -26,7 +32,10 @@ const promos: Promo[] = [
 			SubscriptionState.ProTrialReactivationEligible,
 		],
 		expiresOn: new Date('2024-09-27T06:59:00.000Z').getTime(),
-		commandTooltip: 'Launchpad Sale: Save 75% or more on GitLens Pro',
+		command: { tooltip: 'Launchpad Sale: Save 75% or more on GitLens Pro' },
+		quickpick: {
+			detail: '$(rocket) Launchpad Sale: Save 75% or more on GitLens Pro',
+		},
 	},
 	{
 		key: 'launchpad-extended',
@@ -41,7 +50,10 @@ const promos: Promo[] = [
 		],
 		startsOn: new Date('2024-09-27T06:59:00.000Z').getTime(),
 		expiresOn: new Date('2024-10-14T06:59:00.000Z').getTime(),
-		commandTooltip: 'Launchpad Sale: Save 75% or more on GitLens Pro',
+		command: { tooltip: 'Launchpad Sale: Save 75% or more on GitLens Pro' },
+		quickpick: {
+			detail: '$(rocket) Launchpad Sale: Save 75% or more on GitLens Pro',
+		},
 	},
 	{
 		key: 'pro50',
@@ -53,15 +65,28 @@ const promos: Promo[] = [
 			SubscriptionState.ProTrialExpired,
 			SubscriptionState.ProTrialReactivationEligible,
 		],
-		commandTooltip: 'Limited-Time Sale: Save 33% or more on your 1st seat of Pro. See your special price',
+		command: { tooltip: 'Limited-Time Sale: Save 33% or more on your 1st seat of Pro. See your special price' },
+		quickpick: {
+			detail: '$(star-full) Limited-Time Sale: Save 33% or more on your 1st seat of Pro',
+		},
 	},
 ];
 
-export function getApplicablePromo(state: number | undefined, key?: PromoKeys): Promo | undefined {
+export function getApplicablePromo(
+	state: number | undefined,
+	location?: PromoLocation,
+	key?: PromoKeys,
+): Promo | undefined {
 	if (state == null) return undefined;
 
 	for (const promo of promos) {
-		if ((key == null || key === promo.key) && isPromoApplicable(promo, state)) return promo;
+		if ((key == null || key === promo.key) && isPromoApplicable(promo, state)) {
+			if (location == null || promo.locations == null || promo.locations.includes(location)) {
+				return promo;
+			}
+
+			break;
+		}
 	}
 
 	return undefined;

src/plus/launchpad/launchpad.ts

@@ -266,7 +266,8 @@ export class LaunchpadCommand extends QuickCommand<State> {
 			const result = yield* ensureAccessStep(state, context, PlusFeatures.Launchpad);
 			if (result === StepResultBreak) continue;
 
-			context.showGraduationPromo = getApplicablePromo(result.subscription.current.state, 'launchpad') != null;
+			context.showGraduationPromo =
+				getApplicablePromo(result.subscription.current.state, undefined, 'launchpad') != null;
 
 			await updateContextItems(this.container, context, { force: newlyConnected });
 

src/webviews/apps/home/components/home-nav.ts

@@ -30,7 +30,7 @@ export class GlHomeNav extends LitElement {
 	override render() {
 		return html`
 			<gl-promo
-				.promo=${getApplicablePromo(this._state.subscription.state)}
+				.promo=${getApplicablePromo(this._state.subscription.state, 'home')}
 				class="promo-banner promo-banner--eyebrow"
 				id="promo"
 				type="link"

src/webviews/apps/plus/shared/components/feature-gate-plus-state.ts

@@ -95,7 +95,7 @@ export class GlFeatureGatePlusState extends LitElement {
 
 		this.hidden = false;
 		const appearance = (this.appearance ?? 'alert') === 'alert' ? 'alert' : nothing;
-		const promo = this.state ? getApplicablePromo(this.state) : undefined;
+		const promo = this.state ? getApplicablePromo(this.state, 'gate') : undefined;
 
 		switch (this.state) {
 			case SubscriptionState.VerificationRequired:

src/webviews/apps/plus/shared/components/home-account-content.ts

@@ -280,7 +280,7 @@ export class GLHomeAccountContent extends LitElement {
 	}
 
 	private renderAccountState() {
-		const promo = getApplicablePromo(this.state);
+		const promo = getApplicablePromo(this.state, 'account');
 
 		switch (this.state) {
 			case SubscriptionState.Paid:

src/webviews/apps/shared/components/feature-badge.ts

@@ -263,7 +263,7 @@ export class GlFeatureBadge extends LitElement {
 
 			case SubscriptionState.ProTrialExpired:
 				content = html`<p>
-						Your Pro trial as ended. You can now only use Pro features on publicly-hosted repos.
+						Your Pro trial has ended. You can now only use Pro features on publicly-hosted repos.
 					</p>
 					${this.renderUpgradeActions(html`<p>Please upgrade for full access to Pro features:</p>`)}`;
 				break;
@@ -329,7 +329,7 @@ export class GlFeatureBadge extends LitElement {
 	}
 
 	private renderUpgradeActions(leadin?: TemplateResult) {
-		const promo = getApplicablePromo(this.state);
+		const promo = getApplicablePromo(this.state, 'badge');
 
 		return html`<div class="actions">
 			${leadin ?? nothing}

src/webviews/apps/shared/components/promo.ts

@@ -1,5 +1,6 @@
 import { css, html, LitElement, nothing } from 'lit';
 import { customElement, property } from 'lit/decorators.js';
+import { ifDefined } from 'lit/directives/if-defined.js';
 import type { Promo } from '../../../../plus/gk/account/promos';
 
 @customElement('gl-promo')
@@ -67,7 +68,7 @@ export class GlPromo extends LitElement {
 			return html`<a
 				class="link"
 				href="${this.promo.command ?? 'command:gitlens.plus.upgrade'}"
-				title="${this.promo.commandTooltip}"
+				title="${ifDefined(this.promo.command?.tooltip)}"
 				>${promoHtml}</a
 			>`;
 		}