Adds device cohort to tracking

Author: eamodio

docs/telemetry-events.md

@@ -28,6 +28,7 @@
   'global.cloudIntegrations.connected.count': number,
   'global.cloudIntegrations.connected.ids': string,
   'global.debugging': boolean,
+  'global.device.cohort': number,
   'global.enabled': boolean,
   'global.folders.count': number,
   'global.folders.schemes': string,

src/constants.telemetry.ts

@@ -26,6 +26,8 @@ export interface TelemetryGlobalContext extends SubscriptionEventData {
 	'cloudIntegrations.connected.count': number;
 	'cloudIntegrations.connected.ids': string;
 	debugging: boolean;
+	/** Cohort number between 1 and 100 to use for percentage-based rollouts */
+	'device.cohort': number;
 	enabled: boolean;
 	prerelease: boolean;
 	install: boolean;

src/extension.ts

@@ -25,7 +25,7 @@ import { executeCommand, registerCommands } from './system/-webview/command';
 import { configuration, Configuration } from './system/-webview/configuration';
 import { setContext } from './system/-webview/context';
 import { Storage } from './system/-webview/storage';
-import { isTextDocument, isTextEditor, isWorkspaceFolder } from './system/-webview/vscode';
+import { deviceCohortGroup, isTextDocument, isTextEditor, isWorkspaceFolder } from './system/-webview/vscode';
 import { setDefaultDateLocales } from './system/date';
 import { once } from './system/event';
 import { BufferedLogChannel, getLoggableName, Logger } from './system/logger';
@@ -237,6 +237,7 @@ export async function activate(context: ExtensionContext): Promise<GitLensApi |
 
 	container.telemetry.setGlobalAttributes({
 		debugging: container.debugging,
+		'device.cohort': deviceCohortGroup,
 		prerelease: prerelease,
 		install: previousVersion == null,
 		upgrade: previousVersion != null && gitlensVersion !== previousVersion,

src/plus/gk/productConfigProvider.ts

@@ -1,11 +1,10 @@
-import { env } from 'vscode';
 import { SubscriptionState } from '../../constants.subscription';
 import type { Container } from '../../container';
+import { deviceCohortGroup } from '../../system/-webview/vscode';
 import type { Lazy } from '../../system/lazy';
 import { lazy } from '../../system/lazy';
 import { getLoggableName, Logger } from '../../system/logger';
 import { startLogScope } from '../../system/logger.scope';
-import { getPercentileGroup } from '../../system/string';
 import type { Validator } from '../../system/validation';
 import { createValidator, Is } from '../../system/validation';
 import type { Promo, PromoLocation } from './models/promo';
@@ -211,6 +210,6 @@ function isPromoApplicable(promo: Promo, state: number): boolean {
 		(promo.states == null || promo.states.includes(state)) &&
 		(promo.expiresOn == null || promo.expiresOn > now) &&
 		(promo.startsOn == null || promo.startsOn < now) &&
-		(promo.percentile == null || getPercentileGroup(env.machineId) <= promo.percentile)
+		(promo.percentile == null || deviceCohortGroup <= promo.percentile)
 	);
 }

src/system/-webview/vscode.ts

@@ -15,11 +15,14 @@ import type { Container } from '../../container';
 import { isGitUri } from '../../git/gitUri';
 import { Logger } from '../logger';
 import { extname, joinPaths, normalizePath } from '../path';
+import { getDistributionGroup } from '../string';
 import { satisfies } from '../version';
 import { executeCoreCommand } from './command';
 import { configuration } from './configuration';
 import { relative } from './path';
 
+export const deviceCohortGroup = getDistributionGroup(env.machineId);
+
 export function findTextDocument(uri: Uri): TextDocument | undefined {
 	const normalizedUri = uri.toString();
 	return workspace.textDocuments.find(d => d.uri.toString() === normalizedUri);

src/system/string.ts

@@ -184,11 +184,11 @@ export function* getLines(data: string | string[], char: string = '\n'): Iterabl
 }
 
 /**
- * Groups a value into a percentile group (1-100)
- * @param value The value group by (e.g., machine ID)
- * @returns A number between 1-100 representing the percentile group
+ * Distributes a value into one of 100 groups based on a hash of the value
+ * @param value The value to distribute (e.g., machine ID)
+ * @returns A number between 1-100 representing the distribution group
  */
-export function getPercentileGroup(value: string): number {
+export function getDistributionGroup(value: string): number {
 	// Simple hash function
 	let hash = 0;
 	for (let i = 0; i < value.length; i++) {
@@ -197,8 +197,8 @@ export function getPercentileGroup(value: string): number {
 	}
 
 	// Convert hash to a number between 1-100
-	const percentile = Math.abs(hash % 100) + 1;
-	return percentile;
+	const group = Math.abs(hash % 100) + 1;
+	return group;
 }
 
 export function getPossessiveForm(name: string): string {