optimize replaceable event loader cache times

.changeset/few-doors-dress.md

@@ -0,0 +1,5 @@
+---
+"nostrudel": patch
+---
+
+Optimize caching time for user metadata events

package.json

@@ -31,6 +31,7 @@
     "leaflet": "^1.9.4",
     "leaflet.locatecontrol": "^0.79.0",
     "light-bolt11-decoder": "^3.0.0",
+    "lodash.throttle": "^4.1.1",
     "match-sorter": "^6.3.1",
     "nanoid": "^4.0.2",
     "ngeohash": "^0.6.3",
@@ -55,6 +56,7 @@
     "@types/identicon.js": "^2.3.1",
     "@types/leaflet": "^1.9.3",
     "@types/leaflet.locatecontrol": "^0.74.1",
+    "@types/lodash.throttle": "^4.1.7",
     "@types/ngeohash": "^0.6.4",
     "@types/react": "^18.2.20",
     "@types/react-dom": "^18.2.7",

src/services/replaceable-event-requester.ts

@@ -1,5 +1,7 @@
 import dayjs from "dayjs";
 import debug, { Debugger } from "debug";
+import _throttle from "lodash/throttle";
+
 import { NostrSubscription } from "../classes/nostr-subscription";
 import { SuperMap } from "../classes/super-map";
 import { NostrEvent } from "../types/nostr-event";
@@ -9,6 +11,7 @@ import { logger } from "../helpers/debug";
 import db from "./db";
 import { nameOrPubkey } from "./user-metadata";
 import { getEventCoordinate } from "../helpers/nostr/events";
+import createDefer, { Deferred } from "../classes/deferred";
 
 type Pubkey = string;
 type Relay = string;
@@ -66,11 +69,13 @@ class ReplaceableEventRelayLoader {
 
     if (!event.value) {
       this.requestNext.add(cord);
+      this.updateThrottle();
     }
 
     return event;
   }
 
