sevenhill/QSfera
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README.md updated.

Browse Source 
returned value swapped
This commit is contained in:
Roman Perekhod
2023-04-17 16:15:21 +02:00
parent cd59424a16
commit 22f8076a4f
10 changed files with 128 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files
services/notifications/pkg/config/config.go
+1 -1
View File
@@ -28,7 +28,7 @@ type Notifications struct {
Events Events `yaml:"events"`
MachineAuthAPIKey string `yaml:"machine_auth_api_key" env:"OCIS_MACHINE_AUTH_API_KEY;NOTIFICATIONS_MACHINE_AUTH_API_KEY" desc:"Machine auth API key used to validate internal requests necessary to access resources from other services."`
EmailTemplatePath string `yaml:"email_template_path" env:"OCIS_EMAIL_TEMPLATE_PATH;NOTIFICATIONS_EMAIL_TEMPLATE_PATH" desc:"Path to Email notification templates overriding embedded ones."`
TranslationPath string `yaml:"translation_path" env:"NOTIFICATIONS_TRANSLATION_PATH" desc:"(optional) Set this to a path with custom translations to overwrite the builtin translations. See the documentation for more details."`
TranslationPath string `yaml:"translation_path" env:"OCIS_TRANSLATION_PATH,NOTIFICATIONS_TRANSLATION_PATH" desc:"(optional) Set this to a path with custom translations to overwrite the builtin translations. Note that file and folder naming rules apply, see the documentation for more details."`
RevaGateway string `yaml:"reva_gateway" env:"OCIS_REVA_GATEWAY;REVA_GATEWAY" desc:"CS3 gateway used to look up user metadata" deprecationVersion:"3.0" removalVersion:"3.1" deprecationInfo:"REVA_GATEWAY changing name for consistency" deprecationReplacement:"OCIS_REVA_GATEWAY"`
GRPCClientTLS *shared.GRPCClientTLS `yaml:"grpc_client_tls"`
}
services/notifications/pkg/email/email.go
+14 -14
View File
@@ -17,21 +17,21 @@ var (
)
// RenderEmailTemplate renders the email template for a new share
func RenderEmailTemplate(et MessageTemplate, locale string, emailTemplatePath string, translationPath string, vars map[string]interface{}) (string, string, error) {
rawsub := ComposeMessage(et.Subject, locale, translationPath)
func RenderEmailTemplate(mt MessageTemplate, locale string, emailTemplatePath string, translationPath string, vars map[string]interface{}) (string, string, error) {
// translate a message
mt.Subject = ComposeMessage(mt.Subject, locale, translationPath)
mt.Greeting = ComposeMessage(mt.Greeting, locale, translationPath)
mt.MessageBody = ComposeMessage(mt.MessageBody, locale, translationPath)
mt.CallToAction = ComposeMessage(mt.CallToAction, locale, translationPath)
// replace the body email placeholders with the values
subject, err := executeRaw(rawsub, vars)
subject, err := executeRaw(mt.Subject, vars)
if err != nil {
return "", "", err
}
bodyPlaceholders := map[string]interface{}{}
bodyPlaceholders["Greeting"] = ComposeMessage(et.Greeting, locale, translationPath)
bodyPlaceholders["MessageBody"] = ComposeMessage(et.MessageBody, locale, translationPath)
bodyPlaceholders["CallToAction"] = ComposeMessage(et.CallToAction, locale, translationPath)
// replace the body email template placeholders with the translated template
rawBody, err := executeEmailTemplate(emailTemplatePath, et.bodyTemplate, bodyPlaceholders)
rawBody, err := executeEmailTemplate(emailTemplatePath, mt)
if err != nil {
return "", "", err
}
@@ -43,19 +43,19 @@ func RenderEmailTemplate(et MessageTemplate, locale string, emailTemplatePath st
return subject, body, nil
}
func executeEmailTemplate(emailTemplatePath, templateName string, vars map[string]interface{}) (string, error) {
func executeEmailTemplate(emailTemplatePath string, mt MessageTemplate) (string, error) {
var err error
var tpl *template.Template
// try to lookup the files in the filesystem
tpl, err = template.ParseFiles(filepath.Join(emailTemplatePath, templateName))
tpl, err = template.ParseFiles(filepath.Join(emailTemplatePath, mt.bodyTemplate))
if err != nil {
// template has not been found in the fs, or path has not been specified => use embed templates
tpl, err = template.ParseFS(templatesFS, filepath.Join("templates/", templateName))
tpl, err = template.ParseFS(templatesFS, filepath.Join("templates/", mt.bodyTemplate))
if err != nil {
return "", err
}
}
str, err := executeTemplate(tpl, vars)
str, err := executeTemplate(tpl, mt)
if err != nil {
return "", err
}
@@ -70,7 +70,7 @@ func executeRaw(raw string, vars map[string]interface{}) (string, error) {
return executeTemplate(tpl, vars)
}
func executeTemplate(tpl *template.Template, vars map[string]interface{}) (string, error) {
func executeTemplate(tpl *template.Template, vars any) (string, error) {
var writer bytes.Buffer
if err := tpl.Execute(&writer, vars); err != nil {
return "", err
services/notifications/pkg/service/service.go
+1 -5
View File
@@ -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 {
services/notifications/pkg/service/service_test.go
+69 -12
View File
@@ -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{}{}
services/notifications/pkg/service/shares.go
+2 -2
View File
@@ -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"),
services/notifications/pkg/service/spaces.go
+3 -3
View File
@@ -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"),