Skip to content
Merged
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
2 changes: 1 addition & 1 deletion common/api-review/telemetry-angular.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { LoggerProvider } from '@opentelemetry/sdk-logs';

// @public
export class FirebaseErrorHandler implements ErrorHandler {
constructor(telemetryOptions?: TelemetryOptions | undefined);
constructor(app: FirebaseApp, telemetryOptions?: TelemetryOptions | undefined);
// (undocumented)
handleError(error: unknown): void;
}
Expand Down
12 changes: 8 additions & 4 deletions docs-devsite/telemetry_angular.firebaseerrorhandler.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export declare class FirebaseErrorHandler implements ErrorHandler

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(telemetryOptions)](./telemetry_angular.firebaseerrorhandler.md#firebaseerrorhandlerconstructor) | | Constructs a new instance of the <code>FirebaseErrorHandler</code> class |
| [(constructor)(app, telemetryOptions)](./telemetry_angular.firebaseerrorhandler.md#firebaseerrorhandlerconstructor) | | Constructs a new instance of the <code>FirebaseErrorHandler</code> class |

## Methods

Expand All @@ -40,13 +40,14 @@ Constructs a new instance of the `FirebaseErrorHandler` class
<b>Signature:</b>

```typescript
constructor(telemetryOptions?: TelemetryOptions | undefined);
constructor(app: FirebaseApp, telemetryOptions?: TelemetryOptions | undefined);
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| app | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | |
| telemetryOptions | [TelemetryOptions](./telemetry_.telemetryoptions.md#telemetryoptions_interface) \| undefined | |

## FirebaseErrorHandler.handleError()
Expand Down Expand Up @@ -78,7 +79,10 @@ import { FirebaseErrorHandler } from '@firebase/telemetry-angular';
@NgModule({
// ...
providers: [
{ provide: ErrorHandler, useClass: FirebaseErrorHandler }
{
provide: ErrorHandler,
useFactory: () => new FirebaseErrorHandler(firebaseApp)
}
],
// ...
})
Expand All @@ -99,7 +103,7 @@ import { FirebaseErrorHandler } from '@firebase/telemetry-angular';
providers: [
{
provide: ErrorHandler,
useFactory: () => new FirebaseErrorHandler({ appVersion: '1.2.3' })
useFactory: () => new FirebaseErrorHandler(firebaseApp, { appVersion: '1.2.3' })
}
],
// ...
Expand Down
2 changes: 1 addition & 1 deletion packages/telemetry/src/angular/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ describe('FirebaseErrorHandler', () => {
const testInjector = TestBed.inject(Injector);
errorHandler = runInInjectionContext(
testInjector,
() => new FirebaseErrorHandler()
() => new FirebaseErrorHandler(app)
);
router = TestBed.inject(Router);
});
Expand Down
17 changes: 12 additions & 5 deletions packages/telemetry/src/angular/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import { ActivatedRouteSnapshot, Router } from '@angular/router';
import { registerTelemetry } from '../register';
import { captureError, getTelemetry } from '../api';
import { TelemetryOptions } from '../public-types';
import { getApp } from '@firebase/app';
import { FirebaseApp } from '@firebase/app';

registerTelemetry();

Expand All @@ -42,7 +42,10 @@ export * from '../public-types';
* @NgModule({
* // ...
* providers: [
* { provide: ErrorHandler, useClass: FirebaseErrorHandler }
* {
* provide: ErrorHandler,
* useFactory: () => new FirebaseErrorHandler(firebaseApp)
* }
* ],
* // ...
* })
Expand All @@ -60,14 +63,15 @@ export * from '../public-types';
* providers: [
* {
* provide: ErrorHandler,
* useFactory: () => new FirebaseErrorHandler({ appVersion: '1.2.3' })
* useFactory: () => new FirebaseErrorHandler(firebaseApp, { appVersion: '1.2.3' })
* }
* ],
* // ...
* })
* export class AppModule { }
* ```
*
* @param firebaseApp - The {@link @firebase/app#FirebaseApp} instance to use.
* @param telemetryOptions - Optional. {@link TelemetryOptions} that configure the Telemetry instance.
* To provide these options, you must use a `useFactory` provider as shown in the example above.
*
Expand All @@ -76,10 +80,13 @@ export * from '../public-types';
export class FirebaseErrorHandler implements ErrorHandler {
private readonly router = inject(Router);

constructor(private telemetryOptions?: TelemetryOptions) {}
constructor(
private app: FirebaseApp,
private telemetryOptions?: TelemetryOptions
) {}

handleError(error: unknown): void {
const telemetry = getTelemetry(getApp(), this.telemetryOptions);
const telemetry = getTelemetry(this.app, this.telemetryOptions);

const attributes = {
'angular_route_path': this.getSafeRoutePath(this.router)
Expand Down
Loading