fix(zone.js): disable wrapping unhandled promise error by default

JiaLiPassion · JiaLiPassion · commit 6d7eb3548c5f · 2023-11-02T16:33:03.000Z
Before this commit, zone.js wraps the uncaught promise rejection error
to a new Error object includes more information such as Zone stack
traces. This feature is provided from the very beginning of Zone.js,
but this feature becomes very annoying and make the user difficult to
debug.

So this commit disable this wrapping behavior by default, and user can
enable this feature back by setting
`DISABLE_WRAPPING_UNCAUGHT_PROMISE_REJECTION` to `false`.
diff --git a/packages/platform-browser/test/testing_public_spec.ts b/packages/platform-browser/test/testing_public_spec.ts
@@ -860,7 +860,7 @@ describe('public testing API', () => {
          })));
 
       itPromise.then(() => done.fail('Expected test to fail, but it did not'), (err) => {
-        expect(err.message).toEqual('Uncaught (in promise): baz');
+        expect(err.message).toEqual('baz');
         done();
       });
       restoreJasmineIt();
diff --git a/packages/zone.js/lib/common/promise.ts b/packages/zone.js/lib/common/promise.ts
@@ -23,7 +23,7 @@ Zone.__load_patch('ZoneAwarePromise', (global: any, Zone: ZoneType, api: _ZonePr
   const __symbol__ = api.symbol;
   const _uncaughtPromiseErrors: UncaughtPromiseError[] = [];
   const isDisableWrappingUncaughtPromiseRejection =
-      global[__symbol__('DISABLE_WRAPPING_UNCAUGHT_PROMISE_REJECTION')] === true;
+      global[__symbol__('DISABLE_WRAPPING_UNCAUGHT_PROMISE_REJECTION')] !== false;
   const symbolPromise = __symbol__('Promise');
   const symbolThen = __symbol__('then');
   const creationTrace = '__creationTrace__';
diff --git a/packages/zone.js/lib/zone.configurations.api.ts b/packages/zone.js/lib/zone.configurations.api.ts
@@ -576,11 +576,11 @@ interface ZoneGlobalConfigurations {
   /**
    * Disable wrapping uncaught promise rejection.
    *
-   * By default, `zone.js` wraps the uncaught promise rejection in a new `Error` object
-   * which contains additional information such as a value of the rejection and a stack trace.
+   * By default, `zone.js` throws the original error occurs in the uncaught promise rejection.
    *
-   * If you set `__zone_symbol__DISABLE_WRAPPING_UNCAUGHT_PROMISE_REJECTION = true;` before
-   * importing `zone.js`, `zone.js` will not wrap the uncaught promise rejection.
+   * If you set `__zone_symbol__DISABLE_WRAPPING_UNCAUGHT_PROMISE_REJECTION = false;` before
+   * importing `zone.js`, `zone.js` will wrap the uncaught promise rejection in a new `Error` object
+   * which contains additional information such as a value of the rejection and a stack trace.
    */
   __zone_symbol__DISABLE_WRAPPING_UNCAUGHT_PROMISE_REJECTION?: boolean;
 }
diff --git a/packages/zone.js/test/browser-zone-setup.ts b/packages/zone.js/test/browser-zone-setup.ts
@@ -9,6 +9,7 @@ if (typeof window !== 'undefined') {
   const zoneSymbol = (window as any).Zone.__symbol__;
   (window as any)['__Zone_enable_cross_context_check'] = true;
   (window as any)[zoneSymbol('fakeAsyncAutoFakeAsyncWhenClockPatched')] = true;
+  (window as any)[zoneSymbol('DISABLE_WRAPPING_UNCAUGHT_PROMISE_REJECTION')] = false;
 }
 import '../lib/common/to-string';
 import '../lib/browser/api-util';
diff --git a/packages/zone.js/test/browser_disable_wrap_uncaught_promise_rejection_setup.ts b/packages/zone.js/test/browser_disable_wrap_uncaught_promise_rejection_setup.ts
@@ -5,5 +5,4 @@
  * 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
  */
-
-(window as any)['__zone_symbol__DISABLE_WRAPPING_UNCAUGHT_PROMISE_REJECTION'] = true;
+// This is an empty karma test entry file just to keep the bazel macro happy.
diff --git a/packages/zone.js/test/browser_symbol_setup.ts b/packages/zone.js/test/browser_symbol_setup.ts
@@ -1,3 +1,4 @@
 (window as any).global = window;
 // Change default symbol prefix for testing to ensure no hard-coded references.
 (window as any)['__Zone_symbol_prefix'] = '_test__';
+(window as any)['_test__DISABLE_WRAPPING_UNCAUGHT_PROMISE_REJECTION'] = false;
diff --git a/packages/zone.js/test/node-env-setup.ts b/packages/zone.js/test/node-env-setup.ts
@@ -1,2 +1,3 @@
 // Change default symbol prefix for testing to ensure no hard-coded references.
 (global as any)['__Zone_symbol_prefix'] = '__zone_symbol_test__';
+(global as any)['__zone_symbol_test__DISABLE_WRAPPING_UNCAUGHT_PROMISE_REJECTION'] = false;

Original file line number	Diff line number	Diff line change
`@@ -576,11 +576,11 @@ interface ZoneGlobalConfigurations {`
`576`	`576`	`/**`
`577`	`577`	`* Disable wrapping uncaught promise rejection.`
`578`	`578`	`*`
`579`		- * By default, `zone.js` wraps the uncaught promise rejection in a new `Error` object
`580`		`- * which contains additional information such as a value of the rejection and a stack trace.`
	`579`	+ * By default, `zone.js` throws the original error occurs in the uncaught promise rejection.
`581`	`580`	`*`
`582`		- * If you set `__zone_symbol__DISABLE_WRAPPING_UNCAUGHT_PROMISE_REJECTION = true;` before
`583`		- * importing `zone.js`, `zone.js` will not wrap the uncaught promise rejection.
	`581`	+ * If you set `__zone_symbol__DISABLE_WRAPPING_UNCAUGHT_PROMISE_REJECTION = false;` before
	`582`	+ * importing `zone.js`, `zone.js` will wrap the uncaught promise rejection in a new `Error` object
	`583`	`+ * which contains additional information such as a value of the rejection and a stack trace.`
`584`	`584`	`*/`
`585`	`585`	`__zone_symbol__DISABLE_WRAPPING_UNCAUGHT_PROMISE_REJECTION?: boolean;`
`586`	`586`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ if (typeof window !== 'undefined') {`
`9`	`9`	`const zoneSymbol = (window as any).Zone.__symbol__;`
`10`	`10`	`(window as any)['__Zone_enable_cross_context_check'] = true;`
`11`	`11`	`(window as any)[zoneSymbol('fakeAsyncAutoFakeAsyncWhenClockPatched')] = true;`
	`12`	`+ (window as any)[zoneSymbol('DISABLE_WRAPPING_UNCAUGHT_PROMISE_REJECTION')] = false;`
`12`	`13`	`}`
`13`	`14`	`import '../lib/common/to-string';`
`14`	`15`	`import '../lib/browser/api-util';`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`// Change default symbol prefix for testing to ensure no hard-coded references.`
`2`	`2`	`(global as any)['__Zone_symbol_prefix'] = '__zone_symbol_test__';`
	`3`	`+(global as any)['__zone_symbol_test__DISABLE_WRAPPING_UNCAUGHT_PROMISE_REJECTION'] = false;`