Skip to content

Commit 350c538

Browse files
andrewbrookandrewbrook
authored
Create Angular ErrorHandler (#9322)
* WIP Angular ErrorHandler * implement ng ErrorHandler * generate docs * downgrade angular deps for compat * cleanup
1 parent 2c5a4f7 commit 350c538

16 files changed

+546
-7
lines changed

‎common/api-review/telemetry-angular.api.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## API Report File for "@firebase/telemetry-angular"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
import { ErrorHandler } from '@angular/core';
8+
import { FirebaseApp } from '@firebase/app';
9+
import { LoggerProvider } from '@opentelemetry/sdk-logs';
10+
11+
// @public (undocumented)
12+
export class FirebaseErrorHandler implements ErrorHandler {
13+
constructor(telemetryOptions?: TelemetryOptions | undefined);
14+
// (undocumented)
15+
handleError(error: unknown): void;
16+
}
17+
18+
// @public
19+
export interface Telemetry {
20+
app: FirebaseApp;
21+
loggerProvider: LoggerProvider;
22+
}
23+
24+
// @public
25+
export interface TelemetryOptions {
26+
endpointUrl?: string;
27+
}
28+
29+
30+
// (No @packageDocumentation comment for this package)
31+
32+
```

‎docs-devsite/_toc.yaml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -701,6 +701,15 @@ toc:
701701
path: /docs/reference/js/telemetry_.telemetry.md
702702
- title: TelemetryOptions
703703
path: /docs/reference/js/telemetry_.telemetryoptions.md
704+
- title: telemetry/angular
705+
path: /docs/reference/js/telemetry_angular.md
706+
section:
707+
- title: FirebaseErrorHandler
708+
path: /docs/reference/js/telemetry_angular.firebaseerrorhandler.md
709+
- title: Telemetry
710+
path: /docs/reference/js/telemetry_angular.telemetry.md
711+
- title: TelemetryOptions
712+
path: /docs/reference/js/telemetry_angular.telemetryoptions.md
704713
- title: telemetry/react
705714
path: /docs/reference/js/telemetry_react.md
706715
section:

‎docs-devsite/telemetry.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,6 @@ https://github.com/firebase/firebase-js-sdk
1414
| Entry Point | Description |
1515
| --- | --- |
1616
| [/](./telemetry_.md#@firebase/telemetry) | |
17+
| [/angular](./telemetry_angular.md#@firebase/telemetry/angular) | |
1718
| [/react](./telemetry_react.md#@firebase/telemetry/react) | |
1819

‎docs-devsite/telemetry_angular.firebaseerrorhandler.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# FirebaseErrorHandler class
13+
<b>Signature:</b>
14+
15+
```typescript
16+
export declare class FirebaseErrorHandler implements ErrorHandler
17+
```
18+
<b>Implements:</b> ErrorHandler
19+
20+
## Constructors
21+
22+
| Constructor | Modifiers | Description |
23+
| --- | --- | --- |
24+
| [(constructor)(telemetryOptions)](./telemetry_angular.firebaseerrorhandler.md#firebaseerrorhandlerconstructor) | | Constructs a new instance of the <code>FirebaseErrorHandler</code> class |
25+
26+
## Methods
27+
28+
| Method | Modifiers | Description |
29+
| --- | --- | --- |
30+
| [handleError(error)](./telemetry_angular.firebaseerrorhandler.md#firebaseerrorhandlerhandleerror) | | |
31+
32+
## FirebaseErrorHandler.(constructor)
33+
34+
Constructs a new instance of the `FirebaseErrorHandler` class
35+
36+
<b>Signature:</b>
37+
38+
```typescript
39+
constructor(telemetryOptions?: TelemetryOptions | undefined);
40+
```
41+
42+
#### Parameters
43+
44+
| Parameter | Type | Description |
45+
| --- | --- | --- |
46+
| telemetryOptions | [TelemetryOptions](./telemetry_.telemetryoptions.md#telemetryoptions_interface) \| undefined | |
47+
48+
## FirebaseErrorHandler.handleError()
49+
50+
<b>Signature:</b>
51+
52+
```typescript
53+
handleError(error: unknown): void;
54+
```
55+
56+
#### Parameters
57+
58+
| Parameter | Type | Description |
59+
| --- | --- | --- |
60+
| error | unknown | |
61+
62+
<b>Returns:</b>
63+
64+
void
65+

‎docs-devsite/telemetry_angular.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# @firebase/telemetry/angular
13+
14+
## Classes
15+
16+
| Class | Description |
17+
| --- | --- |
18+
| [FirebaseErrorHandler](./telemetry_angular.firebaseerrorhandler.md#firebaseerrorhandler_class) | |
19+
20+
## Interfaces
21+
22+
| Interface | Description |
23+
| --- | --- |
24+
| [Telemetry](./telemetry_angular.telemetry.md#telemetry_interface) | An instance of the Firebase Telemetry SDK.<!-- -->Do not create this instance directly. Instead, use [getTelemetry()](./telemetry_.md#gettelemetry_448bdc6)<!-- -->. |
25+
| [TelemetryOptions](./telemetry_angular.telemetryoptions.md#telemetryoptions_interface) | Options for initialized the Telemetry service using [getTelemetry()](./telemetry_.md#gettelemetry_448bdc6)<!-- -->. |
26+

‎docs-devsite/telemetry_angular.telemetry.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# Telemetry interface
13+
An instance of the Firebase Telemetry SDK.
14+
15+
Do not create this instance directly. Instead, use [getTelemetry()](./telemetry_.md#gettelemetry_448bdc6)<!-- -->.
16+
17+
<b>Signature:</b>
18+
19+
```typescript
20+
export interface Telemetry
21+
```
22+
23+
## Properties
24+
25+
| Property | Type | Description |
26+
| --- | --- | --- |
27+
| [app](./telemetry_angular.telemetry.md#telemetryapp) | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance is associated with. |
28+
| [loggerProvider](./telemetry_angular.telemetry.md#telemetryloggerprovider) | LoggerProvider | The this [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance uses. |
29+
30+
## Telemetry.app
31+
32+
The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance is associated with.
33+
34+
<b>Signature:</b>
35+
36+
```typescript
37+
app: FirebaseApp;
38+
```
39+
40+
## Telemetry.loggerProvider
41+
42+
The this [Telemetry](./telemetry_.telemetry.md#telemetry_interface) instance uses.
43+
44+
<b>Signature:</b>
45+
46+
```typescript
47+
loggerProvider: LoggerProvider;
48+
```

‎docs-devsite/telemetry_angular.telemetryoptions.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# TelemetryOptions interface
13+
Options for initialized the Telemetry service using [getTelemetry()](./telemetry_.md#gettelemetry_448bdc6)<!-- -->.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface TelemetryOptions
19+
```
20+
21+
## Properties
22+
23+
| Property | Type | Description |
24+
| --- | --- | --- |
25+
| [endpointUrl](./telemetry_angular.telemetryoptions.md#telemetryoptionsendpointurl) | string | The URL for the endpoint to which telemetry data should be sent, in the Open Telemetry format. By default, data will be sent to Firebase. |
26+
27+
## TelemetryOptions.endpointUrl
28+
29+
The URL for the endpoint to which telemetry data should be sent, in the Open Telemetry format. By default, data will be sent to Firebase.
30+
31+
<b>Signature:</b>
32+
33+
```typescript
34+
endpointUrl?: string;
35+
```

‎packages/telemetry/api-extractor.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55
{
66
"modulePath": "react",
77
"filePath": "<projectFolder>/dist/react/index.d.ts"
8+
},
9+
{
10+
"modulePath": "angular",
11+
"filePath": "<projectFolder>/dist/angular/index.d.ts"
812
}
913
],
1014
"dtsRollup": {

‎packages/telemetry/package.json‎

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,18 @@
3131
},
3232
"default": "./dist/react/index.esm.js"
3333
},
34+
"./angular": {
35+
"types": "./dist/angular/index-public.d.ts",
36+
"node": {
37+
"import": "./dist/angular/index.esm.js",
38+
"default": "./dist/angular/index.cjs.js"
39+
},
40+
"browser": {
41+
"require": "./dist/angular/index.cjs.js",
42+
"import": "./dist/angular/index.esm.js"
43+
},
44+
"default": "./dist/angular/index.esm.js"
45+
},
3446
"./package.json": "./package.json"
3547
},
3648
"files": [
@@ -39,18 +51,20 @@
3951
"scripts": {
4052
"lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
4153
"lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
54+
"build-only": "rollup -c",
4255
"build": "rollup -c && yarn api-report",
4356
"build:deps": "lerna run --scope @firebase/telemetry --include-dependencies build",
4457
"dev": "rollup -c -w",
4558
"test": "run-p --npm-path npm lint test:all",
4659
"test:ci": "node ../../scripts/run_tests_in_ci.js -s test:all",
4760
"test:all": "run-p --npm-path npm test:browser test:node",
4861
"test:browser": "karma start",
49-
"test:node": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha **/*.test.ts src/**/*.test.ts --config ../../config/mocharc.node.js",
62+
"test:node": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha **/*.test.ts src/**/*.test.ts --exclude src/angular/*.test.ts --config ../../config/mocharc.node.js",
5063
"trusted-type-check": "tsec -p tsconfig.json --noEmit",
51-
"api-report": "yarn api-report:main && yarn api-report:react && yarn api-report:api-json",
64+
"api-report": "yarn api-report:main && yarn api-report:react && yarn api-report:angular && yarn api-report:api-json",
5265
"api-report:main": "ts-node-script ../../repo-scripts/prune-dts/extract-public-api.ts --package telemetry --packageRoot . --typescriptDts ./dist/index.d.ts --rollupDts ./dist/private.d.ts --untrimmedRollupDts ./dist/internal.d.ts --publicDts ./dist/index-public.d.ts",
5366
"api-report:react": "ts-node-script ../../repo-scripts/prune-dts/extract-public-api.ts --package telemetry-react --packageRoot . --typescriptDts ./dist/react/index.d.ts --rollupDts ./dist/react/private.d.ts --untrimmedRollupDts ./dist/react/internal.d.ts --publicDts ./dist/react/index-public.d.ts",
67+
"api-report:angular": "ts-node-script ../../repo-scripts/prune-dts/extract-public-api.ts --package telemetry-angular --packageRoot . --typescriptDts ./dist/angular/index.d.ts --rollupDts ./dist/angular/private.d.ts --untrimmedRollupDts ./dist/angular/internal.d.ts --publicDts ./dist/angular/index-public.d.ts",
5468
"api-report:api-json": "api-extractor run --local --verbose",
5569
"typings:public": "node ../../scripts/build/use_typings.js ./dist/index-public.d.ts"
5670
},
@@ -66,6 +80,12 @@
6680
},
6781
"@types/react": {
6882
"optional": true
83+
},
84+
"@angular/core": {
85+
"optional": true
86+
},
87+
"@angular/router": {
88+
"optional": true
6989
}
7090
},
7191
"dependencies": {
@@ -82,6 +102,11 @@
82102
},
83103
"license": "Apache-2.0",
84104
"devDependencies": {
105+
"@angular/common": "19.2.15",
106+
"@angular/compiler": "19.2.15",
107+
"@angular/core": "19.2.15",
108+
"@angular/platform-browser": "19.2.15",
109+
"@angular/router": "19.2.15",
85110
"@firebase/app": "0.14.4",
86111
"@opentelemetry/sdk-trace-web": "2.1.0",
87112
"@rollup/plugin-json": "6.1.0",
@@ -95,7 +120,9 @@
95120
"rollup-plugin-copy": "3.5.0",
96121
"rollup-plugin-replace": "2.2.0",
97122
"rollup-plugin-typescript2": "0.36.0",
98-
"typescript": "5.5.4"
123+
"rxjs": "7.8.2",
124+
"typescript": "5.5.4",
125+
"zone.js": "0.15.1"
99126
},
100127
"repository": {
101128
"directory": "packages/telemetry",

‎packages/telemetry/rollup.config.js‎

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,4 +123,56 @@ const reactBuilds = [
123123
}
124124
];
125125

126-
export default [...browserBuilds, ...nodeBuilds, ...reactBuilds];
126+
const angularBuilds = [
127+
{
128+
input: 'src/angular/index.ts',
129+
output: {
130+
file: pkg.exports['./angular'].browser.import,
131+
format: 'es',
132+
sourcemap: true
133+
},
134+
plugins: [
135+
typescriptPlugin({
136+
typescript,
137+
tsconfig: 'tsconfig.angular.json'
138+
}),
139+
json(),
140+
copy({
141+
targets: [
142+
{
143+
src: 'dist/src/angular/index.d.ts',
144+
dest: 'dist/angular'
145+
},
146+
{
147+
src: 'dist/src/public-types.d.ts',
148+
dest: 'dist'
149+
}
150+
]
151+
})
152+
],
153+
external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
154+
},
155+
{
156+
input: 'src/angular/index.ts',
157+
output: {
158+
file: pkg.exports['./angular'].browser.require,
159+
format: 'cjs',
160+
sourcemap: true
161+
},
162+
plugins: [
163+
typescriptPlugin({
164+
typescript,
165+
tsconfig: 'tsconfig.angular.json'
166+
}),
167+
json()
168+
],
169+
external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
170+
}
171+
];
172+
173+
export default [
174+
...browserBuilds,
175+
...nodeBuilds,
176+
...reactBuilds,
177+
...angularBuilds
178+
];

0 commit comments

Comments
 (0)