feat: allow notification templates to be disabled by default #16093
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
dannykopping
approved these changes
Jan 13, 2025
Comment on lines
3
to
11
| -- Disable 'workspace created' notification by default | ||
| UPDATE notification_templates | ||
| SET enabled_by_default = FALSE | ||
| WHERE id = '281fdf73-c6d6-4cbb-8ff5-888baf8a2fff'; | ||
|
|
||
| -- Disable 'workspace manually updated' notification by default | ||
| UPDATE notification_templates | ||
| SET enabled_by_default = FALSE | ||
| WHERE id = 'd089fe7b-d5c5-4c0c-aaf5-689859f7d392'; |
There was a problem hiding this comment.
Nit: this might've been better suited in its own migration.
Comment on lines
33
to
36
| AND (EXISTS (SELECT 1 | ||
| FROM notification_templates | ||
| WHERE id = NEW.notification_template_id | ||
| AND enabled_by_default = FALSE)) THEN |
There was a problem hiding this comment.
Nit: could this not be an OR on the other branch?
If we're gonna keep this separate branch I'd rather we raised a more specific error since this one is no longer accurate.
Perhaps notification is not enabled covers both.
There was a problem hiding this comment.
Can do!
So make this an OR to the other branch and rename the error message to notification is not enabled?
There was a problem hiding this comment.
Thanks! Yes please, I think that'd be a more precise error message
✔️ PR 16093 Updated successfully.
|
mtojek
approved these changes
Jan 13, 2025
| RAISE EXCEPTION 'cannot enqueue message: user has disabled this notification'; | ||
| END IF; | ||
|
|
||
| -- Fails if the notification template is disabled by default and the |
There was a problem hiding this comment.
pinging @mafredri to review SQL changes
mafredri
reviewed
Jan 13, 2025
Comment on lines
7
to
26
| -- Fail the insertion if one of the following: | ||
| -- * the user has disabled this notification. | ||
| -- * the notification template is disabled by default and hasn't | ||
| -- been explicitly enabled by the user. | ||
| IF EXISTS (SELECT 1 | ||
| FROM notification_preferences | ||
| WHERE disabled = TRUE | ||
| AND user_id = NEW.user_id | ||
| AND notification_template_id = NEW.notification_template_id) | ||
| OR (NOT EXISTS (SELECT 1 | ||
| FROM notification_preferences | ||
| WHERE disabled = FALSE | ||
| AND user_id = NEW.user_id | ||
| AND notification_template_id = NEW.notification_template_id)) | ||
| AND (EXISTS (SELECT 1 | ||
| FROM notification_templates | ||
| WHERE id = NEW.notification_template_id | ||
| AND enabled_by_default = FALSE) ) THEN | ||
| RAISE EXCEPTION 'cannot enqueue message: notification is not enabled'; | ||
| END IF; |
There was a problem hiding this comment.
How about simplifying this with a join instead?
Suggested change
| -- Fail the insertion if one of the following: | |
| -- * the user has disabled this notification. | |
| -- * the notification template is disabled by default and hasn't | |
| -- been explicitly enabled by the user. | |
| IF EXISTS (SELECT 1 | |
| FROM notification_preferences | |
| WHERE disabled = TRUE | |
| AND user_id = NEW.user_id | |
| AND notification_template_id = NEW.notification_template_id) | |
| OR (NOT EXISTS (SELECT 1 | |
| FROM notification_preferences | |
| WHERE disabled = FALSE | |
| AND user_id = NEW.user_id | |
| AND notification_template_id = NEW.notification_template_id)) | |
| AND (EXISTS (SELECT 1 | |
| FROM notification_templates | |
| WHERE id = NEW.notification_template_id | |
| AND enabled_by_default = FALSE) ) THEN | |
| RAISE EXCEPTION 'cannot enqueue message: notification is not enabled'; | |
| END IF; | |
| IF EXISTS ( | |
| SELECT 1 | |
| FROM notification_templates nt | |
| LEFT JOIN notification_preferences np | |
| ON np.notification_template_id = nt.id | |
| AND np.user_id = NEW.user_id | |
| WHERE nt.id = NEW.notification_template_id | |
| AND ( | |
| -- Case 1: The user explicitly disabled this template | |
| np.disabled = TRUE | |
| OR | |
| -- Case 2: Template is disabled by default | |
| -- AND user never explicitly enabled it | |
| (np.notification_template_id IS NULL AND nt.enabled_by_default = FALSE) | |
| ) | |
| ) | |
| THEN | |
| RAISE EXCEPTION 'cannot enqueue message: notification is not enabled'; | |
| END IF; |
I feel this is a bit more readable and concise. What do you think? (PS. Feel free to double check the logic, I actually used ChatGPT to rewrite it.)
There was a problem hiding this comment.
I think I agree with you, this definitely feels easier (at least for me) to read
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.
Change as part of #16071
It has been decided that we want to be able to have some notification templates be disabled by default #16071 (comment).
This adds a new column (
enabled_by_default) tonotification_templatesthat defaults toTRUE. It also modifies theinhibit_enqueue_if_disabledfunction to reject notifications for templates that haveenabled_by_default = FALSEwith the user not explicitly enabling it.