feat(brain): structured wing/hall taxonomy + obsidian-compatible layout
Adds a two-dimensional address (wing, hall) to brain notes. A wing is a
topic domain (e.g. jepa-fx, hyperguild); a hall is one of a closed
vocabulary of memory types (facts, decisions, failures, hypotheses,
sources). Notes route to brain/wiki/<wing>/<hall>/<slug>.md with
wing/hall/created_at YAML frontmatter, making the directory a valid
Obsidian vault.
Changes:
- new package ingestion/internal/brain (NotePath, ValidHalls, Sanitise,
BuildWingIndex, BuildAllWingIndexes)
- api.WriteNote refactored to WriteNoteOptions; wing+hall routes to
brain/wiki/, otherwise falls back to brain/knowledge/ (legacy)
- search.Query → QueryOptions with optional Wing/Hall filtering; Result
carries wing/hall extracted from frontmatter or path segments
- MCP tools brain_write and brain_query gain optional wing/hall params
(hall enum-validated); new brain_index tool regenerates _index.md MOC
- POST /index REST endpoint mirrors brain_index
- brain_write auto-rebuilds the wing's _index.md after a wing+hall write
- scripts/migrate-brain-halls.sh migrates flat brain/wiki/{concepts,entities}/
into the new layout (dry-run by default, --commit applies)
All existing tests pass; new tests cover wing/hall write routing, scope
filtering, invalid hall rejection, _index.md generation, and migration
script paths.
Closes hyperguild#1.
This commit is contained in:
161
ingestion/internal/brain/index.go
Normal file
161
ingestion/internal/brain/index.go
Normal file
@@ -0,0 +1,161 @@
|
||||
package brain
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"sort"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
// noteEntry is one row in a Wing _index.md.
|
||||
type noteEntry struct {
|
||||
Hall string
|
||||
Slug string
|
||||
Title string
|
||||
Created string
|
||||
}
|
||||
|
||||
// BuildWingIndex regenerates brain/wiki/<wing>/_index.md as a Map of
|
||||
// Content listing every note in that wing with its Hall and creation
|
||||
// date. Returns nil if the wing directory does not exist.
|
||||
func BuildWingIndex(brainDir, wing string) error {
|
||||
w := Sanitise(wing)
|
||||
if w == "" {
|
||||
return fmt.Errorf("invalid wing %q", wing)
|
||||
}
|
||||
wingDir := filepath.Join(brainDir, "wiki", w)
|
||||
if _, err := os.Stat(wingDir); os.IsNotExist(err) {
|
||||
return nil
|
||||
} else if err != nil {
|
||||
return fmt.Errorf("stat wing: %w", err)
|
||||
}
|
||||
|
||||
entries, err := collectWingEntries(wingDir)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
sort.Slice(entries, func(i, j int) bool {
|
||||
if entries[i].Hall != entries[j].Hall {
|
||||
return entries[i].Hall < entries[j].Hall
|
||||
}
|
||||
return entries[i].Slug < entries[j].Slug
|
||||
})
|
||||
|
||||
var b strings.Builder
|
||||
fmt.Fprintf(&b, "# %s\n\n", w)
|
||||
b.WriteString("| Hall | Note | Created |\n")
|
||||
b.WriteString("|------|------|---------|\n")
|
||||
for _, e := range entries {
|
||||
fmt.Fprintf(&b, "| %s | [%s](%s/%s.md) | %s |\n", e.Hall, e.Title, e.Hall, e.Slug, e.Created)
|
||||
}
|
||||
|
||||
dest := filepath.Join(wingDir, "_index.md")
|
||||
return os.WriteFile(dest, []byte(b.String()), 0o644)
|
||||
}
|
||||
|
||||
// BuildAllWingIndexes regenerates _index.md for every wing under brain/wiki/.
|
||||
func BuildAllWingIndexes(brainDir string) error {
|
||||
wikiDir := filepath.Join(brainDir, "wiki")
|
||||
ents, err := os.ReadDir(wikiDir)
|
||||
if os.IsNotExist(err) {
|
||||
return nil
|
||||
}
|
||||
if err != nil {
|
||||
return fmt.Errorf("read wiki: %w", err)
|
||||
}
|
||||
for _, e := range ents {
|
||||
if !e.IsDir() {
|
||||
continue
|
||||
}
|
||||
if err := BuildWingIndex(brainDir, e.Name()); err != nil {
|
||||
return fmt.Errorf("index %s: %w", e.Name(), err)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func collectWingEntries(wingDir string) ([]noteEntry, error) {
|
||||
var out []noteEntry
|
||||
ents, err := os.ReadDir(wingDir)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("read wing: %w", err)
|
||||
}
|
||||
for _, hallEnt := range ents {
|
||||
if !hallEnt.IsDir() {
|
||||
continue
|
||||
}
|
||||
hall := hallEnt.Name()
|
||||
if !IsValidHall(hall) {
|
||||
continue
|
||||
}
|
||||
hallDir := filepath.Join(wingDir, hall)
|
||||
notes, err := os.ReadDir(hallDir)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("read hall %s: %w", hall, err)
|
||||
}
|
||||
for _, n := range notes {
|
||||
if n.IsDir() || !strings.HasSuffix(n.Name(), ".md") || n.Name() == "_index.md" {
|
||||
continue
|
||||
}
|
||||
slug := strings.TrimSuffix(n.Name(), ".md")
|
||||
full := filepath.Join(hallDir, n.Name())
|
||||
title, created := readTitleAndCreated(full, slug)
|
||||
out = append(out, noteEntry{Hall: hall, Slug: slug, Title: title, Created: created})
|
||||
}
|
||||
}
|
||||
return out, nil
|
||||
}
|
||||
|
||||
// readTitleAndCreated reads YAML frontmatter for title + created_at; falls
|
||||
// back to slug and file mtime when absent.
|
||||
func readTitleAndCreated(path, slug string) (string, string) {
|
||||
f, err := os.Open(path)
|
||||
if err != nil {
|
||||
return slug, ""
|
||||
}
|
||||
defer func() { _ = f.Close() }()
|
||||
|
||||
title, created := "", ""
|
||||
scanner := bufio.NewScanner(f)
|
||||
inFrontmatter := false
|
||||
for scanner.Scan() {
|
||||
line := scanner.Text()
|
||||
if strings.TrimSpace(line) == "---" {
|
||||
if !inFrontmatter {
|
||||
inFrontmatter = true
|
||||
continue
|
||||
}
|
||||
break
|
||||
}
|
||||
if !inFrontmatter {
|
||||
continue
|
||||
}
|
||||
key, val, ok := strings.Cut(line, ":")
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
v := strings.Trim(strings.TrimSpace(val), `"'`)
|
||||
switch strings.TrimSpace(key) {
|
||||
case "title":
|
||||
title = v
|
||||
case "created_at":
|
||||
if t, err := time.Parse(time.RFC3339, v); err == nil {
|
||||
created = t.UTC().Format("2006-01-02")
|
||||
} else {
|
||||
created = v
|
||||
}
|
||||
}
|
||||
}
|
||||
if title == "" {
|
||||
title = slug
|
||||
}
|
||||
if created == "" {
|
||||
if info, err := os.Stat(path); err == nil {
|
||||
created = info.ModTime().UTC().Format("2006-01-02")
|
||||
}
|
||||
}
|
||||
return title, created
|
||||
}
|
||||
85
ingestion/internal/brain/index_test.go
Normal file
85
ingestion/internal/brain/index_test.go
Normal file
@@ -0,0 +1,85 @@
|
||||
package brain_test
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/mathiasbq/hyperguild/ingestion/internal/brain"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestBuildWingIndex(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
for _, p := range []struct{ rel, body string }{
|
||||
{"wiki/jepa-fx/decisions/val-vol.md", "---\ntitle: Val Vol R2\ncreated_at: 2026-05-06T10:00:00Z\n---\nbody\n"},
|
||||
{"wiki/jepa-fx/facts/architecture.md", "---\ntitle: Architecture\ncreated_at: 2026-05-04T10:00:00Z\n---\nbody\n"},
|
||||
{"wiki/jepa-fx/sources/paper.md", "---\n---\nbody\n"},
|
||||
} {
|
||||
full := filepath.Join(dir, p.rel)
|
||||
require.NoError(t, os.MkdirAll(filepath.Dir(full), 0o755))
|
||||
require.NoError(t, os.WriteFile(full, []byte(p.body), 0o644))
|
||||
}
|
||||
|
||||
require.NoError(t, brain.BuildWingIndex(dir, "jepa-fx"))
|
||||
|
||||
got, err := os.ReadFile(filepath.Join(dir, "wiki", "jepa-fx", "_index.md"))
|
||||
require.NoError(t, err)
|
||||
s := string(got)
|
||||
assert.Contains(t, s, "# jepa-fx")
|
||||
assert.Contains(t, s, "| Hall | Note | Created |")
|
||||
assert.Contains(t, s, "| decisions | [Val Vol R2](decisions/val-vol.md) | 2026-05-06 |")
|
||||
assert.Contains(t, s, "| facts | [Architecture](facts/architecture.md) | 2026-05-04 |")
|
||||
assert.Contains(t, s, "| sources | [paper](sources/paper.md) |")
|
||||
// Halls sorted alphabetically.
|
||||
assert.Less(t, indexOf(s, "decisions"), indexOf(s, "facts"))
|
||||
assert.Less(t, indexOf(s, "facts"), indexOf(s, "sources"))
|
||||
}
|
||||
|
||||
func TestBuildWingIndex_SkipsInvalidHalls(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
wingDir := filepath.Join(dir, "wiki", "jepa-fx")
|
||||
require.NoError(t, os.MkdirAll(filepath.Join(wingDir, "garbage"), 0o755))
|
||||
require.NoError(t, os.WriteFile(filepath.Join(wingDir, "garbage", "x.md"), []byte("x"), 0o644))
|
||||
require.NoError(t, os.MkdirAll(filepath.Join(wingDir, "facts"), 0o755))
|
||||
require.NoError(t, os.WriteFile(filepath.Join(wingDir, "facts", "y.md"), []byte("y"), 0o644))
|
||||
|
||||
require.NoError(t, brain.BuildWingIndex(dir, "jepa-fx"))
|
||||
got, err := os.ReadFile(filepath.Join(wingDir, "_index.md"))
|
||||
require.NoError(t, err)
|
||||
s := string(got)
|
||||
assert.Contains(t, s, "facts")
|
||||
assert.NotContains(t, s, "garbage")
|
||||
}
|
||||
|
||||
func TestBuildAllWingIndexes(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
for _, p := range []struct{ rel, body string }{
|
||||
{"wiki/a/facts/x.md", "x"},
|
||||
{"wiki/b/facts/y.md", "y"},
|
||||
} {
|
||||
full := filepath.Join(dir, p.rel)
|
||||
require.NoError(t, os.MkdirAll(filepath.Dir(full), 0o755))
|
||||
require.NoError(t, os.WriteFile(full, []byte(p.body), 0o644))
|
||||
}
|
||||
require.NoError(t, brain.BuildAllWingIndexes(dir))
|
||||
_, err := os.Stat(filepath.Join(dir, "wiki", "a", "_index.md"))
|
||||
require.NoError(t, err)
|
||||
_, err = os.Stat(filepath.Join(dir, "wiki", "b", "_index.md"))
|
||||
require.NoError(t, err)
|
||||
}
|
||||
|
||||
func TestBuildWingIndex_NoWingDir(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
require.NoError(t, brain.BuildWingIndex(dir, "ghost"))
|
||||
}
|
||||
|
||||
func indexOf(s, sub string) int {
|
||||
for i := 0; i+len(sub) <= len(s); i++ {
|
||||
if s[i:i+len(sub)] == sub {
|
||||
return i
|
||||
}
|
||||
}
|
||||
return -1
|
||||
}
|
||||
70
ingestion/internal/brain/path.go
Normal file
70
ingestion/internal/brain/path.go
Normal file
@@ -0,0 +1,70 @@
|
||||
// Package brain provides the wing/hall path taxonomy used by the brain
|
||||
// wiki layout. A note's canonical location is
|
||||
// brain/wiki/<wing>/<hall>/<slug>.md, where Wing is a free-form topic
|
||||
// domain and Hall is one of a closed vocabulary of memory types.
|
||||
package brain
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// ValidHalls is the closed vocabulary of hall names. A hall captures the
|
||||
// memory type of a note within any wing.
|
||||
var ValidHalls = map[string]bool{
|
||||
"facts": true,
|
||||
"decisions": true,
|
||||
"failures": true,
|
||||
"hypotheses": true,
|
||||
"sources": true,
|
||||
}
|
||||
|
||||
// IsValidHall reports whether h is in the closed Hall vocabulary.
|
||||
func IsValidHall(h string) bool {
|
||||
return ValidHalls[h]
|
||||
}
|
||||
|
||||
// NotePath resolves the canonical filesystem path for a note given a
|
||||
// wing, hall, and slug. Returns an error if hall is not in ValidHalls
|
||||
// or if wing/slug sanitise to empty strings.
|
||||
//
|
||||
// The returned path is brain/wiki/<wing>/<hall>/<slug>.md with all
|
||||
// segments sanitised: lowercased, alphanumerics and hyphens only.
|
||||
func NotePath(brainDir, wing, hall, slug string) (string, error) {
|
||||
if !IsValidHall(hall) {
|
||||
return "", fmt.Errorf("invalid hall %q: must be one of facts/decisions/failures/hypotheses/sources", hall)
|
||||
}
|
||||
w := Sanitise(wing)
|
||||
if w == "" {
|
||||
return "", fmt.Errorf("invalid wing %q: must contain at least one alphanumeric character", wing)
|
||||
}
|
||||
s := Sanitise(strings.TrimSuffix(slug, ".md"))
|
||||
if s == "" {
|
||||
return "", fmt.Errorf("invalid slug %q: must contain at least one alphanumeric character", slug)
|
||||
}
|
||||
return filepath.Join(brainDir, "wiki", w, hall, s+".md"), nil
|
||||
}
|
||||
|
||||
// Sanitise lowercases s and keeps only [a-z0-9-], collapsing any other
|
||||
// character (including path separators) to a hyphen. Leading/trailing
|
||||
// hyphens and runs of hyphens are collapsed.
|
||||
func Sanitise(s string) string {
|
||||
s = strings.ToLower(strings.TrimSpace(s))
|
||||
var b strings.Builder
|
||||
prevHyphen := true
|
||||
for _, r := range s {
|
||||
switch {
|
||||
case r >= 'a' && r <= 'z', r >= '0' && r <= '9':
|
||||
b.WriteRune(r)
|
||||
prevHyphen = false
|
||||
case r == '-' || r == '_' || r == ' ' || r == '/' || r == '\\' || r == '.':
|
||||
if !prevHyphen {
|
||||
b.WriteByte('-')
|
||||
prevHyphen = true
|
||||
}
|
||||
}
|
||||
}
|
||||
out := b.String()
|
||||
return strings.Trim(out, "-")
|
||||
}
|
||||
73
ingestion/internal/brain/path_test.go
Normal file
73
ingestion/internal/brain/path_test.go
Normal file
@@ -0,0 +1,73 @@
|
||||
package brain_test
|
||||
|
||||
import (
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/mathiasbq/hyperguild/ingestion/internal/brain"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestNotePath_Valid(t *testing.T) {
|
||||
got, err := brain.NotePath("/b", "jepa-fx", "decisions", "val-vol-r2")
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, filepath.Join("/b", "wiki", "jepa-fx", "decisions", "val-vol-r2.md"), got)
|
||||
}
|
||||
|
||||
func TestNotePath_StripsMdSuffix(t *testing.T) {
|
||||
got, err := brain.NotePath("/b", "x", "facts", "note.md")
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, filepath.Join("/b", "wiki", "x", "facts", "note.md"), got)
|
||||
}
|
||||
|
||||
func TestNotePath_SanitisesWingAndSlug(t *testing.T) {
|
||||
got, err := brain.NotePath("/b", "Jepa FX!", "facts", "Val Vol R2")
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, filepath.Join("/b", "wiki", "jepa-fx", "facts", "val-vol-r2.md"), got)
|
||||
}
|
||||
|
||||
func TestNotePath_RejectsInvalidHall(t *testing.T) {
|
||||
_, err := brain.NotePath("/b", "x", "garbage", "y")
|
||||
require.Error(t, err)
|
||||
assert.Contains(t, err.Error(), "invalid hall")
|
||||
}
|
||||
|
||||
func TestNotePath_RejectsEmptyWing(t *testing.T) {
|
||||
_, err := brain.NotePath("/b", "!!!", "facts", "y")
|
||||
require.Error(t, err)
|
||||
assert.Contains(t, err.Error(), "invalid wing")
|
||||
}
|
||||
|
||||
func TestNotePath_RejectsEmptySlug(t *testing.T) {
|
||||
_, err := brain.NotePath("/b", "x", "facts", "!!!")
|
||||
require.Error(t, err)
|
||||
assert.Contains(t, err.Error(), "invalid slug")
|
||||
}
|
||||
|
||||
func TestSanitise(t *testing.T) {
|
||||
cases := map[string]string{
|
||||
"Jepa-FX": "jepa-fx",
|
||||
" foo bar ": "foo-bar",
|
||||
"Val/Vol\\R2.md": "val-vol-r2-md",
|
||||
"!!!": "",
|
||||
"___leading": "leading",
|
||||
"trailing___": "trailing",
|
||||
"multi---hyphen": "multi-hyphen",
|
||||
"UPPER 123 mixed": "upper-123-mixed",
|
||||
}
|
||||
for in, want := range cases {
|
||||
t.Run(in, func(t *testing.T) {
|
||||
assert.Equal(t, want, brain.Sanitise(in))
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestIsValidHall(t *testing.T) {
|
||||
for _, h := range []string{"facts", "decisions", "failures", "hypotheses", "sources"} {
|
||||
assert.True(t, brain.IsValidHall(h), h)
|
||||
}
|
||||
for _, h := range []string{"", "Facts", "facts ", "rooms", "concepts", "entities"} {
|
||||
assert.False(t, brain.IsValidHall(h), h)
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user