package postcard import ( "bytes" "context" "errors" "log/slog" "strings" "testing" "git.golem15.com/golem15/summercms/modules/backpack" ) // errOverrides is an OverrideSource that always fails. type errOverrides struct{ err error } func (e errOverrides) MailOverrides(context.Context, string) (Overrides, error) { return Overrides{}, e.err } func TestOverride(t *testing.T) { t.Parallel() plugin := acmeBlog{} cat := NewCatalog() if err := cat.Register(plugin.ID(), plugin.MailTemplatesFS(), plugin.MailTemplates(), plugin.MailLayouts()); err != nil { t.Fatal(err) } file := fileWelcome(t) cases := []struct { name string ov Overrides subject string wantSub string wantHTML string wantText string }{ { name: "no_row", ov: Overrides{}, wantSub: file.Subject, wantHTML: file.HTML, wantText: file.Text, }, { name: "customized_template", ov: Overrides{Template: &TemplateOverride{ Subject: "Hello {{ .name }}", Body: "Custom **{{ .name }}**", Layout: "acme.blog::mail.layouts.blog", }}, wantSub: "Hello Ada", wantHTML: `

Custom Ada

`, wantText: "Custom **Ada**", }, { name: "caller_subject", ov: Overrides{Template: &TemplateOverride{ Subject: "Overridden subject", Body: "Body for {{ .name }}", Layout: "acme.blog::mail.layouts.blog", }}, subject: "Caller wins", wantSub: "Caller wins", wantHTML: `

Body for Ada

`, }, { name: "customized_layout", ov: Overrides{ Template: &TemplateOverride{Subject: "Welcome, {{ .name }}", Body: "Hi **{{ .name }}**, thanks for joining.", Layout: "acme.blog::mail.layouts.blog"}, Layouts: map[string]LayoutOverride{ "acme.blog::mail.layouts.blog": {HTML: `
{{ .Content }}
`, Text: "{{ .Content }}\n"}, }, }, wantSub: "Welcome, Ada", wantHTML: `

Hi Ada, thanks for joining.

