update telemetry to support more anonymized project id (#3713)

* update telemetry to support more anonymized project id * Create strange-laws-kick.md * respond to nate feedback
withastro · Jun 27, 2022 · ebd7e7a · ebd7e7a
1 parent 4d6d864
commit ebd7e7a
Show file tree

Hide file tree

Showing 20 changed files with 311 additions and 351 deletions.
diff --git a/.changeset/strange-laws-kick.md b/.changeset/strange-laws-kick.md
@@ -0,0 +1,6 @@
+---
+"astro": patch
+"@astrojs/telemetry": minor
+---
+
+Update telemetry to support a more anonymized project id. `anonymousProjectId` is now hashed based on anonymous git data instead of your git remote URL.
diff --git a/packages/astro/src/cli/index.ts b/packages/astro/src/cli/index.ts
@@ -3,7 +3,7 @@
 import { LogOptions } from '../core/logger/core.js';
 
 import { AstroTelemetry } from '@astrojs/telemetry';
-import * as event from '@astrojs/telemetry/events';
+import * as event from '../events/index.js';
 import * as colors from 'kleur/colors';
 import yargs from 'yargs-parser';
 import { z } from 'zod';
@@ -19,6 +19,7 @@ import { createSafeError } from '../core/util.js';
 import { check } from './check.js';
 import { openInBrowser } from './open.js';
 import * as telemetryHandler from './telemetry.js';
+import { AstroUserConfig } from '../@types/astro.js';
 
 type Arguments = yargs.Arguments;
 type CLICommand =
@@ -61,12 +62,13 @@ function printAstroHelp() {
 	});
 }
 
+// PACKAGE_VERSION is injected when we build and publish the astro package.
+const ASTRO_VERSION = process.env.PACKAGE_VERSION ?? 'development';
+
 /** Display --version flag */
 async function printVersion() {
-	// PACKAGE_VERSION is injected at build time
-	const version = process.env.PACKAGE_VERSION ?? '';
 	console.log();
-	console.log(`  ${colors.bgGreen(colors.black(` astro `))} ${colors.green(`v${version}`)}`);
+	console.log(`  ${colors.bgGreen(colors.black(` astro `))} ${colors.green(`v${ASTRO_VERSION}`)}`);
 }
 
 /** Determine which command the user requested */
@@ -110,43 +112,51 @@ export async function cli(args: string[]) {
 	} else if (flags.silent) {
 		logging.level = 'silent';
 	}
-	const telemetry = new AstroTelemetry({ version: process.env.PACKAGE_VERSION ?? '' });
-
-	if (cmd === 'telemetry') {
-		try {
-			const subcommand = flags._[3]?.toString();
-			return await telemetryHandler.update(subcommand, { flags, telemetry });
-		} catch (err) {
-			return throwAndExit(err);
-		}
-	}
+	const telemetry = new AstroTelemetry({ version: ASTRO_VERSION });
 
