feat(coderd/notifications): improve notification format consistency #14967

SasSwart · 2024-10-03T18:19:15Z

This Pull request addresses the more trivial items in #14893.
These were simple formatting changes that I was able to fix despite limited context.

Some more changes are required for which I will have to dig a bit deeper into how the template contexts are populated. I'm happy to add those to this PR or create a subsequent PR.

github-actions · 2024-10-03T18:19:38Z

All contributors have signed the CLA ✍️ ✅
_{Posted by the CLA Assistant Lite bot.}

SasSwart · 2024-10-03T18:20:04Z

I have read the CLA Document and I hereby sign the CLA

coderd/database/migrations/000261_improve_notification_templates.up.sql

mtojek

I think you need to regenerate the text samples with make update-golden-files, or overwrite default for updateGoldenFiles (false -> true) and rerun test.

Once we have new samples, it will be straightforward to review changes 👍

mafredri · 2024-10-04T10:50:53Z

I think you need to regenerate the text samples with make update-golden-files, or overwrite default for updateGoldenFiles (false -> true) and rerun test.

We should make the test output this hint on error (i.e. change requires to assert and if test failed, show hint). Right now it's only shown when there are missing files.

…e makefile

SasSwart · 2024-10-05T10:17:27Z

I think you need to regenerate the text samples with make update-golden-files, or overwrite default for updateGoldenFiles (false -> true) and rerun test.

I was trying to do this for most of Friday. Turns out that the makefile wasn't actually calling the right test to update these. Firstly because it didn't have a job in the makefile for the notifications package, but also because the test wasn't named correctly.

I've pushed a commit that fixes it. We now have updated testdata, which has shown some issues. I'm working on resolving them. Expect updated queries and rendered testdata soon.

…cation-format

…otification body template

mafredri

Except for missing fmt, these look good to me. Would like to see what @mtojek thinks before merging though.

coderd/notifications/notifications_test.go

mtojek

Definitely better than it is now! Thanks 👍

…cation-information

…otifications

SasSwart · 2024-10-08T13:58:18Z

@mtojek @mafredri

Apologies, but I wasn't happy with the standard of the PR. I reworked it after considering some verbal feedback (thanks @mafredri and @defelmnq).

I also figured out how to deal with the rest of #14893.

Please have another look?

Enough has changed that I would have revoked the initial approvals if I could.
I'd particularly appreciate your thoughts on my changes in functions postUser, postFirstUser and oauthLogin

dannykopping

Noticed a few problems in the rendered templates.
Please go through these closely to make sure they are as you're expecting.

coderd/database/migrations/000262_improve_notification_templates.up.sql

coderd/notifications/testdata/rendered-templates/TemplateUserAccountCreated-body.md.golden

.../notifications/testdata/rendered-templates/TemplateWorkspaceManualBuildFailed-body.md.golden

coderd/notifications/testdata/rendered-templates/TemplateWorkspaceDormant-body.md.golden

…tions

coderd/users.go

…dUser

coderd/database/migrations/000262_improve_notification_templates.down.sql

coderd/notifications/notifications_test.go

coderd/users.go

mtojek · 2024-10-09T12:52:28Z

coderd/notifications/testdata/rendered-templates/TemplateTemplateDeleted-body.md.golden

+The template **bobby-template** was deleted by **rob**.
+
+The template's display name was **Bobby's Template**.


The display name is just a human-readable representation of the template name, so in this case, you don't need to indicate that it is not the real template name.

Just go with:

The template Bobby's Template was deleted by rob.

I wondered about this, but didn't want to assume I could overwrite what was specified.
Will update.

mtojek · 2024-10-09T12:54:17Z

coderd/notifications/testdata/rendered-templates/TemplateUserAccountActivated-body.md.golden

+
+The newly activated account belongs to **william tables** and was activated by **rob**.


Have we considered a bit different phrase?

The account for bobby has been activated by Rob. This account belongs to William Tables.

coderd/notifications/testdata/rendered-templates/TemplateYourAccountSuspended-body.md.golden

