Fix correctness bugs found by code review
- matrix: drop cryptohelper LoginAs so device.json creds aren't invalidated on every restart by Init's re-login - matrix: thread ctx through PostThreadedReply; bot dispatcher derives per-command ctx from app lifecycle so SIGTERM cancels in-flight work - matrix: isTokenValid verifies /whoami user_id matches configured one - matrix: loadDevice distinguishes missing file from corrupt parse; refuse to silently overwrite a corrupt device.json - matrix: Start checks Syncer type assertion and returns error - arr: parseLookup skips empty-title items and extracts existing id - bot: skip Add when Result.Exists; reply "already in library"
This commit is contained in:
@@ -19,9 +19,10 @@ import (
|
||||
"maunium.net/go/mautrix/id"
|
||||
)
|
||||
|
||||
// Replier sends a threaded reply into roomID under rootEventID.
|
||||
// Replier sends a threaded reply into roomID under rootEventID. The ctx
|
||||
// governs cancellation/deadline so shutdown propagates through replies.
|
||||
type Replier interface {
|
||||
PostThreadedReply(roomID id.RoomID, rootEventID id.EventID, plain, htmlBody string) error
|
||||
PostThreadedReply(ctx context.Context, roomID id.RoomID, rootEventID id.EventID, plain, htmlBody string) error
|
||||
}
|
||||
|
||||
// Services holds the configured *arr clients. Any field may be nil; commands
|
||||
@@ -34,6 +35,7 @@ type Services struct {
|
||||
|
||||
// Dispatcher routes parsed commands to services and posts replies.
|
||||
type Dispatcher struct {
|
||||
baseCtx context.Context
|
||||
prefix string
|
||||
services Services
|
||||
replier Replier
|
||||
@@ -41,12 +43,17 @@ type Dispatcher struct {
|
||||
}
|
||||
|
||||
// New builds a Dispatcher. prefix is the leading character(s) on a command
|
||||
// (e.g. "!"); a zero value defaults to "!".
|
||||
func New(prefix string, services Services, replier Replier) *Dispatcher {
|
||||
// (e.g. "!"); a zero value defaults to "!". baseCtx becomes the parent of
|
||||
// every per-command context so app shutdown cancels in-flight handlers.
|
||||
func New(baseCtx context.Context, prefix string, services Services, replier Replier) *Dispatcher {
|
||||
if prefix == "" {
|
||||
prefix = "!"
|
||||
}
|
||||
if baseCtx == nil {
|
||||
baseCtx = context.Background()
|
||||
}
|
||||
return &Dispatcher{
|
||||
baseCtx: baseCtx,
|
||||
prefix: prefix,
|
||||
services: services,
|
||||
replier: replier,
|
||||
@@ -64,11 +71,11 @@ func (d *Dispatcher) Handle(roomID id.RoomID, eventID id.EventID, sender id.User
|
||||
|
||||
slog.Info("bot: command received", "room", roomID, "sender", sender, "cmd", cmd, "query", query)
|
||||
|
||||
ctx, cancel := context.WithTimeout(context.Background(), d.timeout)
|
||||
ctx, cancel := context.WithTimeout(d.baseCtx, d.timeout)
|
||||
defer cancel()
|
||||
|
||||
plain, htmlBody := d.dispatch(ctx, cmd, query)
|
||||
if err := d.replier.PostThreadedReply(roomID, eventID, plain, htmlBody); err != nil {
|
||||
if err := d.replier.PostThreadedReply(ctx, roomID, eventID, plain, htmlBody); err != nil {
|
||||
slog.Error("bot: reply failed", "room", roomID, "err", err)
|
||||
}
|
||||
}
|
||||
@@ -130,6 +137,10 @@ func (d *Dispatcher) run(ctx context.Context, cmd, service string, client arr.Cl
|
||||
}
|
||||
|
||||
top := results[0]
|
||||
if top.Exists {
|
||||
msg := fmt.Sprintf("%s already has %s in the library.", service, formatTitle(top))
|
||||
return msg, html.EscapeString(msg)
|
||||
}
|
||||
if err := client.Add(ctx, top); err != nil {
|
||||
slog.Error("bot: add failed", "service", service, "title", top.Title, "err", err)
|
||||
msg := fmt.Sprintf("%s: failed to add %s: %v", service, formatTitle(top), err)
|
||||
|
||||
@@ -44,7 +44,7 @@ type stubReplier struct {
|
||||
calls int
|
||||
}
|
||||
|
||||
func (r *stubReplier) PostThreadedReply(_ id.RoomID, _ id.EventID, plain, htmlBody string) error {
|
||||
func (r *stubReplier) PostThreadedReply(_ context.Context, _ id.RoomID, _ id.EventID, plain, htmlBody string) error {
|
||||
r.mu.Lock()
|
||||
defer r.mu.Unlock()
|
||||
r.calls++
|
||||
@@ -53,6 +53,10 @@ func (r *stubReplier) PostThreadedReply(_ id.RoomID, _ id.EventID, plain, htmlBo
|
||||
return nil
|
||||
}
|
||||
|
||||
func newDispatcher(prefix string, services Services, replier Replier) *Dispatcher {
|
||||
return New(context.Background(), prefix, services, replier)
|
||||
}
|
||||
|
||||
const (
|
||||
room = id.RoomID("!room:example.org")
|
||||
event = id.EventID("$evt")
|
||||
@@ -87,7 +91,7 @@ func TestDispatchMovieTopHit(t *testing.T) {
|
||||
{Title: "Dune", Year: 1984},
|
||||
}}
|
||||
rep := &stubReplier{}
|
||||
d := New("!", Services{Radarr: radarr}, rep)
|
||||
d := newDispatcher("!", Services{Radarr: radarr}, rep)
|
||||
|
||||
d.Handle(room, event, sender, "!movie dune")
|
||||
|
||||
@@ -105,7 +109,7 @@ func TestDispatchMovieTopHit(t *testing.T) {
|
||||
func TestDispatchNoResults(t *testing.T) {
|
||||
sonarr := &stubClient{}
|
||||
rep := &stubReplier{}
|
||||
d := New("!", Services{Sonarr: sonarr}, rep)
|
||||
d := newDispatcher("!", Services{Sonarr: sonarr}, rep)
|
||||
|
||||
d.Handle(room, event, sender, "!tv obscure show")
|
||||
|
||||
@@ -119,7 +123,7 @@ func TestDispatchNoResults(t *testing.T) {
|
||||
|
||||
func TestDispatchUnconfigured(t *testing.T) {
|
||||
rep := &stubReplier{}
|
||||
d := New("!", Services{}, rep)
|
||||
d := newDispatcher("!", Services{}, rep)
|
||||
|
||||
d.Handle(room, event, sender, "!music radiohead")
|
||||
|
||||
@@ -131,7 +135,7 @@ func TestDispatchUnconfigured(t *testing.T) {
|
||||
func TestDispatchEmptyQuery(t *testing.T) {
|
||||
radarr := &stubClient{}
|
||||
rep := &stubReplier{}
|
||||
d := New("!", Services{Radarr: radarr}, rep)
|
||||
d := newDispatcher("!", Services{Radarr: radarr}, rep)
|
||||
|
||||
d.Handle(room, event, sender, "!movie")
|
||||
|
||||
@@ -149,7 +153,7 @@ func TestDispatchAddError(t *testing.T) {
|
||||
addErr: errors.New("boom"),
|
||||
}
|
||||
rep := &stubReplier{}
|
||||
d := New("!", Services{Radarr: radarr}, rep)
|
||||
d := newDispatcher("!", Services{Radarr: radarr}, rep)
|
||||
|
||||
d.Handle(room, event, sender, "!movie dune")
|
||||
|
||||
@@ -161,7 +165,7 @@ func TestDispatchAddError(t *testing.T) {
|
||||
func TestDispatchSearchError(t *testing.T) {
|
||||
radarr := &stubClient{srchErr: errors.New("network down")}
|
||||
rep := &stubReplier{}
|
||||
d := New("!", Services{Radarr: radarr}, rep)
|
||||
d := newDispatcher("!", Services{Radarr: radarr}, rep)
|
||||
|
||||
d.Handle(room, event, sender, "!movie dune")
|
||||
|
||||
@@ -172,7 +176,7 @@ func TestDispatchSearchError(t *testing.T) {
|
||||
|
||||
func TestDispatchHelp(t *testing.T) {
|
||||
rep := &stubReplier{}
|
||||
d := New("!", Services{}, rep)
|
||||
d := newDispatcher("!", Services{}, rep)
|
||||
|
||||
d.Handle(room, event, sender, "!help")
|
||||
|
||||
@@ -185,7 +189,7 @@ func TestDispatchHelp(t *testing.T) {
|
||||
|
||||
func TestDispatchUnknown(t *testing.T) {
|
||||
rep := &stubReplier{}
|
||||
d := New("!", Services{}, rep)
|
||||
d := newDispatcher("!", Services{}, rep)
|
||||
|
||||
d.Handle(room, event, sender, "!frobnicate stuff")
|
||||
|
||||
@@ -196,7 +200,7 @@ func TestDispatchUnknown(t *testing.T) {
|
||||
|
||||
func TestNonCommandIgnored(t *testing.T) {
|
||||
rep := &stubReplier{}
|
||||
d := New("!", Services{}, rep)
|
||||
d := newDispatcher("!", Services{}, rep)
|
||||
|
||||
d.Handle(room, event, sender, "just chatting")
|
||||
|
||||
@@ -205,10 +209,25 @@ func TestNonCommandIgnored(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatchAlreadyInLibrary(t *testing.T) {
|
||||
radarr := &stubClient{results: []arr.Result{{Title: "Dune", Year: 2021, Exists: true}}}
|
||||
rep := &stubReplier{}
|
||||
d := newDispatcher("!", Services{Radarr: radarr}, rep)
|
||||
|
||||
d.Handle(room, event, sender, "!movie dune")
|
||||
|
||||
if len(radarr.added) != 0 {
|
||||
t.Fatalf("should not re-add existing item, got %d adds", len(radarr.added))
|
||||
}
|
||||
if !strings.Contains(rep.plain, "already has") || !strings.Contains(rep.plain, "Dune (2021)") {
|
||||
t.Fatalf("unexpected reply: %q", rep.plain)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCustomPrefix(t *testing.T) {
|
||||
radarr := &stubClient{results: []arr.Result{{Title: "Dune", Year: 2021}}}
|
||||
rep := &stubReplier{}
|
||||
d := New(".bh ", Services{Radarr: radarr}, rep)
|
||||
d := newDispatcher(".bh ", Services{Radarr: radarr}, rep)
|
||||
|
||||
d.Handle(room, event, sender, ".bh movie dune")
|
||||
|
||||
|
||||
Reference in New Issue
Block a user