Compare commits
6
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
87fa28e2c8 | ||
|
|
9eb3d2456d | ||
|
|
57d0fb0fae | ||
|
|
27a01dd2af | ||
|
|
eb77305580 | ||
|
|
c986df6799 |
@@ -8,6 +8,7 @@ import (
|
|||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
|
"sync"
|
||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"syscall"
|
"syscall"
|
||||||
"testing"
|
"testing"
|
||||||
@@ -25,6 +26,18 @@ import (
|
|||||||
|
|
||||||
const raceSentinel = "SENTINEL-153-RACE"
|
const raceSentinel = "SENTINEL-153-RACE"
|
||||||
|
|
||||||
|
// startSwapper runs fn until the test ends, and waits for it to exit before
|
||||||
|
// t.TempDir's cleanup removes the directory it writes into (hyperguild#162:
|
||||||
|
// an unawaited swapper raced the cleanup, "directory not empty").
|
||||||
|
func startSwapper(t *testing.T, fn func(stop *atomic.Bool)) {
|
||||||
|
t.Helper()
|
||||||
|
var stop atomic.Bool
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
wg.Add(1)
|
||||||
|
go func() { defer wg.Done(); fn(&stop) }()
|
||||||
|
t.Cleanup(func() { stop.Store(true); wg.Wait() })
|
||||||
|
}
|
||||||
|
|
||||||
func swap(raw, outside string, fifo bool, stop *atomic.Bool) {
|
func swap(raw, outside string, fifo bool, stop *atomic.Bool) {
|
||||||
tgt := filepath.Join(raw, "r.md")
|
tgt := filepath.Join(raw, "r.md")
|
||||||
for i := 0; !stop.Load(); i++ {
|
for i := 0; !stop.Load(); i++ {
|
||||||
@@ -76,9 +89,7 @@ func readers(brain, raw string) string {
|
|||||||
|
|
||||||
func TestRawReadersLeakNothingUnderASymlinkSwapRace(t *testing.T) {
|
func TestRawReadersLeakNothingUnderASymlinkSwapRace(t *testing.T) {
|
||||||
brain, raw, outside := raceBrain(t)
|
brain, raw, outside := raceBrain(t)
|
||||||
var stop atomic.Bool
|
startSwapper(t, func(stop *atomic.Bool) { swap(raw, outside, false, stop) })
|
||||||
go swap(raw, outside, false, &stop)
|
|
||||||
defer stop.Store(true)
|
|
||||||
leaks, iters := 0, 0
|
leaks, iters := 0, 0
|
||||||
for deadline := time.Now().Add(1500 * time.Millisecond); time.Now().Before(deadline); iters++ {
|
for deadline := time.Now().Add(1500 * time.Millisecond); time.Now().Before(deadline); iters++ {
|
||||||
leaks += strings.Count(readers(brain, raw), raceSentinel)
|
leaks += strings.Count(readers(brain, raw), raceSentinel)
|
||||||
@@ -91,8 +102,7 @@ func TestRawReadersLeakNothingUnderASymlinkSwapRace(t *testing.T) {
|
|||||||
|
|
||||||
func TestRawReadersDoNotHangUnderAFIFOSwapRace(t *testing.T) {
|
func TestRawReadersDoNotHangUnderAFIFOSwapRace(t *testing.T) {
|
||||||
brain, raw, outside := raceBrain(t)
|
brain, raw, outside := raceBrain(t)
|
||||||
var stop atomic.Bool
|
startSwapper(t, func(stop *atomic.Bool) { swap(raw, outside, true, stop) })
|
||||||
go swap(raw, outside, true, &stop)
|
|
||||||
var iters atomic.Int64
|
var iters atomic.Int64
|
||||||
done := make(chan struct{})
|
done := make(chan struct{})
|
||||||
go func() {
|
go func() {
|
||||||
@@ -104,9 +114,7 @@ func TestRawReadersDoNotHangUnderAFIFOSwapRace(t *testing.T) {
|
|||||||
}()
|
}()
|
||||||
select {
|
select {
|
||||||
case <-done:
|
case <-done:
|
||||||
stop.Store(true)
|
|
||||||
case <-time.After(6 * time.Second):
|
case <-time.After(6 * time.Second):
|
||||||
stop.Store(true)
|
|
||||||
// Unblock the stuck open so the test process can exit.
|
// Unblock the stuck open so the test process can exit.
|
||||||
if f, err := os.OpenFile(filepath.Join(raw, "r.md"), os.O_WRONLY|syscall.O_NONBLOCK, 0); err == nil {
|
if f, err := os.OpenFile(filepath.Join(raw, "r.md"), os.O_WRONLY|syscall.O_NONBLOCK, 0); err == nil {
|
||||||
_ = f.Close()
|
_ = f.Close()
|
||||||
@@ -147,8 +155,7 @@ func TestDocmarkExtractionLeaksNothingUnderASymlinkSwapRace(t *testing.T) {
|
|||||||
if err := os.WriteFile(tgt, []byte("inside docx bytes"), 0o644); err != nil {
|
if err := os.WriteFile(tgt, []byte("inside docx bytes"), 0o644); err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
var stop atomic.Bool
|
startSwapper(t, func(stop *atomic.Bool) {
|
||||||
go func() {
|
|
||||||
for i := 0; !stop.Load(); i++ {
|
for i := 0; !stop.Load(); i++ {
|
||||||
tmp := filepath.Join(raw, ".swapdocx")
|
tmp := filepath.Join(raw, ".swapdocx")
|
||||||
_ = os.Remove(tmp)
|
_ = os.Remove(tmp)
|
||||||
@@ -159,8 +166,7 @@ func TestDocmarkExtractionLeaksNothingUnderASymlinkSwapRace(t *testing.T) {
|
|||||||
}
|
}
|
||||||
_ = os.Rename(tmp, tgt)
|
_ = os.Rename(tmp, tgt)
|
||||||
}
|
}
|
||||||
}()
|
})
|
||||||
defer stop.Store(true)
|
|
||||||
iters := 0
|
iters := 0
|
||||||
for deadline := time.Now().Add(1500 * time.Millisecond); time.Now().Before(deadline); iters++ {
|
for deadline := time.Now().Add(1500 * time.Millisecond); time.Now().Before(deadline); iters++ {
|
||||||
_, _ = api.ReadIngestFile(brain, tgt)
|
_, _ = api.ReadIngestFile(brain, tgt)
|
||||||
|
|||||||
@@ -0,0 +1,43 @@
|
|||||||
|
package api_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/api"
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs/brainfstest"
|
||||||
|
)
|
||||||
|
|
||||||
|
// hyperguild#157 slice 2: ReadNote (brain_get, read-after-write) read by
|
||||||
|
// path; it now reads through brainfs.
|
||||||
|
func TestReadNoteRefusesSymlinksAndSurvivesSwapRaces(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
facts := filepath.Join(brain, "wiki", "w", "facts")
|
||||||
|
require.NoError(t, os.MkdirAll(facts, 0o755))
|
||||||
|
require.NoError(t, os.Symlink(brainfstest.Outside(t), filepath.Join(facts, "leak.md")))
|
||||||
|
_, body, _, err := api.ReadNote(brain, "wiki/w/facts/leak.md")
|
||||||
|
assert.Error(t, err)
|
||||||
|
assert.NotContains(t, body, brainfstest.Sentinel)
|
||||||
|
|
||||||
|
p := filepath.Join(facts, "r.md")
|
||||||
|
require.NoError(t, os.WriteFile(p, []byte("---\nx: y\n---\ninside"), 0o644))
|
||||||
|
fm, body, _, err := api.ReadNote(brain, "wiki/w/facts/r.md")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "y", fm["x"])
|
||||||
|
assert.Contains(t, body, "inside")
|
||||||
|
read := func() string {
|
||||||
|
fm, body, _, _ := api.ReadNote(brain, "wiki/w/facts/r.md")
|
||||||
|
s := body
|
||||||
|
for k, v := range fm {
|
||||||
|
s += k + v
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
brainfstest.AssertNoLeak(t, p, "---\nx: y\n---\ninside", 1500*time.Millisecond, read)
|
||||||
|
brainfstest.AssertNoHang(t, p, "---\nx: y\n---\ninside", 1500*time.Millisecond, 6*time.Second, func() { _ = read() })
|
||||||
|
}
|
||||||
@@ -3,14 +3,18 @@ package api
|
|||||||
import (
|
import (
|
||||||
"crypto/sha256"
|
"crypto/sha256"
|
||||||
"encoding/hex"
|
"encoding/hex"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"io/fs"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/brain"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brain"
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/claim"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/claim"
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/notes"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ContentHash returns the lowercase hex sha256 of b. It is the note's
|
// ContentHash returns the lowercase hex sha256 of b. It is the note's
|
||||||
@@ -90,14 +94,23 @@ func UpdateNote(brainDir string, opts UpdateNoteOptions) (relPath, contentHash,
|
|||||||
rel = filepath.ToSlash(rel)
|
rel = filepath.ToSlash(rel)
|
||||||
}
|
}
|
||||||
|
|
||||||
rel, abs, err := resolveWithin(brainDir, rel)
|
// The path is caller-supplied (brain_update): resolve it as brain_edit
|
||||||
|
// does, knowledge/ and wiki/ notes only, and read and rewrite it through
|
||||||
|
// the brain root, never through a symlink (hyperguild#169).
|
||||||
|
t, err := notes.Resolve(brainDir, rel, notes.ScopeNotes)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", "", "", err
|
return "", "", "", err
|
||||||
}
|
}
|
||||||
|
rel = t.Rel
|
||||||
prior, err := os.ReadFile(abs)
|
bfs, err := brainfs.Open(brainDir)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if os.IsNotExist(err) {
|
return "", "", "", fmt.Errorf("open brain: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = bfs.Close() }()
|
||||||
|
|
||||||
|
prior, err := bfs.ReadRegular(rel)
|
||||||
|
if err != nil {
|
||||||
|
if errors.Is(err, fs.ErrNotExist) {
|
||||||
return "", "", "", fmt.Errorf("note %q does not exist: use brain_write to create", rel)
|
return "", "", "", fmt.Errorf("note %q does not exist: use brain_write to create", rel)
|
||||||
}
|
}
|
||||||
return "", "", "", fmt.Errorf("read target: %w", err)
|
return "", "", "", fmt.Errorf("read target: %w", err)
|
||||||
@@ -163,7 +176,7 @@ func UpdateNote(brainDir string, opts UpdateNoteOptions) (relPath, contentHash,
|
|||||||
return "", "", "", err
|
return "", "", "", err
|
||||||
}
|
}
|
||||||
out := []byte(stamped)
|
out := []byte(stamped)
|
||||||
if err := os.WriteFile(abs, out, 0o644); err != nil {
|
if err := bfs.WriteRegular(rel, out); err != nil {
|
||||||
return "", "", "", fmt.Errorf("write: %w", err)
|
return "", "", "", fmt.Errorf("write: %w", err)
|
||||||
}
|
}
|
||||||
return rel, ContentHash(out), priorHash, nil
|
return rel, ContentHash(out), priorHash, nil
|
||||||
@@ -174,11 +187,17 @@ func UpdateNote(brainDir string, opts UpdateNoteOptions) (relPath, contentHash,
|
|||||||
// write primitive behind brain_get: the hash it returns equals the hash
|
// write primitive behind brain_get: the hash it returns equals the hash
|
||||||
// brain_write / brain_update returned for the same bytes.
|
// brain_write / brain_update returned for the same bytes.
|
||||||
func ReadNote(brainDir, relPath string) (fm map[string]string, body, contentHash string, err error) {
|
func ReadNote(brainDir, relPath string) (fm map[string]string, body, contentHash string, err error) {
|
||||||
_, abs, err := resolveWithin(brainDir, relPath)
|
rel, _, err := resolveWithin(brainDir, relPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, "", "", err
|
return nil, "", "", err
|
||||||
}
|
}
|
||||||
raw, err := os.ReadFile(abs)
|
// Through the brain root, regular files only (hyperguild#157).
|
||||||
|
bfs, err := brainfs.Open(brainDir)
|
||||||
|
if err != nil {
|
||||||
|
return nil, "", "", fmt.Errorf("read note: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = bfs.Close() }()
|
||||||
|
raw, err := bfs.ReadRegular(rel)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if os.IsNotExist(err) {
|
if os.IsNotExist(err) {
|
||||||
return nil, "", "", fmt.Errorf("note %q does not exist", relPath)
|
return nil, "", "", fmt.Errorf("note %q does not exist", relPath)
|
||||||
|
|||||||
@@ -0,0 +1,112 @@
|
|||||||
|
package api_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/api"
|
||||||
|
)
|
||||||
|
|
||||||
|
// brain_update passed the caller's path through resolveWithin, a lexical
|
||||||
|
// containment check only: any file in the brain could be superseded
|
||||||
|
// (classification.yaml, raw/, sessions/), and a final symlink was written
|
||||||
|
// through. It now resolves like brain_edit: knowledge/ and wiki/ notes only,
|
||||||
|
// read and rewritten through the brain root.
|
||||||
|
func TestUpdateNoteRefusesPathsOutsideKnowledgeAndWikiNotes(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
files := map[string]string{
|
||||||
|
"classification.yaml": "levels: {}\n",
|
||||||
|
"raw/r.md": "raw\n",
|
||||||
|
"sessions/s.jsonl": "{}\n",
|
||||||
|
"wiki/w/facts/ok.md": "---\ntitle: ok\n---\nold\n",
|
||||||
|
"knowledge/k.md": "---\ntitle: k\n---\nold\n",
|
||||||
|
"wiki/w/facts/x.txt": "txt\n",
|
||||||
|
}
|
||||||
|
for rel, body := range files {
|
||||||
|
p := filepath.Join(brain, filepath.FromSlash(rel))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(p), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(p, []byte(body), 0o644))
|
||||||
|
}
|
||||||
|
for _, rel := range []string{"classification.yaml", "raw/r.md", "sessions/s.jsonl", "wiki/w/facts/x.txt", "wiki/w/../../raw/r.md"} {
|
||||||
|
_, _, _, err := api.UpdateNote(brain, api.UpdateNoteOptions{Path: rel, Content: "replaced"})
|
||||||
|
assert.Error(t, err, rel)
|
||||||
|
}
|
||||||
|
for rel, body := range files {
|
||||||
|
if rel == "wiki/w/facts/ok.md" || rel == "knowledge/k.md" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
got, err := os.ReadFile(filepath.Join(brain, filepath.FromSlash(rel)))
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, body, string(got), rel)
|
||||||
|
}
|
||||||
|
for _, rel := range []string{"wiki/w/facts/ok.md", "knowledge/k.md"} {
|
||||||
|
_, _, _, err := api.UpdateNote(brain, api.UpdateNoteOptions{Path: rel, Content: "new body"})
|
||||||
|
require.NoError(t, err, "positive control: %s", rel)
|
||||||
|
got, _ := os.ReadFile(filepath.Join(brain, filepath.FromSlash(rel)))
|
||||||
|
assert.Contains(t, string(got), "new body")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUpdateNoteDoesNotWriteThroughASymlinkedNote(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
facts := filepath.Join(brain, "wiki", "w", "facts")
|
||||||
|
require.NoError(t, os.MkdirAll(facts, 0o755))
|
||||||
|
victim := filepath.Join(brain, "raw", "victim.md")
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(victim), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(victim, []byte("untouched\n"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "..", "raw", "victim.md"), filepath.Join(facts, "l.md")))
|
||||||
|
_, _, _, err := api.UpdateNote(brain, api.UpdateNoteOptions{Path: "wiki/w/facts/l.md", Content: "replaced"})
|
||||||
|
assert.Error(t, err)
|
||||||
|
got, _ := os.ReadFile(victim)
|
||||||
|
assert.Equal(t, "untouched\n", string(got))
|
||||||
|
}
|
||||||
|
|
||||||
|
// The note is swapped between a regular file and an in-brain symlink to a
|
||||||
|
// raw/ file while UpdateNote runs: the read and the write each refuse a
|
||||||
|
// symlink, so the raw/ file is never rewritten.
|
||||||
|
func TestUpdateNoteNeverRewritesASymlinkSwappedInForTheNote(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
facts := filepath.Join(brain, "wiki", "w", "facts")
|
||||||
|
require.NoError(t, os.MkdirAll(facts, 0o755))
|
||||||
|
victim := filepath.Join(brain, "raw", "victim.md")
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(victim), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(victim, []byte("untouched\n"), 0o644))
|
||||||
|
note := filepath.Join(facts, "n.md")
|
||||||
|
body := "---\ntitle: n\n---\nold\n"
|
||||||
|
require.NoError(t, os.WriteFile(note, []byte(body), 0o644))
|
||||||
|
|
||||||
|
var stop atomic.Bool
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
wg.Add(1)
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
tmp := note + ".swap"
|
||||||
|
for i := 0; !stop.Load(); i++ {
|
||||||
|
_ = os.Remove(tmp)
|
||||||
|
if i%2 == 0 {
|
||||||
|
_ = os.WriteFile(tmp, []byte(body), 0o644)
|
||||||
|
} else {
|
||||||
|
_ = os.Symlink(filepath.Join("..", "..", "..", "raw", "victim.md"), tmp)
|
||||||
|
}
|
||||||
|
_ = os.Rename(tmp, note)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
ok := 0
|
||||||
|
for deadline := time.Now().Add(1500 * time.Millisecond); time.Now().Before(deadline); {
|
||||||
|
if _, _, _, err := api.UpdateNote(brain, api.UpdateNoteOptions{Path: "wiki/w/facts/n.md", Content: "new"}); err == nil {
|
||||||
|
ok++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
stop.Store(true)
|
||||||
|
wg.Wait()
|
||||||
|
got, _ := os.ReadFile(victim)
|
||||||
|
assert.Equal(t, "untouched\n", string(got))
|
||||||
|
assert.Positive(t, ok, "positive control: some updates reach the regular note")
|
||||||
|
}
|
||||||
@@ -49,7 +49,19 @@ func (n *NtfyNotifier) Notify(ctx context.Context, msg string) error {
|
|||||||
}
|
}
|
||||||
defer func() { _ = resp.Body.Close() }()
|
defer func() { _ = resp.Body.Close() }()
|
||||||
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
if resp.StatusCode < 200 || resp.StatusCode >= 300 {
|
||||||
return fmt.Errorf("ntfy notify: status %d", resp.StatusCode)
|
return &RejectedError{Status: resp.StatusCode}
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// RejectedError is a non-2xx ntfy response.
|
||||||
|
type RejectedError struct{ Status int }
|
||||||
|
|
||||||
|
func (e *RejectedError) Error() string { return fmt.Sprintf("ntfy notify: status %d", e.Status) }
|
||||||
|
|
||||||
|
// Permanent reports whether resending the same message cannot succeed: a 4xx
|
||||||
|
// other than 429 (rate limited). Callers may drop such a message; anything
|
||||||
|
// else (5xx, 429, transport errors) is an outage and must be retried.
|
||||||
|
func (e *RejectedError) Permanent() bool {
|
||||||
|
return e.Status >= 400 && e.Status < 500 && e.Status != http.StatusTooManyRequests
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,27 @@
|
|||||||
|
package audit
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// A non-2xx ntfy response is a *RejectedError, and only a client-side refusal
|
||||||
|
// other than rate limiting is permanent: callers may drop a message on a
|
||||||
|
// permanent rejection and must retry the rest (hyperguild#157, PR #160).
|
||||||
|
func TestNotifyClassifiesRejectionsAsPermanentOrNot(t *testing.T) {
|
||||||
|
for status, permanent := range map[int]bool{413: true, 400: true, 403: true, 429: false, 500: false, 503: false} {
|
||||||
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { w.WriteHeader(status) }))
|
||||||
|
err := NewNtfyNotifier(srv.URL, "").Notify(context.Background(), "m")
|
||||||
|
srv.Close()
|
||||||
|
var rej *RejectedError
|
||||||
|
require.True(t, errors.As(err, &rej), "status %d: %v", status, err)
|
||||||
|
assert.Equal(t, status, rej.Status)
|
||||||
|
assert.Equal(t, permanent, rej.Permanent(), "status %d", status)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -4,9 +4,12 @@ import (
|
|||||||
"bufio"
|
"bufio"
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
|
"path"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
||||||
)
|
)
|
||||||
|
|
||||||
// seeAlsoHeader is the markdown heading used to group cross-wing links.
|
// seeAlsoHeader is the markdown heading used to group cross-wing links.
|
||||||
@@ -197,6 +200,12 @@ func fileExists(p string) bool {
|
|||||||
// section headers. Rejects same-wing pairs (a tunnel is by definition
|
// section headers. Rejects same-wing pairs (a tunnel is by definition
|
||||||
// cross-wing) and missing notes.
|
// cross-wing) and missing notes.
|
||||||
func WriteTunnel(brainDir, sourcePath, targetPath string) error {
|
func WriteTunnel(brainDir, sourcePath, targetPath string) error {
|
||||||
|
if err := checkNotePath(sourcePath); err != nil {
|
||||||
|
return fmt.Errorf("source: %w", err)
|
||||||
|
}
|
||||||
|
if err := checkNotePath(targetPath); err != nil {
|
||||||
|
return fmt.Errorf("target: %w", err)
|
||||||
|
}
|
||||||
srcWing, err := wingOf(sourcePath)
|
srcWing, err := wingOf(sourcePath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("source: %w", err)
|
return fmt.Errorf("source: %w", err)
|
||||||
@@ -209,20 +218,50 @@ func WriteTunnel(brainDir, sourcePath, targetPath string) error {
|
|||||||
return fmt.Errorf("tunnel must cross wings; got both in %q", srcWing)
|
return fmt.Errorf("tunnel must cross wings; got both in %q", srcWing)
|
||||||
}
|
}
|
||||||
|
|
||||||
srcFull := filepath.Join(brainDir, filepath.FromSlash(sourcePath))
|
// Both notes are read and rewritten through the brain root, regular
|
||||||
tgtFull := filepath.Join(brainDir, filepath.FromSlash(targetPath))
|
// files only: brain_tunnel passes caller-supplied paths, and the brain is
|
||||||
if _, err := os.Stat(srcFull); err != nil {
|
// a Syncthing folder that can hold symlinks.
|
||||||
|
bfs, err := brainfs.Open(brainDir)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("open brain: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = bfs.Close() }()
|
||||||
|
srcContent, err := bfs.ReadRegular(sourcePath)
|
||||||
|
if err != nil {
|
||||||
return fmt.Errorf("source note: %w", err)
|
return fmt.Errorf("source note: %w", err)
|
||||||
}
|
}
|
||||||
if _, err := os.Stat(tgtFull); err != nil {
|
tgtContent, err := bfs.ReadRegular(targetPath)
|
||||||
|
if err != nil {
|
||||||
return fmt.Errorf("target note: %w", err)
|
return fmt.Errorf("target note: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := appendSeeAlso(srcFull, wikilinkOf(targetPath)); err != nil {
|
if out, changed, err := withSeeAlso(srcContent, wikilinkOf(targetPath)); err != nil {
|
||||||
|
return fmt.Errorf("update source: %w", err)
|
||||||
|
} else if changed {
|
||||||
|
if err := bfs.WriteRegular(sourcePath, out); err != nil {
|
||||||
return fmt.Errorf("update source: %w", err)
|
return fmt.Errorf("update source: %w", err)
|
||||||
}
|
}
|
||||||
if err := appendSeeAlso(tgtFull, wikilinkOf(sourcePath)); err != nil {
|
}
|
||||||
|
if out, changed, err := withSeeAlso(tgtContent, wikilinkOf(sourcePath)); err != nil {
|
||||||
return fmt.Errorf("update target: %w", err)
|
return fmt.Errorf("update target: %w", err)
|
||||||
|
} else if changed {
|
||||||
|
if err := bfs.WriteRegular(targetPath, out); err != nil {
|
||||||
|
return fmt.Errorf("update target: %w", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// checkNotePath accepts only a clean, local wiki/<wing>/<hall>/.../<slug>.md
|
||||||
|
// path: no "." or ".." segments, no empty segments, no leading slash.
|
||||||
|
func checkNotePath(p string) error {
|
||||||
|
if p == "" || path.Clean(p) != p || !filepath.IsLocal(p) || !strings.HasSuffix(p, ".md") {
|
||||||
|
return fmt.Errorf("not a clean wiki note path: %q", p)
|
||||||
|
}
|
||||||
|
for _, part := range strings.Split(p, "/") {
|
||||||
|
if part == "" || part == "." || part == ".." {
|
||||||
|
return fmt.Errorf("not a clean wiki note path: %q", p)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -248,16 +287,13 @@ func wingOf(relPath string) (string, error) {
|
|||||||
return parts[1], nil
|
return parts[1], nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// appendSeeAlso inserts `- [[link]]` under the file's See also section,
|
// withSeeAlso returns content with `- [[link]]` under its See also section,
|
||||||
// creating the section if absent. No-op when the link is already present.
|
// creating the section if absent. changed is false when the link is already
|
||||||
func appendSeeAlso(filePath, link string) error {
|
// present.
|
||||||
content, err := os.ReadFile(filePath)
|
func withSeeAlso(content []byte, link string) (out []byte, changed bool, err error) {
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
wikilink := "[[" + link + "]]"
|
wikilink := "[[" + link + "]]"
|
||||||
if strings.Contains(string(content), wikilink) {
|
if strings.Contains(string(content), wikilink) {
|
||||||
return nil
|
return content, false, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
bullet := "- " + wikilink
|
bullet := "- " + wikilink
|
||||||
@@ -266,8 +302,7 @@ func appendSeeAlso(filePath, link string) error {
|
|||||||
// No section yet — append a fresh one. Always emit a trailing
|
// No section yet — append a fresh one. Always emit a trailing
|
||||||
// newline so subsequent appends don't merge into the previous line.
|
// newline so subsequent appends don't merge into the previous line.
|
||||||
trimmed := strings.TrimRight(string(content), "\n")
|
trimmed := strings.TrimRight(string(content), "\n")
|
||||||
out := trimmed + "\n\n" + seeAlsoHeader + "\n\n" + bullet + "\n"
|
return []byte(trimmed + "\n\n" + seeAlsoHeader + "\n\n" + bullet + "\n"), true, nil
|
||||||
return os.WriteFile(filePath, []byte(out), 0o644)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Section exists — splice the bullet in just before the next `## `
|
// Section exists — splice the bullet in just before the next `## `
|
||||||
@@ -293,12 +328,11 @@ func appendSeeAlso(filePath, link string) error {
|
|||||||
b.WriteByte('\n')
|
b.WriteByte('\n')
|
||||||
}
|
}
|
||||||
if err := scanner.Err(); err != nil {
|
if err := scanner.Err(); err != nil {
|
||||||
return err
|
return nil, false, err
|
||||||
}
|
}
|
||||||
if !inserted {
|
if !inserted {
|
||||||
// section was the last thing in the file — just append bullet
|
// section was the last thing in the file — just append bullet
|
||||||
out := strings.TrimRight(b.String(), "\n") + "\n" + bullet + "\n"
|
return []byte(strings.TrimRight(b.String(), "\n") + "\n" + bullet + "\n"), true, nil
|
||||||
return os.WriteFile(filePath, []byte(out), 0o644)
|
|
||||||
}
|
}
|
||||||
return os.WriteFile(filePath, []byte(b.String()), 0o644)
|
return []byte(b.String()), true, nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,141 @@
|
|||||||
|
package brain_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brain"
|
||||||
|
)
|
||||||
|
|
||||||
|
// brain_tunnel passes caller-supplied source and target paths to WriteTunnel,
|
||||||
|
// which checked only "wiki/<wing>/..." and then joined them onto the brain
|
||||||
|
// dir: ".." segments resolved outside the brain and appendSeeAlso rewrote the
|
||||||
|
// file there.
|
||||||
|
func TestWriteTunnelRefusesATargetThatTraversesOutOfTheBrain(t *testing.T) {
|
||||||
|
brain0 := t.TempDir()
|
||||||
|
src := filepath.Join(brain0, "wiki", "a", "facts", "s.md")
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(src), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(src, []byte("---\ntitle: S\n---\nbody\n"), 0o644))
|
||||||
|
victim := filepath.Join(t.TempDir(), "victim.md")
|
||||||
|
require.NoError(t, os.WriteFile(victim, []byte("untouched\n"), 0o644))
|
||||||
|
|
||||||
|
up := strings.Repeat("../", strings.Count(filepath.Clean(brain0), "/")+3)
|
||||||
|
target := "wiki/b/x/" + up + strings.TrimPrefix(victim, "/")
|
||||||
|
err := brain.WriteTunnel(brain0, "wiki/a/facts/s.md", target)
|
||||||
|
assert.Error(t, err)
|
||||||
|
got, rerr := os.ReadFile(victim)
|
||||||
|
require.NoError(t, rerr)
|
||||||
|
assert.Equal(t, "untouched\n", string(got), "a file outside the brain was modified")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWriteTunnelRefusesUncleanOrNonWikiPaths(t *testing.T) {
|
||||||
|
brain0 := t.TempDir()
|
||||||
|
for _, p := range []string{"wiki/a/facts/s.md", "wiki/b/facts/t.md", "wiki/b/facts/t.txt", "raw/r.md"} {
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(filepath.Join(brain0, p)), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(brain0, p), []byte("x\n"), 0o644))
|
||||||
|
}
|
||||||
|
for _, target := range []string{
|
||||||
|
"wiki/b/facts/../../../raw/r.md",
|
||||||
|
"wiki/b/./facts/t.md",
|
||||||
|
"wiki/b//facts/t.md",
|
||||||
|
"/wiki/b/facts/t.md",
|
||||||
|
"wiki/b/facts/t.txt",
|
||||||
|
"wiki/b/facts/",
|
||||||
|
} {
|
||||||
|
assert.Error(t, brain.WriteTunnel(brain0, "wiki/a/facts/s.md", target), target)
|
||||||
|
}
|
||||||
|
for _, p := range []string{"raw/r.md", "wiki/b/facts/t.txt"} {
|
||||||
|
got, err := os.ReadFile(filepath.Join(brain0, p))
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "x\n", string(got), p)
|
||||||
|
}
|
||||||
|
require.NoError(t, brain.WriteTunnel(brain0, "wiki/a/facts/s.md", "wiki/b/facts/t.md"), "positive control")
|
||||||
|
got, err := os.ReadFile(filepath.Join(brain0, "wiki", "b", "facts", "t.md"))
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Contains(t, string(got), "[[a/facts/s]]")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWriteTunnelDoesNotWriteThroughASymlinkedNote(t *testing.T) {
|
||||||
|
brain0 := t.TempDir()
|
||||||
|
src := filepath.Join(brain0, "wiki", "a", "facts", "s.md")
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(src), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(src, []byte("x\n"), 0o644))
|
||||||
|
tdir := filepath.Join(brain0, "wiki", "b", "facts")
|
||||||
|
require.NoError(t, os.MkdirAll(tdir, 0o755))
|
||||||
|
victim := filepath.Join(t.TempDir(), "victim.md")
|
||||||
|
require.NoError(t, os.WriteFile(victim, []byte("untouched\n"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(victim, filepath.Join(tdir, "t.md")))
|
||||||
|
assert.Error(t, brain.WriteTunnel(brain0, "wiki/a/facts/s.md", "wiki/b/facts/t.md"))
|
||||||
|
got, err := os.ReadFile(victim)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "untouched\n", string(got))
|
||||||
|
|
||||||
|
// The same with a link to a file elsewhere in the brain, which os.Root
|
||||||
|
// would follow.
|
||||||
|
inVictim := filepath.Join(brain0, "raw", "v.md")
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(inVictim), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(inVictim, []byte("untouched\n"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "..", "raw", "v.md"), filepath.Join(tdir, "u.md")))
|
||||||
|
assert.Error(t, brain.WriteTunnel(brain0, "wiki/a/facts/s.md", "wiki/b/facts/u.md"))
|
||||||
|
got, err = os.ReadFile(inVictim)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "untouched\n", string(got))
|
||||||
|
got, err = os.ReadFile(src)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "x\n", string(got), "the source is not touched when the target is refused")
|
||||||
|
}
|
||||||
|
|
||||||
|
// The target is swapped between a regular note and a symlink to an in-brain
|
||||||
|
// file outside wiki/ while WriteTunnel runs: the read and the write each
|
||||||
|
// refuse a symlink, so the other file is never rewritten.
|
||||||
|
func TestWriteTunnelNeverRewritesASymlinkSwappedInForTheTarget(t *testing.T) {
|
||||||
|
brain0 := t.TempDir()
|
||||||
|
src := filepath.Join(brain0, "wiki", "a", "facts", "s.md")
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(src), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(src, []byte("x\n"), 0o644))
|
||||||
|
tdir := filepath.Join(brain0, "wiki", "b", "facts")
|
||||||
|
require.NoError(t, os.MkdirAll(tdir, 0o755))
|
||||||
|
victim := filepath.Join(brain0, "raw", "victim.md")
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(victim), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(victim, []byte("untouched\n"), 0o644))
|
||||||
|
tgt := filepath.Join(tdir, "t.md")
|
||||||
|
require.NoError(t, os.WriteFile(tgt, []byte("t\n"), 0o644))
|
||||||
|
|
||||||
|
var stop atomic.Bool
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
wg.Add(1)
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
tmp := tgt + ".swap"
|
||||||
|
for i := 0; !stop.Load(); i++ {
|
||||||
|
_ = os.Remove(tmp)
|
||||||
|
if i%2 == 0 {
|
||||||
|
_ = os.WriteFile(tmp, []byte("t\n"), 0o644)
|
||||||
|
} else {
|
||||||
|
_ = os.Symlink(filepath.Join("..", "..", "..", "raw", "victim.md"), tmp)
|
||||||
|
}
|
||||||
|
_ = os.Rename(tmp, tgt)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
ok := 0
|
||||||
|
for deadline := time.Now().Add(1500 * time.Millisecond); time.Now().Before(deadline); {
|
||||||
|
if brain.WriteTunnel(brain0, "wiki/a/facts/s.md", "wiki/b/facts/t.md") == nil {
|
||||||
|
ok++
|
||||||
|
}
|
||||||
|
_ = os.WriteFile(src, []byte("x\n"), 0o644)
|
||||||
|
}
|
||||||
|
stop.Store(true)
|
||||||
|
wg.Wait()
|
||||||
|
got, err := os.ReadFile(victim)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "untouched\n", string(got), "the swapped-in symlink's target was rewritten")
|
||||||
|
assert.Positive(t, ok, "positive control: some tunnels were written to the regular target")
|
||||||
|
}
|
||||||
@@ -13,13 +13,18 @@ import (
|
|||||||
"io"
|
"io"
|
||||||
"io/fs"
|
"io/fs"
|
||||||
"os"
|
"os"
|
||||||
|
"path"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
"syscall"
|
"syscall"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ErrNotRegular is returned for an entry that is not a regular file.
|
// ErrNotRegular is returned for an entry that is not a regular file.
|
||||||
var ErrNotRegular = errors.New("not a regular file")
|
var ErrNotRegular = errors.New("not a regular file")
|
||||||
|
|
||||||
|
// ErrTooLarge is returned by ReadRegularMax for a file over the limit.
|
||||||
|
var ErrTooLarge = errors.New("file too large")
|
||||||
|
|
||||||
// Brain is an open brain directory.
|
// Brain is an open brain directory.
|
||||||
type Brain struct {
|
type Brain struct {
|
||||||
root *os.Root
|
root *os.Root
|
||||||
@@ -50,6 +55,71 @@ func (b *Brain) Rel(path string) (string, error) {
|
|||||||
return filepath.ToSlash(rel), nil
|
return filepath.ToSlash(rel), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Lstat stats a brain-relative path through the root without following a
|
||||||
|
// final symlink.
|
||||||
|
func (b *Brain) Lstat(rel string) (fs.FileInfo, error) {
|
||||||
|
return b.root.Lstat(filepath.ToSlash(rel))
|
||||||
|
}
|
||||||
|
|
||||||
|
// realDir returns ErrNotRegular unless every component of rel is a real
|
||||||
|
// directory. A swap after the check is not caught (accepted residual,
|
||||||
|
// hyperguild#157).
|
||||||
|
func (b *Brain) realDir(rel string) error {
|
||||||
|
if rel == "." {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
prefix := ""
|
||||||
|
for _, part := range strings.Split(rel, "/") {
|
||||||
|
prefix = path.Join(prefix, part)
|
||||||
|
fi, err := b.root.Lstat(prefix)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if !fi.IsDir() {
|
||||||
|
return fmt.Errorf("%s: walk root component %s is not a directory: %w", rel, prefix, ErrNotRegular)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// WriteRegular replaces the contents of an existing regular file at a
|
||||||
|
// brain-relative path. It never creates a file and never writes through a
|
||||||
|
// final symlink: os.Root.OpenFile follows an in-root final symlink even with
|
||||||
|
// O_NOFOLLOW (verified on go1.27), so the path is Lstat-ed through the root
|
||||||
|
// first and the opened handle must be that same file (os.SameFile), which
|
||||||
|
// also catches a swap between the two. O_NONBLOCK keeps a FIFO from blocking
|
||||||
|
// the open. Intermediate in-brain symlinks are still followed (os.Root keeps
|
||||||
|
// the write inside the brain; hyperguild#167).
|
||||||
|
func (b *Brain) WriteRegular(rel string, data []byte) error {
|
||||||
|
rel = filepath.ToSlash(rel)
|
||||||
|
lfi, err := b.root.Lstat(rel)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if !lfi.Mode().IsRegular() {
|
||||||
|
return fmt.Errorf("%s: %w", rel, ErrNotRegular)
|
||||||
|
}
|
||||||
|
f, err := b.root.OpenFile(rel, os.O_WRONLY|syscall.O_NOFOLLOW|syscall.O_NONBLOCK, 0)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer func() { _ = f.Close() }()
|
||||||
|
fi, err := f.Stat()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if !fi.Mode().IsRegular() || !os.SameFile(lfi, fi) {
|
||||||
|
return fmt.Errorf("%s: changed while opening: %w", rel, ErrNotRegular)
|
||||||
|
}
|
||||||
|
if err := f.Truncate(0); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if _, err := f.Write(data); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return f.Close()
|
||||||
|
}
|
||||||
|
|
||||||
// ReadRegular reads a brain-relative path, refusing anything that is not a
|
// ReadRegular reads a brain-relative path, refusing anything that is not a
|
||||||
// regular file, both before the open and on the opened handle.
|
// regular file, both before the open and on the opened handle.
|
||||||
func (b *Brain) ReadRegular(rel string) ([]byte, error) {
|
func (b *Brain) ReadRegular(rel string) ([]byte, error) {
|
||||||
@@ -74,7 +144,22 @@ func (b *Brain) ReadRegular(rel string) ([]byte, error) {
|
|||||||
// cannot create one; fs.protected_hardlinks=1 and the pod's secrets are on a
|
// cannot create one; fs.protected_hardlinks=1 and the pod's secrets are on a
|
||||||
// different filesystem from the brain volume, so a local caller cannot link
|
// different filesystem from the brain volume, so a local caller cannot link
|
||||||
// them in. Refusing Nlink > 1 is the next step if either changes.
|
// them in. Refusing Nlink > 1 is the next step if either changes.
|
||||||
func (b *Brain) readOpened(rel string) ([]byte, error) {
|
func (b *Brain) readOpened(rel string) ([]byte, error) { return b.readOpenedMax(rel, -1) }
|
||||||
|
|
||||||
|
// ReadRegularMax is ReadRegular with a size limit, checked on the opened
|
||||||
|
// handle before reading (max < 0 means no limit).
|
||||||
|
func (b *Brain) ReadRegularMax(rel string, max int64) ([]byte, error) {
|
||||||
|
fi, err := b.root.Lstat(rel)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if !fi.Mode().IsRegular() {
|
||||||
|
return nil, fmt.Errorf("%s: %w", rel, ErrNotRegular)
|
||||||
|
}
|
||||||
|
return b.readOpenedMax(rel, max)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *Brain) readOpenedMax(rel string, max int64) ([]byte, error) {
|
||||||
f, err := b.root.OpenFile(rel, os.O_RDONLY|syscall.O_NONBLOCK, 0)
|
f, err := b.root.OpenFile(rel, os.O_RDONLY|syscall.O_NONBLOCK, 0)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -87,15 +172,56 @@ func (b *Brain) readOpened(rel string) ([]byte, error) {
|
|||||||
if !hfi.Mode().IsRegular() {
|
if !hfi.Mode().IsRegular() {
|
||||||
return nil, fmt.Errorf("%s: %w", rel, ErrNotRegular)
|
return nil, fmt.Errorf("%s: %w", rel, ErrNotRegular)
|
||||||
}
|
}
|
||||||
return io.ReadAll(f)
|
if max >= 0 && hfi.Size() > max {
|
||||||
|
return nil, fmt.Errorf("%s is %d bytes (limit %d): %w", rel, hfi.Size(), max, ErrTooLarge)
|
||||||
|
}
|
||||||
|
var r io.Reader = f
|
||||||
|
if wrapAfterStat != nil {
|
||||||
|
r = wrapAfterStat(r)
|
||||||
|
}
|
||||||
|
if max < 0 {
|
||||||
|
return io.ReadAll(r)
|
||||||
|
}
|
||||||
|
// The handle's size can grow after the check; bound the read itself.
|
||||||
|
data, err := io.ReadAll(io.LimitReader(r, max+1))
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if int64(len(data)) > max {
|
||||||
|
return nil, fmt.Errorf("%s grew past %d bytes while read: %w", rel, max, ErrTooLarge)
|
||||||
|
}
|
||||||
|
return data, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// wrapAfterStat is a test seam: it runs between the size check and the read,
|
||||||
|
// and wraps the reader the read consumes. A package global: brainfs tests
|
||||||
|
// must not use t.Parallel.
|
||||||
|
var wrapAfterStat func(io.Reader) io.Reader
|
||||||
|
|
||||||
// WalkRegular walks a brain-relative directory through the root and calls fn
|
// WalkRegular walks a brain-relative directory through the root and calls fn
|
||||||
// for each regular file (directories are descended; symlinks, FIFOs and
|
// for each regular file. Directories are descended; symlinks, FIFOs and
|
||||||
// devices are skipped, never followed). An entry error is passed to onErr and
|
// devices found by the walk are skipped. A walk root with any component that
|
||||||
// the walk continues; a nil onErr ignores it.
|
// is not a real directory goes to onErr as ErrNotRegular and nothing is
|
||||||
|
// yielded. An entry error is passed to onErr and the walk continues; a nil
|
||||||
|
// onErr ignores it.
|
||||||
|
//
|
||||||
|
// Accepted residual (hyperguild#157): a directory swapped for a symlink
|
||||||
|
// between the listing and the read is followed. os.Root still keeps the read
|
||||||
|
// inside the brain, but not inside relDir.
|
||||||
func (b *Brain) WalkRegular(relDir string, fn func(rel string) error, onErr func(rel string, err error)) error {
|
func (b *Brain) WalkRegular(relDir string, fn func(rel string) error, onErr func(rel string, err error)) error {
|
||||||
return fs.WalkDir(b.root.FS(), filepath.ToSlash(relDir), func(p string, d fs.DirEntry, err error) error {
|
relDir = filepath.ToSlash(relDir)
|
||||||
|
// fs.WalkDir stats its root with a follow, and os.Root allows a symlink
|
||||||
|
// that stays inside the brain: knowledge -> . would alias the whole
|
||||||
|
// brain. Require every component of the root to be a real directory
|
||||||
|
// (Lstat checks only the last one).
|
||||||
|
err := b.realDir(relDir)
|
||||||
|
if err != nil {
|
||||||
|
if onErr != nil {
|
||||||
|
onErr(relDir, err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return fs.WalkDir(b.root.FS(), relDir, func(p string, d fs.DirEntry, err error) error {
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if onErr != nil {
|
if onErr != nil {
|
||||||
onErr(p, err)
|
onErr(p, err)
|
||||||
|
|||||||
@@ -2,6 +2,8 @@ package brainfs
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"errors"
|
"errors"
|
||||||
|
"io"
|
||||||
|
"io/fs"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"syscall"
|
"syscall"
|
||||||
@@ -90,3 +92,146 @@ func TestWalkRegularYieldsOnlyRegularFiles(t *testing.T) {
|
|||||||
require.NoError(t, b.WalkRegular(".", func(rel string) error { got = append(got, rel); return nil }, nil))
|
require.NoError(t, b.WalkRegular(".", func(rel string) error { got = append(got, rel); return nil }, nil))
|
||||||
assert.Equal(t, []string{"a/n.md"}, got)
|
assert.Equal(t, []string{"a/n.md"}, got)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestReadRegularMaxRefusesAFileOverTheLimit(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "big.md"), make([]byte, 100), 0o644))
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
_, err = b.ReadRegularMax("big.md", 99)
|
||||||
|
assert.True(t, errors.Is(err, ErrTooLarge), "got %v", err)
|
||||||
|
got, err := b.ReadRegularMax("big.md", 100)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Len(t, got, 100)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestReadRegularMaxRefusesAndStopsReadingAFileThatGrowsPastTheLimit(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
p := filepath.Join(dir, "grow.md")
|
||||||
|
require.NoError(t, os.WriteFile(p, make([]byte, 10), 0o644))
|
||||||
|
consumed := &countingReader{}
|
||||||
|
wrapAfterStat = func(r io.Reader) io.Reader {
|
||||||
|
f, err := os.OpenFile(p, os.O_WRONLY|os.O_APPEND, 0)
|
||||||
|
require.NoError(t, err)
|
||||||
|
_, err = f.Write(make([]byte, 1000))
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NoError(t, f.Close())
|
||||||
|
consumed.r = r
|
||||||
|
return consumed
|
||||||
|
}
|
||||||
|
t.Cleanup(func() { wrapAfterStat = nil })
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
got, err := b.ReadRegularMax("grow.md", 100)
|
||||||
|
assert.True(t, errors.Is(err, ErrTooLarge), "got %v", err)
|
||||||
|
assert.Nil(t, got)
|
||||||
|
assert.LessOrEqual(t, consumed.n, 101, "read past max+1 bytes")
|
||||||
|
}
|
||||||
|
|
||||||
|
type countingReader struct {
|
||||||
|
r io.Reader
|
||||||
|
n int
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *countingReader) Read(p []byte) (int, error) {
|
||||||
|
n, err := c.r.Read(p)
|
||||||
|
c.n += n
|
||||||
|
return n, err
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLstatDoesNotFollowSymlinksAndRefusesEscapes(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
outside := filepath.Join(t.TempDir(), "o.md")
|
||||||
|
require.NoError(t, os.WriteFile(outside, []byte("o"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(outside, filepath.Join(dir, "l.md")))
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
fi, err := b.Lstat("l.md")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, fs.ModeSymlink, fi.Mode().Type())
|
||||||
|
_, err = b.Lstat("../" + filepath.Base(filepath.Dir(outside)) + "/o.md")
|
||||||
|
assert.Error(t, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWalkRegularReportsASymlinkedWalkRootAndYieldsNothing(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "real"), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "real", "n.md"), []byte("n"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink("real", filepath.Join(dir, "alias")))
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
var got []string
|
||||||
|
var errs []error
|
||||||
|
require.NoError(t, b.WalkRegular("alias", func(rel string) error { got = append(got, rel); return nil },
|
||||||
|
func(_ string, err error) { errs = append(errs, err) }))
|
||||||
|
assert.Empty(t, got)
|
||||||
|
require.Len(t, errs, 1)
|
||||||
|
assert.ErrorIs(t, errs[0], ErrNotRegular)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWalkRegularReportsASymlinkedIntermediateComponentOfTheWalkRoot(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "real", "sub"), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "real", "sub", "n.md"), []byte("n"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink("real", filepath.Join(dir, "alias")))
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
var got []string
|
||||||
|
var errs []error
|
||||||
|
require.NoError(t, b.WalkRegular("alias/sub", func(rel string) error { got = append(got, rel); return nil },
|
||||||
|
func(_ string, err error) { errs = append(errs, err) }))
|
||||||
|
assert.Empty(t, got)
|
||||||
|
require.Len(t, errs, 1)
|
||||||
|
assert.ErrorIs(t, errs[0], ErrNotRegular)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWriteRegularRefusesFinalSymlinksFIFOsEscapesAndMissingFilesAndRewritesRegularFiles(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
outside := filepath.Join(t.TempDir(), "o.md")
|
||||||
|
require.NoError(t, os.WriteFile(outside, []byte("untouched"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(outside, filepath.Join(dir, "l.md")))
|
||||||
|
require.NoError(t, syscall.Mkfifo(filepath.Join(dir, "f.md"), 0o644))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "n.md"), []byte("old content"), 0o644))
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
|
||||||
|
assert.Error(t, b.WriteRegular("l.md", []byte("x")))
|
||||||
|
got, _ := os.ReadFile(outside)
|
||||||
|
assert.Equal(t, "untouched", string(got))
|
||||||
|
|
||||||
|
// A symlink to another file inside the brain: os.Root would allow it,
|
||||||
|
// only O_NOFOLLOW refuses it.
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "in.md"), []byte("inside"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink("in.md", filepath.Join(dir, "il.md")))
|
||||||
|
assert.Error(t, b.WriteRegular("il.md", []byte("x")))
|
||||||
|
got, _ = os.ReadFile(filepath.Join(dir, "in.md"))
|
||||||
|
assert.Equal(t, "inside", string(got))
|
||||||
|
|
||||||
|
// A reader held open, so a non-blocking write open would succeed. The
|
||||||
|
// Lstat type check refuses the FIFO first; the handle check and
|
||||||
|
// O_NONBLOCK matter only if it is swapped in after the Lstat.
|
||||||
|
r, err := os.OpenFile(filepath.Join(dir, "f.md"), os.O_RDONLY|syscall.O_NONBLOCK, 0)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = r.Close() }()
|
||||||
|
done := make(chan error, 1)
|
||||||
|
go func() { done <- b.WriteRegular("f.md", []byte("x")) }()
|
||||||
|
select {
|
||||||
|
case err := <-done:
|
||||||
|
assert.Error(t, err)
|
||||||
|
case <-time.After(3 * time.Second):
|
||||||
|
t.Fatal("WriteRegular hung on a FIFO")
|
||||||
|
}
|
||||||
|
|
||||||
|
assert.Error(t, b.WriteRegular("../"+filepath.Base(filepath.Dir(outside))+"/o.md", []byte("x")))
|
||||||
|
assert.Error(t, b.WriteRegular("missing.md", []byte("x")), "does not create files")
|
||||||
|
|
||||||
|
require.NoError(t, b.WriteRegular("n.md", []byte("new")))
|
||||||
|
got, _ = os.ReadFile(filepath.Join(dir, "n.md"))
|
||||||
|
assert.Equal(t, "new", string(got), "truncated and rewritten")
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,103 @@
|
|||||||
|
// Package brainfstest is the shared harness for hyperguild#157's swap-race
|
||||||
|
// tests: it keeps swapping a regular note, a symlink to an outside file, or a
|
||||||
|
// FIFO (with a writer held open) into a path while a reader under test loops.
|
||||||
|
// It observes two things: no sentinel byte from the outside file reaches the
|
||||||
|
// reader's output, and the reader returns within a timeout. It does not cover
|
||||||
|
// hard links, other paths into the reader, or races it does not generate.
|
||||||
|
package brainfstest
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
|
"syscall"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Sentinel marks the outside file's contents.
|
||||||
|
const Sentinel = "zqbrainfssentinelonefiftyseven"
|
||||||
|
|
||||||
|
// Outside writes a file outside any brain dir containing Sentinel.
|
||||||
|
func Outside(t *testing.T) string {
|
||||||
|
t.Helper()
|
||||||
|
p := filepath.Join(t.TempDir(), "secret.md")
|
||||||
|
if err := os.WriteFile(p, []byte("# secret\n\n"+Sentinel), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// StartSwap renames, in a loop, a regular note (content inside) and either
|
||||||
|
// a symlink to outside or a FIFO into path, until the test ends. FIFOs get a
|
||||||
|
// writer held open until the swapper exits, so a reader that skips the
|
||||||
|
// handle check parks forever instead of reading EOF. The swapper is stopped
|
||||||
|
// and awaited before t.TempDir cleanup.
|
||||||
|
func StartSwap(t *testing.T, path, inside, outside string, fifo bool) {
|
||||||
|
t.Helper()
|
||||||
|
var stop atomic.Bool
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
wg.Add(1)
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
tmp := path + ".swap"
|
||||||
|
var writers []*os.File
|
||||||
|
defer func() {
|
||||||
|
for _, w := range writers {
|
||||||
|
_ = w.Close()
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
for i := 0; !stop.Load(); i++ {
|
||||||
|
_ = os.Remove(tmp)
|
||||||
|
switch {
|
||||||
|
case i%2 == 0:
|
||||||
|
_ = os.WriteFile(tmp, []byte(inside), 0o644)
|
||||||
|
case fifo:
|
||||||
|
if err := syscall.Mkfifo(tmp, 0o644); err == nil {
|
||||||
|
if w, err := os.OpenFile(tmp, os.O_RDWR, 0); err == nil {
|
||||||
|
writers = append(writers, w)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
_ = os.Symlink(outside, tmp)
|
||||||
|
}
|
||||||
|
_ = os.Rename(tmp, path)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
t.Cleanup(func() { stop.Store(true); wg.Wait() })
|
||||||
|
}
|
||||||
|
|
||||||
|
// AssertNoLeak loops read for d while a symlink swapper runs on path, and
|
||||||
|
// fails if any output contains Sentinel.
|
||||||
|
func AssertNoLeak(t *testing.T, path, inside string, d time.Duration, read func() string) {
|
||||||
|
t.Helper()
|
||||||
|
StartSwap(t, path, inside, Outside(t), false)
|
||||||
|
leaks, iters := 0, 0
|
||||||
|
for deadline := time.Now().Add(d); time.Now().Before(deadline); iters++ {
|
||||||
|
leaks += strings.Count(read(), Sentinel)
|
||||||
|
}
|
||||||
|
if leaks > 0 {
|
||||||
|
t.Fatalf("outside file leaked %d times in %d iterations", leaks, iters)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// AssertNoHang loops read for d while a FIFO swapper (held writers) runs on
|
||||||
|
// path, and fails if a read does not return within timeout.
|
||||||
|
func AssertNoHang(t *testing.T, path, inside string, d, timeout time.Duration, read func()) {
|
||||||
|
t.Helper()
|
||||||
|
StartSwap(t, path, inside, Outside(t), true)
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
for deadline := time.Now().Add(d); time.Now().Before(deadline); {
|
||||||
|
read()
|
||||||
|
}
|
||||||
|
close(done)
|
||||||
|
}()
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
case <-time.After(timeout):
|
||||||
|
t.Fatal("reader hung on a swapped-in FIFO with a writer held open")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
package mcp
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs/brainfstest"
|
||||||
|
)
|
||||||
|
|
||||||
|
// hyperguild#157 slice 2: readExcerpt (brain_context) read by path, so a
|
||||||
|
// symlink in the Syncthing-shared brain put an outside file in context, and
|
||||||
|
// a FIFO hung it. It now reads through brainfs.
|
||||||
|
func TestReadExcerptRefusesSymlinksAndSurvivesSwapRaces(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
facts := filepath.Join(brain, "wiki", "w", "facts")
|
||||||
|
require.NoError(t, os.MkdirAll(facts, 0o755))
|
||||||
|
require.NoError(t, os.Symlink(brainfstest.Outside(t), filepath.Join(facts, "leak.md")))
|
||||||
|
assert.NotContains(t, readExcerpt(brain, "wiki/w/facts/leak.md", 500), brainfstest.Sentinel)
|
||||||
|
|
||||||
|
p := filepath.Join(facts, "r.md")
|
||||||
|
require.NoError(t, os.WriteFile(p, []byte("---\nx: y\n---\ninside"), 0o644))
|
||||||
|
assert.Equal(t, "inside", readExcerpt(brain, "wiki/w/facts/r.md", 500))
|
||||||
|
brainfstest.AssertNoLeak(t, p, "---\nx: y\n---\ninside", 1500*time.Millisecond, func() string {
|
||||||
|
return readExcerpt(brain, "wiki/w/facts/r.md", 500)
|
||||||
|
})
|
||||||
|
brainfstest.AssertNoHang(t, p, "---\nx: y\n---\ninside", 1500*time.Millisecond, 6*time.Second, func() {
|
||||||
|
_ = readExcerpt(brain, "wiki/w/facts/r.md", 500)
|
||||||
|
})
|
||||||
|
}
|
||||||
@@ -4,7 +4,7 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -181,8 +181,13 @@ func readExcerpt(brainDir, relPath string, maxLen int) string {
|
|||||||
if relPath == "" {
|
if relPath == "" {
|
||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
full := filepath.Join(brainDir, filepath.FromSlash(relPath))
|
// Through the brain root, regular files only (hyperguild#157).
|
||||||
content, err := os.ReadFile(full)
|
bfs, err := brainfs.Open(brainDir)
|
||||||
|
if err != nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
defer func() { _ = bfs.Close() }()
|
||||||
|
content, err := bfs.ReadRegular(filepath.ToSlash(relPath))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ import (
|
|||||||
"encoding/hex"
|
"encoding/hex"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -71,14 +72,18 @@ func ReadScoped(brainDir, path string, scope Scope) ([]byte, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func readContained(t Target) ([]byte, error) {
|
func readContained(t Target) ([]byte, error) {
|
||||||
fi, err := os.Stat(t.Abs)
|
// Through the brain root, regular files only, size checked on the opened
|
||||||
|
// handle (hyperguild#157): Resolve's Lstat could be raced by a swap, and
|
||||||
|
// os.ReadFile blocked on a FIFO.
|
||||||
|
bfs, err := brainfs.Open(t.Brain)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("notes: stat %s: %w", t.Rel, err)
|
return nil, fmt.Errorf("notes: %w", err)
|
||||||
}
|
}
|
||||||
if fi.Size() > maxNoteBytes {
|
defer func() { _ = bfs.Close() }()
|
||||||
return nil, fmt.Errorf("%w: %s is %d bytes (limit %d)", ErrTooLarge, t.Rel, fi.Size(), maxNoteBytes)
|
b, err := bfs.ReadRegularMax(t.Rel, maxNoteBytes)
|
||||||
|
if errors.Is(err, brainfs.ErrTooLarge) {
|
||||||
|
return nil, fmt.Errorf("%w: %s (limit %d)", ErrTooLarge, t.Rel, maxNoteBytes)
|
||||||
}
|
}
|
||||||
b, err := os.ReadFile(t.Abs)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("notes: read %s: %w", t.Rel, err)
|
return nil, fmt.Errorf("notes: read %s: %w", t.Rel, err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -60,6 +60,7 @@ var (
|
|||||||
type Target struct {
|
type Target struct {
|
||||||
Rel string // brain-relative, cleaned
|
Rel string // brain-relative, cleaned
|
||||||
Abs string // absolute, symlink-checked
|
Abs string // absolute, symlink-checked
|
||||||
|
Brain string // the brain root Rel is relative to
|
||||||
}
|
}
|
||||||
|
|
||||||
// Resolve canonicalises path, then checks it against the scope's allowlist,
|
// Resolve canonicalises path, then checks it against the scope's allowlist,
|
||||||
@@ -109,7 +110,7 @@ func Resolve(brainDir, path string, scope Scope) (Target, error) {
|
|||||||
return Target{}, err
|
return Target{}, err
|
||||||
}
|
}
|
||||||
|
|
||||||
return Target{Rel: clean, Abs: abs}, nil
|
return Target{Rel: clean, Abs: abs, Brain: brainDir}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// allow enforces the scope's allowlist. The two scopes are DISJOINT, not
|
// allow enforces the scope's allowlist. The two scopes are DISJOINT, not
|
||||||
|
|||||||
@@ -0,0 +1,40 @@
|
|||||||
|
package notes
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs/brainfstest"
|
||||||
|
)
|
||||||
|
|
||||||
|
// hyperguild#157 slice 2: ReadScoped (brain_read) Lstat-checked the final
|
||||||
|
// component, then reopened by name with os.ReadFile: a swap after the check
|
||||||
|
// was followed, and a FIFO blocked the read. It now reads through brainfs.
|
||||||
|
func TestReadScopedRefusesSymlinksAndSurvivesSwapRaces(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
facts := filepath.Join(brain, "wiki", "w", "facts")
|
||||||
|
require.NoError(t, os.MkdirAll(facts, 0o755))
|
||||||
|
p := filepath.Join(facts, "r.md")
|
||||||
|
read := func() string {
|
||||||
|
b, _ := ReadScoped(brain, "wiki/w/facts/r.md", ScopeNotes)
|
||||||
|
return string(b)
|
||||||
|
}
|
||||||
|
require.NoError(t, os.WriteFile(p, []byte("inside"), 0o644))
|
||||||
|
assert.Equal(t, "inside", read())
|
||||||
|
brainfstest.AssertNoLeak(t, p, "inside", 1500*time.Millisecond, read)
|
||||||
|
brainfstest.AssertNoHang(t, p, "inside", 1500*time.Millisecond, 6*time.Second, func() { _ = read() })
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestReadScopedRefusesANoteOverMaxNoteBytes(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
facts := filepath.Join(brain, "wiki", "w", "facts")
|
||||||
|
require.NoError(t, os.MkdirAll(facts, 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(facts, "big.md"), make([]byte, maxNoteBytes+1), 0o644))
|
||||||
|
_, err := ReadScoped(brain, "wiki/w/facts/big.md", ScopeNotes)
|
||||||
|
assert.ErrorIs(t, err, ErrTooLarge)
|
||||||
|
}
|
||||||
@@ -61,6 +61,31 @@ func TestQueryDoesNotFollowASymlinkedDirectory(t *testing.T) {
|
|||||||
assert.Zero(t, leaked(rs))
|
assert.Zero(t, leaked(rs))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// A search root that is a symlink staying inside the brain (wiki/<w> -> ..)
|
||||||
|
// was followed by fs.WalkDir, aliasing raw/ and root files into results
|
||||||
|
// (PR #166 review). The root is now Lstat-checked and skipped.
|
||||||
|
func TestQueryDoesNotFollowASymlinkedWingRootInsideTheBrain(t *testing.T) {
|
||||||
|
brain, _, _ := searchBrain(t)
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(brain, "raw"), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(brain, "raw", "r.md"), []byte("# r\n\nzqrawonly"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink("..", filepath.Join(brain, "wiki", "alias")))
|
||||||
|
rs, err := Query(brain, QueryOptions{Query: "zqrawonly", Wing: "alias", Limit: 10})
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Empty(t, rs)
|
||||||
|
}
|
||||||
|
|
||||||
|
// With a hall the search root is wiki/<wing>/<hall>; a symlinked <wing> with
|
||||||
|
// a real <hall> directory under its target was followed (PR #166 round 2).
|
||||||
|
func TestQueryDoesNotFollowASymlinkedWingUnderAWingAndHallRoot(t *testing.T) {
|
||||||
|
brain, _, _ := searchBrain(t)
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(brain, "raw", "facts"), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(brain, "raw", "facts", "r.md"), []byte("# r\n\nzqrawhall"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "raw"), filepath.Join(brain, "wiki", "alias")))
|
||||||
|
rs, err := Query(brain, QueryOptions{Query: "zqrawhall", Wing: "alias", Hall: "facts", Limit: 10})
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Empty(t, rs)
|
||||||
|
}
|
||||||
|
|
||||||
// swapInto keeps renaming a regular note, and either a symlink to outside or
|
// swapInto keeps renaming a regular note, and either a symlink to outside or
|
||||||
// a FIFO, into path. Each FIFO has a writer held open (as any local process
|
// a FIFO, into path. Each FIFO has a writer held open (as any local process
|
||||||
// can): a FIFO with no writer reads EOF at once, which would let a reader
|
// can): a FIFO with no writer reads EOF at once, which would let a reader
|
||||||
|
|||||||
@@ -0,0 +1,49 @@
|
|||||||
|
package session
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// session_log passed the caller's session_id straight into
|
||||||
|
// filepath.Join(sessionsDir, id+".jsonl") and opened it O_CREATE|O_APPEND:
|
||||||
|
// path segments in the id created or appended files anywhere the pod could
|
||||||
|
// write. The id is now a plain name, and the open does not follow a final
|
||||||
|
// symlink.
|
||||||
|
func TestAppendRefusesSessionIDsThatAreNotPlainNames(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
dir := filepath.Join(root, "sessions")
|
||||||
|
for _, id := range []string{"../x", "a/b", "/abs", ".", "..", ".hidden", "", "a\\b", "a\x00b"} {
|
||||||
|
assert.Error(t, Append(dir, id, Entry{SessionID: id}), "%q", id)
|
||||||
|
}
|
||||||
|
ents, _ := os.ReadDir(root)
|
||||||
|
for _, e := range ents {
|
||||||
|
assert.Equal(t, "sessions", e.Name(), "nothing created beside the sessions dir")
|
||||||
|
}
|
||||||
|
for _, id := range []string{"1557b2e1-bf0d-5c4f-bbe3-0754d087e356", "_routing", "2026-05-05-infra.plan", "0"} {
|
||||||
|
require.NoError(t, Append(dir, id, Entry{SessionID: id}), "positive control: %q", id)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAppendDoesNotWriteThroughASymlinkedLog(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
dir := filepath.Join(root, "sessions")
|
||||||
|
require.NoError(t, os.MkdirAll(dir, 0o755))
|
||||||
|
victim := filepath.Join(root, "victim.md")
|
||||||
|
require.NoError(t, os.WriteFile(victim, []byte("untouched\n"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "victim.md"), filepath.Join(dir, "s.jsonl")))
|
||||||
|
assert.Error(t, Append(dir, "s", Entry{SessionID: "s"}))
|
||||||
|
got, _ := os.ReadFile(victim)
|
||||||
|
assert.Equal(t, "untouched\n", string(got))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestReadRefusesSessionIDsThatAreNotPlainNames(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(root, "x.jsonl"), []byte(`{"session_id":"x"}`+"\n"), 0o644))
|
||||||
|
_, err := Read(filepath.Join(root, "sessions"), "../x")
|
||||||
|
assert.Error(t, err)
|
||||||
|
}
|
||||||
@@ -9,6 +9,8 @@ import (
|
|||||||
"io/fs"
|
"io/fs"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"regexp"
|
||||||
|
"syscall"
|
||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -42,13 +44,29 @@ type Attempt struct {
|
|||||||
RunnerOutput string `json:"runner_output,omitempty"`
|
RunnerOutput string `json:"runner_output,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// idPattern is a plain file name: session_log takes the id from the caller,
|
||||||
|
// and a path segment in it created or appended files anywhere the pod could
|
||||||
|
// write (hyperguild#169).
|
||||||
|
var idPattern = regexp.MustCompile(`^[A-Za-z0-9_][A-Za-z0-9._-]{0,127}$`)
|
||||||
|
|
||||||
|
func checkID(sessionID string) error {
|
||||||
|
if !idPattern.MatchString(sessionID) {
|
||||||
|
return fmt.Errorf("session id %q is not a plain name", sessionID)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// Append writes entry as a single JSON line to sessionsDir/{sessionID}.jsonl.
|
// Append writes entry as a single JSON line to sessionsDir/{sessionID}.jsonl.
|
||||||
|
// The open does not follow a final symlink.
|
||||||
func Append(sessionsDir, sessionID string, entry Entry) error {
|
func Append(sessionsDir, sessionID string, entry Entry) error {
|
||||||
|
if err := checkID(sessionID); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
if err := os.MkdirAll(sessionsDir, 0o755); err != nil {
|
if err := os.MkdirAll(sessionsDir, 0o755); err != nil {
|
||||||
return fmt.Errorf("create sessions dir: %w", err)
|
return fmt.Errorf("create sessions dir: %w", err)
|
||||||
}
|
}
|
||||||
path := filepath.Join(sessionsDir, sessionID+".jsonl")
|
path := filepath.Join(sessionsDir, sessionID+".jsonl")
|
||||||
f, err := os.OpenFile(path, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0o644)
|
f, err := os.OpenFile(path, os.O_CREATE|os.O_APPEND|os.O_WRONLY|syscall.O_NOFOLLOW|syscall.O_NONBLOCK, 0o644)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("open session log: %w", err)
|
return fmt.Errorf("open session log: %w", err)
|
||||||
}
|
}
|
||||||
@@ -70,6 +88,9 @@ func Append(sessionsDir, sessionID string, entry Entry) error {
|
|||||||
|
|
||||||
// Read returns all entries for sessionID. Returns empty slice if no log exists.
|
// Read returns all entries for sessionID. Returns empty slice if no log exists.
|
||||||
func Read(sessionsDir, sessionID string) ([]Entry, error) {
|
func Read(sessionsDir, sessionID string) ([]Entry, error) {
|
||||||
|
if err := checkID(sessionID); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
path := filepath.Join(sessionsDir, sessionID+".jsonl")
|
path := filepath.Join(sessionsDir, sessionID+".jsonl")
|
||||||
f, err := os.Open(path)
|
f, err := os.Open(path)
|
||||||
if errors.Is(err, fs.ErrNotExist) {
|
if errors.Is(err, fs.ErrNotExist) {
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ package symlinkguard
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io/fs"
|
"io/fs"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
@@ -21,7 +22,14 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
// DefaultInterval is used when Watch is given a non-positive interval.
|
// DefaultInterval is used when Watch is given a non-positive interval.
|
||||||
const DefaultInterval = 5 * time.Minute
|
const DefaultInterval = 30 * time.Second
|
||||||
|
|
||||||
|
// Alert bounds (PR #160 review): the planter chooses the paths, so neither an
|
||||||
|
// alert's size nor the queue may grow with what was planted.
|
||||||
|
const (
|
||||||
|
maxPathsPerAlert = 10 // further paths are counted, not listed
|
||||||
|
maxPending = 5 // queued alerts; the rest become one summary
|
||||||
|
)
|
||||||
|
|
||||||
// Notifier is the out-of-band alert sink (audit.Notifier satisfies it).
|
// Notifier is the out-of-band alert sink (audit.Notifier satisfies it).
|
||||||
type Notifier interface {
|
type Notifier interface {
|
||||||
@@ -41,13 +49,7 @@ func (r Result) Clean() bool { return len(r.Symlinks) == 0 && len(r.Unreadable)
|
|||||||
// String describes the findings for a log line or alert. Paths are quoted, so
|
// String describes the findings for a log line or alert. Paths are quoted, so
|
||||||
// a name containing a newline cannot blur two findings together.
|
// a name containing a newline cannot blur two findings together.
|
||||||
func (r Result) String() string {
|
func (r Result) String() string {
|
||||||
q := func(xs []string) string {
|
q := r.quoted
|
||||||
out := make([]string, len(xs))
|
|
||||||
for i, x := range xs {
|
|
||||||
out[i] = strconv.Quote(x)
|
|
||||||
}
|
|
||||||
return strings.Join(out, ", ")
|
|
||||||
}
|
|
||||||
var parts []string
|
var parts []string
|
||||||
if len(r.Symlinks) > 0 {
|
if len(r.Symlinks) > 0 {
|
||||||
parts = append(parts, fmt.Sprintf("%d symlink(s): %s", len(r.Symlinks), q(r.Symlinks)))
|
parts = append(parts, fmt.Sprintf("%d symlink(s): %s", len(r.Symlinks), q(r.Symlinks)))
|
||||||
@@ -58,6 +60,24 @@ func (r Result) String() string {
|
|||||||
return strings.Join(parts, "; ")
|
return strings.Join(parts, "; ")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// quoted joins at most maxPathsPerAlert paths, each strconv-quoted, and
|
||||||
|
// counts the rest.
|
||||||
|
func (Result) quoted(xs []string) string {
|
||||||
|
shown := xs
|
||||||
|
if len(shown) > maxPathsPerAlert {
|
||||||
|
shown = shown[:maxPathsPerAlert]
|
||||||
|
}
|
||||||
|
out := make([]string, len(shown))
|
||||||
|
for i, x := range shown {
|
||||||
|
out[i] = strconv.Quote(x)
|
||||||
|
}
|
||||||
|
s := strings.Join(out, ", ")
|
||||||
|
if extra := len(xs) - len(shown); extra > 0 {
|
||||||
|
s += fmt.Sprintf(" and %d more", extra)
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
// Scan walks the brain dir and reports every symlink in it and every
|
// Scan walks the brain dir and reports every symlink in it and every
|
||||||
// directory it could not read, continuing past both. Only the ROOT .git is
|
// directory it could not read, continuing past both. Only the ROOT .git is
|
||||||
// skipped (it is brain-sync's, and no reader walks it); a nested .git is
|
// skipped (it is brain-sync's, and no reader walks it); a nested .git is
|
||||||
@@ -106,15 +126,20 @@ func Scan(brainDir string) (Result, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Watch rescans every interval (DefaultInterval if non-positive) until ctx
|
// Watch rescans every interval (DefaultInterval if non-positive) until ctx
|
||||||
// ends, and notifies once per distinct non-clean result. A result counts as
|
// ends. Every symlink found is removed (the link, never its target:
|
||||||
// reported only after Notify succeeds, so an alert lost to a notifier outage
|
// hyperguild#157 decision), so one is readable for at most one interval.
|
||||||
// is retried on the next tick.
|
// Each removal is an alert; a persistent finding (a link it could not remove,
|
||||||
|
// an unreadable dir, a scan error) alerts once per distinct state. Alerts
|
||||||
|
// queue until Notify succeeds (see alertQueue): an outage delays them, and
|
||||||
|
// any that do not fit the bounded queue, or are undeliverable, are counted in
|
||||||
|
// a summary that is never dropped, so every incident is delivered or counted.
|
||||||
func Watch(ctx context.Context, brainDir string, interval time.Duration, n Notifier) {
|
func Watch(ctx context.Context, brainDir string, interval time.Duration, n Notifier) {
|
||||||
if interval <= 0 {
|
if interval <= 0 {
|
||||||
interval = DefaultInterval
|
interval = DefaultInterval
|
||||||
}
|
}
|
||||||
t := time.NewTicker(interval)
|
t := time.NewTicker(interval)
|
||||||
defer t.Stop()
|
defer t.Stop()
|
||||||
|
q := &alertQueue{}
|
||||||
reported := ""
|
reported := ""
|
||||||
for {
|
for {
|
||||||
select {
|
select {
|
||||||
@@ -123,31 +148,117 @@ func Watch(ctx context.Context, brainDir string, interval time.Duration, n Notif
|
|||||||
case <-t.C:
|
case <-t.C:
|
||||||
}
|
}
|
||||||
r, err := Scan(brainDir)
|
r, err := Scan(brainDir)
|
||||||
var key, msg string
|
key := ""
|
||||||
switch {
|
if err != nil {
|
||||||
case err != nil:
|
key = "cannot scan the brain dir: " + err.Error()
|
||||||
key = "error: " + err.Error()
|
} else {
|
||||||
msg = "brain symlink tripwire (hyperguild#157): cannot scan the brain dir: " + err.Error()
|
removed, failed := removeSymlinks(brainDir, r.Symlinks)
|
||||||
case r.Clean():
|
if len(removed) > 0 {
|
||||||
reported = ""
|
slog.Error("brain symlink tripwire removed symlinks", "count", len(removed))
|
||||||
continue
|
q.push(fmt.Sprintf("brain symlink tripwire (hyperguild#157): removed %d symlink(s) from the brain dir: %s",
|
||||||
default:
|
len(removed), Result{}.quoted(removed)))
|
||||||
key = r.String()
|
|
||||||
msg = "brain symlink tripwire (hyperguild#157): " + key +
|
|
||||||
". Readers may follow symlinks out of the brain; remove them."
|
|
||||||
}
|
}
|
||||||
if key == reported {
|
key = Result{Symlinks: failed, Unreadable: r.Unreadable}.String()
|
||||||
continue
|
|
||||||
}
|
}
|
||||||
|
if key != reported {
|
||||||
|
reported = key
|
||||||
|
if key != "" {
|
||||||
slog.Error("brain symlink tripwire", "finding", key)
|
slog.Error("brain symlink tripwire", "finding", key)
|
||||||
if n == nil {
|
q.push("brain symlink tripwire (hyperguild#157): " + key +
|
||||||
reported = key
|
". Readers may follow symlinks out of the brain; fix them.")
|
||||||
continue
|
|
||||||
}
|
}
|
||||||
if err := n.Notify(ctx, msg); err != nil {
|
|
||||||
slog.Warn("symlink tripwire notify failed; will retry", "err", err)
|
|
||||||
continue
|
|
||||||
}
|
}
|
||||||
reported = key
|
q.flush(ctx, n)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// alertQueue holds alerts until Notify accepts them. It is bounded (at most
|
||||||
|
// maxPending queued) and loses nothing from the record: every overflow and
|
||||||
|
// every dropped message increments suppressed, sent as a summary that is
|
||||||
|
// retried every tick and never dropped.
|
||||||
|
//
|
||||||
|
// A message is dropped only when the notifier rejects it permanently (an
|
||||||
|
// error with Permanent() == true, e.g. ntfy 413). Every other failure is an
|
||||||
|
// outage, and nothing is dropped however long it lasts (PR #160 round 2:
|
||||||
|
// dropping after N raw failures lost the only incident of a long outage).
|
||||||
|
// Each flush tries every queued message, so one undeliverable message cannot
|
||||||
|
// block the others.
|
||||||
|
type alertQueue struct {
|
||||||
|
items []string
|
||||||
|
suppressed int
|
||||||
|
}
|
||||||
|
|
||||||
|
func (q *alertQueue) push(msg string) {
|
||||||
|
if len(q.items) >= maxPending {
|
||||||
|
q.suppressed++
|
||||||
|
return
|
||||||
|
}
|
||||||
|
q.items = append(q.items, msg)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (q *alertQueue) flush(ctx context.Context, n Notifier) {
|
||||||
|
if n == nil {
|
||||||
|
q.items, q.suppressed = nil, 0
|
||||||
|
return
|
||||||
|
}
|
||||||
|
kept := q.items[:0]
|
||||||
|
for _, msg := range q.items {
|
||||||
|
err := n.Notify(ctx, msg)
|
||||||
|
switch {
|
||||||
|
case err == nil:
|
||||||
|
case permanent(err):
|
||||||
|
slog.Error("symlink tripwire alert rejected permanently; counted in the summary", "err", err)
|
||||||
|
q.suppressed++
|
||||||
|
default:
|
||||||
|
slog.Warn("symlink tripwire notify failed; will retry", "err", err)
|
||||||
|
kept = append(kept, msg)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
q.items = kept
|
||||||
|
if q.suppressed > 0 {
|
||||||
|
msg := fmt.Sprintf("brain symlink tripwire (hyperguild#157): %d further alert(s) were suppressed or undeliverable; check the ingestion logs", q.suppressed)
|
||||||
|
if err := n.Notify(ctx, msg); err == nil {
|
||||||
|
q.suppressed = 0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// permanent reports whether err says the message itself can never be sent.
|
||||||
|
func permanent(err error) bool {
|
||||||
|
var p interface{ Permanent() bool }
|
||||||
|
return errors.As(err, &p) && p.Permanent()
|
||||||
|
}
|
||||||
|
|
||||||
|
// removeSymlinks unlinks each brain-relative symlink through an os.Root on
|
||||||
|
// the brain dir, after re-checking it is still a symlink. Removing a symlink
|
||||||
|
// never touches its target. It returns what was removed and what was not.
|
||||||
|
func removeSymlinks(brainDir string, rels []string) (removed, failed []string) {
|
||||||
|
if len(rels) == 0 {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
resolved, err := filepath.EvalSymlinks(brainDir)
|
||||||
|
if err != nil {
|
||||||
|
return nil, rels
|
||||||
|
}
|
||||||
|
root, err := os.OpenRoot(resolved)
|
||||||
|
if err != nil {
|
||||||
|
return nil, rels
|
||||||
|
}
|
||||||
|
defer func() { _ = root.Close() }()
|
||||||
|
for _, rel := range rels {
|
||||||
|
fi, err := root.Lstat(rel)
|
||||||
|
if err != nil || fi.Mode()&os.ModeSymlink == 0 {
|
||||||
|
failed = append(failed, rel)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
// root.Remove, not os.RemoveAll: if the link is swapped for a
|
||||||
|
// non-empty directory after the Lstat, Remove refuses rather than
|
||||||
|
// deleting it recursively, and it cannot act outside the root.
|
||||||
|
if err := root.Remove(rel); err != nil {
|
||||||
|
failed = append(failed, rel)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
removed = append(removed, rel)
|
||||||
|
}
|
||||||
|
return removed, failed
|
||||||
|
}
|
||||||
|
|||||||
@@ -3,9 +3,13 @@ package symlinkguard
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -182,8 +186,313 @@ func TestWatchReportsASetAgainAfterItWasCleared(t *testing.T) {
|
|||||||
go Watch(ctx, brain, 10*time.Millisecond, n)
|
go Watch(ctx, brain, 10*time.Millisecond, n)
|
||||||
require.NoError(t, os.Symlink(t.TempDir(), link))
|
require.NoError(t, os.Symlink(t.TempDir(), link))
|
||||||
require.Eventually(t, func() bool { return n.count() == 1 }, 2*time.Second, 10*time.Millisecond)
|
require.Eventually(t, func() bool { return n.count() == 1 }, 2*time.Second, 10*time.Millisecond)
|
||||||
require.NoError(t, os.Remove(link))
|
// The tripwire removed it; planting it again is a new event.
|
||||||
time.Sleep(60 * time.Millisecond)
|
require.Eventually(t, func() bool { _, err := os.Lstat(link); return os.IsNotExist(err) }, 2*time.Second, 10*time.Millisecond)
|
||||||
require.NoError(t, os.Symlink(t.TempDir(), link))
|
require.NoError(t, os.Symlink(t.TempDir(), link))
|
||||||
require.Eventually(t, func() bool { return n.count() == 2 }, 2*time.Second, 10*time.Millisecond)
|
require.Eventually(t, func() bool { return n.count() == 2 }, 2*time.Second, 10*time.Millisecond)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// hyperguild#157 decision: the runtime tripwire removes a symlink it finds
|
||||||
|
// (the link, never its target), so it is readable for at most one interval
|
||||||
|
// instead of until a human acts, and the alert says what was removed.
|
||||||
|
func TestWatchRemovesAnOutsideFileLinkButNotItsTargetOrRegularFiles(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
outside := filepath.Join(t.TempDir(), "target.md")
|
||||||
|
require.NoError(t, os.WriteFile(outside, []byte("keep me"), 0o644))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(brain, "wiki"), 0o755))
|
||||||
|
link := filepath.Join(brain, "wiki", "leak.md")
|
||||||
|
require.NoError(t, os.Symlink(outside, link))
|
||||||
|
regular := filepath.Join(brain, "wiki", "note.md")
|
||||||
|
require.NoError(t, os.WriteFile(regular, []byte("note"), 0o644))
|
||||||
|
|
||||||
|
n := &recNotifier{}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go Watch(ctx, brain, 10*time.Millisecond, n)
|
||||||
|
|
||||||
|
require.Eventually(t, func() bool {
|
||||||
|
_, err := os.Lstat(link)
|
||||||
|
return os.IsNotExist(err)
|
||||||
|
}, 2*time.Second, 10*time.Millisecond, "the symlink is removed")
|
||||||
|
require.Eventually(t, func() bool { return n.count() >= 1 }, 2*time.Second, 10*time.Millisecond)
|
||||||
|
b, err := os.ReadFile(outside)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "keep me", string(b), "the target is untouched")
|
||||||
|
b, err = os.ReadFile(regular)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "note", string(b), "regular files are untouched")
|
||||||
|
n.mu.Lock()
|
||||||
|
defer n.mu.Unlock()
|
||||||
|
assert.Contains(t, n.msgs[0], "removed")
|
||||||
|
assert.Contains(t, n.msgs[0], "wiki/leak.md")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDefaultIntervalIsThirtySeconds(t *testing.T) {
|
||||||
|
assert.Equal(t, 30*time.Second, DefaultInterval)
|
||||||
|
}
|
||||||
|
|
||||||
|
// PR #160 review: the Lstat re-check and the os.Root confinement in
|
||||||
|
// removeSymlinks had no test. Anything that is not a symlink inside the brain
|
||||||
|
// is reported failed and nothing is deleted.
|
||||||
|
func TestRemoveSymlinksRefusesNonSymlinksEscapesAndPathsThroughLinks(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(brain, "wiki", "real"), 0o755))
|
||||||
|
regular := filepath.Join(brain, "wiki", "note.md")
|
||||||
|
require.NoError(t, os.WriteFile(regular, []byte("note"), 0o644))
|
||||||
|
inLinked := filepath.Join(brain, "wiki", "real", "x.md")
|
||||||
|
require.NoError(t, os.WriteFile(inLinked, []byte("x"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join(brain, "wiki", "real"), filepath.Join(brain, "wiki", "linkdir")))
|
||||||
|
outside := filepath.Join(filepath.Dir(brain), "outside-157.md")
|
||||||
|
require.NoError(t, os.WriteFile(outside, []byte("o"), 0o644))
|
||||||
|
t.Cleanup(func() { _ = os.Remove(outside) })
|
||||||
|
|
||||||
|
removed, failed := removeSymlinks(brain, []string{
|
||||||
|
"wiki/note.md", "wiki/linkdir/x.md", "../outside-157.md", "wiki/missing.md",
|
||||||
|
})
|
||||||
|
assert.Empty(t, removed)
|
||||||
|
assert.ElementsMatch(t, []string{"wiki/note.md", "wiki/linkdir/x.md", "../outside-157.md", "wiki/missing.md"}, failed)
|
||||||
|
for _, p := range []string{regular, inLinked, outside} {
|
||||||
|
_, err := os.Stat(p)
|
||||||
|
assert.NoError(t, err, "%s must not be deleted", p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Dir targets and in-brain targets survive too, not only an outside file.
|
||||||
|
func TestWatchRemovesDirAndInBrainLinksButNotTheirTargets(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
outsideDir := t.TempDir()
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(outsideDir, "keep.md"), []byte("keep"), 0o644))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(brain, "wiki"), 0o755))
|
||||||
|
inBrain := filepath.Join(brain, "wiki", "target.md")
|
||||||
|
require.NoError(t, os.WriteFile(inBrain, []byte("t"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(outsideDir, filepath.Join(brain, "wiki", "dirlink")))
|
||||||
|
require.NoError(t, os.Symlink(inBrain, filepath.Join(brain, "wiki", "inlink.md")))
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go Watch(ctx, brain, 10*time.Millisecond, nil)
|
||||||
|
require.Eventually(t, func() bool {
|
||||||
|
r, err := Scan(brain)
|
||||||
|
return err == nil && len(r.Symlinks) == 0
|
||||||
|
}, 2*time.Second, 10*time.Millisecond)
|
||||||
|
for _, p := range []string{filepath.Join(outsideDir, "keep.md"), inBrain} {
|
||||||
|
_, err := os.Stat(p)
|
||||||
|
assert.NoError(t, err, "%s must survive", p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// PR #160 review: the planter chooses the paths. An alert names at most
|
||||||
|
// maxPathsPerAlert of them and counts the rest, so its size stays bounded.
|
||||||
|
func TestWatchAlertNamesBoundedPathsAndCountsTheRest(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
for i := 0; i < 50; i++ {
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), filepath.Join(brain, strings.Repeat("n", 100)+strconv.Itoa(i))))
|
||||||
|
}
|
||||||
|
n := &recNotifier{}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go Watch(ctx, brain, 10*time.Millisecond, n)
|
||||||
|
require.Eventually(t, func() bool { return n.count() >= 1 }, 2*time.Second, 10*time.Millisecond)
|
||||||
|
n.mu.Lock()
|
||||||
|
msg := n.msgs[0]
|
||||||
|
n.mu.Unlock()
|
||||||
|
assert.Contains(t, msg, "removed 50 symlink(s)")
|
||||||
|
assert.Contains(t, msg, "and 40 more")
|
||||||
|
assert.Less(t, len(msg), 2500, "alert size is bounded regardless of how many links were planted")
|
||||||
|
}
|
||||||
|
|
||||||
|
// rejectNotifier refuses every message containing a marker, forever.
|
||||||
|
type rejectNotifier struct {
|
||||||
|
recNotifier
|
||||||
|
reject string
|
||||||
|
}
|
||||||
|
|
||||||
|
// permanentErr is a rejection the notifier says can never succeed (like ntfy 413).
|
||||||
|
type permanentErr struct{}
|
||||||
|
|
||||||
|
func (permanentErr) Error() string { return "413 payload too large" }
|
||||||
|
func (permanentErr) Permanent() bool { return true }
|
||||||
|
|
||||||
|
func (r *rejectNotifier) Notify(ctx context.Context, m string) error {
|
||||||
|
if strings.Contains(m, r.reject) {
|
||||||
|
r.mu.Lock()
|
||||||
|
r.msgs = append(r.msgs, "REJECTED")
|
||||||
|
r.mu.Unlock()
|
||||||
|
return permanentErr{}
|
||||||
|
}
|
||||||
|
return r.recNotifier.Notify(ctx, m)
|
||||||
|
}
|
||||||
|
|
||||||
|
// PR #160 review: one message the server will never accept blocked every
|
||||||
|
// later alert forever (head-of-line). It is dropped after maxAttempts.
|
||||||
|
func TestWatchDropsAMessageThatNeverSendsSoLaterAlertsFlow(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
n := &rejectNotifier{reject: "POISON"}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go Watch(ctx, brain, 10*time.Millisecond, n)
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), filepath.Join(brain, "POISON")))
|
||||||
|
time.Sleep(30 * time.Millisecond)
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), filepath.Join(brain, "later")))
|
||||||
|
require.Eventually(t, func() bool {
|
||||||
|
n.mu.Lock()
|
||||||
|
defer n.mu.Unlock()
|
||||||
|
for _, m := range n.msgs {
|
||||||
|
if strings.Contains(m, "later") {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}, 3*time.Second, 10*time.Millisecond, "a later alert is delivered despite a poison message")
|
||||||
|
}
|
||||||
|
|
||||||
|
// toggleNotifier fails while down is set.
|
||||||
|
type toggleNotifier struct {
|
||||||
|
recNotifier
|
||||||
|
down atomic.Bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *toggleNotifier) Notify(ctx context.Context, m string) error {
|
||||||
|
if r.down.Load() {
|
||||||
|
return errors.New("ntfy down")
|
||||||
|
}
|
||||||
|
return r.recNotifier.Notify(ctx, m)
|
||||||
|
}
|
||||||
|
|
||||||
|
// PR #160 review: an outage queued one message per removal, unbounded. The
|
||||||
|
// queue holds at most maxPending messages; the rest become one summary.
|
||||||
|
func TestWatchQueueIsBoundedDuringAnOutage(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
n := &toggleNotifier{}
|
||||||
|
n.down.Store(true)
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go Watch(ctx, brain, 5*time.Millisecond, n)
|
||||||
|
for i := 0; i < 30; i++ {
|
||||||
|
link := filepath.Join(brain, "p"+strconv.Itoa(i))
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), link))
|
||||||
|
require.Eventually(t, func() bool { _, err := os.Lstat(link); return os.IsNotExist(err) }, 2*time.Second, 2*time.Millisecond)
|
||||||
|
}
|
||||||
|
n.down.Store(false)
|
||||||
|
require.Eventually(t, func() bool { return n.count() >= 1 }, 2*time.Second, 5*time.Millisecond)
|
||||||
|
time.Sleep(100 * time.Millisecond)
|
||||||
|
assert.LessOrEqual(t, n.count(), maxPending+1, "queued alerts plus at most one suppression summary")
|
||||||
|
n.mu.Lock()
|
||||||
|
defer n.mu.Unlock()
|
||||||
|
found := false
|
||||||
|
for _, m := range n.msgs {
|
||||||
|
if strings.Contains(m, "suppressed") {
|
||||||
|
found = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
assert.True(t, found, "suppressed alerts are counted in a summary")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Within the bound, every alert queued during an outage is delivered after
|
||||||
|
// it, each naming its own removal (PR #160 review: truncating the queue after
|
||||||
|
// the first send stayed green).
|
||||||
|
func TestWatchDeliversEveryQueuedAlertAfterAShortOutage(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
n := &toggleNotifier{}
|
||||||
|
n.down.Store(true)
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go Watch(ctx, brain, 5*time.Millisecond, n)
|
||||||
|
for _, name := range []string{"qa", "qb", "qc"} {
|
||||||
|
link := filepath.Join(brain, name)
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), link))
|
||||||
|
require.Eventually(t, func() bool { _, err := os.Lstat(link); return os.IsNotExist(err) }, 2*time.Second, 2*time.Millisecond)
|
||||||
|
}
|
||||||
|
n.down.Store(false)
|
||||||
|
require.Eventually(t, func() bool { return n.count() == 3 }, 2*time.Second, 5*time.Millisecond)
|
||||||
|
n.mu.Lock()
|
||||||
|
defer n.mu.Unlock()
|
||||||
|
for i, name := range []string{"qa", "qb", "qc"} {
|
||||||
|
assert.Contains(t, n.msgs[i], strconv.Quote(name))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// PR #160 round 2: dropping after N failures could not tell a poison message
|
||||||
|
// from an outage, so a 15-minute outage silently lost the only incident. A
|
||||||
|
// message is only dropped when it keeps failing while others send; through
|
||||||
|
// an outage nothing is dropped, however long.
|
||||||
|
func TestWatchLosesNoAlertThroughALongOutage(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
n := &toggleNotifier{}
|
||||||
|
n.down.Store(true)
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go Watch(ctx, brain, 2*time.Millisecond, n)
|
||||||
|
link := filepath.Join(brain, "only-incident")
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), link))
|
||||||
|
require.Eventually(t, func() bool { _, err := os.Lstat(link); return os.IsNotExist(err) }, 2*time.Second, 2*time.Millisecond)
|
||||||
|
time.Sleep(200 * time.Millisecond) // ~100 ticks of outage, far past any attempt limit
|
||||||
|
n.down.Store(false)
|
||||||
|
require.Eventually(t, func() bool { return n.count() >= 1 }, 2*time.Second, 5*time.Millisecond)
|
||||||
|
n.mu.Lock()
|
||||||
|
defer n.mu.Unlock()
|
||||||
|
assert.Contains(t, n.msgs[0], strconv.Quote("only-incident"))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Every removal is either delivered or counted in the suppression summary:
|
||||||
|
// none disappears from the record (round 2: 74 of 300 were in neither).
|
||||||
|
func TestWatchAccountsForEveryRemovalDuringAnOutage(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
n := &toggleNotifier{}
|
||||||
|
n.down.Store(true)
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go Watch(ctx, brain, 2*time.Millisecond, n)
|
||||||
|
const plants = 25
|
||||||
|
for i := 0; i < plants; i++ {
|
||||||
|
link := filepath.Join(brain, "acct"+strconv.Itoa(i))
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), link))
|
||||||
|
require.Eventually(t, func() bool { _, err := os.Lstat(link); return os.IsNotExist(err) }, 2*time.Second, 1*time.Millisecond)
|
||||||
|
}
|
||||||
|
n.down.Store(false)
|
||||||
|
require.Eventually(t, func() bool {
|
||||||
|
n.mu.Lock()
|
||||||
|
defer n.mu.Unlock()
|
||||||
|
for _, m := range n.msgs {
|
||||||
|
if strings.Contains(m, "suppressed") {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}, 2*time.Second, 5*time.Millisecond)
|
||||||
|
time.Sleep(50 * time.Millisecond)
|
||||||
|
n.mu.Lock()
|
||||||
|
defer n.mu.Unlock()
|
||||||
|
delivered, counted := 0, 0
|
||||||
|
for _, m := range n.msgs {
|
||||||
|
if strings.Contains(m, "removed 1 symlink(s)") {
|
||||||
|
delivered++
|
||||||
|
}
|
||||||
|
if i := strings.Index(m, "): "); i >= 0 && strings.Contains(m, "suppressed") {
|
||||||
|
_, _ = fmt.Sscanf(m[i+3:], "%d", &counted)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
assert.Equal(t, plants, delivered+counted, "delivered %d + counted %d must equal %d removals", delivered, counted, plants)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A poison message is still dropped (others send while it fails), and the
|
||||||
|
// drop is counted in the summary.
|
||||||
|
func TestWatchDropsAPoisonMessageAndCountsIt(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
n := &rejectNotifier{reject: "POISON"}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go Watch(ctx, brain, 5*time.Millisecond, n)
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), filepath.Join(brain, "POISON")))
|
||||||
|
time.Sleep(20 * time.Millisecond)
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), filepath.Join(brain, "fine")))
|
||||||
|
require.Eventually(t, func() bool {
|
||||||
|
n.mu.Lock()
|
||||||
|
defer n.mu.Unlock()
|
||||||
|
for _, m := range n.msgs {
|
||||||
|
if strings.Contains(m, "1 further alert(s)") {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}, 3*time.Second, 5*time.Millisecond, "the dropped poison alert is counted in a summary")
|
||||||
|
}
|
||||||
|
|||||||
@@ -2,12 +2,15 @@ package vectorstore
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"io/fs"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"os"
|
"path"
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Embedder produces dense vectors. The embed package's Client satisfies
|
// Embedder produces dense vectors. The embed package's Client satisfies
|
||||||
@@ -90,31 +93,38 @@ func Sync(ctx context.Context, brainDir string, store Store, embedder Embedder)
|
|||||||
}
|
}
|
||||||
seenParents := make(map[string]struct{})
|
seenParents := make(map[string]struct{})
|
||||||
|
|
||||||
|
// Through the brain root, regular files only (hyperguild#157): the brain
|
||||||
|
// is a Syncthing folder, and os.ReadFile followed a synced symlink into
|
||||||
|
// the embeddings and blocked on a FIFO.
|
||||||
|
bfs, err := brainfs.Open(brainDir)
|
||||||
|
if err != nil {
|
||||||
|
return res, fmt.Errorf("open brain: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = bfs.Close() }()
|
||||||
|
|
||||||
for _, sub := range scanDirs {
|
for _, sub := range scanDirs {
|
||||||
root := filepath.Join(brainDir, sub)
|
if _, err := bfs.Lstat(sub); errors.Is(err, fs.ErrNotExist) {
|
||||||
if _, err := os.Stat(root); os.IsNotExist(err) {
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
// Any other walk error, including a scan root that is a symlink,
|
||||||
err = filepath.WalkDir(root, func(path string, d os.DirEntry, err error) error {
|
// aborts the run below.
|
||||||
if err != nil {
|
var walkErr error
|
||||||
return err
|
onErr := func(rel string, err error) {
|
||||||
|
if walkErr == nil {
|
||||||
|
walkErr = fmt.Errorf("%s: %w", rel, err)
|
||||||
}
|
}
|
||||||
if d.IsDir() || !strings.HasSuffix(path, ".md") || d.Name() == "_index.md" {
|
}
|
||||||
|
err = bfs.WalkRegular(sub, func(relSlash string) error {
|
||||||
|
if !strings.HasSuffix(relSlash, ".md") || path.Base(relSlash) == "_index.md" {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
rel, err := filepath.Rel(brainDir, path)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
relSlash := filepath.ToSlash(rel)
|
|
||||||
seenParents[relSlash] = struct{}{}
|
seenParents[relSlash] = struct{}{}
|
||||||
|
|
||||||
if ps, ok := parents[relSlash]; ok {
|
if ps, ok := parents[relSlash]; ok {
|
||||||
// File already has chunks in the store. Re-embed only when
|
// File already has chunks in the store. Re-embed only when
|
||||||
// the file has been edited since the oldest chunk was
|
// the file has been edited since the oldest chunk was
|
||||||
// written. Tolerate clock skew with a sub-second grace.
|
// written. Tolerate clock skew with a sub-second grace.
|
||||||
info, statErr := d.Info()
|
info, statErr := bfs.Lstat(relSlash)
|
||||||
if statErr != nil {
|
if statErr != nil {
|
||||||
res.Errors = append(res.Errors, fmt.Errorf("stat %s: %w", relSlash, statErr))
|
res.Errors = append(res.Errors, fmt.Errorf("stat %s: %w", relSlash, statErr))
|
||||||
return nil
|
return nil
|
||||||
@@ -132,7 +142,7 @@ func Sync(ctx context.Context, brainDir string, store Store, embedder Embedder)
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
content, readErr := os.ReadFile(path)
|
content, readErr := bfs.ReadRegular(relSlash)
|
||||||
if readErr != nil {
|
if readErr != nil {
|
||||||
res.Errors = append(res.Errors, fmt.Errorf("read %s: %w", relSlash, readErr))
|
res.Errors = append(res.Errors, fmt.Errorf("read %s: %w", relSlash, readErr))
|
||||||
return nil
|
return nil
|
||||||
@@ -151,7 +161,12 @@ func Sync(ctx context.Context, brainDir string, store Store, embedder Embedder)
|
|||||||
res.Added++
|
res.Added++
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
})
|
}, onErr)
|
||||||
|
if err == nil {
|
||||||
|
err = walkErr
|
||||||
|
}
|
||||||
|
// Abort before the delete pass: an incomplete walk would leave
|
||||||
|
// seenParents short and delete chunks of files that still exist.
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return res, fmt.Errorf("walk %s: %w", sub, err)
|
return res, fmt.Errorf("walk %s: %w", sub, err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,126 @@
|
|||||||
|
package vectorstore_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs/brainfstest"
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/vectorstore"
|
||||||
|
)
|
||||||
|
|
||||||
|
// recordingEmbedder keeps every text it was asked to embed.
|
||||||
|
type recordingEmbedder struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
texts []string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *recordingEmbedder) Embed(_ context.Context, text string) ([]float32, error) {
|
||||||
|
e.mu.Lock()
|
||||||
|
defer e.mu.Unlock()
|
||||||
|
e.texts = append(e.texts, text)
|
||||||
|
return []float32{1}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *recordingEmbedder) all() string {
|
||||||
|
e.mu.Lock()
|
||||||
|
defer e.mu.Unlock()
|
||||||
|
return strings.Join(e.texts, "\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
// hyperguild#157 slice 3: Sync walked wiki/ and knowledge/ and read each .md
|
||||||
|
// with os.ReadFile, so a symlinked note had its target embedded and served by
|
||||||
|
// semantic search, and a FIFO stalled the sync.
|
||||||
|
func TestSyncRefusesSymlinkedNotesAndSurvivesSwapRaces(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
writeNote(t, brain, "wiki/w/facts/ok.md", "inside note")
|
||||||
|
require.NoError(t, os.Symlink(brainfstest.Outside(t), filepath.Join(brain, "wiki", "w", "facts", "leak.md")))
|
||||||
|
|
||||||
|
emb := &recordingEmbedder{}
|
||||||
|
store := &stubStore{}
|
||||||
|
_, err := vectorstore.Sync(context.Background(), brain, store, emb)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Contains(t, emb.all(), "inside note", "positive control: the regular note is embedded")
|
||||||
|
assert.NotContains(t, emb.all(), brainfstest.Sentinel)
|
||||||
|
for p := range store.upserts {
|
||||||
|
assert.NotContains(t, p, "leak.md")
|
||||||
|
}
|
||||||
|
|
||||||
|
p := filepath.Join(brain, "knowledge", "r.md")
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Dir(p), 0o755))
|
||||||
|
sync := func() string {
|
||||||
|
e := &recordingEmbedder{}
|
||||||
|
_, _ = vectorstore.Sync(context.Background(), brain, &stubStore{}, e)
|
||||||
|
return e.all()
|
||||||
|
}
|
||||||
|
brainfstest.AssertNoLeak(t, p, "inside", 1500*time.Millisecond, sync)
|
||||||
|
brainfstest.AssertNoHang(t, p, "inside", 1500*time.Millisecond, 6*time.Second, func() { _ = sync() })
|
||||||
|
}
|
||||||
|
|
||||||
|
// Chunks embedded from a symlinked note before this fix are deleted: the
|
||||||
|
// note is no longer seen, so the delete pass drops its rows.
|
||||||
|
func TestSyncDeletesChunksOfASymlinkedNote(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
writeNote(t, brain, "wiki/w/facts/ok.md", "inside note")
|
||||||
|
require.NoError(t, os.Symlink(brainfstest.Outside(t), filepath.Join(brain, "wiki", "w", "facts", "leak.md")))
|
||||||
|
store := &stubStore{known: map[string]time.Time{
|
||||||
|
"wiki/w/facts/leak.md#0001": {},
|
||||||
|
"wiki/w/facts/ok.md#0001": {},
|
||||||
|
}}
|
||||||
|
_, err := vectorstore.Sync(context.Background(), brain, store, &recordingEmbedder{})
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, []string{"wiki/w/facts/leak.md#0001"}, store.deletes)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A walk error aborts Sync before the delete pass, so chunks of files the
|
||||||
|
// walk could not see are kept.
|
||||||
|
func TestSyncAbortsBeforeDeletingWhenASubdirIsUnreadable(t *testing.T) {
|
||||||
|
if os.Geteuid() == 0 {
|
||||||
|
t.Skip("root ignores directory permissions")
|
||||||
|
}
|
||||||
|
brain := t.TempDir()
|
||||||
|
writeNote(t, brain, "wiki/w/facts/ok.md", "inside note")
|
||||||
|
locked := filepath.Join(brain, "wiki", "w")
|
||||||
|
require.NoError(t, os.Chmod(locked, 0o000))
|
||||||
|
t.Cleanup(func() { _ = os.Chmod(locked, 0o755) })
|
||||||
|
store := &stubStore{known: map[string]time.Time{"wiki/w/facts/ok.md#0001": {}}}
|
||||||
|
_, err := vectorstore.Sync(context.Background(), brain, store, &recordingEmbedder{})
|
||||||
|
assert.Error(t, err)
|
||||||
|
assert.Empty(t, store.deletes)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A scan root that is a symlink inside the brain (knowledge -> .) was
|
||||||
|
// followed by fs.WalkDir, aliasing raw/, sessions/ and root files into the
|
||||||
|
// index. Sync now aborts on it, before embedding or deleting anything.
|
||||||
|
func TestSyncAbortsOnASymlinkedScanRoot(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
writeNote(t, brain, "wiki/w/a.md", "wiki note")
|
||||||
|
writeNote(t, brain, "sessions/s1.md", "session note")
|
||||||
|
require.NoError(t, os.Symlink(".", filepath.Join(brain, "knowledge")))
|
||||||
|
emb := &recordingEmbedder{}
|
||||||
|
store := &stubStore{known: map[string]time.Time{"wiki/w/a.md#0001": {}}}
|
||||||
|
_, err := vectorstore.Sync(context.Background(), brain, store, emb)
|
||||||
|
assert.Error(t, err)
|
||||||
|
assert.NotContains(t, emb.all(), "session note")
|
||||||
|
for p := range store.upserts {
|
||||||
|
assert.False(t, strings.HasPrefix(p, "knowledge/"), "upserted %s", p)
|
||||||
|
}
|
||||||
|
assert.Empty(t, store.deletes)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A missing scan root is skipped; the other root still syncs.
|
||||||
|
func TestSyncSkipsAMissingScanRoot(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
writeNote(t, brain, "wiki/w/a.md", "wiki note")
|
||||||
|
emb := &recordingEmbedder{}
|
||||||
|
_, err := vectorstore.Sync(context.Background(), brain, &stubStore{}, emb)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Contains(t, emb.all(), "wiki note")
|
||||||
|
}
|
||||||
@@ -8,6 +8,7 @@ import (
|
|||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
|
"sync"
|
||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"syscall"
|
"syscall"
|
||||||
"testing"
|
"testing"
|
||||||
@@ -343,7 +344,12 @@ func TestProcessDir_DoesNotHangUnderAFIFOSwapRace(t *testing.T) {
|
|||||||
brainDir := setupBrainDir(t)
|
brainDir := setupBrainDir(t)
|
||||||
raw := filepath.Join(brainDir, "raw")
|
raw := filepath.Join(brainDir, "raw")
|
||||||
var stop atomic.Bool
|
var stop atomic.Bool
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
wg.Add(1)
|
||||||
|
// Awaited before t.TempDir's cleanup (hyperguild#162).
|
||||||
|
t.Cleanup(func() { stop.Store(true); wg.Wait() })
|
||||||
go func() {
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
for i := 0; !stop.Load(); i++ {
|
for i := 0; !stop.Load(); i++ {
|
||||||
tmp := filepath.Join(raw, ".swap")
|
tmp := filepath.Join(raw, ".swap")
|
||||||
_ = os.Remove(tmp)
|
_ = os.Remove(tmp)
|
||||||
|
|||||||
Reference in New Issue
Block a user