- Notifications
You must be signed in to change notification settings - Fork929
feat(coderd): add company logo when available for email notifications#14935
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes from1 commit
Commits
Show all changes
27 commits Select commitHold shift + click to select a range
a42f108 feat(notifications): add company logo url when available for email no…
defelmnq1fa1271 feat(notifications): adapt tests with new labels
defelmnq2def52e fix: revert changes on generated code version
defelmnq1b1a4c4 feat(notification): move logo_url and app_name logic to helpers funct…
defelmnq779260e chore: remove unused GetLogoURL method from notifications store inter…
defelmnq1e6899f fix: add better context and timeout for db related queries
defelmnqb552267 chore: lint
defelmnq73e07e9 feat(notifications): improve logo_url and app_name fetching moving it…
defelmnq70e23ae feat(notifications): improve logo_url and app_name fetching moving it…
defelmnq2f620c9 feat(notifications): improve logo_url and app_name fetching moving it…
defelmnqfdcdf7b feat(notifications): improve logo_url and app_name fetching moving it…
defelmnq9c6c105 feat(coderd): regenerate golden files
0c131a5 feat(notifications): working on tests for logo and app_name
defelmnq34d6611 feat(notifications): change helpers logic to be defined in the Dispat…
0a9a66a feat(notifications): add golden file for custom appearance
bf558cb feat(notifications): add golden file for custom appearance
a420f37 feat(notifications): work on tests
defelmnq51d8d33 feat(notifications): add golden file for custom appearance
defelmnqd492d09 feat(notifications): add golden file for custom appearance
defelmnq0c9c485 feat(notifications): add comment ent in tests for enterprise feature
defelmnqa6d4a0c feat(coderd): remove unused call
defelmnq4c5cb3d fix(notifications): improve tests and some nit fixes
defelmnqe419431 chore(retry): improve retry policy on fetcher
defelmnqa7fec66 Merge remote-tracking branch 'origin/main' into feat/notif-custom-logo
defelmnq8b766f6 improve errors handling
defelmnq157e086 improve errors handling
defelmnq790ff33 improve errors handling
defelmnqFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
feat(notifications): add golden file for custom appearance
- Loading branch information
Uh oh!
There was an error while loading.Please reload this page.
There are no files selected for viewing
308 changes: 135 additions & 173 deletionscoderd/notifications/notifications_test.go
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1414,7 +1414,7 @@ | ||
| // GIVEN: a notification template which has a method explicitly set | ||
| var ( | ||
| template = notifications.TemplateWorkspaceDormant | ||
| defaultMethod = database.NotificationMethodSmtp | ||
| customMethod = database.NotificationMethodWebhook | ||
| ) | ||
| @@ -1562,7 +1562,7 @@ | ||
| succeeded, failed []string | ||
| } | ||
| func (f *fakeHandler) Dispatcher(helpers template.FuncMap, payload types.MessagePayload, _, _ string) (dispatch.DeliveryFunc, error) { | ||
| return func(_ context.Context, msgID uuid.UUID) (retryable bool, err error) { | ||
| f.mu.Lock() | ||
| defer f.mu.Unlock() | ||
| @@ -1612,7 +1612,7 @@ | ||
| return messages, err | ||
| } | ||
| funcTestNotificationTemplates_GoldenWithCustomAppearance(t *testing.T) { | ||
| t.Parallel() | ||
| if !dbtestutil.WillUsePostgres() { | ||
| @@ -1629,205 +1629,167 @@ | ||
| hint = "run \"DB=ci make update-golden-files\" and commit the changes" | ||
| ) | ||
| var ( | ||
| payload = types.MessagePayload{ | ||
| Labels: map[string]string{ | ||
| "name": "bobby-workspace", | ||
| "reason": "autodeleted due to dormancy", | ||
| "initiator": "autobuild", | ||
| }, | ||
| } | ||
| ) | ||
| // Spin up the DB | ||
| db, logger, user := func() (database.Store, *slog.Logger, *codersdk.User) { | ||
| adminClient, _, api := coderdtest.NewWithAPI(t, nil) | ||
| firstUser:=coderdtest.CreateFirstUser(t, adminClient) | ||
| _, user := coderdtest.CreateAnotherUserMutators( | ||
| t, | ||
| adminClient, | ||
| firstUser.OrganizationID, | ||
| []rbac.RoleIdentifier{rbac.RoleUserAdmin()}, | ||
| func(r *codersdk.CreateUserRequestWithOrgs) { | ||
| r.Username = "bobby" | ||
| r.Email = "bobby@coder.com" | ||
| r.Name = "Bobby" | ||
| }, | ||
| ) | ||
| return api.Database, &api.Logger, &user | ||
| }() | ||
defelmnq marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| // nolint:gocritic // Unit test. | ||
| ctx := dbauthz.AsSystemRestricted(testutil.Context(t, testutil.WaitSuperLong)) | ||
| err := db.UpsertApplicationName(ctx, "CustomApplication") | ||
defelmnq marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| require.NoError(t,err) | ||
| err = db.UpsertLogoURL(ctx, "https://custom.application") | ||
defelmnq marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| require.NoError(t, err) | ||
| // smtp config shared between client and server | ||
| smtpConfig := codersdk.NotificationsEmailConfig{ | ||
| Hello: hello, | ||
| From: from, | ||
| Auth: codersdk.NotificationsEmailAuthConfig{ | ||
| Username: username, | ||
| Password: password, | ||
| }, | ||
| } | ||
| // Spin up the mock SMTP server | ||
| backend := smtptest.NewBackend(smtptest.Config{ | ||
| AuthMechanisms: []string{sasl.Login}, | ||
| AcceptedIdentity: smtpConfig.Auth.Identity.String(), | ||
| AcceptedUsername: username, | ||
| AcceptedPassword: password, | ||
| }) | ||
| // Create a mock SMTP server which conditionally listens for plain or TLS connections. | ||
| srv, listen, err := smtptest.CreateMockSMTPServer(backend, false) | ||
| require.NoError(t, err) | ||
| t.Cleanup(func() { | ||
| err := srv.Shutdown(ctx) | ||
| require.NoError(t, err) | ||
| }) | ||
| var hp serpent.HostPort | ||
| require.NoError(t, hp.Set(listen.Addr().String())) | ||
| smtpConfig.Smarthost = hp | ||
| // Start mock SMTP server in the background. | ||
| var wg sync.WaitGroup | ||
| wg.Add(1) | ||
| go func() { | ||
| defer wg.Done() | ||
| assert.NoError(t, srv.Serve(listen)) | ||
| }() | ||
| // Wait for the server to become pingable. | ||
| require.Eventually(t, func() bool { | ||
| cl, err := smtptest.PingClient(listen, false, smtpConfig.TLS.StartTLS.Value()) | ||
| if err != nil { | ||
| t.Logf("smtp not yet dialable: %s", err) | ||
| return false | ||
| } | ||
| if err = cl.Noop(); err != nil { | ||
| t.Logf("smtp not yet noopable: %s", err) | ||
| return false | ||
| } | ||
| if err = cl.Close(); err != nil { | ||
| t.Logf("smtp didn't close properly: %s", err) | ||
| return false | ||
| } | ||
| return true | ||
| }, testutil.WaitShort, testutil.IntervalFast) | ||
| smtpCfg := defaultNotificationsConfig(database.NotificationMethodSmtp) | ||
| smtpCfg.SMTP = smtpConfig | ||
| smtpManager, err := notifications.NewManager( | ||
| smtpCfg, | ||
| db, | ||
| defaultHelpers(), | ||
| createMetrics(), | ||
| logger.Named("manager"), | ||
| ) | ||
| require.NoError(t, err) | ||
| smtpManager.Run(ctx) | ||
| notificationCfg := defaultNotificationsConfig(database.NotificationMethodSmtp) | ||
| smtpEnqueuer, err := notifications.NewStoreEnqueuer( | ||
| notificationCfg, | ||
| db, | ||
| defaultHelpers(), | ||
| logger.Named("enqueuer"), | ||
| quartz.NewReal(), | ||
| ) | ||
| require.NoError(t, err) | ||
| _, err = smtpEnqueuer.EnqueueWithData( | ||
| ctx, | ||
| user.ID, | ||
| notifications.TemplateWorkspaceDeleted, | ||
| payload.Labels, | ||
| payload.Data, | ||
| user.Username, | ||
| user.ID, | ||
| ) | ||
| require.NoError(t, err) | ||
| // Wait for the message to be fetched | ||
| var msg *smtptest.Message | ||
| require.Eventually(t, func() bool { | ||
| msg = backend.LastMessage() | ||
| return msg != nil && len(msg.Contents) > 0 | ||
| }, testutil.WaitShort, testutil.IntervalFast) | ||
| body := normalizeGoldenEmail([]byte(msg.Contents)) | ||
| err = smtpManager.Stop(ctx) | ||
| require.NoError(t, err) | ||
| goldenFile := filepath.Join("testdata", "rendered-templates", "smtp", "TemplateWorkspaceDeleted_WithCustomAppearance.html.golden") | ||
defelmnq marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| if *updateGoldenFiles { | ||
| err = os.MkdirAll(filepath.Dir(goldenFile), 0o755) | ||
| require.NoError(t, err, "want no error creating golden file directory") | ||
| err = os.WriteFile(goldenFile, body, 0o600) | ||
| require.NoError(t, err, "want no error writing body golden file") | ||
| } | ||
| wantBody, err := os.ReadFile(goldenFile) | ||
| require.NoError(t, err, fmt.Sprintf("missing golden notification body file. %s", hint)) | ||
| require.Empty( | ||
| t, | ||
| cmp.Diff(wantBody, body), | ||
| fmt.Sprintf("golden file mismatch: %s. If this is expected, %s. (-want +got). ", goldenFile, hint), | ||
| ) | ||
| } | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.