Fix 'user' on batch tag operations when viewed via Audit Logs #506
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
Batch tags are currently always logged as "default user" because this function never receives an implicit User object. It feels unpleasant to add another implicit String parameter, since this means the function is effectively saying to its caller "Hey, do you have a string handy that I can pretend is a username?". It would be nicer if this was passed as a User object. This issue also highlights how easy it is for bugs to creep in with implicit parameters that have default values.
twrichards
approved these changes
Jan 9, 2024
There was a problem hiding this comment.
awesome - thanks for doing this @davidfurey . all the code changes LGTM and I've had a quick look at CODE where you'd already deployed this branch and things seem to look correct (improved) 👏
app/model/AppAudit.scala
Outdated
| @@ -34,15 +34,15 @@ object AppAudit extends Logging { | |||
| } | |||
| } | |||
|
|
|||
| def reindexTags()(implicit username: Option[String] = None): AppAudit = { | |||
| def reindexTags()(implicit username: Option[String]): AppAudit = { | |||
| AppAudit("reindexTags", new DateTime(), username.getOrElse("default user"), "tag reindex started"); | |||
There was a problem hiding this comment.
would unknown be better than default user?
This seems like a better label
twrichards
approved these changes
Jan 9, 2024
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.
What does this change?
Batch tags were always logged as "default user" because a the logging function expected an implicit
Userobject but the caller was expecting to provide an implicitStringusername.This issue highlighted how easy it is for bugs to creep in with implicit parameters that have default values, so I have also removed the default value from all functions that have an
implicit user(name): Option[String]parameter. In doing so I identified a few places where we could be logging username but weren't.The bug report also mentioned duplicated audit log entries. We were logging batch tag operations when the Job was created and when the Step was carried out. I have removed the Step level logging.
Tested in CODE. Old audit entry shows "Default User", newer entry shows david.furey
How to test