[SLG-0005]: LogEvent LogHandler API implementation#423
Open
kukushechkin wants to merge 9 commits intomainfrom
Open
[SLG-0005]: LogEvent LogHandler API implementation#423kukushechkin wants to merge 9 commits intomainfrom
kukushechkin wants to merge 9 commits intomainfrom
Conversation
kukushechkin
force-pushed
the
SLG-0005-log-event-LogHandler-API-implementation
branch
from
7ba9aed to
5409b18
Compare
kukushechkin
force-pushed
the
SLG-0005-log-event-LogHandler-API-implementation
branch
from
5c6c628 to
0ea389f
Compare
| #expect(event.source == "OverriddenSource") | ||
| } | ||
|
|
||
| @Test func sourceLazyDerivationDoesNotStoreUntilAccessed() { |
Contributor
There was a problem hiding this comment.
Nit: Maybe I'm reading this wrong, but to me it sounds like we expect it to "store after accessed". But what we test for is more like "sourceLazyDerivationDoesNotStoreEvenAfterAccessed"
Comment on lines
+39
to
+41
| /// When no explicit source was provided at the call site, this is derived lazily from ``file`` | ||
| /// the first time this property is accessed. Handlers that never read this property pay no | ||
| /// allocation cost for source computation. |
Contributor
There was a problem hiding this comment.
Nit: To me, this suggests that it will only be computed on first access. Is there a reason we don't store it in self._source after computing it? Otherwise, maybe the doc should say "[...] this is derived lazily from ``file`` when this property is accessed"?
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Replace the flat-parameter
log(level:message:metadata:source:file:function:line:)method onLogHandlerwithlog(event: LogEvent), enabling forward-compatible evolution of theLogHandlerinterface without breaking existinghandler implementations.
Motivation:
Changes to the
LogHandlerAPI require dance around creating new overloads, deprecating old overloads, which unnecessary bloatsLogHandlerprotocol surface (like happened with the source: parameter). We have upcoming changes that would introduce new capabilities to theLogHandlerprotocol, for example https://forums.swift.org/t/proposal-slg-0003-standardized-error-metadata-via-logger-convenience/84518/35. It makes sense to introduce a single container structure for all the data associated with a log event before introducing any new overloads inLogHandlerprotocol.Modifications:
LogEventis added.LogHandlerprotocol now has an additionallog(event: LogEvent)method.Loggeris calling handler'slog(event: LogEvent)method.Result:
Further changes to the
LogEventwith new information passed from theLoggerto aLogHandlerdoes not require changes in theLogHandlerAPI. As a bonus,LogEventmakessourcea computable variable, improving performance for log handlers who do not need the default source created based on the log file location.