feature: extract lumberjack core into an agnostic library #154

NachoVazquez · 2023-05-17T13:39:16Z

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: CONTRIBUTING.md#commit
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Lumberjack is a highly extensible and configurable logging library for Angular.

But why stop there?

What is the new behavior?

@webworker/lumberjack is a framework-agnostic logging library; it powers ngworker/lumberjack and enables the creation of any framework-specific lumberjack implementation like Qwik, Solid, or React.

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

Although nothing changes for @ngworker/lumberjack, this refactoring should introduce a major version.

nx-cloud · 2023-05-17T13:39:18Z

☁️ Nx Cloud Report

Attention: This version of the Nx Cloud GitHub bot will cease to function on July 1st, 2023. An organization admin can update your integration here.

CI is running/has finished running commands for commit 735764c. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 7 targets

Sent with 💌 from NxCloud.

nx-cloud · 2023-08-09T23:52:34Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 91bf803. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 5 targets

Sent with 💌 from NxCloud.

LayZeeDK

Partial review of latest commits.

packages/ngworker/lumberjack/src/lib/formatting/lumberjack-log-formatter.service.ts

packages/webworker/lumberjack/src/lib/formatting/create-lumberjack-log-formatter.ts

LayZeeDK · 2023-08-10T17:51:10Z

packages/webworker/lumberjack/src/lib/formatting/create-lumberjack-log-formatter.ts

+  return {
+    formatLog,
+  };


question: Does it makes sense to return an object? Can't we just return a function?

It does make sense to return just a function. I was returning an object to keep it consistent with the other create* factory functions on the workspace.

If you think is ok to just return a function, I'm happy with that.

These are the two possibilities:

Returning an object

const logFormatter = createLumberjackLogFormatter({ config, getUnixEpochTicks }); const { log, formattedLog } = logFormatter.formatLog(lumberjackLog);

Returning a function

const formatLog = createLumberjackLogFormatter({ config, getUnixEpochTicks }); const { log, formattedLog } = formatLog(lumberjackLog);

LayZeeDK · 2023-08-10T18:07:11Z

packages/ngworker/lumberjack/src/lib/logging/lumberjack.service.ts

@@ -24,7 +25,7 @@ import { LumberjackTimeService } from '../time/lumberjack-time.service';
 * API.
 */
 @Injectable()
