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
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ libs/common/src/state-migrations @bitwarden/team-platform-dev
libs/platform @bitwarden/team-platform-dev
libs/storage-core @bitwarden/team-platform-dev
libs/logging @bitwarden/team-platform-dev
libs/logging-angular @bitwarden/team-platform-dev
libs/storage-test-utils @bitwarden/team-platform-dev
libs/messaging @bitwarden/team-platform-dev
libs/serialization @bitwarden/team-platform-dev
Expand Down
1 change: 1 addition & 0 deletions jest.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ module.exports = {
"<rootDir>/libs/key-management/jest.config.js",
"<rootDir>/libs/key-management-ui/jest.config.js",
"<rootDir>/libs/logging/jest.config.js",
"<rootDir>/libs/logging-angular/jest.config.js",
"<rootDir>/libs/messaging/jest.config.js",
"<rootDir>/libs/node/jest.config.js",
"<rootDir>/libs/platform/jest.config.js",
Expand Down
26 changes: 26 additions & 0 deletions libs/logging-angular/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# logging-angular

Owned by: platform

Angular wrapper for [`@bitwarden/logging`](../logging/README.md). Provides `FlightRecorderService`, an
`@Injectable` subclass of `FlightRecorder` that wires SDK readiness automatically via
`SdkLoadService.Ready`.

## Usage

```typescript
import { FlightRecorderService } from "@bitwarden/logging-angular";

@Component({
/* ... */
})
export class MyComponent {
private recorder = inject(FlightRecorderService);

async viewEvents() {
const events = await this.recorder.read();
}
}
```

See [`@bitwarden/logging`](../logging/README.md) for the full API surface inherited by this service.
3 changes: 3 additions & 0 deletions libs/logging-angular/eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import baseConfig from "../../eslint.config.mjs";

export default [...baseConfig];
16 changes: 16 additions & 0 deletions libs/logging-angular/jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
const { pathsToModuleNameMapper } = require("ts-jest");

const { compilerOptions } = require("../../tsconfig.base");

const sharedConfig = require("../../libs/shared/jest.config.angular");

/** @type {import('jest').Config} */
module.exports = {
...sharedConfig,
displayName: "logging-angular",
setupFilesAfterEnv: ["<rootDir>/test.setup.ts"],
moduleNameMapper: pathsToModuleNameMapper(compilerOptions?.paths ?? {}, {
prefix: "<rootDir>/../../",
}),
coverageDirectory: "../../coverage/libs/logging-angular",
};
15 changes: 15 additions & 0 deletions libs/logging-angular/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"name": "@bitwarden/logging-angular",
"version": "0.0.1",
"description": "Angular wrapper for @bitwarden/logging",
"private": true,
"type": "commonjs",
"main": "index.js",
"types": "index.d.ts",
"license": "GPL-3.0",
"author": "platform",
"scripts": {
"clean": "rimraf dist",
"build": "tsc --noEmit -p tsconfig.lib.json"
}
}
30 changes: 30 additions & 0 deletions libs/logging-angular/project.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"name": "logging-angular",
"$schema": "../../node_modules/nx/schemas/project-schema.json",
"sourceRoot": "libs/logging-angular/src",
"projectType": "library",
"tags": [],
"targets": {
"build": {
"executor": "nx:run-script",
"dependsOn": [],
"options": {
"script": "build"
}
},
"lint": {
"executor": "@nx/eslint:lint",
"outputs": ["{options.outputFile}"],
"options": {
"lintFilePatterns": ["libs/logging-angular/**/*.ts"]
}
},
"test": {
"executor": "@nx/jest:jest",
"outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
"options": {
"jestConfig": "libs/logging-angular/jest.config.js"
}
}
}
}
17 changes: 17 additions & 0 deletions libs/logging-angular/src/flight-recorder.service.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import { Injectable } from "@angular/core";

import { SdkLoadService } from "@bitwarden/common/platform/abstractions/sdk/sdk-load.service";
import { FlightRecorder } from "@bitwarden/logging";

/**
* Angular wrapper for {@link FlightRecorder}.
*
* Provides the flight recorder as an injectable service, wiring it
* to {@link SdkLoadService.Ready} automatically.
*/
@Injectable({ providedIn: "root" })
export class FlightRecorderService extends FlightRecorder {
constructor() {
super(SdkLoadService.Ready);
}
}
3 changes: 3 additions & 0 deletions libs/logging-angular/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export { FlightRecorderService } from "./flight-recorder.service";
// Re-export types from logging for convenience
export { FlightRecorderEvent } from "@bitwarden/logging";
23 changes: 23 additions & 0 deletions libs/logging-angular/src/logging-angular.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import { TestBed } from "@angular/core/testing";

import { FlightRecorder } from "@bitwarden/logging";

import { FlightRecorderService } from "./index";

describe("FlightRecorderService", () => {
beforeEach(() => {
TestBed.configureTestingModule({});
});

it("is injectable via Angular DI", () => {
expect(TestBed.inject(FlightRecorderService)).toBeInstanceOf(FlightRecorderService);
});

it("is a singleton at the root injector", () => {
expect(TestBed.inject(FlightRecorderService)).toBe(TestBed.inject(FlightRecorderService));
});

it("inherits from FlightRecorder", () => {
expect(TestBed.inject(FlightRecorderService)).toBeInstanceOf(FlightRecorder);
});
});
1 change: 1 addition & 0 deletions libs/logging-angular/test.setup.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
import "@bitwarden/ui-common/setup-jest";
6 changes: 6 additions & 0 deletions libs/logging-angular/tsconfig.eslint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"extends": "../../tsconfig.base.json",
"files": [],
"include": ["src/**/*.ts", "src/**/*.js"],
"exclude": ["**/build", "**/dist"]
}
13 changes: 13 additions & 0 deletions libs/logging-angular/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"extends": "../../tsconfig.base.json",
"files": [],
"include": [],
"references": [
{
"path": "./tsconfig.lib.json"
},
{
"path": "./tsconfig.spec.json"
}
]
}
10 changes: 10 additions & 0 deletions libs/logging-angular/tsconfig.lib.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"outDir": "../../dist/out-tsc",
"declaration": true,
"types": ["node"]
},
"include": ["src/**/*.ts"],
"exclude": ["jest.config.js", "src/**/*.spec.ts"]
}
10 changes: 10 additions & 0 deletions libs/logging-angular/tsconfig.spec.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"outDir": "../../dist/out-tsc",
"module": "commonjs",
"moduleResolution": "node10",
"types": ["jest", "node"]
},
"include": ["jest.config.ts", "src/**/*.test.ts", "src/**/*.spec.ts", "src/**/*.d.ts"]
}
9 changes: 9 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions tsconfig.base.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
"@bitwarden/key-management": ["./libs/key-management/src"],
"@bitwarden/key-management-ui": ["./libs/key-management-ui/src"],
"@bitwarden/logging": ["./libs/logging/src"],
"@bitwarden/logging-angular": ["./libs/logging-angular/src/index.ts"],
"@bitwarden/messaging": ["./libs/messaging/src/index.ts"],
"@bitwarden/node/*": ["./libs/node/src/*"],
"@bitwarden/nx-plugin": ["./libs/nx-plugin/src/index.ts"],
Expand Down
Loading