Sends context on some registration/login cases

Author: axosoft-ramint

src/constants.ts

@@ -857,7 +857,8 @@ export type Sources =
 	| 'scm-input'
 	| 'subscription'
 	| 'walkthrough'
-	| 'welcome';
+	| 'welcome'
+	| 'worktrees';
 
 export interface Source {
 	source: Sources;

src/plus/gk/account/authenticationConnection.ts

@@ -13,6 +13,11 @@ import type { ServerConnection } from '../serverConnection';
 
 export const LoginUriPathPrefix = 'login';
 export const AuthenticationUriPathPrefix = 'did-authenticate';
+export const enum AuthenticationContext {
+	Graph = 'graph',
+	Worktrees = 'worktrees',
+	VisualFileHistory = 'visual_file_history',
+}
 
 interface AccountInfo {
 	id: string;
@@ -62,7 +67,12 @@ export class AuthenticationConnection implements Disposable {
 	}
 
 	@debug()
-	async login(scopes: string[], scopeKey: string, signUp: boolean = false): Promise<string> {
+	async login(
+		scopes: string[],
+		scopeKey: string,
+		signUp: boolean = false,
+		context?: AuthenticationContext,
+	): Promise<string> {
 		this.updateStatusBarItem(true);
 
 		// Include a state parameter here to prevent CSRF attacks
@@ -76,9 +86,9 @@ export class AuthenticationConnection implements Disposable {
 
 		const uri = this.container.getGkDevUri(
 			signUp ? 'register' : 'login',
-			`${scopes.includes('gitlens') ? 'source=gitlens&' : ''}state=${encodeURIComponent(
-				gkstate,
-			)}&redirect_uri=${encodeURIComponent(callbackUri.toString(true))}`,
+			`${scopes.includes('gitlens') ? 'source=gitlens&' : ''}${
+				context != null ? `context=${context}&` : ''
+			}state=${encodeURIComponent(gkstate)}&redirect_uri=${encodeURIComponent(callbackUri.toString(true))}`,
 		);
 
 		void (await openUrl(uri.toString(true)));

src/plus/gk/account/authenticationProvider.ts

@@ -11,6 +11,7 @@ import { debug } from '../../../system/decorators/log';
 import { Logger } from '../../../system/logger';
 import { getLogScope, setLogScopeExit } from '../../../system/logger.scope';
 import type { ServerConnection } from '../serverConnection';
+import type { AuthenticationContext } from './authenticationConnection';
 import { AuthenticationConnection } from './authenticationConnection';
 
 interface StoredSession {
@@ -31,6 +32,7 @@ const authenticationLabel = 'GitKraken: GitLens';
 export interface AuthenticationProviderOptions {
 	signUp?: boolean;
 	signIn?: { code: string; state?: string };
+	context?: AuthenticationContext;
 }
 
 export class AccountAuthenticationProvider implements AuthenticationProvider, Disposable {
@@ -99,7 +101,7 @@ export class AccountAuthenticationProvider implements AuthenticationProvider, Di
 			const token =
 				options?.signIn != null
 					? await this._authConnection.getTokenFromCodeAndState(options.signIn.code, options.signIn.state)
-					: await this._authConnection.login(scopes, scopesKey, options?.signUp);
+					: await this._authConnection.login(scopes, scopesKey, options?.signUp, options?.context);
 			const session = await this.createSessionForToken(token, scopes);
 
 			const sessions = await this._sessionsPromise;

src/plus/gk/account/subscriptionService.ts

@@ -47,6 +47,7 @@ import type { GKCheckInResponse } from '../checkin';
 import { getSubscriptionFromCheckIn } from '../checkin';
 import type { ServerConnection } from '../serverConnection';
 import { ensurePlusFeaturesEnabled } from '../utils';
+import { AuthenticationContext } from './authenticationConnection';
 import { authenticationProviderId, authenticationProviderScopes } from './authenticationProvider';
 import type { Organization } from './organization';
 import type { Subscription } from './subscription';
@@ -361,7 +362,31 @@ export class SubscriptionService implements Disposable {
 			);
 		}
 
-		return this.loginCore({ signUp: signUp, source: source });
+		let context: AuthenticationContext | undefined;
+		switch (source?.source) {
+			case 'graph':
+				context = AuthenticationContext.Graph;
+				break;
+			case 'timeline':
+				context = AuthenticationContext.VisualFileHistory;
+				break;
+			case 'git-commands':
+				if (
+					source.detail != null &&
+					typeof source.detail !== 'string' &&
+					(source.detail['action'] === 'worktree' ||
+						source.detail['step.title'] === 'Create Worktree' ||
+						source.detail['step.title'] === 'Open Worktree')
+				) {
+					context = AuthenticationContext.Worktrees;
+				}
+				break;
+			case 'worktrees':
+				context = AuthenticationContext.Worktrees;
+				break;
+		}
+
+		return this.loginCore({ signUp: signUp, source: source, context: context });
 	}
 
 	async loginWithCode(authentication: { code: string; state?: string }, source?: Source): Promise<boolean> {
@@ -382,6 +407,7 @@ export class SubscriptionService implements Disposable {
 		signUp?: boolean;
 		source?: Source;
 		signIn?: { code: string; state?: string };
+		context?: AuthenticationContext;
 	}): Promise<boolean> {
 		// Abort any waiting authentication to ensure we can start a new flow
 		await this.container.accountAuthentication.abort();
@@ -390,6 +416,7 @@ export class SubscriptionService implements Disposable {
 		const session = await this.ensureSession(true, {
 			signIn: options?.signIn,
 			signUp: options?.signUp,
+			context: options?.context,
 		});
 		const loggedIn = Boolean(session);
 		if (loggedIn) {
@@ -941,7 +968,12 @@ export class SubscriptionService implements Disposable {
 	@debug()
 	private async ensureSession(
 		createIfNeeded: boolean,
-		options?: { force?: boolean; signUp?: boolean; signIn?: { code: string; state?: string } },
+		options?: {
+			force?: boolean;
+			signUp?: boolean;
+			signIn?: { code: string; state?: string };
+			context?: AuthenticationContext;
+		},
 	): Promise<AuthenticationSession | undefined> {
 		if (this._sessionPromise != null) {
 			void (await this._sessionPromise);
@@ -954,6 +986,7 @@ export class SubscriptionService implements Disposable {
 			this._sessionPromise = this.getOrCreateSession(createIfNeeded, {
 				signUp: options?.signUp,
 				signIn: options?.signIn,
+				context: options?.context,
 			}).then(
 				s => {
 					this._session = s;
@@ -975,7 +1008,7 @@ export class SubscriptionService implements Disposable {
 	@debug()
 	private async getOrCreateSession(
 		createIfNeeded: boolean,
-		options?: { signUp?: boolean; signIn?: { code: string; state?: string } },
+		options?: { signUp?: boolean; signIn?: { code: string; state?: string }; context?: AuthenticationContext },
 	): Promise<AuthenticationSession | null> {
 		const scope = getLogScope();