feat(scheduler-utils): add address to return. remove setTimeouts in f…

…avor of lru-cache ttl

scheduler-utils/README.md

@@ -46,7 +46,7 @@ Locate the `ao` Scheduler assigned to an `ao` Process.
 ```js
 import { locate } from "@permaweb/ao-scheduler-utils";
 
-let { url } = await locate('<process-id>');
+let { url, owner } = await locate('<process-id>');
 ```
 
 #### `validate`

scheduler-utils/package.json

@@ -26,7 +26,7 @@
     "test": "node --test ./src"
   },
   "dependencies": {
-    "mnemonist": "^0.39.6",
+    "lru-cache": "^10.1.0",
     "ramda": "^0.29.1"
   },
   "devDependencies": {

scheduler-utils/src/client/in-memory.js

@@ -1,14 +1,30 @@
-import LruCache from 'mnemonist/lru-cache-with-delete.js'
+import { LRUCache } from 'lru-cache'
 
 /**
- * @type {LruCache}
+ * @type {LRUCache}
  */
 let internalCache
 let internalSize
 export function createLruCache ({ size }) {
   if (internalCache) return internalCache
   internalSize = size
-  internalCache = new LruCache(size)
+  internalCache = new LRUCache({
+    /**
+     * number of entries
+     */
+    max: size,
+    /**
+     * max size of cache, as a scalar.
+     *
+     * In our case, characters (see sizeCalculation)
+     */
+    maxSize: 1_000_000 * 5,
+    /**
+     * Simply stringify to get the bytes
+     */
+    sizeCalculation: (v) => JSON.stringify(v).length,
+    allowStale: true
+  })
   return internalCache
 }
 
@@ -20,10 +36,9 @@ export function getByProcessWith ({ cache = internalCache }) {
 }
 
 export function setByProcessWith ({ cache = internalCache }) {
-  return async (process, url, ttl) => {
+  return async (process, { url, owner }, ttl) => {
     if (!internalSize) return
-    setTimeout(() => cache.delete(process), ttl)
-    return cache.set(process, url)
+    return cache.set(process, { url, owner }, { ttl })
   }
 }
 
@@ -35,9 +50,8 @@ export function getByOwnerWith ({ cache = internalCache }) {
 }
 
 export function setByOwnerWith ({ cache = internalCache }) {
-  return async (owner, url, ttl) => {
+  return async (owner, { url }, ttl) => {
     if (!internalSize) return
-    setTimeout(() => cache.delete(owner), ttl)
-    return cache.set(owner, url)
+    return cache.set(owner, { url, address: owner }, { ttl })
   }
 }

scheduler-utils/src/client/in-memory.test.js

@@ -20,37 +20,33 @@ describe('in-memory', () => {
     const getByProcess = getByProcessWith({ cache })
     test('returns the url if in cache', async () => {
       assert.equal(await getByProcess(PROCESS), undefined)
-      cache.set(PROCESS, DOMAIN)
-      assert.equal(await getByProcess(PROCESS), DOMAIN)
+      cache.set(PROCESS, { url: DOMAIN, address: SCHEDULER })
+      assert.deepStrictEqual(await getByProcess(PROCESS), { url: DOMAIN, address: SCHEDULER })
     })
   })
 
   describe('getByOwnerWith', () => {
     const getByOwner = getByOwnerWith({ cache })
     test('returns the url if in cache', async () => {
       assert.equal(await getByOwner(SCHEDULER), undefined)
-      cache.set(SCHEDULER, DOMAIN)
-      assert.equal(await getByOwner(SCHEDULER), DOMAIN)
+      cache.set(SCHEDULER, { url: DOMAIN, address: SCHEDULER })
+      assert.deepStrictEqual(await getByOwner(SCHEDULER), { url: DOMAIN, address: SCHEDULER })
     })
   })
 
   describe('setByProcessWith', () => {
     const setByProcess = setByProcessWith({ cache })
-    test('sets the value in cache and removes after ttl', async () => {
+    test('sets the value in cache', async () => {
       await setByProcess(PROCESS, DOMAIN, TEN_MS)
       assert.ok(cache.has(PROCESS))
-      await new Promise(resolve => setTimeout(resolve, TEN_MS))
-      assert.equal(cache.get(PROCESS), undefined)
     })
   })
 
   describe('setByOwnerWith', () => {
     const setByOwner = setByOwnerWith({ cache })
-    test('sets the value in cache and removes after ttl', async () => {
+    test('sets the value in cache', async () => {
       await setByOwner(SCHEDULER, DOMAIN, TEN_MS)
       assert.ok(cache.has(SCHEDULER))
-      await new Promise(resolve => setTimeout(resolve, TEN_MS))
-      assert.equal(cache.get(SCHEDULER), undefined)
     })
   })
 })

scheduler-utils/src/locate.js

@@ -6,20 +6,19 @@ export function locateWith ({ loadProcessScheduler, cache }) {
    * of decentralized sequencers
    *
    * @param {string} process - the id of the process
-   * @returns {Promise<{ url: string }>} - an object whose url field is the Scheduler Location
+   * @returns {Promise<{ url: string, address: string }>} - an object whose url field is the Scheduler Location
    */
   return (process) =>
     cache.getByProcess(process)
-      .then((url) => {
-        if (url) return url
+      .then((cached) => {
+        if (cached) return cached
         return loadProcessScheduler(process)
           .then((scheduler) => {
             return Promise.all([
-              cache.setByProcess(process, scheduler.url, scheduler.ttl),
+              cache.setByProcess(process, { url: scheduler.url, address: scheduler.owner }, scheduler.ttl),
               cache.setByOwner(scheduler.owner, scheduler.url, scheduler.ttl)
             ])
-              .then(() => scheduler.url)
+              .then(() => ({ url: scheduler.url, address: scheduler.owner }))
           })
       })
-      .then((url) => ({ url }))
 }

scheduler-utils/src/locate.test.js

@@ -20,9 +20,10 @@ describe('locateWith', () => {
           assert.equal(process, PROCESS)
           return undefined
         },
-        setByProcess: async (process, url, ttl) => {
+        setByProcess: async (process, { url, address }, ttl) => {
           assert.equal(process, PROCESS)
           assert.equal(url, DOMAIN)
+          assert.equal(address, SCHEDULER)
           assert.equal(ttl, TEN_MS)
         },
         setByOwner: async (owner, url, ttl) => {
@@ -34,7 +35,7 @@ describe('locateWith', () => {
     })
 
     await locate(PROCESS)
-      .then((res) => assert.deepStrictEqual(res, { url: DOMAIN }))
+      .then((res) => assert.deepStrictEqual(res, { url: DOMAIN, address: SCHEDULER }))
   })
 
   test('should serve the cached value', async () => {
@@ -45,12 +46,12 @@ describe('locateWith', () => {
       cache: {
         getByProcess: async (process) => {
           assert.equal(process, PROCESS)
-          return DOMAIN
+          return { url: DOMAIN, address: SCHEDULER }
         }
       }
     })
 
     await locate(PROCESS)
-      .then((res) => assert.deepStrictEqual(res, { url: DOMAIN }))
+      .then((res) => assert.deepStrictEqual(res, { url: DOMAIN, address: SCHEDULER }))
   })
 })

scheduler-utils/src/raw.test.js

@@ -60,7 +60,7 @@ describe('rawWith', () => {
       cache: {
         getByOwner: async (walletAddress) => {
           assert.equal(walletAddress, SCHEDULER)
-          return DOMAIN
+          return { url: DOMAIN, address: SCHEDULER }
         }
       }
     })

scheduler-utils/src/validate.test.js

@@ -65,7 +65,7 @@ describe('validateWith', () => {
       cache: {
         getByOwner: async (walletAddress) => {
           assert.equal(walletAddress, SCHEDULER)
-          return DOMAIN
+          return { url: DOMAIN, address: SCHEDULER }
         }
       }
     })