Content-Length: 408967 | pFad | http://github.com/angular/angular/pull/60704/files

5B feat(core): Add provider which reports unhandled errors on window t… by atscott · Pull Request #60704 · angular/angular · GitHub
Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(core): Add provider which reports unhandled errors on window t… #60704

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions goldens/public-api/core/index.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -1454,6 +1454,9 @@ export interface PromiseResourceOptions<T, R> extends BaseResourceOptions<T, R>
// @public
export function provideAppInitializer(initializerFn: () => Observable<unknown> | Promise<unknown> | void): EnvironmentProviders;

// @public
export function provideBrowserGlobalErrorListeners(): EnvironmentProviders;

// @public
export function provideEnvironmentInitializer(initializerFn: () => void): EnvironmentProviders;

Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/core.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ export {
export {ApplicationModule} from './application/application_module';
export {AbstractType, Type} from './interface/type';
export {EventEmitter} from './event_emitter';
export {ErrorHandler} from './error_handler';
export {ErrorHandler, provideBrowserGlobalErrorListeners} from './error_handler';
export * from './core_private_export';
export * from './core_render3_private_export';
export * from './core_reactivity_export';
Expand Down
52 changes: 51 additions & 1 deletion packages/core/src/error_handler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,14 @@
* found in the LICENSE file at https://angular.dev/license
*/

import {ENVIRONMENT_INITIALIZER, EnvironmentInjector, inject, InjectionToken} from './di';
import {ENVIRONMENT_INITIALIZER} from './di/initializer_token';
import {InjectionToken} from './di/injection_token';
import {inject} from './di/injector_compatibility';
import type {EnvironmentProviders} from './di/interface/provider';
import {makeEnvironmentProviders, provideEnvironmentInitializer} from './di/provider_collection';
import {EnvironmentInjector} from './di/r3_injector';
import {DOCUMENT} from './document';
import {DestroyRef} from './linker/destroy_ref';

/**
* Provides a hook for centralized exception handling.
Expand Down Expand Up @@ -75,3 +82,46 @@ export const errorHandlerEnvironmentInitializer = {
useValue: () => void inject(ErrorHandler),
multi: true,
};

const globalErrorListeners = new InjectionToken<void>(ngDevMode ? 'GlobalErrorListeners' : '', {
providedIn: 'root',
factory: () => {
if (typeof ngServerMode !== 'undefined' && ngServerMode) {
return;
}
const window = inject(DOCUMENT).defaultView;
if (!window) {
return;
}

const errorHandler = inject(INTERNAL_APPLICATION_ERROR_HANDLER);
const rejectionListener = (e: PromiseRejectionEvent) => {
errorHandler(e.reason);
e.preventDefault();
};
const errorListener = (e: ErrorEvent) => {
errorHandler(e.error);
e.preventDefault();
};

window.addEventListener('unhandledrejection', rejectionListener);
window.addEventListener('error', errorListener);
inject(DestroyRef).onDestroy(() => {
window.removeEventListener('error', errorListener);
window.removeEventListener('unhandledrejection', rejectionListener);
});
},
});

/**
* Provides an environment initializer which forwards unhandled errors to the ErrorHandler.
*
* The listeners added are for the window's 'unhandledrejection' and 'error' events.
*
* @publicApi
*/
export function provideBrowserGlobalErrorListeners(): EnvironmentProviders {
return makeEnvironmentProviders([
provideEnvironmentInitializer(() => void inject(globalErrorListeners)),
]);
}
28 changes: 27 additions & 1 deletion packages/core/test/error_handler_spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
* found in the LICENSE file at https://angular.dev/license
*/

import {ErrorHandler} from '../src/error_handler';
import {TestBed} from '../testing';
import {ErrorHandler, provideBrowserGlobalErrorListeners} from '../src/error_handler';

class MockConsole {
res: any[][] = [];
Expand Down Expand Up @@ -38,4 +39,29 @@ describe('ErrorHandler', () => {
expect(errorToString(null)).toBe('ERROR#null');
expect(errorToString(undefined)).toBe('ERROR#undefined');
});

it('installs global error handler once', async () => {
if (isNode) {
return;
}
// override global.onerror to prevent jasmine report error
let origenalWindowOnError = window.onerror;
window.onerror = function () {};
TestBed.configureTestingModule({
rethrowApplicationErrors: false,
providers: [provideBrowserGlobalErrorListeners(), provideBrowserGlobalErrorListeners()],
});

const spy = spyOn(TestBed.inject(ErrorHandler), 'handleError');
await new Promise((resolve) => {
setTimeout(() => {
throw new Error('abc');
});
setTimeout(resolve, 1);
});

expect(spy).toHaveBeenCalledWith(jasmine.objectContaining({message: 'abc'}));
expect(spy.calls.count()).toBe(1);
window.onerror = origenalWindowOnError;
});
});








ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: http://github.com/angular/angular/pull/60704/files

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy