chore: disable telemetry for local dev (#295)

Author: jonaslagoni

jest.config.js

@@ -3,6 +3,9 @@
   transform: {
     '^.+\\.(t|j)sx?$': '@swc/jest'
   },
+  // Disable telemetry during testing to avoid polluting analytics
+  testEnvironment: 'node',
+  setupFiles: ['<rootDir>/test/setup.js'],
   // The root of your source code, typically /src
   // `<rootDir>` is a token Jest substitutes
   roots: ['<rootDir>'],

src/PersistedConfig.ts

@@ -12,9 +12,6 @@ export interface GlobalConfig {
   telemetry: TelemetryConfig;
   hasShownTelemetryNotice: boolean;
   lastUpdated?: string;
-  // Future extensibility:
-  // updates?: UpdatePreferences;
-  // preferences?: UserPreferences;
 }
 
 /**
@@ -25,7 +22,7 @@ export interface TelemetryConfig {
   anonymousId: string;
   endpoint: string;
   trackingId: string;
-  apiSecret?: string;
+  apiSecret: string;
 }
 
 const CONFIG_DIR = path.join(os.homedir(), '.the-codegen-project');

src/commands/telemetry.ts

@@ -86,31 +86,10 @@ export default class Telemetry extends Command {
     Logger.info('│         Telemetry Status                    │');
     Logger.info('└─────────────────────────────────────────────┘\n');
 
-    // Check environment variable overrides
-    const envDisabled =
-      process.env.CODEGEN_TELEMETRY_DISABLED === '1' ||
-      process.env.DO_NOT_TRACK === '1';
-
-    if (envDisabled) {
-      Logger.info('Status: ❌ DISABLED (via environment variable)');
-      Logger.info('\nEnvironment variables:');
-      if (process.env.CODEGEN_TELEMETRY_DISABLED === '1') {
-        Logger.info('  CODEGEN_TELEMETRY_DISABLED=1');
-      }
-      if (process.env.DO_NOT_TRACK === '1') {
-        Logger.info('  DO_NOT_TRACK=1');
-      }
-    } else {
-      Logger.info(`Status: ${enabled ? '✅ ENABLED' : '❌ DISABLED'}`);
-    }
-
+    Logger.info(`Status: ${enabled ? '✅ ENABLED' : '❌ DISABLED'}`);
     Logger.info(`\nConfig file: ${configPath}`);
-    Logger.info(`Anonymous ID: ${config.anonymousId || 'Not set'}`);
-    Logger.info(`Endpoint: ${config.endpoint || 'Not set'}`);
-
-    if (process.env.CODEGEN_TELEMETRY_ENDPOINT) {
-      Logger.info(`  (overridden by CODEGEN_TELEMETRY_ENDPOINT)`);
-    }
+    Logger.info(`Anonymous ID: ${config.anonymousId}`);
+    Logger.info(`Endpoint: ${config.endpoint}`);
 
     Logger.info('\nWhat we collect:');
     Logger.info('  ✓ Command usage and flags');

src/telemetry/config.ts

@@ -13,10 +13,9 @@ import {ProjectTelemetryConfig} from '../codegen/types';
  * This function never throws - returns disabled config on any error.
  *
  * Priority order (highest to lowest):
- * 1. DO_NOT_TRACK or CODEGEN_TELEMETRY_DISABLED environment variables
- * 2. Environment variable overrides (endpoint, tracking ID, API secret)
- * 3. Project-level config (from codegen.config.js)
- * 4. Global config file (~/.the-codegen-project/config.json)
+ * 1. Project-level config (from codegen.config.js)
+ * 2. Global config file (~/.the-codegen-project/config.json)
+ * 3. Environment variable overrides (CODEGEN_TELEMETRY_DISABLED, DO_NOT_TRACK)
  *
  * @param projectConfig - Optional project-level telemetry config from codegen.config.js
  * @returns Promise resolving to telemetry configuration
@@ -30,7 +29,8 @@ export async function getTelemetryConfig(
       ...globalConfig.telemetry,
       ...(projectConfig ?? {})
     };
-    // 4. Apply environment variable overrides (highest priority for values)
+
+    // Apply environment variable overrides
     if (
       process.env.CODEGEN_TELEMETRY_DISABLED === '1' ||
       process.env.DO_NOT_TRACK
@@ -84,6 +84,7 @@ function createDisabledTelemetryConfig(): TelemetryConfig {
     enabled: false,
     anonymousId: '',
     endpoint: '',
-    trackingId: ''
+    trackingId: '',
+    apiSecret: ''
   };
 }

test/commands/telemetry.spec.ts

@@ -55,28 +55,31 @@ describe('telemetry command', () => {
   });
 
   describe('environment variable handling', () => {
-    it('should show DO_NOT_TRACK in status when set', async () => {
+    it('should show DISABLED when DO_NOT_TRACK is set', async () => {
+      // Save and clear global test setup
+      const originalCodegenDisabled = process.env.CODEGEN_TELEMETRY_DISABLED;
+      delete process.env.CODEGEN_TELEMETRY_DISABLED;
+      
       process.env.DO_NOT_TRACK = '1';
 
       const {stdout, error} = await runCommand('telemetry status');
 
       expect(error).toBeUndefined();
       expect(stdout).toContain('DISABLED');
-      expect(stdout).toContain('DO_NOT_TRACK=1');
 
       delete process.env.DO_NOT_TRACK;
+      // Restore global test setup
+      if (originalCodegenDisabled) {
+        process.env.CODEGEN_TELEMETRY_DISABLED = originalCodegenDisabled;
+      }
     });
 
-    it('should show CODEGEN_TELEMETRY_DISABLED in status when set', async () => {
-      process.env.CODEGEN_TELEMETRY_DISABLED = '1';
-
+    it('should show DISABLED when CODEGEN_TELEMETRY_DISABLED is set', async () => {
+      // CODEGEN_TELEMETRY_DISABLED is already set by test setup
       const {stdout, error} = await runCommand('telemetry status');
 
       expect(error).toBeUndefined();
       expect(stdout).toContain('DISABLED');
-      expect(stdout).toContain('CODEGEN_TELEMETRY_DISABLED=1');
-
-      delete process.env.CODEGEN_TELEMETRY_DISABLED;
     });
   });
 

test/configs/config-all.js

@@ -23,8 +23,5 @@ export default {
 			language: 'typescript',
 			protocols: ['nats']
 		}
-	],
-	telemetry: {
-		enabled: false
-	}
+	]
 };

test/configs/config-custom.js

@@ -18,8 +18,5 @@ export default {
 				return 'Hello World!';
 			}
 		}
-	],
-	telemetry: {
-		enabled: false
-	}
+	]
 };

test/configs/config-implicit.js

@@ -10,8 +10,5 @@ export default {
 			outputPath: './src/__gen__/', 
 			protocols: ['nats']
 		}
-	],
-	telemetry: {
-		enabled: false
-	}
+	]
 };

test/configs/config.js

@@ -10,8 +10,5 @@ export default {
 			// Not needed, as we can look in the AsyncAPI file, but we can overwrite it
 			serializationType: 'json', 
 		}
-	],
-	telemetry: {
-		enabled: false
-	}
+	]
 };

test/configs/config.json

@@ -8,8 +8,5 @@
       "outputPath": "./src/__gen__/",
       "serializationType": "json"
     }
-  ],
-	"telemetry": {
-		"enabled": false
-	}
+  ]
 }