Skip to content

armgit / posta

Public Imported from GitHub
0

Self-hosted email delivery platform that enables applications to send emails via HTTP APIs while handling SMTP delivery, templates, storage, security, and analytics. Fully self-hostable alternative to services like SendGrid or Mailgun.

6.7 KB
Raw Blame
// Copyright (c) 2026 Jonas Kaninda.
//
// This file is part of Posta.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
//
// SPDX-License-Identifier: AGPL-3.0-or-later

package worker

import (
	"strings"
	"testing"

	"github.com/goposta/posta/internal/models"
	"github.com/goposta/posta/internal/services/messages"
)

func TestShouldNotify(t *testing.T) {
	cases := []struct {
		name   string
		form   models.Form
		status models.MessageStatus
		want   bool
	}{
		{
			"received with immediate notify",
			models.Form{NotifyEnabled: true, NotifyMode: models.NotifyModeImmediate, NotifyOnFlagged: true},
			models.MessageStatusReceived, true,
		},
		{
			"notify disabled",
			models.Form{NotifyEnabled: false, NotifyMode: models.NotifyModeImmediate},
			models.MessageStatusReceived, false,
		},
		{
			"digest mode defers to the cron job",
			models.Form{NotifyEnabled: true, NotifyMode: models.NotifyModeHourly},
			models.MessageStatusReceived, false,
		},
		{
			"quarantined never notifies",
			models.Form{NotifyEnabled: true, NotifyMode: models.NotifyModeImmediate, NotifyOnFlagged: true},
			models.MessageStatusQuarantined, false,
		},
		{
			"flagged notifies when opted in",
			models.Form{NotifyEnabled: true, NotifyMode: models.NotifyModeImmediate, NotifyOnFlagged: true},
			models.MessageStatusFlagged, true,
		},
		{
			"flagged skipped when opted out",
			models.Form{NotifyEnabled: true, NotifyMode: models.NotifyModeImmediate, NotifyOnFlagged: false},
			models.MessageStatusFlagged, false,
		},
	}

	h := &MessageProcessHandler{}
	for _, tc := range cases {
		t.Run(tc.name, func(t *testing.T) {
			msg := &models.Message{Status: tc.status}
			form := tc.form
			if got := h.shouldNotify(msg, &form); got != tc.want {
				t.Fatalf("shouldNotify = %v, want %v", got, tc.want)
			}
		})
	}
}

func TestNotifiableFieldsSender(t *testing.T) {
	cases := []struct {
		msg  models.Message
		want string
	}{
		{models.Message{SenderName: "Ada", SenderEmail: "[email protected]"}, "Ada <[email protected]>"},
		{models.Message{SenderEmail: "[email protected]"}, "[email protected]"},
		{models.Message{SenderName: "Ada"}, "Ada"},
		{models.Message{}, "unknown sender"},
	}
	for _, tc := range cases {
		msg := tc.msg
		if got := notifiableFields(&msg, nil, messages.NewPIIMask(nil))[0].Value; got != tc.want {
			t.Fatalf("From for %+v = %q, want %q", tc.msg, got, tc.want)
		}
	}
}

