perf(nodes): port upstream region membership cache (#2102)

cmd/server/db.go

@@ -18,6 +18,7 @@ import (
 	"github.com/meshcore-analyzer/dbschema"
 	"github.com/meshcore-analyzer/geofilter"
 	regionutil "github.com/meshcore-analyzer/regions"
+	"golang.org/x/sync/singleflight"
 	_ "modernc.org/sqlite"
 )
 
@@ -112,6 +113,13 @@ type DB struct {
 	// channelsRowsHook wraps the result rows of each real query, so a test
 	// can fail the iteration part-way.
 	channelsRowsHook func(kind string, rows channelRows) channelRows
+
+	// Region-membership cache for GetNodes (see nodes_region_cache.go).
+	nodeRegionCacheMu   sync.Mutex
+	nodeRegionCache     map[string]*nodeRegionEntry
+	nodeRegionSF        singleflight.Group
+	nodeRegionFullMu    sync.Mutex
+	nodeRegionQueryHook func()
 }
 
 // channelRows is the part of *sql.Rows the channel list scans use.
@@ -1126,30 +1134,13 @@ func (db *DB) GetNodes(limit, offset int, role, search, before, lastHeard, sortB
 		}
 	}
 
-	if region != "" {
-		codes := normalizeRegionCodes(region)
-		if len(codes) > 0 {
-			placeholders := make([]string, len(codes))
-			regionArgs := make([]interface{}, len(codes))
-			for i, c := range codes {
-				placeholders[i] = "?"
-				regionArgs[i] = c
-			}
-			joinCond := "obs.rowid = o.observer_idx"
-			if !db.isV3() {
-				joinCond = "obs.id = o.observer_id"
-			}
-			subq := fmt.Sprintf(`public_key IN (
-				SELECT DISTINCT JSON_EXTRACT(t.decoded_json, '$.pubKey')
-				FROM transmissions t
-				JOIN observations o ON o.transmission_id = t.id
-				JOIN observers obs ON %s
-				WHERE t.payload_type = 4
-				AND UPPER(TRIM(obs.iata)) IN (%s)
-			)`, joinCond, strings.Join(placeholders, ","))
-			where = append(where, subq)
-			args = append(args, regionArgs...)
+	if codes := normalizeRegionCodes(region); len(codes) > 0 {
+		keysJSON, err := db.nodeRegionKeysJSON(codes)
+		if err != nil {
+			return nil, 0, nil, err
 		}
+		where = append(where, "public_key IN (SELECT value FROM json_each(?))")
+		args = append(args, keysJSON)
 	}
 
 	w := ""

cmd/server/nodes_region_cache.go

@@ -0,0 +1,312 @@
+package main
+
+import (
+	"context"
+	"encoding/json"
+	"errors"
+	"fmt"
+	"log"
+	"sort"
+	"strings"
+	"time"
+)
+
+// Region-scoped node membership cache for GetNodes (#2101).
+//
+// `/api/nodes?region=X` restricts the node list to nodes whose ADVERTs were
+// heard by an observer in region X. That used to be an inline
+// `public_key IN (SELECT DISTINCT from_pubkey FROM transmissions ⋈
+// observations ⋈ observers ...)` subquery, uncached, evaluated twice per
+// request (COUNT(*) and the page). On a 1.4 GB database (1.47M observations)
+// each evaluation took ~10s, and fetchAllNodes() pages at 500, so a single
+// open Nodes or Map tab kept a 2-vCPU host busy.
+//
+// Membership only grows as observations arrive, so it is cached per region
+// set with an observations.id watermark:
+//   - fresh (< nodeRegionFreshTTL): served as-is;
+//   - stale: served as-is while ONE background refresh scans only
+//     observations with id > watermark (a rowid range, milliseconds);
+//   - every nodeRegionRebuildInterval the refresh is a full rebuild instead,
+//     so retention pruning, observer IATA changes and late from_pubkey
+//     backfills are picked up.
+//
+// Only the first request for a region set waits on a full scan, and
+// concurrent first requests share it (the #1910 singleflight pattern, as
+// channelsSF).
+
+const (
+	nodeRegionFreshTTL        = 30 * time.Second
+	nodeRegionRebuildInterval = 30 * time.Minute
+	// nodeRegionMaxEntries bounds the cache. Entries hold up to a few thousand
+	// pubkeys each, so this is far below the shared maxCacheEntries; in
+	// practice an instance sees a handful of distinct region sets.
+	nodeRegionMaxEntries = 32
+)
+
+// errNodeRegionFlightResult means nodeRegionSF returned something other than
+// a *nodeRegionEntry, which only a programming error can cause.
+var errNodeRegionFlightResult = errors.New("unexpected node region flight result")
+
+// nodeRegionEntry is immutable once stored: refreshes build a new entry, so
+// readers can use one without holding nodeRegionCacheMu.
+type nodeRegionEntry struct {
+	keys      []string // sorted from_pubkeys heard in the region set
+	keysJSON  string   // keys as a JSON array, bound to json_each(?)
+	watermark int64    // max observations.id covered by keys
+	refreshed time.Time
+	built     time.Time // last full rebuild
+}
+
+func (e *nodeRegionEntry) fresh() bool {
+	return time.Since(e.refreshed) < nodeRegionFreshTTL
+}
+
+func (e *nodeRegionEntry) rebuildDue() bool {
+	return time.Since(e.built) >= nodeRegionRebuildInterval
+}
+
+// newNodeRegionEntry snapshots set into an entry.
+func newNodeRegionEntry(set map[string]struct{}, watermark int64, built time.Time) (*nodeRegionEntry, error) {
+	keys := make([]string, 0, len(set))
+	for k := range set {
+		keys = append(keys, k)
+	}
+	sort.Strings(keys)
+	buf, err := json.Marshal(keys)
+	if err != nil {
+		return nil, fmt.Errorf("encode region keys: %w", err)
+	}
+	return &nodeRegionEntry{
+		keys:      keys,
+		keysJSON:  string(buf),
+		watermark: watermark,
+		refreshed: time.Now(),
+		built:     built,
+	}, nil
+}
+
+// nodeRegionKey canonicalises normalised region codes so "EDI,GLA",
+// "gla, edi" and "EDI,EDI,GLA" share one cache entry.
+func nodeRegionKey(codes []string) string {
+	seen := make(map[string]struct{}, len(codes))
+	uniq := make([]string, 0, len(codes))
+	for _, c := range codes {
+		if _, ok := seen[c]; !ok {
+			seen[c] = struct{}{}
+			uniq = append(uniq, c)
+		}
+	}
+	sort.Strings(uniq)
+	return strings.Join(uniq, ",")
+}
+
+func (db *DB) getNodeRegionEntry(key string) *nodeRegionEntry {
+	db.nodeRegionCacheMu.Lock()
+	defer db.nodeRegionCacheMu.Unlock()
+	return db.nodeRegionCache[key]
+}
+
+func (db *DB) setNodeRegionEntry(key string, e *nodeRegionEntry) {
+	db.nodeRegionCacheMu.Lock()
+	defer db.nodeRegionCacheMu.Unlock()
+	_, replacing := db.nodeRegionCache[key]
+	if db.nodeRegionCache == nil || (!replacing && len(db.nodeRegionCache) >= nodeRegionMaxEntries) {
+		db.nodeRegionCache = make(map[string]*nodeRegionEntry)
+	}
+	db.nodeRegionCache[key] = e
+}
+
+// nodeRegionKeysJSON returns the JSON array of node public keys heard in the
+// given (normalised, non-empty) region codes, for binding to
+// `public_key IN (SELECT value FROM json_each(?))`.
+func (db *DB) nodeRegionKeysJSON(codes []string) (string, error) {
+	key := nodeRegionKey(codes)
+
+	if e := db.getNodeRegionEntry(key); e != nil {
+		if !e.fresh() {
+			// Stale-while-revalidate: kick one refresh, don't wait on it.
+			// DoChan dedups against an in-flight refresh for the same key,
+			// and its buffered result channel may be left unread.
+			db.nodeRegionSF.DoChan(key, func() (any, error) {
+				return db.refreshNodeRegion(key, codes)
+			})
+		}
+		return e.keysJSON, nil
+	}
+
+	v, err, _ := db.nodeRegionSF.Do(key, func() (any, error) {
+		return db.refreshNodeRegion(key, codes)
+	})
+	if err != nil {
+		return "", err
+	}
+	e, ok := v.(*nodeRegionEntry)
+	if !ok {
+		return "", fmt.Errorf("nodes-region %s: %w: %T", key, errNodeRegionFlightResult, v)
+	}
+	return e.keysJSON, nil
+}
+
+// refreshNodeRegion brings the cache entry for key up to date and stores it:
+// a delta scan past the watermark when an entry exists and is not due a
+// rebuild, a full scan otherwise. It runs inside nodeRegionSF, so at most one
+// refresh per key is in flight. Failures are logged here because a background
+// refresh has no caller to report to; the previous entry stays in place.
+func (db *DB) refreshNodeRegion(key string, codes []string) (*nodeRegionEntry, error) {
+	prev := db.getNodeRegionEntry(key)
+	if prev != nil && prev.fresh() {
+		return prev, nil // a flight that finished just before this one got here
+	}
+	if db.nodeRegionQueryHook != nil {
+		db.nodeRegionQueryHook()
+	}
+
+	// A scan still running when the next rebuild would be due is abandoned
+	// rather than left holding one of the pooled connections.
+	ctx, cancel := context.WithTimeout(context.Background(), nodeRegionRebuildInterval)
+	defer cancel()
+
+	var e *nodeRegionEntry
+	var err error
+	if prev == nil || prev.rebuildDue() {
+		e, err = db.buildNodeRegion(ctx, key, codes)
+	} else {
+		e, err = db.extendNodeRegion(ctx, key, codes, prev)
+	}
+	if err != nil {
+		err = fmt.Errorf("nodes-region %s: %w", key, err)
+		log.Printf("[nodes-region] refresh failed: %v", err)
+		return nil, err
+	}
+	db.setNodeRegionEntry(key, e)
+	return e, nil
+}
+
+// buildNodeRegion scans the full observation history for the region set.
+// Full builds are serialised across region sets: each holds a pooled
+// connection for seconds on a large database, and entries built together at
+// startup fall due together.
+func (db *DB) buildNodeRegion(ctx context.Context, key string, codes []string) (*nodeRegionEntry, error) {
+	db.nodeRegionFullMu.Lock()
+	defer db.nodeRegionFullMu.Unlock()
+
+	wm, err := db.maxObservationID(ctx)
+	if err != nil {
+		return nil, err
+	}
+	start := time.Now()
+	set := make(map[string]struct{})
+	if _, err := db.scanNodeRegionKeys(ctx, codes, 0, wm, false, set); err != nil {
+		return nil, err
+	}
+	log.Printf("[nodes-region] %s: full build, %d nodes in %v (obs id <= %d)",
+		key, len(set), time.Since(start).Round(time.Millisecond), wm)
+	return newNodeRegionEntry(set, wm, start)
+}
+
+// extendNodeRegion adds nodes heard since prev's watermark.
+func (db *DB) extendNodeRegion(
+	ctx context.Context, key string, codes []string, prev *nodeRegionEntry,
+) (*nodeRegionEntry, error) {
+	wm, err := db.maxObservationID(ctx)
+	if err != nil {
+		return nil, err
+	}
+	set := make(map[string]struct{}, len(prev.keys))
+	for _, k := range prev.keys {
+		set[k] = struct{}{}
+	}
+	start := time.Now()
+	added := 0
+	if wm > prev.watermark {
+		added, err = db.scanNodeRegionKeys(ctx, codes, prev.watermark, wm, true, set)
+		if err != nil {
+			return nil, err
+		}
+	}
+	if added == 0 {
+		// Same membership: keep the encoded keys, advance the watermark.
+		e := *prev
+		e.watermark = max(wm, prev.watermark)
+		e.refreshed = time.Now()
+		return &e, nil
+	}
+	log.Printf("[nodes-region] %s: +%d nodes from obs %d..%d in %v",
+		key, added, prev.watermark+1, wm, time.Since(start).Round(time.Millisecond))
+	return newNodeRegionEntry(set, wm, prev.built)
+}
+
+// maxObservationID pins the upper bound of a scan. The ingestor is the single
+// writer and observations.id is AUTOINCREMENT, so every id <= the returned
+// value is committed and visible to a later read; newer rows are left for the
+// next delta.
+func (db *DB) maxObservationID(ctx context.Context) (int64, error) {
+	const q = "SELECT COALESCE(MAX(id), 0) FROM observations"
+	// Issue exactly one query: an unscanned *sql.Row keeps its connection
+	// checked out, and the pool is 4 (OpenDB).
+	row := db.conn.QueryRowContext(ctx, q)
+	var wm int64
+	if err := row.Scan(&wm); err != nil {
+		return 0, fmt.Errorf("max observation id: %w", err)
+	}
+	return wm, nil
+}
+
+// scanNodeRegionKeys adds to set every ADVERT from_pubkey observed by an
+// observer in codes with lo < observations.id <= hi, returning how many were
+// new. For a delta scan the join order is forced (CROSS JOIN) to drive from
+// the observations rowid range; left to the planner, sqlite_stat1 (#2058)
+// makes it start from the region's observers and walk their whole history.
+func (db *DB) scanNodeRegionKeys(
+	ctx context.Context, codes []string, lo, hi int64, delta bool, set map[string]struct{},
+) (int, error) {
+	placeholders := make([]string, len(codes))
+	args := []any{payloadTypeAdvert}
+	for i, c := range codes {
+		placeholders[i] = "?"
+		args = append(args, c)
+	}
+	args = append(args, lo, hi)
+
+	joinCond := "obs.rowid = o.observer_idx"
+	if !db.isV3() {
+		joinCond = "obs.id = o.observer_id"
+	}
+	join := "JOIN"
+	if delta {
+		join = "CROSS JOIN"
+	}
+	// Only fixed fragments and "?" placeholders are formatted in; every value
+	// is bound. Use the indexed from_pubkey for current ADVERTs, but legacy
+	// rows can predate its asynchronous backfill. JSON_EXTRACT preserves the
+	// fork's existing region membership for those rows.
+	q := fmt.Sprintf(`SELECT DISTINCT COALESCE(t.from_pubkey, JSON_EXTRACT(t.decoded_json, '$.pubKey'))
+		FROM observations o
+		%[1]s transmissions t ON t.id = o.transmission_id
+		%[1]s observers obs ON %[2]s
+		WHERE t.payload_type = ?
+		AND COALESCE(t.from_pubkey, JSON_EXTRACT(t.decoded_json, '$.pubKey')) IS NOT NULL
+		AND UPPER(TRIM(obs.iata)) IN (%[3]s)
+		AND o.id > ? AND o.id <= ?`, join, joinCond, strings.Join(placeholders, ","))
+
+	rows, err := db.conn.QueryContext(ctx, q, args...)
+	if err != nil {
+		return 0, fmt.Errorf("scan region keys: %w", err)
+	}
+	defer rows.Close()
+	added := 0
+	for rows.Next() {
+		var pk string
+		if err := rows.Scan(&pk); err != nil {
+			return added, fmt.Errorf("scan region keys: %w", err)
+		}
+		if _, ok := set[pk]; !ok {
+			set[pk] = struct{}{}
+			added++
+		}
+	}
+	if err := rows.Err(); err != nil {
+		return added, fmt.Errorf("scan region keys: %w", err)
+	}
+	return added, nil
+}