Files
minstrel/internal/notifications/render.go
T
bvandeusenandClaude Opus 5.5 561c1d5eae
release / web (push) Failing after 1m29s
release / go (push) Successful in 1m55s
release / govulncheck (push) Successful in 19s
release / integration (push) Successful in 4m22s
release / android (push) Successful in 4m57s
release / Attach APK to the Release (tag releases only) (push) Canceled after 0s
release / Build + push container image (push) Canceled after 0s
release / Verify release artifacts (tag releases only) (push) Canceled after 0s
release / Build signed APK (push) Canceled after 4m23s
feat: new-music notices come from the scanner; request notices and the original specs go
Request notifications (approved, declined, completed, pending) are removed
along with the request flow that produced them. A new_music kind takes the
"new music arrived" slot: when a scan or a watcher batch finishes, the
scanner claims every album not yet announced (albums.announced_at) and tells
every user about the ones that are new: an album with a track on disk and
no track older than itself. The first import into an empty library, and an
album formed only by retagging tracks already held, announce nothing. One
notice per scan, carrying up to 50 albums and the total; it is never
coalesced, so a notice already emailed can't quietly absorb later arrivals.
It feeds the daily summary email, grouped by artist. Defaults: inbox and
email on, phone off.

Migration 0103 deletes request-kind notification rows and prefs, swaps the
kind CHECKs to new_music, and adds albums.announced_at with every album
held marked announced, so the first scan after it announces nothing old.

Web and Android: labels, the Android "Requests" settings section becomes
"New music", the shade channel your_requests becomes new_music (the old one
is deleted at startup), and "/" opens Home in the app. TrackLabel moves to
the notifications package. docs/smart-music-{server,client}-spec.md are
deleted per the operator; an Android comment loses the word "exchanges".

Grimoire #7666, #7671.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-21 23:29:13 -05:00

