Adds pr entity id to draft models

Fixes draft create/archive/view tracking
Adds strong-typing to our tracking data
Adds strong-typing to the flatten method

Author: eamodio

src/constants.ts

@@ -206,7 +206,7 @@ export async function activate(context: ExtensionContext): Promise<GitLensApi |
 	await container.ready();
 
 	// TODO@eamodio do we want to capture any vscode settings that are relevant to GitLens?
-	const flatCfg = flatten(configuration.getAll(true), { prefix: 'config', stringify: 'all' });
+	const flatCfg = flatten(configuration.getAll(true), 'config', { joinArrays: true });
 
 	container.telemetry.setGlobalAttributes({
 		debugging: container.debugging,

src/extension.ts

@@ -923,7 +923,9 @@ export class GitProviderService implements Disposable {
 				visibility = await this.visibilityCore();
 				if (this.container.telemetry.enabled) {
 					this.container.telemetry.setGlobalAttribute('repositories.visibility', visibility);
-					this.container.telemetry.sendEvent('repositories/visibility');
+					this.container.telemetry.sendEvent('repositories/visibility', {
+						'repositories.visibility': visibility,
+					});
 				}
 				this._reposVisibilityCache = visibility;
 			}

src/git/gitProviderService.ts

@@ -44,6 +44,8 @@ export interface Draft {
 	readonly archivedReason?: DraftArchiveReason;
 	readonly archivedAt?: Date;
 
+	readonly prEntityId?: string;
+
 	readonly latestChangesetId: string;
 	changesets?: DraftChangeset[];
 
@@ -78,6 +80,7 @@ export interface DraftPatch {
 	readonly draftId: string;
 	readonly changesetId: string;
 	readonly userId: string;
+	readonly prEntityId?: string;
 
 	readonly baseBranchName: string;
 	/*readonly*/ baseRef: string;

src/gk/models/drafts.ts

@@ -1,3 +1,4 @@
+import type { EntityIdentifier } from '@gitkraken/provider-apis';
 import { EntityIdentifierUtils } from '@gitkraken/provider-apis';
 import type { Disposable } from 'vscode';
 import type { HeadersInit } from '@env/fetch';
@@ -1039,3 +1040,15 @@ function formatPatch(
 		repository: options?.repository,
 	};
 }
+
+export function getDraftEntityIdentifier(draft: Draft, patch?: DraftPatch): EntityIdentifier | undefined {
+	if (draft.prEntityId != null) {
+		return EntityIdentifierUtils.decode(draft.prEntityId);
+	}
+
+	if (patch?.prEntityId != null) {
+		return EntityIdentifierUtils.decode(patch.prEntityId);
+	}
+
+	return undefined;
+}

src/plus/drafts/draftsService.ts

@@ -1,4 +1,3 @@
-import type { AttributeValue } from '@opentelemetry/api';
 import type { QuickInputButton } from 'vscode';
 import { commands, Uri } from 'vscode';
 import { getAvatarUri } from '../../avatars';
@@ -29,7 +28,7 @@ import {
 	UnpinQuickInputButton,
 	UnsnoozeQuickInputButton,
 } from '../../commands/quickCommand.buttons';
-import type { Source, Sources } from '../../constants';
+import type { LaunchpadTelemetryContext, Source, Sources } from '../../constants';
 import { Commands, previewBadge } from '../../constants';
 import type { Container } from '../../container';
 import type { QuickPickItemOfT } from '../../quickpicks/items/common';
@@ -91,7 +90,7 @@ interface Context {
 	items: FocusItem[];
 	title: string;
 	collapsed: Map<FocusGroup, boolean>;
-	telemetryContext: Record<string, AttributeValue | null | undefined> | undefined;
+	telemetryContext: LaunchpadTelemetryContext | undefined;
 }
 
 interface GroupedFocusItem extends FocusItem {
@@ -126,7 +125,7 @@ const instanceCounter = getScopedCounter();
 @command()
 export class FocusCommand extends QuickCommand<State> {
 	private readonly source: Source;
-	private readonly telemetryContext: Record<string, any> | undefined;
+	private readonly telemetryContext: LaunchpadTelemetryContext | undefined;
 
 	// TODO: Hidden is a hack for now to avoid telemetry when this gets loaded in the hidden group of the git commands
 	constructor(container: Container, args?: FocusCommandArgs, hidden: boolean = false) {
@@ -145,7 +144,7 @@ export class FocusCommand extends QuickCommand<State> {
 		if (this.container.telemetry.enabled && !hidden) {
 			this.telemetryContext = {
 				instance: instanceCounter.next(),
-				'initialState.group': args?.state?.initialGroup ?? null,
+				'initialState.group': args?.state?.initialGroup,
 				'initialState.selectTopItem': args?.state?.selectTopItem ?? false,
 			};
 
@@ -205,7 +204,7 @@ export class FocusCommand extends QuickCommand<State> {
 					this.container.telemetry.sendEvent(
 						opened ? 'launchpad/steps/connect' : 'launchpad/opened',
 						{
-							...context.telemetryContext,
+							...context.telemetryContext!,
 							connected: false,
 						},
 						this.source,
@@ -236,7 +235,7 @@ export class FocusCommand extends QuickCommand<State> {
 					this.container.telemetry.sendEvent(
 						opened ? 'launchpad/steps/main' : 'launchpad/opened',
 						{
-							...context.telemetryContext,
+							...context.telemetryContext!,
 							connected: true,
 						},
 						this.source,
@@ -349,7 +348,7 @@ export class FocusCommand extends QuickCommand<State> {
 									this.container.telemetry.sendEvent(
 										'launchpad/groupToggled',
 										{
-											...context.telemetryContext,
+											...context.telemetryContext!,
 											group: ui,
 											collapsed: collapsed,
 										},
@@ -915,7 +914,7 @@ export class FocusCommand extends QuickCommand<State> {
 		this.container.telemetry.sendEvent(
 			action === 'select' ? 'launchpad/steps/details' : 'launchpad/action',
 			{
-				...context.telemetryContext,
+				...context.telemetryContext!,
 				action: action,
 				'item.id': getFocusItemIdHash(item),
 				'item.type': item.type,
@@ -927,8 +926,8 @@ export class FocusCommand extends QuickCommand<State> {
 				'item.updatedDate': item.updatedDate.getTime(),
 				'item.isNew': item.isNew,
 
-				'item.comments.count': item.commentCount,
-				'item.upvotes.count': item.upvoteCount,
+				'item.comments.count': item.commentCount ?? undefined,
+				'item.upvotes.count': item.upvoteCount ?? undefined,
 
 				'item.pr.codeSuggestionCount': item.codeSuggestionsCount,
 				'item.pr.isDraft': item.isDraft,
@@ -944,7 +943,7 @@ export class FocusCommand extends QuickCommand<State> {
 				'item.pr.hasConflicts': item.hasConflicts,
 
 				'item.pr.reviews.count': item.reviews?.length ?? undefined,
-				'item.pr.reviews.decision': item.reviewDecision,
+				'item.pr.reviews.decision': item.reviewDecision ?? undefined,
 				'item.pr.reviews.changeRequestCount': item.changeRequestReviewCount ?? undefined,
 
 				'item.viewer.isAuthor': item.viewer.isAuthor,
@@ -971,18 +970,22 @@ async function updateContextItems(container: Container, context: Context, option
 }
 
 function updateTelemetryContext(context: Context) {
+	if (context.telemetryContext == null) return;
+
 	const grouped = countFocusItemGroups(context.items);
 
-	context.telemetryContext = {
+	const updatedContext: NonNullable<(typeof context)['telemetryContext']> = {
 		...context.telemetryContext,
 		'items.count': context.items.length,
 		'groups.count': grouped.size,
 	};
 
 	for (const [group, count] of grouped) {
-		context.telemetryContext[`groups.${group}.count`] = count;
-		context.telemetryContext[`groups.${group}.collapsed`] = context.collapsed.get(group);
+		updatedContext[`groups.${group}.count`] = count;
+		updatedContext[`groups.${group}.collapsed`] = context.collapsed.get(group);
 	}
+
+	context.telemetryContext = updatedContext;
 }
 
 function isFocusTargetActionQuickPickItem(item: any): item is QuickPickItemOfT<FocusTargetAction> {

src/plus/focus/focus.ts

@@ -60,6 +60,13 @@ export class FocusIndicator implements Disposable {
 	private async onConfigurationChanged(e: ConfigurationChangeEvent) {
 		if (!configuration.changed(e, 'launchpad.indicator')) return;
 
+		if (
+			configuration.changed(e, 'launchpad.indicator.enabled') &&
+			!configuration.get('launchpad.indicator.enabled')
+		) {
+			this.container.telemetry.sendEvent('launchpad/indicator/hidden');
+		}
+
 		if (configuration.changed(e, 'launchpad.indicator.openInEditor')) {
 			this.updateStatusBarCommand();
 		}

src/plus/focus/focusIndicator.ts

@@ -670,24 +670,21 @@ export class FocusProvider implements Disposable {
 
 	private onConfigurationChanged(e: ConfigurationChangeEvent) {
 		if (!configuration.changed(e, 'launchpad')) return;
-		const launchpadConfig = configuration.get('launchpad');
+
+		const cfg = configuration.get('launchpad');
 		this.container.telemetry.sendEvent('launchpad/configurationChanged', {
-			staleThreshold: launchpadConfig.staleThreshold,
-			ignoredRepositories: launchpadConfig.ignoredRepositories,
-			indicatorEnabled: launchpadConfig.indicator.enabled,
-			indicatorOpenInEditor: launchpadConfig.indicator.openInEditor,
-			indicatorIcon: launchpadConfig.indicator.icon,
-			indicatorLabel: launchpadConfig.indicator.label,
-			indicatorUseColors: launchpadConfig.indicator.useColors,
-			indicatorGroups: launchpadConfig.indicator.groups,
-			indicatorPollingEnabled: launchpadConfig.indicator.polling.enabled,
-			indicatorPollingInterval: launchpadConfig.indicator.polling.interval,
+			'config.launchpad.staleThreshold': cfg.staleThreshold,
+			'config.launchpad.ignoredRepositories': cfg.ignoredRepositories?.length ?? 0,
+			'config.launchpad.indicator.enabled': cfg.indicator.enabled,
+			'config.launchpad.indicator.openInEditor': cfg.indicator.openInEditor,
+			'config.launchpad.indicator.icon': cfg.indicator.icon,
+			'config.launchpad.indicator.label': cfg.indicator.label,
+			'config.launchpad.indicator.useColors': cfg.indicator.useColors,
+			'config.launchpad.indicator.groups': cfg.indicator.groups.join(','),
+			'config.launchpad.indicator.polling.enabled': cfg.indicator.polling.enabled,
+			'config.launchpad.indicator.polling.interval': cfg.indicator.polling.interval,
 		});
 
-		if (configuration.changed(e, 'launchpad.indicator.enabled') && !launchpadConfig.indicator.enabled) {
-			this.container.telemetry.sendEvent('launchpad/indicator/hidden');
-		}
-
 		if (
 			configuration.changed(e, 'launchpad.ignoredRepositories') ||
 			configuration.changed(e, 'launchpad.staleThreshold')

src/plus/focus/focusProvider.ts

@@ -215,7 +215,7 @@ export class SubscriptionService implements Disposable {
 		if (originalSource != null) {
 			source.detail = {
 				...(typeof source.detail === 'string' ? { action: source.detail } : source.detail),
-				...flatten(originalSource, { prefix: 'original' }),
+				...flatten(originalSource, 'original'),
 			};
 		}
 
@@ -1335,28 +1335,43 @@ export class SubscriptionService implements Disposable {
 	}
 }
 
-function flattenSubscription(subscription: Optional<Subscription, 'state'> | undefined, prefix?: string) {
+type FlattenedSubscription = {
+	'subscription.state'?: SubscriptionState;
+	'subscription.status'?:
+		| 'verification'
+		| 'free'
+		| 'preview'
+		| 'preview-expired'
+		| 'trial'
+		| 'trial-expired'
+		| 'trial-reactivation-eligible'
+		| 'paid'
+		| 'unknown';
+} & Partial<
+	Record<`account.${string}`, string | number | boolean | undefined> &
+		Record<`subscription.${string}`, string | number | boolean | undefined> &
+		Record<`subscription.previewTrial.${string}`, string | number | boolean | undefined> &
+		Record<`previous.account.${string}`, string | number | boolean | undefined> &
+		Record<`previous.subscription.${string}`, string | number | boolean | undefined> &
+		Record<`previous.subscription.previewTrial.${string}`, string | number | boolean | undefined>
+>;
+
+function flattenSubscription(
+	subscription: Optional<Subscription, 'state'> | undefined,
+	prefix?: string,
+): FlattenedSubscription {
 	if (subscription == null) return {};
 
 	return {
-		...flatten(subscription.account, {
-			arrays: 'join',
-			prefix: `${prefix ? `${prefix}.` : ''}account`,
+		...flatten(subscription.account, `${prefix ? `${prefix}.` : ''}account`, {
+			joinArrays: true,
 			skipPaths: ['name', 'email'],
-			skipNulls: true,
-			stringify: true,
 		}),
-		...flatten(subscription.plan, {
-			prefix: `${prefix ? `${prefix}.` : ''}subscription`,
+		...flatten(subscription.plan, `${prefix ? `${prefix}.` : ''}subscription`, {
 			skipPaths: ['actual.name', 'effective.name'],
-			skipNulls: true,
-			stringify: true,
 		}),
-		...flatten(subscription.previewTrial, {
-			prefix: `${prefix ? `${prefix}.` : ''}subscription.previewTrial`,
+		...flatten(subscription.previewTrial, `${prefix ? `${prefix}.` : ''}subscription.previewTrial`, {
 			skipPaths: ['actual.name', 'effective.name'],
-			skipNulls: true,
-			stringify: true,
 		}),
 		'subscription.state': subscription.state,
 		'subscription.stateString': getSubscriptionStateString(subscription.state),

src/plus/gk/account/subscriptionService.ts

@@ -1,7 +1,7 @@
 import type { ConfigurationChangeEvent } from 'vscode';
 import { Disposable, env, Uri, window } from 'vscode';
 import { getAvatarUri } from '../../../avatars';
-import type { ContextKeys } from '../../../constants';
+import type { ContextKeys, Sources } from '../../../constants';
 import { Commands, GlyphChars, previewBadge } from '../../../constants';
 import type { Container } from '../../../container';
 import { CancellationError } from '../../../errors';
@@ -46,6 +46,7 @@ import type { IpcCallMessageType, IpcMessage } from '../../../webviews/protocol'
 import type { WebviewHost, WebviewProvider } from '../../../webviews/webviewProvider';
 import type { WebviewShowOptions } from '../../../webviews/webviewsController';
 import { showPatchesView } from '../../drafts/actions';
+import { getDraftEntityIdentifier } from '../../drafts/draftsService';
 import type { OrganizationMember } from '../../gk/account/organization';
 import { confirmDraftStorage, ensureAccount } from '../../utils';
 import type { ShowInCommitGraphCommandArgs } from '../graph/protocol';
@@ -769,19 +770,25 @@ export class PatchDetailsWebviewProvider
 	private async trackArchiveDraft(draft: Draft) {
 		draft = await this.ensureDraftContent(draft);
 		const patch = draft.changesets?.[0].patches.find(p => isRepoLocated(p.repository));
-		if (patch == null) return;
 
-		const repo = patch.repository as Repository;
-		const remote = await this.container.git.getBestRemoteWithProvider(repo.uri);
-		if (remote == null) return;
+		let repoPrivacy;
+		if (isRepository(patch?.repository)) {
+			repoPrivacy = await this.container.git.visibility(patch.repository.uri);
+		}
 
-		const provider = remote.provider.id;
+		const entity = getDraftEntityIdentifier(draft, patch);
 
-		this.container.telemetry.sendEvent('codeSuggestionArchived', {
-			provider: provider,
-			draftId: draft.id,
-			reason: draft.archivedReason!,
-		});
+		this.container.telemetry.sendEvent(
+			'codeSuggestionArchived',
+			{
+				provider: entity?.provider,
+				'repository.visibility': repoPrivacy,
+				repoPrivacy: repoPrivacy,
+				draftId: draft.id,
+				reason: draft.archivedReason!,
+			},
+			{ source: 'patchDetails' },
+		);
 	}
 
 	private async explainRequest<T extends typeof ExplainRequest>(requestType: T, msg: IpcCallMessageType<T>) {
@@ -1077,27 +1084,31 @@ export class PatchDetailsWebviewProvider
 		});
 	}
 
-	private async trackViewDraft(draft: Draft | LocalDraft | undefined, source?: string) {
+	private async trackViewDraft(draft: Draft | LocalDraft | undefined, source?: Sources | undefined) {
 		if (draft?.draftType !== 'cloud' || draft.type !== 'suggested_pr_change') return;
 
 		draft = await this.ensureDraftContent(draft);
 		const patch = draft.changesets?.[0].patches.find(p => isRepoLocated(p.repository));
-		if (patch == null) return;
 
-		const repo = patch.repository as Repository;
-		const remote = await this.container.git.getBestRemoteWithProvider(repo.uri);
-		if (remote == null) return;
+		let repoPrivacy;
+		if (isRepository(patch?.repository)) {
+			repoPrivacy = await this.container.git.visibility(patch.repository.uri);
+		}
 
-		const provider = remote.provider.id;
-		const repoPrivacy = await this.container.git.visibility(repo.path);
+		const entity = getDraftEntityIdentifier(draft, patch);
 
-		this.container.telemetry.sendEvent('codeSuggestionViewed', {
-			provider: provider,
-			source: source,
-			repoPrivacy: repoPrivacy,
-			draftPrivacy: draft.visibility,
-			draftId: draft.id,
-		});
+		this.container.telemetry.sendEvent(
+			'codeSuggestionViewed',
+			{
+				provider: entity?.provider,
+				'repository.visibility': repoPrivacy,
+				repoPrivacy: repoPrivacy,
+				draftId: draft.id,
+				draftPrivacy: draft.visibility,
+				source: source,
+			},
+			{ source: source ?? 'patchDetails' },
+		);
 	}
 
 	private async updateViewDraftState(draft: LocalDraft | Draft | undefined) {