From a8a926bcf2a2c9e3896de09ab46074d2e6533859 Mon Sep 17 00:00:00 2001 From: Roman Perekhod Date: Mon, 17 Apr 2023 13:46:57 +0200 Subject: [PATCH] README.md updated. returned value swapped --- services/notifications/README.md | 31 ++++++- services/notifications/pkg/service/service.go | 6 +- .../notifications/pkg/service/service_test.go | 81 ++++++++++++++++--- services/notifications/pkg/service/shares.go | 4 +- services/notifications/pkg/service/spaces.go | 6 +- 5 files changed, 104 insertions(+), 24 deletions(-) diff --git a/services/notifications/README.md b/services/notifications/README.md index 700a62b3481..83387c2e536 100644 --- a/services/notifications/README.md +++ b/services/notifications/README.md @@ -2,14 +2,41 @@ The notification service is responsible for sending emails to users informing them about events that happened. To do this it hooks into the event system and listens for certain events that the users need to be informed about. +## Email notification + +The `notifications` service has embedded email body templates. +The email templates contain placeholders `{{ .Greeting }}`, `{{ .MessageBody }}`, `{{ .CallToAction }}` that are +replaced with translations (See [Translations](#translations) in this readme). +These embedded templates are available for all deployment scenarios. In addition, the service supports custom +templates. +The custom email template takes precedence over the embedded one. If a custom email template exists, the embedded ones +are not used. To configure custom email templates, +the `NOTIFICATIONS_EMAIL_TEMPLATE_PATH` environment variable needs to point to a base folder that will contain the email +templates. The source template files provided by ocis are situated +in [https://github.com/owncloud/ocis/tree/master/services/notifications/pkg/email/templates](https://github.com/owncloud/ocis/tree/master/services/notifications/pkg/email/templates) in the `shares` +and `spaces` subfolders. +The custom email templates must be situated in the same subfolder and have the same names as the embedded templates. +``` +templates +│ +└───shares +│ │ shareCreated.email.body.tmpl +│ │ shareExpired.email.body.tmpl +│ +└───spaces + │ membershipExpired.email.body.tmpl + │ sharedSpace.email.body.tmpl + │ unsharedSpace.email.body.tmpl +``` + ## Translations -The `translations` service has embedded translations sourced via transifex to provide a basic set of translated languages. +The `notifications` service has embedded translations sourced via transifex to provide a basic set of translated languages. These embedded translations are available for all deployment scenarios. In addition, the service supports custom translations, though it is currently not possible to just add custom translations to embedded ones. If custom translations are configured, the embedded ones are not used. To configure custom translations, the `NOTIFICATIONS_TRANSLATION_PATH` environment variable needs to point to a base folder that will contain the translation -files. This path must be available from all instances of the translations service, a shared storage is recommended. +files. This path must be available from all instances of the notifications service, a shared storage is recommended. Translation files must be of type [.po](https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html#PO-Files) or [.mo](https://www.gnu.org/software/gettext/manual/html_node/Binaries.html). For each language, the filename needs to be `translations.po` (or `translations.mo`) and stored in a folder structure defining the language code. In general the path/name diff --git a/services/notifications/pkg/service/service.go b/services/notifications/pkg/service/service.go index daf329475a7..714696e720f 100644 --- a/services/notifications/pkg/service/service.go +++ b/services/notifications/pkg/service/service.go @@ -89,11 +89,7 @@ func (s eventsNotifier) Run() error { func (s eventsNotifier) render(template email.MessageTemplate, values map[string]interface{}) (string, string, error) { // The locate have to come from the user setting - sub, msg, err := email.RenderEmailTemplate(template, "en", s.emailTemplatePath, s.translationPath, values) - if err != nil { - return "", "", err - } - return msg, sub, nil + return email.RenderEmailTemplate(template, "en", s.emailTemplatePath, s.translationPath, values) } func (s eventsNotifier) send(ctx context.Context, u *user.UserId, g *group.GroupId, msg, subj, sender string) error { diff --git a/services/notifications/pkg/service/service_test.go b/services/notifications/pkg/service/service_test.go index a9c323473a9..aad56181995 100644 --- a/services/notifications/pkg/service/service_test.go +++ b/services/notifications/pkg/service/service_test.go @@ -66,8 +66,19 @@ var _ = Describe("Notifications", func() { Entry("Share Created", testChannel{ expectedReceipients: map[string]bool{sharee.GetId().GetOpaqueId(): true}, expectedSubject: "Dr. S. Harer shared 'secrets of the board' with you", - expectedSender: sharer.GetDisplayName(), - done: make(chan struct{}), + expectedMessage: `Hello Dr. S. Harer + +Dr. S. Harer has shared "secrets of the board" with you. + +Click here to view it: files/shares/with-me + + +--- +ownCloud - Store. Share. Work. +https://owncloud.com +`, + expectedSender: sharer.GetDisplayName(), + done: make(chan struct{}), }, events.Event{ Event: events.ShareCreated{ Sharer: sharer.GetId(), @@ -80,8 +91,19 @@ var _ = Describe("Notifications", func() { Entry("Share Expired", testChannel{ expectedReceipients: map[string]bool{sharee.GetId().GetOpaqueId(): true}, expectedSubject: "Share to 'secrets of the board' expired at 2023-04-17 16:42:00", - expectedSender: sharer.GetDisplayName(), - done: make(chan struct{}), + expectedMessage: `Hello Dr. S. Harer, + +Your share to secrets of the board has expired at 2023-04-17 16:42:00 + +Even though this share has been revoked you still might have access through other shares and/or space memberships. + + +--- +ownCloud - Store. Share. Work. +https://owncloud.com +`, + expectedSender: sharer.GetDisplayName(), + done: make(chan struct{}), }, events.Event{ Event: events.ShareExpired{ ShareOwner: sharer.GetId(), @@ -94,8 +116,19 @@ var _ = Describe("Notifications", func() { Entry("Added to Space", testChannel{ expectedReceipients: map[string]bool{sharee.GetId().GetOpaqueId(): true}, expectedSubject: "Dr. S. Harer invited you to join secret space", - expectedSender: sharer.GetDisplayName(), - done: make(chan struct{}), + expectedMessage: `Hello Dr. S. Harer, + +Dr. S. Harer has invited you to join "secret space". + +Click here to view it: f/spaceid + + +--- +ownCloud - Store. Share. Work. +https://owncloud.com +`, + expectedSender: sharer.GetDisplayName(), + done: make(chan struct{}), }, events.Event{ Event: events.SpaceShared{ Executant: sharer.GetId(), @@ -108,8 +141,21 @@ var _ = Describe("Notifications", func() { Entry("Removed from Space", testChannel{ expectedReceipients: map[string]bool{sharee.GetId().GetOpaqueId(): true}, expectedSubject: "Dr. S. Harer removed you from secret space", - expectedSender: sharer.GetDisplayName(), - done: make(chan struct{}), + expectedMessage: `Hello Dr. S. Harer, + +Dr. S. Harer has removed you from "secret space". + +You might still have access through your other groups or direct membership. + +Click here to check it: f/spaceid + + +--- +ownCloud - Store. Share. Work. +https://owncloud.com +`, + expectedSender: sharer.GetDisplayName(), + done: make(chan struct{}), }, events.Event{ Event: events.SpaceUnshared{ Executant: sharer.GetId(), @@ -121,8 +167,19 @@ var _ = Describe("Notifications", func() { Entry("Space Expired", testChannel{ expectedReceipients: map[string]bool{sharee.GetId().GetOpaqueId(): true}, expectedSubject: "Membership of 'secret space' expired at 2023-04-17 16:42:00", - expectedSender: sharer.GetDisplayName(), - done: make(chan struct{}), + expectedMessage: `Hello Dr. S. Harer, + +Your membership of space secret space has expired at 2023-04-17 16:42:00 + +Even though this membership has expired you still might have access through other shares and/or space memberships + + +--- +ownCloud - Store. Share. Work. +https://owncloud.com +`, + expectedSender: sharer.GetDisplayName(), + done: make(chan struct{}), }, events.Event{ Event: events.SpaceMembershipExpired{ SpaceOwner: sharer.GetId(), @@ -139,6 +196,7 @@ var _ = Describe("Notifications", func() { type testChannel struct { expectedReceipients map[string]bool expectedSubject string + expectedMessage string expectedSender string done chan struct{} } @@ -150,8 +208,7 @@ func (tc testChannel) SendMessage(ctx context.Context, userIDs []string, msg, su Expect(tc.expectedReceipients[u]).To(Equal(true)) } - // TODO: test the message? - //Expect(msg).To(Equal(tc.expectedMessage)) + Expect(msg).To(Equal(tc.expectedMessage)) Expect(subject).To(Equal(tc.expectedSubject)) Expect(senderDisplayName).To(Equal(tc.expectedSender)) tc.done <- struct{}{} diff --git a/services/notifications/pkg/service/shares.go b/services/notifications/pkg/service/shares.go index 8e54ffb9fb1..6451783bc2f 100644 --- a/services/notifications/pkg/service/shares.go +++ b/services/notifications/pkg/service/shares.go @@ -42,7 +42,7 @@ func (s eventsNotifier) handleShareCreated(e events.ShareCreated) { } sharerDisplayName := owner.GetDisplayName() - msg, subj, err := s.render(email.ShareCreated, map[string]interface{}{ + subj, msg, err := s.render(email.ShareCreated, map[string]interface{}{ "ShareGrantee": shareGrantee, "ShareSharer": sharerDisplayName, "ShareFolder": resourceInfo.Name, @@ -85,7 +85,7 @@ func (s eventsNotifier) handleShareExpired(e events.ShareExpired) { return } - msg, subj, err := s.render(email.ShareExpired, map[string]interface{}{ + subj, msg, err := s.render(email.ShareExpired, map[string]interface{}{ "ShareGrantee": shareGrantee, "ShareFolder": resourceInfo.GetName(), "ExpiredAt": e.ExpiredAt.Format("2006-01-02 15:04:05"), diff --git a/services/notifications/pkg/service/spaces.go b/services/notifications/pkg/service/spaces.go index f07501e6ec8..bf7d7473428 100644 --- a/services/notifications/pkg/service/spaces.go +++ b/services/notifications/pkg/service/spaces.go @@ -55,7 +55,7 @@ func (s eventsNotifier) handleSpaceShared(e events.SpaceShared) { } sharerDisplayName := owner.GetDisplayName() - msg, subj, err := s.render(email.SharedSpace, map[string]interface{}{ + subj, msg, err := s.render(email.SharedSpace, map[string]interface{}{ "SpaceGrantee": spaceGrantee, "SpaceSharer": sharerDisplayName, "SpaceName": resourceInfo.GetSpace().GetName(), @@ -117,7 +117,7 @@ func (s eventsNotifier) handleSpaceUnshared(e events.SpaceUnshared) { } sharerDisplayName := owner.GetDisplayName() - msg, subj, err := s.render(email.UnsharedSpace, map[string]interface{}{ + subj, msg, err := s.render(email.UnsharedSpace, map[string]interface{}{ "SpaceGrantee": spaceGrantee, "SpaceSharer": sharerDisplayName, "SpaceName": resourceInfo.GetSpace().Name, @@ -152,7 +152,7 @@ func (s eventsNotifier) handleSpaceMembershipExpired(e events.SpaceMembershipExp return } - msg, subj, err := s.render(email.MembershipExpired, map[string]interface{}{ + subj, msg, err := s.render(email.MembershipExpired, map[string]interface{}{ "SpaceGrantee": shareGrantee, "SpaceName": e.SpaceName, "ExpiredAt": e.ExpiredAt.Format("2006-01-02 15:04:05"),