add additional utp data objects

Author: StephenHodgson

src/logging.ts

@@ -3,7 +3,7 @@ import * as fs from 'fs';
 export enum LogLevel {
     DEBUG = 'debug',
     CI = 'ci',
-    UTP = 'utp',
+    UTP = 'utp', // minimal logging level
     INFO = 'info',
     WARN = 'warning',
     ERROR = 'error',

src/unity-logging.ts

@@ -2,7 +2,15 @@ import * as fs from 'fs';
 import * as path from 'path';
 import { LogLevel, Logger } from './logging';
 import { Delay, WaitForFileToBeUnlocked } from './utilities';
-import { Phase, Severity, UTP, UTPBase, UTPMemoryLeak, UTPPlayerBuildInfo } from './utp/utp';
+import {
+    Phase,
+    Severity,
+    UTP,
+    UTPBase,
+    UTPMemoryLeak,
+    UTPPlayerBuildInfo,
+    normalizeTelemetryEntry
+} from './utp/utp';
 
 /**
  * Result of the tailLogFile function containing cleanup resources.
@@ -977,7 +985,7 @@ export function TailLogFile(logPath: string, projectPath: string | undefined): L
                 if (!sanitizedJson) { return; }
 
                 const utpJson = JSON.parse(sanitizedJson);
-                const utp = utpJson as UTP;
+                const utp = normalizeTelemetryEntry(utpJson);
                 telemetry.push(utp);
 
                 if (utp.message && 'severity' in utp &&
@@ -989,7 +997,7 @@ export function TailLogFile(logPath: string, projectPath: string | undefined): L
                     }
 
                     const file = utp.file ? utp.file.replace(/\\/g, '/') : undefined;
-                    const stacktrace = sanitizeStackTrace(utp.stacktrace);
+                    const stacktrace = sanitizeStackTrace(utp.stackTrace);
                     const message = stacktrace == undefined ? utp.message : `${utp.message}\n${stacktrace}`;
 
                     if (!githubAnnotationPrefixRegex.test(message)) {
@@ -1051,6 +1059,7 @@ export function TailLogFile(logPath: string, projectPath: string | undefined): L
                 break;
             }
             default:
+                logger.warn(`UTP entry has unknown type: ${utp.type ?? 'undefined'}`);
                 // Print raw JSON for unhandled UTP types
                 writeStdoutThenTableContent(`${JSON.stringify(utp)}\n`);
                 break;

src/utp/utp.ts

@@ -1,3 +1,5 @@
+import { Logger } from "../logging";
+
 export class UTPBase {
     type?: string;
     version?: number;
@@ -6,12 +8,15 @@ export class UTPBase {
     processId?: number;
     severity?: Severity;
     message?: string;
-    stacktrace?: string;
+    stackTrace?: string;
     line?: number;
+    lineNumber?: number;
     file?: string;
+    fileName?: string;
     name?: string;
     description?: string;
     duration?: number;
+    durationMicroseconds?: number;
     errors?: unknown[];
 }
 
@@ -20,6 +25,87 @@ export class UTPMemoryLeak extends UTPBase {
     memoryLabels?: Record<string, number> | Array<Record<string, number>>;
 }
 
+export class UTPLogEntry extends UTPBase { }
+
+export class UTPTestPlan extends UTPBase {
+    tests?: string[];
+}
+
+export interface ScreenSettingsInfo {
+    ScreenWidth?: number;
+    ScreenHeight?: number;
+    ScreenRefreshRate?: number;
+    Fullscreen?: boolean;
+}
+
+export class UTPScreenSettings extends UTPBase {
+    ScreenSettings?: ScreenSettingsInfo;
+}
+
+export interface PlayerSettingsInfo {
+    ScriptingBackend?: string;
+    MtRendering?: boolean;
+    GraphicsJobs?: boolean;
+    GpuSkinning?: boolean;
+    GraphicsApi?: string;
+    Batchmode?: string;
+    StereoRenderingPath?: string;
+    RenderThreadingMode?: string;
+    AndroidMinimumSdkVersion?: string;
+    AndroidTargetSdkVersion?: string;
+    ScriptingRuntimeVersion?: string;
+    AndroidTargetArchitecture?: string;
+    StripEngineCode?: boolean;
+}
+
+export class UTPPlayerSettings extends UTPBase {
+    PlayerSettings?: PlayerSettingsInfo;
+}
+
+export interface BuildSettingsInfo {
+    Platform?: string;
+    BuildTarget?: string;
+    DevelopmentPlayer?: boolean;
+    AndroidBuildSystem?: string;
+}
+
+export class UTPBuildSettings extends UTPBase {
+    BuildSettings?: BuildSettingsInfo;
+}
+
+export interface PlayerSystemInfoDetails {
+    OperatingSystem?: string;
+    DeviceModel?: string;
+    DeviceName?: string;
+    ProcessorType?: string;
+    ProcessorCount?: number;
+    GraphicsDeviceName?: string;
+    SystemMemorySize?: number;
+    XrModel?: string;
+    XrDevice?: string;
+}
+
+export class UTPPlayerSystemInfo extends UTPBase {
+    PlayerSystemInfo?: PlayerSystemInfoDetails;
+}
+
+export interface QualitySettingsInfo {
+    Vsync?: number;
+    AntiAliasing?: number;
+    ColorSpace?: string;
+    AnisotropicFiltering?: string;
+    BlendWeights?: string;
+}
+
+export class UTPQualitySettings extends UTPBase {
+    QualitySettings?: QualitySettingsInfo;
+}
+
+export class UTPTestStatus extends UTPBase {
+    state?: number;
+    iteration?: number;
+}
+
 export interface PlayerBuildInfoStep {
     description?: string;
     duration?: number;
@@ -30,7 +116,18 @@ export class UTPPlayerBuildInfo extends UTPBase {
     steps?: PlayerBuildInfoStep[];
 }
 
-export type UTP = UTPBase | UTPMemoryLeak | UTPPlayerBuildInfo;
+export type UTP =
+    | UTPBase
+    | UTPLogEntry
+    | UTPTestPlan
+    | UTPScreenSettings
+    | UTPPlayerSettings
+    | UTPBuildSettings
+    | UTPPlayerSystemInfo
+    | UTPQualitySettings
+    | UTPTestStatus
+    | UTPMemoryLeak
+    | UTPPlayerBuildInfo;
 
 export enum Phase {
     Begin = 'Begin',
@@ -44,4 +141,70 @@ export enum Severity {
     Error = 'Error',
     Exception = 'Exception',
     Assert = 'Assert'
+}
+
+const allowedUtpKeys = new Set<string>([
+    'allocatedMemory',
+    'BuildSettings',
+    'description',
+    'duration',
+    'durationMicroseconds',
+    'errors',
+    'file',
+    'fileName',
+    'iteration',
+    'line',
+    'lineNumber',
+    'memoryLabels',
+    'message',
+    'name',
+    'phase',
+    'PlayerSettings',
+    'PlayerSystemInfo',
+    'processId',
+    'QualitySettings',
+    'ScreenSettings',
+    'severity',
+    'stackTrace',
+    'state',
+    'steps',
+    'tests',
+    'time',
+    'type',
+    'version',
+]);
+
+/**
+ * Normalizes UTP telemetry entries to canonical shapes and reports unexpected properties.
+ * Accepts an optional warn callback to avoid importing logging dependencies here.
+ */
+export function normalizeTelemetryEntry(entry: unknown): UTP {
+    if (!entry || typeof entry !== 'object') {
+        return entry as UTP;
+    }
+
+    const utp = entry as UTP;
+    const record = entry as Record<string, unknown>;
+
+    const stackTraceLegacy = record.stacktrace;
+    if (utp.stackTrace === undefined && typeof stackTraceLegacy === 'string') {
+        utp.stackTrace = stackTraceLegacy;
+    }
+
+    if (!utp.type) {
+        Logger.instance.warn('UTP entry missing type property; telemetry entry may be ignored.');
+    }
+
+    const extras: string[] = [];
+    for (const key of Object.keys(record)) {
+        if (!allowedUtpKeys.has(key)) {
+            extras.push(key);
+        }
+    }
+
+    if (extras.length > 0) {
+        Logger.instance.warn(`UTP entry contains unrecognized properties: ${extras.join(', ')}`);
+    }
+
+    return utp;
 }