prefer logging user ids over emails #338
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
lieut-data
commented
Oct 9, 2023
| @@ -339,7 +339,7 @@ func TestSyncUsers(t *testing.T) { | |||
| { | |||
| Name: "SyncUsers: Unable to create the user", | |||
| SetupAPI: func(api *plugintest.API) { | |||
| api.On("LogError", "Unable to create new MM user during sync job", "email", "test@test.com", "error", mock.Anything).Times(1) | |||
| api.On("LogError", "Unable to create new MM user during sync job", "MMUserID", mock.Anything, "TeamsUserID", mock.Anything, "error", mock.Anything).Times(1) | |||
There was a problem hiding this comment.
Note that these API assertions don't actually test anything since we never call api.AssertExpectations(t), but updated for completeness. (I can't add api.AssertExpectations(t) without failing all the tests. Ideally, we transition these away from mocks altogether.)
jespino
reviewed
Oct 9, 2023
server/plugin.go
Outdated
| @@ -502,11 +502,11 @@ func (p *Plugin) syncUsers() { | |||
| Value: "0", | |||
| }} | |||
| if prefErr := p.API.UpdatePreferencesForUser(newUser.Id, preferences); prefErr != nil { | |||
| p.API.LogError("Unable to disable email notifications for new user", "MMUserID", newUser.Id, "error", prefErr.Error()) | |||
| p.API.LogError("Unable to disable email notifications for new user", "MMUserID", mmUser.Id, "TeamsUserID", msUser.ID, "error", prefErr.Error()) | |||
There was a problem hiding this comment.
Is mmUser.Id correct here?, should it be newUser.Id?
There was a problem hiding this comment.
Yes, you're right! I commented that the tests were broken to catch this and failed to do my own due diligence instead :)
jespino
reviewed
Oct 9, 2023
server/plugin.go
Outdated
| } | ||
|
|
||
| if err = p.store.SetUserInfo(newUser.Id, msUser.ID, nil); err != nil { | ||
| p.API.LogError("Unable to set user info during sync user job", "email", msUser.Mail, "error", err.Error()) | ||
| p.API.LogError("Unable to set user info during sync user job", "MMUserID", mmUser.Id, "TeamsUserID", msUser.ID, "error", err.Error()) |
There was a problem hiding this comment.
Same here, it shouldn't be newUser.Id instead of mmUser.Id?
jespino
requested changes
Oct 9, 2023
manojmalik20
approved these changes
Oct 13, 2023
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.
Summary
Prefer logging user ids over emails. For now, we follow the existing convention of naming the fields
TeamsUserIDandMMUserID.Ticket Link
None.