`, }, } for _, tc := range cases { t.Run(tc.name, func(t *testing.T) { drv := NewMemoryDriver() m := NewMailer(cat, drv, Options{Overrides: fakeOverrides{ov: tc.ov}}) sendWelcome(t, m, tc.subject) got := lastMessage(t, drv) if got.Subject != tc.wantSub { t.Fatalf("subject = %q, want %q", got.Subject, tc.wantSub) } if tc.wantHTML != "" && !strings.Contains(got.HTML, tc.wantHTML) { t.Fatalf("HTML = %q, want fragment %q", got.HTML, tc.wantHTML) } if tc.wantText != "" && !strings.Contains(got.Text, tc.wantText) { t.Fatalf("Text = %q, want fragment %q", got.Text, tc.wantText) } }) } t.Run("partial_override", func(t *testing.T) { p := blogPlugin() c := NewCatalog() if err := c.RegisterPartials(p.id, p.fsys, p.partials); err != nil { t.Fatal(err) } if err := c.Register(p.id, p.fsys, p.templates, p.layouts); err != nil { t.Fatal(err) } ov := Overrides{Partials: map[string]PartialOverride{ "acme.blog::mail.partials.note": {HTML: ``, Text: "SIDE: {{ .text }}"}, }} drv := NewMemoryDriver() m := NewMailer(c, drv, Options{Overrides: fakeOverrides{ov: ov}}) got := sendTemplate(t, m, drv, "acme.blog::mail.note", map[string]any{"Text": "hello"}) if !strings.Contains(got.HTML, "") { t.Fatalf("HTML = %q", got.HTML) } if !strings.Contains(got.Text, "SIDE: hello") { t.Fatalf("Text = %q", got.Text) } }) t.Run("database_only_layout", func(t *testing.T) { ov := Overrides{ Template: &TemplateOverride{Subject: "S", Body: "Body", Layout: "promo"}, Layouts: map[string]LayoutOverride{ "promo": {HTML: `{{ .Content }}`, Text: "{{ .Content }}"}, }, } drv := NewMemoryDriver() m := NewMailer(cat, drv, Options{Overrides: fakeOverrides{ov: ov}}) sendWelcome(t, m, "") got := lastMessage(t, drv) if !strings.Contains(got.HTML, "") { t.Fatalf("HTML = %q", got.HTML) } }) } func TestFallback(t *testing.T) { t.Parallel() file := fileWelcome(t) plugin := acmeBlog{} cat := NewCatalog() if err := cat.Register(plugin.ID(), plugin.MailTemplatesFS(), plugin.MailTemplates(), plugin.MailLayouts()); err != nil { t.Fatal(err) } t.Run("render_failure", func(t *testing.T) { assertFileFallback(t, cat, file, Options{Overrides: fakeOverrides{ov: Overrides{Template: &TemplateOverride{ Subject: "Hello {{ .name }}", Body: "Order {{ .order.code }}", Layout: "acme.blog::mail.layouts.blog", }}}}, true) }) t.Run("unsafe_override", func(t *testing.T) { assertFileFallback(t, cat, file, Options{Overrides: fakeOverrides{ov: Overrides{Template: &TemplateOverride{ Subject: "Hello {{ .name }}", Body: "Type javascript: in the address bar.", Layout: "acme.blog::mail.layouts.blog", }}}}, true) }) t.Run("lookup_error", func(t *testing.T) { drv := NewMemoryDriver() var logs bytes.Buffer m := NewMailer(cat, drv, Options{Overrides: errOverrides{err: errors.New("db down")}}) if mm, ok := m.(*mailer); ok { mm.log = slog.New(slog.NewTextHandler(&logs, &slog.HandlerOptions{Level: slog.LevelDebug})) } sendWelcome(t, m, "") got := lastMessage(t, drv) if got.Subject != file.Subject || got.HTML != file.HTML { t.Fatalf("lookup error did not fall back: %+v", got) } if !strings.Contains(logs.String(), "mail overrides unavailable") { t.Fatalf("log = %q", logs.String()) } }) t.Run("no_published_db", func(t *testing.T) { assertFileFallback(t, cat, file, Options{Overrides: NewDBSource(backpack.New(nil))}, false) }) t.Run("unresolved_layout", func(t *testing.T) { drv := NewMemoryDriver() var logs bytes.Buffer m := NewMailer(cat, drv, Options{Overrides: fakeOverrides{ov: Overrides{Template: &TemplateOverride{ Subject: "Welcome, {{ .name }}", Body: "Hi **{{ .name }}**, thanks for joining.", Layout: "gone", }}}}) if mm, ok := m.(*mailer); ok { mm.log = slog.New(slog.NewTextHandler(&logs, &slog.HandlerOptions{Level: slog.LevelDebug})) } sendWelcome(t, m, "") got := lastMessage(t, drv) if len(drv.Messages()) != 1 { t.Fatalf("sent %d messages", len(drv.Messages())) } if !strings.Contains(got.HTML, `

Hi Ada`) { t.Fatalf("HTML = %q, want default layout", got.HTML) } out := logs.String() if !strings.Contains(out, "unknown layout") || !strings.Contains(out, "layout=gone") { t.Fatalf("log = %q, want unknown-layout warning", out) } }) } func assertFileFallback(t *testing.T, cat *Catalog, file RenderedMessage, opts Options, wantLog bool) { t.Helper() drv := NewMemoryDriver() var logs bytes.Buffer m := NewMailer(cat, drv, opts) if mm, ok := m.(*mailer); ok { mm.log = slog.New(slog.NewTextHandler(&logs, &slog.HandlerOptions{Level: slog.LevelDebug})) } sendWelcome(t, m, "") got := lastMessage(t, drv) if len(drv.Messages()) != 1 { t.Fatalf("sent %d messages, want 1", len(drv.Messages())) } if got.Subject != file.Subject || got.HTML != file.HTML || got.Text != file.Text { t.Fatalf("fallback did not send file version:\n got %+v\nwant %+v", got, file) } if !wantLog { return } out := logs.String() if !strings.Contains(out, "postcard: override failed, sending the file version") { t.Fatalf("log = %q, want override-failed error", out) } if !strings.Contains(out, "component=postcard") && !strings.Contains(out, "postcard") { t.Fatalf("log = %q, want postcard component", out) } }