Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
47354dc4fc |
@@ -179,12 +179,9 @@ func alertingWarnings(getenv func(string) string) []string {
|
|||||||
return out
|
return out
|
||||||
}
|
}
|
||||||
|
|
||||||
// buildNotifier returns the ntfy notifier for one alert source, titled so
|
func buildNotifier() audit.Notifier {
|
||||||
// the source is recognisable (hyperguild#163), or nil when ntfy is not
|
if n := audit.NewNtfyNotifier(os.Getenv("BRAIN_NTFY_URL"), os.Getenv("BRAIN_NTFY_TOKEN")); n != nil {
|
||||||
// configured.
|
return n
|
||||||
func buildNotifier(getenv func(string) string, title string) audit.Notifier {
|
|
||||||
if n := audit.NewNtfyNotifier(getenv("BRAIN_NTFY_URL"), getenv("BRAIN_NTFY_TOKEN")); n != nil {
|
|
||||||
return n.WithTitle(title)
|
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -206,7 +203,7 @@ func buildAuditSink(ctx context.Context, brainDir string, logger *slog.Logger) c
|
|||||||
logger.Error("capture audit buffer init", "err", err)
|
logger.Error("capture audit buffer init", "err", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
notifier := buildNotifier(os.Getenv, "brain-capture audit degraded")
|
notifier := buildNotifier()
|
||||||
reconcileInterval := time.Duration(envInt("BRAIN_AUDIT_RECONCILE_INTERVAL", 60)) * time.Second
|
reconcileInterval := time.Duration(envInt("BRAIN_AUDIT_RECONCILE_INTERVAL", 60)) * time.Second
|
||||||
audit.StartReconcile(ctx, central, buffer, notifier, reconcileInterval)
|
audit.StartReconcile(ctx, central, buffer, notifier, reconcileInterval)
|
||||||
logger.Info("capture audit: loki+buffer sink", "loki", lokiURL, "reconcile_s", int(reconcileInterval.Seconds()))
|
logger.Info("capture audit: loki+buffer sink", "loki", lokiURL, "reconcile_s", int(reconcileInterval.Seconds()))
|
||||||
@@ -369,7 +366,7 @@ func main() {
|
|||||||
|
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
// hyperguild#157: report a symlink that appears in the brain while running.
|
// hyperguild#157: report a symlink that appears in the brain while running.
|
||||||
go symlinkguard.Watch(ctx, brainDir, symlinkScanInterval(os.Getenv), buildNotifier(os.Getenv, "brain symlink tripwire"))
|
go symlinkguard.Watch(ctx, brainDir, symlinkScanInterval(os.Getenv), buildNotifier())
|
||||||
|
|
||||||
// Never fatal on an unreachable issuer (#83): on a cold cluster boot this
|
// Never fatal on an unreachable issuer (#83): on a cold cluster boot this
|
||||||
// pod can beat dex to serving and get a 502 from ingress, and exiting meant
|
// pod can beat dex to serving and get a 502 from ingress, and exiting meant
|
||||||
@@ -549,7 +546,7 @@ func main() {
|
|||||||
// capture already gets, plus an out-of-band alert. Wired here because
|
// capture already gets, plus an out-of-band alert. Wired here because
|
||||||
// brain_edit_root needs the capture plumbing anyway — that is what
|
// brain_edit_root needs the capture plumbing anyway — that is what
|
||||||
// re-derives the static principal its gate checks.
|
// re-derives the static principal its gate checks.
|
||||||
mcpSrv.WithGovernanceObserver(auditSink, buildNotifier(os.Getenv, "brain governance edit"))
|
mcpSrv.WithGovernanceObserver(auditSink, buildNotifier())
|
||||||
logger.Info("capture enabled (REST + MCP tool)", "sovereign_principals", len(sovereign),
|
logger.Info("capture enabled (REST + MCP tool)", "sovereign_principals", len(sovereign),
|
||||||
"governance_observer", true)
|
"governance_observer", true)
|
||||||
} else {
|
} else {
|
||||||
|
|||||||
@@ -1,9 +1,6 @@
|
|||||||
package main
|
package main
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -77,16 +74,3 @@ func TestStartupSymlinkCheckRefusesABrainWithAFIFO(t *testing.T) {
|
|||||||
require.Error(t, err)
|
require.Error(t, err)
|
||||||
assert.Contains(t, err.Error(), "classification.yaml")
|
assert.Contains(t, err.Error(), "classification.yaml")
|
||||||
}
|
}
|
||||||
|
|
||||||
// hyperguild#163: each alert source gets its own ntfy title.
|
|
||||||
func TestBuildNotifierUsesTheGivenTitle(t *testing.T) {
|
|
||||||
var got string
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { got = r.Header.Get("Title") }))
|
|
||||||
defer srv.Close()
|
|
||||||
env := map[string]string{"BRAIN_NTFY_URL": srv.URL}
|
|
||||||
n := buildNotifier(func(k string) string { return env[k] }, "brain symlink tripwire")
|
|
||||||
require.NotNil(t, n)
|
|
||||||
require.NoError(t, n.Notify(context.Background(), "m"))
|
|
||||||
assert.Equal(t, "brain symlink tripwire", got)
|
|
||||||
assert.Nil(t, buildNotifier(func(string) string { return "" }, "x"), "no ntfy URL, no notifier")
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -12,7 +12,6 @@ import (
|
|||||||
"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/pipeline"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/pipeline"
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/search"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/search"
|
||||||
@@ -228,22 +227,14 @@ func writeHallNote(brainDir string, opts WriteNoteOptions) (string, error) {
|
|||||||
// The directory is created only once the note is known to be writable:
|
// The directory is created only once the note is known to be writable:
|
||||||
// a refused write leaves nothing behind, not even an empty hall dir
|
// a refused write leaves nothing behind, not even an empty hall dir
|
||||||
// (brain#21; provenance refusal joins the envelope refusal here).
|
// (brain#21; provenance refusal joins the envelope refusal here).
|
||||||
// Created through the brain root, never through a symlinked wing or
|
if err := os.MkdirAll(filepath.Dir(dest), 0o755); err != nil {
|
||||||
// hall directory (hyperguild#188).
|
return "", fmt.Errorf("create hall dir: %w", err)
|
||||||
rel, err := filepath.Rel(brainDir, dest)
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("note path: %w", err)
|
|
||||||
}
|
}
|
||||||
rel = filepath.ToSlash(rel)
|
if err := os.WriteFile(dest, []byte(final), 0o644); err != nil {
|
||||||
bfs, err := brainfs.Open(brainDir)
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("open brain: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = bfs.Close() }()
|
|
||||||
if err := bfs.PutRegular(rel, []byte(final)); err != nil {
|
|
||||||
return "", fmt.Errorf("write: %w", err)
|
return "", fmt.Errorf("write: %w", err)
|
||||||
}
|
}
|
||||||
return rel, nil
|
rel, _ := filepath.Rel(brainDir, dest)
|
||||||
|
return filepath.ToSlash(rel), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// scalarValues flattens frontmatter fields to key -> scalar value for
|
// scalarValues flattens frontmatter fields to key -> scalar value for
|
||||||
|
|||||||
@@ -127,18 +127,18 @@ func PromoteNote(brainDir string, opts PromoteOptions) (string, error) {
|
|||||||
}
|
}
|
||||||
fm.set("promoted_at", now)
|
fm.set("promoted_at", now)
|
||||||
|
|
||||||
// Write-then-delete: the source survives any write failure. Both go
|
if err := os.MkdirAll(filepath.Dir(dest), 0o755); err != nil {
|
||||||
// through the brain root (hyperguild#188).
|
return "", fmt.Errorf("create wing dir: %w", err)
|
||||||
|
}
|
||||||
|
// Write-then-delete: the source survives any write failure.
|
||||||
promoted, err := StampProvenance(fm.render()+body, opts.Origin, opts.WrittenBy)
|
promoted, err := StampProvenance(fm.render()+body, opts.Origin, opts.WrittenBy)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
// Created with O_EXCL: a note that appeared after the collision check
|
if err := os.WriteFile(dest, []byte(promoted), 0o644); err != nil {
|
||||||
// above is never overwritten.
|
|
||||||
if err := createBrainFile(brainDir, dest, []byte(promoted)); err != nil {
|
|
||||||
return "", fmt.Errorf("write promoted note: %w", err)
|
return "", fmt.Errorf("write promoted note: %w", err)
|
||||||
}
|
}
|
||||||
if err := removeBrainFile(brainDir, src); err != nil {
|
if err := os.Remove(src); err != nil {
|
||||||
return "", fmt.Errorf("promoted note written but source removal failed: %w", err)
|
return "", fmt.Errorf("promoted note written but source removal failed: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -196,12 +196,14 @@ func RejectNote(brainDir string, opts RejectOptions) (string, error) {
|
|||||||
fm.set("reject_reason", opts.Reason)
|
fm.set("reject_reason", opts.Reason)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Write-then-delete: the source survives any write failure. Both go
|
if err := os.MkdirAll(filepath.Dir(dest), 0o755); err != nil {
|
||||||
// through the brain root (hyperguild#188).
|
return "", fmt.Errorf("create rejected dir: %w", err)
|
||||||
if err := createBrainFile(brainDir, dest, []byte(fm.render()+body)); err != nil {
|
}
|
||||||
|
// Write-then-delete: the source survives any write failure.
|
||||||
|
if err := os.WriteFile(dest, []byte(fm.render()+body), 0o644); err != nil {
|
||||||
return "", fmt.Errorf("write rejected note: %w", err)
|
return "", fmt.Errorf("write rejected note: %w", err)
|
||||||
}
|
}
|
||||||
if err := removeBrainFile(brainDir, src); err != nil {
|
if err := os.Remove(src); err != nil {
|
||||||
return "", fmt.Errorf("rejected note written but source removal failed: %w", err)
|
return "", fmt.Errorf("rejected note written but source removal failed: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,87 +0,0 @@
|
|||||||
package api_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
|
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/api"
|
|
||||||
)
|
|
||||||
|
|
||||||
// hyperguild#188: promote and reject wrote the destination with
|
|
||||||
// os.MkdirAll + os.WriteFile by path, so a symlinked wing (promote) or a
|
|
||||||
// symlinked raw/rejected (reject) redirected the note; the raw source was
|
|
||||||
// then removed.
|
|
||||||
func TestPromoteAndRejectRefuseASymlinkedDestinationDirectory(t *testing.T) {
|
|
||||||
brain := t.TempDir()
|
|
||||||
outside := t.TempDir()
|
|
||||||
raw := filepath.Join(brain, "raw")
|
|
||||||
require.NoError(t, os.MkdirAll(raw, 0o755))
|
|
||||||
require.NoError(t, os.WriteFile(filepath.Join(raw, "2026-10-05-n.md"), []byte("---\ntitle: n\n---\nbody\n"), 0o644))
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(brain, "wiki"), 0o755))
|
|
||||||
require.NoError(t, os.Symlink(outside, filepath.Join(brain, "wiki", "lw")))
|
|
||||||
require.NoError(t, os.Symlink(outside, filepath.Join(raw, "rejected")))
|
|
||||||
|
|
||||||
_, err := api.PromoteNote(brain, api.PromoteOptions{Filename: "2026-10-05-n.md", Wing: "lw", Hall: "facts"})
|
|
||||||
assert.Error(t, err)
|
|
||||||
_, err = api.RejectNote(brain, api.RejectOptions{Filename: "2026-10-05-n.md"})
|
|
||||||
assert.Error(t, err)
|
|
||||||
ents, _ := os.ReadDir(outside)
|
|
||||||
assert.Empty(t, ents, "a note was written outside the brain")
|
|
||||||
_, err = os.Stat(filepath.Join(raw, "2026-10-05-n.md"))
|
|
||||||
assert.NoError(t, err, "the raw source is kept when the write is refused")
|
|
||||||
|
|
||||||
require.NoError(t, os.Remove(filepath.Join(raw, "rejected")))
|
|
||||||
_, err = api.PromoteNote(brain, api.PromoteOptions{Filename: "2026-10-05-n.md", Wing: "w", Hall: "facts"})
|
|
||||||
require.NoError(t, err, "positive control: promote into a real wing")
|
|
||||||
}
|
|
||||||
|
|
||||||
// StampProvenanceFile read and rewrote the note by path (provenance.ApplyFile).
|
|
||||||
func TestStampProvenanceFileRefusesANoteBehindASymlinkedDirectory(t *testing.T) {
|
|
||||||
brain := t.TempDir()
|
|
||||||
victim := filepath.Join(brain, "raw", "facts", "v.md")
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Dir(victim), 0o755))
|
|
||||||
require.NoError(t, os.WriteFile(victim, []byte("---\ntitle: v\n---\nuntouched\n"), 0o644))
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(brain, "wiki", "w"), 0o755))
|
|
||||||
require.NoError(t, os.Symlink(filepath.Join("..", "..", "raw", "facts"), filepath.Join(brain, "wiki", "w", "alias")))
|
|
||||||
assert.Error(t, api.StampProvenanceFile(brain, "wiki/w/alias/v.md", "static", "x"))
|
|
||||||
got, _ := os.ReadFile(victim)
|
|
||||||
assert.Equal(t, "---\ntitle: v\n---\nuntouched\n", string(got))
|
|
||||||
|
|
||||||
real := filepath.Join(brain, "wiki", "w", "facts", "r.md")
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Dir(real), 0o755))
|
|
||||||
require.NoError(t, os.WriteFile(real, []byte("---\ntitle: r\n---\nbody\n"), 0o644))
|
|
||||||
require.NoError(t, api.StampProvenanceFile(brain, "wiki/w/facts/r.md", "static", "x"), "positive control")
|
|
||||||
got, _ = os.ReadFile(real)
|
|
||||||
assert.Contains(t, string(got), "written_by: x")
|
|
||||||
}
|
|
||||||
|
|
||||||
// The same through an in-brain symlinked wing and raw/rejected, which
|
|
||||||
// os.Root alone would follow.
|
|
||||||
func TestPromoteAndRejectRefuseAnInBrainSymlinkedDestinationDirectory(t *testing.T) {
|
|
||||||
brain := t.TempDir()
|
|
||||||
raw := filepath.Join(brain, "raw")
|
|
||||||
require.NoError(t, os.MkdirAll(raw, 0o755))
|
|
||||||
require.NoError(t, os.WriteFile(filepath.Join(raw, "2026-10-05-n.md"), []byte("---\ntitle: n\n---\nbody\n"), 0o644))
|
|
||||||
target := filepath.Join(brain, "archive")
|
|
||||||
require.NoError(t, os.MkdirAll(target, 0o755))
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(brain, "wiki"), 0o755))
|
|
||||||
require.NoError(t, os.Symlink(filepath.Join("..", "archive"), filepath.Join(brain, "wiki", "lw")))
|
|
||||||
require.NoError(t, os.Symlink(filepath.Join("..", "archive"), filepath.Join(raw, "rejected")))
|
|
||||||
|
|
||||||
_, err := api.PromoteNote(brain, api.PromoteOptions{Filename: "2026-10-05-n.md", Wing: "lw", Hall: "facts"})
|
|
||||||
assert.Error(t, err)
|
|
||||||
_, err = api.RejectNote(brain, api.RejectOptions{Filename: "2026-10-05-n.md"})
|
|
||||||
assert.Error(t, err)
|
|
||||||
ents, _ := os.ReadDir(target)
|
|
||||||
assert.Empty(t, ents, "a note was written at the in-brain link's target")
|
|
||||||
_, err = os.Stat(filepath.Join(raw, "2026-10-05-n.md"))
|
|
||||||
assert.NoError(t, err, "the raw source is kept")
|
|
||||||
|
|
||||||
require.NoError(t, os.Remove(filepath.Join(raw, "rejected")))
|
|
||||||
_, err = api.RejectNote(brain, api.RejectOptions{Filename: "2026-10-05-n.md"})
|
|
||||||
require.NoError(t, err, "positive control: reject into a real raw/rejected")
|
|
||||||
}
|
|
||||||
@@ -1,10 +1,6 @@
|
|||||||
package api
|
package api
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
|
||||||
"path/filepath"
|
|
||||||
|
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/provenance"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/provenance"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -15,61 +11,11 @@ func StampProvenance(content, origin, writtenBy string) (string, error) {
|
|||||||
return provenance.Apply(content, provenance.Stamp{Origin: origin, WrittenBy: writtenBy})
|
return provenance.Apply(content, provenance.Stamp{Origin: origin, WrittenBy: writtenBy})
|
||||||
}
|
}
|
||||||
|
|
||||||
// StampProvenanceFile applies StampProvenance to a brain-relative note path,
|
// StampProvenanceFile applies StampProvenance to a brain-relative note path.
|
||||||
// read and rewritten through the brain root (hyperguild#158).
|
|
||||||
func StampProvenanceFile(brainDir, relPath, origin, writtenBy string) error {
|
func StampProvenanceFile(brainDir, relPath, origin, writtenBy string) error {
|
||||||
rel, _, err := resolveWithin(brainDir, relPath)
|
_, abs, err := resolveWithin(brainDir, relPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
bfs, err := brainfs.Open(brainDir)
|
return provenance.ApplyFile(abs, provenance.Stamp{Origin: origin, WrittenBy: writtenBy})
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("open brain: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = bfs.Close() }()
|
|
||||||
b, err := bfs.ReadRegular(rel)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("read for provenance: %w", err)
|
|
||||||
}
|
|
||||||
out, err := provenance.Apply(string(b), provenance.Stamp{Origin: origin, WrittenBy: writtenBy})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if out == string(b) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if err := bfs.WriteRegular(rel, []byte(out)); err != nil {
|
|
||||||
return fmt.Errorf("write provenance: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// createBrainFile creates the file at abs (inside brainDir) through the
|
|
||||||
// brain root and fails if anything is already there.
|
|
||||||
func createBrainFile(brainDir, abs string, data []byte) error {
|
|
||||||
rel, err := filepath.Rel(brainDir, abs)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
bfs, err := brainfs.Open(brainDir)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("open brain: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = bfs.Close() }()
|
|
||||||
return bfs.CreateRegular(filepath.ToSlash(rel), data)
|
|
||||||
}
|
|
||||||
|
|
||||||
// removeBrainFile removes the file at abs (inside brainDir) through the
|
|
||||||
// brain root.
|
|
||||||
func removeBrainFile(brainDir, abs string) error {
|
|
||||||
rel, err := filepath.Rel(brainDir, abs)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
bfs, err := brainfs.Open(brainDir)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("open brain: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = bfs.Close() }()
|
|
||||||
return bfs.Remove(filepath.ToSlash(rel))
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,43 +0,0 @@
|
|||||||
package api_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
|
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/api"
|
|
||||||
)
|
|
||||||
|
|
||||||
// hyperguild#188: brain_write created a new note with os.MkdirAll +
|
|
||||||
// os.WriteFile by path, so a symlinked wing directory redirected the note
|
|
||||||
// elsewhere in the brain or outside it.
|
|
||||||
func TestWriteNoteRefusesASymlinkedWing(t *testing.T) {
|
|
||||||
for name, target := range map[string]func(t *testing.T, brain string) string{
|
|
||||||
"in-brain": func(t *testing.T, brain string) string {
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(brain, "raw"), 0o755))
|
|
||||||
return filepath.Join("..", "raw")
|
|
||||||
},
|
|
||||||
"outside": func(t *testing.T, _ string) string { return t.TempDir() },
|
|
||||||
} {
|
|
||||||
t.Run(name, func(t *testing.T) {
|
|
||||||
brain := t.TempDir()
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(brain, "wiki"), 0o755))
|
|
||||||
link := target(t, brain)
|
|
||||||
require.NoError(t, os.Symlink(link, filepath.Join(brain, "wiki", "lw")))
|
|
||||||
_, err := api.WriteNote(brain, api.WriteNoteOptions{Wing: "lw", Hall: "facts", Filename: "n", Content: "learning"})
|
|
||||||
assert.Error(t, err)
|
|
||||||
resolved := link
|
|
||||||
if !filepath.IsAbs(resolved) {
|
|
||||||
resolved = filepath.Join(brain, "wiki", link)
|
|
||||||
}
|
|
||||||
_, serr := os.Stat(filepath.Join(resolved, "facts"))
|
|
||||||
assert.True(t, os.IsNotExist(serr), "a hall was created at the link's target")
|
|
||||||
|
|
||||||
_, err = api.WriteNote(brain, api.WriteNoteOptions{Wing: "w", Hall: "facts", Filename: "n", Content: "learning"})
|
|
||||||
require.NoError(t, err, "positive control: a real wing is written")
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -13,14 +13,9 @@ import (
|
|||||||
type NtfyNotifier struct {
|
type NtfyNotifier struct {
|
||||||
topicURL string
|
topicURL string
|
||||||
token string
|
token string
|
||||||
title string
|
|
||||||
http *http.Client
|
http *http.Client
|
||||||
}
|
}
|
||||||
|
|
||||||
// defaultNtfyTitle is the title of a notifier built without WithTitle: the
|
|
||||||
// capture audit's degraded-state alert, its first user.
|
|
||||||
const defaultNtfyTitle = "brain-capture audit degraded"
|
|
||||||
|
|
||||||
// NewNtfyNotifier constructs a notifier for the given ntfy topic URL
|
// NewNtfyNotifier constructs a notifier for the given ntfy topic URL
|
||||||
// (e.g. https://ntfy.sh/my-topic). token is an optional bearer for
|
// (e.g. https://ntfy.sh/my-topic). token is an optional bearer for
|
||||||
// protected ntfy instances; it is held here and only sent in the
|
// protected ntfy instances; it is held here and only sent in the
|
||||||
@@ -32,31 +27,17 @@ func NewNtfyNotifier(topicURL, token string) *NtfyNotifier {
|
|||||||
return &NtfyNotifier{
|
return &NtfyNotifier{
|
||||||
topicURL: strings.TrimRight(topicURL, "/"),
|
topicURL: strings.TrimRight(topicURL, "/"),
|
||||||
token: token,
|
token: token,
|
||||||
title: defaultNtfyTitle,
|
|
||||||
http: &http.Client{Timeout: 10 * time.Second},
|
http: &http.Client{Timeout: 10 * time.Second},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// WithTitle returns a copy that sends title as the ntfy Title header, so each
|
|
||||||
// alert source (the capture audit, the symlink tripwire, governance edits)
|
|
||||||
// is recognisable on the phone (hyperguild#163). A nil notifier (ntfy not
|
|
||||||
// configured) stays nil.
|
|
||||||
func (n *NtfyNotifier) WithTitle(title string) *NtfyNotifier {
|
|
||||||
if n == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
c := *n
|
|
||||||
c.title = title
|
|
||||||
return &c
|
|
||||||
}
|
|
||||||
|
|
||||||
// Notify posts a message to the ntfy topic.
|
// Notify posts a message to the ntfy topic.
|
||||||
func (n *NtfyNotifier) Notify(ctx context.Context, msg string) error {
|
func (n *NtfyNotifier) Notify(ctx context.Context, msg string) error {
|
||||||
req, err := http.NewRequestWithContext(ctx, http.MethodPost, n.topicURL, strings.NewReader(msg))
|
req, err := http.NewRequestWithContext(ctx, http.MethodPost, n.topicURL, strings.NewReader(msg))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
req.Header.Set("Title", n.title)
|
req.Header.Set("Title", "brain-capture audit degraded")
|
||||||
req.Header.Set("Priority", "high")
|
req.Header.Set("Priority", "high")
|
||||||
req.Header.Set("Tags", "warning,brain")
|
req.Header.Set("Tags", "warning,brain")
|
||||||
if n.token != "" {
|
if n.token != "" {
|
||||||
|
|||||||
@@ -1,29 +0,0 @@
|
|||||||
package audit
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
)
|
|
||||||
|
|
||||||
// hyperguild#163: every alert went out titled "brain-capture audit
|
|
||||||
// degraded", including the symlink tripwire's and governance alerts.
|
|
||||||
func TestNtfyNotifierSendsItsOwnTitle(t *testing.T) {
|
|
||||||
var got []string
|
|
||||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
got = append(got, r.Header.Get("Title"))
|
|
||||||
}))
|
|
||||||
defer srv.Close()
|
|
||||||
base := NewNtfyNotifier(srv.URL, "")
|
|
||||||
require.NoError(t, base.Notify(context.Background(), "m"))
|
|
||||||
require.NoError(t, base.WithTitle("brain symlink tripwire").Notify(context.Background(), "m"))
|
|
||||||
require.NoError(t, base.Notify(context.Background(), "m"))
|
|
||||||
assert.Equal(t, []string{"brain-capture audit degraded", "brain symlink tripwire", "brain-capture audit degraded"}, got,
|
|
||||||
"WithTitle returns a copy; the base keeps its default title")
|
|
||||||
var nilN *NtfyNotifier
|
|
||||||
assert.Nil(t, nilN.WithTitle("x"), "nil (ntfy not configured) stays nil")
|
|
||||||
}
|
|
||||||
@@ -7,6 +7,8 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"io/fs"
|
"io/fs"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
@@ -30,6 +32,7 @@ func BuildWingIndex(brainDir, wing string) error {
|
|||||||
if w == "" {
|
if w == "" {
|
||||||
return fmt.Errorf("invalid wing %q", wing)
|
return fmt.Errorf("invalid wing %q", wing)
|
||||||
}
|
}
|
||||||
|
wingDir := filepath.Join(brainDir, "wiki", w)
|
||||||
// Listed and read through the brain root (hyperguild#157): a wing or
|
// Listed and read through the brain root (hyperguild#157): a wing or
|
||||||
// hall that is a symlink is not followed, and notes are regular files.
|
// hall that is a symlink is not followed, and notes are regular files.
|
||||||
bfs, err := brainfs.Open(brainDir)
|
bfs, err := brainfs.Open(brainDir)
|
||||||
@@ -60,9 +63,8 @@ func BuildWingIndex(brainDir, wing string) error {
|
|||||||
fmt.Fprintf(&b, "| %s | [%s](%s/%s.md) | %s |\n", e.Hall, e.Title, e.Hall, e.Slug, e.Created)
|
fmt.Fprintf(&b, "| %s | [%s](%s/%s.md) | %s |\n", e.Hall, e.Title, e.Hall, e.Slug, e.Created)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Written through the brain root, never through a symlinked _index.md
|
dest := filepath.Join(wingDir, "_index.md")
|
||||||
// (hyperguild#158).
|
return os.WriteFile(dest, []byte(b.String()), 0o644)
|
||||||
return bfs.PutRegular("wiki/"+w+"/_index.md", []byte(b.String()))
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// BuildAllWingIndexes regenerates _index.md for every wing under brain/wiki/.
|
// BuildAllWingIndexes regenerates _index.md for every wing under brain/wiki/.
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io/fs"
|
"io/fs"
|
||||||
|
"os"
|
||||||
"path"
|
"path"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -175,23 +176,35 @@ func logFuzzyCandidates(brainDir, sourcePath string, cs []TunnelCandidate) error
|
|||||||
if len(cs) == 0 {
|
if len(cs) == 0 {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
// Appended through the brain root, never through a symlinked raw/ or
|
rawDir := filepath.Join(brainDir, "raw")
|
||||||
// log file (hyperguild#158).
|
if err := os.MkdirAll(rawDir, 0o755); err != nil {
|
||||||
bfs, err := brainfs.Open(brainDir)
|
return err
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("open brain: %w", err)
|
|
||||||
}
|
}
|
||||||
defer func() { _ = bfs.Close() }()
|
|
||||||
stamp := time.Now().UTC().Format("2006-01-02")
|
stamp := time.Now().UTC().Format("2006-01-02")
|
||||||
rel := "raw/tunnel-candidates-" + stamp + ".md"
|
path := filepath.Join(rawDir, "tunnel-candidates-"+stamp+".md")
|
||||||
var buf strings.Builder
|
existed := fileExists(path)
|
||||||
if _, err := bfs.Lstat(rel); errors.Is(err, fs.ErrNotExist) {
|
f, err := os.OpenFile(path, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0o644)
|
||||||
buf.WriteString("# Tunnel candidates " + stamp + "\n\nFuzzy cross-wing matches surfaced by AutoTunnel. Review and promote to a tunnel via `brain_tunnel` if relevant.\n\n")
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer func() { _ = f.Close() }()
|
||||||
|
if !existed {
|
||||||
|
if _, err := f.WriteString("# Tunnel candidates " + stamp + "\n\nFuzzy cross-wing matches surfaced by AutoTunnel. Review and promote to a tunnel via `brain_tunnel` if relevant.\n\n"); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
}
|
}
|
||||||
for _, c := range cs {
|
for _, c := range cs {
|
||||||
fmt.Fprintf(&buf, "- `%s` ↔ `%s` (term: %q)\n", sourcePath, c.TargetPath, c.MatchedTerm)
|
line := fmt.Sprintf("- `%s` ↔ `%s` (term: %q)\n", sourcePath, c.TargetPath, c.MatchedTerm)
|
||||||
|
if _, err := f.WriteString(line); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return bfs.AppendRegular(rel, []byte(buf.String()))
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func fileExists(p string) bool {
|
||||||
|
_, err := os.Stat(p)
|
||||||
|
return err == nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// WriteTunnel appends a bidirectional wikilink between sourcePath and
|
// WriteTunnel appends a bidirectional wikilink between sourcePath and
|
||||||
|
|||||||
@@ -1,52 +0,0 @@
|
|||||||
package brain_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
|
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/brain"
|
|
||||||
)
|
|
||||||
|
|
||||||
// hyperguild#158: BuildWingIndex wrote wiki/<wing>/_index.md with
|
|
||||||
// os.WriteFile, so a symlinked _index.md was written through.
|
|
||||||
func TestBuildWingIndexDoesNotWriteThroughASymlinkedIndex(t *testing.T) {
|
|
||||||
b := t.TempDir()
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(b, "wiki", "w", "facts"), 0o755))
|
|
||||||
require.NoError(t, os.WriteFile(filepath.Join(b, "wiki", "w", "facts", "n.md"), []byte("---\ntitle: zqn\n---\n"), 0o644))
|
|
||||||
victim := filepath.Join(b, "raw", "v.md")
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Dir(victim), 0o755))
|
|
||||||
require.NoError(t, os.WriteFile(victim, []byte("untouched"), 0o644))
|
|
||||||
require.NoError(t, os.Symlink(filepath.Join("..", "..", "raw", "v.md"), filepath.Join(b, "wiki", "w", "_index.md")))
|
|
||||||
assert.Error(t, brain.BuildWingIndex(b, "w"))
|
|
||||||
got, _ := os.ReadFile(victim)
|
|
||||||
assert.Equal(t, "untouched", string(got))
|
|
||||||
|
|
||||||
require.NoError(t, os.Remove(filepath.Join(b, "wiki", "w", "_index.md")))
|
|
||||||
require.NoError(t, brain.BuildWingIndex(b, "w"), "positive control")
|
|
||||||
idx, _ := os.ReadFile(filepath.Join(b, "wiki", "w", "_index.md"))
|
|
||||||
assert.Contains(t, string(idx), "zqn")
|
|
||||||
}
|
|
||||||
|
|
||||||
// AutoTunnel's fuzzy-candidate log appended to raw/tunnel-candidates-*.md
|
|
||||||
// with os.OpenFile, so a symlinked raw/ (or log file) was written through.
|
|
||||||
func TestAutoTunnelDoesNotAppendTheCandidateLogThroughASymlinkedRaw(t *testing.T) {
|
|
||||||
b := t.TempDir()
|
|
||||||
outside := t.TempDir()
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(b, "wiki", "a", "facts"), 0o755))
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(b, "wiki", "b", "facts"), 0o755))
|
|
||||||
// "zq widget" matches as a substring of "zq widgets", a fuzzy candidate.
|
|
||||||
require.NoError(t, os.WriteFile(filepath.Join(b, "wiki", "b", "facts", "t.md"), []byte("---\ntitle: Zq Widget\n---\n"), 0o644))
|
|
||||||
require.NoError(t, os.Symlink(outside, filepath.Join(b, "raw")))
|
|
||||||
_ = brain.AutoTunnel(b, "wiki/a/facts/s.md", "about zq widgets")
|
|
||||||
ents, _ := os.ReadDir(outside)
|
|
||||||
assert.Empty(t, ents, "the candidate log was written outside the brain")
|
|
||||||
|
|
||||||
require.NoError(t, os.Remove(filepath.Join(b, "raw")))
|
|
||||||
require.NoError(t, brain.AutoTunnel(b, "wiki/a/facts/s.md", "about zq widgets"))
|
|
||||||
logs, _ := filepath.Glob(filepath.Join(b, "raw", "tunnel-candidates-*.md"))
|
|
||||||
assert.Len(t, logs, 1, "positive control: the fuzzy candidate is logged in the real raw/")
|
|
||||||
}
|
|
||||||
@@ -22,10 +22,6 @@ import (
|
|||||||
// 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")
|
||||||
|
|
||||||
// ErrLockChanged is returned by OpenLock when the lock file was replaced
|
|
||||||
// while it was being opened.
|
|
||||||
var ErrLockChanged = errors.New("lock file replaced while opening")
|
|
||||||
|
|
||||||
// ErrTooLarge is returned by ReadRegularMax for a file over the limit.
|
// ErrTooLarge is returned by ReadRegularMax for a file over the limit.
|
||||||
var ErrTooLarge = errors.New("file too large")
|
var ErrTooLarge = errors.New("file too large")
|
||||||
|
|
||||||
@@ -140,152 +136,17 @@ func (b *Brain) ReadDirDirs(relDir string) ([]string, error) {
|
|||||||
return names, nil
|
return names, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// PutRegular creates or replaces a regular file at a brain-relative path,
|
|
||||||
// for creating writes (hyperguild#188, #158). Missing parent directories are
|
|
||||||
// created one component at a time through the root, and every existing
|
|
||||||
// component must be a real directory, so a symlinked directory cannot
|
|
||||||
// redirect the write elsewhere in the brain or outside it. An existing file
|
|
||||||
// is replaced only if it is regular (WriteRegular's checks); a new file is
|
|
||||||
// created with O_EXCL and confirmed to be the file that was opened. A
|
|
||||||
// directory swapped in after the checks is the #167 residual.
|
|
||||||
func (b *Brain) PutRegular(rel string, data []byte) error {
|
|
||||||
if err := cleanRel(rel); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if err := b.mkdirReal(path.Dir(rel)); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if _, err := b.root.Lstat(rel); err == nil {
|
|
||||||
return b.WriteRegular(rel, data)
|
|
||||||
} else if !errors.Is(err, fs.ErrNotExist) {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return b.createNew(rel, data)
|
|
||||||
}
|
|
||||||
|
|
||||||
// CreateRegular creates a new regular file at a brain-relative path, with
|
|
||||||
// PutRegular's parent rules, and fails with fs.ErrExist if anything is
|
|
||||||
// already there: for writers that must never overwrite (promote, reject).
|
|
||||||
func (b *Brain) CreateRegular(rel string, data []byte) error {
|
|
||||||
if err := cleanRel(rel); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if err := b.mkdirReal(path.Dir(rel)); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return b.createNew(rel, data)
|
|
||||||
}
|
|
||||||
|
|
||||||
// createNew creates rel with O_EXCL and writes data only after confirming
|
|
||||||
// the path is the regular file it created.
|
|
||||||
func (b *Brain) createNew(rel string, data []byte) error {
|
|
||||||
f, err := b.root.OpenFile(rel, os.O_WRONLY|os.O_CREATE|os.O_EXCL|syscall.O_NOFOLLOW|syscall.O_NONBLOCK, 0o644)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
defer func() { _ = f.Close() }()
|
|
||||||
hfi, herr := f.Stat()
|
|
||||||
lfi, lerr := b.root.Lstat(rel)
|
|
||||||
if herr != nil || lerr != nil || !lfi.Mode().IsRegular() || !os.SameFile(lfi, hfi) {
|
|
||||||
return fmt.Errorf("%s: changed while creating: %w", rel, ErrNotRegular)
|
|
||||||
}
|
|
||||||
if _, err := f.Write(data); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return f.Close()
|
|
||||||
}
|
|
||||||
|
|
||||||
// AppendRegular appends data to a regular file at a brain-relative path,
|
|
||||||
// creating it (and missing parent directories, as PutRegular does) if it is
|
|
||||||
// absent. It writes only after confirming the path is the regular file it
|
|
||||||
// opened, so a final symlink or special file, or one swapped in, is refused.
|
|
||||||
func (b *Brain) AppendRegular(rel string, data []byte) error {
|
|
||||||
if err := cleanRel(rel); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if err := b.mkdirReal(path.Dir(rel)); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if fi, err := b.root.Lstat(rel); err == nil && !fi.Mode().IsRegular() {
|
|
||||||
return fmt.Errorf("%s: %w", rel, ErrNotRegular)
|
|
||||||
} else if err != nil && !errors.Is(err, fs.ErrNotExist) {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
f, err := b.root.OpenFile(rel, os.O_WRONLY|os.O_APPEND|os.O_CREATE|syscall.O_NOFOLLOW|syscall.O_NONBLOCK, 0o644)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
defer func() { _ = f.Close() }()
|
|
||||||
hfi, herr := f.Stat()
|
|
||||||
lfi, lerr := b.root.Lstat(rel)
|
|
||||||
if herr != nil || lerr != nil || !lfi.Mode().IsRegular() || !os.SameFile(lfi, hfi) {
|
|
||||||
return fmt.Errorf("%s: changed while opening: %w", rel, ErrNotRegular)
|
|
||||||
}
|
|
||||||
if _, err := f.Write(data); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return f.Close()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remove removes the file at a clean brain-relative path through the root,
|
|
||||||
// refusing a path behind a symlinked directory. A final symlink is removed
|
|
||||||
// itself, never its target.
|
|
||||||
func (b *Brain) Remove(rel string) error {
|
|
||||||
if err := b.RealParent(rel); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return b.root.Remove(rel)
|
|
||||||
}
|
|
||||||
|
|
||||||
// RealParent returns ErrNotRegular unless rel is clean and every directory
|
|
||||||
// above it is a real directory, for writers that do their own I/O (an atomic
|
|
||||||
// rename) but must not be redirected by a symlinked directory.
|
|
||||||
func (b *Brain) RealParent(rel string) error {
|
|
||||||
if err := cleanRel(rel); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return b.realDir(path.Dir(rel))
|
|
||||||
}
|
|
||||||
|
|
||||||
// mkdirReal makes sure every component of rel exists as a real directory,
|
|
||||||
// creating missing ones through the root; an existing component that is
|
|
||||||
// not a real directory is ErrNotRegular.
|
|
||||||
func (b *Brain) mkdirReal(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 errors.Is(err, fs.ErrNotExist) {
|
|
||||||
if err := b.root.Mkdir(prefix, 0o755); err != nil && !errors.Is(err, fs.ErrExist) {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
fi, err = b.root.Lstat(prefix)
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if !fi.IsDir() {
|
|
||||||
return fmt.Errorf("%s: component %s is not a directory: %w", rel, prefix, ErrNotRegular)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// OpenLock opens (creating if absent) a regular lock file at a clean
|
// OpenLock opens (creating if absent) a regular lock file at a clean
|
||||||
// brain-relative path for flock, through the root (hyperguild#192): every
|
// brain-relative path for flock, through the root (hyperguild#192): every
|
||||||
// directory above it must be real, an existing lock must be a regular file,
|
// directory above it must be real, an existing lock must be a regular file,
|
||||||
// and the opened handle must be the file at the path (os.Root follows an
|
// and the opened handle must be the file at the path (os.Root follows an
|
||||||
// in-root final symlink even with O_NOFOLLOW, so the Lstat pre-check is
|
// in-root final symlink even with O_NOFOLLOW). A dangling or swapped-in
|
||||||
// what refuses a dangling in-brain link). A link swapped in between the
|
// symlink is refused; nothing is created at its target.
|
||||||
// pre-check and the open can still have an empty file created at an in-brain
|
|
||||||
// target before the refusal: the #167 residual. ErrLockChanged reports a
|
|
||||||
// lock replaced while opening (a peer removed and recreated it); callers
|
|
||||||
// retry.
|
|
||||||
func (b *Brain) OpenLock(rel string) (*os.File, error) {
|
func (b *Brain) OpenLock(rel string) (*os.File, error) {
|
||||||
if err := b.RealParent(rel); err != nil {
|
if err := cleanRel(rel); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if err := b.realDir(path.Dir(rel)); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
if fi, err := b.root.Lstat(rel); err == nil && !fi.Mode().IsRegular() {
|
if fi, err := b.root.Lstat(rel); err == nil && !fi.Mode().IsRegular() {
|
||||||
@@ -299,27 +160,23 @@ func (b *Brain) OpenLock(rel string) (*os.File, error) {
|
|||||||
}
|
}
|
||||||
hfi, herr := f.Stat()
|
hfi, herr := f.Stat()
|
||||||
lfi, lerr := b.root.Lstat(rel)
|
lfi, lerr := b.root.Lstat(rel)
|
||||||
if herr != nil || !hfi.Mode().IsRegular() {
|
if herr != nil || lerr != nil || !lfi.Mode().IsRegular() || !os.SameFile(lfi, hfi) {
|
||||||
_ = f.Close()
|
_ = f.Close()
|
||||||
return nil, fmt.Errorf("%s: %w", rel, ErrNotRegular)
|
return nil, fmt.Errorf("%s: changed while opening: %w", rel, ErrNotRegular)
|
||||||
}
|
|
||||||
if lerr != nil || !os.SameFile(lfi, hfi) {
|
|
||||||
_ = f.Close()
|
|
||||||
if lerr == nil && !lfi.Mode().IsRegular() {
|
|
||||||
return nil, fmt.Errorf("%s: %w", rel, ErrNotRegular)
|
|
||||||
}
|
|
||||||
return nil, fmt.Errorf("%s: %w", rel, ErrLockChanged)
|
|
||||||
}
|
}
|
||||||
return f, nil
|
return f, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// LockIsCurrent reports whether f is still the file at rel: after taking a
|
// RemoveLock removes the lock file at rel through the root (a symlink there
|
||||||
// flock, a lock file removed and recreated by a peer means the flock is on
|
// is removed itself, never its target).
|
||||||
// an orphaned inode and does not exclude anyone (hyperguild#192).
|
func (b *Brain) RemoveLock(rel string) error {
|
||||||
func (b *Brain) LockIsCurrent(rel string, f *os.File) bool {
|
if err := cleanRel(rel); err != nil {
|
||||||
hfi, herr := f.Stat()
|
return err
|
||||||
lfi, lerr := b.root.Lstat(rel)
|
}
|
||||||
return herr == nil && lerr == nil && os.SameFile(lfi, hfi)
|
if err := b.realDir(path.Dir(rel)); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return b.root.Remove(rel)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ReadRegular reads a brain-relative path, refusing anything that is not a
|
// ReadRegular reads a brain-relative path, refusing anything that is not a
|
||||||
|
|||||||
@@ -376,202 +376,3 @@ func TestReadAndWriteRegularRefuseAPathThatIsNotClean(t *testing.T) {
|
|||||||
got, _ := os.ReadFile(filepath.Join(dir, "raw", "v.md"))
|
got, _ := os.ReadFile(filepath.Join(dir, "raw", "v.md"))
|
||||||
assert.Equal(t, "untouched", string(got))
|
assert.Equal(t, "untouched", string(got))
|
||||||
}
|
}
|
||||||
|
|
||||||
// hyperguild#188: PutRegular creates or replaces a regular file through the
|
|
||||||
// root. Missing parent directories are created; an existing component that
|
|
||||||
// is not a real directory, a final symlink or special file, and an unclean
|
|
||||||
// path are refused, and nothing is created at a link's target.
|
|
||||||
func TestPutRegularCreatesOrReplacesOnlyThroughRealDirectories(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
outside := t.TempDir()
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(dir, "raw"), 0o755))
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(dir, "wiki"), 0o755))
|
|
||||||
require.NoError(t, os.Symlink(filepath.Join("..", "raw"), filepath.Join(dir, "wiki", "inwing")))
|
|
||||||
require.NoError(t, os.Symlink(outside, filepath.Join(dir, "wiki", "outwing")))
|
|
||||||
require.NoError(t, os.WriteFile(filepath.Join(dir, "raw", "v.md"), []byte("untouched"), 0o644))
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(dir, "wiki", "w"), 0o755))
|
|
||||||
require.NoError(t, os.Symlink(filepath.Join("..", "..", "raw", "v.md"), filepath.Join(dir, "wiki", "w", "link.md")))
|
|
||||||
require.NoError(t, syscall.Mkfifo(filepath.Join(dir, "wiki", "w", "f.md"), 0o644))
|
|
||||||
b, err := Open(dir)
|
|
||||||
require.NoError(t, err)
|
|
||||||
defer func() { _ = b.Close() }()
|
|
||||||
|
|
||||||
for _, rel := range []string{"wiki/inwing/facts/n.md", "wiki/outwing/facts/n.md", "wiki/w/link.md", "wiki/w/f.md", "wiki/w/../../raw/v.md", "/abs.md"} {
|
|
||||||
assert.ErrorIs(t, b.PutRegular(rel, []byte("x")), ErrNotRegular, rel)
|
|
||||||
}
|
|
||||||
ents, _ := os.ReadDir(outside)
|
|
||||||
assert.Empty(t, ents, "nothing created outside the brain")
|
|
||||||
_, err = os.Stat(filepath.Join(dir, "raw", "facts"))
|
|
||||||
assert.True(t, os.IsNotExist(err), "nothing created through the in-brain link")
|
|
||||||
got, _ := os.ReadFile(filepath.Join(dir, "raw", "v.md"))
|
|
||||||
assert.Equal(t, "untouched", string(got))
|
|
||||||
|
|
||||||
require.NoError(t, b.PutRegular("wiki/new/facts/n.md", []byte("one")), "positive control: create with missing parents")
|
|
||||||
got, _ = os.ReadFile(filepath.Join(dir, "wiki", "new", "facts", "n.md"))
|
|
||||||
assert.Equal(t, "one", string(got))
|
|
||||||
require.NoError(t, b.PutRegular("wiki/new/facts/n.md", []byte("two")), "positive control: replace")
|
|
||||||
got, _ = os.ReadFile(filepath.Join(dir, "wiki", "new", "facts", "n.md"))
|
|
||||||
assert.Equal(t, "two", string(got))
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestAppendRegularCreatesOrAppendsOnlyThroughRealDirectories(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
outside := t.TempDir()
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(dir, "raw"), 0o755))
|
|
||||||
require.NoError(t, os.WriteFile(filepath.Join(dir, "raw", "v.md"), []byte("untouched"), 0o644))
|
|
||||||
require.NoError(t, os.Symlink(outside, filepath.Join(dir, "outdir")))
|
|
||||||
require.NoError(t, os.Symlink("raw", filepath.Join(dir, "indir")))
|
|
||||||
require.NoError(t, os.Symlink(filepath.Join("raw", "v.md"), filepath.Join(dir, "log.md")))
|
|
||||||
require.NoError(t, syscall.Mkfifo(filepath.Join(dir, "f.md"), 0o644))
|
|
||||||
b, err := Open(dir)
|
|
||||||
require.NoError(t, err)
|
|
||||||
defer func() { _ = b.Close() }()
|
|
||||||
|
|
||||||
for _, rel := range []string{"outdir/l.md", "indir/v.md", "log.md", "f.md", "raw/../log.md"} {
|
|
||||||
assert.ErrorIs(t, b.AppendRegular(rel, []byte("x")), ErrNotRegular, rel)
|
|
||||||
}
|
|
||||||
ents, _ := os.ReadDir(outside)
|
|
||||||
assert.Empty(t, ents)
|
|
||||||
got, _ := os.ReadFile(filepath.Join(dir, "raw", "v.md"))
|
|
||||||
assert.Equal(t, "untouched", string(got))
|
|
||||||
|
|
||||||
require.NoError(t, b.AppendRegular("logs/a.md", []byte("one\n")), "positive control: create")
|
|
||||||
require.NoError(t, b.AppendRegular("logs/a.md", []byte("two\n")), "positive control: append")
|
|
||||||
got, _ = os.ReadFile(filepath.Join(dir, "logs", "a.md"))
|
|
||||||
assert.Equal(t, "one\ntwo\n", string(got))
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRealParentRefusesASymlinkedDirectoryOrUncleanPath(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(dir, "raw"), 0o755))
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(dir, "wiki"), 0o755))
|
|
||||||
require.NoError(t, os.Symlink(filepath.Join("..", "raw"), filepath.Join(dir, "wiki", "alias")))
|
|
||||||
b, err := Open(dir)
|
|
||||||
require.NoError(t, err)
|
|
||||||
defer func() { _ = b.Close() }()
|
|
||||||
assert.ErrorIs(t, b.RealParent("wiki/alias/x.md"), ErrNotRegular)
|
|
||||||
assert.ErrorIs(t, b.RealParent("wiki/../raw/x.md"), ErrNotRegular)
|
|
||||||
assert.NoError(t, b.RealParent("wiki/x.md"), "positive control")
|
|
||||||
}
|
|
||||||
|
|
||||||
// cleanRel must refuse an unclean path on its own: here the ".." resolves,
|
|
||||||
// after a symlinked directory, to a real regular file, so only the clean
|
|
||||||
// check stands between the call and that file.
|
|
||||||
func TestAppendRegularRefusesAnUncleanPathThatResolvesToARealFile(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(dir, "raw", "keep"), 0o755))
|
|
||||||
require.NoError(t, os.WriteFile(filepath.Join(dir, "raw", "v.md"), []byte("untouched"), 0o644))
|
|
||||||
require.NoError(t, os.Symlink(filepath.Join("raw", "keep"), filepath.Join(dir, "indir")))
|
|
||||||
b, err := Open(dir)
|
|
||||||
require.NoError(t, err)
|
|
||||||
defer func() { _ = b.Close() }()
|
|
||||||
assert.ErrorIs(t, b.AppendRegular("indir/../v.md", []byte("x")), ErrNotRegular)
|
|
||||||
assert.ErrorIs(t, b.PutRegular("indir/../v.md", []byte("x")), ErrNotRegular)
|
|
||||||
got, _ := os.ReadFile(filepath.Join(dir, "raw", "v.md"))
|
|
||||||
assert.Equal(t, "untouched", string(got))
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRemoveRefusesAPathBehindASymlinkedDirectoryAndRemovesOnlyTheLink(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(dir, "raw"), 0o755))
|
|
||||||
require.NoError(t, os.WriteFile(filepath.Join(dir, "raw", "v.md"), []byte("keep"), 0o644))
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(dir, "wiki"), 0o755))
|
|
||||||
require.NoError(t, os.Symlink(filepath.Join("..", "raw"), filepath.Join(dir, "wiki", "alias")))
|
|
||||||
require.NoError(t, os.Symlink(filepath.Join("..", "raw", "v.md"), filepath.Join(dir, "wiki", "link.md")))
|
|
||||||
require.NoError(t, os.WriteFile(filepath.Join(dir, "wiki", "n.md"), []byte("n"), 0o644))
|
|
||||||
b, err := Open(dir)
|
|
||||||
require.NoError(t, err)
|
|
||||||
defer func() { _ = b.Close() }()
|
|
||||||
|
|
||||||
assert.ErrorIs(t, b.Remove("wiki/alias/v.md"), ErrNotRegular)
|
|
||||||
_, err = os.Stat(filepath.Join(dir, "raw", "v.md"))
|
|
||||||
assert.NoError(t, err, "the file behind the symlinked directory is kept")
|
|
||||||
require.NoError(t, b.Remove("wiki/link.md"))
|
|
||||||
_, err = os.Stat(filepath.Join(dir, "raw", "v.md"))
|
|
||||||
assert.NoError(t, err, "removing a final symlink never removes its target")
|
|
||||||
require.NoError(t, b.Remove("wiki/n.md"), "positive control")
|
|
||||||
_, err = os.Stat(filepath.Join(dir, "wiki", "n.md"))
|
|
||||||
assert.True(t, os.IsNotExist(err))
|
|
||||||
}
|
|
||||||
|
|
||||||
// CreateRegular is the only write path for promote and reject: it creates
|
|
||||||
// missing parents through the root, refuses an in-brain symlinked parent and
|
|
||||||
// an unclean path, and never replaces anything already there (fs.ErrExist,
|
|
||||||
// content unchanged), including a dangling link.
|
|
||||||
func TestCreateRegularCreatesOnlyNewFilesThroughRealDirectories(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(dir, "raw", "keep"), 0o755))
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(dir, "wiki"), 0o755))
|
|
||||||
require.NoError(t, os.Symlink(filepath.Join("..", "raw"), filepath.Join(dir, "wiki", "inwing")))
|
|
||||||
require.NoError(t, os.WriteFile(filepath.Join(dir, "raw", "v.md"), []byte("untouched"), 0o644))
|
|
||||||
require.NoError(t, os.Symlink(filepath.Join("raw", "keep"), filepath.Join(dir, "indir")))
|
|
||||||
require.NoError(t, os.WriteFile(filepath.Join(dir, "wiki", "exists.md"), []byte("original"), 0o644))
|
|
||||||
require.NoError(t, os.Symlink("nowhere.md", filepath.Join(dir, "wiki", "dangling.md")))
|
|
||||||
b, err := Open(dir)
|
|
||||||
require.NoError(t, err)
|
|
||||||
defer func() { _ = b.Close() }()
|
|
||||||
|
|
||||||
assert.ErrorIs(t, b.CreateRegular("wiki/inwing/facts/n.md", []byte("x")), ErrNotRegular)
|
|
||||||
_, err = os.Stat(filepath.Join(dir, "raw", "facts"))
|
|
||||||
assert.True(t, os.IsNotExist(err), "nothing created through the in-brain link")
|
|
||||||
assert.ErrorIs(t, b.CreateRegular("indir/../v.md", []byte("x")), ErrNotRegular)
|
|
||||||
got, _ := os.ReadFile(filepath.Join(dir, "raw", "v.md"))
|
|
||||||
assert.Equal(t, "untouched", string(got))
|
|
||||||
|
|
||||||
assert.ErrorIs(t, b.CreateRegular("wiki/exists.md", []byte("x")), fs.ErrExist)
|
|
||||||
got, _ = os.ReadFile(filepath.Join(dir, "wiki", "exists.md"))
|
|
||||||
assert.Equal(t, "original", string(got))
|
|
||||||
assert.ErrorIs(t, b.CreateRegular("wiki/dangling.md", []byte("x")), fs.ErrExist)
|
|
||||||
_, err = os.Stat(filepath.Join(dir, "wiki", "nowhere.md"))
|
|
||||||
assert.True(t, os.IsNotExist(err), "nothing created at the dangling link's target")
|
|
||||||
|
|
||||||
require.NoError(t, b.CreateRegular("wiki/new/facts/n.md", []byte("one")), "positive control: create with missing parents")
|
|
||||||
got, _ = os.ReadFile(filepath.Join(dir, "wiki", "new", "facts", "n.md"))
|
|
||||||
assert.Equal(t, "one", string(got))
|
|
||||||
}
|
|
||||||
|
|
||||||
// hyperguild#192: OpenLock creates or reuses a regular lock file through the
|
|
||||||
// root and refuses every other shape without creating anything at a link's
|
|
||||||
// target or hanging.
|
|
||||||
func TestOpenLockOpensOnlyARegularLockThroughRealDirectories(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(dir, "raw"), 0o755))
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(dir, "wiki", "w"), 0o755))
|
|
||||||
require.NoError(t, os.WriteFile(filepath.Join(dir, "raw", "v.md"), []byte("untouched"), 0o644))
|
|
||||||
require.NoError(t, os.Symlink(filepath.Join("..", "..", "raw", "created"), filepath.Join(dir, "wiki", "w", "dangling.lock")))
|
|
||||||
require.NoError(t, os.Symlink(filepath.Join("..", "..", "raw", "v.md"), filepath.Join(dir, "wiki", "w", "live.lock")))
|
|
||||||
require.NoError(t, syscall.Mkfifo(filepath.Join(dir, "wiki", "w", "fifo.lock"), 0o644))
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(dir, "wiki", "w", "dir.lock"), 0o755))
|
|
||||||
require.NoError(t, os.Symlink(filepath.Join("..", "raw"), filepath.Join(dir, "wiki", "alias")))
|
|
||||||
b, err := Open(dir)
|
|
||||||
require.NoError(t, err)
|
|
||||||
defer func() { _ = b.Close() }()
|
|
||||||
|
|
||||||
for _, rel := range []string{"wiki/w/dangling.lock", "wiki/w/live.lock", "wiki/w/fifo.lock", "wiki/w/dir.lock", "wiki/alias/x.lock", "wiki/w/../w/x.lock"} {
|
|
||||||
done := make(chan error, 1)
|
|
||||||
go func() {
|
|
||||||
f, err := b.OpenLock(rel)
|
|
||||||
if f != nil {
|
|
||||||
_ = f.Close()
|
|
||||||
}
|
|
||||||
done <- err
|
|
||||||
}()
|
|
||||||
select {
|
|
||||||
case err := <-done:
|
|
||||||
assert.ErrorIs(t, err, ErrNotRegular, rel)
|
|
||||||
case <-time.After(3 * time.Second):
|
|
||||||
t.Fatalf("OpenLock hung on %s", rel)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
_, err = os.Lstat(filepath.Join(dir, "raw", "created"))
|
|
||||||
assert.True(t, os.IsNotExist(err), "nothing created at the dangling link's target")
|
|
||||||
got, _ := os.ReadFile(filepath.Join(dir, "raw", "v.md"))
|
|
||||||
assert.Equal(t, "untouched", string(got))
|
|
||||||
|
|
||||||
f, err := b.OpenLock("wiki/w/n.md.lock")
|
|
||||||
require.NoError(t, err, "positive control: creates a lock")
|
|
||||||
assert.True(t, b.LockIsCurrent("wiki/w/n.md.lock", f))
|
|
||||||
require.NoError(t, b.Remove("wiki/w/n.md.lock"))
|
|
||||||
assert.False(t, b.LockIsCurrent("wiki/w/n.md.lock", f), "a removed lock is no longer current")
|
|
||||||
_ = f.Close()
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -10,11 +10,6 @@ import (
|
|||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/audit"
|
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/brainstore"
|
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/capture"
|
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/capturehttp"
|
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/classification"
|
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/mcp"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/mcp"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -50,69 +45,17 @@ func TestBrainEditReturnsPromptlyOnAFIFONoteWithAWriter(t *testing.T) {
|
|||||||
func TestBrainEditDoesNotCreateAFileThroughADanglingLockSymlink(t *testing.T) {
|
func TestBrainEditDoesNotCreateAFileThroughADanglingLockSymlink(t *testing.T) {
|
||||||
for name, target := range map[string]func(t *testing.T, dir string) string{
|
for name, target := range map[string]func(t *testing.T, dir string) string{
|
||||||
"outside": func(t *testing.T, _ string) string { return filepath.Join(t.TempDir(), "created") },
|
"outside": func(t *testing.T, _ string) string { return filepath.Join(t.TempDir(), "created") },
|
||||||
// Relative, as Syncthing carries it: os.Root refuses an absolute
|
|
||||||
// link on its own, so only OpenLock's pre-check stops this one.
|
|
||||||
"in-brain": func(t *testing.T, dir string) string { return filepath.Join(dir, "raw", "created") },
|
"in-brain": func(t *testing.T, dir string) string { return filepath.Join(dir, "raw", "created") },
|
||||||
} {
|
} {
|
||||||
t.Run(name, func(t *testing.T) {
|
t.Run(name, func(t *testing.T) {
|
||||||
dir := newBrainRepo(t)
|
dir := newBrainRepo(t)
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(dir, "raw"), 0o755))
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "raw"), 0o755))
|
||||||
tgt := target(t, dir)
|
tgt := target(t, dir)
|
||||||
lock := filepath.Join(dir, "wiki", "homelab", "facts", "n.md.lock")
|
require.NoError(t, os.Symlink(tgt, filepath.Join(dir, "wiki", "homelab", "facts", "n.md.lock")))
|
||||||
linkTo := tgt
|
|
||||||
if name == "in-brain" {
|
|
||||||
rel, err := filepath.Rel(filepath.Dir(lock), tgt)
|
|
||||||
require.NoError(t, err)
|
|
||||||
linkTo = rel
|
|
||||||
}
|
|
||||||
require.NoError(t, os.Symlink(linkTo, lock))
|
|
||||||
srv := mcp.NewServer(dir, nil, nil, nil)
|
srv := mcp.NewServer(dir, nil, nil, nil)
|
||||||
resp := call(t, srv, "brain_edit", map[string]any{"path": "wiki/homelab/facts/n.md", "old_str": "beta", "new_str": "BETA"})
|
_ = call(t, srv, "brain_edit", map[string]any{"path": "wiki/homelab/facts/n.md", "old_str": "beta", "new_str": "BETA"})
|
||||||
require.NotNil(t, resp["error"], "the edit is refused")
|
|
||||||
assert.Contains(t, resp["error"].(map[string]any)["message"], "lock", "refused because of the lock file")
|
|
||||||
_, err := os.Lstat(tgt)
|
_, err := os.Lstat(tgt)
|
||||||
assert.True(t, os.IsNotExist(err), "a file was created at the lock symlink's target")
|
assert.True(t, os.IsNotExist(err), "a file was created at the lock symlink's target")
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// The rollback (when the stamp cannot be verified) writes the prior bytes
|
|
||||||
// through the brain root: a symlink swapped in for the note before the
|
|
||||||
// rollback is refused, and its target, in the brain or outside, is
|
|
||||||
// untouched.
|
|
||||||
func TestBrainEditRollbackDoesNotWriteThroughASymlinkSwappedInForTheNote(t *testing.T) {
|
|
||||||
for name, mk := range map[string]func(t *testing.T, dir string) (link, victim string){
|
|
||||||
"outside": func(t *testing.T, _ string) (string, string) {
|
|
||||||
v := filepath.Join(t.TempDir(), "victim.md")
|
|
||||||
return v, v
|
|
||||||
},
|
|
||||||
"in-brain": func(t *testing.T, dir string) (string, string) {
|
|
||||||
return filepath.Join("..", "..", "..", "raw", "victim.md"), filepath.Join(dir, "raw", "victim.md")
|
|
||||||
},
|
|
||||||
} {
|
|
||||||
t.Run(name, func(t *testing.T) {
|
|
||||||
dir := newBrainRepo(t)
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(dir, "raw"), 0o755))
|
|
||||||
cfg, err := classification.Load(dir)
|
|
||||||
require.NoError(t, err)
|
|
||||||
svc := capture.NewService(brainstore.New(dir), capFakeTracker{}, cfg, audit.NewSlogSink(nil))
|
|
||||||
srv := mcp.NewServer(dir, nil, nil, nil)
|
|
||||||
srv.WithCapture(svc, capFakeValidator{subject: "bad\xff"}, capStaticTok, "local-cli", capturehttp.NewOriginResolver(nil))
|
|
||||||
out := resultText(t, authCall(t, srv, "Bearer "+capStaticTok, "brain_write", map[string]any{
|
|
||||||
"content": "# R\n\nstatic body", "wing": "testing", "hall": "facts", "filename": "rb",
|
|
||||||
}))
|
|
||||||
path := out["path"].(string)
|
|
||||||
note := filepath.Join(dir, path)
|
|
||||||
link, victim := mk(t, dir)
|
|
||||||
require.NoError(t, os.WriteFile(victim, []byte("untouched"), 0o644))
|
|
||||||
defer mcp.SetBeforeStampHook(func() {
|
|
||||||
require.NoError(t, os.Remove(note))
|
|
||||||
require.NoError(t, os.Symlink(link, note))
|
|
||||||
})()
|
|
||||||
resp := authCall(t, srv, jwtAuthz, "brain_edit", map[string]any{"path": path, "old_str": "static body", "new_str": "injected"})
|
|
||||||
require.NotNil(t, resp["error"])
|
|
||||||
got, _ := os.ReadFile(victim)
|
|
||||||
assert.Equal(t, "untouched", string(got), "the rollback wrote through the swapped-in symlink")
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,9 +0,0 @@
|
|||||||
package mcp
|
|
||||||
|
|
||||||
// SetBeforeStampHook installs beforeStampHook for a test and returns a
|
|
||||||
// restore func.
|
|
||||||
func SetBeforeStampHook(f func()) func() {
|
|
||||||
old := beforeStampHook
|
|
||||||
beforeStampHook = f
|
|
||||||
return func() { beforeStampHook = old }
|
|
||||||
}
|
|
||||||
@@ -137,9 +137,6 @@ func (s *Server) brainEdit(ctx context.Context, args json.RawMessage) (json.RawM
|
|||||||
// whoever edits a note is the author of what a reader now sees: re-stamp
|
// whoever edits a note is the author of what a reader now sees: re-stamp
|
||||||
// to the editor after every edit (PR #147 review, escape E1).
|
// to the editor after every edit (PR #147 review, escape E1).
|
||||||
origin, writtenBy := provenanceFrom(ctx)
|
origin, writtenBy := provenanceFrom(ctx)
|
||||||
if beforeStampHook != nil {
|
|
||||||
beforeStampHook()
|
|
||||||
}
|
|
||||||
if serr := api.StampProvenanceFile(s.brainDir, res.Path, origin, writtenBy); serr != nil {
|
if serr := api.StampProvenanceFile(s.brainDir, res.Path, origin, writtenBy); serr != nil {
|
||||||
if werr := bfs.WriteRegular(target.Rel, prior); werr != nil {
|
if werr := bfs.WriteRegular(target.Rel, prior); werr != nil {
|
||||||
// Say exactly what state the note is in: edited, unverified.
|
// Say exactly what state the note is in: edited, unverified.
|
||||||
@@ -151,11 +148,6 @@ func (s *Server) brainEdit(ctx context.Context, args json.RawMessage) (json.RawM
|
|||||||
return out, nil
|
return out, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// beforeStampHook is a test seam (nil in production): it runs between the
|
|
||||||
// edit and the provenance stamp, so a test can swap the note before the
|
|
||||||
// rollback path runs.
|
|
||||||
var beforeStampHook func()
|
|
||||||
|
|
||||||
// brainEditRoot edits a governance file (CLAUDE.md). De-surfaced AND gated on
|
// brainEditRoot edits a governance file (CLAUDE.md). De-surfaced AND gated on
|
||||||
// the authenticated principal: only the static local-CLI token may call it, so
|
// the authenticated principal: only the static local-CLI token may call it, so
|
||||||
// a claude.ai-origin session — the one that may have just read an untrusted
|
// a claude.ai-origin session — the one that may have just read an untrusted
|
||||||
|
|||||||
@@ -222,47 +222,31 @@ func lockFor(abs string) *sync.Mutex {
|
|||||||
// flockFile takes an advisory lock covering other processes sharing the
|
// flockFile takes an advisory lock covering other processes sharing the
|
||||||
// hostPath — during a RollingUpdate two ingestion pods do. The lock file is
|
// hostPath — during a RollingUpdate two ingestion pods do. The lock file is
|
||||||
// opened and removed through the brain root, never through a symlink
|
// opened and removed through the brain root, never through a symlink
|
||||||
// (hyperguild#192): a planted dangling "<note>.lock" link made a successful
|
// (hyperguild#192): a planted dangling "<note>.lock" link made a
|
||||||
// edit create a file at its target.
|
// successful edit create a file at its target.
|
||||||
//
|
|
||||||
// Unlock removes the lock file while still holding the flock, so a waiter
|
|
||||||
// can wake holding a lock on an orphaned inode while the next caller locks a
|
|
||||||
// fresh file: two editors at once (measured on main). After taking the
|
|
||||||
// flock, the file must still be the one at the path; otherwise retry.
|
|
||||||
func flockFile(t Target) (func(), error) {
|
func flockFile(t Target) (func(), error) {
|
||||||
lockRel := t.Rel + ".lock"
|
lockRel := t.Rel + ".lock"
|
||||||
bfs, err := brainfs.Open(t.Brain)
|
bfs, err := brainfs.Open(t.Brain)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("notes: lock %s: %w", lockRel, err)
|
return nil, fmt.Errorf("notes: lock %s: %w", lockRel, err)
|
||||||
}
|
}
|
||||||
for attempt := 0; attempt < 1000; attempt++ {
|
f, err := bfs.OpenLock(lockRel)
|
||||||
f, err := bfs.OpenLock(lockRel)
|
|
||||||
if errors.Is(err, brainfs.ErrLockChanged) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
_ = bfs.Close()
|
|
||||||
return nil, fmt.Errorf("notes: lock %s: %w", lockRel, err)
|
|
||||||
}
|
|
||||||
if err := syscall.Flock(int(f.Fd()), syscall.LOCK_EX); err != nil {
|
|
||||||
_ = f.Close()
|
|
||||||
_ = bfs.Close()
|
|
||||||
return nil, fmt.Errorf("notes: flock %s: %w", lockRel, err)
|
|
||||||
}
|
|
||||||
if !bfs.LockIsCurrent(lockRel, f) {
|
|
||||||
_ = syscall.Flock(int(f.Fd()), syscall.LOCK_UN)
|
|
||||||
_ = f.Close()
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
return func() {
|
|
||||||
_ = bfs.Remove(lockRel)
|
|
||||||
_ = syscall.Flock(int(f.Fd()), syscall.LOCK_UN)
|
|
||||||
_ = f.Close()
|
|
||||||
_ = bfs.Close()
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
_ = bfs.Close()
|
_ = bfs.Close()
|
||||||
return nil, fmt.Errorf("notes: lock %s: kept changing while locking", lockRel)
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("notes: lock %s: %w", lockRel, err)
|
||||||
|
}
|
||||||
|
if err := syscall.Flock(int(f.Fd()), syscall.LOCK_EX); err != nil {
|
||||||
|
_ = f.Close()
|
||||||
|
return nil, fmt.Errorf("notes: flock %s: %w", lockRel, err)
|
||||||
|
}
|
||||||
|
return func() {
|
||||||
|
_ = syscall.Flock(int(f.Fd()), syscall.LOCK_UN)
|
||||||
|
_ = f.Close()
|
||||||
|
if b, err := brainfs.Open(t.Brain); err == nil {
|
||||||
|
_ = b.RemoveLock(lockRel)
|
||||||
|
_ = b.Close()
|
||||||
|
}
|
||||||
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// writeAtomic replaces the file via a same-directory temp + rename, then
|
// writeAtomic replaces the file via a same-directory temp + rename, then
|
||||||
|
|||||||
@@ -1,36 +0,0 @@
|
|||||||
package notes
|
|
||||||
|
|
||||||
import (
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
)
|
|
||||||
|
|
||||||
// hyperguild#188/#173: brain_edit's atomic rename must not be redirected by
|
|
||||||
// a symlinked directory inside the brain.
|
|
||||||
func TestEditRefusesANoteBehindASymlinkedDirectory(t *testing.T) {
|
|
||||||
b := t.TempDir()
|
|
||||||
// Edit refuses a tree that is not the sync source before any path
|
|
||||||
// check, so the test needs a .git to reach the symlink refusal.
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(b, ".git"), 0o755))
|
|
||||||
victim := filepath.Join(b, "raw", "facts", "v.md")
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Dir(victim), 0o755))
|
|
||||||
require.NoError(t, os.WriteFile(victim, []byte("old text\n"), 0o644))
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(b, "wiki", "w"), 0o755))
|
|
||||||
require.NoError(t, os.Symlink(filepath.Join("..", "..", "raw", "facts"), filepath.Join(b, "wiki", "w", "alias")))
|
|
||||||
_, err := Edit(b, "wiki/w/alias/v.md", "old text", "new text", ScopeNotes)
|
|
||||||
assert.Error(t, err)
|
|
||||||
got, _ := os.ReadFile(victim)
|
|
||||||
assert.Equal(t, "old text\n", string(got))
|
|
||||||
|
|
||||||
real := filepath.Join(b, "wiki", "w", "facts", "r.md")
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Dir(real), 0o755))
|
|
||||||
require.NoError(t, os.WriteFile(real, []byte("old text\n"), 0o644))
|
|
||||||
_, err = Edit(b, "wiki/w/facts/r.md", "old text", "new text", ScopeNotes)
|
|
||||||
require.NoError(t, err, "positive control: a note in a real directory is edited")
|
|
||||||
got, _ = os.ReadFile(real)
|
|
||||||
assert.Equal(t, "new text\n", string(got))
|
|
||||||
}
|
|
||||||
@@ -1,82 +0,0 @@
|
|||||||
package notes
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"os/exec"
|
|
||||||
"path/filepath"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
)
|
|
||||||
|
|
||||||
// lockChild runs inside a re-executed test binary: it takes the note's edit
|
|
||||||
// lock N times and, while holding it, creates an O_EXCL marker. Finding the
|
|
||||||
// marker already there means another process holds the "same" lock: mutual
|
|
||||||
// exclusion failed. It prints the overlap count.
|
|
||||||
func lockChild(brainDir string, rounds int) {
|
|
||||||
t, err := Resolve(brainDir, "wiki/w/facts/n.md", ScopeNotes)
|
|
||||||
if err != nil {
|
|
||||||
fmt.Println("resolve:", err)
|
|
||||||
os.Exit(2)
|
|
||||||
}
|
|
||||||
marker := filepath.Join(brainDir, "marker")
|
|
||||||
overlaps := 0
|
|
||||||
for i := 0; i < rounds; i++ {
|
|
||||||
unlock, err := flockFile(t)
|
|
||||||
if err != nil {
|
|
||||||
fmt.Println("lock:", err)
|
|
||||||
os.Exit(2)
|
|
||||||
}
|
|
||||||
f, err := os.OpenFile(marker, os.O_CREATE|os.O_EXCL|os.O_WRONLY, 0o644)
|
|
||||||
if errors.Is(err, os.ErrExist) {
|
|
||||||
overlaps++
|
|
||||||
} else if err == nil {
|
|
||||||
_ = f.Close()
|
|
||||||
_ = os.Remove(marker)
|
|
||||||
}
|
|
||||||
unlock()
|
|
||||||
}
|
|
||||||
fmt.Println(overlaps)
|
|
||||||
os.Exit(0)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestMain(m *testing.M) {
|
|
||||||
if dir := os.Getenv("NOTES_LOCK_CHILD"); dir != "" {
|
|
||||||
n, _ := strconv.Atoi(os.Getenv("NOTES_LOCK_ROUNDS"))
|
|
||||||
lockChild(dir, n)
|
|
||||||
}
|
|
||||||
os.Exit(m.Run())
|
|
||||||
}
|
|
||||||
|
|
||||||
// hyperguild#192: the edit lock must exclude other processes (two ingestion
|
|
||||||
// pods share the hostPath brain during a RollingUpdate). Unlock removes the
|
|
||||||
// lock file, so without re-checking that the locked file is still the one at
|
|
||||||
// the path, a waiter and the next caller each held a lock (measured on main:
|
|
||||||
// hundreds of overlaps in 2000 rounds).
|
|
||||||
func TestEditLockExcludesOtherProcesses(t *testing.T) {
|
|
||||||
brain := t.TempDir()
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(brain, "wiki", "w", "facts"), 0o755))
|
|
||||||
require.NoError(t, os.WriteFile(filepath.Join(brain, "wiki", "w", "facts", "n.md"), []byte("x"), 0o644))
|
|
||||||
const procs, rounds = 3, 400
|
|
||||||
cmds := make([]*exec.Cmd, procs)
|
|
||||||
outs := make([]*strings.Builder, procs)
|
|
||||||
for i := range cmds {
|
|
||||||
outs[i] = &strings.Builder{}
|
|
||||||
cmds[i] = exec.Command(os.Args[0], "-test.run=^$")
|
|
||||||
cmds[i].Env = append(os.Environ(), "NOTES_LOCK_CHILD="+brain, "NOTES_LOCK_ROUNDS="+strconv.Itoa(rounds))
|
|
||||||
cmds[i].Stdout, cmds[i].Stderr = outs[i], outs[i]
|
|
||||||
require.NoError(t, cmds[i].Start())
|
|
||||||
}
|
|
||||||
total := 0
|
|
||||||
for i, c := range cmds {
|
|
||||||
require.NoError(t, c.Wait(), "child %d: %s", i, outs[i].String())
|
|
||||||
n, err := strconv.Atoi(strings.TrimSpace(outs[i].String()))
|
|
||||||
require.NoError(t, err, "child %d output: %q", i, outs[i].String())
|
|
||||||
total += n
|
|
||||||
}
|
|
||||||
require.Zero(t, total, "processes held the edit lock at the same time")
|
|
||||||
}
|
|
||||||
@@ -28,6 +28,7 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"os"
|
||||||
"regexp"
|
"regexp"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
@@ -101,6 +102,25 @@ func Apply(content string, s Stamp) (string, error) {
|
|||||||
return out, nil
|
return out, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ApplyFile applies the stamp to the note at absPath in place.
|
||||||
|
func ApplyFile(absPath string, s Stamp) error {
|
||||||
|
b, err := os.ReadFile(absPath)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("read for provenance: %w", err)
|
||||||
|
}
|
||||||
|
out, err := Apply(string(b), s)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if out == string(b) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(absPath, []byte(out), 0o644); err != nil {
|
||||||
|
return fmt.Errorf("write provenance: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// plainGroups keeps the provably plain key groups of a frontmatter block.
|
// plainGroups keeps the provably plain key groups of a frontmatter block.
|
||||||
func plainGroups(block string) string {
|
func plainGroups(block string) string {
|
||||||
lines := strings.Split(strings.TrimSuffix(block, "\n"), "\n")
|
lines := strings.Split(strings.TrimSuffix(block, "\n"), "\n")
|
||||||
|
|||||||
@@ -381,19 +381,18 @@ func TestWatchQueueIsBoundedDuringAnOutage(t *testing.T) {
|
|||||||
require.Eventually(t, func() bool { _, err := os.Lstat(link); return os.IsNotExist(err) }, 2*time.Second, 2*time.Millisecond)
|
require.Eventually(t, func() bool { _, err := os.Lstat(link); return os.IsNotExist(err) }, 2*time.Second, 2*time.Millisecond)
|
||||||
}
|
}
|
||||||
n.down.Store(false)
|
n.down.Store(false)
|
||||||
// Synchronise on the summary being delivered (hyperguild#193: a fixed
|
require.Eventually(t, func() bool { return n.count() >= 1 }, 2*time.Second, 5*time.Millisecond)
|
||||||
// sleep flaked under load); once it is, the queue has been flushed.
|
time.Sleep(100 * time.Millisecond)
|
||||||
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
|
|
||||||
}, 10*time.Second, 5*time.Millisecond, "suppressed alerts are counted in a summary")
|
|
||||||
assert.LessOrEqual(t, n.count(), maxPending+1, "queued alerts plus at most one suppression summary")
|
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
|
// Within the bound, every alert queued during an outage is delivered after
|
||||||
@@ -412,21 +411,11 @@ func TestWatchDeliversEveryQueuedAlertAfterAShortOutage(t *testing.T) {
|
|||||||
require.Eventually(t, func() bool { _, err := os.Lstat(link); return os.IsNotExist(err) }, 2*time.Second, 2*time.Millisecond)
|
require.Eventually(t, func() bool { _, err := os.Lstat(link); return os.IsNotExist(err) }, 2*time.Second, 2*time.Millisecond)
|
||||||
}
|
}
|
||||||
n.down.Store(false)
|
n.down.Store(false)
|
||||||
require.Eventually(t, func() bool { return n.count() >= 3 }, 10*time.Second, 5*time.Millisecond)
|
require.Eventually(t, func() bool { return n.count() == 3 }, 2*time.Second, 5*time.Millisecond)
|
||||||
n.mu.Lock()
|
n.mu.Lock()
|
||||||
defer n.mu.Unlock()
|
defer n.mu.Unlock()
|
||||||
// Each removal delivered exactly once, in any order: the outage ends
|
for i, name := range []string{"qa", "qb", "qc"} {
|
||||||
// asynchronously, possibly mid-flush, so a later item can send before an
|
assert.Contains(t, n.msgs[i], strconv.Quote(name))
|
||||||
// earlier one (hyperguild#193). Order is not what this test is about.
|
|
||||||
assert.Len(t, n.msgs, 3)
|
|
||||||
for _, name := range []string{"qa", "qb", "qc"} {
|
|
||||||
hits := 0
|
|
||||||
for _, m := range n.msgs {
|
|
||||||
if strings.Contains(m, strconv.Quote(name)) {
|
|
||||||
hits++
|
|
||||||
}
|
|
||||||
}
|
|
||||||
assert.Equal(t, 1, hits, "%s delivered exactly once", name)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -468,30 +457,29 @@ func TestWatchAccountsForEveryRemovalDuringAnOutage(t *testing.T) {
|
|||||||
require.Eventually(t, func() bool { _, err := os.Lstat(link); return os.IsNotExist(err) }, 2*time.Second, 1*time.Millisecond)
|
require.Eventually(t, func() bool { _, err := os.Lstat(link); return os.IsNotExist(err) }, 2*time.Second, 1*time.Millisecond)
|
||||||
}
|
}
|
||||||
n.down.Store(false)
|
n.down.Store(false)
|
||||||
// Synchronise on the record being complete, not on a fixed sleep after
|
require.Eventually(t, func() bool {
|
||||||
// the first summary (hyperguild#193): sum every "removed N" alert and
|
|
||||||
// every suppression count until they account for all plants.
|
|
||||||
account := func() (delivered, counted int) {
|
|
||||||
n.mu.Lock()
|
n.mu.Lock()
|
||||||
defer n.mu.Unlock()
|
defer n.mu.Unlock()
|
||||||
for _, m := range n.msgs {
|
for _, m := range n.msgs {
|
||||||
var k int
|
if strings.Contains(m, "suppressed") {
|
||||||
if i := strings.Index(m, "removed "); i >= 0 && strings.Contains(m, "symlink(s)") {
|
return true
|
||||||
if _, err := fmt.Sscanf(m[i+len("removed "):], "%d", &k); err == nil {
|
|
||||||
delivered += k
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if i := strings.Index(m, "): "); i >= 0 && strings.Contains(m, "suppressed") {
|
|
||||||
if _, err := fmt.Sscanf(m[i+3:], "%d", &k); err == nil {
|
|
||||||
counted += k
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return delivered, counted
|
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)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
require.Eventually(t, func() bool { d, c := account(); return d+c >= plants }, 10*time.Second, 5*time.Millisecond)
|
assert.Equal(t, plants, delivered+counted, "delivered %d + counted %d must equal %d removals", delivered, counted, plants)
|
||||||
d, c := account()
|
|
||||||
assert.Equal(t, plants, d+c, "delivered %d + counted %d must equal %d removals", d, c, plants)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// A poison message is still dropped (others send while it fails), and the
|
// A poison message is still dropped (others send while it fails), and the
|
||||||
|
|||||||
@@ -3,6 +3,8 @@ package wiki
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
||||||
@@ -48,8 +50,8 @@ func RebuildIndex(brainDir, date string) error {
|
|||||||
sb.WriteString("\n")
|
sb.WriteString("\n")
|
||||||
}
|
}
|
||||||
|
|
||||||
// Written through the brain root, never through a symlink (#158).
|
dest := filepath.Join(brainDir, "wiki", "index.md")
|
||||||
return bfs.PutRegular("wiki/index.md", []byte(sb.String()))
|
return os.WriteFile(dest, []byte(sb.String()), 0o644)
|
||||||
}
|
}
|
||||||
|
|
||||||
// pageFirstSentence reads the page through the brain root, regular files
|
// pageFirstSentence reads the page through the brain root, regular files
|
||||||
|
|||||||
@@ -3,7 +3,8 @@ package wiki
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
"os"
|
||||||
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -26,14 +27,14 @@ func AppendLog(brainDir, source string, pages, warnings []string, date string) e
|
|||||||
}
|
}
|
||||||
sb.WriteString("\n")
|
sb.WriteString("\n")
|
||||||
|
|
||||||
// Appended through the brain root, never through a symlink (#158).
|
logPath := filepath.Join(brainDir, "log.md")
|
||||||
bfs, err := brainfs.Open(brainDir)
|
f, err := os.OpenFile(logPath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0o644)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("open brain: %w", err)
|
return fmt.Errorf("open log: %w", err)
|
||||||
}
|
}
|
||||||
defer func() { _ = bfs.Close() }()
|
if _, err = f.WriteString(sb.String()); err != nil {
|
||||||
if err := bfs.AppendRegular("log.md", []byte(sb.String())); err != nil {
|
f.Close() //nolint:errcheck
|
||||||
return fmt.Errorf("write log: %w", err)
|
return fmt.Errorf("write log: %w", err)
|
||||||
}
|
}
|
||||||
return nil
|
return f.Close()
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,35 +0,0 @@
|
|||||||
package wiki
|
|
||||||
|
|
||||||
import (
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
)
|
|
||||||
|
|
||||||
// hyperguild#158: RebuildIndex wrote wiki/index.md and AppendLog appended
|
|
||||||
// log.md with os.WriteFile / os.OpenFile, so a symlinked file was written
|
|
||||||
// through.
|
|
||||||
func TestRebuildIndexAndAppendLogDoNotWriteThroughSymlinks(t *testing.T) {
|
|
||||||
b := t.TempDir()
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Join(b, "wiki", "concepts"), 0o755))
|
|
||||||
victim := filepath.Join(b, "raw", "v.md")
|
|
||||||
require.NoError(t, os.MkdirAll(filepath.Dir(victim), 0o755))
|
|
||||||
require.NoError(t, os.WriteFile(victim, []byte("untouched"), 0o644))
|
|
||||||
require.NoError(t, os.Symlink(filepath.Join("..", "raw", "v.md"), filepath.Join(b, "wiki", "index.md")))
|
|
||||||
require.NoError(t, os.Symlink(filepath.Join("raw", "v.md"), filepath.Join(b, "log.md")))
|
|
||||||
|
|
||||||
assert.Error(t, RebuildIndex(b, "2026-10-05"))
|
|
||||||
assert.Error(t, AppendLog(b, "src", []string{"p"}, nil, "2026-10-05"))
|
|
||||||
got, _ := os.ReadFile(victim)
|
|
||||||
assert.Equal(t, "untouched", string(got))
|
|
||||||
|
|
||||||
require.NoError(t, os.Remove(filepath.Join(b, "wiki", "index.md")))
|
|
||||||
require.NoError(t, os.Remove(filepath.Join(b, "log.md")))
|
|
||||||
require.NoError(t, RebuildIndex(b, "2026-10-05"), "positive control")
|
|
||||||
require.NoError(t, AppendLog(b, "src", []string{"p"}, nil, "2026-10-05"), "positive control")
|
|
||||||
l, _ := os.ReadFile(filepath.Join(b, "log.md"))
|
|
||||||
assert.Contains(t, string(l), "src")
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user