msg is a reserved property name in Chronicles
#321
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
Every Chronicles log record has an existing `msg` property matching the static string supplied in the log statement. Thus, it's currently not possible to use `msg` as the name of a user property: status-im/nim-chronicles#86
dryajov
reviewed
Aug 7, 2020
| @@ -132,7 +132,7 @@ proc send*( | |||
| timeout: Duration = DefaultSendTimeout) {.async.} = | |||
| logScope: | |||
| peer = p.id | |||
| msg = shortLog(msg) | |||
| rpcMsg = shortLog(msg) | |||
There was a problem hiding this comment.
I believe there might be many places in the codebase where msg is used... it's not an issue to change those, but it seems like a very big pitfall to have a reserved word in chronicles and not warn about it when used as a field, imo chronicles should warn about it.
There was a problem hiding this comment.
myeah, half of our code deals withmsg:s, sad to not be able to use it
There was a problem hiding this comment.
This PR fixes a problem which we currently have, nim-libp2p producing incorrect json log lines.
|
ok, merging... not something to bikeshed right now. |
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.
Every Chronicles log record has an existing
msgproperty matchingthe static string supplied in the log statement. Thus, it's currently
not possible to use
msgas the name of a user property:status-im/nim-chronicles#86