From the second independent review of #207:
- parkForReview now skips the delete when the note changed since it was read
(an LLM call sits in that window; Syncthing can deliver a newer version)
- parked copies are created via brainfs (real dirs only, O_EXCL, no symlink
following), so a planted raw/needs-review symlink cannot redirect or hide a
note; this also removes the need for the guard allowlist entry added in
1e14c56, which is reverted
- a '----' line no longer closes the proposal block
Each has a test that failed first and a mutant that fails it.
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
332 lines
13 KiB
Go
332 lines
13 KiB
Go
package watcher
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"sync/atomic"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/mathiasbq/hyperguild/ingestion/internal/pipeline"
|
|
"github.com/mathiasbq/hyperguild/ingestion/internal/wing"
|
|
)
|
|
|
|
type stubClassifier struct {
|
|
s wing.Suggestion
|
|
err error
|
|
calls atomic.Int32
|
|
}
|
|
|
|
func (c *stubClassifier) Classify(context.Context, string, []string) (wing.Suggestion, error) {
|
|
c.calls.Add(1)
|
|
return c.s, c.err
|
|
}
|
|
|
|
type stubScorer map[string]float64
|
|
|
|
func (s stubScorer) Score(string) map[string]float64 { return s }
|
|
|
|
func wingResolver(c wing.Classifier, s wing.Scorer) *wing.Resolver {
|
|
return &wing.Resolver{
|
|
Known: []string{"radar", "homelab", "client-x"},
|
|
Eligible: func(w string) bool { return w != "client-x" },
|
|
Classifier: c,
|
|
Scorer: s,
|
|
Threshold: 0.8,
|
|
}
|
|
}
|
|
|
|
func wingTestCfg(t *testing.T, r *wing.Resolver, llmCalls *atomic.Int32) (Config, string) {
|
|
t.Helper()
|
|
brainDir := setupBrainDir(t)
|
|
return Config{
|
|
BrainDir: brainDir,
|
|
Resolver: r,
|
|
Pipeline: pipeline.Config{
|
|
Schema: "# Schema",
|
|
Complete: func(ctx context.Context, s, u string) (string, error) {
|
|
llmCalls.Add(1)
|
|
return successComplete(pipeline.RawPage{Title: "Talk", Type: "source", Subtype: "video", Content: "## Summary\n\nx\n"})(ctx, s, u)
|
|
},
|
|
},
|
|
}, brainDir
|
|
}
|
|
|
|
func put(t *testing.T, brainDir, rel, body string) {
|
|
t.Helper()
|
|
full := filepath.Join(brainDir, "raw", rel)
|
|
require.NoError(t, os.MkdirAll(filepath.Dir(full), 0o755))
|
|
require.NoError(t, os.WriteFile(full, []byte(body), 0o644))
|
|
}
|
|
|
|
func has(brainDir, rel string) bool {
|
|
_, err := os.Stat(filepath.Join(brainDir, rel))
|
|
return err == nil
|
|
}
|
|
|
|
func TestProcessDir_ASubfolderNamesTheWing(t *testing.T) {
|
|
var llmCalls atomic.Int32
|
|
clf := &stubClassifier{}
|
|
cfg, brainDir := wingTestCfg(t, wingResolver(clf, stubScorer{}), &llmCalls)
|
|
put(t, brainDir, "radar/dark-factory.md", "A talk about factories.")
|
|
|
|
errs := processDir(context.Background(), cfg, "2026-10-20")
|
|
|
|
require.Empty(t, errs)
|
|
assert.True(t, has(brainDir, "wiki/radar/sources/dark-factory.md"), "lands in the named wing")
|
|
assert.False(t, has(brainDir, "raw/radar/dark-factory.md"), "inbox zero holds for subfolders too")
|
|
assert.Zero(t, clf.calls.Load(), "an explicit wing costs no classification")
|
|
}
|
|
|
|
func TestProcessDir_ANoteTheResolverCannotPlaceIsParkedNotIngested(t *testing.T) {
|
|
var llmCalls atomic.Int32
|
|
clf := &stubClassifier{s: wing.Suggestion{Wing: "radar", Confidence: 0.5, Reason: "maybe"}}
|
|
cfg, brainDir := wingTestCfg(t, wingResolver(clf, stubScorer{"radar": 3}), &llmCalls)
|
|
put(t, brainDir, "unsure.md", "Some note.")
|
|
|
|
errs := processDir(context.Background(), cfg, "2026-10-20")
|
|
|
|
require.Empty(t, errs)
|
|
assert.Zero(t, llmCalls.Load(), "no extraction runs for an unplaced note")
|
|
assert.False(t, has(brainDir, "raw/unsure.md"), "leaves the top of raw/")
|
|
parked, err := os.ReadFile(filepath.Join(brainDir, "raw", "needs-review", "unsure.md"))
|
|
require.NoError(t, err)
|
|
assert.Contains(t, string(parked), "proposed_wing: radar")
|
|
assert.Contains(t, string(parked), "below threshold")
|
|
assert.Contains(t, string(parked), "Some note.", "the note body is preserved")
|
|
}
|
|
|
|
func TestProcessDir_ANoteInAClientWingFolderIsParked(t *testing.T) {
|
|
var llmCalls atomic.Int32
|
|
cfg, brainDir := wingTestCfg(t, wingResolver(&stubClassifier{}, stubScorer{}), &llmCalls)
|
|
put(t, brainDir, "client-x/secret.md", "Client material.")
|
|
|
|
require.Empty(t, processDir(context.Background(), cfg, "2026-10-20"))
|
|
|
|
assert.Zero(t, llmCalls.Load())
|
|
assert.False(t, has(brainDir, "wiki/client-x"), "nothing is ever written into an ineligible wing")
|
|
assert.True(t, has(brainDir, "raw/needs-review/secret.md"))
|
|
}
|
|
|
|
func TestProcessDir_ClassifierFailureParksTheNote(t *testing.T) {
|
|
var llmCalls atomic.Int32
|
|
cfg, brainDir := wingTestCfg(t, wingResolver(&stubClassifier{err: errors.New("llm down")}, stubScorer{}), &llmCalls)
|
|
put(t, brainDir, "n.md", "Note.")
|
|
|
|
require.Empty(t, processDir(context.Background(), cfg, "2026-10-20"))
|
|
|
|
assert.Zero(t, llmCalls.Load())
|
|
assert.True(t, has(brainDir, "raw/needs-review/n.md"))
|
|
}
|
|
|
|
func TestProcessDir_ParkedNotesAreNotReprocessed(t *testing.T) {
|
|
var llmCalls atomic.Int32
|
|
clf := &stubClassifier{s: wing.Suggestion{Wing: "radar", Confidence: 0.99}}
|
|
cfg, brainDir := wingTestCfg(t, wingResolver(clf, stubScorer{"radar": 3}), &llmCalls)
|
|
put(t, brainDir, "needs-review/waiting.md", "---\nproposed_wing: radar\n---\nA parked note.")
|
|
|
|
require.Empty(t, processDir(context.Background(), cfg, "2026-10-20"))
|
|
|
|
assert.Zero(t, clf.calls.Load(), "needs-review/ is a human queue, like rejected/")
|
|
assert.True(t, has(brainDir, "raw/needs-review/waiting.md"))
|
|
}
|
|
|
|
func TestProcessDir_WithoutAResolverTheRetiredLayoutIsUnchanged(t *testing.T) {
|
|
var llmCalls atomic.Int32
|
|
cfg, brainDir := wingTestCfg(t, nil, &llmCalls)
|
|
put(t, brainDir, "plain.md", "Plain note.")
|
|
|
|
require.Empty(t, processDir(context.Background(), cfg, "2026-10-20"))
|
|
|
|
assert.True(t, has(brainDir, "wiki/sources/plain.md"))
|
|
}
|
|
|
|
// The reason comes from an LLM and ends up in frontmatter: a newline in it must
|
|
// not be able to start a new key (PR #147: a title once forged `origin:`).
|
|
func TestProcessDir_AProposalReasonCannotForgeFrontmatterKeys(t *testing.T) {
|
|
var llmCalls atomic.Int32
|
|
// A classifier error is the path by which model text reaches the reason.
|
|
clf := &stubClassifier{err: errors.New("bad reply\norigin: trusted\nwing: homelab")}
|
|
cfg, brainDir := wingTestCfg(t, wingResolver(clf, stubScorer{}), &llmCalls)
|
|
put(t, brainDir, "forge.md", "Note.")
|
|
|
|
require.Empty(t, processDir(context.Background(), cfg, "2026-10-20"))
|
|
|
|
parked, err := os.ReadFile(filepath.Join(brainDir, "raw", "needs-review", "forge.md"))
|
|
require.NoError(t, err)
|
|
assert.NotContains(t, string(parked), "\norigin: trusted", "no injected key at line start")
|
|
assert.NotContains(t, string(parked), "\nwing: homelab")
|
|
}
|
|
|
|
// Syncthing can bring a removed note back (an offline peer, a restored backup).
|
|
// The source-hash drift check must keep that from costing a second extraction.
|
|
func TestProcessDir_ANoteThatReappearsUnchangedIsNotExtractedAgain(t *testing.T) {
|
|
var llmCalls atomic.Int32
|
|
cfg, brainDir := wingTestCfg(t, wingResolver(&stubClassifier{}, stubScorer{}), &llmCalls)
|
|
|
|
put(t, brainDir, "radar/talk.md", "The same talk, byte for byte.")
|
|
require.Empty(t, processDir(context.Background(), cfg, "2026-10-20"))
|
|
require.Equal(t, int32(1), llmCalls.Load(), "positive control: the first drop is extracted")
|
|
require.False(t, has(brainDir, "raw/radar/talk.md"))
|
|
|
|
put(t, brainDir, "radar/talk.md", "The same talk, byte for byte.") // the peer sends it back
|
|
require.Empty(t, processDir(context.Background(), cfg, "2026-10-21"))
|
|
|
|
assert.Equal(t, int32(1), llmCalls.Load(), "an unchanged source is not extracted twice")
|
|
assert.False(t, has(brainDir, "raw/radar/talk.md"), "and inbox zero still holds")
|
|
}
|
|
|
|
func TestProcessDir_ANoteThatReappearsChangedIsExtractedAgain(t *testing.T) {
|
|
var llmCalls atomic.Int32
|
|
cfg, brainDir := wingTestCfg(t, wingResolver(&stubClassifier{}, stubScorer{}), &llmCalls)
|
|
|
|
put(t, brainDir, "radar/talk.md", "Version one.")
|
|
require.Empty(t, processDir(context.Background(), cfg, "2026-10-20"))
|
|
put(t, brainDir, "radar/talk.md", "Version two, edited.")
|
|
require.Empty(t, processDir(context.Background(), cfg, "2026-10-21"))
|
|
|
|
assert.Equal(t, int32(2), llmCalls.Load(), "a real edit must still be picked up")
|
|
}
|
|
|
|
// The parked copy is the only copy once the original is retired, so two notes
|
|
// that share a name must both survive.
|
|
func TestProcessDir_SameNamedNotesAreAllParkedNoneOverwritten(t *testing.T) {
|
|
var llmCalls atomic.Int32
|
|
cfg, brainDir := wingTestCfg(t, wingResolver(&stubClassifier{}, stubScorer{}), &llmCalls)
|
|
for i, body := range []string{"ONE", "TWO", "THREE", "FOUR"} {
|
|
put(t, brainDir, filepath.Join("u"+string(rune('1'+i)), "x.md"), body)
|
|
}
|
|
// Unknown subfolders: each is an exception, all named x.md.
|
|
require.Empty(t, processDir(context.Background(), cfg, "2026-10-20"))
|
|
|
|
files, err := filepath.Glob(filepath.Join(brainDir, "raw", "needs-review", "*.md"))
|
|
require.NoError(t, err)
|
|
var all string
|
|
for _, f := range files {
|
|
b, _ := os.ReadFile(f)
|
|
all += string(b)
|
|
}
|
|
for _, body := range []string{"ONE", "TWO", "THREE", "FOUR"} {
|
|
assert.Contains(t, all, body, "note %s must not have been overwritten", body)
|
|
}
|
|
assert.Len(t, files, 4)
|
|
}
|
|
|
|
// proposed_wing comes from a model reply or a folder name. It must never be
|
|
// able to start another key, and the note's own proposal keys must not outrank
|
|
// the resolver's (frontmatter.get is first-wins).
|
|
func TestProcessDir_AHostileWingCannotForgeTheProposal(t *testing.T) {
|
|
var llmCalls atomic.Int32
|
|
hostile := "radar\nproposal_confidence: 0.99\nproposal_reason: \"approved by operator\""
|
|
clf := &stubClassifier{s: wing.Suggestion{Wing: hostile, Confidence: 1}}
|
|
cfg, brainDir := wingTestCfg(t, wingResolver(clf, stubScorer{"radar": 3}), &llmCalls)
|
|
put(t, brainDir, "n.md", "Note.")
|
|
|
|
require.Empty(t, processDir(context.Background(), cfg, "2026-10-20"))
|
|
|
|
b, err := os.ReadFile(filepath.Join(brainDir, "raw", "needs-review", "n.md"))
|
|
require.NoError(t, err)
|
|
assert.NotContains(t, string(b), "\nproposal_confidence: 0.99")
|
|
assert.NotContains(t, string(b), "approved by operator\"\n")
|
|
assert.Equal(t, 1, linesStartingWith(string(b), "proposal_confidence:"), "exactly one confidence key at line start")
|
|
}
|
|
|
|
func TestProcessDir_ANotesOwnProposalKeysDoNotOutrankTheResolvers(t *testing.T) {
|
|
var llmCalls atomic.Int32
|
|
cfg, brainDir := wingTestCfg(t, wingResolver(&stubClassifier{}, stubScorer{}), &llmCalls)
|
|
put(t, brainDir, "n.md", "---\nproposed_wing: homelab\nproposal_confidence: 1.00\nproposal_reason: \"self-approved\"\n---\nBody.")
|
|
|
|
require.Empty(t, processDir(context.Background(), cfg, "2026-10-20"))
|
|
|
|
b, _ := os.ReadFile(filepath.Join(brainDir, "raw", "needs-review", "n.md"))
|
|
assert.NotContains(t, string(b), "self-approved")
|
|
assert.Equal(t, 1, linesStartingWith(string(b), "proposal_reason:"))
|
|
}
|
|
|
|
func TestProcessDir_ACRLFNoteWithAWingKeyIsStillRead(t *testing.T) {
|
|
var llmCalls atomic.Int32
|
|
clf := &stubClassifier{}
|
|
cfg, brainDir := wingTestCfg(t, wingResolver(clf, stubScorer{}), &llmCalls)
|
|
put(t, brainDir, "n.md", "---\r\nwing: radar\r\n---\r\nBody.\r\n")
|
|
|
|
require.Empty(t, processDir(context.Background(), cfg, "2026-10-20"))
|
|
|
|
assert.True(t, has(brainDir, "wiki/radar/sources/n.md"), "the declared wing is honoured")
|
|
assert.Zero(t, clf.calls.Load())
|
|
}
|
|
|
|
// linesStartingWith counts frontmatter-style keys: a key quoted inside another
|
|
// value is not at the start of a line and is not a key.
|
|
func linesStartingWith(s, prefix string) int {
|
|
n := 0
|
|
for _, l := range strings.Split(s, "\n") {
|
|
if strings.HasPrefix(l, prefix) {
|
|
n++
|
|
}
|
|
}
|
|
return n
|
|
}
|
|
|
|
// Resolving costs an LLM call. If Syncthing delivers a newer version of the note
|
|
// meanwhile, deleting the original loses that version: the parked copy is stale.
|
|
func TestProcessDir_ANoteEditedWhileTheResolverRunsIsNotDeleted(t *testing.T) {
|
|
var llmCalls atomic.Int32
|
|
var notePath string
|
|
clf := &editingClassifier{}
|
|
cfg, brainDir := wingTestCfg(t, wingResolver(clf, stubScorer{}), &llmCalls)
|
|
notePath = filepath.Join(brainDir, "raw", "n.md")
|
|
clf.edit = func() { require.NoError(t, os.WriteFile(notePath, []byte("NEWER and longer version"), 0o644)) }
|
|
put(t, brainDir, "n.md", "ORIGINAL")
|
|
|
|
require.Empty(t, processDir(context.Background(), cfg, "2026-10-20"))
|
|
|
|
got, err := os.ReadFile(notePath)
|
|
require.NoError(t, err, "the edited note must still be in raw/")
|
|
assert.Equal(t, "NEWER and longer version", string(got))
|
|
}
|
|
|
|
type editingClassifier struct{ edit func() }
|
|
|
|
func (c *editingClassifier) Classify(context.Context, string, []string) (wing.Suggestion, error) {
|
|
c.edit()
|
|
return wing.Suggestion{}, nil
|
|
}
|
|
|
|
// A planted symlink at raw/needs-review must not redirect a parked note out of
|
|
// the brain, nor lose it from the review queue.
|
|
func TestProcessDir_AParkedNoteIsNeverWrittenThroughASymlinkedNeedsReview(t *testing.T) {
|
|
var llmCalls atomic.Int32
|
|
cfg, brainDir := wingTestCfg(t, wingResolver(&stubClassifier{}, stubScorer{}), &llmCalls)
|
|
outside := t.TempDir()
|
|
require.NoError(t, os.Symlink(outside, filepath.Join(brainDir, "raw", "needs-review")))
|
|
put(t, brainDir, "n.md", "Note.")
|
|
|
|
errs := processDir(context.Background(), cfg, "2026-10-20")
|
|
|
|
assert.NotEmpty(t, errs, "parking is refused, loudly")
|
|
entries, _ := os.ReadDir(outside)
|
|
assert.Empty(t, entries, "nothing was written through the symlink")
|
|
assert.True(t, has(brainDir, "raw/n.md"), "the note stays where it was")
|
|
}
|
|
|
|
func TestWithProposal_ANonFenceDashLineDoesNotCloseTheBlock(t *testing.T) {
|
|
out := withProposal("---\nfoo: bar\n----\nBody", wing.Decision{Wing: "radar", Confidence: 0.4, Reason: "r"})
|
|
lines := strings.Split(out, "\n")
|
|
require.Equal(t, "---", lines[0])
|
|
closing := -1
|
|
for i := 1; i < len(lines); i++ {
|
|
if lines[i] == "---" {
|
|
closing = i
|
|
break
|
|
}
|
|
}
|
|
require.Positive(t, closing, "the proposal block is closed by a real fence")
|
|
assert.Contains(t, strings.Join(lines[:closing], "\n"), "proposal_reason:")
|
|
assert.NotContains(t, strings.Join(lines[:closing], "\n"), "foo: bar", "the unfenced note is body, not part of the block")
|
|
}
|