Compare commits
14
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
bdc1e51a1a | ||
|
|
8c48e2e343 | ||
|
|
c0be5c473c | ||
|
|
0bd0fbf03e | ||
|
|
ef39435252 | ||
|
|
b6ef11600b | ||
|
|
432e09d122 | ||
|
|
77e32de33c | ||
|
|
57d0fb0fae | ||
|
|
27a01dd2af | ||
|
|
eb77305580 | ||
|
|
c986df6799 | ||
|
|
687afa0145 | ||
|
|
cad389f62f |
@@ -0,0 +1,26 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"log/slog"
|
||||||
|
|
||||||
|
chassisauth "git.d-ma.be/mathias/mcp-chassis/auth"
|
||||||
|
)
|
||||||
|
|
||||||
|
// buildJWTValidator builds the JWT validator for issuer (nil when issuer is
|
||||||
|
// empty: JWT auth disabled). Since mcp-chassis v0.7 construction no longer
|
||||||
|
// fails when OIDC discovery does (mcp-chassis#4): the issuer resolves lazily,
|
||||||
|
// and until it does a JWT is answered 503-and-retry, not 401. That replaces
|
||||||
|
// #83's boot-time retry loop (hyperguild#155). An issuer still unresolved at
|
||||||
|
// boot is logged, so a misconfigured issuer is visible rather than silent.
|
||||||
|
func buildJWTValidator(ctx context.Context, logger *slog.Logger, issuer, audience string) (*chassisauth.JWTValidator, error) {
|
||||||
|
v, err := chassisauth.NewJWTValidator(ctx, issuer, audience)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("build jwt validator: %w", err)
|
||||||
|
}
|
||||||
|
if ok, rerr := v.Ready(ctx); !ok {
|
||||||
|
logger.Warn("jwt issuer not resolved at boot; JWTs answer 503 until it is", "issuer", issuer, "err", rerr)
|
||||||
|
}
|
||||||
|
return v, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,111 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"io"
|
||||||
|
"log/slog"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"sync/atomic"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/metrics"
|
||||||
|
)
|
||||||
|
|
||||||
|
// fakeIssuer answers OIDC discovery with 502 for the first fail requests, as
|
||||||
|
// ingress does while dex is not yet serving on a cold boot (#83), then with a
|
||||||
|
// real discovery document and an empty JWKS.
|
||||||
|
func fakeIssuer(t *testing.T, fail int32) (*httptest.Server, *atomic.Int32) {
|
||||||
|
t.Helper()
|
||||||
|
var discoveries atomic.Int32
|
||||||
|
mux := http.NewServeMux()
|
||||||
|
var srv *httptest.Server
|
||||||
|
mux.HandleFunc("/.well-known/openid-configuration", func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
if discoveries.Add(1) <= fail {
|
||||||
|
w.WriteHeader(http.StatusBadGateway)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
_, _ = io.WriteString(w, `{"issuer":"`+srv.URL+`","jwks_uri":"`+srv.URL+`/keys"}`)
|
||||||
|
})
|
||||||
|
mux.HandleFunc("/keys", func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
_, _ = io.WriteString(w, `{"keys":[]}`)
|
||||||
|
})
|
||||||
|
srv = httptest.NewServer(mux)
|
||||||
|
t.Cleanup(srv.Close)
|
||||||
|
return srv, &discoveries
|
||||||
|
}
|
||||||
|
|
||||||
|
// #83 retried discovery at boot because chassis v0.2.0 failed construction on
|
||||||
|
// a 502. Since chassis v0.7 (mcp-chassis#4) the validator is built anyway and
|
||||||
|
// resolves the issuer lazily, so boot no longer waits or exits on it
|
||||||
|
// (hyperguild#155). An unresolved issuer is logged at boot.
|
||||||
|
func TestBuildJWTValidatorReturnsAValidatorWhileDiscovery502s(t *testing.T) {
|
||||||
|
srv, _ := fakeIssuer(t, 1000)
|
||||||
|
var buf bytes.Buffer
|
||||||
|
v, err := buildJWTValidator(context.Background(), slog.New(slog.NewTextHandler(&buf, nil)), srv.URL, "brain")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.NotNil(t, v)
|
||||||
|
assert.Contains(t, buf.String(), "jwt issuer not resolved at boot")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildJWTValidatorLogsNothingAgainstAHealthyIssuer(t *testing.T) {
|
||||||
|
srv, _ := fakeIssuer(t, 0)
|
||||||
|
var buf bytes.Buffer
|
||||||
|
v, err := buildJWTValidator(context.Background(), slog.New(slog.NewTextHandler(&buf, nil)), srv.URL, "brain")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.NotNil(t, v)
|
||||||
|
assert.NotContains(t, buf.String(), "not resolved")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildJWTValidatorIsNilWithoutAnIssuer(t *testing.T) {
|
||||||
|
v, err := buildJWTValidator(context.Background(), slog.New(slog.DiscardHandler), "", "brain")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Nil(t, v)
|
||||||
|
}
|
||||||
|
|
||||||
|
// With the issuer unresolved, a JWT on a REST route answers 503 (retry), not
|
||||||
|
// 401: the token may be fine, the server just cannot check it yet.
|
||||||
|
func TestBuildMuxAnswers503ToAJWTWhileTheIssuerIsUnresolved(t *testing.T) {
|
||||||
|
srv, _ := fakeIssuer(t, 1000)
|
||||||
|
v, err := buildJWTValidator(context.Background(), slog.New(slog.DiscardHandler), srv.URL, "brain")
|
||||||
|
require.NoError(t, err)
|
||||||
|
mux, err := buildMux(restAuth{token: routesTok, validator: v, realm: "brain"}, testHandler(t),
|
||||||
|
okHandler("mcp"), metrics.New(), nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
code, _ := do(t, mux, "GET", "/pending", "Bearer aaa.bbb.ccc")
|
||||||
|
assert.Equal(t, http.StatusServiceUnavailable, code)
|
||||||
|
}
|
||||||
|
|
||||||
|
// PR #183 review: /mcp shares REST's bearer, but only the static token was
|
||||||
|
// asserted on it. With the issuer unresolved, a JWT on /mcp answers 503 too,
|
||||||
|
// so /mcp's middleware was built with the JWT validator.
|
||||||
|
func TestBuildMuxAnswers503ToAJWTOnMCPWhileTheIssuerIsUnresolved(t *testing.T) {
|
||||||
|
srv, _ := fakeIssuer(t, 1000)
|
||||||
|
v, err := buildJWTValidator(context.Background(), slog.New(slog.DiscardHandler), srv.URL, "brain")
|
||||||
|
require.NoError(t, err)
|
||||||
|
mux, err := buildMux(restAuth{token: routesTok, validator: v, realm: "brain"}, testHandler(t),
|
||||||
|
okHandler("mcp"), metrics.New(), nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
code, _ := do(t, mux, "POST", "/mcp", "Bearer aaa.bbb.ccc")
|
||||||
|
assert.Equal(t, http.StatusServiceUnavailable, code)
|
||||||
|
}
|
||||||
|
|
||||||
|
// PR #183 review: a 401 on /mcp names the protected-resource metadata in
|
||||||
|
// WWW-Authenticate (what the claude.ai OAuth connector discovers from), so
|
||||||
|
// /mcp's middleware was built with resourceMetadataURL.
|
||||||
|
func TestBuildMuxMCP401CarriesResourceMetadataInWWWAuthenticate(t *testing.T) {
|
||||||
|
const rm = "https://brain.example/.well-known/oauth-protected-resource"
|
||||||
|
mux, err := buildMux(restAuth{token: routesTok, realm: "brain", resourceMetadataURL: rm}, testHandler(t),
|
||||||
|
okHandler("mcp"), metrics.New(), nil)
|
||||||
|
require.NoError(t, err)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
mux.ServeHTTP(rec, httptest.NewRequest(http.MethodPost, "/mcp", nil))
|
||||||
|
require.Equal(t, http.StatusUnauthorized, rec.Code)
|
||||||
|
assert.Contains(t, rec.Header().Get("WWW-Authenticate"), `resource_metadata="`+rm+`"`)
|
||||||
|
}
|
||||||
@@ -32,7 +32,7 @@ import (
|
|||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/pipeline"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/pipeline"
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/reranker"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/reranker"
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/search"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/search"
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/startupretry"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/symlinkguard"
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/vectorstore"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/vectorstore"
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/watcher"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/watcher"
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/webhook"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/webhook"
|
||||||
@@ -173,7 +173,8 @@ func alertingWarnings(getenv func(string) string) []string {
|
|||||||
var out []string
|
var out []string
|
||||||
if getenv("BRAIN_NTFY_URL") == "" {
|
if getenv("BRAIN_NTFY_URL") == "" {
|
||||||
out = append(out, "alerting DISABLED: BRAIN_NTFY_URL unset — "+
|
out = append(out, "alerting DISABLED: BRAIN_NTFY_URL unset — "+
|
||||||
"brain_edit_root governance rewrites and capture audit degradation will not notify")
|
"brain_edit_root governance rewrites, capture audit degradation and the "+
|
||||||
|
"brain symlink tripwire (hyperguild#157) will not notify")
|
||||||
}
|
}
|
||||||
return out
|
return out
|
||||||
}
|
}
|
||||||
@@ -239,6 +240,10 @@ func main() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
brainDir := envOr("INGEST_BRAIN_DIR", "../brain")
|
brainDir := envOr("INGEST_BRAIN_DIR", "../brain")
|
||||||
|
if err := startupSymlinkCheck(brainDir); err != nil {
|
||||||
|
logger.Error("brain symlink tripwire", "err", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
port := envOr("INGEST_PORT", "3300")
|
port := envOr("INGEST_PORT", "3300")
|
||||||
|
|
||||||
llmURL := envOr("INGEST_LLM_URL", "http://iguana:4000/v1")
|
llmURL := envOr("INGEST_LLM_URL", "http://iguana:4000/v1")
|
||||||
@@ -360,28 +365,18 @@ func main() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
|
// hyperguild#157: report a symlink that appears in the brain while running.
|
||||||
|
go symlinkguard.Watch(ctx, brainDir, symlinkScanInterval(os.Getenv), buildNotifier())
|
||||||
|
|
||||||
// Built before the watcher, the graph backfill and session ingestion, and
|
// Never fatal on an unreachable issuer (#83): on a cold cluster boot this
|
||||||
// retried rather than fatal (#83). Two separate reasons:
|
// pod can beat dex to serving and get a 502 from ingress, and exiting meant
|
||||||
//
|
// CrashLoopBackOff redoing the backfill. Since mcp-chassis v0.7 the
|
||||||
// - On a cold cluster boot this pod can beat dex to serving and gets a
|
// validator resolves the issuer lazily and answers JWTs 503-and-retry until
|
||||||
// 502 from ingress. Nothing is misconfigured; it simply started first.
|
// it does (hyperguild#155), so no boot retry is needed. A misconfigured
|
||||||
// Exiting there meant CrashLoopBackOff redoing the backfill on every
|
// issuer no longer exits the process: it is logged at boot and every JWT
|
||||||
// attempt, with exponential backoff stretching the brain outage.
|
// gets 503; the static bearer keeps working.
|
||||||
// - Constructing it first means a genuine config error (wrong issuer,
|
jwtValidator, err := buildJWTValidator(ctx, logger,
|
||||||
// bad audience) fails in seconds instead of after all that work.
|
os.Getenv("DEX_ISSUER_URL"), os.Getenv("MCP_AUDIENCE"))
|
||||||
//
|
|
||||||
// The budget stays bounded: retrying forever would turn a misconfiguration
|
|
||||||
// into a process that looks alive and never serves.
|
|
||||||
jwtValidator, err := startupretry.Do(ctx,
|
|
||||||
startupretry.Policy{Attempts: 8, Base: time.Second, Max: 30 * time.Second},
|
|
||||||
func(ctx context.Context) (*chassisauth.JWTValidator, error) {
|
|
||||||
v, err := chassisauth.NewJWTValidator(ctx, os.Getenv("DEX_ISSUER_URL"), os.Getenv("MCP_AUDIENCE"))
|
|
||||||
if err != nil {
|
|
||||||
logger.Warn("oidc discovery not ready, retrying", "err", err)
|
|
||||||
}
|
|
||||||
return v, err
|
|
||||||
})
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
logger.Error("build jwt validator", "err", err)
|
logger.Error("build jwt validator", "err", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
@@ -521,8 +516,6 @@ func main() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public["/mcp"] = chassisauth.BearerMiddleware(mcpToken, jwtValidator, "brain", resourceMetadataURL, mcpSrv)
|
|
||||||
|
|
||||||
// POST /capture (#53/#54): the uniform capture REST door. Needs a ticket
|
// POST /capture (#53/#54): the uniform capture REST door. Needs a ticket
|
||||||
// tracker to file action items, so it only mounts when Gitea is
|
// tracker to file action items, so it only mounts when Gitea is
|
||||||
// configured. It reuses the MCP server's graph-wired brain store (one
|
// configured. It reuses the MCP server's graph-wired brain store (one
|
||||||
@@ -546,7 +539,7 @@ func main() {
|
|||||||
public["POST /capture"] = captureH
|
public["POST /capture"] = captureH
|
||||||
// Same use-case behind the MCP `capture` tool (#55 relay) so MCP-native
|
// Same use-case behind the MCP `capture` tool (#55 relay) so MCP-native
|
||||||
// harnesses (claude.ai, Crush, Pi, LLM Council) reach capture through
|
// harnesses (claude.ai, Crush, Pi, LLM Council) reach capture through
|
||||||
// the existing /mcp OAuth connector. mcpSrv is already wrapped above;
|
// the existing /mcp OAuth connector. buildMux wraps this same mcpSrv;
|
||||||
// WithCapture mutates the same instance, so the tool appears live.
|
// WithCapture mutates the same instance, so the tool appears live.
|
||||||
mcpSrv.WithCapture(captureSvc, jwtValidator, mcpToken, "local-cli", resolver)
|
mcpSrv.WithCapture(captureSvc, jwtValidator, mcpToken, "local-cli", resolver)
|
||||||
// hyperguild#97: a governance-file rewrite gets the same trail a
|
// hyperguild#97: a governance-file rewrite gets the same trail a
|
||||||
@@ -588,19 +581,18 @@ func main() {
|
|||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
|
|
||||||
// /metrics — unauthenticated Prometheus endpoint. kube-prometheus-stack
|
// /metrics — unauthenticated Prometheus endpoint, scraped via the
|
||||||
// scrapes it via the ServiceMonitor in k3s/apps/supervisor/. The metrics
|
// ServiceMonitor in k3s/apps/supervisor/. buildMux registers it and wraps
|
||||||
// middleware below wraps every other registered handler so it observes
|
// the whole router in the registry's middleware.
|
||||||
// real request latency. /metrics itself is excluded from its own
|
//
|
||||||
// observation by registering it on the outer mux (post-wrap).
|
// The whole router, /mcp's bearer included, is built in buildMux so its
|
||||||
reg := metrics.New()
|
// tests are tests of production wiring (PR #152 review, hyperguild#154).
|
||||||
public["GET /metrics"] = http.HandlerFunc(reg.Handler())
|
// The REST API's credential is the same as /mcp's. Untested here: the
|
||||||
|
// restAuth fields and the public map this call passes in (e.g. a nil
|
||||||
// The whole router, built in one place so the test of buildMux is a test
|
// validator would drop JWT auth on /mcp and REST and the suite stays
|
||||||
// of production wiring (PR #152 review). The REST API's credential is the
|
// green), and ListenAndServe serving the result unchanged (hyperguild#182).
|
||||||
// same as /mcp's.
|
handler, err := buildMux(restAuth{token: mcpToken, validator: jwtValidator, realm: "brain",
|
||||||
mux, err := buildMux(restAuth{token: mcpToken, validator: jwtValidator, realm: "brain",
|
resourceMetadataURL: resourceMetadataURL}, h, mcpSrv, metrics.New(), public)
|
||||||
resourceMetadataURL: resourceMetadataURL}, h, public)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
logger.Error("build router", "err", err)
|
logger.Error("build router", "err", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
@@ -621,7 +613,7 @@ func main() {
|
|||||||
"watch_interval", watchIntervalLog,
|
"watch_interval", watchIntervalLog,
|
||||||
"mcp_enabled", true,
|
"mcp_enabled", true,
|
||||||
)
|
)
|
||||||
if err := http.ListenAndServe(addr, reg.Middleware(mux)); err != nil {
|
if err := http.ListenAndServe(addr, handler); err != nil {
|
||||||
logger.Error("server stopped", "err", err)
|
logger.Error("server stopped", "err", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -8,22 +8,22 @@ import (
|
|||||||
chassisauth "git.d-ma.be/mathias/mcp-chassis/auth"
|
chassisauth "git.d-ma.be/mathias/mcp-chassis/auth"
|
||||||
|
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/api"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/api"
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/metrics"
|
||||||
)
|
)
|
||||||
|
|
||||||
// publicRoutes is the complete set of patterns allowed on the outer mux,
|
// publicRoutes is the complete set of patterns a caller may register on the
|
||||||
// outside the REST API's auth (hyperguild#149). Each authenticates itself or is
|
// outer mux, outside the REST API's auth (hyperguild#149). Each authenticates
|
||||||
// meant to be open: /mcp (bearer/JWT), /capture (bearer/JWT), the webhook
|
// itself or is meant to be open: /capture (bearer/JWT), the webhook (HMAC),
|
||||||
// (HMAC), /oauth/token (client secret), OAuth metadata and /metrics (open).
|
// /oauth/token (client secret) and OAuth metadata (open). /mcp and /metrics
|
||||||
// A REST pattern added here would beat the authenticated catch-all by
|
// are not here: buildMux builds them itself (hyperguild#154). A REST pattern
|
||||||
// specificity and ship open, which is why buildMux refuses anything else.
|
// added here would beat the authenticated catch-all by specificity and ship
|
||||||
|
// open, which is why buildMux refuses anything else.
|
||||||
var publicRoutes = map[string]bool{
|
var publicRoutes = map[string]bool{
|
||||||
"/mcp": true,
|
|
||||||
"POST /capture": true,
|
"POST /capture": true,
|
||||||
"POST /webhooks/brain-sync": true,
|
"POST /webhooks/brain-sync": true,
|
||||||
"GET /.well-known/oauth-protected-resource": true,
|
"GET /.well-known/oauth-protected-resource": true,
|
||||||
"GET /.well-known/oauth-authorization-server": true,
|
"GET /.well-known/oauth-authorization-server": true,
|
||||||
"POST /oauth/token": true,
|
"POST /oauth/token": true,
|
||||||
"GET /metrics": true,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// restAuth is the credential the REST API checks: the same as /mcp's.
|
// restAuth is the credential the REST API checks: the same as /mcp's.
|
||||||
@@ -34,16 +34,25 @@ type restAuth struct {
|
|||||||
resourceMetadataURL string
|
resourceMetadataURL string
|
||||||
}
|
}
|
||||||
|
|
||||||
// buildMux is the server's whole router. The REST API is mounted at "/"
|
// buildMux builds the handler main passes to ListenAndServe unchanged. The
|
||||||
// behind bearer auth that buildMux constructs itself, so a caller cannot pass
|
// REST API is mounted at "/" and /mcp is registered, both behind bearer auth
|
||||||
// a no-op; public handlers are registered as given, and only for patterns on
|
// that buildMux constructs itself from auth (one credential), so a caller
|
||||||
// the publicRoutes allowlist. It returns an http.Handler, not the
|
// cannot pass a no-op. GET /metrics serves reg, and the whole router is
|
||||||
// *ServeMux, so nothing can register a route on the result afterwards and
|
// wrapped in reg's middleware. Other public handlers are registered as given,
|
||||||
// bypass the allowlist.
|
// and only for patterns on the publicRoutes allowlist. It returns an
|
||||||
func buildMux(auth restAuth, h *api.Handler, public map[string]http.Handler) (http.Handler, error) {
|
// http.Handler, not the *ServeMux, so nothing can register a route on the
|
||||||
|
// result. What stays untested is main's call site: the restAuth fields and
|
||||||
|
// the public map main passes in, and ListenAndServe serving this handler
|
||||||
|
// unchanged (hyperguild#182). The tests build their own arguments.
|
||||||
|
func buildMux(
|
||||||
|
auth restAuth, h *api.Handler, mcpHandler http.Handler, reg *metrics.Registry, public map[string]http.Handler,
|
||||||
|
) (http.Handler, error) {
|
||||||
if auth.token == "" {
|
if auth.token == "" {
|
||||||
return nil, errors.New("buildMux: REST auth needs a token")
|
return nil, errors.New("buildMux: REST auth needs a token")
|
||||||
}
|
}
|
||||||
|
if mcpHandler == nil || reg == nil {
|
||||||
|
return nil, errors.New("buildMux: needs the MCP handler and the metrics registry")
|
||||||
|
}
|
||||||
mux := http.NewServeMux()
|
mux := http.NewServeMux()
|
||||||
for pattern, handler := range public {
|
for pattern, handler := range public {
|
||||||
if !publicRoutes[pattern] {
|
if !publicRoutes[pattern] {
|
||||||
@@ -51,10 +60,15 @@ func buildMux(auth restAuth, h *api.Handler, public map[string]http.Handler) (ht
|
|||||||
}
|
}
|
||||||
mux.Handle(pattern, handler)
|
mux.Handle(pattern, handler)
|
||||||
}
|
}
|
||||||
mountREST(mux, h, func(next http.Handler) http.Handler {
|
bearer := func(next http.Handler) http.Handler {
|
||||||
return chassisauth.BearerMiddleware(auth.token, auth.validator, auth.realm, auth.resourceMetadataURL, next)
|
return chassisauth.BearerMiddleware(auth.token, auth.validator, auth.realm, auth.resourceMetadataURL, next)
|
||||||
})
|
}
|
||||||
return mux, nil
|
mux.Handle("/mcp", bearer(mcpHandler))
|
||||||
|
// /metrics is registered on the mux and so observed by its own
|
||||||
|
// middleware, like any route.
|
||||||
|
mux.Handle("GET /metrics", reg.Handler())
|
||||||
|
mountREST(mux, h, bearer)
|
||||||
|
return reg.Middleware(mux), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// mountREST registers the REST API on its own mux and mounts it at "/" behind
|
// mountREST registers the REST API on its own mux and mounts it at "/" behind
|
||||||
@@ -73,5 +87,23 @@ func mountREST(mux *http.ServeMux, h *api.Handler, auth func(http.Handler) http.
|
|||||||
rest.HandleFunc("POST /promote", h.Promote)
|
rest.HandleFunc("POST /promote", h.Promote)
|
||||||
rest.HandleFunc("POST /backfill-embeddings", h.BackfillEmbeddings)
|
rest.HandleFunc("POST /backfill-embeddings", h.BackfillEmbeddings)
|
||||||
rest.HandleFunc("GET /pass-rate", h.PassRate)
|
rest.HandleFunc("GET /pass-rate", h.PassRate)
|
||||||
mux.Handle("/", auth(rest))
|
mux.Handle("/", labelRESTPattern(rest, auth(rest)))
|
||||||
|
}
|
||||||
|
|
||||||
|
// labelRESTPattern sets the request's Pattern to the REST route it addresses
|
||||||
|
// before auth runs, so the metrics middleware (which reads Pattern from the
|
||||||
|
// same *http.Request) labels a refused request by its route rather than by
|
||||||
|
// the "/" mount (hyperguild#155). A refused request to a path no route
|
||||||
|
// matches keeps "/", so for refused requests the label set stays bounded by
|
||||||
|
// the registered routes. That bound does not hold for authenticated
|
||||||
|
// requests: an unregistered path reaches the REST mux, which 404s with an
|
||||||
|
// empty Pattern, and the metrics middleware falls back to the raw URL path
|
||||||
|
// (hyperguild#185).
|
||||||
|
func labelRESTPattern(rest *http.ServeMux, next http.Handler) http.Handler {
|
||||||
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if _, pattern := rest.Handler(r); pattern != "" {
|
||||||
|
r.Pattern = pattern
|
||||||
|
}
|
||||||
|
next.ServeHTTP(w, r)
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,88 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"log/slog"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// wrongTokSentinel is a presented credential distinctive enough that any
|
||||||
|
// occurrence in a log line is the raw token, not a coincidence.
|
||||||
|
const wrongTokSentinel = "wrong-tok-sentinel-q7zx"
|
||||||
|
|
||||||
|
// hyperguild#155: since #149 every REST route sits behind BearerMiddleware,
|
||||||
|
// and chassis v0.2.0 refused without logging, so an unknown caller got
|
||||||
|
// silent 401s. The chassis now writes an `mcp auth rejected` line, and the
|
||||||
|
// presented token appears nowhere in the log as a bare value (PR #181
|
||||||
|
// review: asserting on the "Bearer " header form could never fail, since
|
||||||
|
// the chassis logs fields, not headers).
|
||||||
|
func TestBuildMuxRejectionLogLineOmitsTheBarePresentedToken(t *testing.T) {
|
||||||
|
var buf bytes.Buffer
|
||||||
|
prev := slog.Default()
|
||||||
|
slog.SetDefault(slog.New(slog.NewTextHandler(&buf, nil)))
|
||||||
|
t.Cleanup(func() { slog.SetDefault(prev) })
|
||||||
|
|
||||||
|
code, _ := do(t, testMux(t), "POST", "/query", "Bearer "+wrongTokSentinel)
|
||||||
|
require.Equal(t, http.StatusUnauthorized, code)
|
||||||
|
assert.Contains(t, buf.String(), "mcp auth rejected")
|
||||||
|
assert.Contains(t, buf.String(), "path=/query")
|
||||||
|
assert.NotContains(t, buf.String(), wrongTokSentinel, "the rejected token is logged as a bare value")
|
||||||
|
assert.NotContains(t, buf.String(), routesTok, "the valid static token is logged")
|
||||||
|
}
|
||||||
|
|
||||||
|
// The `mcp auth accepted` line leaves out the valid static token.
|
||||||
|
func TestBuildMuxAcceptedLogLineOmitsTheBareStaticToken(t *testing.T) {
|
||||||
|
var buf bytes.Buffer
|
||||||
|
prev := slog.Default()
|
||||||
|
slog.SetDefault(slog.New(slog.NewTextHandler(&buf, nil)))
|
||||||
|
t.Cleanup(func() { slog.SetDefault(prev) })
|
||||||
|
|
||||||
|
code, _ := do(t, testMux(t), "GET", "/pending", "Bearer "+routesTok)
|
||||||
|
require.Equal(t, http.StatusOK, code)
|
||||||
|
assert.Contains(t, buf.String(), "mcp auth accepted")
|
||||||
|
assert.NotContains(t, buf.String(), routesTok, "the accepted static token is logged as a bare value")
|
||||||
|
}
|
||||||
|
|
||||||
|
// An authenticated REST request is labelled with the REST mux's pattern:
|
||||||
|
// the inner mux sets it on the same *http.Request the outer middleware reads.
|
||||||
|
func TestMetricsLabelAnAuthenticatedRESTRequestWithItsRoutePattern(t *testing.T) {
|
||||||
|
mux, reg := testMuxAndRegistry(t)
|
||||||
|
code, _ := do(t, mux, "GET", "/pending", "Bearer "+routesTok)
|
||||||
|
require.Equal(t, http.StatusOK, code)
|
||||||
|
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
reg.Handler().ServeHTTP(rec, httptest.NewRequest(http.MethodGet, "/metrics", nil))
|
||||||
|
assert.Contains(t, rec.Body.String(), `path="GET /pending"`)
|
||||||
|
assert.NotContains(t, rec.Body.String(), `path="/"`)
|
||||||
|
}
|
||||||
|
|
||||||
|
// hyperguild#155: a request refused by REST auth never reaches the REST mux,
|
||||||
|
// so it was labelled path="/" and a 4xx on /query could not be told from one
|
||||||
|
// on /write. It is now labelled with the REST pattern it was addressed to.
|
||||||
|
func TestMetricsLabelARejectedRESTRequestWithItsRoutePattern(t *testing.T) {
|
||||||
|
mux, reg := testMuxAndRegistry(t)
|
||||||
|
code, _ := do(t, mux, "POST", "/query", "")
|
||||||
|
require.Equal(t, http.StatusUnauthorized, code)
|
||||||
|
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
reg.Handler().ServeHTTP(rec, httptest.NewRequest(http.MethodGet, "/metrics", nil))
|
||||||
|
assert.Contains(t, rec.Body.String(), `path="POST /query",status="4xx"`)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A path no REST route matches keeps the catch-all label, so an attacker
|
||||||
|
// probing random URLs cannot grow the series set.
|
||||||
|
func TestMetricsLabelARejectedUnknownPathWithTheCatchAll(t *testing.T) {
|
||||||
|
mux, reg := testMuxAndRegistry(t)
|
||||||
|
code, _ := do(t, mux, "POST", "/no-such-route-zq", "")
|
||||||
|
require.Equal(t, http.StatusUnauthorized, code)
|
||||||
|
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
reg.Handler().ServeHTTP(rec, httptest.NewRequest(http.MethodGet, "/metrics", nil))
|
||||||
|
assert.Contains(t, rec.Body.String(), `path="/",status="4xx"`)
|
||||||
|
assert.NotContains(t, rec.Body.String(), "no-such-route-zq")
|
||||||
|
}
|
||||||
@@ -12,6 +12,7 @@ import (
|
|||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/api"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/api"
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/metrics"
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/pipeline"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/pipeline"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -21,20 +22,34 @@ func okHandler(body string) http.Handler {
|
|||||||
return http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { _, _ = w.Write([]byte(body)) })
|
return http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { _, _ = w.Write([]byte(body)) })
|
||||||
}
|
}
|
||||||
|
|
||||||
// testMux builds the router exactly as main does: buildMux with the full
|
// testMux builds the router through buildMux, the function main calls, with
|
||||||
// public set main registers (stub handlers) and real bearer config.
|
// every allowlisted public pattern (stub handlers), a stub MCP server and a
|
||||||
// hyperguild#149: the REST API is authenticated as a whole; the PR #152
|
// static token only: no JWT validator and no resourceMetadataURL (the tests
|
||||||
// review showed a test of a COPY of the router let main.go regress unseen.
|
// in jwt_validator_test.go pass those). It does not use main's own restAuth
|
||||||
|
// or public map (hyperguild#182). hyperguild#149: the REST API is
|
||||||
|
// authenticated as a whole; the PR #152 review showed a test of a COPY of
|
||||||
|
// the router let main.go regress unseen.
|
||||||
func testMux(t *testing.T) http.Handler {
|
func testMux(t *testing.T) http.Handler {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
h := api.NewHandler(t.TempDir(), slog.New(slog.NewTextHandler(os.Stderr, nil)), pipeline.Config{})
|
mux, _ := testMuxAndRegistry(t)
|
||||||
|
return mux
|
||||||
|
}
|
||||||
|
|
||||||
|
func testMuxAndRegistry(t *testing.T) (http.Handler, *metrics.Registry) {
|
||||||
|
t.Helper()
|
||||||
public := map[string]http.Handler{}
|
public := map[string]http.Handler{}
|
||||||
for p := range publicRoutes {
|
for p := range publicRoutes {
|
||||||
public[p] = okHandler("public " + p)
|
public[p] = okHandler("public " + p)
|
||||||
}
|
}
|
||||||
mux, err := buildMux(restAuth{token: routesTok, realm: "brain"}, h, public)
|
reg := metrics.New()
|
||||||
|
mux, err := buildMux(restAuth{token: routesTok, realm: "brain"}, testHandler(t), okHandler("mcp"), reg, public)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
return mux
|
return mux, reg
|
||||||
|
}
|
||||||
|
|
||||||
|
func testHandler(t *testing.T) *api.Handler {
|
||||||
|
t.Helper()
|
||||||
|
return api.NewHandler(t.TempDir(), slog.New(slog.NewTextHandler(os.Stderr, nil)), pipeline.Config{})
|
||||||
}
|
}
|
||||||
|
|
||||||
func do(t *testing.T, h http.Handler, method, path, authz string) (int, string) {
|
func do(t *testing.T, h http.Handler, method, path, authz string) (int, string) {
|
||||||
@@ -74,8 +89,9 @@ func TestBuildMuxAuthenticatesAnUnregisteredPath(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// buildMux registers public handlers as given, without adding auth: each
|
// buildMux registers public handlers as given, without adding auth: each
|
||||||
// public route owns its own (bearer on /mcp, HMAC on the webhook, client
|
// public route owns its own (bearer/JWT on /capture, HMAC on the webhook,
|
||||||
// secret on /oauth/token) or is meant to be open (/metrics, OAuth metadata).
|
// client secret on /oauth/token) or is meant to be open (OAuth metadata).
|
||||||
|
// /mcp and /metrics are not public routes: buildMux builds them itself.
|
||||||
func TestBuildMuxDoesNotWrapPublicRoutes(t *testing.T) {
|
func TestBuildMuxDoesNotWrapPublicRoutes(t *testing.T) {
|
||||||
r := testMux(t)
|
r := testMux(t)
|
||||||
for p := range publicRoutes {
|
for p := range publicRoutes {
|
||||||
@@ -93,14 +109,53 @@ func TestBuildMuxDoesNotWrapPublicRoutes(t *testing.T) {
|
|||||||
// over the authenticated catch-all (more specific pattern), so it is refused.
|
// over the authenticated catch-all (more specific pattern), so it is refused.
|
||||||
func TestBuildMuxRefusesAPublicPatternOffTheAllowlist(t *testing.T) {
|
func TestBuildMuxRefusesAPublicPatternOffTheAllowlist(t *testing.T) {
|
||||||
h := api.NewHandler(t.TempDir(), slog.New(slog.NewTextHandler(os.Stderr, nil)), pipeline.Config{})
|
h := api.NewHandler(t.TempDir(), slog.New(slog.NewTextHandler(os.Stderr, nil)), pipeline.Config{})
|
||||||
for _, p := range []string{"POST /query", "GET /pending", "/", "POST /metrics"} {
|
// "/mcp" and "GET /metrics" are built by buildMux itself (hyperguild#154):
|
||||||
_, err := buildMux(restAuth{token: routesTok, realm: "brain"}, h, map[string]http.Handler{p: okHandler("x")})
|
// passing either as public would register them unauthenticated or twice.
|
||||||
|
for _, p := range []string{"POST /query", "GET /pending", "/", "POST /metrics", "/mcp", "GET /metrics"} {
|
||||||
|
_, err := buildMux(restAuth{token: routesTok, realm: "brain"}, h, okHandler("mcp"), metrics.New(),
|
||||||
|
map[string]http.Handler{p: okHandler("x")})
|
||||||
assert.Error(t, err, "public pattern %q must be refused", p)
|
assert.Error(t, err, "public pattern %q must be refused", p)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestBuildMuxRefusesAnEmptyToken(t *testing.T) {
|
func TestBuildMuxRefusesAnEmptyToken(t *testing.T) {
|
||||||
h := api.NewHandler(t.TempDir(), slog.New(slog.NewTextHandler(os.Stderr, nil)), pipeline.Config{})
|
h := api.NewHandler(t.TempDir(), slog.New(slog.NewTextHandler(os.Stderr, nil)), pipeline.Config{})
|
||||||
_, err := buildMux(restAuth{token: "", realm: "brain"}, h, nil)
|
_, err := buildMux(restAuth{token: "", realm: "brain"}, h, okHandler("mcp"), metrics.New(), nil)
|
||||||
assert.Error(t, err)
|
assert.Error(t, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// hyperguild#154: /mcp's bearer was built in main.go, untested; the buildMux
|
||||||
|
// tests used stubs. buildMux now wraps the MCP handler itself, with the same
|
||||||
|
// credential as the REST API.
|
||||||
|
func TestBuildMuxRefusesMCPWithoutAValidToken(t *testing.T) {
|
||||||
|
r := testMux(t)
|
||||||
|
for _, authz := range []string{"", "Bearer wrong"} {
|
||||||
|
code, body := do(t, r, "POST", "/mcp", authz)
|
||||||
|
assert.Equal(t, http.StatusUnauthorized, code, "authz %q", authz)
|
||||||
|
assert.NotEqual(t, "mcp", body)
|
||||||
|
}
|
||||||
|
code, body := do(t, r, "POST", "/mcp", "Bearer "+routesTok)
|
||||||
|
assert.Equal(t, http.StatusOK, code)
|
||||||
|
assert.Equal(t, "mcp", body)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildMuxRefusesANilMCPHandlerOrRegistry(t *testing.T) {
|
||||||
|
auth := restAuth{token: routesTok, realm: "brain"}
|
||||||
|
_, err := buildMux(auth, testHandler(t), nil, metrics.New(), nil)
|
||||||
|
assert.Error(t, err)
|
||||||
|
_, err = buildMux(auth, testHandler(t), okHandler("mcp"), nil, nil)
|
||||||
|
assert.Error(t, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// hyperguild#154: main wrapped buildMux's result in the metrics middleware
|
||||||
|
// before ListenAndServe, untested. buildMux now returns the handler main
|
||||||
|
// serves as-is, metrics included: a request through it is observed and
|
||||||
|
// exposed on its own GET /metrics.
|
||||||
|
func TestBuildMuxObservesRequestsAndServesMetrics(t *testing.T) {
|
||||||
|
r := testMux(t)
|
||||||
|
code, _ := do(t, r, "GET", "/pending", "Bearer "+routesTok)
|
||||||
|
require.Equal(t, http.StatusOK, code)
|
||||||
|
code, body := do(t, r, "GET", "/metrics", "")
|
||||||
|
require.Equal(t, http.StatusOK, code)
|
||||||
|
assert.Contains(t, body, `path="GET /pending"`)
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,39 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"strconv"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/symlinkguard"
|
||||||
|
)
|
||||||
|
|
||||||
|
// startupSymlinkCheck is the hyperguild#157 tripwire at boot: a symlink in the
|
||||||
|
// brain dir would let brain readers serve a file from outside the brain, so
|
||||||
|
// the server does not start until it is removed. A directory the scan cannot
|
||||||
|
// read could hide one, so it refuses on that too. A missing brain dir (first
|
||||||
|
// boot) is the only case it lets pass.
|
||||||
|
func startupSymlinkCheck(brainDir string) error {
|
||||||
|
r, err := symlinkguard.Scan(brainDir)
|
||||||
|
if err != nil {
|
||||||
|
if errors.Is(err, os.ErrNotExist) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return fmt.Errorf("refusing to start: cannot scan the brain dir %s (hyperguild#157): %w", brainDir, err)
|
||||||
|
}
|
||||||
|
if !r.Clean() {
|
||||||
|
return fmt.Errorf("refusing to start: brain dir %s has %s (hyperguild#157); fix them first", brainDir, r)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// symlinkScanInterval reads BRAIN_SYMLINK_SCAN_INTERVAL (seconds), falling
|
||||||
|
// back to the default on an unset, non-numeric or non-positive value.
|
||||||
|
func symlinkScanInterval(getenv func(string) string) time.Duration {
|
||||||
|
if s, err := strconv.Atoi(getenv("BRAIN_SYMLINK_SCAN_INTERVAL")); err == nil && s > 0 {
|
||||||
|
return time.Duration(s) * time.Second
|
||||||
|
}
|
||||||
|
return symlinkguard.DefaultInterval
|
||||||
|
}
|
||||||
@@ -0,0 +1,65 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// hyperguild#157: the server refuses to start while a symlink exists in the
|
||||||
|
// brain dir, or while any part of it cannot be scanned (which could hide
|
||||||
|
// one); a missing brain dir is the only thing it lets pass.
|
||||||
|
func TestStartupSymlinkCheckRefusesABrainWithASymlink(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), filepath.Join(brain, "planted")))
|
||||||
|
err := startupSymlinkCheck(brain)
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), "planted")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStartupSymlinkCheckRefusesABrainWithAnUnreadableDir(t *testing.T) {
|
||||||
|
if os.Geteuid() == 0 {
|
||||||
|
t.Skip("root reads mode-000 directories")
|
||||||
|
}
|
||||||
|
brain := t.TempDir()
|
||||||
|
locked := filepath.Join(brain, "aaa")
|
||||||
|
require.NoError(t, os.MkdirAll(locked, 0o755))
|
||||||
|
require.NoError(t, os.Chmod(locked, 0o000))
|
||||||
|
t.Cleanup(func() { _ = os.Chmod(locked, 0o755) })
|
||||||
|
err := startupSymlinkCheck(brain)
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.Contains(t, err.Error(), "aaa")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStartupSymlinkCheckPassesACleanOrMissingBrain(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(brain, "n.md"), []byte("x"), 0o644))
|
||||||
|
assert.NoError(t, startupSymlinkCheck(brain))
|
||||||
|
assert.NoError(t, startupSymlinkCheck(filepath.Join(brain, "missing")))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSymlinkScanIntervalFallsBackOnNonPositive(t *testing.T) {
|
||||||
|
for _, v := range []string{"0", "-5", "", "junk"} {
|
||||||
|
got := symlinkScanInterval(func(string) string { return v })
|
||||||
|
assert.Positive(t, got, "env %q", v)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAlertingWarningsNamesTheSymlinkTripwire(t *testing.T) {
|
||||||
|
w := strings.Join(alertingWarnings(func(string) string { return "" }), " ")
|
||||||
|
assert.Contains(t, w, "symlink tripwire")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStartupSymlinkCheckRefusesAnUnlistableBrainRoot(t *testing.T) {
|
||||||
|
if os.Geteuid() == 0 {
|
||||||
|
t.Skip("root lists mode-0100 directories")
|
||||||
|
}
|
||||||
|
brain := t.TempDir()
|
||||||
|
require.NoError(t, os.Chmod(brain, 0o100))
|
||||||
|
t.Cleanup(func() { _ = os.Chmod(brain, 0o755) })
|
||||||
|
assert.Error(t, startupSymlinkCheck(brain))
|
||||||
|
}
|
||||||
+7
-7
@@ -34,9 +34,9 @@ require (
|
|||||||
github.com/rogpeppe/go-internal v1.15.0 // indirect
|
github.com/rogpeppe/go-internal v1.15.0 // indirect
|
||||||
github.com/spf13/pflag v1.0.5 // indirect
|
github.com/spf13/pflag v1.0.5 // indirect
|
||||||
github.com/x448/float16 v0.8.4 // indirect
|
github.com/x448/float16 v0.8.4 // indirect
|
||||||
golang.org/x/net v0.26.0 // indirect
|
golang.org/x/net v0.55.0 // indirect
|
||||||
golang.org/x/oauth2 v0.21.0 // indirect
|
golang.org/x/oauth2 v0.21.0 // indirect
|
||||||
golang.org/x/term v0.28.0 // indirect
|
golang.org/x/term v0.43.0 // indirect
|
||||||
golang.org/x/time v0.3.0 // indirect
|
golang.org/x/time v0.3.0 // indirect
|
||||||
google.golang.org/protobuf v1.34.2 // indirect
|
google.golang.org/protobuf v1.34.2 // indirect
|
||||||
gopkg.in/evanphx/json-patch.v4 v4.12.0 // indirect
|
gopkg.in/evanphx/json-patch.v4 v4.12.0 // indirect
|
||||||
@@ -51,7 +51,7 @@ require (
|
|||||||
)
|
)
|
||||||
|
|
||||||
require (
|
require (
|
||||||
git.d-ma.be/mathias/mcp-chassis v0.2.0
|
git.d-ma.be/mathias/mcp-chassis v0.7.1
|
||||||
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
|
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
|
||||||
github.com/decred/dcrd/dcrec/secp256k1/v4 v4.4.0 // indirect
|
github.com/decred/dcrd/dcrec/secp256k1/v4 v4.4.0 // indirect
|
||||||
github.com/goccy/go-json v0.10.3 // indirect
|
github.com/goccy/go-json v0.10.3 // indirect
|
||||||
@@ -66,9 +66,9 @@ require (
|
|||||||
github.com/lestrrat-go/option v1.0.1 // indirect
|
github.com/lestrrat-go/option v1.0.1 // indirect
|
||||||
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
|
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
|
||||||
github.com/segmentio/asm v1.2.0 // indirect
|
github.com/segmentio/asm v1.2.0 // indirect
|
||||||
golang.org/x/crypto v0.32.0 // indirect
|
golang.org/x/crypto v0.51.0 // indirect
|
||||||
golang.org/x/sync v0.17.0 // indirect
|
golang.org/x/sync v0.21.0 // indirect
|
||||||
golang.org/x/sys v0.31.0 // indirect
|
golang.org/x/sys v0.45.0 // indirect
|
||||||
golang.org/x/text v0.29.0 // indirect
|
golang.org/x/text v0.39.0 // indirect
|
||||||
gopkg.in/yaml.v3 v3.0.1
|
gopkg.in/yaml.v3 v3.0.1
|
||||||
)
|
)
|
||||||
|
|||||||
+16
-16
@@ -1,5 +1,5 @@
|
|||||||
git.d-ma.be/mathias/mcp-chassis v0.2.0 h1:6fLmb7xqRa2nNVWsHaUbbfbArgDXJw/gDhb09clBIjo=
|
git.d-ma.be/mathias/mcp-chassis v0.7.1 h1:4h8TOBHTA0L/no4IPcr4tLcQtmKUlhE2/cXyPdNFGmM=
|
||||||
git.d-ma.be/mathias/mcp-chassis v0.2.0/go.mod h1:Ks7EK2UnGAN0H3rJjKUxUagX8/ZBdtLrOlcUbv0RwH8=
|
git.d-ma.be/mathias/mcp-chassis v0.7.1/go.mod h1:Ks7EK2UnGAN0H3rJjKUxUagX8/ZBdtLrOlcUbv0RwH8=
|
||||||
github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
|
github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
|
||||||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||||
@@ -117,42 +117,42 @@ github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9dec
|
|||||||
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
|
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
|
||||||
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
|
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
|
||||||
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
|
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
|
||||||
golang.org/x/crypto v0.32.0 h1:euUpcYgM8WcP71gNpTqQCn6rC2t6ULUPiOzfWaXVVfc=
|
golang.org/x/crypto v0.51.0 h1:IBPXwPfKxY7cWQZ38ZCIRPI50YLeevDLlLnyC5wRGTI=
|
||||||
golang.org/x/crypto v0.32.0/go.mod h1:ZnnJkOaASj8g0AjIduWNlq2NRxL0PlBrbKVyZ6V/Ugc=
|
golang.org/x/crypto v0.51.0/go.mod h1:8AdwkbraGNABw2kOX6YFPs3WM22XqI4EXEd8g+x7Oc8=
|
||||||
golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
||||||
golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
||||||
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
|
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
|
||||||
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
||||||
golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
||||||
golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
|
golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
|
||||||
golang.org/x/net v0.26.0 h1:soB7SVo0PWrY4vPW/+ay0jKDNScG2X9wFeYlXIvJsOQ=
|
golang.org/x/net v0.55.0 h1:bcvxaJn3e1U6InsFWt1JUq1aSjnRxLzT2rtD2KfkDF8=
|
||||||
golang.org/x/net v0.26.0/go.mod h1:5YKkiSynbBIh3p6iOc/vibscux0x38BZDkn8sCUPxHE=
|
golang.org/x/net v0.55.0/go.mod h1:L5U2KuzuOe1lY7Z+aWVIKK6qEeJXnXV9yzGA+WCHJww=
|
||||||
golang.org/x/oauth2 v0.21.0 h1:tsimM75w1tF/uws5rbeHzIWxEqElMehnc+iW793zsZs=
|
golang.org/x/oauth2 v0.21.0 h1:tsimM75w1tF/uws5rbeHzIWxEqElMehnc+iW793zsZs=
|
||||||
golang.org/x/oauth2 v0.21.0/go.mod h1:XYTD2NtWslqkgxebSiOHnXEap4TF09sJSc7H1sXbhtI=
|
golang.org/x/oauth2 v0.21.0/go.mod h1:XYTD2NtWslqkgxebSiOHnXEap4TF09sJSc7H1sXbhtI=
|
||||||
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
golang.org/x/sync v0.17.0 h1:l60nONMj9l5drqw6jlhIELNv9I0A4OFgRsG9k2oT9Ug=
|
golang.org/x/sync v0.21.0 h1:HLII4xRRTtCRkxYp4HNFF0Js/Og6q2i++KXbg0gHCwM=
|
||||||
golang.org/x/sync v0.17.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI=
|
golang.org/x/sync v0.21.0/go.mod h1:9xrNwdLfx4jkKbNva9FpL6vEN7evnE43NNNJQ2LF3+0=
|
||||||
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||||
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||||
golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||||
golang.org/x/sys v0.31.0 h1:ioabZlmFYtWhL+TRYpcnNlLwhyxaM9kWTDEmfnprqik=
|
golang.org/x/sys v0.45.0 h1:dO4czNzziLiiXplLQgBCEpCvXQ3dnkn0SdaZSYdQ+FY=
|
||||||
golang.org/x/sys v0.31.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
|
golang.org/x/sys v0.45.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
|
||||||
golang.org/x/term v0.28.0 h1:/Ts8HFuMR2E6IP/jlo7QVLZHggjKQbhu/7H0LJFr3Gg=
|
golang.org/x/term v0.43.0 h1:S4RLU2sB31O/NCl+zFN9Aru9A/Cq2aqKpTZJ6B+DwT4=
|
||||||
golang.org/x/term v0.28.0/go.mod h1:Sw/lC2IAUZ92udQNf3WodGtn4k/XoLyZoh8v/8uiwek=
|
golang.org/x/term v0.43.0/go.mod h1:lrhlHNdQJHO+1qVYiHfFKVuVioJIheAc3fBSMFYEIsk=
|
||||||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
||||||
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
||||||
golang.org/x/text v0.29.0 h1:1neNs90w9YzJ9BocxfsQNHKuAT4pkghyXc4nhZ6sJvk=
|
golang.org/x/text v0.39.0 h1:UbZz4pLOvn600D6Oh6GGEI6VAmndrEBLv8/6BEXzyus=
|
||||||
golang.org/x/text v0.29.0/go.mod h1:7MhJOA9CD2qZyOKYazxdYMF85OwPdEr9jTtBpO7ydH4=
|
golang.org/x/text v0.39.0/go.mod h1:3UwRclnC2g0TU9x8PZiyfOajCd1zaUNHF9cvqcQZ+ZM=
|
||||||
golang.org/x/time v0.3.0 h1:rg5rLMjNzMS1RkNLzCG38eapWhnYLFYXDXj2gOlr8j4=
|
golang.org/x/time v0.3.0 h1:rg5rLMjNzMS1RkNLzCG38eapWhnYLFYXDXj2gOlr8j4=
|
||||||
golang.org/x/time v0.3.0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
|
golang.org/x/time v0.3.0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
|
||||||
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
|
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
|
||||||
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
|
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
|
||||||
golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE=
|
golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE=
|
||||||
golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
|
golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
|
||||||
golang.org/x/tools v0.36.0 h1:kWS0uv/zsvHEle1LbV5LE8QujrxB3wfQyxHfhOk0Qkg=
|
golang.org/x/tools v0.47.0 h1:7Kn5x/d1svx/PzryTsqeoZN4TZwqeH5pGWjefhLi/1Q=
|
||||||
golang.org/x/tools v0.36.0/go.mod h1:WBDiHKJK8YgLHlcQPYQzNCkUxUypCaa5ZegCVutKm+s=
|
golang.org/x/tools v0.47.0/go.mod h1:dFHnyTvFWY212G+h7ZY4Vsp/K3U4/7W9TyVaAul8uCA=
|
||||||
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||||
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||||
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||||
|
|||||||
@@ -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() })
|
||||||
|
}
|
||||||
@@ -4,6 +4,7 @@ import (
|
|||||||
"crypto/sha256"
|
"crypto/sha256"
|
||||||
"encoding/hex"
|
"encoding/hex"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -174,11 +175,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)
|
||||||
|
|||||||
@@ -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)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,12 +2,18 @@ package brain
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"bufio"
|
"bufio"
|
||||||
|
"bytes"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"io/fs"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
||||||
)
|
)
|
||||||
|
|
||||||
// noteEntry is one row in a Wing _index.md.
|
// noteEntry is one row in a Wing _index.md.
|
||||||
@@ -27,13 +33,18 @@ func BuildWingIndex(brainDir, wing string) error {
|
|||||||
return fmt.Errorf("invalid wing %q", wing)
|
return fmt.Errorf("invalid wing %q", wing)
|
||||||
}
|
}
|
||||||
wingDir := filepath.Join(brainDir, "wiki", w)
|
wingDir := filepath.Join(brainDir, "wiki", w)
|
||||||
if _, err := os.Stat(wingDir); os.IsNotExist(err) {
|
// 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.
|
||||||
|
bfs, err := brainfs.Open(brainDir)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("open brain: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = bfs.Close() }()
|
||||||
|
if _, err := bfs.Lstat("wiki/" + w); errors.Is(err, fs.ErrNotExist) {
|
||||||
return nil
|
return nil
|
||||||
} else if err != nil {
|
|
||||||
return fmt.Errorf("stat wing: %w", err)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
entries, err := collectWingEntries(wingDir)
|
entries, err := collectWingEntries(bfs, "wiki/"+w)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -58,51 +69,47 @@ func BuildWingIndex(brainDir, wing string) error {
|
|||||||
|
|
||||||
// BuildAllWingIndexes regenerates _index.md for every wing under brain/wiki/.
|
// BuildAllWingIndexes regenerates _index.md for every wing under brain/wiki/.
|
||||||
func BuildAllWingIndexes(brainDir string) error {
|
func BuildAllWingIndexes(brainDir string) error {
|
||||||
wikiDir := filepath.Join(brainDir, "wiki")
|
bfs, err := brainfs.Open(brainDir)
|
||||||
ents, err := os.ReadDir(wikiDir)
|
if err != nil {
|
||||||
if os.IsNotExist(err) {
|
return fmt.Errorf("open brain: %w", err)
|
||||||
|
}
|
||||||
|
wings, err := bfs.ReadDirDirs("wiki")
|
||||||
|
_ = bfs.Close()
|
||||||
|
if errors.Is(err, fs.ErrNotExist) {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("read wiki: %w", err)
|
return fmt.Errorf("read wiki: %w", err)
|
||||||
}
|
}
|
||||||
for _, e := range ents {
|
for _, w := range wings {
|
||||||
if !e.IsDir() {
|
if err := BuildWingIndex(brainDir, w); err != nil {
|
||||||
continue
|
return fmt.Errorf("index %s: %w", w, err)
|
||||||
}
|
|
||||||
if err := BuildWingIndex(brainDir, e.Name()); err != nil {
|
|
||||||
return fmt.Errorf("index %s: %w", e.Name(), err)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func collectWingEntries(wingDir string) ([]noteEntry, error) {
|
func collectWingEntries(bfs *brainfs.Brain, wingRel string) ([]noteEntry, error) {
|
||||||
var out []noteEntry
|
var out []noteEntry
|
||||||
ents, err := os.ReadDir(wingDir)
|
halls, err := bfs.ReadDirDirs(wingRel)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("read wing: %w", err)
|
return nil, fmt.Errorf("read wing: %w", err)
|
||||||
}
|
}
|
||||||
for _, hallEnt := range ents {
|
for _, hall := range halls {
|
||||||
if !hallEnt.IsDir() {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
hall := hallEnt.Name()
|
|
||||||
if !IsValidHall(hall) {
|
if !IsValidHall(hall) {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
hallDir := filepath.Join(wingDir, hall)
|
hallRel := wingRel + "/" + hall
|
||||||
notes, err := os.ReadDir(hallDir)
|
names, err := bfs.ReadDirRegular(hallRel)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("read hall %s: %w", hall, err)
|
return nil, fmt.Errorf("read hall %s: %w", hall, err)
|
||||||
}
|
}
|
||||||
for _, n := range notes {
|
for _, name := range names {
|
||||||
if n.IsDir() || !strings.HasSuffix(n.Name(), ".md") || n.Name() == "_index.md" {
|
if !strings.HasSuffix(name, ".md") || name == "_index.md" {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
slug := strings.TrimSuffix(n.Name(), ".md")
|
slug := strings.TrimSuffix(name, ".md")
|
||||||
full := filepath.Join(hallDir, n.Name())
|
title, created := readTitleAndCreatedIn(bfs, hallRel+"/"+name, slug)
|
||||||
title, created := readTitleAndCreated(full, slug)
|
|
||||||
out = append(out, noteEntry{Hall: hall, Slug: slug, Title: title, Created: created})
|
out = append(out, noteEntry{Hall: hall, Slug: slug, Title: title, Created: created})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -117,9 +124,40 @@ func readTitleAndCreated(path, slug string) (string, string) {
|
|||||||
return slug, ""
|
return slug, ""
|
||||||
}
|
}
|
||||||
defer func() { _ = f.Close() }()
|
defer func() { _ = f.Close() }()
|
||||||
|
title, created := parseTitleAndCreated(f)
|
||||||
|
if created == "" {
|
||||||
|
if info, err := os.Stat(path); err == nil {
|
||||||
|
created = info.ModTime().UTC().Format("2006-01-02")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return titleOrSlug(title, slug), created
|
||||||
|
}
|
||||||
|
|
||||||
title, created := "", ""
|
// readTitleAndCreatedIn is readTitleAndCreated through the brain root,
|
||||||
scanner := bufio.NewScanner(f)
|
// regular files only (hyperguild#157).
|
||||||
|
func readTitleAndCreatedIn(bfs *brainfs.Brain, rel, slug string) (string, string) {
|
||||||
|
content, err := bfs.ReadRegular(rel)
|
||||||
|
if err != nil {
|
||||||
|
return slug, ""
|
||||||
|
}
|
||||||
|
title, created := parseTitleAndCreated(bytes.NewReader(content))
|
||||||
|
if created == "" {
|
||||||
|
if info, err := bfs.Lstat(rel); err == nil {
|
||||||
|
created = info.ModTime().UTC().Format("2006-01-02")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return titleOrSlug(title, slug), created
|
||||||
|
}
|
||||||
|
|
||||||
|
func titleOrSlug(title, slug string) string {
|
||||||
|
if title == "" {
|
||||||
|
return strings.ReplaceAll(slug, "-", " ")
|
||||||
|
}
|
||||||
|
return title
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseTitleAndCreated(r io.Reader) (title, created string) {
|
||||||
|
scanner := bufio.NewScanner(r)
|
||||||
inFrontmatter := false
|
inFrontmatter := false
|
||||||
for scanner.Scan() {
|
for scanner.Scan() {
|
||||||
line := scanner.Text()
|
line := scanner.Text()
|
||||||
@@ -149,13 +187,5 @@ func readTitleAndCreated(path, slug string) (string, string) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if title == "" {
|
|
||||||
title = strings.ReplaceAll(slug, "-", " ")
|
|
||||||
}
|
|
||||||
if created == "" {
|
|
||||||
if info, err := os.Stat(path); err == nil {
|
|
||||||
created = info.ModTime().UTC().Format("2006-01-02")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return title, created
|
return title, created
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,132 @@
|
|||||||
|
package brain_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brain"
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs/brainfstest"
|
||||||
|
)
|
||||||
|
|
||||||
|
func readIndex(t *testing.T, brainDir, wing string) string {
|
||||||
|
t.Helper()
|
||||||
|
b, _ := os.ReadFile(filepath.Join(brainDir, "wiki", wing, "_index.md"))
|
||||||
|
return string(b)
|
||||||
|
}
|
||||||
|
|
||||||
|
// hyperguild#157 slice 5: BuildWingIndex listed wiki/<wing>/<hall>/ with
|
||||||
|
// os.ReadDir and opened each note by path, so a symlinked note put the
|
||||||
|
// target's title into _index.md, and a FIFO hung the index build.
|
||||||
|
func TestBuildWingIndexRefusesSymlinkedNotesAndSurvivesSwapRaces(t *testing.T) {
|
||||||
|
b := t.TempDir()
|
||||||
|
facts := filepath.Join(b, "wiki", "w", "facts")
|
||||||
|
require.NoError(t, os.MkdirAll(facts, 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(facts, "ok.md"), []byte("---\ntitle: zqinside\n---\n"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(brainfstest.Outside(t), filepath.Join(facts, "leak.md")))
|
||||||
|
inBrain := brainfstest.WriteSentinelAt(t, filepath.Join(b, "raw", "s.md"))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "..", "raw", "s.md"), filepath.Join(facts, "inlink.md")))
|
||||||
|
|
||||||
|
require.NoError(t, brain.BuildWingIndex(b, "w"))
|
||||||
|
idx := readIndex(t, b, "w")
|
||||||
|
assert.Contains(t, idx, "zqinside", "positive control")
|
||||||
|
assert.NotContains(t, idx, brainfstest.Sentinel)
|
||||||
|
assert.NotContains(t, idx, "leak")
|
||||||
|
assert.NotContains(t, idx, "inlink")
|
||||||
|
|
||||||
|
p := filepath.Join(facts, "r.md")
|
||||||
|
read := func() string {
|
||||||
|
_ = brain.BuildWingIndex(b, "w")
|
||||||
|
return readIndex(t, b, "w")
|
||||||
|
}
|
||||||
|
brainfstest.AssertNoLeak(t, p, "---\ntitle: zqinside\n---\n", 1500*time.Millisecond, read)
|
||||||
|
brainfstest.AssertNoLeakFrom(t, p, "---\ntitle: zqinside\n---\n", inBrain, 1500*time.Millisecond, read)
|
||||||
|
brainfstest.AssertNoHang(t, p, "---\ntitle: zqinside\n---\n", 1500*time.Millisecond, 6*time.Second, func() { _ = read() })
|
||||||
|
}
|
||||||
|
|
||||||
|
// A symlinked hall is skipped while a real hall next to it is indexed; a
|
||||||
|
// symlinked wing is refused and nothing is written into its target.
|
||||||
|
func TestBuildWingIndexSkipsASymlinkedHallAndRefusesASymlinkedWing(t *testing.T) {
|
||||||
|
b := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(b, "raw", "facts"), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(b, "raw", "facts", "r.md"), []byte("---\ntitle: zqrawonly\n---\n"), 0o644))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(b, "wiki", "w", "decisions"), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(b, "wiki", "w", "decisions", "d.md"), []byte("---\ntitle: zqrealhall\n---\n"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "raw", "facts"), filepath.Join(b, "wiki", "w", "facts")))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "raw"), filepath.Join(b, "wiki", "alias")))
|
||||||
|
|
||||||
|
require.NoError(t, brain.BuildWingIndex(b, "w"))
|
||||||
|
idx, err := os.ReadFile(filepath.Join(b, "wiki", "w", "_index.md"))
|
||||||
|
require.NoError(t, err, "the wing index is written")
|
||||||
|
assert.Contains(t, string(idx), "zqrealhall", "the real hall is indexed")
|
||||||
|
assert.NotContains(t, string(idx), "zqrawonly", "the symlinked hall is not")
|
||||||
|
|
||||||
|
assert.Error(t, brain.BuildWingIndex(b, "alias"))
|
||||||
|
_, err = os.Stat(filepath.Join(b, "raw", "_index.md"))
|
||||||
|
assert.True(t, os.IsNotExist(err), "an index was written into the symlinked wing's target")
|
||||||
|
}
|
||||||
|
|
||||||
|
// BuildAllWingIndexes indexes the real wings and skips a symlinked one.
|
||||||
|
func TestBuildAllWingIndexesSkipsASymlinkedWing(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: zqrealwing\n---\n"), 0o644))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(b, "raw", "facts"), 0o755))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "raw"), filepath.Join(b, "wiki", "alias")))
|
||||||
|
|
||||||
|
require.NoError(t, brain.BuildAllWingIndexes(b))
|
||||||
|
idx, err := os.ReadFile(filepath.Join(b, "wiki", "w", "_index.md"))
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Contains(t, string(idx), "zqrealwing")
|
||||||
|
_, err = os.Stat(filepath.Join(b, "raw", "_index.md"))
|
||||||
|
assert.True(t, os.IsNotExist(err))
|
||||||
|
}
|
||||||
|
|
||||||
|
// A link to a symlinked note does not resolve: only regular files count as
|
||||||
|
// entries, so StripUnresolvedLinks unwraps it.
|
||||||
|
func TestStripUnresolvedLinksDoesNotCountASymlinkedNoteAsAnEntry(t *testing.T) {
|
||||||
|
b := t.TempDir()
|
||||||
|
facts := filepath.Join(b, "wiki", "w", "facts")
|
||||||
|
require.NoError(t, os.MkdirAll(facts, 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(facts, "real.md"), []byte("x"), 0o644))
|
||||||
|
brainfstest.WriteSentinelAt(t, filepath.Join(b, "raw", "s.md"))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "..", "raw", "s.md"), filepath.Join(facts, "ghost.md")))
|
||||||
|
out, unlinked, err := brain.StripUnresolvedLinks(b, "see [[real]] and [[ghost]]")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Contains(t, out, "[[real]]", "positive control")
|
||||||
|
assert.NotContains(t, out, "[[ghost]]")
|
||||||
|
assert.Contains(t, unlinked, "ghost")
|
||||||
|
}
|
||||||
|
|
||||||
|
// A linked tree (knowledge/ or wiki/) that is not a real directory is
|
||||||
|
// skipped, not an error: StripUnresolvedLinks runs before every brain_write,
|
||||||
|
// and an error there loses the learning.
|
||||||
|
func TestStripUnresolvedLinksSkipsALinkedTreeThatIsNotARealDirectory(t *testing.T) {
|
||||||
|
for name, mk := range map[string]func(t *testing.T, b string){
|
||||||
|
"symlink to an in-brain dir": func(t *testing.T, b string) {
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(b, "raw", "k"), 0o755))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("raw", "k"), filepath.Join(b, "knowledge")))
|
||||||
|
},
|
||||||
|
"dangling symlink": func(t *testing.T, b string) {
|
||||||
|
require.NoError(t, os.Symlink("nowhere", filepath.Join(b, "knowledge")))
|
||||||
|
},
|
||||||
|
"regular file": func(t *testing.T, b string) {
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(b, "knowledge"), []byte("x"), 0o644))
|
||||||
|
},
|
||||||
|
} {
|
||||||
|
t.Run(name, func(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", "real.md"), []byte("x"), 0o644))
|
||||||
|
mk(t, b)
|
||||||
|
out, _, err := brain.StripUnresolvedLinks(b, "learning [[real]] and [[gone]]")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Contains(t, out, "[[real]]", "links into wiki/ still resolve")
|
||||||
|
assert.NotContains(t, out, "[[gone]]")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,12 +1,16 @@
|
|||||||
package brain
|
package brain
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"io/fs"
|
||||||
"path/filepath"
|
"log/slog"
|
||||||
|
"path"
|
||||||
"regexp"
|
"regexp"
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
||||||
)
|
)
|
||||||
|
|
||||||
// wikilinkRE matches [[target]] and [[target|Display Text]].
|
// wikilinkRE matches [[target]] and [[target|Display Text]].
|
||||||
@@ -98,29 +102,40 @@ var linkedTrees = []string{"knowledge", "wiki"}
|
|||||||
// one the audit will also resolve.
|
// one the audit will also resolve.
|
||||||
func entryIndex(brainDir string) (map[string]struct{}, error) {
|
func entryIndex(brainDir string) (map[string]struct{}, error) {
|
||||||
index := map[string]struct{}{}
|
index := map[string]struct{}{}
|
||||||
|
// Walked through the brain root (hyperguild#157): only regular files
|
||||||
|
// count as entries, so a symlinked .md name cannot make a link resolve.
|
||||||
|
bfs, err := brainfs.Open(brainDir)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("open brain: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = bfs.Close() }()
|
||||||
for _, dir := range linkedTrees {
|
for _, dir := range linkedTrees {
|
||||||
root := filepath.Join(brainDir, dir)
|
if _, err := bfs.Lstat(dir); errors.Is(err, fs.ErrNotExist) {
|
||||||
if _, err := os.Stat(root); os.IsNotExist(err) {
|
|
||||||
continue
|
continue
|
||||||
} else if err != nil {
|
|
||||||
return nil, fmt.Errorf("stat %s: %w", dir, err)
|
|
||||||
}
|
}
|
||||||
err := filepath.WalkDir(root, func(path string, d os.DirEntry, err error) error {
|
var walkErr error
|
||||||
if err != nil {
|
err := bfs.WalkRegular(dir, func(rel string) error {
|
||||||
return err
|
if !strings.HasSuffix(rel, ".md") {
|
||||||
}
|
|
||||||
if d.IsDir() || !strings.HasSuffix(path, ".md") {
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
rel, err := filepath.Rel(brainDir, path)
|
index[strings.TrimSuffix(path.Base(rel), ".md")] = struct{}{}
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
rel = filepath.ToSlash(rel)
|
|
||||||
index[strings.TrimSuffix(filepath.Base(rel), ".md")] = struct{}{}
|
|
||||||
index[strings.TrimPrefix(strings.TrimSuffix(rel, ".md"), "wiki/")] = struct{}{}
|
index[strings.TrimPrefix(strings.TrimSuffix(rel, ".md"), "wiki/")] = struct{}{}
|
||||||
return nil
|
return nil
|
||||||
|
}, func(rel string, err error) {
|
||||||
|
// A linked tree that is not a real directory (a symlink, a
|
||||||
|
// file) is skipped, as filepath.WalkDir did: this runs before
|
||||||
|
// every brain_write, and an error here loses the learning.
|
||||||
|
if rel == dir && errors.Is(err, brainfs.ErrNotRegular) {
|
||||||
|
slog.Warn("link check: skipping a linked tree that is not a real directory", "dir", dir)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if walkErr == nil {
|
||||||
|
walkErr = fmt.Errorf("%s: %w", rel, err)
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
if err == nil {
|
||||||
|
err = walkErr
|
||||||
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("walk %s: %w", dir, err)
|
return nil, fmt.Errorf("walk %s: %w", dir, err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,251 @@
|
|||||||
|
// Package brainfs reads the brain directory through an os.Root (hyperguild#157).
|
||||||
|
// The brain dir is a Syncthing sendreceive folder and Syncthing syncs
|
||||||
|
// symlinks; a reader that walks and reads by path follows a planted symlink
|
||||||
|
// out of the brain, and blocks forever on a planted FIFO. Readers that go
|
||||||
|
// through a Brain only ever read regular files inside the brain: os.Root
|
||||||
|
// refuses to leave the root even if an entry is swapped mid-read, and every
|
||||||
|
// open is non-blocking with the type checked on the opened handle.
|
||||||
|
package brainfs
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"io/fs"
|
||||||
|
"os"
|
||||||
|
"path"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"syscall"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ErrNotRegular is returned for an entry that is 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.
|
||||||
|
type Brain struct {
|
||||||
|
root *os.Root
|
||||||
|
dir string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Open opens brainDir (which may itself be a mount symlink) as a root.
|
||||||
|
func Open(brainDir string) (*Brain, error) {
|
||||||
|
r, err := os.OpenRoot(brainDir)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("open brain root: %w", err)
|
||||||
|
}
|
||||||
|
return &Brain{root: r, dir: brainDir}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close releases the root.
|
||||||
|
func (b *Brain) Close() error { return b.root.Close() }
|
||||||
|
|
||||||
|
// Rel converts a path under the brain dir to a root-relative path.
|
||||||
|
func (b *Brain) Rel(path string) (string, error) {
|
||||||
|
rel, err := filepath.Rel(b.dir, path)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
if rel == ".." || len(rel) > 2 && rel[:3] == ".."+string(filepath.Separator) {
|
||||||
|
return "", fmt.Errorf("%s is outside the brain dir", path)
|
||||||
|
}
|
||||||
|
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
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReadDirRegular lists the regular files directly in a brain-relative
|
||||||
|
// directory, by name. Every component of relDir must be a real directory
|
||||||
|
// (ErrNotRegular otherwise); symlinks, FIFOs, devices and subdirectories in
|
||||||
|
// it are left out.
|
||||||
|
func (b *Brain) ReadDirRegular(relDir string) ([]string, error) {
|
||||||
|
relDir = filepath.ToSlash(relDir)
|
||||||
|
if err := b.realDir(relDir); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
ents, err := fs.ReadDir(b.root.FS(), relDir)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
var names []string
|
||||||
|
for _, e := range ents {
|
||||||
|
if e.Type().IsRegular() {
|
||||||
|
names = append(names, e.Name())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return names, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReadDirDirs lists the real subdirectories directly in a brain-relative
|
||||||
|
// directory, by name. Every component of relDir must be a real directory
|
||||||
|
// (ErrNotRegular otherwise); symlinks to directories are left out.
|
||||||
|
func (b *Brain) ReadDirDirs(relDir string) ([]string, error) {
|
||||||
|
relDir = filepath.ToSlash(relDir)
|
||||||
|
if err := b.realDir(relDir); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
ents, err := fs.ReadDir(b.root.FS(), relDir)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
var names []string
|
||||||
|
for _, e := range ents {
|
||||||
|
if e.Type().IsDir() {
|
||||||
|
names = append(names, e.Name())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return names, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReadRegular reads a brain-relative path, refusing anything that is not a
|
||||||
|
// regular file, both before the open and on the opened handle.
|
||||||
|
func (b *Brain) ReadRegular(rel string) ([]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, -1, fi)
|
||||||
|
}
|
||||||
|
|
||||||
|
// readOpened opens rel non-blocking and reads it only if the OPENED handle is
|
||||||
|
// a regular file. This is the check that matters under a race: an entry
|
||||||
|
// swapped for a FIFO after the Lstat, with a writer holding it open, would
|
||||||
|
// otherwise park io.ReadAll forever (PR #161 review: removing it hung search
|
||||||
|
// after 16 iterations).
|
||||||
|
//
|
||||||
|
// Accepted residual, as in api/rawroot.go: a HARD link to an outside file is
|
||||||
|
// a regular file and is read. Syncthing syncs contents, not links, so a peer
|
||||||
|
// 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
|
||||||
|
// them in. Refusing Nlink > 1 is the next step if either changes.
|
||||||
|
func (b *Brain) readOpened(rel string) ([]byte, error) { return b.readOpenedMax(rel, -1, nil) }
|
||||||
|
|
||||||
|
// 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, fi)
|
||||||
|
}
|
||||||
|
|
||||||
|
// readOpenedMax opens rel and reads it if the opened handle is a regular file
|
||||||
|
// and, when lfi is set, the same file the caller Lstat-ed: os.Root follows an
|
||||||
|
// in-root final symlink even with O_NOFOLLOW, so a symlink to another brain
|
||||||
|
// file swapped in between the Lstat and the open is refused only here.
|
||||||
|
func (b *Brain) readOpenedMax(rel string, max int64, lfi fs.FileInfo) ([]byte, error) {
|
||||||
|
f, err := b.root.OpenFile(rel, os.O_RDONLY|syscall.O_NONBLOCK, 0)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer func() { _ = f.Close() }()
|
||||||
|
hfi, err := f.Stat()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if !hfi.Mode().IsRegular() {
|
||||||
|
return nil, fmt.Errorf("%s: %w", rel, ErrNotRegular)
|
||||||
|
}
|
||||||
|
if lfi != nil && !os.SameFile(lfi, hfi) {
|
||||||
|
return nil, fmt.Errorf("%s: changed while opening: %w", rel, ErrNotRegular)
|
||||||
|
}
|
||||||
|
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
|
||||||
|
// for each regular file. Directories are descended; symlinks, FIFOs and
|
||||||
|
// devices found by the walk are skipped. A walk root with any component that
|
||||||
|
// 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 {
|
||||||
|
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 onErr != nil {
|
||||||
|
onErr(p, err)
|
||||||
|
}
|
||||||
|
if d != nil && d.IsDir() {
|
||||||
|
return fs.SkipDir
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if d.IsDir() || !d.Type().IsRegular() {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return fn(p)
|
||||||
|
})
|
||||||
|
}
|
||||||
@@ -0,0 +1,282 @@
|
|||||||
|
package brainfs
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"io/fs"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
|
"syscall"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// The handle check is what stops a FIFO swapped in after the Lstat. A FIFO
|
||||||
|
// with no writer reads EOF at once, so a race test could not see the check
|
||||||
|
// missing; here a writer holds the FIFO open, as any local process can, and
|
||||||
|
// readOpened must refuse it promptly (PR #161 review).
|
||||||
|
func TestReadOpenedRefusesAFIFOHeldOpenByAWriter(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
fifo := filepath.Join(dir, "p.md")
|
||||||
|
require.NoError(t, syscall.Mkfifo(fifo, 0o644))
|
||||||
|
w, err := os.OpenFile(fifo, os.O_RDWR, 0)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = w.Close() }()
|
||||||
|
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
|
||||||
|
done := make(chan error, 1)
|
||||||
|
go func() { _, err := b.readOpened("p.md"); done <- err }()
|
||||||
|
select {
|
||||||
|
case err := <-done:
|
||||||
|
assert.True(t, errors.Is(err, ErrNotRegular), "got %v", err)
|
||||||
|
case <-time.After(2 * time.Second):
|
||||||
|
t.Fatal("readOpened blocked on a FIFO with a writer")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestReadRegularRefusesSymlinksAndReadsRegularFiles(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "ok.md"), []byte("ok"), 0o644))
|
||||||
|
outside := filepath.Join(t.TempDir(), "s.md")
|
||||||
|
require.NoError(t, os.WriteFile(outside, []byte("secret"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(outside, filepath.Join(dir, "link.md")))
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
got, err := b.ReadRegular("ok.md")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, "ok", string(got))
|
||||||
|
_, err = b.ReadRegular("link.md")
|
||||||
|
assert.True(t, errors.Is(err, ErrNotRegular), "got %v", err)
|
||||||
|
_, err = b.ReadRegular("../" + filepath.Base(outside))
|
||||||
|
assert.Error(t, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRelAcceptsPathsInsideAndRefusesEscapes(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
for in, want := range map[string]string{
|
||||||
|
filepath.Join(dir, "wiki", "x.md"): "wiki/x.md",
|
||||||
|
filepath.Join(dir, "..foo", "x"): "..foo/x",
|
||||||
|
dir: ".",
|
||||||
|
} {
|
||||||
|
got, err := b.Rel(in)
|
||||||
|
require.NoError(t, err, in)
|
||||||
|
assert.Equal(t, want, got, in)
|
||||||
|
}
|
||||||
|
for _, bad := range []string{filepath.Join(dir, "..", "x"), dir + "-evil/x", "/etc/passwd", filepath.Join(dir, "wiki", "..", "..", "x")} {
|
||||||
|
_, err := b.Rel(bad)
|
||||||
|
assert.Error(t, err, bad)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWalkRegularYieldsOnlyRegularFiles(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "a"), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "a", "n.md"), []byte("n"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), filepath.Join(dir, "a", "dirlink")))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join(dir, "a", "n.md"), filepath.Join(dir, "a", "filelink.md")))
|
||||||
|
require.NoError(t, syscall.Mkfifo(filepath.Join(dir, "a", "p.md"), 0o644))
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
var got []string
|
||||||
|
require.NoError(t, b.WalkRegular(".", func(rel string) error { got = append(got, rel); return nil }, nil))
|
||||||
|
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 TestReadDirRegularListsOnlyRegularFilesAndRefusesSymlinkedComponents(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "a", "b", "sub"), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "a", "b", "n.md"), []byte("n"), 0o644))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "other.md"), []byte("o"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "other.md"), filepath.Join(dir, "a", "b", "l.md")))
|
||||||
|
require.NoError(t, syscall.Mkfifo(filepath.Join(dir, "a", "b", "f.md"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink("a", filepath.Join(dir, "alias")))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "x"), 0o755))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "a"), filepath.Join(dir, "x", "mid")))
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
|
||||||
|
names, err := b.ReadDirRegular("a/b")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, []string{"n.md"}, names)
|
||||||
|
for _, rel := range []string{"alias/b", "x/mid/b"} {
|
||||||
|
_, err := b.ReadDirRegular(rel)
|
||||||
|
assert.ErrorIs(t, err, ErrNotRegular, rel)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A final component swapped for a symlink to another regular file in the
|
||||||
|
// brain between the Lstat and the open: os.Root follows in-root links, so
|
||||||
|
// only comparing the two (os.SameFile) refuses it.
|
||||||
|
func TestReadRegularNeverReturnsAnInBrainFileSwappedInBehindASymlink(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "s.md"), []byte("zqsamefilesentinel"), 0o644))
|
||||||
|
p := filepath.Join(dir, "r.md")
|
||||||
|
require.NoError(t, os.WriteFile(p, []byte("inside"), 0o644))
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
|
||||||
|
var stop atomic.Bool
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
wg.Add(1)
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
tmp := p + ".swap"
|
||||||
|
for i := 0; !stop.Load(); i++ {
|
||||||
|
_ = os.Remove(tmp)
|
||||||
|
if i%2 == 0 {
|
||||||
|
_ = os.WriteFile(tmp, []byte("inside"), 0o644)
|
||||||
|
} else {
|
||||||
|
_ = os.Symlink("s.md", tmp)
|
||||||
|
}
|
||||||
|
_ = os.Rename(tmp, p)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
leaks, ok := 0, 0
|
||||||
|
for deadline := time.Now().Add(1500 * time.Millisecond); time.Now().Before(deadline); {
|
||||||
|
got, err := b.ReadRegular("r.md")
|
||||||
|
if err == nil {
|
||||||
|
ok++
|
||||||
|
}
|
||||||
|
if string(got) == "zqsamefilesentinel" {
|
||||||
|
leaks++
|
||||||
|
}
|
||||||
|
got, _ = b.ReadRegularMax("r.md", 1<<20)
|
||||||
|
if string(got) == "zqsamefilesentinel" {
|
||||||
|
leaks++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
stop.Store(true)
|
||||||
|
wg.Wait()
|
||||||
|
assert.Zero(t, leaks)
|
||||||
|
assert.Positive(t, ok, "positive control: the regular file is read")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestReadDirDirsListsOnlyRealSubdirsAndRefusesSymlinkedComponents(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "a", "real"), 0o755))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(dir, "other"), 0o755))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "other"), filepath.Join(dir, "a", "linked")))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "a", "f.md"), []byte("f"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink("a", filepath.Join(dir, "alias")))
|
||||||
|
b, err := Open(dir)
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
|
||||||
|
names, err := b.ReadDirDirs("a")
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, []string{"real"}, names)
|
||||||
|
_, err = b.ReadDirDirs("alias")
|
||||||
|
assert.ErrorIs(t, err, ErrNotRegular)
|
||||||
|
}
|
||||||
@@ -0,0 +1,171 @@
|
|||||||
|
// 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 (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
|
"syscall"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Sentinel marks the outside file's contents.
|
||||||
|
const Sentinel = "zqbrainfssentinelonefiftyseven"
|
||||||
|
|
||||||
|
// outsideContent carries Sentinel in every field a reader might extract: the
|
||||||
|
// frontmatter title and aliases, a heading, a wikilink and the body.
|
||||||
|
const outsideContent = "---\ntitle: " + Sentinel + "\naliases:\n - " + Sentinel + "\n---\n# " + Sentinel +
|
||||||
|
"\n\n" + Sentinel + " [[" + Sentinel + "]]\n"
|
||||||
|
|
||||||
|
// Outside writes a file outside any brain dir containing Sentinel.
|
||||||
|
func Outside(t testing.TB) string {
|
||||||
|
t.Helper()
|
||||||
|
p := filepath.Join(t.TempDir(), "secret.md")
|
||||||
|
if err := os.WriteFile(p, []byte(outsideContent), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
var swapSeq atomic.Int64
|
||||||
|
|
||||||
|
// 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. It returns the number of symlinks
|
||||||
|
// or FIFOs actually renamed into path so far, so a caller can tell a race
|
||||||
|
// that ran from one whose every swap failed (hyperguild#177).
|
||||||
|
func StartSwap(t testing.TB, path, inside, outside string, fifo bool) *atomic.Int64 {
|
||||||
|
t.Helper()
|
||||||
|
var swaps atomic.Int64
|
||||||
|
var stop atomic.Bool
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
wg.Add(1)
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
// A name of its own: swappers on one path share a test, and one
|
||||||
|
// opening another's FIFO for write would block forever.
|
||||||
|
tmp := fmt.Sprintf("%s.swap%d", path, swapSeq.Add(1))
|
||||||
|
// A relative link: os.Root refuses every absolute link on its own, so
|
||||||
|
// an absolute in-brain target would test nothing.
|
||||||
|
link := outside
|
||||||
|
if rel, err := filepath.Rel(filepath.Dir(path), outside); err == nil {
|
||||||
|
link = rel
|
||||||
|
}
|
||||||
|
var writers []*os.File
|
||||||
|
defer func() {
|
||||||
|
for _, w := range writers {
|
||||||
|
_ = w.Close()
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
for i := 0; !stop.Load(); i++ {
|
||||||
|
_ = os.Remove(tmp)
|
||||||
|
var made error
|
||||||
|
switch {
|
||||||
|
case i%2 == 0:
|
||||||
|
_ = os.WriteFile(tmp, []byte(inside), 0o644)
|
||||||
|
case fifo:
|
||||||
|
if made = syscall.Mkfifo(tmp, 0o644); made == nil {
|
||||||
|
if w, err := os.OpenFile(tmp, os.O_RDWR, 0); err == nil {
|
||||||
|
writers = append(writers, w)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
made = os.Symlink(link, tmp)
|
||||||
|
}
|
||||||
|
if err := os.Rename(tmp, path); err == nil && made == nil && i%2 == 1 {
|
||||||
|
swaps.Add(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
t.Cleanup(func() { stop.Store(true); wg.Wait() })
|
||||||
|
return &swaps
|
||||||
|
}
|
||||||
|
|
||||||
|
// WriteSentinelAt writes a file carrying Sentinel at p (creating its
|
||||||
|
// directory), for an in-brain symlink target.
|
||||||
|
func WriteSentinelAt(t *testing.T, p string) string {
|
||||||
|
t.Helper()
|
||||||
|
if err := os.MkdirAll(filepath.Dir(p), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(p, []byte(outsideContent), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// AssertNoLeak loops read for d while a symlink swapper runs on path, and
|
||||||
|
// fails if any output contains Sentinel. The symlink points outside the
|
||||||
|
// brain; os.Root refuses that on its own, so pair it with AssertNoLeakFrom
|
||||||
|
// and an in-brain target.
|
||||||
|
func AssertNoLeak(t *testing.T, path, inside string, d time.Duration, read func() string) {
|
||||||
|
t.Helper()
|
||||||
|
AssertNoLeakFrom(t, path, inside, Outside(t), d, read)
|
||||||
|
}
|
||||||
|
|
||||||
|
// InsideMarker must appear in the inside note's content and in read's
|
||||||
|
// output whenever read saw that note: the floor below counts such reads.
|
||||||
|
const InsideMarker = "inside"
|
||||||
|
|
||||||
|
// AssertNoLeakFrom is AssertNoLeak with the symlink pointing at target, e.g.
|
||||||
|
// a file elsewhere in the brain written with WriteSentinelAt.
|
||||||
|
//
|
||||||
|
// Beyond "no Sentinel in any output" it sets two floors, because without
|
||||||
|
// them the assertion passes when nothing was tested (hyperguild#177): at
|
||||||
|
// least one symlink must have been swapped into path, and at least one read
|
||||||
|
// must have returned InsideMarker (a reader that always errors returns
|
||||||
|
// nothing, and so never leaks).
|
||||||
|
func AssertNoLeakFrom(t testing.TB, path, inside, target string, d time.Duration, read func() string) {
|
||||||
|
t.Helper()
|
||||||
|
if !strings.Contains(inside, InsideMarker) {
|
||||||
|
t.Fatalf("inside content must contain %q", InsideMarker)
|
||||||
|
}
|
||||||
|
swaps := StartSwap(t, path, inside, target, false)
|
||||||
|
leaks, iters, insideReads := 0, 0, 0
|
||||||
|
for deadline := time.Now().Add(d); time.Now().Before(deadline); iters++ {
|
||||||
|
out := read()
|
||||||
|
leaks += strings.Count(out, Sentinel)
|
||||||
|
if strings.Contains(out, InsideMarker) {
|
||||||
|
insideReads++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if leaks > 0 {
|
||||||
|
t.Fatalf("outside file leaked %d times in %d iterations", leaks, iters)
|
||||||
|
}
|
||||||
|
if n := swaps.Load(); n == 0 {
|
||||||
|
t.Fatalf("no symlink was swapped into %s in %d iterations: the race did not run", path, iters)
|
||||||
|
}
|
||||||
|
if insideReads == 0 {
|
||||||
|
t.Fatalf("no read in %d iterations returned the inside note (%q): the reader read nothing", iters, InsideMarker)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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,79 @@
|
|||||||
|
package brainfstest
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"runtime"
|
||||||
|
"syscall"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// recordingTB stands in for the test under AssertNoLeakFrom so a fatal
|
||||||
|
// there can be observed instead of failing this test. Fatalf ends the
|
||||||
|
// calling goroutine the way testing.T does.
|
||||||
|
type recordingTB struct {
|
||||||
|
testing.TB
|
||||||
|
failed bool
|
||||||
|
msg string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *recordingTB) Fatalf(format string, args ...any) {
|
||||||
|
r.failed, r.msg = true, fmt.Sprintf(format, args...)
|
||||||
|
runtime.Goexit()
|
||||||
|
}
|
||||||
|
|
||||||
|
func runAssert(t *testing.T, path, target string, read func() string) *recordingTB {
|
||||||
|
t.Helper()
|
||||||
|
r := &recordingTB{TB: t}
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
defer close(done)
|
||||||
|
AssertNoLeakFrom(r, path, "inside", target, 200*time.Millisecond, read)
|
||||||
|
}()
|
||||||
|
<-done
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
// hyperguild#177: with every swap failing, no leak can occur, so the leak
|
||||||
|
// assertion passed without testing anything.
|
||||||
|
func TestAssertNoLeakFromFailsWhenNoSymlinkSwapSucceeds(t *testing.T) {
|
||||||
|
path := filepath.Join(t.TempDir(), "missing-dir", "r.md")
|
||||||
|
r := runAssert(t, path, Outside(t), func() string { return "inside" })
|
||||||
|
if !r.failed {
|
||||||
|
t.Fatal("AssertNoLeakFrom passed with zero successful symlink swaps")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// hyperguild#177: a reader that always errors returns nothing, so it never
|
||||||
|
// leaks either.
|
||||||
|
func TestAssertNoLeakFromFailsWhenNoReadReturnsTheInsideNote(t *testing.T) {
|
||||||
|
path := filepath.Join(t.TempDir(), "r.md")
|
||||||
|
r := runAssert(t, path, Outside(t), func() string { return "" })
|
||||||
|
if !r.failed {
|
||||||
|
t.Fatal("AssertNoLeakFrom passed with zero reads returning the inside note")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Positive control: a reader that refuses symlinks and reads regular files
|
||||||
|
// passes, so the floors do not fail a working reader.
|
||||||
|
func TestAssertNoLeakFromPassesAReaderThatRefusesSymlinks(t *testing.T) {
|
||||||
|
path := filepath.Join(t.TempDir(), "r.md")
|
||||||
|
read := func() string {
|
||||||
|
f, err := os.OpenFile(path, os.O_RDONLY|noFollow, 0)
|
||||||
|
if err != nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
defer func() { _ = f.Close() }()
|
||||||
|
b := make([]byte, 64)
|
||||||
|
n, _ := f.Read(b)
|
||||||
|
return string(b[:n])
|
||||||
|
}
|
||||||
|
r := runAssert(t, path, Outside(t), read)
|
||||||
|
if r.failed {
|
||||||
|
t.Fatalf("a symlink-refusing reader failed: %s", r.msg)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const noFollow = syscall.O_NOFOLLOW
|
||||||
@@ -12,10 +12,14 @@ package graphsync
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"io/fs"
|
||||||
|
"path"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/graph"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/graph"
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/graphstore"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/graphstore"
|
||||||
)
|
)
|
||||||
@@ -46,8 +50,25 @@ func IndexDoc(ctx context.Context, store Store, brainDir, relPath string) error
|
|||||||
if relPath == "" {
|
if relPath == "" {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
abs := filepath.Join(brainDir, filepath.FromSlash(relPath))
|
// Callers pass caller-supplied paths (brain_tunnel, brain_update): index
|
||||||
content, err := os.ReadFile(abs)
|
// only a clean path under wiki/ or knowledge/.
|
||||||
|
if path.Clean(relPath) != relPath || !filepath.IsLocal(relPath) ||
|
||||||
|
(!strings.HasPrefix(relPath, "wiki/") && !strings.HasPrefix(relPath, "knowledge/")) {
|
||||||
|
return fmt.Errorf("index %q: not a clean wiki/ or knowledge/ path", relPath)
|
||||||
|
}
|
||||||
|
bfs, err := brainfs.Open(brainDir)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("open brain: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = bfs.Close() }()
|
||||||
|
return indexDoc(ctx, store, bfs, relPath)
|
||||||
|
}
|
||||||
|
|
||||||
|
// indexDoc reads relPath through the brain root, regular files only
|
||||||
|
// (hyperguild#157): the brain is a Syncthing folder, and os.ReadFile
|
||||||
|
// followed a synced symlink into the graph and blocked on a FIFO.
|
||||||
|
func indexDoc(ctx context.Context, store Store, bfs *brainfs.Brain, relPath string) error {
|
||||||
|
content, err := bfs.ReadRegular(relPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("read %q: %w", relPath, err)
|
return fmt.Errorf("read %q: %w", relPath, err)
|
||||||
}
|
}
|
||||||
@@ -77,33 +98,34 @@ func BackfillFromBrainDir(ctx context.Context, store Store, brainDir string) (in
|
|||||||
if store == nil {
|
if store == nil {
|
||||||
return 0, nil
|
return 0, nil
|
||||||
}
|
}
|
||||||
roots := []string{"wiki", "knowledge"}
|
bfs, err := brainfs.Open(brainDir)
|
||||||
for _, root := range roots {
|
if err != nil {
|
||||||
base := filepath.Join(brainDir, root)
|
return 0, fmt.Errorf("open brain: %w", err)
|
||||||
if _, err := os.Stat(base); os.IsNotExist(err) {
|
}
|
||||||
|
defer func() { _ = bfs.Close() }()
|
||||||
|
for _, root := range []string{"wiki", "knowledge"} {
|
||||||
|
if _, err := bfs.Lstat(root); errors.Is(err, fs.ErrNotExist) {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
err := filepath.WalkDir(base, func(path string, d os.DirEntry, walkErr error) error {
|
// Any walk error, including a root that is a symlink, aborts.
|
||||||
if walkErr != nil {
|
var walkErr error
|
||||||
return walkErr
|
err := bfs.WalkRegular(root, func(rel string) error {
|
||||||
}
|
if path.Ext(rel) != ".md" {
|
||||||
if d.IsDir() {
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
if filepath.Ext(path) != ".md" {
|
if err := indexDoc(ctx, store, bfs, rel); err != nil {
|
||||||
return nil
|
|
||||||
}
|
|
||||||
rel, relErr := filepath.Rel(brainDir, path)
|
|
||||||
if relErr != nil {
|
|
||||||
return fmt.Errorf("rel %q: %w", path, relErr)
|
|
||||||
}
|
|
||||||
rel = filepath.ToSlash(rel)
|
|
||||||
if err := IndexDoc(ctx, store, brainDir, rel); err != nil {
|
|
||||||
return fmt.Errorf("index %q: %w", rel, err)
|
return fmt.Errorf("index %q: %w", rel, err)
|
||||||
}
|
}
|
||||||
indexed++
|
indexed++
|
||||||
return nil
|
return nil
|
||||||
|
}, func(rel string, err error) {
|
||||||
|
if walkErr == nil {
|
||||||
|
walkErr = fmt.Errorf("%s: %w", rel, err)
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
if err == nil {
|
||||||
|
err = walkErr
|
||||||
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return indexed, fmt.Errorf("walk %s: %w", root, err)
|
return indexed, fmt.Errorf("walk %s: %w", root, err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,92 @@
|
|||||||
|
package graphsync
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs/brainfstest"
|
||||||
|
)
|
||||||
|
|
||||||
|
func (f *fakeStore) dump() string {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
return fmt.Sprintf("%+v %+v", f.upserts, f.replaces)
|
||||||
|
}
|
||||||
|
|
||||||
|
// hyperguild#157 slice 4: IndexDoc and BackfillFromBrainDir read notes with
|
||||||
|
// os.ReadFile, so a symlinked note put the target's title and wikilinks into
|
||||||
|
// the graph, and a FIFO hung the read.
|
||||||
|
func TestIndexDocRefusesSymlinksAndSurvivesSwapRaces(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, "ok.md"), []byte("---\ntitle: zqinside\n---\nbody [[other]]\n"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(brainfstest.Outside(t), filepath.Join(facts, "leak.md")))
|
||||||
|
|
||||||
|
store := newFakeStore()
|
||||||
|
require.NoError(t, IndexDoc(context.Background(), store, brain, "wiki/w/facts/ok.md"))
|
||||||
|
assert.Contains(t, store.dump(), "zqinside", "positive control: a regular note is indexed")
|
||||||
|
assert.Error(t, IndexDoc(context.Background(), store, brain, "wiki/w/facts/leak.md"))
|
||||||
|
// A link to a file elsewhere in the brain: os.Root allows it, only the
|
||||||
|
// regular-file check refuses it.
|
||||||
|
inBrain := brainfstest.WriteSentinelAt(t, filepath.Join(brain, "raw", "s.md"))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "..", "raw", "s.md"), filepath.Join(facts, "inlink.md")))
|
||||||
|
assert.Error(t, IndexDoc(context.Background(), store, brain, "wiki/w/facts/inlink.md"))
|
||||||
|
assert.NotContains(t, store.dump(), brainfstest.Sentinel)
|
||||||
|
|
||||||
|
p := filepath.Join(facts, "r.md")
|
||||||
|
read := func() string {
|
||||||
|
s := newFakeStore()
|
||||||
|
_ = IndexDoc(context.Background(), s, brain, "wiki/w/facts/r.md")
|
||||||
|
return s.dump()
|
||||||
|
}
|
||||||
|
brainfstest.AssertNoLeak(t, p, "---\ntitle: zqinside\n---\n", 1500*time.Millisecond, read)
|
||||||
|
brainfstest.AssertNoLeakFrom(t, p, "---\ntitle: zqinside\n---\n", inBrain, 1500*time.Millisecond, read)
|
||||||
|
brainfstest.AssertNoHang(t, p, "---\ntitle: zqinside\n---\n", 1500*time.Millisecond, 6*time.Second, func() { _ = read() })
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBackfillSkipsSymlinkedNotesAndAbortsOnASymlinkedRoot(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, "ok.md"), []byte("---\ntitle: zqinside\n---\n"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(brainfstest.Outside(t), filepath.Join(facts, "leak.md")))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(brain, "raw"), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(brain, "raw", "r.md"), []byte("---\ntitle: zqrawonly\n---\n"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "..", "raw", "r.md"), filepath.Join(facts, "inlink.md")))
|
||||||
|
require.NoError(t, os.Symlink(".", filepath.Join(brain, "knowledge")))
|
||||||
|
|
||||||
|
store := newFakeStore()
|
||||||
|
_, err := BackfillFromBrainDir(context.Background(), store, brain)
|
||||||
|
assert.Error(t, err, "a symlinked root aborts the backfill")
|
||||||
|
assert.NotContains(t, store.dump(), brainfstest.Sentinel)
|
||||||
|
assert.NotContains(t, store.dump(), "zqrawonly")
|
||||||
|
|
||||||
|
require.NoError(t, os.Remove(filepath.Join(brain, "knowledge")))
|
||||||
|
store = newFakeStore()
|
||||||
|
n, err := BackfillFromBrainDir(context.Background(), store, brain)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, 1, n, "only the regular note is indexed")
|
||||||
|
assert.Contains(t, store.dump(), "zqinside")
|
||||||
|
assert.NotContains(t, store.dump(), brainfstest.Sentinel)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IndexDoc gets caller-supplied paths (brain_tunnel, brain_update): only a
|
||||||
|
// clean path under wiki/ or knowledge/ is indexed.
|
||||||
|
func TestIndexDocRefusesPathsOutsideWikiAndKnowledgeAndUncleanPaths(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
brainfstest.WriteSentinelAt(t, filepath.Join(brain, "raw", "secret.md"))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(brain, "wiki", "w"), 0o755))
|
||||||
|
for _, p := range []string{"raw/secret.md", "wiki/w/../../raw/secret.md", "./raw/secret.md", "/raw/secret.md"} {
|
||||||
|
store := newFakeStore()
|
||||||
|
assert.Error(t, IndexDoc(context.Background(), store, brain, p), p)
|
||||||
|
assert.NotContains(t, store.dump(), brainfstest.Sentinel, p)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -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)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -58,8 +58,9 @@ var (
|
|||||||
|
|
||||||
// Target is a resolved, contained path.
|
// Target is a resolved, contained path.
|
||||||
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)
|
||||||
|
}
|
||||||
@@ -0,0 +1,191 @@
|
|||||||
|
package search
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
|
"syscall"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// hyperguild#157 option 1: search walked and read the brain by path, so a
|
||||||
|
// symlink anywhere in the Syncthing-shared brain dir (wiki/<w>/<h>/leak.md ->
|
||||||
|
// /any/file) put the target's contents in brain_query results (reproduced in
|
||||||
|
// the PR #156 review). Search now walks and reads through an os.Root on the
|
||||||
|
// brain dir and only reads regular files.
|
||||||
|
|
||||||
|
const sentinel157 = "zqsentinelonefiftyseven"
|
||||||
|
|
||||||
|
func searchBrain(t *testing.T) (brain, facts, outside string) {
|
||||||
|
t.Helper()
|
||||||
|
brain = t.TempDir()
|
||||||
|
facts = filepath.Join(brain, "wiki", "w", "facts")
|
||||||
|
require.NoError(t, os.MkdirAll(facts, 0o755))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(brain, "knowledge"), 0o755))
|
||||||
|
outside = filepath.Join(t.TempDir(), "secret.md")
|
||||||
|
require.NoError(t, os.WriteFile(outside, []byte("# secret\n\n"+sentinel157), 0o644))
|
||||||
|
return brain, facts, outside
|
||||||
|
}
|
||||||
|
|
||||||
|
func leaked(rs []Result) int {
|
||||||
|
n := 0
|
||||||
|
for _, r := range rs {
|
||||||
|
n += strings.Count(r.Excerpt+r.Title, sentinel157)
|
||||||
|
}
|
||||||
|
return n
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestQueryDoesNotFollowASymlinkInTheWiki(t *testing.T) {
|
||||||
|
brain, facts, outside := searchBrain(t)
|
||||||
|
require.NoError(t, os.Symlink(outside, filepath.Join(facts, "leak.md")))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(facts, "real.md"), []byte("# real\n\nzqrealnote"), 0o644))
|
||||||
|
rs, err := Query(brain, QueryOptions{Query: sentinel157, Limit: 10})
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Zero(t, leaked(rs))
|
||||||
|
rs, err = Query(brain, QueryOptions{Query: "zqrealnote", Limit: 10})
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Len(t, rs, 1, "regular notes are still found")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestQueryDoesNotFollowASymlinkedDirectory(t *testing.T) {
|
||||||
|
brain, _, outside := searchBrain(t)
|
||||||
|
require.NoError(t, os.Symlink(filepath.Dir(outside), filepath.Join(brain, "wiki", "linked")))
|
||||||
|
rs, err := Query(brain, QueryOptions{Query: sentinel157, Limit: 10})
|
||||||
|
require.NoError(t, err)
|
||||||
|
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
|
||||||
|
// 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
|
||||||
|
// that skips the handle check pass (PR #161 round 2: with a held writer, a
|
||||||
|
// bypass of readOpened hung Query after 5 iterations).
|
||||||
|
// startSwap runs swapInto until the test ends and waits for it before
|
||||||
|
// t.TempDir's cleanup (hyperguild#162).
|
||||||
|
// It returns the count of symlinks or FIFOs actually renamed into path
|
||||||
|
// (hyperguild#177: a swapper whose every swap fails tests nothing).
|
||||||
|
func startSwap(t *testing.T, path, outside string, fifo bool) *atomic.Int64 {
|
||||||
|
t.Helper()
|
||||||
|
var stop atomic.Bool
|
||||||
|
var swaps atomic.Int64
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
wg.Add(1)
|
||||||
|
go func() { defer wg.Done(); swapInto(path, outside, fifo, &stop, &swaps) }()
|
||||||
|
t.Cleanup(func() { stop.Store(true); wg.Wait() })
|
||||||
|
return &swaps
|
||||||
|
}
|
||||||
|
|
||||||
|
func swapInto(path, outside string, fifo bool, stop *atomic.Bool, swaps *atomic.Int64) {
|
||||||
|
tmp := path + ".swap"
|
||||||
|
// Writers stay open until the swapper exits, so a reader parked on a
|
||||||
|
// FIFO stays parked (closing one would hand the reader EOF and hide the
|
||||||
|
// hang). Past the fd limit, new FIFOs simply have no writer.
|
||||||
|
var writers []*os.File
|
||||||
|
defer func() {
|
||||||
|
for _, w := range writers {
|
||||||
|
_ = w.Close()
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
for i := 0; !stop.Load(); i++ {
|
||||||
|
_ = os.Remove(tmp)
|
||||||
|
var made error
|
||||||
|
switch {
|
||||||
|
case i%2 == 0:
|
||||||
|
_ = os.WriteFile(tmp, []byte("# r\n\nzqinside "+"zqracenote"), 0o644)
|
||||||
|
case fifo:
|
||||||
|
if made = syscall.Mkfifo(tmp, 0o644); made == nil {
|
||||||
|
if w, err := os.OpenFile(tmp, os.O_RDWR, 0); err == nil {
|
||||||
|
writers = append(writers, w)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
made = os.Symlink(outside, tmp)
|
||||||
|
}
|
||||||
|
if err := os.Rename(tmp, path); err == nil && made == nil && i%2 == 1 {
|
||||||
|
swaps.Add(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestQueryLeaksNothingUnderASymlinkSwapRace(t *testing.T) {
|
||||||
|
brain, facts, outside := searchBrain(t)
|
||||||
|
swaps := startSwap(t, filepath.Join(facts, "r.md"), outside, false)
|
||||||
|
leaks, iters, insideReads := 0, 0, 0
|
||||||
|
for deadline := time.Now().Add(1500 * time.Millisecond); time.Now().Before(deadline); iters++ {
|
||||||
|
rs, err := Query(brain, QueryOptions{Query: sentinel157, Limit: 10})
|
||||||
|
require.NoError(t, err)
|
||||||
|
leaks += leaked(rs)
|
||||||
|
// Positive control (hyperguild#177): a Query that always errors
|
||||||
|
// returns nothing and so never leaks.
|
||||||
|
rs, err = Query(brain, QueryOptions{Query: "zqracenote", Limit: 10})
|
||||||
|
require.NoError(t, err)
|
||||||
|
if len(rs) > 0 {
|
||||||
|
insideReads++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if leaks > 0 {
|
||||||
|
t.Fatalf("outside file leaked %d times in %d iterations", leaks, iters)
|
||||||
|
}
|
||||||
|
require.Positive(t, swaps.Load(), "no symlink was swapped in: the race did not run")
|
||||||
|
require.Positive(t, insideReads, "no Query returned the inside note")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestQueryDoesNotHangUnderAFIFOSwapRace(t *testing.T) {
|
||||||
|
brain, facts, outside := searchBrain(t)
|
||||||
|
startSwap(t, filepath.Join(facts, "r.md"), outside, true)
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
for deadline := time.Now().Add(1500 * time.Millisecond); time.Now().Before(deadline); {
|
||||||
|
_, _ = Query(brain, QueryOptions{Query: "zqracenote", Limit: 10})
|
||||||
|
}
|
||||||
|
close(done)
|
||||||
|
}()
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
case <-time.After(6 * time.Second):
|
||||||
|
if f, err := os.OpenFile(filepath.Join(facts, "r.md"), os.O_WRONLY|syscall.O_NONBLOCK, 0); err == nil {
|
||||||
|
_ = f.Close()
|
||||||
|
}
|
||||||
|
t.Fatal("search hung on a swapped-in FIFO")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// hydrate (vector-only hits) reads by relative path; it must refuse a symlink.
|
||||||
|
func TestHydrateRefusesASymlink(t *testing.T) {
|
||||||
|
brain, facts, outside := searchBrain(t)
|
||||||
|
require.NoError(t, os.Symlink(outside, filepath.Join(facts, "leak.md")))
|
||||||
|
r, err := hydrate(brain, "wiki/w/facts/leak.md")
|
||||||
|
assert.Error(t, err)
|
||||||
|
assert.NotContains(t, r.Excerpt, sentinel157)
|
||||||
|
}
|
||||||
@@ -5,6 +5,7 @@ import (
|
|||||||
"bufio"
|
"bufio"
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
||||||
sharedfm "github.com/mathiasbq/hyperguild/ingestion/internal/frontmatter"
|
sharedfm "github.com/mathiasbq/hyperguild/ingestion/internal/frontmatter"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"os"
|
"os"
|
||||||
@@ -119,20 +120,30 @@ func QueryContext(ctx context.Context, brainDir string, opts QueryOptions) ([]Re
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Walk and read through an os.Root on the brain dir, regular files only
|
||||||
|
// (hyperguild#157): a symlink planted in the Syncthing-shared brain must
|
||||||
|
// not put an outside file in results, nor a FIFO hang the query.
|
||||||
|
bfs, err := brainfs.Open(brainDir)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("search: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = bfs.Close() }()
|
||||||
|
|
||||||
var results []Result
|
var results []Result
|
||||||
for _, dir := range roots {
|
for _, dir := range roots {
|
||||||
if _, statErr := os.Stat(dir); os.IsNotExist(statErr) {
|
if _, statErr := os.Stat(dir); os.IsNotExist(statErr) {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
err := filepath.WalkDir(dir, func(path string, d os.DirEntry, err error) error {
|
relDir, relErr := bfs.Rel(dir)
|
||||||
if err != nil {
|
if relErr != nil {
|
||||||
slog.Warn("search: skipping path", "path", path, "err", err)
|
return nil, fmt.Errorf("search: %w", relErr)
|
||||||
|
}
|
||||||
|
err := bfs.WalkRegular(relDir, func(relPath string) error {
|
||||||
|
if !strings.HasSuffix(relPath, ".md") {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
if d.IsDir() || !strings.HasSuffix(path, ".md") {
|
path := filepath.Join(brainDir, filepath.FromSlash(relPath))
|
||||||
return nil
|
content, err := bfs.ReadRegular(relPath)
|
||||||
}
|
|
||||||
content, err := os.ReadFile(path)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
slog.Warn("search: skipping unreadable file", "path", path, "err", err)
|
slog.Warn("search: skipping unreadable file", "path", path, "err", err)
|
||||||
return nil
|
return nil
|
||||||
@@ -155,7 +166,7 @@ func QueryContext(ctx context.Context, brainDir string, opts QueryOptions) ([]Re
|
|||||||
origin, writtenBy := extractProvenance(string(content))
|
origin, writtenBy := extractProvenance(string(content))
|
||||||
results = append(results, Result{
|
results = append(results, Result{
|
||||||
Path: rel,
|
Path: rel,
|
||||||
Title: extractTitle(string(content), d.Name()),
|
Title: extractTitle(string(content), filepath.Base(relPath)),
|
||||||
Excerpt: excerpt(string(content), 300),
|
Excerpt: excerpt(string(content), 300),
|
||||||
Score: score,
|
Score: score,
|
||||||
Wing: wing,
|
Wing: wing,
|
||||||
@@ -166,6 +177,8 @@ func QueryContext(ctx context.Context, brainDir string, opts QueryOptions) ([]Re
|
|||||||
WrittenBy: writtenBy,
|
WrittenBy: writtenBy,
|
||||||
})
|
})
|
||||||
return nil
|
return nil
|
||||||
|
}, func(p string, err error) {
|
||||||
|
slog.Warn("search: skipping path", "path", p, "err", err)
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -275,8 +288,13 @@ func pathInScope(relPath, wing, hall string) bool {
|
|||||||
// excerpt, wing, and hall populated. Used for paths that surface only
|
// excerpt, wing, and hall populated. Used for paths that surface only
|
||||||
// via vector search.
|
// via vector search.
|
||||||
func hydrate(brainDir, relPath string) (Result, error) {
|
func hydrate(brainDir, relPath string) (Result, error) {
|
||||||
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 Result{}, err
|
||||||
|
}
|
||||||
|
defer func() { _ = bfs.Close() }()
|
||||||
|
content, err := bfs.ReadRegular(filepath.ToSlash(relPath))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return Result{}, err
|
return Result{}, err
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,75 +0,0 @@
|
|||||||
// Package startupretry retries a startup dependency that may not be serving
|
|
||||||
// yet, instead of exiting on its first failure.
|
|
||||||
//
|
|
||||||
// It exists for the cold-boot ordering race (#83): on a cluster restart the
|
|
||||||
// ingestion pod can reach OIDC discovery before dex is answering, gets a 502
|
|
||||||
// from ingress, and dies — after having already connected postgres, backfilled
|
|
||||||
// the graph and ingested session batches, all of which the restart redoes.
|
|
||||||
// Nothing is misconfigured in that scenario; the pod simply started first.
|
|
||||||
//
|
|
||||||
// The budget is bounded on purpose. Retrying forever would turn a genuine
|
|
||||||
// misconfiguration (wrong issuer URL, bad audience) into a process that looks
|
|
||||||
// healthy and never serves, which is harder to diagnose than a crash loop.
|
|
||||||
package startupretry
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Policy bounds the retry: at most Attempts calls, with the delay doubling
|
|
||||||
// from Base and capped at Max.
|
|
||||||
type Policy struct {
|
|
||||||
Attempts int // total calls, including the first; < 1 means 1
|
|
||||||
Base time.Duration // delay before the second attempt
|
|
||||||
Max time.Duration // ceiling for the doubling delay
|
|
||||||
}
|
|
||||||
|
|
||||||
// Do calls fn until it succeeds, the attempt budget is spent, or ctx ends.
|
|
||||||
//
|
|
||||||
// The returned error wraps the last failure, so callers keep the diagnosis
|
|
||||||
// they would have had without the retry.
|
|
||||||
func Do[T any](ctx context.Context, p Policy, fn func(context.Context) (T, error)) (T, error) {
|
|
||||||
var zero T
|
|
||||||
|
|
||||||
attempts := p.Attempts
|
|
||||||
if attempts < 1 {
|
|
||||||
attempts = 1
|
|
||||||
}
|
|
||||||
|
|
||||||
delay := p.Base
|
|
||||||
var lastErr error
|
|
||||||
|
|
||||||
for i := range attempts {
|
|
||||||
if err := ctx.Err(); err != nil {
|
|
||||||
return zero, fmt.Errorf("startupretry: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
v, err := fn(ctx)
|
|
||||||
if err == nil {
|
|
||||||
return v, nil
|
|
||||||
}
|
|
||||||
lastErr = err
|
|
||||||
|
|
||||||
if i == attempts-1 {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
if delay <= 0 {
|
|
||||||
delay = time.Second
|
|
||||||
}
|
|
||||||
if p.Max > 0 && delay > p.Max {
|
|
||||||
delay = p.Max
|
|
||||||
}
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
return zero, fmt.Errorf("startupretry: %w", ctx.Err())
|
|
||||||
case <-time.After(delay):
|
|
||||||
}
|
|
||||||
delay *= 2
|
|
||||||
}
|
|
||||||
|
|
||||||
return zero, fmt.Errorf("startupretry: gave up after %d attempts: %w", attempts, lastErr)
|
|
||||||
}
|
|
||||||
@@ -1,142 +0,0 @@
|
|||||||
// ingestion/internal/startupretry/startupretry_test.go
|
|
||||||
package startupretry
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
func fastPolicy(attempts int) Policy {
|
|
||||||
return Policy{Attempts: attempts, Base: time.Millisecond, Max: 2 * time.Millisecond}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDo_ReturnsImmediatelyOnFirstSuccess(t *testing.T) {
|
|
||||||
calls := 0
|
|
||||||
got, err := Do(context.Background(), fastPolicy(5), func(context.Context) (string, error) {
|
|
||||||
calls++
|
|
||||||
return "ready", nil
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Do: %v", err)
|
|
||||||
}
|
|
||||||
if got != "ready" {
|
|
||||||
t.Errorf("got %q, want %q", got, "ready")
|
|
||||||
}
|
|
||||||
if calls != 1 {
|
|
||||||
t.Errorf("calls = %d, want 1", calls)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDo_SurvivesTransientFailuresThenSucceeds(t *testing.T) {
|
|
||||||
// The observed cold-boot race: dex is not serving yet, ingress answers
|
|
||||||
// 502 for the first few attempts, then discovery works.
|
|
||||||
calls := 0
|
|
||||||
got, err := Do(context.Background(), fastPolicy(5), func(context.Context) (string, error) {
|
|
||||||
calls++
|
|
||||||
if calls < 4 {
|
|
||||||
return "", errors.New("oidc discovery: status 502")
|
|
||||||
}
|
|
||||||
return "ready", nil
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Do returned %v — a transient 502 must not be fatal", err)
|
|
||||||
}
|
|
||||||
if got != "ready" {
|
|
||||||
t.Errorf("got %q, want %q", got, "ready")
|
|
||||||
}
|
|
||||||
if calls != 4 {
|
|
||||||
t.Errorf("calls = %d, want 4", calls)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDo_GivesUpAfterTheAttemptBudgetAndReportsTheLastError(t *testing.T) {
|
|
||||||
// A genuinely broken issuer must still fail — retrying forever would turn
|
|
||||||
// a config error into a silent hang, which is worse than crash-looping.
|
|
||||||
last := errors.New("oidc discovery: status 404")
|
|
||||||
calls := 0
|
|
||||||
|
|
||||||
_, err := Do(context.Background(), fastPolicy(3), func(context.Context) (string, error) {
|
|
||||||
calls++
|
|
||||||
return "", last
|
|
||||||
})
|
|
||||||
|
|
||||||
if !errors.Is(err, last) {
|
|
||||||
t.Fatalf("err = %v, want it to wrap the last failure", err)
|
|
||||||
}
|
|
||||||
if calls != 3 {
|
|
||||||
t.Errorf("calls = %d, want 3 (the attempt budget)", calls)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDo_StopsPromptlyWhenTheContextIsCancelled(t *testing.T) {
|
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
|
||||||
calls := 0
|
|
||||||
|
|
||||||
done := make(chan struct{})
|
|
||||||
var err error
|
|
||||||
go func() {
|
|
||||||
defer close(done)
|
|
||||||
_, err = Do(ctx, Policy{Attempts: 100, Base: 50 * time.Millisecond, Max: time.Second},
|
|
||||||
func(context.Context) (string, error) {
|
|
||||||
calls++
|
|
||||||
if calls == 1 {
|
|
||||||
cancel()
|
|
||||||
}
|
|
||||||
return "", errors.New("still down")
|
|
||||||
})
|
|
||||||
}()
|
|
||||||
|
|
||||||
select {
|
|
||||||
case <-done:
|
|
||||||
case <-time.After(2 * time.Second):
|
|
||||||
t.Fatal("Do did not return after context cancellation")
|
|
||||||
}
|
|
||||||
if !errors.Is(err, context.Canceled) {
|
|
||||||
t.Errorf("err = %v, want context.Canceled", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDo_BacksOffAndIsCappedByMax(t *testing.T) {
|
|
||||||
var delays []time.Duration
|
|
||||||
p := Policy{Attempts: 5, Base: 10 * time.Millisecond, Max: 25 * time.Millisecond}
|
|
||||||
|
|
||||||
last := time.Now()
|
|
||||||
_, _ = Do(context.Background(), p, func(context.Context) (string, error) {
|
|
||||||
now := time.Now()
|
|
||||||
delays = append(delays, now.Sub(last))
|
|
||||||
last = now
|
|
||||||
return "", errors.New("down")
|
|
||||||
})
|
|
||||||
|
|
||||||
// delays[0] is the first call (no wait); the rest are the sleeps.
|
|
||||||
if len(delays) != 5 {
|
|
||||||
t.Fatalf("attempts = %d, want 5", len(delays))
|
|
||||||
}
|
|
||||||
if delays[1] >= delays[2] {
|
|
||||||
t.Errorf("backoff is not growing: %v then %v", delays[1], delays[2])
|
|
||||||
}
|
|
||||||
for i, d := range delays[1:] {
|
|
||||||
if d > 2*p.Max {
|
|
||||||
t.Errorf("delay %d = %v, exceeds the Max cap %v with slack", i+1, d, p.Max)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPolicy_ZeroValueStillMakesOneAttempt(t *testing.T) {
|
|
||||||
// A caller that forgets to configure the policy must not silently get a
|
|
||||||
// no-op that returns a nil validator and a nil error.
|
|
||||||
calls := 0
|
|
||||||
_, err := Do(context.Background(), Policy{}, func(context.Context) (string, error) {
|
|
||||||
calls++
|
|
||||||
return "", errors.New("down")
|
|
||||||
})
|
|
||||||
|
|
||||||
if calls != 1 {
|
|
||||||
t.Errorf("calls = %d, want 1", calls)
|
|
||||||
}
|
|
||||||
if err == nil {
|
|
||||||
t.Error("err = nil, want the failure surfaced")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,357 @@
|
|||||||
|
// Package symlinkguard is the hyperguild#157 tripwire. The brain directory is
|
||||||
|
// a Syncthing sendreceive folder and Syncthing syncs symlinks; several brain
|
||||||
|
// readers (search, vectorstore, context, graph) follow a symlink out of the
|
||||||
|
// brain and would index or return whatever it points to. Until every reader
|
||||||
|
// reads through an os.Root, a symlink inside the brain, or a directory the
|
||||||
|
// scan cannot read (which could hide one), is an incident: the server refuses
|
||||||
|
// to start on one (main), and Watch reports one that appears while it runs.
|
||||||
|
package symlinkguard
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io/fs"
|
||||||
|
"log/slog"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"sort"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// shutdownFlushTimeout bounds the final flush when Watch stops.
|
||||||
|
var shutdownFlushTimeout = 5 * time.Second
|
||||||
|
|
||||||
|
// DefaultInterval is used when Watch is given a non-positive interval.
|
||||||
|
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).
|
||||||
|
type Notifier interface {
|
||||||
|
Notify(ctx context.Context, msg string) error
|
||||||
|
}
|
||||||
|
|
||||||
|
// Result is what a scan found: symlinks, and directories it could not read
|
||||||
|
// (each of which could hide a symlink). Paths are brain-relative.
|
||||||
|
type Result struct {
|
||||||
|
Symlinks []string
|
||||||
|
Unreadable []string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Clean reports whether the scan found nothing to act on.
|
||||||
|
func (r Result) Clean() bool { return len(r.Symlinks) == 0 && len(r.Unreadable) == 0 }
|
||||||
|
|
||||||
|
// String describes the findings for a log line or alert. Paths are quoted, so
|
||||||
|
// a name containing a newline cannot blur two findings together.
|
||||||
|
func (r Result) String() string {
|
||||||
|
q := r.quoted
|
||||||
|
var parts []string
|
||||||
|
if len(r.Symlinks) > 0 {
|
||||||
|
parts = append(parts, fmt.Sprintf("%d symlink(s): %s", len(r.Symlinks), q(r.Symlinks)))
|
||||||
|
}
|
||||||
|
if len(r.Unreadable) > 0 {
|
||||||
|
parts = append(parts, fmt.Sprintf("%d unreadable dir(s): %s", len(r.Unreadable), q(r.Unreadable)))
|
||||||
|
}
|
||||||
|
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
|
||||||
|
// 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
|
||||||
|
// scanned like any other directory. brainDir itself may be a symlink (a
|
||||||
|
// volume mount); it is resolved first. The error is non-nil when the root
|
||||||
|
// cannot be resolved (wrapping os.ErrNotExist when it is missing) or cannot be
|
||||||
|
// listed.
|
||||||
|
func Scan(brainDir string) (Result, error) {
|
||||||
|
root, err := filepath.EvalSymlinks(brainDir)
|
||||||
|
if err != nil {
|
||||||
|
return Result{}, fmt.Errorf("resolve brain dir: %w", err)
|
||||||
|
}
|
||||||
|
var r Result
|
||||||
|
rootGit := filepath.Join(root, ".git")
|
||||||
|
walkErr := filepath.WalkDir(root, func(p string, d fs.DirEntry, err error) error {
|
||||||
|
rel, _ := filepath.Rel(root, p)
|
||||||
|
rel = filepath.ToSlash(rel)
|
||||||
|
if err != nil {
|
||||||
|
if p == root {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
r.Unreadable = append(r.Unreadable, rel)
|
||||||
|
if d != nil && d.IsDir() {
|
||||||
|
return filepath.SkipDir
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if d.IsDir() && p == rootGit {
|
||||||
|
return filepath.SkipDir
|
||||||
|
}
|
||||||
|
if d.Type()&os.ModeSymlink != 0 {
|
||||||
|
r.Symlinks = append(r.Symlinks, rel)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
sort.Strings(r.Symlinks)
|
||||||
|
sort.Strings(r.Unreadable)
|
||||||
|
if walkErr != nil {
|
||||||
|
// Only the root's own error reaches here (deeper errors are recorded
|
||||||
|
// as Unreadable). A root that cannot be listed cannot be shown clean
|
||||||
|
// (PR #159 round 2: discarding this reported clean while search
|
||||||
|
// served a planted symlink).
|
||||||
|
return r, fmt.Errorf("scan brain dir: %w", walkErr)
|
||||||
|
}
|
||||||
|
return r, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Watch rescans every interval (DefaultInterval if non-positive) until ctx
|
||||||
|
// ends. Every symlink found is removed (the link, never its target:
|
||||||
|
// hyperguild#157 decision), so one is readable for at most one interval.
|
||||||
|
// 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.
|
||||||
|
//
|
||||||
|
// Delivery runs in its own goroutine (hyperguild#164): a hung notifier, with
|
||||||
|
// a full queue, blocked one flush for several notify timeouts, and while the
|
||||||
|
// scan waited on it a planted link stayed readable for several intervals.
|
||||||
|
// The scan hands alerts over without blocking; any that do not fit are
|
||||||
|
// counted in the summary. When ctx ends, Watch returns after a final flush
|
||||||
|
// of what was handed over (bounded by shutdownFlushTimeout); alerts that
|
||||||
|
// flush cannot deliver are counted in one error log line instead. That
|
||||||
|
// shutdown path only runs for a caller that cancels ctx: cmd/server passes
|
||||||
|
// context.Background(), so in production the flush on handoff is what keeps
|
||||||
|
// alerts from waiting on a restart.
|
||||||
|
func Watch(ctx context.Context, brainDir string, interval time.Duration, n Notifier) {
|
||||||
|
if interval <= 0 {
|
||||||
|
interval = DefaultInterval
|
||||||
|
}
|
||||||
|
t := time.NewTicker(interval)
|
||||||
|
defer t.Stop()
|
||||||
|
alerts := make(chan string, maxPending)
|
||||||
|
var overflow atomic.Int64
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
wg.Add(1)
|
||||||
|
go func() { defer wg.Done(); deliver(ctx, interval, n, alerts, &overflow) }()
|
||||||
|
// The scan is the only sender: closing alerts tells deliver to drain and
|
||||||
|
// flush once more, and Watch returns only after it has.
|
||||||
|
defer func() { close(alerts); wg.Wait() }()
|
||||||
|
q := alertSender{alerts: alerts, overflow: &overflow}
|
||||||
|
reported := ""
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
case <-t.C:
|
||||||
|
}
|
||||||
|
r, err := Scan(brainDir)
|
||||||
|
key := ""
|
||||||
|
if err != nil {
|
||||||
|
key = "cannot scan the brain dir: " + err.Error()
|
||||||
|
} else {
|
||||||
|
removed, failed := removeSymlinks(brainDir, r.Symlinks)
|
||||||
|
if len(removed) > 0 {
|
||||||
|
slog.Error("brain symlink tripwire removed symlinks", "count", len(removed))
|
||||||
|
q.push(fmt.Sprintf("brain symlink tripwire (hyperguild#157): removed %d symlink(s) from the brain dir: %s",
|
||||||
|
len(removed), Result{}.quoted(removed)))
|
||||||
|
}
|
||||||
|
key = Result{Symlinks: failed, Unreadable: r.Unreadable}.String()
|
||||||
|
}
|
||||||
|
if key != reported {
|
||||||
|
reported = key
|
||||||
|
if key != "" {
|
||||||
|
slog.Error("brain symlink tripwire", "finding", key)
|
||||||
|
q.push("brain symlink tripwire (hyperguild#157): " + key +
|
||||||
|
". Readers may follow symlinks out of the brain; fix them.")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// alertSender hands alerts to deliver without ever blocking the scan; an
|
||||||
|
// alert that does not fit is counted in overflow, which deliver adds to the
|
||||||
|
// summary.
|
||||||
|
type alertSender struct {
|
||||||
|
alerts chan<- string
|
||||||
|
overflow *atomic.Int64
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s alertSender) push(msg string) {
|
||||||
|
select {
|
||||||
|
case s.alerts <- msg:
|
||||||
|
default:
|
||||||
|
s.overflow.Add(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// deliver owns the alertQueue. It flushes as soon as an alert is handed
|
||||||
|
// over, and again every interval while any are pending (outage retries).
|
||||||
|
// When alerts is closed (Watch is stopping) it drains it and flushes once
|
||||||
|
// more, bounded by shutdownFlushTimeout, so an alert handed over just before
|
||||||
|
// shutdown is not lost (PR #180 review). Whatever that flush cannot deliver
|
||||||
|
// is logged as one error with its counts, never dropped silently.
|
||||||
|
func deliver(ctx context.Context, interval time.Duration, n Notifier, alerts <-chan string, overflow *atomic.Int64) {
|
||||||
|
t := time.NewTicker(interval)
|
||||||
|
defer t.Stop()
|
||||||
|
q := &alertQueue{}
|
||||||
|
// drain moves everything handed over into the queue; it reports false
|
||||||
|
// once alerts is closed.
|
||||||
|
drain := func() bool {
|
||||||
|
defer func() { q.suppressed += int(overflow.Swap(0)) }()
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case msg, ok := <-alerts:
|
||||||
|
if !ok {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
q.push(msg)
|
||||||
|
default:
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case msg, ok := <-alerts:
|
||||||
|
if ok {
|
||||||
|
q.push(msg)
|
||||||
|
ok = drain()
|
||||||
|
}
|
||||||
|
if !ok {
|
||||||
|
q.suppressed += int(overflow.Swap(0))
|
||||||
|
fctx, cancel := context.WithTimeout(context.WithoutCancel(ctx), shutdownFlushTimeout)
|
||||||
|
q.flush(fctx, n)
|
||||||
|
cancel()
|
||||||
|
if len(q.items) > 0 || q.suppressed > 0 {
|
||||||
|
slog.Error("symlink tripwire alerts not delivered at shutdown",
|
||||||
|
"undelivered", len(q.items), "suppressed", q.suppressed)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
q.flush(ctx, n)
|
||||||
|
case <-t.C:
|
||||||
|
if !drain() {
|
||||||
|
continue // the closed channel is handled by the case above
|
||||||
|
}
|
||||||
|
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
|
||||||
|
}
|
||||||
@@ -0,0 +1,774 @@
|
|||||||
|
package symlinkguard
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"log/slog"
|
||||||
|
"path/filepath"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
// hyperguild#157: the brain dir is a Syncthing sendreceive folder and
|
||||||
|
// Syncthing syncs symlinks; several readers follow them out of the brain.
|
||||||
|
// Until every reader goes through an os.Root, a symlink anywhere in the brain,
|
||||||
|
// or a directory the scan cannot read (which could hide one), is an incident.
|
||||||
|
|
||||||
|
func TestScanReportsSymlinksAtEveryDepthIncludingNestedGit(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
outside := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(brain, "wiki", "w", "facts", ".git"), 0o755))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(brain, ".git", "objects"), 0o755))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join(outside, "f"), filepath.Join(brain, "wiki", "w", "facts", "leak.md")))
|
||||||
|
require.NoError(t, os.Symlink(outside, filepath.Join(brain, "wiki", "dirlink")))
|
||||||
|
// PR #159 review: only the ROOT .git is skipped; a nested .git is not
|
||||||
|
// special to the brain readers, which walk into it.
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join(outside, "g"), filepath.Join(brain, "wiki", "w", "facts", ".git", "leak.md")))
|
||||||
|
require.NoError(t, os.Symlink(outside, filepath.Join(brain, ".git", "objects", "alt")))
|
||||||
|
|
||||||
|
r, err := Scan(brain)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.ElementsMatch(t, []string{"wiki/w/facts/leak.md", "wiki/dirlink", "wiki/w/facts/.git/leak.md"}, r.Symlinks)
|
||||||
|
assert.Empty(t, r.Unreadable)
|
||||||
|
}
|
||||||
|
|
||||||
|
// PR #159 review: WalkDir stopped at the first unreadable directory and the
|
||||||
|
// startup check passed, while search (which keeps walking) served a planted
|
||||||
|
// symlink. Scan now records the unreadable dir and keeps going.
|
||||||
|
func TestScanReportsUnreadableDirsAndKeepsWalkingPastThem(t *testing.T) {
|
||||||
|
if os.Geteuid() == 0 {
|
||||||
|
t.Skip("root reads mode-000 directories")
|
||||||
|
}
|
||||||
|
brain := t.TempDir()
|
||||||
|
locked := filepath.Join(brain, "aaa")
|
||||||
|
require.NoError(t, os.MkdirAll(locked, 0o755))
|
||||||
|
require.NoError(t, os.Chmod(locked, 0o000))
|
||||||
|
t.Cleanup(func() { _ = os.Chmod(locked, 0o755) })
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), filepath.Join(brain, "zzz-planted")))
|
||||||
|
|
||||||
|
r, err := Scan(brain)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, []string{"aaa"}, r.Unreadable)
|
||||||
|
assert.Equal(t, []string{"zzz-planted"}, r.Symlinks, "the walk continues past the unreadable dir")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestScanResolvesASymlinkedRootAndReportsSymlinkedEntriesInsideIt(t *testing.T) {
|
||||||
|
real := t.TempDir()
|
||||||
|
link := filepath.Join(t.TempDir(), "brain")
|
||||||
|
require.NoError(t, os.Symlink(real, link))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(real, "n.md"), []byte("x"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), filepath.Join(real, "inner")))
|
||||||
|
r, err := Scan(link)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Equal(t, []string{"inner"}, r.Symlinks)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestScanOfAMissingRootIsErrNotExist(t *testing.T) {
|
||||||
|
_, err := Scan(filepath.Join(t.TempDir(), "nope"))
|
||||||
|
assert.True(t, errors.Is(err, os.ErrNotExist), "got %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
type recNotifier struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
msgs []string
|
||||||
|
fail int // fail the first N calls
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *recNotifier) Notify(_ context.Context, m string) error {
|
||||||
|
r.mu.Lock()
|
||||||
|
defer r.mu.Unlock()
|
||||||
|
r.msgs = append(r.msgs, m)
|
||||||
|
if r.fail > 0 {
|
||||||
|
r.fail--
|
||||||
|
return errors.New("ntfy down")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *recNotifier) count() int { r.mu.Lock(); defer r.mu.Unlock(); return len(r.msgs) }
|
||||||
|
|
||||||
|
func TestWatchNotifiesOncePerDistinctSetAndAgainForANewSet(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
n := &recNotifier{}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go Watch(ctx, brain, 10*time.Millisecond, n)
|
||||||
|
|
||||||
|
time.Sleep(50 * time.Millisecond)
|
||||||
|
assert.Zero(t, n.count(), "a clean brain raises nothing")
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), filepath.Join(brain, "first")))
|
||||||
|
require.Eventually(t, func() bool { return n.count() == 1 }, 2*time.Second, 10*time.Millisecond)
|
||||||
|
time.Sleep(60 * time.Millisecond)
|
||||||
|
assert.Equal(t, 1, n.count(), "the same set is reported once, not every tick")
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), filepath.Join(brain, "second")))
|
||||||
|
require.Eventually(t, func() bool { return n.count() == 2 }, 2*time.Second, 10*time.Millisecond)
|
||||||
|
}
|
||||||
|
|
||||||
|
// PR #159 review: last was recorded before Notify, so an alert lost to an
|
||||||
|
// ntfy outage was never retried while the symlink stayed.
|
||||||
|
func TestWatchRetriesAnAlertThatFailedToSend(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), filepath.Join(brain, "planted")))
|
||||||
|
n := &recNotifier{fail: 2}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go Watch(ctx, brain, 10*time.Millisecond, n)
|
||||||
|
require.Eventually(t, func() bool { return n.count() == 3 }, 2*time.Second, 10*time.Millisecond)
|
||||||
|
time.Sleep(60 * time.Millisecond)
|
||||||
|
assert.Equal(t, 3, n.count(), "after one successful send, no more")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWatchAlertsOnAnUnreadableDir(t *testing.T) {
|
||||||
|
if os.Geteuid() == 0 {
|
||||||
|
t.Skip("root reads mode-000 directories")
|
||||||
|
}
|
||||||
|
brain := t.TempDir()
|
||||||
|
locked := filepath.Join(brain, "locked")
|
||||||
|
require.NoError(t, os.MkdirAll(locked, 0o755))
|
||||||
|
require.NoError(t, os.Chmod(locked, 0o000))
|
||||||
|
t.Cleanup(func() { _ = os.Chmod(locked, 0o755) })
|
||||||
|
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)
|
||||||
|
assert.Contains(t, n.msgs[0], "locked")
|
||||||
|
}
|
||||||
|
|
||||||
|
// PR #159 review: a non-positive interval panicked time.NewTicker inside the
|
||||||
|
// goroutine and crashlooped the server.
|
||||||
|
func TestWatchToleratesANonPositiveInterval(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() { Watch(ctx, brain, 0, nil); close(done) }()
|
||||||
|
cancel()
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
case <-time.After(2 * time.Second):
|
||||||
|
t.Fatal("Watch did not return on cancel")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// PR #159 round 2: a brain root that can be entered but not listed (mode
|
||||||
|
// 0100) made WalkDir fail at the root; the error was discarded and Scan
|
||||||
|
// reported clean, while search (which goes straight into wiki/) still served
|
||||||
|
// a planted symlink. A root that cannot be listed is now an error.
|
||||||
|
func TestScanOfAnUnlistableRootIsAnError(t *testing.T) {
|
||||||
|
if os.Geteuid() == 0 {
|
||||||
|
t.Skip("root lists mode-0100 directories")
|
||||||
|
}
|
||||||
|
brain := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(brain, "wiki"), 0o755))
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), filepath.Join(brain, "wiki", "leak.md")))
|
||||||
|
require.NoError(t, os.Chmod(brain, 0o100))
|
||||||
|
t.Cleanup(func() { _ = os.Chmod(brain, 0o755) })
|
||||||
|
_, err := Scan(brain)
|
||||||
|
require.Error(t, err)
|
||||||
|
assert.False(t, errors.Is(err, os.ErrNotExist), "an unlistable root is not a missing root")
|
||||||
|
}
|
||||||
|
|
||||||
|
// The same set that disappears and comes back is reported again.
|
||||||
|
func TestWatchReportsASetAgainAfterItWasCleared(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
link := filepath.Join(brain, "planted")
|
||||||
|
n := &recNotifier{}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go Watch(ctx, brain, 10*time.Millisecond, n)
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), link))
|
||||||
|
require.Eventually(t, func() bool { return n.count() == 1 }, 2*time.Second, 10*time.Millisecond)
|
||||||
|
// The tripwire removed it; planting it again is a new event.
|
||||||
|
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.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. Like the real audit.NtfyNotifier
|
||||||
|
// (http.NewRequestWithContext), it also fails, without recording, when its
|
||||||
|
// ctx is already done (PR #180 round 2: notifiers that ignored ctx let a
|
||||||
|
// final flush on the cancelled ctx pass).
|
||||||
|
type toggleNotifier struct {
|
||||||
|
recNotifier
|
||||||
|
down atomic.Bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *toggleNotifier) Notify(ctx context.Context, m string) error {
|
||||||
|
if err := ctx.Err(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
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")
|
||||||
|
}
|
||||||
|
|
||||||
|
// hungNotifier answers every Notify only after latency (or when ctx ends),
|
||||||
|
// with an outage error: an ntfy that accepts connections but never responds
|
||||||
|
// until its timeout.
|
||||||
|
type hungNotifier struct{ latency time.Duration }
|
||||||
|
|
||||||
|
func (h hungNotifier) Notify(ctx context.Context, _ string) error {
|
||||||
|
select {
|
||||||
|
case <-time.After(h.latency):
|
||||||
|
case <-ctx.Done():
|
||||||
|
}
|
||||||
|
return errors.New("ntfy timeout")
|
||||||
|
}
|
||||||
|
|
||||||
|
func waitGone(t *testing.T, link string) {
|
||||||
|
t.Helper()
|
||||||
|
require.Eventually(t, func() bool { _, err := os.Lstat(link); return os.IsNotExist(err) }, 10*time.Second, time.Millisecond)
|
||||||
|
}
|
||||||
|
|
||||||
|
// hyperguild#164: alerts were flushed in the scan goroutine, so with a hung
|
||||||
|
// ntfy and a full queue one flush (6 x notify timeout) delayed the next scan.
|
||||||
|
// The notifier here is slower than the interval, as in production (10 s
|
||||||
|
// timeout vs 30 s interval with 6 messages), so the alert handoff is full:
|
||||||
|
// a scan that waited on it would keep a link for seconds.
|
||||||
|
func TestWatchLinkLifetimeStaysNearOneIntervalWithANotifierSlowerThanTheInterval(t *testing.T) {
|
||||||
|
const interval = 100 * time.Millisecond
|
||||||
|
brain := t.TempDir()
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go Watch(ctx, brain, interval, hungNotifier{latency: 400 * time.Millisecond})
|
||||||
|
|
||||||
|
for i := 0; i < 2*maxPending+3; i++ { // overfill queue and handoff
|
||||||
|
link := filepath.Join(brain, "fill"+strconv.Itoa(i))
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), link))
|
||||||
|
waitGone(t, link)
|
||||||
|
}
|
||||||
|
var worst time.Duration
|
||||||
|
for i := 0; i < 6; i++ {
|
||||||
|
link := filepath.Join(brain, "probe"+strconv.Itoa(i))
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), link))
|
||||||
|
planted := time.Now()
|
||||||
|
waitGone(t, link)
|
||||||
|
worst = max(worst, time.Since(planted))
|
||||||
|
}
|
||||||
|
assert.LessOrEqual(t, worst, interval+interval/2, "worst link lifetime %v with a hung notifier", worst)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Review of PR #180: delivery waited for its own tick, about one interval
|
||||||
|
// after the removal. An alert is now flushed as soon as it is handed over.
|
||||||
|
func TestWatchDeliversARemovalAlertWellWithinOneInterval(t *testing.T) {
|
||||||
|
const interval = 400 * time.Millisecond
|
||||||
|
brain := t.TempDir()
|
||||||
|
n := &recNotifier{}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go Watch(ctx, brain, interval, n)
|
||||||
|
link := filepath.Join(brain, "prompt")
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), link))
|
||||||
|
waitGone(t, link)
|
||||||
|
removed := time.Now()
|
||||||
|
require.Eventually(t, func() bool { return n.count() == 1 }, 2*time.Second, time.Millisecond)
|
||||||
|
assert.Less(t, time.Since(removed), interval/4)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Review of PR #180: on ctx end, deliver returned without draining what the
|
||||||
|
// scan had handed over, so a removal just before shutdown was neither
|
||||||
|
// delivered nor counted. Watch now drains and flushes before returning.
|
||||||
|
func TestWatchDeliversAnAlertHandedOverJustBeforeShutdown(t *testing.T) {
|
||||||
|
for i := 0; i < 20; i++ {
|
||||||
|
brain := t.TempDir()
|
||||||
|
n := &recNotifier{}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() { Watch(ctx, brain, 5*time.Millisecond, n); close(done) }()
|
||||||
|
link := filepath.Join(brain, "late")
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), link))
|
||||||
|
waitGone(t, link)
|
||||||
|
cancel()
|
||||||
|
<-done
|
||||||
|
require.Equal(t, 1, n.count(), "iteration %d: the removal alert was lost at shutdown", i)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// blockingNotifier holds every Notify until its ctx ends, tracking calls in
|
||||||
|
// flight.
|
||||||
|
type blockingNotifier struct{ inFlight atomic.Int32 }
|
||||||
|
|
||||||
|
func (b *blockingNotifier) Notify(ctx context.Context, _ string) error {
|
||||||
|
b.inFlight.Add(1)
|
||||||
|
defer b.inFlight.Add(-1)
|
||||||
|
<-ctx.Done()
|
||||||
|
return ctx.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Watch does not return while its delivery goroutine is still notifying.
|
||||||
|
func TestWatchReturnsOnlyAfterDeliveryHasStopped(t *testing.T) {
|
||||||
|
prev := shutdownFlushTimeout
|
||||||
|
shutdownFlushTimeout = 50 * time.Millisecond
|
||||||
|
t.Cleanup(func() { shutdownFlushTimeout = prev })
|
||||||
|
brain := t.TempDir()
|
||||||
|
n := &blockingNotifier{}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() { Watch(ctx, brain, 5*time.Millisecond, n); close(done) }()
|
||||||
|
link := filepath.Join(brain, "x")
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), link))
|
||||||
|
waitGone(t, link)
|
||||||
|
require.Eventually(t, func() bool { return n.inFlight.Load() == 1 }, 2*time.Second, time.Millisecond)
|
||||||
|
cancel()
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
case <-time.After(5 * time.Second):
|
||||||
|
t.Fatal("Watch did not return after cancel")
|
||||||
|
}
|
||||||
|
assert.Zero(t, n.inFlight.Load(), "Notify still running after Watch returned")
|
||||||
|
}
|
||||||
|
|
||||||
|
// slowToggleNotifier fails slowly (a hung ntfy) while down, then records.
|
||||||
|
type slowToggleNotifier struct {
|
||||||
|
recNotifier
|
||||||
|
down atomic.Bool
|
||||||
|
latency time.Duration
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *slowToggleNotifier) Notify(ctx context.Context, m string) error {
|
||||||
|
if r.down.Load() {
|
||||||
|
select {
|
||||||
|
case <-time.After(r.latency):
|
||||||
|
case <-ctx.Done():
|
||||||
|
}
|
||||||
|
return errors.New("ntfy timeout")
|
||||||
|
}
|
||||||
|
return r.recNotifier.Notify(ctx, m)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Review of PR #180: with a slow notifier the scan's handoff overflows, and
|
||||||
|
// those alerts exist only in the overflow counter. Every removal is still
|
||||||
|
// delivered or counted in the summary.
|
||||||
|
func TestWatchCountsHandoffOverflowWithASlowNotifier(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
n := &slowToggleNotifier{latency: 30 * time.Millisecond}
|
||||||
|
n.down.Store(true)
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go Watch(ctx, brain, 2*time.Millisecond, n)
|
||||||
|
const plants = 40
|
||||||
|
for i := 0; i < plants; i++ {
|
||||||
|
link := filepath.Join(brain, "ov"+strconv.Itoa(i))
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), link))
|
||||||
|
waitGone(t, link)
|
||||||
|
}
|
||||||
|
n.down.Store(false)
|
||||||
|
delivered, counted := 0, 0
|
||||||
|
require.Eventually(t, func() bool {
|
||||||
|
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") {
|
||||||
|
var c int
|
||||||
|
_, _ = fmt.Sscanf(m[i+3:], "%d", &c)
|
||||||
|
counted += c
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return delivered+counted == plants
|
||||||
|
}, 5*time.Second, 10*time.Millisecond, "delivered %d + counted %d of %d", delivered, counted, plants)
|
||||||
|
}
|
||||||
|
|
||||||
|
// An alert still queued when Watch stops (its send failed, the notifier has
|
||||||
|
// since recovered, the retry tick has not come) is flushed once more before
|
||||||
|
// Watch returns, on a ctx that is not the cancelled one: toggleNotifier fails
|
||||||
|
// on a done ctx, as the real ntfy notifier does.
|
||||||
|
func TestWatchFinalFlushSendsAQueuedAlertOnACtxThatOutlivesTheCancel(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
n := &toggleNotifier{}
|
||||||
|
n.down.Store(true)
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() { Watch(ctx, brain, 300*time.Millisecond, n); close(done) }()
|
||||||
|
link := filepath.Join(brain, "queued")
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), link))
|
||||||
|
waitGone(t, link)
|
||||||
|
time.Sleep(20 * time.Millisecond) // let the immediate send fail
|
||||||
|
n.down.Store(false)
|
||||||
|
cancel()
|
||||||
|
<-done
|
||||||
|
assert.Equal(t, 1, n.count(), "the queued alert was not flushed at shutdown")
|
||||||
|
}
|
||||||
|
|
||||||
|
// lockedBuffer is a goroutine-safe log sink: Watch goroutines of earlier
|
||||||
|
// tests may still log while one test captures.
|
||||||
|
type lockedBuffer struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
buf bytes.Buffer
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *lockedBuffer) Write(p []byte) (int, error) {
|
||||||
|
b.mu.Lock()
|
||||||
|
defer b.mu.Unlock()
|
||||||
|
return b.buf.Write(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *lockedBuffer) String() string { b.mu.Lock(); defer b.mu.Unlock(); return b.buf.String() }
|
||||||
|
|
||||||
|
func captureLog(t *testing.T) *lockedBuffer {
|
||||||
|
t.Helper()
|
||||||
|
b := &lockedBuffer{}
|
||||||
|
prev := slog.Default()
|
||||||
|
slog.SetDefault(slog.New(slog.NewTextHandler(b, nil)))
|
||||||
|
t.Cleanup(func() { slog.SetDefault(prev) })
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
// PR #180 round 2: when the final flush fails (ntfy hung at shutdown) the
|
||||||
|
// undelivered alerts vanished with only "will retry" warnings. Watch now logs
|
||||||
|
// one error with both counts.
|
||||||
|
func TestWatchLogsUndeliveredAndSuppressedCountsWhenTheFinalFlushFails(t *testing.T) {
|
||||||
|
prev := shutdownFlushTimeout
|
||||||
|
shutdownFlushTimeout = 50 * time.Millisecond
|
||||||
|
t.Cleanup(func() { shutdownFlushTimeout = prev })
|
||||||
|
logs := captureLog(t)
|
||||||
|
brain := t.TempDir()
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() { Watch(ctx, brain, 5*time.Millisecond, hungNotifier{latency: time.Hour}); close(done) }()
|
||||||
|
link := filepath.Join(brain, "lost")
|
||||||
|
require.NoError(t, os.Symlink(t.TempDir(), link))
|
||||||
|
waitGone(t, link)
|
||||||
|
cancel()
|
||||||
|
<-done
|
||||||
|
out := logs.String()
|
||||||
|
assert.Contains(t, out, "level=ERROR")
|
||||||
|
assert.Contains(t, out, `msg="symlink tripwire alerts not delivered at shutdown"`)
|
||||||
|
assert.Contains(t, out, "undelivered=1")
|
||||||
|
assert.Contains(t, out, "suppressed=0")
|
||||||
|
}
|
||||||
|
|
||||||
|
// deliver, given a handoff that already holds alerts and is closed, moves them
|
||||||
|
// into the queue and runs the final flush, even though the ctx is cancelled:
|
||||||
|
// the drain-on-close path, without depending on when the close lands.
|
||||||
|
func TestDeliverFlushesAlertsDrainedFromAClosedHandoffOnACancelledCtx(t *testing.T) {
|
||||||
|
alerts := make(chan string, 3)
|
||||||
|
alerts <- "a1"
|
||||||
|
alerts <- "a2"
|
||||||
|
close(alerts)
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel()
|
||||||
|
n := &toggleNotifier{}
|
||||||
|
var overflow atomic.Int64
|
||||||
|
deliver(ctx, time.Hour, n, alerts, &overflow)
|
||||||
|
assert.Equal(t, []string{"a1", "a2"}, n.msgs)
|
||||||
|
}
|
||||||
|
|
||||||
|
// PR #180 round 2: when the first receive after close finds the handoff empty,
|
||||||
|
// overflow counted by the scan was never moved into the summary.
|
||||||
|
func TestDeliverCountsOverflowWhenTheHandoffIsClosedAndEmpty(t *testing.T) {
|
||||||
|
alerts := make(chan string)
|
||||||
|
close(alerts)
|
||||||
|
n := &recNotifier{}
|
||||||
|
var overflow atomic.Int64
|
||||||
|
overflow.Store(3)
|
||||||
|
deliver(context.Background(), time.Hour, n, alerts, &overflow)
|
||||||
|
require.Len(t, n.msgs, 1)
|
||||||
|
assert.Contains(t, n.msgs[0], "3 further alert(s)")
|
||||||
|
}
|
||||||
@@ -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)
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ import (
|
|||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
||||||
"github.com/mathiasbq/hyperguild/ingestion/internal/textutil"
|
"github.com/mathiasbq/hyperguild/ingestion/internal/textutil"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -16,6 +17,11 @@ func RebuildIndex(brainDir, date string) error {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("load inventory: %w", err)
|
return fmt.Errorf("load inventory: %w", err)
|
||||||
}
|
}
|
||||||
|
bfs, err := brainfs.Open(brainDir)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("open brain: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = bfs.Close() }()
|
||||||
|
|
||||||
total := len(inv[PageTypeConcept]) + len(inv[PageTypeEntity]) + len(inv[PageTypeSource])
|
total := len(inv[PageTypeConcept]) + len(inv[PageTypeEntity]) + len(inv[PageTypeSource])
|
||||||
var sb strings.Builder
|
var sb strings.Builder
|
||||||
@@ -34,7 +40,7 @@ func RebuildIndex(brainDir, date string) error {
|
|||||||
label := strings.ToUpper(string(pt)[:1]) + string(pt)[1:]
|
label := strings.ToUpper(string(pt)[:1]) + string(pt)[1:]
|
||||||
fmt.Fprintf(&sb, "## %s\n\n", label)
|
fmt.Fprintf(&sb, "## %s\n\n", label)
|
||||||
for _, e := range entries {
|
for _, e := range entries {
|
||||||
summary := pageFirstSentence(brainDir, e)
|
summary := pageFirstSentence(bfs, e)
|
||||||
if summary != "" {
|
if summary != "" {
|
||||||
fmt.Fprintf(&sb, "- [[%s|%s]] — %s\n", e.Slug, e.Title, summary)
|
fmt.Fprintf(&sb, "- [[%s|%s]] — %s\n", e.Slug, e.Title, summary)
|
||||||
} else {
|
} else {
|
||||||
@@ -48,9 +54,10 @@ func RebuildIndex(brainDir, date string) error {
|
|||||||
return os.WriteFile(dest, []byte(sb.String()), 0o644)
|
return os.WriteFile(dest, []byte(sb.String()), 0o644)
|
||||||
}
|
}
|
||||||
|
|
||||||
func pageFirstSentence(brainDir string, e Entry) string {
|
// pageFirstSentence reads the page through the brain root, regular files
|
||||||
path := filepath.Join(brainDir, "wiki", string(e.Type), e.Slug+".md")
|
// only (hyperguild#157).
|
||||||
content, err := os.ReadFile(path)
|
func pageFirstSentence(bfs *brainfs.Brain, e Entry) string {
|
||||||
|
content, err := bfs.ReadRegular("wiki/" + string(e.Type) + "/" + e.Slug + ".md")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,36 +3,45 @@ package wiki
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"bufio"
|
"bufio"
|
||||||
|
"bytes"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"io/fs"
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
||||||
)
|
)
|
||||||
|
|
||||||
// LoadInventory walks brain/wiki/ and returns all pages grouped by type.
|
// LoadInventory walks brain/wiki/ and returns all pages grouped by type.
|
||||||
// Missing subdirectories are silently skipped.
|
// Missing subdirectories are silently skipped. Pages are listed and read
|
||||||
|
// through the brain root, regular files only (hyperguild#157); a type
|
||||||
|
// directory that is a symlink is an error.
|
||||||
func LoadInventory(brainDir string) (map[PageType][]Entry, error) {
|
func LoadInventory(brainDir string) (map[PageType][]Entry, error) {
|
||||||
result := map[PageType][]Entry{
|
result := map[PageType][]Entry{
|
||||||
PageTypeConcept: {},
|
PageTypeConcept: {},
|
||||||
PageTypeEntity: {},
|
PageTypeEntity: {},
|
||||||
PageTypeSource: {},
|
PageTypeSource: {},
|
||||||
}
|
}
|
||||||
|
bfs, err := brainfs.Open(brainDir)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("open brain: %w", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = bfs.Close() }()
|
||||||
for pt := range result {
|
for pt := range result {
|
||||||
dir := filepath.Join(brainDir, "wiki", string(pt))
|
dir := "wiki/" + string(pt)
|
||||||
entries, err := os.ReadDir(dir)
|
names, err := bfs.ReadDirRegular(dir)
|
||||||
if os.IsNotExist(err) {
|
if errors.Is(err, fs.ErrNotExist) {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("read dir %s: %w", dir, err)
|
return nil, fmt.Errorf("read dir %s: %w", dir, err)
|
||||||
}
|
}
|
||||||
for _, e := range entries {
|
for _, name := range names {
|
||||||
if e.IsDir() || !strings.HasSuffix(e.Name(), ".md") {
|
if !strings.HasSuffix(name, ".md") {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
slug := strings.TrimSuffix(e.Name(), ".md")
|
slug := strings.TrimSuffix(name, ".md")
|
||||||
path := filepath.Join(dir, e.Name())
|
title, aliases := readFrontmatter(bfs, dir+"/"+name, slug)
|
||||||
title, aliases := readFrontmatter(path, slug)
|
|
||||||
result[pt] = append(result[pt], Entry{Slug: slug, Title: title, Aliases: aliases, Type: pt})
|
result[pt] = append(result[pt], Entry{Slug: slug, Title: title, Aliases: aliases, Type: pt})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -41,15 +50,14 @@ func LoadInventory(brainDir string) (map[PageType][]Entry, error) {
|
|||||||
|
|
||||||
// readFrontmatter extracts title and aliases from YAML frontmatter.
|
// readFrontmatter extracts title and aliases from YAML frontmatter.
|
||||||
// Falls back to slug for title and empty aliases on any error.
|
// Falls back to slug for title and empty aliases on any error.
|
||||||
func readFrontmatter(path, fallbackSlug string) (title string, aliases []string) {
|
func readFrontmatter(bfs *brainfs.Brain, rel, fallbackSlug string) (title string, aliases []string) {
|
||||||
title = fallbackSlug
|
title = fallbackSlug
|
||||||
f, err := os.Open(path)
|
content, err := bfs.ReadRegular(rel)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
defer f.Close() //nolint:errcheck
|
|
||||||
|
|
||||||
scanner := bufio.NewScanner(f)
|
scanner := bufio.NewScanner(bytes.NewReader(content))
|
||||||
inFM := false
|
inFM := false
|
||||||
inAliases := false
|
inAliases := false
|
||||||
for scanner.Scan() {
|
for scanner.Scan() {
|
||||||
|
|||||||
@@ -0,0 +1,79 @@
|
|||||||
|
package wiki
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs"
|
||||||
|
"github.com/mathiasbq/hyperguild/ingestion/internal/brainfs/brainfstest"
|
||||||
|
)
|
||||||
|
|
||||||
|
// hyperguild#157 slice 4: LoadInventory listed wiki/<type>/ with os.ReadDir
|
||||||
|
// and opened each .md by path, so a symlinked page put the target's title and
|
||||||
|
// aliases into the inventory (and the LLM prompts built from it), and a FIFO
|
||||||
|
// hung it. RebuildIndex read first sentences the same way.
|
||||||
|
func TestLoadInventoryRefusesSymlinksAndSurvivesSwapRaces(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
dir := filepath.Join(brain, "wiki", "concepts")
|
||||||
|
require.NoError(t, os.MkdirAll(dir, 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(dir, "ok.md"), []byte("---\ntitle: zqinside\n---\n"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(brainfstest.Outside(t), filepath.Join(dir, "leak.md")))
|
||||||
|
inBrain := brainfstest.WriteSentinelAt(t, filepath.Join(brain, "raw", "s.md"))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "..", "raw", "s.md"), filepath.Join(dir, "inlink.md")))
|
||||||
|
|
||||||
|
inv, err := LoadInventory(brain)
|
||||||
|
require.NoError(t, err)
|
||||||
|
got := fmt.Sprintf("%+v", inv)
|
||||||
|
assert.Contains(t, got, "zqinside", "positive control")
|
||||||
|
assert.NotContains(t, got, brainfstest.Sentinel)
|
||||||
|
assert.NotContains(t, got, "leak", "a symlinked page is not listed")
|
||||||
|
assert.NotContains(t, got, "inlink", "a page linked to another brain file is not listed")
|
||||||
|
|
||||||
|
p := filepath.Join(dir, "r.md")
|
||||||
|
read := func() string {
|
||||||
|
inv, _ := LoadInventory(brain)
|
||||||
|
return fmt.Sprintf("%+v", inv)
|
||||||
|
}
|
||||||
|
brainfstest.AssertNoLeak(t, p, "---\ntitle: zqinside\n---\n", 1500*time.Millisecond, read)
|
||||||
|
brainfstest.AssertNoLeakFrom(t, p, "---\ntitle: zqinside\n---\n", inBrain, 1500*time.Millisecond, read)
|
||||||
|
brainfstest.AssertNoHang(t, p, "---\ntitle: zqinside\n---\n", 1500*time.Millisecond, 6*time.Second, func() { _ = read() })
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadInventoryReturnsErrNotRegularForASymlinkedTypeDir(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(brain, "wiki"), 0o755))
|
||||||
|
require.NoError(t, os.MkdirAll(filepath.Join(brain, "raw"), 0o755))
|
||||||
|
require.NoError(t, os.WriteFile(filepath.Join(brain, "raw", "r.md"), []byte("---\ntitle: zqrawonly\n---\n"), 0o644))
|
||||||
|
require.NoError(t, os.Symlink(filepath.Join("..", "raw"), filepath.Join(brain, "wiki", "concepts")))
|
||||||
|
inv, err := LoadInventory(brain)
|
||||||
|
require.ErrorIs(t, err, brainfs.ErrNotRegular)
|
||||||
|
assert.NotContains(t, fmt.Sprintf("%+v", inv), "zqrawonly")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRebuildIndexDoesNotReadAPageSwappedForASymlink(t *testing.T) {
|
||||||
|
brain := t.TempDir()
|
||||||
|
dir := filepath.Join(brain, "wiki", "concepts")
|
||||||
|
require.NoError(t, os.MkdirAll(dir, 0o755))
|
||||||
|
p := filepath.Join(dir, "r.md")
|
||||||
|
require.NoError(t, os.WriteFile(p, []byte("---\ntitle: R\n---\nzqinside sentence.\n"), 0o644))
|
||||||
|
require.NoError(t, RebuildIndex(brain, "2026-10-04"))
|
||||||
|
idx, err := os.ReadFile(filepath.Join(brain, "wiki", "index.md"))
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Contains(t, string(idx), "zqinside", "positive control: the summary is read")
|
||||||
|
|
||||||
|
read := func() string {
|
||||||
|
_ = RebuildIndex(brain, "2026-10-04")
|
||||||
|
b, _ := os.ReadFile(filepath.Join(brain, "wiki", "index.md"))
|
||||||
|
return string(b)
|
||||||
|
}
|
||||||
|
brainfstest.AssertNoLeak(t, p, "---\ntitle: R\n---\nzqinside sentence.\n", 1500*time.Millisecond, read)
|
||||||
|
inBrain := brainfstest.WriteSentinelAt(t, filepath.Join(brain, "raw", "s.md"))
|
||||||
|
brainfstest.AssertNoLeakFrom(t, p, "---\ntitle: R\n---\nzqinside sentence.\n", inBrain, 1500*time.Millisecond, read)
|
||||||
|
brainfstest.AssertNoHang(t, p, "---\ntitle: R\n---\nzqinside sentence.\n", 1500*time.Millisecond, 6*time.Second, func() { _ = read() })
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user