e2e: add app version and build number to perf metrics (#9261)

### Summary

Updated the payload that we are sending to e2e-test-insights API to
include the app version and build #.

### QA Notes

n/a

Author: midleman

test/e2e/infra/test-runner/test-setup.ts

@@ -47,8 +47,8 @@ export function prepareTestEnv(rootPath: string, logsRootPath: string) {
 /**
  * Sets up the test environment for Electron or Web e2e tests.
  */
-function initializeTestEnvironment(rootPath = process.env.ROOT_PATH || 'ROOT_PATH not set initTestEnv', logger: Logger): string | null {
-	let version: string | null = null;
+function initializeTestEnvironment(rootPath = process.env.ROOT_PATH || 'ROOT_PATH not set initTestEnv', logger: Logger): PositronVersion | null {
+	let version: PositronVersion | null = null;
 
 	//
 	// #### E2E: Electron Tests ####
@@ -61,7 +61,9 @@ function initializeTestEnvironment(rootPath = process.env.ROOT_PATH || 'ROOT_PAT
 		if (testCodePath) {
 			electronPath = getBuildElectronPath(testCodePath);
 			version = getPositronVersion(testCodePath);
-			console.log('POSITRON VERSION:', version);
+			if (version) {
+				console.log(`POSITRON VERSION: ${version.positronVersion}-${version.buildNumber}`);
+			}
 		} else {
 			testCodePath = getDevElectronPath();
 			electronPath = testCodePath;
@@ -117,7 +119,11 @@ function prepareTestDataDirectory() {
 	mkdirp.sync(TEST_DATA_PATH);
 }
 
-function getPositronVersion(testCodePath: string): string | null {
+export function getPositronVersion(testCodePath = process.env.BUILD || ''): PositronVersion | null {
+	if (!testCodePath) {
+		return null;
+	}
+
 	let productJsonPath;
 	switch (process.platform) {
 		case 'darwin':
@@ -133,14 +139,27 @@ function getPositronVersion(testCodePath: string): string | null {
 			return null;
 	}
 
-	// Read and parse the JSON file
-	const productJson = JSON.parse(fs.readFileSync(productJsonPath, 'utf8'));
+	try {
+		// Read and parse the JSON file
+		const productJson = JSON.parse(fs.readFileSync(productJsonPath, 'utf8'));
+
+		// Return both version and build number properties
+		const positronVersion = productJson.positronVersion || null;
+		const buildNumber = productJson.positronBuildNumber || null;
 
-	// Return the `positronVersion` property if it exists, otherwise log an error
-	if (productJson.positronVersion) {
-		return productJson.positronVersion;
-	} else {
-		console.error('positronVersion not found in product.json.');
+		if (!positronVersion) {
+			throw new Error('positronVersion not found in product.json.');
+		}
+
+		if (!buildNumber) {
+			console.error('positronBuildNumber not found in product.json.');
+		}
+
+		return { positronVersion, buildNumber };
+	} catch (error) {
+		console.error('Error reading product.json:', error);
 		return null;
 	}
 }
+
+type PositronVersion = { positronVersion: string | null, buildNumber: string | null };

test/e2e/utils/metrics/api.ts

@@ -11,7 +11,8 @@ import {
 	LOCAL_API_URL,
 	platformOs,
 	platformVersion,
-	MetricResponse
+	MetricResponse,
+	positronVersion
 } from './metric-base.js';
 import { SPEC_NAME } from '../../fixtures/test-setup/constants.js';
 
@@ -28,6 +29,8 @@ export type PerfMetric = {
 
 export type MetricPayload = {
 	timestamp: string;
+	app_version: string;
+	build_number: string;
 	platform_os: string;
 	platform_version: string;
 	runtime_env: string;
@@ -99,6 +102,8 @@ function createMetricPayload(metric: PerfMetric, isElectronApp: boolean): Metric
 		timestamp: new Date().toISOString(),
 		platform_os: platformOs,
 		platform_version: platformVersion,
+		app_version: positronVersion?.positronVersion || 'unknown',
+		build_number: positronVersion?.buildNumber || 'unknown',
 		runtime_env: isElectronApp ? 'electron' : 'chromium',
 		run_id: process.env.GITHUB_RUN_ID ?? process.env.RUN_ID ?? 'unknown',
 		feature_area,

test/e2e/utils/metrics/metric-base.ts

@@ -5,11 +5,16 @@
 
 import os from 'os';
 import { DataExplorerShortcutOptions } from './metric-data-explorer.js';
+import { getPositronVersion } from '../../infra/test-runner/test-setup.js';
 
 export const CONNECT_API_KEY = process.env.CONNECT_API_KEY!;
 export const PROD_API_URL = 'https://connect.posit.it/e2e-test-insights-api/metrics';
 export const LOCAL_API_URL = 'http://127.0.0.1:8000/metrics';
 
+//-----------------------
+// Platform Information
+//-----------------------
+
 export const platformOs = (() => {
 	const osMap = {
 		darwin: 'macOS',
@@ -22,6 +27,8 @@ export const platformOs = (() => {
 
 export const platformVersion = os.release();
 
+export const positronVersion = getPositronVersion();
+
 //-----------------------
 // Base Metric Types
 //-----------------------