git.giacomolli.uk - onechat/blob - memory.go

   1 package main
   2
   3 import (
   4         "context"
   5         "encoding/json"
   6         "errors"
   7         "fmt"
   8         "log/slog"
   9         "os"
  10         "path/filepath"
  11         "strings"
  12         "sync"
  13         "time"
  14 )
  15
  16 var (
  17         // errMemoryNoView tells that a chat has messages but no saved view.
  18         errMemoryNoView = errors.New("the chat has messages but no saved view")
  19
  20         // errMemoryUnsettled tells that a line of the view stays pending,
  21         // because its build failed.
  22         errMemoryUnsettled = errors.New("a summary of the view failed, and it is tried again at the next message")
  23 )
  24
  25 // openMemory opens the chat in root and starts the builds that are ready. The
  26 // clock gives the dates of new messages and the days of new nodes. logger gets
  27 // one line for each failed build. The builds stop when ctx ends or at Close.
  28 func openMemory(ctx context.Context, root string, clock func() time.Time, summarizer Summarizer, logger *slog.Logger) (*Memory, error) {
  29         log, err := openLog(ctx, root, clock)
  30         if err != nil {
  31                 return nil, err
  32         }
  33
  34         m := &Memory{
  35                 root:       root,
  36                 log:        log,
  37                 queue:      newBuildQueue(),
  38                 summarizer: summarizer,
  39                 logger:     logger,
  40                 changed:    make(chan struct{}),
  41         }
  42
  43         m.ctx, m.cancel = context.WithCancel(ctx)
  44
  45         m.syncer, err = openSyncer(root)
  46         if err != nil {
  47                 return nil, errors.Join(err, m.Close())
  48         }
  49
  50         m.tree, err = openTree(ctx, root, log.Len(), clock)
  51         if err != nil {
  52                 return nil, errors.Join(err, m.Close())
  53         }
  54
  55         err = m.load()
  56         if err != nil {
  57                 return nil, errors.Join(fmt.Errorf("load view: %w", err), m.Close())
  58         }
  59
  60         err = m.restoreQueue()
  61         if err != nil {
  62                 return nil, errors.Join(fmt.Errorf("restore build queue: %w", err), m.Close())
  63         }
  64
  65         err = m.catchUp()
  66         if err != nil {
  67                 return nil, errors.Join(err, m.Close())
  68         }
  69
  70         m.mutex.Lock()
  71         m.syncer.Written()
  72         m.dispatch()
  73         m.mutex.Unlock()
  74
  75         return m, nil
  76 }
  77
  78 // Summarizer builds the text of one node with a model.
  79 type Summarizer interface {
  80         Summarize(ctx context.Context, task Task) (string, error)
  81 }
  82
  83 // Memory is the memory of one chat: the message log, the summary tree, the chat
  84 // view, the compaction view, and the queue of the builds. The compaction view
  85 // is the chat view merged further, at the limits of 16 to 32 KB. It takes the
  86 // same new lines, and it merges again in one batch when it is too large or when
  87 // the chat view merges. So the compactions share its prefix in the prompt
  88 // cache. It saves the views to view.json after each change and loads them at
  89 // start. It never builds the views again from the log, because a new view
  90 // differs from the live one and so loses the prompt cache.
  91 //
  92 // Each write goes to the operating system at once, and a syncer makes the
  93 // writes durable by group commit in the background. Flush waits until the
  94 // writes so far are durable.
  95 //
  96 // The summarizer builds the nodes in the queue in the background. The start
  97 // reads the indexes once to fill the queue again. After that, only a new
  98 // message or a new node adds work. Memory keeps the nodes of the views and the
  99 // tasks of the running builds. It reads all other messages and nodes from their
 100 // day files through the indexes.
 101 type Memory struct {
 102         mutex      sync.Mutex
 103         root       string
 104         log        *Log
 105         syncer     *Syncer
 106         tree       *Tree
 107         chat       *View
 108         cview      *View
 109         queue      *BuildQueue
 110         summarizer Summarizer
 111         logger     *slog.Logger
 112         ctx        context.Context
 113         cancel     context.CancelFunc
 114         workers    sync.WaitGroup
 115         changed    chan struct{}
 116 }
 117
 118 // Close stops the builds, waits for them, makes the writes durable, closes the
 119 // files of the chat, and releases its lock.
 120 func (m *Memory) Close() error {
 121         m.cancel()
 122         m.workers.Wait()
 123
 124         m.mutex.Lock()
 125         defer m.mutex.Unlock()
 126
 127         var err error
 128
 129         if m.syncer != nil {
 130                 err = m.syncer.Close()
 131         }
 132
 133         if m.tree != nil {
 134                 err = errors.Join(err, m.tree.Close())
 135         }
 136
 137         return errors.Join(err, m.log.Close())
 138 }
 139
 140 // Append logs a new message, adds it to the tree and the views, and starts the
 141 // builds that are ready, also the failed ones.
 142 func (m *Memory) Append(kind, text string) (Message, error) {
 143         return m.AppendDated(kind, text, "")
 144 }
 145
 146 // AppendDated appends a message with its RFC 3339 date and builds its nodes. An
 147 // empty date uses the clock, as Append does.
 148 func (m *Memory) AppendDated(kind, text, date string) (Message, error) {
 149         m.mutex.Lock()
 150         defer m.mutex.Unlock()
 151
 152         message, err := m.log.AppendDated(kind, text, date)
 153         if err != nil {
 154                 return Message{}, fmt.Errorf("append dated log message: %w", err)
 155         }
 156
 157         defer m.syncer.Written()
 158
 159         err = m.addMessage(message)
 160         if err != nil {
 161                 return Message{}, fmt.Errorf("add dated message to memory: %w", err)
 162         }
 163
 164         err = m.save()
 165         if err != nil {
 166                 return Message{}, fmt.Errorf("save dated message view: %w", err)
 167         }
 168
 169         m.queue.Retry()
 170         m.dispatch()
 171
 172         return message, nil
 173 }
 174
 175 // children reads the two children of the node key.
 176 func (m *Memory) children(key NodeKey) (Node, Node, error) {
 177         var children [2]Node
 178
 179         for n := range children {
 180                 child, built, err := m.tree.Node(key.level-1, 2*key.index+n)
 181                 if err != nil {
 182                         return Node{}, Node{}, err
 183                 }
 184
 185                 if !built {
 186                         return Node{}, Node{}, fmt.Errorf("node (%d, %d) is not built", key.level-1, 2*key.index+n)
 187                 }
 188
 189                 children[n] = child
 190         }
 191
 192         return children[0], children[1], nil
 193 }
 194
 195 // Wait returns when no build runs. The failed builds wait for the next message.
 196 func (m *Memory) Wait(ctx context.Context) error {
 197         for {
 198                 m.mutex.Lock()
 199
 200                 running := m.queue.Running()
 201                 changed := m.changed
 202                 m.mutex.Unlock()
 203
 204                 if running == 0 {
 205                         return nil
 206                 }
 207
 208                 select {
 209                 case <-changed:
 210                 case <-ctx.Done():
 211                         return ctx.Err()
 212                 }
 213         }
 214 }
 215
 216 // Settle returns when the chat view has no pending line, so that every message
 217 // so far is summarized. A pending line with no build that runs belongs to a
 218 // failed build, which waits for the next message, so Settle returns
 219 // errMemoryUnsettled in place of a wait that never ends.
 220 func (m *Memory) Settle(ctx context.Context) error {
 221         for {
 222                 m.mutex.Lock()
 223
 224                 pending := m.chat.Pending()
 225                 running := m.queue.Running()
 226                 changed := m.changed
 227                 m.mutex.Unlock()
 228
 229                 if !pending {
 230                         return nil
 231                 }
 232
 233                 if running == 0 {
 234                         return errMemoryUnsettled
 235                 }
 236
 237                 select {
 238                 case <-changed:
 239                 case <-ctx.Done():
 240                         return ctx.Err()
 241                 }
 242         }
 243 }
 244
 245 // Flush returns when every write before the call is durable.
 246 func (m *Memory) Flush(ctx context.Context) error {
 247         return m.syncer.Flush(ctx)
 248 }
 249
 250 // ViewLines returns the lines of the chat view, each with its newline, without
 251 // the leaf lines of the messages in skip.
 252 func (m *Memory) ViewLines(skip map[int]bool) []string {
 253         m.mutex.Lock()
 254         defer m.mutex.Unlock()
 255
 256         return m.chat.LinesWithout(skip)
 257 }
 258
 259 // Len returns the number of messages in the log.
 260 func (m *Memory) Len() int {
 261         m.mutex.Lock()
 262         defer m.mutex.Unlock()
 263
 264         return m.log.Len()
 265 }
 266
 267 // Message reads the message with the given ID.
 268 func (m *Memory) Message(id int) (Message, error) {
 269         m.mutex.Lock()
 270         defer m.mutex.Unlock()
 271
 272         return m.log.Message(id)
 273 }
 274
 275 // Node reads the node (l, i) if it is built.
 276 func (m *Memory) Node(level, index int) (Node, bool, error) {
 277         m.mutex.Lock()
 278         defer m.mutex.Unlock()
 279
 280         return m.tree.Node(level, index)
 281 }
 282
 283 // load reads the saved views.
 284 func (m *Memory) load() error {
 285         data, err := os.ReadFile(m.viewPath())
 286         if errors.Is(err, os.ErrNotExist) && m.log.Len() == 0 {
 287                 m.chat = newView(viewChatHigh, viewChatLow)
 288                 m.cview = newView(viewCompactionHigh, viewCompactionLow)
 289
 290                 return nil
 291         }
 292
 293         if errors.Is(err, os.ErrNotExist) {
 294                 return errMemoryNoView
 295         }
 296
 297         if err != nil {
 298                 return fmt.Errorf("read view: %w", err)
 299         }
 300
 301         var file MemoryViewFile
 302
 303         err = json.Unmarshal(data, &file)
 304         if err != nil {
 305                 return fmt.Errorf("decode view: %w", err)
 306         }
 307
 308         m.chat, err = restoreView(file.Chat, viewChatHigh, viewChatLow, m.tree)
 309         if err != nil {
 310                 return fmt.Errorf("chat view: %w", err)
 311         }
 312
 313         m.cview, err = restoreView(file.Compaction, viewCompactionHigh, viewCompactionLow, m.tree)
 314         if err != nil {
 315                 return fmt.Errorf("compaction view: %w", err)
 316         }
 317
 318         if m.cview.end != m.chat.end {
 319                 return fmt.Errorf("compaction view covers %d messages, but the chat view %d", m.cview.end, m.chat.end)
 320         }
 321
 322         if m.chat.end > m.log.Len() {
 323                 return fmt.Errorf("view covers %d messages, but the log has %d", m.chat.end, m.log.Len())
 324         }
 325
 326         return nil
 327 }
 328
 329 // restoreQueue adds the work of the messages in the view to the queue. It
 330 // builds each node that needs no model call and that a crash left out.
 331 func (m *Memory) restoreQueue() error {
 332         for id := range m.chat.end {
 333                 built, err := m.tree.Built(0, id)
 334                 if err != nil {
 335                         return err
 336                 }
 337
 338                 if built {
 339                         continue
 340                 }
 341
 342                 message, err := m.log.Message(id)
 343                 if err != nil {
 344                         return err
 345                 }
 346
 347                 leaf, free := freeLeaf(message)
 348                 if !free {
 349                         m.queue.AddLeaf(id)
 350
 351                         continue
 352                 }
 353
 354                 err = m.build(leaf)
 355                 if err != nil {
 356                         return err
 357                 }
 358         }
 359
 360         keys, err := m.tree.Keys()
 361         if err != nil {
 362                 return err
 363         }
 364
 365         for _, key := range keys {
 366                 if key.index%2 != 0 {
 367                         continue
 368                 }
 369
 370                 err = m.settle(key)
 371                 if err != nil {
 372                         return err
 373                 }
 374         }
 375
 376         return nil
 377 }
 378
 379 // catchUp adds the messages that the view does not cover yet. A crash can stop
 380 // an append after the log write and before the view save.
 381 func (m *Memory) catchUp() error {
 382         if m.chat.end == m.log.Len() {
 383                 return nil
 384         }
 385
 386         for m.chat.end < m.log.Len() {
 387                 message, err := m.log.Message(m.chat.end)
 388                 if err != nil {
 389                         return err
 390                 }
 391
 392                 err = m.addMessage(message)
 393                 if err != nil {
 394                         return err
 395                 }
 396         }
 397
 398         return m.save()
 399 }
 400
 401 // dispatch starts the builds that are ready, up to the limit. A build whose
 402 // input cannot be read fails and waits for the next message.
 403 func (m *Memory) dispatch() {
 404         for m.ctx.Err() == nil {
 405                 key, ready := m.queue.Next()
 406                 if !ready {
 407                         return
 408                 }
 409
 410                 task, err := m.task(key)
 411                 if err != nil {
 412                         m.failed(key, fmt.Errorf("read its input: %w", err))
 413                         m.queue.Fail(key)
 414
 415                         continue
 416                 }
 417
 418                 m.workers.Add(1)
 419
 420                 go m.run(key, task)
 421         }
 422 }
 423
 424 // addMessage builds the leaf of message when it needs no model call, or else
 425 // adds the leaf to the queue. Then it appends the leaf to the views. A crash can
 426 // stop an append after the leaf build and before the view save, so a leaf that
 427 // is built already stays as it is, and restoreQueue settles its parent.
 428 func (m *Memory) addMessage(message Message) error {
 429         built, err := m.tree.Built(0, message.ID)
 430         if err != nil {
 431                 return err
 432         }
 433
 434         leaf, free := freeLeaf(message)
 435         switch {
 436         case built:
 437         case free:
 438                 err = m.build(leaf)
 439                 if err != nil {
 440                         return err
 441                 }
 442         default:
 443                 m.queue.AddLeaf(message.ID)
 444         }
 445
 446         merged, err := m.chat.Append(m.tree)
 447         if err != nil {
 448                 return fmt.Errorf("append to chat view: %w", err)
 449         }
 450
 451         _, err = m.cview.Append(m.tree)
 452         if err == nil && merged {
 453                 err = m.cview.Coarsen(m.chat, m.tree)
 454         }
 455
 456         if err != nil {
 457                 return fmt.Errorf("append to compaction view: %w", err)
 458         }
 459
 460         return nil
 461 }
 462
 463 // save writes the views to view.json.
 464 func (m *Memory) save() error {
 465         data, err := json.Marshal(MemoryViewFile{
 466                 Chat:       m.chat.State(),
 467                 Compaction: m.cview.State(),
 468         })
 469         if err != nil {
 470                 return fmt.Errorf("encode view: %w", err)
 471         }
 472
 473         err = writeFileAtomic(m.viewPath(), append(data, '\n'))
 474         if err != nil {
 475                 return fmt.Errorf("save view: %w", err)
 476         }
 477
 478         return nil
 479 }
 480
 481 func (m *Memory) viewPath() string {
 482         return filepath.Join(m.root, "view.json")
 483 }
 484
 485 // build adds node to the tree, keeps it in the views when it is a pending line,
 486 // and settles its parent.
 487 func (m *Memory) build(node Node) error {
 488         err := m.tree.Add(node)
 489         if err != nil {
 490                 return err
 491         }
 492
 493         m.chat.Refresh(node)
 494         m.cview.Refresh(node)
 495
 496         return m.settle(NodeKey{node.Level, node.Index})
 497 }
 498
 499 // settle looks at the parent of the built node key when both children are
 500 // built. It builds each parent that needs no model call, up the tree, and adds
 501 // the first other parent to the queue.
 502 func (m *Memory) settle(key NodeKey) error {
 503         for {
 504                 parent := NodeKey{key.level + 1, key.index / 2}
 505                 ready, err := m.ready(parent)
 506                 if err != nil || !ready {
 507                         return err
 508                 }
 509
 510                 left, right, err := m.children(parent)
 511                 if err != nil {
 512                         return err
 513                 }
 514
 515                 node, free := freeMerge(left, right)
 516                 if !free {
 517                         m.queue.AddMerge(parent)
 518
 519                         return nil
 520                 }
 521
 522                 err = m.tree.Add(node)
 523                 if err != nil {
 524                         return err
 525                 }
 526
 527                 key = parent
 528         }
 529 }
 530
 531 // task returns the build task of the node key, with its input read from the log
 532 // or the tree.
 533 func (m *Memory) task(key NodeKey) (Task, error) {
 534         task := Task{
 535                 Level:   key.level,
 536                 Index:   key.index,
 537                 Context: m.context(key.level, key.index),
 538         }
 539
 540         if key.level == 0 {
 541                 message, err := m.log.Message(key.index)
 542                 if err != nil {
 543                         return Task{}, err
 544                 }
 545
 546                 task.Input = []string{leafSource(message)}
 547
 548                 return task, nil
 549         }
 550
 551         left, right, err := m.children(key)
 552         if err != nil {
 553                 return Task{}, err
 554         }
 555
 556         for _, child := range []Node{left, right} {
 557                 task.Input = append(task.Input, strings.ReplaceAll(child.Text, "\n", " "))
 558         }
 559
 560         return task, nil
 561 }
 562
 563 // run builds one node with the summarizer. A failed build stays in the queue
 564 // until the next message.
 565 func (m *Memory) run(key NodeKey, task Task) {
 566         defer m.workers.Done()
 567
 568         text, err := m.summarizer.Summarize(m.ctx, task)
 569
 570         m.mutex.Lock()
 571         defer m.mutex.Unlock()
 572
 573         if err == nil {
 574                 err = m.build(Node{
 575                         Level: key.level,
 576                         Index: key.index,
 577                         Text:  text,
 578                         Size:  len(text),
 579                 })
 580                 m.syncer.Written()
 581         }
 582
 583         if err != nil && m.ctx.Err() == nil {
 584                 m.failed(key, err)
 585         }
 586
 587         if err != nil {
 588                 m.queue.Fail(key)
 589         } else {
 590                 m.queue.Done(key)
 591         }
 592
 593         close(m.changed)
 594
 595         m.changed = make(chan struct{})
 596         m.dispatch()
 597 }
 598
 599 // failed logs the failed build of the node key with its cause err.
 600 func (m *Memory) failed(key NodeKey, err error) {
 601         m.logger.Warn("summary failed", "level", key.level, "index", key.index, "err", err)
 602 }
 603
 604 // ready tells if both children of the node key are built and the node is not.
 605 func (m *Memory) ready(key NodeKey) (bool, error) {
 606         for _, index := range []int{2 * key.index, 2*key.index + 1} {
 607                 built, err := m.tree.Built(key.level-1, index)
 608                 if err != nil || !built {
 609                         return false, err
 610                 }
 611         }
 612
 613         built, err := m.tree.Built(key.level, key.index)
 614
 615         return !built, err
 616 }
 617
 618 func (m *Memory) context(level, index int) string {
 619         end := index
 620         if level > 0 {
 621                 end = nodeEnd(level, index)
 622         }
 623
 624         return m.cview.Context(end)
 625 }
 626
 627 // View returns the chat view as the model reads it.
 628 func (m *Memory) View() string {
 629         m.mutex.Lock()
 630         defer m.mutex.Unlock()
 631
 632         return m.chat.Render()
 633 }
 634
 635 // Context returns the compaction view for the build of node (l, i). It ends
 636 // before the message of a leaf, or after the last message of a merge, and it
 637 // stops at the first line that is not built.
 638 func (m *Memory) Context(level, index int) string {
 639         m.mutex.Lock()
 640         defer m.mutex.Unlock()
 641
 642         return m.context(level, index)
 643 }
 644
 645 // rebuildComplete checks the whole tree, not only the visible view. A compactor
 646 // can fail without an HTTP error, for example with an empty line. Such a failed
 647 // merge can be absent from the view and must prevent a swap.
 648 func (m *Memory) rebuildComplete() error {
 649         m.mutex.Lock()
 650         defer m.mutex.Unlock()
 651
 652         if len(m.queue.leaves) != 0 || len(m.queue.queued) != 0 {
 653                 return errors.New("rebuild failed: summary tree has unfinished nodes")
 654         }
 655
 656         return nil
 657 }
 658
 659 // buildModelLines returns the sizes of the nodes that the model wrote, in tree
 660 // order. A node that fits its source with no model call is not one of them.
 661 func (m *Memory) buildModelLines() ([]int, error) {
 662         m.mutex.Lock()
 663         defer m.mutex.Unlock()
 664
 665         keys, err := m.tree.Keys()
 666         if err != nil {
 667                 return nil, fmt.Errorf("list built nodes: %w", err)
 668         }
 669
 670         var sizes []int
 671
 672         for _, key := range keys {
 673                 var node Node
 674
 675                 node, _, err = m.tree.Node(key.level, key.index)
 676                 if err != nil {
 677                         return nil, fmt.Errorf("read built node: %w", err)
 678                 }
 679
 680                 var model bool
 681
 682                 model, err = m.buildBuiltByModel(key)
 683                 if err != nil {
 684                         return nil, fmt.Errorf("check model source: %w", err)
 685                 }
 686
 687                 if model {
 688                         sizes = append(sizes, node.Size)
 689                 }
 690         }
 691
 692         return sizes, nil
 693 }
 694
 695 // buildBuiltByModel tells if the node key needed a model call: a leaf whose
 696 // source is over nodeBytes, or a merge whose children do not fit in one node.
 697 func (m *Memory) buildBuiltByModel(key NodeKey) (bool, error) {
 698         if key.level == 0 {
 699                 message, err := m.log.Message(key.index)
 700                 if err != nil {
 701                         return false, fmt.Errorf("read leaf source: %w", err)
 702                 }
 703
 704                 _, free := freeLeaf(message)
 705
 706                 return !free, nil
 707         }
 708
 709         left, right, err := m.children(key)
 710         if err != nil {
 711                 return false, fmt.Errorf("read merge sources: %w", err)
 712         }
 713
 714         _, free := freeMerge(left, right)
 715
 716         return !free, nil
 717 }
 718
 719 // Task is the build of the node (Level, Index). Context is the compaction view
 720 // for the build. Input holds the source "kind: text" of a leaf, or the two
 721 // child lines of a merge with their newlines as spaces.
 722 type Task struct {
 723         Level   int
 724         Index   int
 725         Context string
 726         Input   []string
 727 }
 728
 729 // MemoryViewFile is the content of view.json.
 730 type MemoryViewFile struct {
 731         Chat       ViewState `json:"chat"`
 732         Compaction ViewState `json:"compaction"`
 733 }