fix: ignore all unrelated messages from child process (#13543)

LinusU · web-flow · commit 48ddbf495352 · 2023-02-03T14:02:47.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,7 @@
 
 - `[expect, @jest/expect]` Provide type of `actual` as a generic argument to `Matchers` to allow better-typed extensions ([#13848](https://github.com/facebook/jest/pull/13848))
 - `[jest-circus]` Added explicit mention of test failing because `done()` is not being called in error message ([#13847](https://github.com/facebook/jest/pull/13847))
+- `[jest-worker]` Ignore IPC messages not intended for Jest ([#13543](https://github.com/facebook/jest/pull/13543))
 
 ### Chore & Maintenance
 
diff --git a/packages/jest-worker/src/workers/ChildProcessWorker.ts b/packages/jest-worker/src/workers/ChildProcessWorker.ts
@@ -255,6 +255,9 @@ export default class ChildProcessWorker
   }
 
   private _onMessage(response: ParentMessage) {
+    // Ignore messages not intended for us
+    if (!Array.isArray(response)) return;
+
     // TODO: Add appropriate type check
     let error: any;
 
@@ -311,7 +314,8 @@ export default class ChildProcessWorker
         break;
 
       default:
-        throw new TypeError(`Unexpected response from worker: ${response[0]}`);
+        // Ignore messages not intended for us
+        break;
     }
   }
 
diff --git a/packages/jest-worker/src/workers/NodeThreadsWorker.ts b/packages/jest-worker/src/workers/NodeThreadsWorker.ts
@@ -170,6 +170,9 @@ export default class ExperimentalWorker
   }
 
   private _onMessage(response: ParentMessage) {
+    // Ignore messages not intended for us
+    if (!Array.isArray(response)) return;
+
     let error;
 
     switch (response[0]) {
@@ -227,7 +230,8 @@ export default class ExperimentalWorker
         break;
 
       default:
-        throw new TypeError(`Unexpected response from worker: ${response[0]}`);
+        // Ignore messages not intended for us
+        break;
     }
   }
 
diff --git a/packages/jest-worker/src/workers/__tests__/ChildProcessWorker.test.ts b/packages/jest-worker/src/workers/__tests__/ChildProcessWorker.test.ts
@@ -363,7 +363,7 @@ it('creates error instances for known errors', () => {
   expect(callback3.mock.calls[0][0]).toBe(412);
 });
 
-it('throws when the child process returns a strange message', () => {
+it('does not throw when the child process returns a strange message', () => {
   const worker = new Worker({
     forkOptions: {},
     maxRetries: 3,
@@ -378,9 +378,14 @@ it('throws when the child process returns a strange message', () => {
   );
 
   // Type 27 does not exist.
-  expect(() => {
-    forkInterface.emit('message', [27]);
-  }).toThrow(TypeError);
+  forkInterface.emit('message', [27]);
+
+  forkInterface.emit('message', 'test');
+  forkInterface.emit('message', {foo: 'bar'});
+  forkInterface.emit('message', 0);
+  forkInterface.emit('message', null);
+  forkInterface.emit('message', Symbol('test'));
+  forkInterface.emit('message', true);
 });
 
 it('does not restart the child if it cleanly exited', () => {
diff --git a/packages/jest-worker/src/workers/__tests__/NodeThreadsWorker.test.ts b/packages/jest-worker/src/workers/__tests__/NodeThreadsWorker.test.ts
@@ -365,7 +365,7 @@ it('creates error instances for known errors', () => {
   expect(callback3.mock.calls[0][0]).toBe(412);
 });
 
-it('throws when the thread returns a strange message', () => {
+it('does not throw when the thread returns a strange message', () => {
   const worker = new Worker({
     forkOptions: {},
     maxRetries: 3,
@@ -380,10 +380,26 @@ it('throws when the thread returns a strange message', () => {
   );
 
   // Type 27 does not exist.
-  expect(() => {
-    // @ts-expect-error: Testing internal method
-    worker._worker.emit('message', [27]);
-  }).toThrow(TypeError);
+  // @ts-expect-error: Testing internal method
+  worker._worker.emit('message', [27]);
+
+  // @ts-expect-error: Testing internal method
+  worker._worker.emit('message', 'test');
+
+  // @ts-expect-error: Testing internal method
+  worker._worker.emit('message', {foo: 'bar'});
+
+  // @ts-expect-error: Testing internal method
+  worker._worker.emit('message', 0);
+
+  // @ts-expect-error: Testing internal method
+  worker._worker.emit('message', null);
+
+  // @ts-expect-error: Testing internal method
+  worker._worker.emit('message', Symbol('test'));
+
+  // @ts-expect-error: Testing internal method
+  worker._worker.emit('message', true);
 });
 
 it('does not restart the thread if it cleanly exited', () => {

Original file line number	Diff line number	Diff line change
`@@ -255,6 +255,9 @@ export default class ChildProcessWorker`
`255`	`255`	`}`
`256`	`256`
`257`	`257`	`private _onMessage(response: ParentMessage) {`
	`258`	`+ // Ignore messages not intended for us`
	`259`	`+ if (!Array.isArray(response)) return;`
	`260`	`+`
`258`	`261`	`// TODO: Add appropriate type check`
`259`	`262`	`let error: any;`
`260`	`263`
`@@ -311,7 +314,8 @@ export default class ChildProcessWorker`
`311`	`314`	`break;`
`312`	`315`
`313`	`316`	`default:`
`314`		- throw new TypeError(`Unexpected response from worker: ${response[0]}`);
	`317`	`+ // Ignore messages not intended for us`
	`318`	`+ break;`
`315`	`319`	`}`
`316`	`320`	`}`
`317`	`321`
Original file line number	Diff line number	Diff line change
`@@ -170,6 +170,9 @@ export default class ExperimentalWorker`
`170`	`170`	`}`
`171`	`171`
`172`	`172`	`private _onMessage(response: ParentMessage) {`
	`173`	`+ // Ignore messages not intended for us`
	`174`	`+ if (!Array.isArray(response)) return;`
	`175`	`+`
`173`	`176`	`let error;`
`174`	`177`
`175`	`178`	`switch (response[0]) {`
`@@ -227,7 +230,8 @@ export default class ExperimentalWorker`
`227`	`230`	`break;`
`228`	`231`
`229`	`232`	`default:`
`230`		- throw new TypeError(`Unexpected response from worker: ${response[0]}`);
	`233`	`+ // Ignore messages not intended for us`
	`234`	`+ break;`
`231`	`235`	`}`
`232`	`236`	`}`
`233`	`237`