This repository has been archived by the owner on Nov 1, 2023. It is now read-only.
Update log message to accurately represent action being take #3366
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
Codecov Report
@@ Coverage Diff @@
## main #3366 +/- ##
==========================================
- Coverage 32.33% 31.68% -0.65%
==========================================
Files 275 308 +33
Lines 31995 37628 +5633
==========================================
+ Hits 10344 11923 +1579
- Misses 21651 25705 +4054
|
chkeita
reviewed
Jul 31, 2023
| @@ -89,7 +89,7 @@ public class Events : IEvents { | |||
|
|
|||
| public virtual void LogEvent(BaseEvent anEvent) { | |||
| var serializedEvent = JsonSerializer.Serialize(anEvent, anEvent.GetType(), _options); | |||
| _log.LogInformation("sending event: {EventType} - {serializedEvent}", anEvent.GetEventType(), serializedEvent); | |||
| _log.LogInformation("logging event: {EventType} - {serializedEvent}", anEvent.GetEventType(), serializedEvent); | |||
There was a problem hiding this comment.
That was meant to describe what is happening on line 86.
There was a problem hiding this comment.
Ah I see, I think we could remove LogEvent since it's only used by SendEvent. It'll make things a little clearer
There was a problem hiding this comment.
I agree but I think this function is used elsewhere. If that is the case, I suggest you take the log message string (or just a prefix) as parameter to this function. That wat you keep the intent close to where it is being used.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary of the Pull Request
What is this about?
We log a message "sending event" when we are actually only logging an event.