206 lines
6.6 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
package notifications
import (
"encoding/json"
"fmt"
"strings"
"git.fabledsword.com/bvandeusen/minstrel/internal/words"
)
// Rendered is a notification as people read it. The server renders it once,
// so the web inbox, the Android inbox, the phone's shade and the email digest
// all say the same thing, and a wording change is one edit here rather than
// a phrase table per client.
type Rendered struct {
Title string `json:"title"`
Body string `json:"body"`
// Link is the web path the notification opens. Android maps the same
// paths onto its screens.
Link string `json:"link"`
}
// Payload is what producers put in a notification. Every field is optional;
// each kind documents the ones it uses in Render.
type Payload struct {
// Name is what was flagged, as the user would say it: "Moe Shop – WWW".
Name string `json:"name,omitempty"`
// Albums are new_music's arrivals, the first AlbumsKept of Count.
Albums []Arrival `json:"albums,omitempty"`
// Actor is the other person involved: who flagged.
Actor string `json:"actor,omitempty"`
Reason string `json:"reason,omitempty"`
// Count is the coalesced kinds' running total since the notice was last
// read.
Count int64 `json:"count,omitempty"`
// Items name what Count counts, one each, newest first: "Weezer – Buddy
// Holly". A coalesced update puts its own in front and keeps ten,
// so the body can say which, not only how many.
Items []string `json:"items,omitempty"`
// Detail is free text: scan_failed's error message. Rows from before
// Items also carry duplicates_resolved's summary here.
Detail string `json:"detail,omitempty"`
}
// Arrival is one album new to the library.
type Arrival struct {
Artist string `json:"artist"`
Title string `json:"title"`
ArtistID string `json:"artist_id,omitempty"`
AlbumID string `json:"album_id,omitempty"`
}
// AlbumsKept is how many arrivals a new_music notice carries. The count says
// how many there were in all.
const AlbumsKept = 50
// Map turns a Payload into the map Notify takes, dropping empty fields.
func (p Payload) Map() map[string]any {
b, _ := json.Marshal(p)
var m map[string]any
_ = json.Unmarshal(b, &m)
return m
}
// Render turns a stored row into what people read. An unreadable payload
// still renders, from the kind alone, rather than failing the whole inbox.
func Render(kind Kind, payload []byte) Rendered {
var p Payload
_ = json.Unmarshal(payload, &p)
name := p.Name
if name == "" {
name = "A track"
}
switch kind {
case KindNewMusic:
return renderNewMusic(p)
case KindQuarantineFlagged:
who := p.Actor
if who == "" {
who = "Someone"
}
body := who + " flagged " + name + "."
if p.Reason != "" {
body = who + " flagged " + name + ": " + p.Reason
}
return Rendered{Title: "Track flagged", Body: body, Link: "/collection/reports"}
case KindScanFailed:
title := "Library scan failed"
if p.Count > 1 {
title = fmt.Sprintf("Library scan failed %d times", p.Count)
}
body := "The last scan stopped with an error."
if p.Detail != "" {
body = "The last scan stopped: " + p.Detail
}
return Rendered{Title: title, Body: body, Link: "/admin/library"}
case KindTracksMissing:
body := "Their files are no longer where the library expects them."
if names := nameList(p.Items, p.Count); names != "" {
body = "No longer on disk: " + names + "."
}
return Rendered{
Title: plural(p.Count, "track went missing", "tracks went missing"),
Body: body,
Link: "/collection/missing",
}
case KindDuplicatesFound:
body := "The duplicate sweep found tracks holding the same recording."
if names := nameList(p.Items, p.Count); names != "" {
body = "Held more than once: " + names + "."
}
return Rendered{
Title: plural(p.Count, "new duplicate to review", "new duplicates to review"),
Body: body,
Link: "/collection/duplicates",
}
case KindDuplicatesResolved:
body := "Extra copies of a song were merged into the one the album keeps."
switch names := nameList(p.Items, p.Count); {
case names != "":
body = "Extra copies removed, the right one kept: " + names + "."
case p.Detail != "":
body = p.Detail
}
return Rendered{
Title: plural(p.Count, "duplicate merged automatically", "duplicates merged automatically"),
Body: body,
Link: "/collection/duplicates?view=resolved",
}
case KindPlaybackErrors:
body := "A track failed to play for someone."
if names := nameList(p.Items, p.Count); names != "" {
body = "Failed to play: " + names + "."
}
return Rendered{
Title: plural(p.Count, "playback error reported", "playback errors reported"),
Body: body,
Link: "/collection/reports",
}
default:
return Rendered{Title: "Notification", Link: "/"}
}
}
// renderNewMusic: a single album opens itself; several open Home, whose
// Recently added row starts with them.
func renderNewMusic(p Payload) Rendered {
total := max(p.Count, int64(len(p.Albums)))
if total == 1 && len(p.Albums) == 1 {
a := p.Albums[0]
link := "/"
if a.AlbumID != "" {
link = "/albums/" + a.AlbumID
}
return Rendered{Title: "New album", Body: TrackLabel(a.Artist, a.Title) + " is in the library.", Link: link}
}
labels := make([]string, 0, min(len(p.Albums), namesShown))
for _, a := range p.Albums[:min(len(p.Albums), namesShown)] {
labels = append(labels, TrackLabel(a.Artist, a.Title))
}
body := "New albums are in the library."
if names := nameList(labels, total); names != "" {
body = "Now in the library: " + names + "."
}
return Rendered{Title: plural(total, "new album", "new albums"), Body: body, Link: "/"}
}
// TrackLabel names a track or album as a notice does: "Artist – Title", or
// the title alone when the artist is unknown.
func TrackLabel(artist, title string) string {
if artist == "" {
return title
}
return artist + " – " + title
}
// namesShown is how many of a notice's items its body names.
const namesShown = 3
// nameList names the first few items, then how many more of the total there
// are: "A, B, C and 4 more". Empty when there are no items.
func nameList(items []string, total int64) string {
if len(items) == 0 {
return ""
}
shown := items[:min(len(items), namesShown)]
more := max(total, int64(len(items))) - int64(len(shown))
if more > 0 {
return strings.Join(shown, ", ") + " and " + words.Count(more, "more", "more")
}
if len(shown) == 1 {
return shown[0]
}
return strings.Join(shown[:len(shown)-1], ", ") + " and " + shown[len(shown)-1]
}
func plural(n int64, one, many string) string {
if n < 1 {
// A coalesced kind always carries a count; this only guards a
// malformed row from reading "0 tracks went missing".
return "Some " + many
}
return words.Count(n, one, many)
}