mtojek · 2024-10-09T12:58:12Z

coderd/notifications/testdata/rendered-templates/TemplateUserAccountDeleted-body.md.golden

+User account **bobby** has been deleted.
+
+The deleted account belonged to **william tables** and was deleted by **rob**.


Curious, if we can make notifications TemplateUserAccountDeleted, TemplateUserAccountCreated, TemplateUserAccountActivated and TemplateUserAccountSuspended sound more natural?

Any ideas, @dannykopping? Should we involve Christin?

I'd be keen for a professional Wordsmith to have a look if we want.

Agree, we should involve @EdwardAngert.

I think we can do this in a follow-up. Let's get this merged.

dannykopping

LGTM modulo the existing nits.

dannykopping · 2024-10-09T15:45:12Z

coderd/notifications/testdata/rendered-templates/TemplateUserAccountDeleted-body.md.golden

+User account **bobby** has been deleted.
+
+The deleted account belonged to **william tables** and was deleted by **rob**.


Agree, we should involve @EdwardAngert.

dannykopping · 2024-10-09T15:48:33Z

coderd/users.go

@@ -576,11 +589,24 @@ func (api *API) deleteUser(rw http.ResponseWriter, r *http.Request) {
 		return
 	}

+	apiKey := httpmw.APIKey(r)
+
+	accountDeleter, err := api.Database.GetUserByID(ctx, apiKey.UserID)


As a follow-up PR, this feels like something that we should inject into the context.

…cation-format

mafredri

Few minor things but otherwise LGTM.

coderd/notifications/notifications_test.go

mtojek · 2024-10-12T19:21:04Z

Re #14967 (comment):

I wondered about this, but didn't want to assume I could overwrite what was specified.
Will update.

@SasSwart @dannykopping Right now the result looks strange. Please take a look below at the notification I received today, it needs more love. I still don't think we need to refer to the display name specifically.

feat(notifications): Improve notification format consistency

70f3486

github-actions bot assigned SasSwart Oct 3, 2024

cdrcommunity added a commit to coder/cla that referenced this pull request Oct 3, 2024

@SasSwart has signed the CLA in coder/coder#14967

9b0db0a

SasSwart changed the title ~~feat(notifications): Improve notification format consistency~~ feat(notifications): improve notification format consistency Oct 3, 2024

mtojek requested review from mafredri and mtojek October 3, 2024 20:05

SasSwart changed the title ~~feat(notifications): improve notification format consistency~~ feat(migrations): improve notification format consistency Oct 4, 2024

SasSwart marked this pull request as draft October 4, 2024 08:34

mafredri reviewed Oct 4, 2024

View reviewed changes

coderd/database/migrations/000261_improve_notification_templates.up.sql Outdated Show resolved Hide resolved

mtojek reviewed Oct 4, 2024

View reviewed changes

chore(coderd/notifications): regenerate notification testdata from th…

7e31a34

…e makefile

SasSwart changed the title ~~feat(migrations): improve notification format consistency~~ feat(coderd/notifications): improve notification format consistency Oct 5, 2024

SasSwart added 5 commits October 5, 2024 10:22

Merge remote-tracking branch 'origin/main' into jjs/consistent-notifi…

cf3afd4

…cation-format

chore(coderd/database): renumber migration

4b85f2b

chore(coderd/notifications): regenerate testdata

e8ad3ac

fix(coderd/notifications): remove duplicate function signature

2a4d740

chore: remove redundant escaping in migration

e741c43

SasSwart marked this pull request as ready for review October 5, 2024 13:02

chore(coderd/notifications): improve failed test feedback

adffe60

SasSwart mentioned this pull request Oct 6, 2024

Notifications: improve wording #14893

Closed

13 tasks

feat(coderd/database): add new information to the account activated n…

41ed54a

…otification body template

mafredri approved these changes Oct 7, 2024

View reviewed changes

coderd/notifications/notifications_test.go Outdated Show resolved Hide resolved

mtojek approved these changes Oct 7, 2024

View reviewed changes

