fix(zone.js): enable monkey patching of the queueMicrotask() API in node.js

alan-agius4 · alan-agius4 · commit 320e70a2464a · 2023-05-26T04:55:40.000Z
Similar to the browser, now we also monkey patch `queueMicrotask` in Node.js. This API was added in Node.js 11.
diff --git a/packages/zone.js/karma-build.conf.js b/packages/zone.js/karma-build.conf.js
@@ -13,5 +13,6 @@ module.exports = function(config) {
   config.files.push('build/test/test_fake_polyfill.js');
   config.files.push('build/lib/zone.js');
   config.files.push('build/lib/common/promise.js');
+  config.files.push('build/lib/common/queue-microtask.js');
   config.files.push('build/test/main.js');
 };
diff --git a/packages/zone.js/lib/browser/browser.ts b/packages/zone.js/lib/browser/browser.ts
@@ -25,15 +25,6 @@ Zone.__load_patch('legacy', (global: any) => {
   }
 });
 
-Zone.__load_patch('queueMicrotask', (global: any, Zone: ZoneType, api: _ZonePrivate) => {
-  api.patchMethod(global, 'queueMicrotask', delegate => {
-    return function(self: any, args: any[]) {
-      Zone.current.scheduleMicroTask('queueMicrotask', args[0]);
-    }
-  });
-});
-
-
 Zone.__load_patch('timers', (global: any) => {
   const set = 'set';
   const clear = 'clear';
diff --git a/packages/zone.js/lib/browser/rollup-common.ts b/packages/zone.js/lib/browser/rollup-common.ts
@@ -10,3 +10,4 @@ import '../zone';
 import '../common/promise';
 import '../common/to-string';
 import './api-util';
+import '../common/queue-microtask';
diff --git a/packages/zone.js/lib/common/queue-microtask.ts b/packages/zone.js/lib/common/queue-microtask.ts
@@ -0,0 +1,19 @@
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+/**
+ * @fileoverview
+ * @suppress {missingRequire}
+ */
+
+Zone.__load_patch('queueMicrotask', (global: any, Zone: ZoneType, api: _ZonePrivate) => {
+  api.patchMethod(global, 'queueMicrotask', delegate => {
+    return function(self: any, args: any[]) {
+      Zone.current.scheduleMicroTask('queueMicrotask', args[0]);
+    }
+  });
+});
diff --git a/packages/zone.js/lib/node/node.ts b/packages/zone.js/lib/node/node.ts
@@ -9,6 +9,7 @@
 import './node_util';
 import './events';
 import './fs';
+import '../common/queue-microtask';
 
 import {findEventTasks} from '../common/events';
 import {patchTimer} from '../common/timers';
diff --git a/packages/zone.js/lib/zone.configurations.api.ts b/packages/zone.js/lib/zone.configurations.api.ts
@@ -296,9 +296,9 @@ interface ZoneGlobalConfigurations {
 
   /**
    *
-   * Disable the monkey patching of the browser's `queueMicrotask()` API.
+   * Disable the monkey patching of the `queueMicrotask()` API.
    *
-   * By default, `zone.js` monkey patches the browser's `queueMicrotask()` API
+   * By default, `zone.js` monkey patches the `queueMicrotask()` API
    * to ensure that `queueMicrotask()` callback is invoked in the same zone as zone used to invoke
    * `queueMicrotask()`. And also the callback is running as `microTask` like
    * `Promise.prototype.then()`.
diff --git a/packages/zone.js/test/browser-zone-setup.ts b/packages/zone.js/test/browser-zone-setup.ts
@@ -11,6 +11,7 @@ if (typeof window !== 'undefined') {
   (window as any)[zoneSymbol('fakeAsyncAutoFakeAsyncWhenClockPatched')] = true;
 }
 import '../lib/common/to-string';
+import '../lib/common/queue-microtask';
 import '../lib/browser/api-util';
 import '../lib/browser/browser-legacy';
 import '../lib/browser/browser';
diff --git a/packages/zone.js/test/browser_entry_point.ts b/packages/zone.js/test/browser_entry_point.ts
@@ -28,4 +28,3 @@ import './mocha-patch.spec';
 import './jasmine-patch.spec';
 import './browser/messageport.spec';
 import './extra/cordova.spec';
-import './browser/queue-microtask.spec';
diff --git a/packages/zone.js/test/common/queue-microtask.spec.ts b/packages/zone.js/test/common/queue-microtask.spec.ts
diff --git a/packages/zone.js/test/common_tests.ts b/packages/zone.js/test/common_tests.ts
@@ -11,6 +11,7 @@ import './common/zone.spec';
 import './common/task.spec';
 import './common/util.spec';
 import './common/Promise.spec';
+import './common/queue-microtask.spec';
 import './common/fetch.spec';
 import './common/Error.spec';
 import './common/setInterval.spec';
diff --git a/packages/zone.js/test/node_error_entry_point.init.ts b/packages/zone.js/test/node_error_entry_point.init.ts
@@ -11,6 +11,7 @@ import './test_fake_polyfill';
 // Setup tests for Zone without microtask support
 import '../lib/zone';
 import '../lib/common/promise';
+import '../lib/common/queue-microtask';
 import '../lib/common/to-string';
 import './test-env-setup-jasmine';
 import './wtf_mock';

Original file line number	Diff line number	Diff line change
`@@ -296,9 +296,9 @@ interface ZoneGlobalConfigurations {`
`296`	`296`
`297`	`297`	`/**`
`298`	`298`	`*`
`299`		- * Disable the monkey patching of the browser's `queueMicrotask()` API.
	`299`	+ * Disable the monkey patching of the `queueMicrotask()` API.
`300`	`300`	`*`
`301`		- * By default, `zone.js` monkey patches the browser's `queueMicrotask()` API
	`301`	+ * By default, `zone.js` monkey patches the `queueMicrotask()` API
`302`	`302`	* to ensure that `queueMicrotask()` callback is invoked in the same zone as zone used to invoke
`303`	`303`	* `queueMicrotask()`. And also the callback is running as `microTask` like
`304`	`304`	* `Promise.prototype.then()`.
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ if (typeof window !== 'undefined') {`
`11`	`11`	`(window as any)[zoneSymbol('fakeAsyncAutoFakeAsyncWhenClockPatched')] = true;`
`12`	`12`	`}`
`13`	`13`	`import '../lib/common/to-string';`
	`14`	`+import '../lib/common/queue-microtask';`
`14`	`15`	`import '../lib/browser/api-util';`
`15`	`16`	`import '../lib/browser/browser-legacy';`
`16`	`17`	`import '../lib/browser/browser';`