|
| 1 | +// Copyright 2025, Command Line Inc. |
| 2 | +// SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +package wcore |
| 5 | + |
| 6 | +import ( |
| 7 | + "context" |
| 8 | + "fmt" |
| 9 | + "log" |
| 10 | + "sync" |
| 11 | + "time" |
| 12 | + |
| 13 | + "github.com/wavetermdev/waveterm/pkg/baseds" |
| 14 | + "github.com/wavetermdev/waveterm/pkg/util/utilfn" |
| 15 | + "github.com/wavetermdev/waveterm/pkg/waveobj" |
| 16 | + "github.com/wavetermdev/waveterm/pkg/wps" |
| 17 | + "github.com/wavetermdev/waveterm/pkg/wshrpc/wshclient" |
| 18 | + "github.com/wavetermdev/waveterm/pkg/wstore" |
| 19 | +) |
| 20 | + |
| 21 | +// BadgeStore is a write-through cache for badges. |
| 22 | +// Each oref can carry two independent badges: |
| 23 | +// - a persistent badge (stored in the DB and survives restarts) |
| 24 | +// - a transient badge (in-memory only, cleared on restart) |
| 25 | +// |
| 26 | +// Values are stored by value (not pointer) to prevent external mutation. |
| 27 | +type BadgeStore struct { |
| 28 | + lock *sync.Mutex |
| 29 | + persistent map[string]baseds.Badge // keyed by oref string |
| 30 | + transient map[string]baseds.Badge // keyed by oref string |
| 31 | +} |
| 32 | + |
| 33 | +var globalBadgeStore = &BadgeStore{ |
| 34 | + lock: &sync.Mutex{}, |
| 35 | + persistent: make(map[string]baseds.Badge), |
| 36 | + transient: make(map[string]baseds.Badge), |
| 37 | +} |
| 38 | + |
| 39 | +// InitBadgeStore loads all persisted badges from the DB into the in-memory |
| 40 | +// cache and subscribes to incoming badge events. |
| 41 | +func InitBadgeStore() error { |
| 42 | + log.Printf("initializing badge store\n") |
| 43 | + |
| 44 | + ctx, cancelFn := context.WithTimeout(context.Background(), 5*time.Second) |
| 45 | + defer cancelFn() |
| 46 | + |
| 47 | + // Load persisted badges from all tabs. |
| 48 | + tabs, err := wstore.DBGetAllObjsByType[*waveobj.Tab](ctx, waveobj.OType_Tab) |
| 49 | + if err != nil { |
| 50 | + return fmt.Errorf("badge store: error loading tabs from DB: %w", err) |
| 51 | + } |
| 52 | + for _, tab := range tabs { |
| 53 | + if tab.Badge != nil { |
| 54 | + oref := waveobj.MakeORef(waveobj.OType_Tab, tab.OID).String() |
| 55 | + globalBadgeStore.persistent[oref] = *tab.Badge |
| 56 | + } |
| 57 | + } |
| 58 | + |
| 59 | + // Load persisted badges from all blocks. |
| 60 | + blocks, err := wstore.DBGetAllObjsByType[*waveobj.Block](ctx, waveobj.OType_Block) |
| 61 | + if err != nil { |
| 62 | + return fmt.Errorf("badge store: error loading blocks from DB: %w", err) |
| 63 | + } |
| 64 | + for _, block := range blocks { |
| 65 | + if block.Badge != nil { |
| 66 | + oref := waveobj.MakeORef(waveobj.OType_Block, block.OID).String() |
| 67 | + globalBadgeStore.persistent[oref] = *block.Badge |
| 68 | + } |
| 69 | + } |
| 70 | + |
| 71 | + log.Printf("badge store: loaded %d persisted badges\n", len(globalBadgeStore.persistent)) |
| 72 | + |
| 73 | + // Subscribe to badge events so we can update the cache when events arrive. |
| 74 | + rpcClient := wshclient.GetBareRpcClient() |
| 75 | + rpcClient.EventListener.On(wps.Event_Badge, handleBadgeEvent) |
| 76 | + wshclient.EventSubCommand(rpcClient, wps.SubscriptionRequest{ |
| 77 | + Event: wps.Event_Badge, |
| 78 | + AllScopes: true, |
| 79 | + }, nil) |
| 80 | + |
| 81 | + return nil |
| 82 | +} |
| 83 | + |
| 84 | +func handleBadgeEvent(event *wps.WaveEvent) { |
| 85 | + if event.Event != wps.Event_Badge { |
| 86 | + return |
| 87 | + } |
| 88 | + var data baseds.BadgeEvent |
| 89 | + err := utilfn.ReUnmarshal(&data, event.Data) |
| 90 | + if err != nil { |
| 91 | + log.Printf("badge store: error unmarshaling BadgeEvent: %v\n", err) |
| 92 | + return |
| 93 | + } |
| 94 | + if data.ORef == "" { |
| 95 | + log.Printf("badge store: received badge event with empty oref\n") |
| 96 | + return |
| 97 | + } |
| 98 | + |
| 99 | + oref, err := waveobj.ParseORef(data.ORef) |
| 100 | + if err != nil { |
| 101 | + log.Printf("badge store: error parsing oref %q: %v\n", data.ORef, err) |
| 102 | + return |
| 103 | + } |
| 104 | + |
| 105 | + setBadge(oref, data.Badge, data.Persistent, data.Clear) |
| 106 | +} |
| 107 | + |
| 108 | +// setBadge updates the appropriate in-memory map and, when persistent, writes |
| 109 | +// through to the DB and fires a WaveObjUpdate event so the frontend stays in sync. |
| 110 | +func setBadge(oref waveobj.ORef, badge *baseds.Badge, persistent bool, clear bool) { |
| 111 | + globalBadgeStore.lock.Lock() |
| 112 | + defer globalBadgeStore.lock.Unlock() |
| 113 | + |
| 114 | + orefStr := oref.String() |
| 115 | + |
| 116 | + if persistent { |
| 117 | + if clear || badge == nil { |
| 118 | + delete(globalBadgeStore.persistent, orefStr) |
| 119 | + log.Printf("badge store: persistent badge cleared: oref=%s\n", orefStr) |
| 120 | + go persistBadge(oref, nil) |
| 121 | + } else { |
| 122 | + globalBadgeStore.persistent[orefStr] = *badge |
| 123 | + log.Printf("badge store: persistent badge set: oref=%s badge=%+v\n", orefStr, *badge) |
| 124 | + go persistBadge(oref, badge) |
| 125 | + } |
| 126 | + } else { |
| 127 | + if clear || badge == nil { |
| 128 | + delete(globalBadgeStore.transient, orefStr) |
| 129 | + log.Printf("badge store: transient badge cleared: oref=%s\n", orefStr) |
| 130 | + } else { |
| 131 | + globalBadgeStore.transient[orefStr] = *badge |
| 132 | + log.Printf("badge store: transient badge set: oref=%s badge=%+v\n", orefStr, *badge) |
| 133 | + } |
| 134 | + } |
| 135 | +} |
| 136 | + |
| 137 | +// persistBadge writes the badge (or nil to clear) to the appropriate DB object. |
| 138 | +func persistBadge(oref waveobj.ORef, badge *baseds.Badge) { |
| 139 | + ctx, cancelFn := context.WithTimeout(context.Background(), 5*time.Second) |
| 140 | + defer cancelFn() |
| 141 | + |
| 142 | + switch oref.OType { |
| 143 | + case waveobj.OType_Tab: |
| 144 | + err := wstore.DBUpdateFn[*waveobj.Tab](ctx, oref.OID, func(tab *waveobj.Tab) { |
| 145 | + tab.Badge = badge |
| 146 | + }) |
| 147 | + if err != nil { |
| 148 | + log.Printf("badge store: error persisting badge for tab %s: %v\n", oref.OID, err) |
| 149 | + return |
| 150 | + } |
| 151 | + log.Printf("badge store: persisted badge for tab %s\n", oref.OID) |
| 152 | + SendWaveObjUpdate(oref) |
| 153 | + |
| 154 | + case waveobj.OType_Block: |
| 155 | + err := wstore.DBUpdateFn[*waveobj.Block](ctx, oref.OID, func(block *waveobj.Block) { |
| 156 | + block.Badge = badge |
| 157 | + }) |
| 158 | + if err != nil { |
| 159 | + log.Printf("badge store: error persisting badge for block %s: %v\n", oref.OID, err) |
| 160 | + return |
| 161 | + } |
| 162 | + log.Printf("badge store: persisted badge for block %s\n", oref.OID) |
| 163 | + SendWaveObjUpdate(oref) |
| 164 | + |
| 165 | + default: |
| 166 | + log.Printf("badge store: unsupported oref type for persistence: %s\n", oref.OType) |
| 167 | + } |
| 168 | +} |
| 169 | + |
| 170 | +// GetAllBadges returns a snapshot of all currently active badges as a slice of |
| 171 | +// BadgeEvent values. Each entry carries the ORef, the Persistent flag, and the |
| 172 | +// Badge itself. An oref that has both a persistent and a transient badge will |
| 173 | +// appear twice in the result. |
| 174 | +func GetAllBadges() []baseds.BadgeEvent { |
| 175 | + globalBadgeStore.lock.Lock() |
| 176 | + defer globalBadgeStore.lock.Unlock() |
| 177 | + |
| 178 | + result := make([]baseds.BadgeEvent, 0, len(globalBadgeStore.persistent)+len(globalBadgeStore.transient)) |
| 179 | + for orefStr, badge := range globalBadgeStore.persistent { |
| 180 | + b := badge // copy |
| 181 | + result = append(result, baseds.BadgeEvent{ |
| 182 | + ORef: orefStr, |
| 183 | + Persistent: true, |
| 184 | + Badge: &b, |
| 185 | + }) |
| 186 | + } |
| 187 | + for orefStr, badge := range globalBadgeStore.transient { |
| 188 | + b := badge // copy |
| 189 | + result = append(result, baseds.BadgeEvent{ |
| 190 | + ORef: orefStr, |
| 191 | + Badge: &b, |
| 192 | + }) |
| 193 | + } |
| 194 | + return result |
| 195 | +} |
0 commit comments