SasSwart added 3 commits October 8, 2024 07:37

Merge remote-tracking branch 'origin/main' into jjs/additional-notifi…

5541331

…cation-information

chore(coderd/database): rework migration for legibility

fe94f0d

feat(coderd): send newly required information to notification templates

98e7501

feat(coderd/notifications): provide additional context to workspace n…

d8e00c2

…otifications

fix(coderd/notifications): add a missing call to fmt.Sprintf

d6a339f

dannykopping reviewed Oct 8, 2024

View reviewed changes

SasSwart commented Oct 8, 2024

View reviewed changes

coderd/notifications/testdata/rendered-templates/TemplateWorkspaceDormant-body.md.golden Outdated Show resolved Hide resolved

SasSwart added 2 commits October 9, 2024 06:20

fix(coderd/notifications): fix oversights in template migration

920ad31

chore(coderd/provisionerdserver): set the displayname in TestNotifica…

9e938e5

…tions

SasSwart commented Oct 9, 2024

View reviewed changes

coderd/users.go Show resolved Hide resolved

chore(coderd): add more robust testing assertions to TestNotifyDelete…

59e57ac

…dUser

mtojek reviewed Oct 9, 2024

View reviewed changes

mtojek requested review from mtojek, mafredri and dannykopping October 9, 2024 12:59

dannykopping approved these changes Oct 9, 2024

View reviewed changes

SasSwart added 3 commits October 9, 2024 16:00

chore(coderd/notifications): fix migration indentation

c907238

chore(coderd/notifications): regenerate golden files

2493556

Merge remote-tracking branch 'origin/main' into jjs/consistent-notifi…

19dccc8

…cation-format

dannykopping merged commit 9d02269 into main Oct 9, 2024
29 checks passed

dannykopping deleted the jjs/consistent-notification-format branch October 9, 2024 22:31

github-actions bot locked and limited conversation to collaborators Oct 9, 2024

mafredri reviewed Oct 9, 2024

View reviewed changes

coderd/notifications/notifications_test.go Show resolved Hide resolved

coderd/notifications/notifications_test.go Show resolved Hide resolved

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(coderd/notifications): improve notification format consistency #14967

feat(coderd/notifications): improve notification format consistency #14967

SasSwart commented Oct 3, 2024

github-actions bot commented Oct 3, 2024 •

edited

Loading

SasSwart commented Oct 3, 2024

mtojek left a comment

mafredri commented Oct 4, 2024

SasSwart commented Oct 5, 2024

mafredri left a comment

mtojek left a comment

SasSwart commented Oct 8, 2024

dannykopping left a comment

mtojek Oct 9, 2024

SasSwart Oct 9, 2024

mtojek Oct 9, 2024

mtojek Oct 9, 2024

SasSwart Oct 9, 2024

dannykopping Oct 9, 2024

dannykopping Oct 9, 2024

dannykopping left a comment

dannykopping Oct 9, 2024

dannykopping Oct 9, 2024

mafredri left a comment

mtojek commented Oct 12, 2024

		The template bobby-template was deleted by rob.

		The template's display name was Bobby's Template.


		The newly activated account belongs to william tables and was activated by rob.

		User account bobby has been deleted.

		The deleted account belonged to william tables and was deleted by rob.

feat(coderd/notifications): improve notification format consistency #14967

feat(coderd/notifications): improve notification format consistency #14967

Conversation

SasSwart commented Oct 3, 2024

github-actions bot commented Oct 3, 2024 • edited Loading

SasSwart commented Oct 3, 2024

mtojek left a comment

Choose a reason for hiding this comment

mafredri commented Oct 4, 2024

SasSwart commented Oct 5, 2024

mafredri left a comment

Choose a reason for hiding this comment

mtojek left a comment

Choose a reason for hiding this comment

SasSwart commented Oct 8, 2024

dannykopping left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dannykopping left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mafredri left a comment

Choose a reason for hiding this comment

mtojek commented Oct 12, 2024

github-actions bot commented Oct 3, 2024 •

edited

Loading