Skip to content

Topics #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kicher-erbse merged 2 commits into from
Apr 15, 2026
Merged

Topics #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e31dfa3
multipart mails
kicher-erbse Apr 15, 2026
4922276
implement topic management
kicher-erbse Apr 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 124 additions & 14 deletions api/private.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ type ListManager interface {

// MailDispatcher is the private API's view of the mail service.
type MailDispatcher interface {
SendToList(ctx context.Context, listName string, raw string, data map[string]any) error
SendToList(ctx context.Context, listName string, raw string, topicNames []string, data map[string]any) error
SendTestMail(ctx context.Context, recipient domain.User, raw string, data map[string]any) error
}

Expand All @@ -43,7 +43,7 @@ type NewsletterArchive interface {

// ScheduleManager is the private API's view of the scheduling service.
type ScheduleManager interface {
Schedule(ctx context.Context, mailingListName, rawMarkdown string, scheduledAt int64) (*domain.ScheduledMail, error)
Schedule(ctx context.Context, mailingListName, rawMarkdown string, scheduledAt int64, topicNames []string) (*domain.ScheduledMail, error)
List(ctx context.Context) ([]domain.ScheduledMail, error)
Get(ctx context.Context, id uint) (*domain.ScheduledMail, error)
Delete(ctx context.Context, id uint) error
Expand All @@ -53,19 +53,28 @@ type ScheduleManager interface {

// PrivateHandler serves the private admin API.
// When publicKey is non-nil, every request must carry a valid Ed25519 signature.
type TopicManager interface {
Create(ctx context.Context, mailingListName, name, displayName string, defaultEnabled, subscribeExisting bool) (*domain.Topic, error)
List(ctx context.Context, mailingListName string) ([]domain.Topic, error)
Get(ctx context.Context, mailingListName, name string) (*domain.Topic, error)
Update(ctx context.Context, mailingListName, name string, displayName *string, defaultEnabled *bool) (*domain.Topic, error)
Delete(ctx context.Context, mailingListName, name string) error
}

type PrivateHandler struct {
lists ListManager
mail MailDispatcher
newsletters NewsletterArchive
scheduler ScheduleManager
topics TopicManager
publicKey ed25519.PublicKey
logger *slog.Logger
}

// NewPrivateHandler creates a new PrivateHandler.
// Pass a nil publicKey to disable request authentication.
func NewPrivateHandler(lists ListManager, mail MailDispatcher, newsletters NewsletterArchive, scheduler ScheduleManager, publicKey ed25519.PublicKey, logger *slog.Logger) *PrivateHandler {
return &PrivateHandler{lists: lists, mail: mail, newsletters: newsletters, scheduler: scheduler, publicKey: publicKey, logger: logger}
func NewPrivateHandler(lists ListManager, mail MailDispatcher, newsletters NewsletterArchive, scheduler ScheduleManager, topics TopicManager, publicKey ed25519.PublicKey, logger *slog.Logger) *PrivateHandler {
return &PrivateHandler{lists: lists, mail: mail, newsletters: newsletters, scheduler: scheduler, topics: topics, publicKey: publicKey, logger: logger}
}

// Routes returns the mux for all private API endpoints.
Expand All @@ -79,6 +88,11 @@ func (h *PrivateHandler) Routes() *http.ServeMux {
mux.Handle("GET /lists/{name}/users", h.auth(h.handleListUsers))
mux.Handle("POST /lists/{name}/send", h.auth(h.handleSendToList))
mux.Handle("POST /lists/{name}/schedule", h.auth(h.handleScheduleMail))
mux.Handle("GET /lists/{name}/topics", h.auth(h.handleListTopics))
mux.Handle("POST /lists/{name}/topics", h.auth(h.handleCreateTopic))
mux.Handle("GET /lists/{name}/topics/{topic}", h.auth(h.handleGetTopic))
mux.Handle("PUT /lists/{name}/topics/{topic}", h.auth(h.handleUpdateTopic))
mux.Handle("DELETE /lists/{name}/topics/{topic}", h.auth(h.handleDeleteTopic))
mux.Handle("POST /mail/test", h.auth(h.handleSendTestMail))
mux.Handle("GET /newsletters", h.auth(h.handleAllNewsletters))
mux.Handle("GET /newsletters/{id}", h.auth(h.handleGetNewsletter))
Expand Down Expand Up @@ -113,8 +127,9 @@ type userResponse struct {
}

type sendRequest struct {
Raw string `json:"raw"`
Data map[string]any `json:"data"`
Raw string `json:"raw"`
Topics []string `json:"topics"`
Data map[string]any `json:"data"`
}

type testMailRequest struct {
Expand Down Expand Up @@ -145,15 +160,23 @@ type newsletterDetailResponse struct {
}

type scheduleRequest struct {
Raw string `json:"raw"`
ScheduledAt int64 `json:"scheduledAt"`
Raw string `json:"raw"`
Topics []string `json:"topics"`
ScheduledAt int64 `json:"scheduledAt"`
}

type scheduledMailResponse struct {
ID uint `json:"id"`
MailingListName string `json:"mailingListName"`
ScheduledAt int64 `json:"scheduledAt"`
SentAt *int64 `json:"sentAt"`
ID uint `json:"id"`
MailingListName string `json:"mailingListName"`
ScheduledAt int64 `json:"scheduledAt"`
SentAt *int64 `json:"sentAt"`
TopicNames []string `json:"topicNames,omitempty"`
}

type topicResponse struct {
Name string `json:"name"`
DisplayName string `json:"displayName"`
DefaultEnabled bool `json:"defaultEnabled"`
}

type rescheduleRequest struct {
Expand Down Expand Up @@ -281,7 +304,7 @@ func (h *PrivateHandler) handleSendToList(w http.ResponseWriter, r *http.Request
return
}

if err := h.mail.SendToList(r.Context(), name, body.Raw, body.Data); err != nil {
if err := h.mail.SendToList(r.Context(), name, body.Raw, body.Topics, body.Data); err != nil {
h.logger.ErrorContext(r.Context(), "send to list failed", slog.String("list", name), slog.Any("error", err))
writeError(w, http.StatusInternalServerError, "failed to send mail")
return
Expand Down Expand Up @@ -389,7 +412,7 @@ func (h *PrivateHandler) handleScheduleMail(w http.ResponseWriter, r *http.Reque
return
}

m, err := h.scheduler.Schedule(r.Context(), name, body.Raw, body.ScheduledAt)
m, err := h.scheduler.Schedule(r.Context(), name, body.Raw, body.ScheduledAt, body.Topics)
if err != nil {
h.logger.ErrorContext(r.Context(), "schedule mail failed", slog.String("list", name), slog.Any("error", err))
writeError(w, http.StatusInternalServerError, "failed to schedule mail")
Expand All @@ -401,9 +424,92 @@ func (h *PrivateHandler) handleScheduleMail(w http.ResponseWriter, r *http.Reque
MailingListName: m.MailingListName,
ScheduledAt: m.ScheduledAt,
SentAt: m.SentAt,
TopicNames: m.TopicNames,
})
}

func (h *PrivateHandler) handleListTopics(w http.ResponseWriter, r *http.Request) {
name := r.PathValue("name")
topics, err := h.topics.List(r.Context(), name)
if err != nil {
h.logger.ErrorContext(r.Context(), "list topics failed", slog.String("list", name), slog.Any("error", err))
writeError(w, http.StatusInternalServerError, "failed to load topics")
return
}
resp := make([]topicResponse, len(topics))
for i, t := range topics {
resp[i] = topicResponse{Name: t.Name, DisplayName: t.DisplayName, DefaultEnabled: t.DefaultEnabled}
}
writeJSON(w, http.StatusOK, resp)
}

func (h *PrivateHandler) handleCreateTopic(w http.ResponseWriter, r *http.Request) {
listName := r.PathValue("name")
var body struct {
Name string `json:"name"`
DisplayName string `json:"displayName"`
DefaultEnabled bool `json:"defaultEnabled"`
SubscribeExisting bool `json:"subscribeExisting"`
}
if err := json.NewDecoder(r.Body).Decode(&body); err != nil || body.Name == "" {
writeError(w, http.StatusBadRequest, "name is required")
return
}
if body.DisplayName == "" {
body.DisplayName = body.Name
}
t, err := h.topics.Create(r.Context(), listName, body.Name, body.DisplayName, body.DefaultEnabled, body.SubscribeExisting)
if err != nil {
h.logger.ErrorContext(r.Context(), "create topic failed", slog.String("list", listName), slog.String("topic", body.Name), slog.Any("error", err))
writeError(w, http.StatusInternalServerError, "failed to create topic")
return
}
writeJSON(w, http.StatusCreated, topicResponse{Name: t.Name, DisplayName: t.DisplayName, DefaultEnabled: t.DefaultEnabled})
}

func (h *PrivateHandler) handleGetTopic(w http.ResponseWriter, r *http.Request) {
listName := r.PathValue("name")
topicName := r.PathValue("topic")
t, err := h.topics.Get(r.Context(), listName, topicName)
if err != nil {
h.logger.ErrorContext(r.Context(), "get topic failed", slog.String("list", listName), slog.String("topic", topicName), slog.Any("error", err))
writeError(w, http.StatusNotFound, "topic not found")
return
}
writeJSON(w, http.StatusOK, topicResponse{Name: t.Name, DisplayName: t.DisplayName, DefaultEnabled: t.DefaultEnabled})
}

func (h *PrivateHandler) handleUpdateTopic(w http.ResponseWriter, r *http.Request) {
listName := r.PathValue("name")
topicName := r.PathValue("topic")
var body struct {
DisplayName *string `json:"displayName"`
DefaultEnabled *bool `json:"defaultEnabled"`
}
if err := json.NewDecoder(r.Body).Decode(&body); err != nil {
writeError(w, http.StatusBadRequest, "invalid request body")
return
}
t, err := h.topics.Update(r.Context(), listName, topicName, body.DisplayName, body.DefaultEnabled)
if err != nil {
h.logger.ErrorContext(r.Context(), "update topic failed", slog.String("list", listName), slog.String("topic", topicName), slog.Any("error", err))
writeError(w, http.StatusInternalServerError, "failed to update topic")
return
}
writeJSON(w, http.StatusOK, topicResponse{Name: t.Name, DisplayName: t.DisplayName, DefaultEnabled: t.DefaultEnabled})
}

func (h *PrivateHandler) handleDeleteTopic(w http.ResponseWriter, r *http.Request) {
listName := r.PathValue("name")
topicName := r.PathValue("topic")
if err := h.topics.Delete(r.Context(), listName, topicName); err != nil {
h.logger.ErrorContext(r.Context(), "delete topic failed", slog.String("list", listName), slog.String("topic", topicName), slog.Any("error", err))
writeError(w, http.StatusInternalServerError, "failed to delete topic")
return
}
w.WriteHeader(http.StatusNoContent)
}

func (h *PrivateHandler) handleAllScheduled(w http.ResponseWriter, r *http.Request) {
mails, err := h.scheduler.List(r.Context())
if err != nil {
Expand All @@ -418,6 +524,7 @@ func (h *PrivateHandler) handleAllScheduled(w http.ResponseWriter, r *http.Reque
MailingListName: m.MailingListName,
ScheduledAt: m.ScheduledAt,
SentAt: m.SentAt,
TopicNames: m.TopicNames,
}
}
writeJSON(w, http.StatusOK, resp)
Expand All @@ -440,6 +547,7 @@ func (h *PrivateHandler) handleGetScheduled(w http.ResponseWriter, r *http.Reque
MailingListName: m.MailingListName,
ScheduledAt: m.ScheduledAt,
SentAt: m.SentAt,
TopicNames: m.TopicNames,
})
}

Expand Down Expand Up @@ -479,6 +587,7 @@ func (h *PrivateHandler) handleRescheduleMail(w http.ResponseWriter, r *http.Req
MailingListName: m.MailingListName,
ScheduledAt: m.ScheduledAt,
SentAt: m.SentAt,
TopicNames: m.TopicNames,
})
}

Expand All @@ -504,6 +613,7 @@ func (h *PrivateHandler) handleReplaceScheduledContent(w http.ResponseWriter, r
MailingListName: m.MailingListName,
ScheduledAt: m.ScheduledAt,
SentAt: m.SentAt,
TopicNames: m.TopicNames,
})
}

Expand Down
113 changes: 104 additions & 9 deletions api/private_client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,8 +171,8 @@ func (c *PrivateClient) GetUsers(ctx context.Context, listName string) ([]UserIt

// SendToList dispatches a rendered markdown mail to all confirmed subscribers
// of the named list.
func (c *PrivateClient) SendToList(ctx context.Context, listName string, raw string, data map[string]any) error {
resp, err := c.do(ctx, http.MethodPost, fmt.Sprintf("/lists/%s/send", listName), map[string]any{"raw": raw, "data": data})
func (c *PrivateClient) SendToList(ctx context.Context, listName string, raw string, topicNames []string, data map[string]any) error {
resp, err := c.do(ctx, http.MethodPost, fmt.Sprintf("/lists/%s/send", listName), map[string]any{"raw": raw, "topics": topicNames, "data": data})
if err != nil {
return fmt.Errorf("send to list: %w", err)
}
Expand Down Expand Up @@ -205,16 +205,17 @@ func (c *PrivateClient) SendTestMail(ctx context.Context, recipient RecipientInp

// ScheduledMailItem describes a single scheduled mail as returned by the API.
type ScheduledMailItem struct {
ID uint `json:"id"`
MailingListName string `json:"mailingListName"`
ScheduledAt int64 `json:"scheduledAt"`
SentAt *int64 `json:"sentAt"`
ID uint `json:"id"`
MailingListName string `json:"mailingListName"`
ScheduledAt int64 `json:"scheduledAt"`
SentAt *int64 `json:"sentAt"`
TopicNames []string `json:"topicNames,omitempty"`
}

// ScheduleMail creates a new scheduled mail for the given list.
// scheduledAt is a unix timestamp (UTC).
func (c *PrivateClient) ScheduleMail(ctx context.Context, listName string, raw string, scheduledAt int64) (*ScheduledMailItem, error) {
payload := map[string]any{"raw": raw, "scheduledAt": scheduledAt}
func (c *PrivateClient) ScheduleMail(ctx context.Context, listName string, raw string, scheduledAt int64, topicNames []string) (*ScheduledMailItem, error) {
payload := map[string]any{"raw": raw, "scheduledAt": scheduledAt, "topics": topicNames}
resp, err := c.do(ctx, http.MethodPost, fmt.Sprintf("/lists/%s/schedule", listName), payload)
if err != nil {
return nil, fmt.Errorf("schedule mail: %w", err)
Expand Down Expand Up @@ -318,7 +319,101 @@ func (c *PrivateClient) ReplaceScheduledContent(ctx context.Context, id uint, ra
return &out, nil
}

// do builds and executes a signed HTTP request.
type TopicItem struct {
Name string `json:"name"`
DisplayName string `json:"displayName"`
DefaultEnabled bool `json:"defaultEnabled"`
}

func (c *PrivateClient) ListTopics(ctx context.Context, listName string) ([]TopicItem, error) {
resp, err := c.do(ctx, http.MethodGet, fmt.Sprintf("/lists/%s/topics", listName), nil)
if err != nil {
return nil, fmt.Errorf("list topics: %w", err)
}
defer resp.Body.Close()
if err := expectStatus(resp, http.StatusOK); err != nil {
return nil, fmt.Errorf("list topics: %w", err)
}
var out []TopicItem
if err := json.NewDecoder(resp.Body).Decode(&out); err != nil {
return nil, fmt.Errorf("list topics: decode response: %w", err)
}
return out, nil
}

func (c *PrivateClient) CreateTopic(ctx context.Context, listName, name, displayName string, defaultEnabled, subscribeExisting bool) (*TopicItem, error) {
payload := map[string]any{
"name": name,
"displayName": displayName,
"defaultEnabled": defaultEnabled,
"subscribeExisting": subscribeExisting,
}
resp, err := c.do(ctx, http.MethodPost, fmt.Sprintf("/lists/%s/topics", listName), payload)
if err != nil {
return nil, fmt.Errorf("create topic: %w", err)
}
defer resp.Body.Close()
if err := expectStatus(resp, http.StatusCreated); err != nil {
return nil, fmt.Errorf("create topic: %w", err)
}
var out TopicItem
if err := json.NewDecoder(resp.Body).Decode(&out); err != nil {
return nil, fmt.Errorf("create topic: decode response: %w", err)
}
return &out, nil
}

func (c *PrivateClient) GetTopic(ctx context.Context, listName, topicName string) (*TopicItem, error) {
resp, err := c.do(ctx, http.MethodGet, fmt.Sprintf("/lists/%s/topics/%s", listName, topicName), nil)
if err != nil {
return nil, fmt.Errorf("get topic: %w", err)
}
defer resp.Body.Close()
if err := expectStatus(resp, http.StatusOK); err != nil {
return nil, fmt.Errorf("get topic: %w", err)
}
var out TopicItem
if err := json.NewDecoder(resp.Body).Decode(&out); err != nil {
return nil, fmt.Errorf("get topic: decode response: %w", err)
}
return &out, nil
}

func (c *PrivateClient) UpdateTopic(ctx context.Context, listName, topicName string, displayName *string, defaultEnabled *bool) (*TopicItem, error) {
payload := map[string]any{}
if displayName != nil {
payload["displayName"] = *displayName
}
if defaultEnabled != nil {
payload["defaultEnabled"] = *defaultEnabled
}
resp, err := c.do(ctx, http.MethodPut, fmt.Sprintf("/lists/%s/topics/%s", listName, topicName), payload)
if err != nil {
return nil, fmt.Errorf("update topic: %w", err)
}
defer resp.Body.Close()
if err := expectStatus(resp, http.StatusOK); err != nil {
return nil, fmt.Errorf("update topic: %w", err)
}
var out TopicItem
if err := json.NewDecoder(resp.Body).Decode(&out); err != nil {
return nil, fmt.Errorf("update topic: decode response: %w", err)
}
return &out, nil
}

func (c *PrivateClient) DeleteTopic(ctx context.Context, listName, topicName string) error {
resp, err := c.do(ctx, http.MethodDelete, fmt.Sprintf("/lists/%s/topics/%s", listName, topicName), nil)
if err != nil {
return fmt.Errorf("delete topic: %w", err)
}
defer resp.Body.Close()
if err := expectStatus(resp, http.StatusNoContent); err != nil {
return fmt.Errorf("delete topic: %w", err)
}
return nil
}

func (c *PrivateClient) do(ctx context.Context, method, path string, payload any) (*http.Response, error) {
var bodyBytes []byte
if payload != nil {
Expand Down
Loading
Loading