X-Git-Url: http://git.giacomolli.uk/onechat/blobdiff_plain/e754189bc2aa32ec43a5dc4ee01d7a6c6e4e388c..eeb821ff17ad79c87ca9b64cd9be26f8612f4a03:/memory.go?ds=sidebyside

diff --git a/memory.go b/memory.go
index 9c8073f..0fd7d83 100644
--- a/memory.go
+++ b/memory.go
@@ -12,24 +12,72 @@ import (
 	"time"
 )
 
-// errNoView tells that a chat has messages but no saved view.
-var errNoView = errors.New("the chat has messages but no saved view")
+var (
+	// errMemoryNoView tells that a chat has messages but no saved view.
+	errMemoryNoView = errors.New("the chat has messages but no saved view")
+
+	// errMemoryUnsettled tells that a line of the view stays pending,
+	// because its build failed.
+	errMemoryUnsettled = errors.New("a summary of the view failed, and it is tried again at the next message")
+)
+
+// openMemory opens the chat in root and starts the builds that are ready. The
+// clock gives the dates of new messages and the days of new nodes. The builds
+// stop when ctx ends or at Close.
+func openMemory(ctx context.Context, root string, clock func() time.Time, summarizer Summarizer) (*Memory, error) {
+	log, err := openLog(ctx, root, clock)
+	if err != nil {
+		return nil, err
+	}
+
+	m := &Memory{
+		root:       root,
+		log:        log,
+		queue:      newBuildQueue(),
+		summarizer: summarizer,
+		changed:    make(chan struct{}),
+	}
+
+	m.ctx, m.cancel = context.WithCancel(ctx)
+
+	m.syncer, err = openSyncer(root)
+	if err != nil {
+		return nil, errors.Join(err, m.Close())
+	}
+
+	m.tree, err = openTree(ctx, root, log.Len(), clock)
+	if err != nil {
+		return nil, errors.Join(err, m.Close())
+	}
+
+	err = m.load()
+	if err != nil {
+		return nil, errors.Join(fmt.Errorf("load view: %w", err), m.Close())
+	}
+
+	err = m.restoreQueue()
+	if err != nil {
+		return nil, errors.Join(fmt.Errorf("restore build queue: %w", err), m.Close())
+	}
+
+	err = m.catchUp()
+	if err != nil {
+		return nil, errors.Join(err, m.Close())
+	}
+
+	m.mutex.Lock()
+	m.syncer.Written()
+	m.dispatch()
+	m.mutex.Unlock()
+
+	return m, nil
+}
 
 // Summarizer builds the text of one node with a model.
 type Summarizer interface {
 	Summarize(ctx context.Context, task Task) (string, error)
 }
 
-// Task is the build of the node (Level, Index). Context is the compaction view
-// for the build. Input holds the source "kind: text" of a leaf, or the two
-// child lines of a merge with their newlines as spaces.
-type Task struct {
-	Level   int
-	Index   int
-	Context string
-	Input   []string
-}
-
 // Memory is the memory of one chat: the message log, the summary tree, the chat
 // view, the compaction view, and the queue of the builds. The compaction view
 // is the chat view merged further, at the limits of 16 to 32 KB. It takes the