-export class LumberjackService<TPayload extends LumberjackLogPayload | void = void> {
+export class LumberjackService<TPayload extends LumberjackLogPayload | void = void> implements Lumberjack<TPayload> {


nit: Can we please find a different name than LumberjackService? See #166 (comment).

In my article about Plugin Architecture I use the terms core system and orchestrator.

Do any of those terms resonate with you?

I'm going with LumberjackOrchestrator. But we can change later.

packages/webworker/lumberjack/src/lib/logging/create-lumberjack.ts

packages/webworker/lumberjack/src/lib/formatting/lumberjack-log-formatter-result.ts

packages/webworker/lumberjack/src/lib/logging/create-lumberjack.ts

packages/webworker/lumberjack/src/lib/logging/lumberjack.ts

packages/webworker/lumberjack/src/lib/logging/create-lumberjack-log-factory.ts

LayZeeDK · 2023-08-10T19:17:25Z

packages/webworker/lumberjack/src/lib/logging/lumberjack-log.builder.ts

+  constructor(
+    level: LumberjackLogLevel,
+    message: string,
+    getUnixEpochTicks: () => number = () => new Date().valueOf()


question: Do we have an integration test that replaces getUnixEpochTicks?

In most tests, we use the fakeTime.getUnixEpochTicks if that's what you were thinking.

LayZeeDK

Request changes

LayZeeDK · 2023-10-29T04:10:21Z

packages/docs/lumberjack-docs-app/docs/community-drivers.md

- [@ngworker/lumberjack-applicationinsights-driver](https://github.com/ngworker/lumberjack-applicationinsights-driver), community log driver using [Azure Application Insights](https://docs.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview) as a log store.
-
-The ngworkers teams offers hosting of a community log driver in the [ngworker GitHub](https://github.com/ngworker) and [@ngworker NPM](https://www.npmjs.com/org/ngworker) organizations.
+The LumberjackJS team offers hosting of a community log driver in the [ngworker GitHub](https://github.com/ngworker) and [@ngworker NPM](https://www.npmjs.com/org/ngworker) organizations.


suggestion: the Lumberjack team (JS is just for getting an npm scope).

Suggested change

The LumberjackJS team offers hosting of a community log driver in the [ngworker GitHub](https://github.com/ngworker) and [@ngworker NPM](https://www.npmjs.com/org/ngworker) organizations.

The Lumberjack team offers hosting of a community log driver in the [ngworker GitHub](https://github.com/ngworker) and [@ngworker NPM](https://www.npmjs.com/org/ngworker) organizations.

LayZeeDK · 2023-10-29T04:11:26Z

packages/docs/lumberjack-docs-app/docs/community-drivers.md

- [@ngworker/lumberjack-applicationinsights-driver](https://github.com/ngworker/lumberjack-applicationinsights-driver), community log driver using [Azure Application Insights](https://docs.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview) as a log store.
-
-The ngworkers teams offers hosting of a community log driver in the [ngworker GitHub](https://github.com/ngworker) and [@ngworker NPM](https://www.npmjs.com/org/ngworker) organizations.
+The LumberjackJS team offers hosting of a community log driver in the [ngworker GitHub](https://github.com/ngworker) and [@ngworker NPM](https://www.npmjs.com/org/ngworker) organizations.


issue: update GitHub and npm organizations

Suggested change

The LumberjackJS team offers hosting of a community log driver in the [ngworker GitHub](https://github.com/ngworker) and [@ngworker NPM](https://www.npmjs.com/org/ngworker) organizations.

The LumberjackJS team offers hosting of a community log driver in the [lumberjackjs GitHub](https://github.com/lumberjackjs) and [@lumberjackjs NPM](https://www.npmjs.com/org/lumberjackjs) organizations.

LayZeeDK · 2023-10-29T04:16:33Z

packages/docs/lumberjack-docs-app/docs/log-drivers/log-drivers.md

-import { LumberjackConsoleDriverModule } from '@ngworker/lumberjack/console-driver';
-import { LumberjackHttpDriverModule } from '@ngworker/lumberjack/http-driver';
+import { LumberjackLevel, LumberjackModule } from '@lumberjackjs/angular';
+import { LumberjackConsoleDriverModule } from '@lumberjackjs/angular/console-driver';


issue: our decision is to not have an Angular-specific console driver package or secondary entry point if possible, that is there will be a @lumberjackjs/core/console-driver package but no Angular console driver package

That is a good catch, but I fear I must do a profound rewrite of the docs. Also, write down the migration guide.

Yeah, I checked, and the docs are in bad shape. I will rewrite them next weekend.

LayZeeDK · 2023-10-29T04:17:32Z

packages/docs/lumberjack-docs-app/docs/log-drivers/log-drivers.md

-import { LumberjackHttpDriverModule } from '@ngworker/lumberjack/http-driver';
+import { LumberjackLevel, LumberjackModule } from '@lumberjackjs/angular';
+import { LumberjackConsoleDriverModule } from '@lumberjackjs/angular/console-driver';
+import { LumberjackHttpDriverModule } from '@lumberjackjs/angular/http-driver';


issue: correct the package name according to our decision

Suggested change

import { LumberjackHttpDriverModule } from '@lumberjackjs/angular/http-driver';

import { LumberjackHttpDriverModule } from '@lumberjackjs/angular-http-driver';

I will rewrite the whole documentation next week.

LayZeeDK · 2023-10-29T04:17:50Z

packages/docs/lumberjack-docs-app/docs/log-drivers/log-drivers.md

-import { provideLumberjackConsoleDriver } from '@ngworker/lumberjack/console-driver';
-import { provideLumberjackHttpDriver, withHttpConfig } from '@ngworker/lumberjack/http-driver';
+import { LumberjackLevel, provideLumberjack } from '@lumberjackjs/angular';
+import { provideLumberjackConsoleDriver } from '@lumberjackjs/angular/console-driver';


issue: our decision is to not have an Angular-specific console driver package or secondary entry point if possible, that is there will be a @lumberjackjs/core/console-driver package but no Angular console driver package

packages/internal/angular/console-driver/test-util/src/lib/spy-console/spy-console.module.ts

packages/internal/angular/console-driver/test-util/src/lib/spy-console/spy-console.service.ts

LayZeeDK · 2023-10-29T04:45:48Z

packages/internal/angular/test-util/src/lib/time/fake-time.service.ts

@@ -1,6 +1,6 @@
 import { Injectable } from '@angular/core';

-import { LumberjackTimeService } from '@ngworker/lumberjack';
+import { LumberjackTimeService } from '@lumberjackjs/angular';


question: where do we place LumberjackTimeService and will it have a different API?

For the agnostic core, I have replaced it with a getUnixEpochTicks function that can be passed to the createLumberjack factory function.

By default it uses the () => new Date().valueof()

This is the complete method signature

export function createLumberjack<TPayload extends LumberjackLogPayload | void = void>({ drivers, config, getUnixEpochTicks = () => new Date().valueOf(), }: LumberjackDependencies<TPayload>): Lumberjack<TPayload>

packages/lumberjackjs/angular/console-driver/src/index.ts

packages/lumberjackjs/angular/http-driver/src/index.ts

…e agnostic one

…lar-http-driver

…angular-http-driver

…lient to use agnostic drivers

… carried createLogBuilderFunction

…ly default" This reverts commit d9720d9.

sonarqubecloud · 2023-11-12T22:47:00Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

98.1% Coverage
0.0% Duplication

LayZeeDK · 2024-01-05T06:20:06Z

See #188

NachoVazquez added enhancement New feature or request lumberjack Applies to issues of the Lumberjack project. v16 This issue will be solve as part of the Lumberjack version 16 labels Jun 3, 2023

NachoVazquez force-pushed the feature/extracting-lumberjack-core branch 3 times, most recently from 49cf544 to 2279cb7 Compare June 9, 2023 12:46

NachoVazquez force-pushed the feature/extracting-lumberjack-core branch from 8d64cb4 to bfc6d1e Compare June 12, 2023 21:27

NachoVazquez force-pushed the main branch 4 times, most recently from 4c908ec to 9df215b Compare June 12, 2023 23:59

NachoVazquez force-pushed the feature/extracting-lumberjack-core branch from bfc6d1e to 2d38dd7 Compare June 13, 2023 20:03

NachoVazquez marked this pull request as ready for review June 13, 2023 22:28

NachoVazquez requested review from LayZeeDK and santoshyadavdev June 13, 2023 22:29

NachoVazquez force-pushed the feature/extracting-lumberjack-core branch from 191c2bd to 2c7f384 Compare August 9, 2023 23:50

LayZeeDK requested changes Aug 10, 2023

View reviewed changes

NachoVazquez mentioned this pull request Sep 9, 2023

feature: extend the Lumberjack service with log level methods #181

Closed

3 tasks

LayZeeDK requested changes Oct 30, 2023

View reviewed changes

NachoVazquez added 9 commits November 11, 2023 19:45

feat: create lumberjack core library

698cd12

chore: move agnostic configuration to core library

98fe461

chore: move more agnostic features to core library

3b38ec8

chore: start moving the api test for the moved files

d505369

chore: move the api-test as needed

5abfbe1

feat: make the core stable

4a11bc7

fix: all imports

16e2b59

chore: add new library for final version

7437417

feat: copy all files to the new library

873b0b3

NachoVazquez added 22 commits November 11, 2023 19:45

fix: bring back the log factory service, this time as a wrapper of th…

d60701a

…e agnostic one

feat: make getUnixEpochTicks optional

52cc398

fix: log builder arguments order to adjust for default getUnixEpochTicks

fabcc5c

refactor: move libraries to the new common scope lumberjackjs

1829440

refactor: move http-driver secondary entrypoint to a new package angu…

1945759

…lar-http-driver

refactor: rename all files from lumberjack-http-driver to lumberjack-…

dd6c53c

…angular-http-driver

feat: move console driver from angular to core

726c906

fix: migration issues

c5e1451

feat: implement provideLumberjackCustomDrivers to allow the angular c…

145df0e

…lient to use agnostic drivers

refactor: rename all references from log driver to driver

3a8e16d

fix: adjust eslint and format

3d6e3a3

fix: migration errors

7a0e6a5

refactor: remove implementation details from public api

f45e413

refactor: replace the concept of LubmerjackLogFactory with individual…

9e61a45

… carried createLogBuilderFunction

refactor: stop using ReturnType<T> to create types for functions returns

a9252c9

refactor: make the log formatter return a function instead of an object

b665fda

refactor: rename LumberjackService to LumberjackOrchestrator

a2a0d06

refactor: adjust grammar of comments/docs

331567e

docs: add nest to the potential list of projects we will support

e683035

docs: adjust community driver team and org name -- pr review suggestions

44c5c82

docs: make partial fixes to the drivers docs

c5a6e05

fix: createLumberjackLogFormatter failing tests

1bd120f

NachoVazquez force-pushed the feature/extracting-lumberjack-core branch from fa79538 to 1bd120f Compare November 11, 2023 22:49

NachoVazquez added 4 commits November 11, 2023 19:59

fix: rename ngworker on paths

d03bf56

feat: make the format function optional in the config and apply default

d9720d9

Revert "feat: make the format function optional in the config and app…

7ebfd25

…ly default" This reverts commit d9720d9.

feat: allow getUnixEpochTicks to be optional

91bf803

LayZeeDK closed this Jan 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: extract lumberjack core into an agnostic library #154

feature: extract lumberjack core into an agnostic library #154

NachoVazquez commented May 17, 2023 •

edited

Loading

nx-cloud bot commented May 17, 2023 •

edited

Loading

nx-cloud bot commented Aug 9, 2023 •

edited

Loading

LayZeeDK left a comment

LayZeeDK Aug 10, 2023

NachoVazquez Aug 15, 2023

NachoVazquez Aug 15, 2023

LayZeeDK Aug 10, 2023

NachoVazquez Aug 15, 2023 •

edited

Loading

NachoVazquez Aug 15, 2023

LayZeeDK Aug 10, 2023

NachoVazquez Aug 15, 2023

LayZeeDK left a comment

LayZeeDK Oct 29, 2023

LayZeeDK Oct 29, 2023

LayZeeDK Oct 29, 2023

NachoVazquez Nov 5, 2023

NachoVazquez Nov 5, 2023

LayZeeDK Oct 29, 2023

NachoVazquez Nov 5, 2023

LayZeeDK Oct 29, 2023

LayZeeDK Oct 29, 2023

NachoVazquez Nov 5, 2023

sonarqubecloud bot commented Nov 12, 2023

LayZeeDK commented Jan 5, 2024

	The LumberjackJS team offers hosting of a community log driver in the [ngworker GitHub](https://github.com/ngworker) and [@ngworker NPM](https://www.npmjs.com/org/ngworker) organizations.
	The Lumberjack team offers hosting of a community log driver in the [ngworker GitHub](https://github.com/ngworker) and [@ngworker NPM](https://www.npmjs.com/org/ngworker) organizations.

	import { LumberjackHttpDriverModule } from '@lumberjackjs/angular/http-driver';
	import { LumberjackHttpDriverModule } from '@lumberjackjs/angular-http-driver';

feature: extract lumberjack core into an agnostic library #154

feature: extract lumberjack core into an agnostic library #154

Conversation

NachoVazquez commented May 17, 2023 • edited Loading

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

nx-cloud bot commented May 17, 2023 • edited Loading

☁️ Nx Cloud Report

nx-cloud bot commented Aug 9, 2023 • edited Loading

☁️ Nx Cloud Report

LayZeeDK left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NachoVazquez Aug 15, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

LayZeeDK left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Nov 12, 2023

LayZeeDK commented Jan 5, 2024

NachoVazquez commented May 17, 2023 •

edited

Loading

nx-cloud bot commented May 17, 2023 •

edited

Loading

nx-cloud bot commented Aug 9, 2023 •

edited

Loading

NachoVazquez Aug 15, 2023 •

edited

Loading