+  updateThrottle = _throttle(this.update, 1000);
   update() {
     let needsUpdate = false;
     for (const cord of this.requestNext) {
@@ -137,15 +142,16 @@ class ReplaceableEventLoaderService {
   );
 
   log = logger.extend("ReplaceableEventLoader");
+  dbLog = this.log.extend("database");
 
-  handleEvent(event: NostrEvent) {
+  handleEvent(event: NostrEvent, saveToCache = true) {
     const cord = getEventCoordinate(event);
 
     const sub = this.events.get(cord);
     const current = sub.value;
     if (!current || event.created_at > current.created_at) {
       sub.next(event);
-      this.saveToCache(cord, event);
+      if (saveToCache) this.saveToCache(cord, event);
     }
   }
 
@@ -153,37 +159,71 @@ class ReplaceableEventLoaderService {
     return this.events.get(createCoordinate(kind, pubkey, d));
   }
 
+  private readFromCachePromises = new Map<string, Deferred<boolean>>();
+  private readFromCacheThrottle = _throttle(this.readFromCache, 1000);
+  private async readFromCache() {
+    if (this.readFromCachePromises.size === 0) return;
+
+    this.dbLog(`Reading ${this.readFromCachePromises.size} events from database`);
+    const transaction = db.transaction("replaceableEvents", "readonly");
+    for (const [cord, promise] of this.readFromCachePromises) {
+      transaction
+        .objectStore("replaceableEvents")
+        .get(cord)
+        .then((cached) => {
+          if (cached?.event) {
+            this.handleEvent(cached.event, false);
+            promise.resolve(true);
+          }
+          promise.resolve(false);
+        });
+    }
+    this.readFromCachePromises.clear();
+    transaction.commit();
+    await transaction.done;
+  }
   private loadCacheDedupe = new Map<string, Promise<boolean>>();
   private loadFromCache(cord: string) {
     const dedupe = this.loadCacheDedupe.get(cord);
     if (dedupe) return dedupe;
 
-    const promise = db.get("replaceableEvents", cord).then((cached) => {
-      this.loadCacheDedupe.delete(cord);
-      if (cached?.event) {
-        this.handleEvent(cached.event);
-        return true;
-      }
-      return false;
-    });
+    // add to read queue
+    const promise = createDefer<boolean>();
+    this.readFromCachePromises.set(cord, promise);
 
     this.loadCacheDedupe.set(cord, promise);
+    this.readFromCacheThrottle();
 
     return promise;
   }
+
+  private writeCacheQueue = new Map<string, NostrEvent>();
+  private writeToCacheThrottle = _throttle(this.writeToCache, 1000);
+  private async writeToCache() {
+    if (this.writeCacheQueue.size === 0) return;
+
+    this.dbLog(`Writing ${this.writeCacheQueue.size} events to database`);
+    const transaction = db.transaction("replaceableEvents", "readwrite");
+    for (const [cord, event] of this.writeCacheQueue) {
+      transaction.objectStore("replaceableEvents").put({ addr: cord, event, created: dayjs().unix() });
+    }
+    this.writeCacheQueue.clear();
+    transaction.commit();
+    await transaction.done;
+  }
   private async saveToCache(cord: string, event: NostrEvent) {
-    await db.put("replaceableEvents", { addr: cord, event, created: dayjs().unix() });
+    this.writeCacheQueue.set(cord, event);
+    this.writeToCacheThrottle();
   }
 
-  async pruneCache() {
+  async pruneDatabaseCache() {
     const keys = await db.getAllKeysFromIndex(
       "replaceableEvents",
       "created",
       IDBKeyRange.upperBound(dayjs().subtract(1, "day").unix()),
     );
 
-    this.log(`Pruning ${keys.length} events`);
-
+    this.dbLog(`Pruning ${keys.length} expired events from database`);
     const transaction = db.transaction("replaceableEvents", "readwrite");
     for (const key of keys) {
       transaction.store.delete(key);
@@ -215,9 +255,7 @@ class ReplaceableEventLoaderService {
 
     if (!sub.value) {
       this.loadFromCache(cord).then((loaded) => {
-        if (!loaded) {
-          this.requestEventFromRelays(relays, kind, pubkey, d);
-        }
+        if (!loaded) this.requestEventFromRelays(relays, kind, pubkey, d);
       });
     }
 
@@ -227,27 +265,14 @@ class ReplaceableEventLoaderService {
 
     return sub;
   }
-
-  update() {
-    for (const [relay, loader] of this.loaders) {
-      loader.update();
-    }
-  }
 }
 
 const replaceableEventLoaderService = new ReplaceableEventLoaderService();
 
-replaceableEventLoaderService.pruneCache();
-
+replaceableEventLoaderService.pruneDatabaseCache();
 setInterval(() => {
-  replaceableEventLoaderService.update();
-}, 1000 * 2);
-setInterval(
-  () => {
-    replaceableEventLoaderService.pruneCache();
-  },
-  1000 * 60 * 60,
-);
+  replaceableEventLoaderService.pruneDatabaseCache();
+}, 1000 * 60);
 
 if (import.meta.env.DEV) {
   //@ts-ignore

yarn.lock

@@ -2664,6 +2664,13 @@
   dependencies:
     "@types/lodash" "*"
 
+"@types/lodash.throttle@^4.1.7":
+  version "4.1.7"
+  resolved "https://registry.yarnpkg.com/@types/lodash.throttle/-/lodash.throttle-4.1.7.tgz#4ef379eb4f778068022310ef166625f420b6ba58"
+  integrity sha512-znwGDpjCHQ4FpLLx19w4OXDqq8+OvREa05H89obtSyXyOFKL3dDjCslsmfBz0T2FU8dmf5Wx1QvogbINiGIu9g==
+  dependencies:
+    "@types/lodash" "*"
+
 "@types/lodash@*":
   version "4.14.195"
   resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.195.tgz#bafc975b252eb6cea78882ce8a7b6bf22a6de632"
@@ -4932,6 +4939,11 @@ lodash.startcase@^4.4.0:
   resolved "https://registry.yarnpkg.com/lodash.startcase/-/lodash.startcase-4.4.0.tgz#9436e34ed26093ed7ffae1936144350915d9add8"
   integrity sha512-+WKqsK294HMSc2jEbNgpHpd0JfIBhp7rEV4aqXWqFr6AlXov+SlcgB1Fv01y2kGe3Gc8nMW7VA0SrGuSkRfIEg==
 
+lodash.throttle@^4.1.1:
+  version "4.1.1"
+  resolved "https://registry.yarnpkg.com/lodash.throttle/-/lodash.throttle-4.1.1.tgz#c23e91b710242ac70c37f1e1cda9274cc39bf2f4"
+  integrity sha512-wIkUCfVKpVsWo3JSZlc+8MB5it+2AN5W8J7YVMST30UrvcQNZ1Okbj+rbVniijTWE6FGYy4XJq/rHkas8qJMLQ==
+
 lodash@^4.17.20, lodash@^4.17.21:
   version "4.17.21"
   resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.21.tgz#679591c564c3bffaae8454cf0b3df370c3d6911c"