Skip to content

feat: allow notification templates to be disabled by default #16093

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jan 13, 2025
Merged

feat: allow notification templates to be disabled by default #16093

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c4755f4
feat: allow notification templates to be disabled by default
DanielleMaywood Jan 10, 2025
5c3ac59
chore: run 'make gen' and change error message
DanielleMaywood Jan 10, 2025
013a626
chore: add test
DanielleMaywood Jan 10, 2025
fd7ed60
chore: create new migration, refactor inhibit logic, change error mes…
DanielleMaywood Jan 13, 2025
c3f5e2a
Merge branch 'main' into dm-allow-notification-templates-to-be-disabl…
DanielleMaywood Jan 13, 2025
73bc02e
chore: update migration numbers
DanielleMaywood Jan 13, 2025
de41561
chore: run 'make gen'
DanielleMaywood Jan 13, 2025
dd51bd7
chore: refactor sql
DanielleMaywood Jan 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore: add test
  • Loading branch information
@DanielleMaywood
DanielleMaywood committed Jan 10, 2025
commit 013a626fafbff848c5806119edbbcb3c6c16f87c
5 changes: 3 additions & 2 deletions coderd/database/dump.sql
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 13 additions & 2 deletions coderd/database/migrations/000283_allow_disabling_notification_templates_by_default.up.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
ALTER TABLE notification_templates ADD COLUMN enabled_by_default boolean DEFAULT TRUE NOT NULL;

-- 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';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: this might've been better suited in its own migration.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can do! 👍


CREATE OR REPLACE FUNCTION inhibit_enqueue_if_disabled()
RETURNS TRIGGER AS
$$
Expand All @@ -17,13 +27,14 @@ BEGIN
-- user hasn't explicitly enabled it.
IF (NOT EXISTS (SELECT 1
FROM notification_preferences
WHERE user_id = NEW.user_id
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: user has not enabled this notification';
RAISE EXCEPTION 'cannot enqueue message: user has disabled this notification';
END IF;

RETURN NEW;
Expand Down
24 changes: 24 additions & 0 deletions coderd/notifications/notifications_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1438,6 +1438,30 @@ func normalizeGoldenWebhook(content []byte) []byte {
return content
}

func TestDisabledByDefaultBeforeEnqueue(t *testing.T) {
t.Parallel()

if !dbtestutil.WillUsePostgres() {
t.Skip("This test requires postgres; it is testing business-logic implemented in the database")
}

// nolint:gocritic // Unit test.
ctx := dbauthz.AsNotifier(testutil.Context(t, testutil.WaitSuperLong))
store, _ := dbtestutil.NewDB(t)
logger := testutil.Logger(t)

cfg := defaultNotificationsConfig(database.NotificationMethodSmtp)
enq, err := notifications.NewStoreEnqueuer(cfg, store, defaultHelpers(), logger.Named("enqueuer"), quartz.NewReal())
require.NoError(t, err)
user := createSampleUser(t, store)

// We want to try enqueuing a notification on a template that is disabled
// by default. We expect this to fail.
templateID := notifications.TemplateWorkspaceManuallyUpdated
_, err = enq.Enqueue(ctx, user.ID, templateID, map[string]string{}, "test")
require.ErrorIs(t, err, notifications.ErrCannotEnqueueDisabledNotification, "enqueuing did not fail with expected error")
}

// TestDisabledBeforeEnqueue ensures that notifications cannot be enqueued once a user has disabled that notification template
func TestDisabledBeforeEnqueue(t *testing.T) {
t.Parallel()
Expand Down
Loading