@@ -39,17 +87,24 @@ type Task struct {
 // start. It never builds the views again from the log, because a new view
 // differs from the live one and so loses the prompt cache.
 //
+// Each write goes to the operating system at once, and a syncer makes the
+// writes durable by group commit in the background. Flush waits until the
+// writes so far are durable.
+//
 // The summarizer builds the nodes in the queue in the background. The start
-// reads the log and the tree once to fill the queue again. After that, only a
-// new message or a new node adds work.
+// reads the indexes once to fill the queue again. After that, only a new
+// message or a new node adds work. Memory keeps the nodes of the views and the
+// tasks of the running builds. It reads all other messages and nodes from their
+// day files through the indexes.
 type Memory struct {
 	mutex      sync.Mutex
 	root       string
 	log        *Log
+	syncer     *Syncer
 	tree       *Tree
 	chat       *View
 	cview      *View
-	queue      *queue
+	queue      *BuildQueue
 	summarizer Summarizer
 	ctx        context.Context
 	cancel     context.CancelFunc
@@ -57,88 +112,191 @@ type Memory struct {
 	changed    chan struct{}
 }
 
-// viewFile is the content of view.json.
-type viewFile struct {
-	Chat       viewState `json:"chat"`
-	Compaction viewState `json:"compaction"`
-}
+// Close stops the builds, waits for them, makes the writes durable, closes the
+// files of the chat, and releases its lock.
+func (m *Memory) Close() error {
+	m.cancel()
+	m.workers.Wait()
 
-// openMemory opens the chat in root and starts the builds that are ready. The
-// clock gives the dates of new messages and the days of new nodes. The builds
-// stop when ctx ends or at Close.
-func openMemory(ctx context.Context, root string, clock func() time.Time, summarizer Summarizer) (*Memory, error) {
-	log, err := openLog(ctx, root, clock)
-	if err != nil {
-		return nil, err
+	m.mutex.Lock()
+	defer m.mutex.Unlock()
+
+	var err error
+	if m.syncer != nil {
+		err = m.syncer.Close()
 	}
 
-	m := &Memory{
-		root:       root,
-		log:        log,
-		queue:      newQueue(),
-		summarizer: summarizer,
-		changed:    make(chan struct{}),
+	if m.tree != nil {
+		err = errors.Join(err, m.tree.Close())
 	}
 
-	m.ctx, m.cancel = context.WithCancel(ctx)
+	return errors.Join(err, m.log.Close())
+}
 
-	m.tree, err = openTree(ctx, root, log.Len(), clock)
+// Append logs a new message, adds it to the tree and the views, and starts the
+// builds that are ready, also the failed ones.
+func (m *Memory) Append(kind, text string) (Message, error) {
+	m.mutex.Lock()
+	defer m.mutex.Unlock()
+
+	message, err := m.log.Append(kind, text)
 	if err != nil {
-		return nil, errors.Join(err, m.Close())
+		return Message{}, err
 	}
 
-	err = m.load()
+	defer m.syncer.Written()
+
+	err = m.addMessage(message)
 	if err != nil {
-		return nil, errors.Join(fmt.Errorf("load view: %w", err), m.Close())
+		return Message{}, err
 	}
 
-	err = m.restoreQueue()
+	err = m.save()
 	if err != nil {
-		return nil, errors.Join(fmt.Errorf("restore build queue: %w", err), m.Close())
+		return Message{}, err
 	}
 
-	err = m.catchUp()
-	if err != nil {
-		return nil, errors.Join(err, m.Close())
+	m.queue.Retry()
+	m.dispatch()
+
+	return message, nil
+}
+
+// children reads the two children of the node key.
+func (m *Memory) children(key NodeKey) (Node, Node, error) {
+	var children [2]Node
+	for n := range children {
+		child, built, err := m.tree.Node(key.level-1, 2*key.index+n)
+		if err != nil {
+			return Node{}, Node{}, err
+		}
+
+		if !built {
+			return Node{}, Node{}, fmt.Errorf("node (%d, %d) is not built", key.level-1, 2*key.index+n)
+		}
+
+		children[n] = child
+	}
+
+	return children[0], children[1], nil
+}
+
+// Wait returns when no build runs. The failed builds wait for the next message.
+func (m *Memory) Wait(ctx context.Context) error {
+	for {
+		m.mutex.Lock()
+		running := m.queue.Running()
+		changed := m.changed
+		m.mutex.Unlock()
+
+		if running == 0 {
+			return nil
+		}
+
+		select {
+		case <-changed:
+		case <-ctx.Done():
+			return ctx.Err()
+		}
 	}
+}
+
+// Settle returns when the chat view has no pending line, so that every message
+// so far is summarized. A pending line with no build that runs belongs to a
+// failed build, which waits for the next message, so Settle returns
+// errMemoryUnsettled in place of a wait that never ends.
+func (m *Memory) Settle(ctx context.Context) error {
+	for {
+		m.mutex.Lock()
+		pending := m.chat.Pending()
+		running := m.queue.Running()
+		changed := m.changed
+		m.mutex.Unlock()
+
+		if !pending {
+			return nil
+		}
+
+		if running == 0 {
+			return errMemoryUnsettled
+		}
+
+		select {
+		case <-changed:
+		case <-ctx.Done():
+			return ctx.Err()
+		}
+	}
+}
+
+// Flush returns when every write before the call is durable.
+func (m *Memory) Flush(ctx context.Context) error {
+	return m.syncer.Flush(ctx)
+}
 
+// ViewLines returns the lines of the chat view, each with its newline, without
+// the leaf lines of the messages in skip.
+func (m *Memory) ViewLines(skip map[int]bool) []string {
 	m.mutex.Lock()
-	m.dispatch()
-	m.mutex.Unlock()
+	defer m.mutex.Unlock()
 
-	return m, nil
+	return m.chat.LinesWithout(skip)
+}
+
+// Len returns the number of messages in the log.
+func (m *Memory) Len() int {
+	m.mutex.Lock()
+	defer m.mutex.Unlock()
+
+	return m.log.Len()
+}
+
+// Message reads the message with the given ID.
+func (m *Memory) Message(id int) (Message, error) {
+	m.mutex.Lock()
+	defer m.mutex.Unlock()
+
+	return m.log.Message(id)
+}
+
+// Node reads the node (l, i) if it is built.
+func (m *Memory) Node(level, index int) (Node, bool, error) {
+	m.mutex.Lock()
+	defer m.mutex.Unlock()
+
+	return m.tree.Node(level, index)
 }
 
 // load reads the saved views.
 func (m *Memory) load() error {
 	data, err := os.ReadFile(m.viewPath())
 	if errors.Is(err, os.ErrNotExist) && m.log.Len() == 0 {
-		m.chat = newView(chatHigh, chatLow)
-		m.cview = newView(compactionHigh, compactionLow)
+		m.chat = newView(viewChatHigh, viewChatLow)
+		m.cview = newView(viewCompactionHigh, viewCompactionLow)
 
 		return nil
 	}
 
 	if errors.Is(err, os.ErrNotExist) {
-		return errNoView
+		return errMemoryNoView
 	}
 
 	if err != nil {
 		return fmt.Errorf("read view: %w", err)
 	}
 
-	var file viewFile
+	var file MemoryViewFile
 	err = json.Unmarshal(data, &file)
 	if err != nil {
 		return fmt.Errorf("decode view: %w", err)
 	}
 
-	m.chat, err = restoreView(file.Chat, chatHigh, chatLow, m.tree)
+	m.chat, err = restoreView(file.Chat, viewChatHigh, viewChatLow, m.tree)
 	if err != nil {
 		return fmt.Errorf("chat view: %w", err)
 	}
 
-	m.cview, err = restoreView(file.Compaction, compactionHigh, compactionLow, m.tree)
+	m.cview, err = restoreView(file.Compaction, viewCompactionHigh, viewCompactionLow, m.tree)
 	if err != nil {
 		return fmt.Errorf("compaction view: %w", err)
 	}
@@ -158,28 +316,43 @@ func (m *Memory) load() error {
 // builds each node that needs no model call and that a crash left out.
 func (m *Memory) restoreQueue() error {
 	for id := range m.chat.end {
-		if m.tree.Built(0, id) {
+		built, err := m.tree.Built(0, id)
+		if err != nil {
+			return err
+		}
+
+		if built {
 			continue
 		}
 
-		leaf, free := freeLeaf(m.log.Message(id))
+		message, err := m.log.Message(id)
+		if err != nil {
+			return err
+		}
+
+		leaf, free := freeLeaf(message)
 		if !free {
 			m.queue.AddLeaf(id)
 			continue
 		}
 
-		err := m.build(leaf)
+		err = m.build(leaf)
 		if err != nil {
 			return err
 		}
 	}
 
-	for _, node := range m.tree.Nodes() {
-		if node.Index%2 != 0 {
+	keys, err := m.tree.Keys()
+	if err != nil {
+		return err
+	}
+
+	for _, key := range keys {
+		if key.index%2 != 0 {
 			continue
 		}
 
-		err := m.settle(node)
+		err = m.settle(key)
 		if err != nil {
 			return err
 		}
@@ -196,7 +369,12 @@ func (m *Memory) catchUp() error {
 	}
 
 	for m.chat.end < m.log.Len() {
-		err := m.addMessage(m.log.Message(m.chat.end))
+		message, err := m.log.Message(m.chat.end)
+		if err != nil {
+			return err
+		}
+
+		err = m.addMessage(message)
 		if err != nil {
 			return err
 		}
@@ -205,128 +383,135 @@ func (m *Memory) catchUp() error {
 	return m.save()
 }
 
-// Close stops the builds, waits for them, closes the files of the chat, and
-// releases its lock.
-func (m *Memory) Close() error {
-	m.cancel()
-	m.workers.Wait()
+// dispatch starts the builds that are ready, up to the limit. A build whose
+// input cannot be read fails and waits for the next message.
+func (m *Memory) dispatch() {
+	for m.ctx.Err() == nil {
+		key, ready := m.queue.Next()
+		if !ready {
+			return
+		}
 
-	m.mutex.Lock()
-	defer m.mutex.Unlock()
+		task, err := m.task(key)
+		if err != nil {
+			m.queue.Fail(key)
+			continue
+		}
 
-	var err error
-	if m.tree != nil {
-		err = m.tree.Close()
+		m.workers.Add(1)
+		go m.run(key, task)
 	}
-
-	return errors.Join(err, m.log.Close())
 }
 
-// Append logs a new message, adds it to the tree and the views, and starts the
-// builds that are ready, also the failed ones.
-func (m *Memory) Append(kind, text string) (Message, error) {
-	m.mutex.Lock()
-	defer m.mutex.Unlock()
-
-	message, err := m.log.Append(kind, text)
+// addMessage builds the leaf of message when it needs no model call, or else
+// adds the leaf to the queue. Then it appends the leaf to the views. A crash can
+// stop an append after the leaf build and before the view save, so a leaf that
+// is built already stays as it is, and restoreQueue settles its parent.
+func (m *Memory) addMessage(message Message) error {
+	built, err := m.tree.Built(0, message.ID)
 	if err != nil {
-		return Message{}, err
+		return err
 	}
 
-	err = m.addMessage(message)
-	if err != nil {
-		return Message{}, err
+	leaf, free := freeLeaf(message)
+	switch {
+	case built:
+	case free:
+		err = m.build(leaf)
+		if err != nil {
+			return err
+		}
+	default:
+		m.queue.AddLeaf(message.ID)
 	}
 
-	err = m.save()
+	merged, err := m.chat.Append(m.tree)
 	if err != nil {
-		return Message{}, err
+		return fmt.Errorf("append to chat view: %w", err)
 	}
 
-	m.queue.Retry()
-	m.dispatch()
+	_, err = m.cview.Append(m.tree)
+	if err == nil && merged {
+		err = m.cview.Coarsen(m.chat, m.tree)
+	}
 
-	return message, nil
+	if err != nil {
+		return fmt.Errorf("append to compaction view: %w", err)
+	}
+
+	return nil
 }
 
-// addMessage builds the leaf of message when it needs no model call, or else
-// adds the leaf to the queue. Then it appends the leaf to the views.
-func (m *Memory) addMessage(message Message) error {
-	leaf, free := freeLeaf(message)
-	if free {
-		err := m.build(leaf)
-		if err != nil {
-			return err
-		}
-	} else {
-		m.queue.AddLeaf(message.ID)
+// save writes the views to view.json.
+func (m *Memory) save() error {
+	data, err := json.Marshal(MemoryViewFile{
+		Chat:       m.chat.State(),
+		Compaction: m.cview.State(),
+	})
+	if err != nil {
+		return fmt.Errorf("encode view: %w", err)
 	}
 
-	merged := m.chat.Append(m.tree)
-	m.cview.Append(m.tree)
-	if merged {
-		m.cview.Coarsen(m.chat, m.tree)
+	err = writeFileAtomic(m.viewPath(), append(data, '\n'))
+	if err != nil {
+		return fmt.Errorf("save view: %w", err)
 	}
 
 	return nil
 }
 
-// build adds node to the tree and settles its parent.
+func (m *Memory) viewPath() string {
+	return filepath.Join(m.root, "view.json")
+}
+
+// build adds node to the tree, keeps it in the views when it is a pending line,
+// and settles its parent.
 func (m *Memory) build(node Node) error {
 	err := m.tree.Add(node)
 	if err != nil {
 		return err
 	}
 
-	return m.settle(node)
+	m.chat.Refresh(node)
+	m.cview.Refresh(node)
+
+	return m.settle(NodeKey{node.Level, node.Index})
 }
 
-// settle looks at the parent of node when both children are built. It builds
-// each parent that needs no model call, up the tree, and adds the first other
-// parent to the queue.
-func (m *Memory) settle(node Node) error {
+// settle looks at the parent of the built node key when both children are
+// built. It builds each parent that needs no model call, up the tree, and adds
+// the first other parent to the queue.
+func (m *Memory) settle(key NodeKey) error {
 	for {
-		sibling, built := m.tree.Node(node.Level, node.Index^1)
-		if !built || m.tree.Built(node.Level+1, node.Index/2) {
-			return nil
+		parent := NodeKey{key.level + 1, key.index / 2}
+		ready, err := m.ready(parent)
+		if err != nil || !ready {
+			return err
 		}
 
-		left, right := node, sibling
-		if node.Index%2 != 0 {
-			left, right = sibling, node
+		left, right, err := m.children(parent)
+		if err != nil {
+			return err
 		}
 
-		parent, free := freeMerge(left, right)
+		node, free := freeMerge(left, right)
 		if !free {
-			m.queue.AddMerge(nodeKey{node.Level + 1, node.Index / 2})
+			m.queue.AddMerge(parent)
 			return nil
 		}
 
-		err := m.tree.Add(parent)
+		err = m.tree.Add(node)
 		if err != nil {
 			return err
 		}
 
-		node = parent
+		key = parent
 	}
 }
 
-// dispatch starts the builds that are ready, up to the limit.
-func (m *Memory) dispatch() {
-	for m.ctx.Err() == nil {
-		key, ready := m.queue.Next()
-		if !ready {
-			return
-		}
-
-		task := m.task(key)
-		m.workers.Add(1)
-		go m.run(key, task)
-	}
-}
-
-// task returns the build task of the node key.
-func (m *Memory) task(key nodeKey) Task {
+// task returns the build task of the node key, with its input read from the log
+// or the tree.
+func (m *Memory) task(key NodeKey) (Task, error) {
 	task := Task{
 		Level:   key.level,
 		Index:   key.index,
@@ -334,21 +519,31 @@ func (m *Memory) task(key nodeKey) Task {
 	}
 
 	if key.level == 0 {
-		task.Input = []string{leafSource(m.log.Message(key.index))}
-		return task
+		message, err := m.log.Message(key.index)
+		if err != nil {
+			return Task{}, err
+		}
+
+		task.Input = []string{leafSource(message)}
+
+		return task, nil
 	}
 
-	for _, index := range []int{2 * key.index, 2*key.index + 1} {
-		child, _ := m.tree.Node(key.level-1, index)
+	left, right, err := m.children(key)
+	if err != nil {
+		return Task{}, err
+	}
+
+	for _, child := range []Node{left, right} {
 		task.Input = append(task.Input, strings.ReplaceAll(child.Text, "\n", " "))
 	}
 
-	return task
+	return task, nil
 }
 
 // run builds one node with the summarizer. A failed build stays in the queue
 // until the next message.
-func (m *Memory) run(key nodeKey, task Task) {
+func (m *Memory) run(key NodeKey, task Task) {
 	defer m.workers.Done()
 
 	text, err := m.summarizer.Summarize(m.ctx, task)
@@ -363,6 +558,7 @@ func (m *Memory) run(key nodeKey, task Task) {
 			Text:  text,
 			Size:  len(text),
 		})
+		m.syncer.Written()
 	}
 
 	if err != nil {
@@ -376,46 +572,27 @@ func (m *Memory) run(key nodeKey, task Task) {
 	m.dispatch()
 }
 
-// Wait returns when no build runs. The failed builds wait for the next message.
-func (m *Memory) Wait(ctx context.Context) error {
-	for {
-		m.mutex.Lock()
-		running := m.queue.Running()
-		changed := m.changed
-		m.mutex.Unlock()
-
-		if running == 0 {
-			return nil
-		}
-
-		select {
-		case <-changed:
-		case <-ctx.Done():
-			return ctx.Err()
+// ready tells if both children of the node key are built and the node is not.
+func (m *Memory) ready(key NodeKey) (bool, error) {
+	for _, index := range []int{2 * key.index, 2*key.index + 1} {
+		built, err := m.tree.Built(key.level-1, index)
+		if err != nil || !built {
+			return false, err
 		}
 	}
-}
 
-// save writes the views to view.json.
-func (m *Memory) save() error {
-	data, err := json.Marshal(viewFile{
-		Chat:       m.chat.State(),
-		Compaction: m.cview.State(),
-	})
-	if err != nil {
-		return fmt.Errorf("encode view: %w", err)
-	}
-
-	err = writeFileAtomic(m.viewPath(), append(data, '\n'))
-	if err != nil {
-		return fmt.Errorf("save view: %w", err)
-	}
+	built, err := m.tree.Built(key.level, key.index)
 
-	return nil
+	return !built, err
 }
 
-func (m *Memory) viewPath() string {
-	return filepath.Join(m.root, "view.json")
+func (m *Memory) context(level, index int) string {
+	end := index
+	if level > 0 {
+		end = nodeEnd(level, index)
+	}
+
+	return m.cview.Context(end)
 }
 
 // View returns the chat view as the model reads it.
@@ -423,7 +600,7 @@ func (m *Memory) View() string {
 	m.mutex.Lock()
 	defer m.mutex.Unlock()
 
-	return m.chat.Render(m.tree)
+	return m.chat.Render()
 }
 
 // Context returns the compaction view for the build of node (l, i). It ends
@@ -436,56 +613,18 @@ func (m *Memory) Context(level, index int) string {
 	return m.context(level, index)
 }
 
-func (m *Memory) context(level, index int) string {
-	end := index
-	if level > 0 {
-		end = nodeEnd(level, index)
-	}
-
-	return m.cview.Context(m.tree, end)
-}
-
-// writeFileAtomic replaces the file at path with data. A reader or a crash sees
-// the old file or the new file, never a part of one.
-func writeFileAtomic(path string, data []byte) error {
-	dir := filepath.Dir(path)
-	file, err := os.CreateTemp(dir, "."+filepath.Base(path)+".*")
-	if err != nil {
-		return fmt.Errorf("create temporary file: %w", err)
-	}
-
-	_, err = file.Write(data)
-	if err == nil {
-		err = file.Sync()
-	}
-
-	err = errors.Join(err, file.Close())
-	if err == nil {
-		err = os.Rename(file.Name(), path)
-	}
-
-	if err != nil {
-		return errors.Join(fmt.Errorf("replace file: %w", err), os.Remove(file.Name()))
-	}
-
-	return syncDir(dir)
+// Task is the build of the node (Level, Index). Context is the compaction view
+// for the build. Input holds the source "kind: text" of a leaf, or the two
+// child lines of a merge with their newlines as spaces.
+type Task struct {
+	Level   int
+	Index   int
+	Context string
+	Input   []string
 }
 
-// syncDir flushes the entries of dir to the disk.
-func syncDir(dir string) (err error) {
-	handle, err := os.Open(dir)
-	if err != nil {
-		return fmt.Errorf("open directory: %w", err)
-	}
-
-	defer func() {
-		err = errors.Join(err, handle.Close())
-	}()
-
-	err = handle.Sync()
-	if err != nil {
-		return fmt.Errorf("flush directory: %w", err)
-	}
-
-	return nil
+// MemoryViewFile is the content of view.json.
+type MemoryViewFile struct {
+	Chat       ViewState `json:"chat"`
+	Compaction ViewState `json:"compaction"`
 }