+	// Special CLI Commands: "add", "docs", "telemetry"
+	// These commands run before the user's config is parsed, and may have other special
+	// conditions that should be handled here, before the others.
+	//
 	switch (cmd) {
 		case 'add': {
 			try {
+				telemetry.record(event.eventCliSession({ cliCommand: cmd }));
 				const packages = flags._.slice(3) as string[];
-				telemetry.record(
-					event.eventCliSession({
-						astroVersion: process.env.PACKAGE_VERSION ?? '',
-						cliCommand: 'add',
-					})
-				);
 				return await add(packages, { cwd: root, flags, logging, telemetry });
 			} catch (err) {
 				return throwAndExit(err);
 			}
 		}
+		case 'docs': {
+			try {
+				telemetry.record(event.eventCliSession({ cliCommand: cmd }));
+				return await openInBrowser('https://docs.astro.build/');
+			} catch (err) {
+				return throwAndExit(err);
+			}
+		}
+		case 'telemetry': {
+			try {
+				// Do not track session start, since the user may be trying to enable,
+				// disable, or modify telemetry settings.
+				const subcommand = flags._[3]?.toString();
+				return await telemetryHandler.update(subcommand, { flags, telemetry });
+			} catch (err) {
+				return throwAndExit(err);
+			}
+		}
+	}
+
+	const { astroConfig, userConfig } = await openConfig({ cwd: root, flags, cmd });
+	telemetry.record(event.eventCliSession({ cliCommand: cmd }, userConfig, flags));
+
+	// Common CLI Commands:
+	// These commands run normally. All commands are assumed to have been handled
+	// by the end of this switch statement.
+	switch (cmd) {
 		case 'dev': {
 			try {
-				const { astroConfig, userConfig } = await openConfig({ cwd: root, flags, cmd });
-
-				telemetry.record(
-					event.eventCliSession(
-						{ astroVersion: process.env.PACKAGE_VERSION ?? '', cliCommand: 'dev' },
-						userConfig,
-						flags
-					)
-				);
 				await devServer(astroConfig, { logging, telemetry });
 				return await new Promise(() => {}); // lives forever
 			} catch (err) {
@@ -156,68 +166,29 @@ export async function cli(args: string[]) {
 
 		case 'build': {
 			try {
-				const { astroConfig, userConfig } = await openConfig({ cwd: root, flags, cmd });
-				telemetry.record(
-					event.eventCliSession(
-						{ astroVersion: process.env.PACKAGE_VERSION ?? '', cliCommand: 'build' },
-						userConfig,
-						flags
-					)
-				);
 				return await build(astroConfig, { logging, telemetry });
 			} catch (err) {
 				return throwAndExit(err);
 			}
 		}
 
 		case 'check': {
-			const { astroConfig, userConfig } = await openConfig({ cwd: root, flags, cmd });
-			telemetry.record(
-				event.eventCliSession(
-					{ astroVersion: process.env.PACKAGE_VERSION ?? '', cliCommand: 'check' },
-					userConfig,
-					flags
-				)
-			);
 			const ret = await check(astroConfig);
 			return process.exit(ret);
 		}
 
 		case 'preview': {
 			try {
-				const { astroConfig, userConfig } = await openConfig({ cwd: root, flags, cmd });
-				telemetry.record(
-					event.eventCliSession(
-						{ astroVersion: process.env.PACKAGE_VERSION ?? '', cliCommand: 'preview' },
-						userConfig,
-						flags
-					)
-				);
 				const server = await preview(astroConfig, { logging, telemetry });
 				return await server.closed(); // keep alive until the server is closed
 			} catch (err) {
 				return throwAndExit(err);
 			}
 		}
-
-		case 'docs': {
-			try {
-				await telemetry.record(
-					event.eventCliSession({
-						astroVersion: process.env.PACKAGE_VERSION ?? '',
-						cliCommand: 'docs',
-					})
-				);
-				return await openInBrowser('https://docs.astro.build/');
-			} catch (err) {
-				return throwAndExit(err);
-			}
-		}
-
-		default: {
-			throw new Error(`Error running ${cmd}`);
-		}
 	}
+
+	// No command handler matched! This is unexpected.
+	throwAndExit(new Error(`Error running ${cmd} -- no command found.`));
 }
 
 /** Display error and exit */

diff --git a/packages/astro/src/cli/telemetry.ts b/packages/astro/src/cli/telemetry.ts
@@ -1,9 +1,7 @@
 /* eslint-disable no-console */
 import type { AstroTelemetry } from '@astrojs/telemetry';
 import type yargs from 'yargs-parser';
-
 import * as msg from '../core/messages.js';
-
 export interface TelemetryOptions {
 	flags: yargs.Arguments;
 	telemetry: AstroTelemetry;

diff --git a/packages/telemetry/src/events/index.ts → packages/astro/src/events/index.ts b/packages/telemetry/src/events/index.ts → packages/astro/src/events/index.ts
@@ -1,2 +1 @@
-export * from './build.js';
 export * from './session.js';
diff --git a/packages/telemetry/src/events/session.ts → packages/astro/src/events/session.ts b/packages/telemetry/src/events/session.ts → packages/astro/src/events/session.ts
@@ -1,14 +1,10 @@
 import { createRequire } from 'node:module';
-
+import type { AstroUserConfig } from '../@types/astro';
 const require = createRequire(import.meta.url);
 
 const EVENT_SESSION = 'ASTRO_CLI_SESSION_STARTED';
 
-// :( We can't import the type because of TurboRepo circular dep limitation
-type AstroUserConfig = Record<string, any>;
-
 interface EventCliSession {
-	astroVersion: string;
 	cliCommand: string;
 }
 
@@ -25,7 +21,7 @@ interface ConfigInfo {
 	markdown:
 		| undefined
 		| {
-				mode: undefined | 'md' | 'mdx';
+				drafts: undefined | boolean;
 				syntaxHighlight: undefined | 'shiki' | 'prism' | false;
 		  };
 }
@@ -91,15 +87,18 @@ export function eventCliSession(
 	flags?: Record<string, any>
 ): { eventName: string; payload: EventCliSessionInternal }[] {
 	// Filter out falsy integrations
-	const integrations = userConfig?.integrations?.filter?.(Boolean) ?? [];
 	const configValues = userConfig
 		? {
 				markdownPlugins: [
-					userConfig?.markdown?.remarkPlugins ?? [],
-					userConfig?.markdown?.rehypePlugins ?? [],
-				].flat(1),
+					...(userConfig?.markdown?.remarkPlugins?.map((p) =>
+						typeof p === 'string' ? p : typeof p
+					) ?? []),
+					...(userConfig?.markdown?.rehypePlugins?.map((p) =>
+						typeof p === 'string' ? p : typeof p
+					) ?? []),
+				] as string[],
 				adapter: userConfig?.adapter?.name ?? null,
-				integrations: integrations?.map?.((i: any) => i?.name) ?? [],
+				integrations: (userConfig?.integrations ?? []).filter(Boolean).map((i: any) => i?.name),
 				trailingSlash: userConfig?.trailingSlash,
 				build: userConfig?.build
 					? {
@@ -108,7 +107,7 @@ export function eventCliSession(
 					: undefined,
 				markdown: userConfig?.markdown
 					? {
-							mode: userConfig?.markdown?.mode,
+							drafts: userConfig.markdown?.drafts,
 							syntaxHighlight: userConfig.markdown?.syntaxHighlight,
 					  }
 					: undefined,
@@ -121,15 +120,12 @@ export function eventCliSession(
 	const payload: EventCliSessionInternal = {
 		cliCommand: event.cliCommand,
 		// Versions
-		astroVersion: event.astroVersion,
 		viteVersion: getViteVersion(),
 		nodeVersion: process.version.replace(/^v?/, ''),
 		configKeys: userConfig ? configKeys(userConfig, '') : undefined,
 		// Config Values
 		config: configValues,
 		flags: cliFlags,
-		// Optional integrations
-		optionalIntegrations: userConfig?.integrations?.length - integrations?.length,
 	};
 	return [{ eventName: EVENT_SESSION, payload }];
 }
Original file line number	Diff line number	Diff line change
		@@ -1,2 +1 @@
		export * from './build.js';
		export * from './session.js';