feat(logger): simplify logger API
#2344
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/nextauthjs/next-auth/9REUgGGDfCkWgh9mdGaKguGRpAHu |
github-actions
bot
added
client
These adapter specific errors are now generated on-the-fly.
balazsorban44
changed the title
logger API
Codecov Report
@@ Coverage Diff @@
## next #2344 +/- ##
==========================================
+ Coverage 10.78% 10.89% +0.10%
==========================================
Files 83 83
Lines 1409 1395 -14
Branches 389 389
==========================================
Hits 152 152
+ Misses 1042 1026 -16
- Partials 215 217 +2
Continue to review full report at Codecov.
|
balazsorban44
commented
Jul 10, 2021
This was referenced Nov 9, 2023
mnphpexpert
added a commit
to mnphpexpert/next-auth
that referenced
this pull request
Sep 2, 2024
Similar to nextauthjs#2342, this aims to unify the user-facing API and provide an easier way to extend in the future. In addition, this PR also solves the problem when the `logger.error` method sometimes did not print results, because `Error` instances are not serializable and will be printed as empty objects `"{}"`. After this PR, we make any `Error` instances serializable as described here: https://iaincollins.medium.com/error-handling-in-javascript-a6172ccdf9af Closes nextauthjs#1602 Achieved by adding a `client: true` flag when logs are coming from the frontend. BREAKING CHANGE: The main change is that instead of an unknown number of parameters, the log events have at most two, where the second parameter is usually an object. In the case of the `error` event, it can also be an `Error` instance (that is serializable by `JSON.stringify`). If it is an object, an `Error` instance will be available on `metadata.error`, and `message` will default to `metadata.error.message`. This is done so that an error event always provides some kind of a stack to see where the error happened ```diff // [...nextauth.js] import log from "some-logger-service" ... logger: { - error(code, ...message) {}, + error(code, metadata) {}, - warn(code, ...message) {}, + warn(code) {} - debug(code, ...message) {} + debug(code, metadata) {} } ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Similar to #2342, this aims to unify the user-facing API and provide an easier way to extend in the future.
In addition, this PR also solves the problem when the
logger.errormethod sometimes did not print results, becauseErrorinstances are not serializable and will be printed as empty objects"{}".After this PR, we make any
Errorinstances serializable as described here: https://iaincollins.medium.com/error-handling-in-javascript-a6172ccdf9afCloses #1602
Achieved by adding a
client: trueflag when logs are coming from the frontend.BREAKING CHANGE:
The main change is that instead of an unknown number of parameters, the log events have at most two, where the second parameter is usually an object. In the case of the
errorevent, it can also be anErrorinstance (that is serializable byJSON.stringify). If it is an object, anErrorinstance will be available onmetadata.error, andmessagewill default tometadata.error.message. This is done so that an error event always provides some kind of a stack to see where the error happened// [...nextauth.js] import log from "some-logger-service" ... logger: { - error(code, ...message) {}, + error(code, metadata) {}, - warn(code, ...message) {}, + warn(code) {} - debug(code, ...message) {} + debug(code, metadata) {} }