// Answers to personal-data questions never reach a notification email, and
// neither do the summary values they fill.
func TestNotifiableFieldsHidesPII(t *testing.T) {
	mask := messages.NewPIIMask(models.FieldDefs{
		{Key: "work_email", Type: models.FieldEmail, Role: models.RoleSenderEmail, PII: true},
		{Key: "mobile", Type: models.FieldPhone, Role: models.RoleSenderPhone, PII: true},
		{Key: "salary", Type: models.FieldNumber, PII: true},
		{Key: "dept", Type: models.FieldText},
	})
	msg := &models.Message{SenderName: "Ada", SenderEmail: "[email protected]", SenderPhone: "+1 555 010 9999", Subject: "Hi"}
	fields := []models.MessageField{
		{Key: "work_email", Value: "[email protected]"},
		{Key: "mobile", Value: "+1 555 010 9999"},
		{Key: "salary", Value: "90000"},
		{Key: "dept", Value: "sales"},
	}
	got := map[string]string{}
	for _, f := range notifiableFields(msg, fields, mask) {
		got[f.Key] = f.Value
		if strings.Contains(f.Value, "[email protected]") || strings.Contains(f.Value, "555") || f.Value == "90000" {
			t.Errorf("%s leaks %q", f.Key, f.Value)
		}
	}
	if got["From"] != "Ada (email hidden)" || got["salary"] != messages.HiddenValue || got["Phone"] != messages.HiddenValue {
		t.Errorf("unexpected masking: %+v", got)
	}
	if got["dept"] != "sales" || got["Subject"] != "Hi" {
		t.Errorf("visible answers were hidden: %+v", got)
	}
}

func TestNotifiableFieldsDropsBodyAndCaps(t *testing.T) {
	msg := &models.Message{SenderEmail: "[email protected]", Subject: "Hi"}
	fields := []models.MessageField{{Key: "message", Value: "long body"}, {Key: "company", Value: "Acme"}}
	for i := 0; i < 20; i++ {
		fields = append(fields, models.MessageField{Key: "extra", Value: "x"})
	}

	got := notifiableFields(msg, fields, messages.NewPIIMask(nil))
	if len(got) > 12 {
		t.Fatalf("got %d fields, want at most 12", len(got))
	}
	for _, f := range got {
		if f.Key == "message" {
			t.Fatal("the body field must not be duplicated into the field table")
		}
	}
	if got[0].Key != "From" || got[1].Key != "Subject" {
		t.Fatalf("unexpected leading fields: %+v", got[:2])
	}
}

func TestMessageIsSpam(t *testing.T) {
	cases := map[models.MessageStatus]bool{
		models.MessageStatusReceived:    false,
		models.MessageStatusFlagged:     false,
		models.MessageStatusQuarantined: true,
		models.MessageStatusRejected:    true,
	}
	for status, want := range cases {
		msg := models.Message{Status: status}
		if got := msg.IsSpam(); got != want {
			t.Fatalf("IsSpam(%s) = %v, want %v", status, got, want)
		}
	}
}

func TestNotifiableFieldsIncludesPhoneAndDropsSummarizedAliases(t *testing.T) {
	msg := &models.Message{
		SenderName:  "Ada",
		SenderEmail: "[email protected]",
		SenderPhone: "+1 555 010 9999",
		Subject:     "Hi",
	}
	fields := []models.MessageField{
		{Key: "name", Value: "Ada"},
		{Key: "email", Value: "[email protected]"},
		{Key: "phone", Value: "+1 555 010 9999"},
		{Key: "subject", Value: "Hi"},
		{Key: "message", Value: "long body"},
		{Key: "company", Value: "Acme"},
	}

	got := notifiableFields(msg, fields, messages.NewPIIMask(nil))

	keys := make([]string, 0, len(got))
	for _, f := range got {
		keys = append(keys, f.Key)
	}
	want := []string{"From", "Phone", "Subject", "company"}
	if len(keys) != len(want) {
		t.Fatalf("keys = %v, want %v", keys, want)
	}
	for i := range want {
		if keys[i] != want[i] {
			t.Fatalf("keys = %v, want %v", keys, want)
		}
	}
	if got[1].Value != "+1 555 010 9999" {
		t.Fatalf("phone value = %q", got[1].Value)
	}
}

func TestNotifiableFieldsOmitsPhoneRowWhenAbsent(t *testing.T) {
	msg := &models.Message{SenderEmail: "[email protected]", Subject: "Hi"}
	for _, f := range notifiableFields(msg, nil, messages.NewPIIMask(nil)) {
		if f.Key == "Phone" {
			t.Fatal("a Phone row should not appear when no phone was submitted")
		}
	}
}