feat(store): publisher flag on members and the publishers post policy
- members.publisher column, added to old databases by an additive migration - Member.Publisher, SetPublisher (ErrNotFound for a non-member) and IsPublisher - a publisher disabled by bounces is still a publisher - AddMember keeps the publisher flag of an existing member - SetPolicies accepts the publishers post policy
This commit is contained in:
parent
e772777a2a
commit
5bed75864f
2 changed files with 158 additions and 6 deletions
126
internal/store/publisher_test.go
Normal file
126
internal/store/publisher_test.go
Normal file
|
|
@ -0,0 +1,126 @@
|
||||||
|
package store
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestANewMemberIsNotAPublisher(t *testing.T) {
|
||||||
|
s := newTestStore(t)
|
||||||
|
l, _ := s.CreateList("news", "example.org", "News")
|
||||||
|
s.AddMember(l.ID, "a@x.com", "")
|
||||||
|
ms, _ := s.Members(l.ID)
|
||||||
|
if len(ms) != 1 || ms[0].Publisher {
|
||||||
|
t.Fatalf("members: %+v", ms)
|
||||||
|
}
|
||||||
|
if ok, err := s.IsPublisher(l.ID, "a@x.com"); ok || err != nil {
|
||||||
|
t.Fatalf("IsPublisher: %v %v", ok, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetPublisherPromotesAndDemotes(t *testing.T) {
|
||||||
|
s := newTestStore(t)
|
||||||
|
l, _ := s.CreateList("news", "example.org", "News")
|
||||||
|
s.AddMember(l.ID, "a@x.com", "")
|
||||||
|
s.AddMember(l.ID, "b@x.com", "")
|
||||||
|
if err := s.SetPublisher(l.ID, "A@X.com", true); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if ok, err := s.IsPublisher(l.ID, "a@X.COM"); !ok || err != nil {
|
||||||
|
t.Fatalf("promoted: %v %v", ok, err)
|
||||||
|
}
|
||||||
|
if ok, _ := s.IsPublisher(l.ID, "b@x.com"); ok {
|
||||||
|
t.Fatal("only a is a publisher")
|
||||||
|
}
|
||||||
|
ms, _ := s.Members(l.ID)
|
||||||
|
if !ms[0].Publisher || ms[1].Publisher {
|
||||||
|
t.Fatalf("members: %+v", ms)
|
||||||
|
}
|
||||||
|
if m, _ := s.MemberByID(ms[0].ID); !m.Publisher {
|
||||||
|
t.Fatalf("by id: %+v", m)
|
||||||
|
}
|
||||||
|
if err := s.SetPublisher(l.ID, "a@x.com", false); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if ok, _ := s.IsPublisher(l.ID, "a@x.com"); ok {
|
||||||
|
t.Fatal("demoted")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetPublisherOfANonMemberIsNotFound(t *testing.T) {
|
||||||
|
s := newTestStore(t)
|
||||||
|
l, _ := s.CreateList("news", "example.org", "News")
|
||||||
|
other, _ := s.CreateList("dev", "example.org", "Dev")
|
||||||
|
s.AddMember(other.ID, "a@x.com", "")
|
||||||
|
if err := s.SetPublisher(l.ID, "a@x.com", true); !errors.Is(err, ErrNotFound) {
|
||||||
|
t.Fatalf("want ErrNotFound, got %v", err)
|
||||||
|
}
|
||||||
|
if ok, _ := s.IsPublisher(other.ID, "a@x.com"); ok {
|
||||||
|
t.Fatal("the flag is per list")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAPublisherDisabledByBouncesIsStillAPublisher(t *testing.T) {
|
||||||
|
s := newTestStore(t)
|
||||||
|
l, _ := s.CreateList("news", "example.org", "News")
|
||||||
|
s.AddMember(l.ID, "a@x.com", "")
|
||||||
|
s.SetPublisher(l.ID, "a@x.com", true)
|
||||||
|
ms, _ := s.Members(l.ID)
|
||||||
|
for i := 0; i < BounceThreshold; i++ {
|
||||||
|
s.RecordHardBounce(ms[0].ID, BounceThreshold)
|
||||||
|
}
|
||||||
|
if m, _ := s.MemberByID(ms[0].ID); !m.Disabled {
|
||||||
|
t.Fatal("setup: the member is disabled")
|
||||||
|
}
|
||||||
|
if ok, err := s.IsPublisher(l.ID, "a@x.com"); !ok || err != nil {
|
||||||
|
t.Fatalf("still a publisher: %v %v", ok, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestReAddingAMemberKeepsThePublisherFlag(t *testing.T) {
|
||||||
|
s := newTestStore(t)
|
||||||
|
l, _ := s.CreateList("news", "example.org", "News")
|
||||||
|
s.AddMember(l.ID, "a@x.com", "")
|
||||||
|
s.SetPublisher(l.ID, "a@x.com", true)
|
||||||
|
if err := s.AddMember(l.ID, "a@x.com", "Alice"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
ms, _ := s.Members(l.ID)
|
||||||
|
if len(ms) != 1 || !ms[0].Publisher || ms[0].DisplayName != "Alice" {
|
||||||
|
t.Fatalf("members: %+v", ms)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPublishersIsAPostPolicy(t *testing.T) {
|
||||||
|
s := newTestStore(t)
|
||||||
|
l, _ := s.CreateList("news", "example.org", "News")
|
||||||
|
if err := s.SetPolicies(l.ID, PostPublishers, JoinOpen, ArchivePublic); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if got, _ := s.GetList(l.ID); got.PostPolicy != "publishers" {
|
||||||
|
t.Fatalf("policy: %+v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMigrationAddsThePublisherColumn(t *testing.T) {
|
||||||
|
path := t.TempDir() + "/old.db"
|
||||||
|
s, _ := Open(path)
|
||||||
|
l, _ := s.CreateList("news", "example.org", "News")
|
||||||
|
s.AddMember(l.ID, "a@x.com", "A")
|
||||||
|
if _, err := s.db.Exec(`ALTER TABLE members DROP COLUMN publisher`); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
s.Close()
|
||||||
|
s2, err := Open(path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("migrate: %v", err)
|
||||||
|
}
|
||||||
|
defer s2.Close()
|
||||||
|
ms, err := s2.Members(l.ID)
|
||||||
|
if err != nil || len(ms) != 1 || ms[0].Address != "a@x.com" || ms[0].Publisher {
|
||||||
|
t.Fatalf("an old member survives and is not a publisher: %+v %v", ms, err)
|
||||||
|
}
|
||||||
|
if err := s2.SetPublisher(l.ID, "a@x.com", true); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -102,6 +102,7 @@ type Member struct {
|
||||||
DisplayName string
|
DisplayName string
|
||||||
Disabled bool // too many hard bounces: no more delivery
|
Disabled bool // too many hard bounces: no more delivery
|
||||||
BounceCount int
|
BounceCount int
|
||||||
|
Publisher bool // may post to a list whose post policy is PostPublishers
|
||||||
}
|
}
|
||||||
|
|
||||||
// Held is a message waiting for moderation.
|
// Held is a message waiting for moderation.
|
||||||
|
|
@ -153,6 +154,7 @@ CREATE TABLE IF NOT EXISTS members (
|
||||||
disabled INTEGER NOT NULL DEFAULT 0,
|
disabled INTEGER NOT NULL DEFAULT 0,
|
||||||
bounce_count INTEGER NOT NULL DEFAULT 0,
|
bounce_count INTEGER NOT NULL DEFAULT 0,
|
||||||
bounce_at INTEGER NOT NULL DEFAULT 0,
|
bounce_at INTEGER NOT NULL DEFAULT 0,
|
||||||
|
publisher INTEGER NOT NULL DEFAULT 0,
|
||||||
UNIQUE(list_id, address)
|
UNIQUE(list_id, address)
|
||||||
);
|
);
|
||||||
CREATE TABLE IF NOT EXISTS held (
|
CREATE TABLE IF NOT EXISTS held (
|
||||||
|
|
@ -293,6 +295,11 @@ func migrate(db *sql.DB) error {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if has, _ := hasColumn(db, "members", "publisher"); !has {
|
||||||
|
if _, err := db.Exec(`ALTER TABLE members ADD COLUMN publisher INTEGER NOT NULL DEFAULT 0`); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
if ok, err := hasColumn(db, "outbox", "msg_id"); err != nil {
|
if ok, err := hasColumn(db, "outbox", "msg_id"); err != nil {
|
||||||
return err
|
return err
|
||||||
|
|
@ -492,7 +499,7 @@ func (s *Store) UpdateList(id int64, title string) error {
|
||||||
|
|
||||||
// SetPolicies changes the post, join and archive policies of a list.
|
// SetPolicies changes the post, join and archive policies of a list.
|
||||||
func (s *Store) SetPolicies(id int64, post, join, archive string) error {
|
func (s *Store) SetPolicies(id int64, post, join, archive string) error {
|
||||||
if post != PostMembers && post != PostModerated {
|
if post != PostMembers && post != PostModerated && post != PostPublishers {
|
||||||
return fmt.Errorf("invalid post policy %q", post)
|
return fmt.Errorf("invalid post policy %q", post)
|
||||||
}
|
}
|
||||||
if join != JoinOpen && join != JoinClosed {
|
if join != JoinOpen && join != JoinClosed {
|
||||||
|
|
@ -511,21 +518,22 @@ func (s *Store) DeleteList(id int64) error {
|
||||||
|
|
||||||
// Members.
|
// Members.
|
||||||
|
|
||||||
const memberCols = `id, list_id, address, display_name, disabled, bounce_count`
|
const memberCols = `id, list_id, address, display_name, disabled, bounce_count, publisher`
|
||||||
|
|
||||||
func scanMember(row interface{ Scan(...any) error }) (Member, error) {
|
func scanMember(row interface{ Scan(...any) error }) (Member, error) {
|
||||||
var m Member
|
var m Member
|
||||||
var dis int
|
var dis, pub int
|
||||||
err := row.Scan(&m.ID, &m.ListID, &m.Address, &m.DisplayName, &dis, &m.BounceCount)
|
err := row.Scan(&m.ID, &m.ListID, &m.Address, &m.DisplayName, &dis, &m.BounceCount, &pub)
|
||||||
if errors.Is(err, sql.ErrNoRows) {
|
if errors.Is(err, sql.ErrNoRows) {
|
||||||
return Member{}, ErrNotFound
|
return Member{}, ErrNotFound
|
||||||
}
|
}
|
||||||
m.Disabled = dis != 0
|
m.Disabled = dis != 0
|
||||||
|
m.Publisher = pub != 0
|
||||||
return m, err
|
return m, err
|
||||||
}
|
}
|
||||||
|
|
||||||
// AddMember subscribes an address to a list. Re-adding keeps the member id and
|
// AddMember subscribes an address to a list. Re-adding keeps the member id and the publisher
|
||||||
// clears the bounce state.
|
// flag and clears the bounce state.
|
||||||
func (s *Store) AddMember(listID int64, addr, displayName string) error {
|
func (s *Store) AddMember(listID int64, addr, displayName string) error {
|
||||||
return addMember(s.db, listID, addr, displayName)
|
return addMember(s.db, listID, addr, displayName)
|
||||||
}
|
}
|
||||||
|
|
@ -544,6 +552,24 @@ func (s *Store) IsMember(listID int64, addr string) (bool, error) {
|
||||||
return n > 0, err
|
return n > 0, err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetPublisher flags or unflags a member as a publisher of the list. It returns ErrNotFound
|
||||||
|
// when the address is not a member.
|
||||||
|
func (s *Store) SetPublisher(listID int64, addr string, publisher bool) error {
|
||||||
|
v := 0
|
||||||
|
if publisher {
|
||||||
|
v = 1
|
||||||
|
}
|
||||||
|
return affected(s.db.Exec(`UPDATE members SET publisher=? WHERE list_id=? AND address=?`, v, listID, norm(addr)))
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsPublisher reports whether addr is a member flagged as a publisher of the list. A publisher
|
||||||
|
// disabled by bounces is still a publisher: bounces stop delivery to it, not its posts.
|
||||||
|
func (s *Store) IsPublisher(listID int64, addr string) (bool, error) {
|
||||||
|
var n int
|
||||||
|
err := s.db.QueryRow(`SELECT COUNT(*) FROM members WHERE list_id=? AND address=? AND publisher=1`, listID, norm(addr)).Scan(&n)
|
||||||
|
return n > 0, err
|
||||||
|
}
|
||||||
|
|
||||||
// IsActiveMember reports whether addr is subscribed and not disabled by bounces.
|
// IsActiveMember reports whether addr is subscribed and not disabled by bounces.
|
||||||
func (s *Store) IsActiveMember(listID int64, addr string) (bool, error) {
|
func (s *Store) IsActiveMember(listID int64, addr string) (bool, error) {
|
||||||
var n int
|
var n int
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue