Refactor preferences to allow custom defaults and chaining #83
Conversation
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
Codecov ReportAttention: Patch coverage is
✅ All tests successful. No failed tests found.
Additional details and impacted files@@ Coverage Diff @@
## main #83 +/- ##
==========================================
+ Coverage 87.24% 87.38% +0.13%
==========================================
Files 18 20 +2
Lines 894 951 +57
==========================================
+ Hits 780 831 +51
- Misses 98 105 +7
+ Partials 16 15 -1 ☔ View full report in Codecov by Sentry. |
colinodell
commented
Jun 17, 2025
zhammer
reviewed
Jun 17, 2025
pkg/notifier/default.go
Outdated
| userStore user.Store | ||
| transports []Transport | ||
| transports []Transport | ||
| preferences preference.Preferences |
There was a problem hiding this comment.
this is preferences for an individual user?
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.
This PR shifts responsibility for delivery preferences out of the user objects and into a customizeable, chainable system.
Context
Previously, we assumed users should always receive notifications by default unless they explicitly opted-out. This makes sense in most cases, but there may be certain noisy notifications that should instead be opt-in. Ideally we'd have a way for Mailroom to determine whether to deliver based on checking the following things in the following order:
This PR makes that possible.
Changes
Notable changes include:
pkg/notifier/preferencepackage with primitives for defining and checking preferencesuser.PreferenceProvidermailroom.WithDefaultPreferences()function to provide default preferencesuser.PreferenceProviderfirst, falling back to the default preferences if needed'preference.Default([bool])), a custom function, a chain of preference providers, etc.