feat(jest-worker): child interval heartbeats

Author: ayshiff

packages/jest-worker/src/workers/ChildProcessWorker.ts

@@ -33,6 +33,8 @@ const SIGTERM_EXIT_CODE = SIGNAL_BASE_EXIT_CODE + 15;
 // How long to wait after SIGTERM before sending SIGKILL
 const SIGKILL_DELAY = 500;
 
+const CHILD_HEARTBEAT_INTERVAL = 1_000;
+
 /**
  * This class wraps the child process and provides a nice interface to
  * communicate with. It takes care of:
@@ -128,8 +130,15 @@ export default class ChildProcessWorker implements WorkerInterface {
       false,
       this._options.workerPath,
       this._options.setupArgs,
+      CHILD_HEARTBEAT_INTERVAL,
     ]);
 
+    setInterval(() => {
+      if (process && process.send) {
+        process.send([PARENT_MESSAGE_HEARTBEAT]);
+      }
+    }, 1000);
+
     this._child = child;
 
     this._retries++;
@@ -147,8 +156,6 @@ export default class ChildProcessWorker implements WorkerInterface {
         error.stack!,
         {type: 'WorkerError'},
       ]);
-
-      this.monitorHeartbeat(() => this.monitorHeartbeatError());
     }
   }
 
@@ -174,7 +181,7 @@ export default class ChildProcessWorker implements WorkerInterface {
 
     if (this._options.inspector !== undefined) {
       error = new Error(
-        `Test worker was unresponsive for 10 seconds. There was an inspector connected so we were able to capture stack frames before it was terminated.`,
+        `Test worker was unresponsive for ${this._options.workerHeartbeatTimeout} milliseconds. There was an inspector connected so we were able to capture stack frames before it was terminated.`,
       );
       this._options.inspector.on('Debugger.paused', (message: any) => {
         const callFrames = message.params.callFrames.slice(0, 20);
@@ -208,7 +215,7 @@ export default class ChildProcessWorker implements WorkerInterface {
       });
     } else {
       error = new Error(
-        `Test worker was unresponsive for 10 seconds. There was no inspector connected so we were unable to capture stack frames before it was terminated.`,
+        `Test worker was unresponsive for ${this._options.workerHeartbeatTimeout} milliseconds. There was no inspector connected so we were unable to capture stack frames before it was terminated.`,
       );
     }
     // @ts-expect-error: adding custom properties to errors.
@@ -227,12 +234,10 @@ export default class ChildProcessWorker implements WorkerInterface {
 
     switch (response[0]) {
       case PARENT_MESSAGE_OK:
-        clearTimeout(this._heartbeatTimeout);
         this._onProcessEnd(null, response[1]);
         break;
 
       case PARENT_MESSAGE_CLIENT_ERROR:
-        clearTimeout(this._heartbeatTimeout);
         error = response[4];
 
         if (error != null && typeof error === 'object') {
@@ -253,7 +258,6 @@ export default class ChildProcessWorker implements WorkerInterface {
         break;
 
       case PARENT_MESSAGE_SETUP_ERROR:
-        clearTimeout(this._heartbeatTimeout);
         error = new Error('Error when calling setup: ' + response[2]);
 
         error.type = response[1];
@@ -266,7 +270,6 @@ export default class ChildProcessWorker implements WorkerInterface {
         this.monitorHeartbeat(() => this.monitorHeartbeatError());
         break;
       case PARENT_MESSAGE_CUSTOM:
-        clearTimeout(this._heartbeatTimeout);
         this._onCustomMessage(response[1]);
         break;
       default:
@@ -288,6 +291,7 @@ export default class ChildProcessWorker implements WorkerInterface {
       }
     } else {
       this._shutdown();
+      clearTimeout(this._heartbeatTimeout);
     }
   }
 
@@ -323,6 +327,7 @@ export default class ChildProcessWorker implements WorkerInterface {
       SIGKILL_DELAY,
     );
     this._exitPromise.then(() => clearTimeout(sigkillTimeout));
+    clearTimeout(this._heartbeatTimeout);
   }
 
   getWorkerId(): number {

packages/jest-worker/src/workers/NodeThreadsWorker.ts

@@ -26,6 +26,8 @@ import {
   WorkerOptions,
 } from '../types';
 
+const CHILD_HEARTBEAT_INTERVAL = 1_000;
+
 export default class ExperimentalWorker implements WorkerInterface {
   private _worker!: Worker;
   private _options: WorkerOptions;
@@ -110,6 +112,7 @@ export default class ExperimentalWorker implements WorkerInterface {
       false,
       this._options.workerPath,
       this._options.setupArgs,
+      CHILD_HEARTBEAT_INTERVAL,
     ]);
 
     this._retries++;
@@ -203,12 +206,10 @@ export default class ExperimentalWorker implements WorkerInterface {
 
     switch (response[0]) {
       case PARENT_MESSAGE_OK:
-        clearTimeout(this._heartbeatTimeout);
         this._onProcessEnd(null, response[1]);
         break;
 
       case PARENT_MESSAGE_CLIENT_ERROR:
-        clearTimeout(this._heartbeatTimeout);
         error = response[4];
 
         if (error != null && typeof error === 'object') {
@@ -230,7 +231,6 @@ export default class ExperimentalWorker implements WorkerInterface {
         this._onProcessEnd(error, null);
         break;
       case PARENT_MESSAGE_SETUP_ERROR:
-        clearTimeout(this._heartbeatTimeout);
         error = new Error('Error when calling setup: ' + response[2]);
 
         // @ts-expect-error: adding custom properties to errors.
@@ -243,11 +243,9 @@ export default class ExperimentalWorker implements WorkerInterface {
         this.monitorHeartbeat(() => this.monitorHeartbeatError());
         break;
       case PARENT_MESSAGE_CUSTOM:
-        clearTimeout(this._heartbeatTimeout);
         this._onCustomMessage(response[1]);
         break;
       default:
-        clearTimeout(this._heartbeatTimeout);
         throw new TypeError('Unexpected response from worker: ' + response[0]);
     }
   }
@@ -261,6 +259,7 @@ export default class ExperimentalWorker implements WorkerInterface {
       }
     } else {
       this._shutdown();
+      clearTimeout(this._heartbeatTimeout);
     }
   }
 
@@ -271,6 +270,7 @@ export default class ExperimentalWorker implements WorkerInterface {
   forceExit(): void {
     this._forceExited = true;
     this._worker.terminate();
+    clearTimeout(this._heartbeatTimeout);
   }
 
   send(

packages/jest-worker/src/workers/processChild.ts

@@ -21,6 +21,8 @@ import {
 let file: string | null = null;
 let setupArgs: Array<unknown> = [];
 let initialized = false;
+let monitorHeartbeat: NodeJS.Timeout;
+let heartbeatIntervalValue: number;
 
 /**
  * This file is a small bootstrapper for workers. It sets up the communication
@@ -41,6 +43,10 @@ const messageListener: NodeJS.MessageListener = request => {
       const init: ChildMessageInitialize = request;
       file = init[2];
       setupArgs = request[3];
+      heartbeatIntervalValue = request[4];
+      monitorHeartbeat = setInterval(() => {
+        sendParentMessageHeartbeat();
+      }, heartbeatIntervalValue);
       break;
 
     case CHILD_MESSAGE_CALL:
@@ -115,6 +121,7 @@ function end(): void {
 function exitProcess(): void {
   // Clean up open handles so the process ideally exits gracefully
   process.removeListener('message', messageListener);
+  clearInterval(monitorHeartbeat);
 }
 
 function execMethod(method: string, args: Array<unknown>): void {
@@ -156,7 +163,6 @@ function execFunction(
   onError: (error: Error) => void,
 ): void {
   let result;
-  sendParentMessageHeartbeat();
 
   try {
     result = fn.apply(ctx, args);

packages/jest-worker/src/workers/threadChild.ts

@@ -23,6 +23,8 @@ import {
 let file: string | null = null;
 let setupArgs: Array<unknown> = [];
 let initialized = false;
+let monitorHeartbeat: NodeJS.Timeout;
+let heartbeatIntervalValue: number;
 
 /**
  * This file is a small bootstrapper for workers. It sets up the communication
@@ -43,6 +45,10 @@ const messageListener = (request: any) => {
       const init: ChildMessageInitialize = request;
       file = init[2];
       setupArgs = request[3];
+      heartbeatIntervalValue = request[4];
+      monitorHeartbeat = setInterval(() => {
+        sendParentMessageHeartbeat();
+      }, heartbeatIntervalValue);
       break;
 
     case CHILD_MESSAGE_CALL:
@@ -117,6 +123,7 @@ function end(): void {
 function exitProcess(): void {
   // Clean up open handles so the worker ideally exits gracefully
   parentPort!.removeListener('message', messageListener);
+  clearInterval(monitorHeartbeat);
 }
 
 function execMethod(method: string, args: Array<unknown>): void {
@@ -158,7 +165,6 @@ function execFunction(
   onError: (error: Error) => void,
 ): void {
   let result;
-  sendParentMessageHeartbeat();
 
   try {
     result = fn.apply(ctx, args);