@todesktop/shared 7.188.22 → 7.188.23

package/lib/desktopify.d.ts

@@ -186,11 +186,59 @@ export interface SmokeTestProgress {
     bcState?: SmokeTestState;
     code?: string;
     message?: string;
+    performance?: SmokeTestPerformance;
     progress: number;
     screenshot?: string;
     state: SmokeTestState;
     updatedAppHasNoMainErrors?: boolean;
 }
+export interface SmokeTestPerformance {
+    /**
+     * Time between process spawning and `process.getCreationTime()`
+     */
+    appStartedMs: number;
+    /**
+     * Time between process spawning and `App#redy event`
+     */
+    appReadyMs: number;
+    /**
+     * From `process.cpuUsage()` user + system.
+     * This value measures time spent in user and system code, and may end up
+     * being greater than actual elapsed time if multiple CPU cores are
+     * performing work for this process.
+     * Under the hood, low-level calls like `getrusage` are used, so this value
+     * is calculated from the process start.
+     * It measures for the first 10-12 seconds of the app execution.
+     */
+    cupUsageMainProcessMs: number;
+    /**
+     * Maximum memory consumption by the main + renders + any other helper
+     * processes
+     */
+    memoryUsageAllProcessesMb: number;
+    /**
+     * Maximum memory consumption by the main process
+     */
+    memoryUsageMainProcessMb: number;
+    /**
+     * Maximum memory consumption by a renderer process (if started)
+     */
+    memoryUsageRendererProcessMb?: number;
+    /**
+     * Time between process spawning and `initSmokeTest()` of runtime execution
+     */
+    runtimeLoadedMs: number;
+    /**
+     * Time between process spawning and the first firing of WebContents#dom-ready
+     * if any window is created
+     */
+    webContentsDomReadyMs?: number;
+    /**
+     * Time between process spawning and the first firing of
+     * WebContents#did-finish-load if any window is created
+     */
+    webContentsFinishLoadMs?: number;
+}
 export declare type SmokeTestState = 'progress' | 'done' | 'error' | 'skipped';
 export declare const hasBuildKickedOff: (build: Build) => boolean;
 export declare const isPlatformBuildRunning: (platformBuild: PlatformBuild) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@todesktop/shared",
-  "version": "7.188.22",
+  "version": "7.188.23",
   "description": "",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",

package/src/desktopify.ts

@@ -263,12 +263,61 @@ export interface SmokeTestProgress {
   bcState?: SmokeTestState;
   code?: string; // string currently, since it's still a subject to change
   message?: string;
+  performance?: SmokeTestPerformance;
   progress: number;
   screenshot?: string;
   state: SmokeTestState;
   updatedAppHasNoMainErrors?: boolean;
 }
 
+export interface SmokeTestPerformance {
+  /**
+   * Time between process spawning and `process.getCreationTime()`
+   */
+  appStartedMs: number;
+  /**
+   * Time between process spawning and `App#redy event`
+   */
+  appReadyMs: number;
+  /**
+   * From `process.cpuUsage()` user + system.
+   * This value measures time spent in user and system code, and may end up
+   * being greater than actual elapsed time if multiple CPU cores are
+   * performing work for this process.
+   * Under the hood, low-level calls like `getrusage` are used, so this value
+   * is calculated from the process start.
+   * It measures for the first 10-12 seconds of the app execution.
+   */
+  cupUsageMainProcessMs: number;
+  /**
+   * Maximum memory consumption by the main + renders + any other helper
+   * processes
+   */
+  memoryUsageAllProcessesMb: number;
+  /**
+   * Maximum memory consumption by the main process
+   */
+  memoryUsageMainProcessMb: number;
+  /**
+   * Maximum memory consumption by a renderer process (if started)
+   */
+  memoryUsageRendererProcessMb?: number;
+  /**
+   * Time between process spawning and `initSmokeTest()` of runtime execution
+   */
+  runtimeLoadedMs: number;
+  /**
+   * Time between process spawning and the first firing of WebContents#dom-ready
+   * if any window is created
+   */
+  webContentsDomReadyMs?: number;
+  /**
+   * Time between process spawning and the first firing of
+   * WebContents#did-finish-load if any window is created
+   */
+  webContentsFinishLoadMs?: number;
+}
+
 export type SmokeTestState = 'progress' | 'done' | 'error' | 'skipped';
 
 export const hasBuildKickedOff = (build: Build): boolean => {