feat(api): add memoryUsage to stats info

zhibirc · Dec 12, 2023 · 2d27b08 · 2d27b08
1 parent 1bb5934
commit 2d27b08
Show file tree

Hide file tree

Showing 8 changed files with 71 additions and 22 deletions.
diff --git a/fifo-cache/index.d.ts b/fifo-cache/index.d.ts
@@ -7,6 +7,14 @@ declare class FifoCache implements ICache {
         capacity: number;
         locked: boolean;
         hitRatio: number;
+        memoryUsage: {
+            rss: number;
+            heapTotal: number;
+            heapUsed: number;
+            external: number;
+            arrayBuffers: number;
+            freeTotalRatio: number;
+        };
     };
     set lock(state: boolean);
     /**

diff --git a/fifo-cache/index.js b/fifo-cache/index.js
@@ -1,3 +1,4 @@
+import os from 'node:os';
 const Node = (data, next = null, prev = null) => ({ data, next, prev });
 class FifoCache {
     #hits;
@@ -17,7 +18,9 @@ class FifoCache {
         this.#locked = false;
         // store is a Doubly Linked List to support fast add (to tail) and delete (from head) records,
         // as well as effective deletion
+        // points to first node (head) of the list
         this.#head = null;
+        // points to last node (tail) of the list
         this.#tail = null;
         // struct for fast access to cache records, use as <key:node> lookup table
         // to compensate O(N) bottleneck to search node in such list
@@ -28,7 +31,11 @@ class FifoCache {
             size: this.#map.size,
             capacity: this.#capacity,
             locked: this.#locked,
-            hitRatio: this.#hits / (this.#hits + this.#misses)
+            hitRatio: this.#hits / (this.#hits + this.#misses),
+            memoryUsage: {
+                freeTotalRatio: Math.round(os.freemem() / os.totalmem() * 100) / 100,
+                ...process.memoryUsage()
+            }
         };
     }
     set lock(state) {
@@ -52,20 +59,20 @@ class FifoCache {
         // check if cache capacity limit is reached
         if (this.#map.size === this.#capacity) {
             // evict head since we are out of capacity
-            const head = this.#head;
-            this.#head = head.next;
-            head.next = null;
-            this.#head.prev = null;
-            this.#map.delete(head.data.key);
+            this.#map.delete(this.#head.data.key);
+            this.#head = this.#head.next;
+            if (this.#head) {
+                this.#head.prev = null;
+            }
         }
         const node = Node({ key, value });
-        if (this.#map.size === 0) {
+        if (this.#head === null) {
             this.#head = node;
         }
-        else if (this.#map.size === 1) {
+        else if (this.#tail === null) {
             this.#tail = node;
-            this.#head.next = this.#tail;
-            this.#tail.prev = this.#head;
+            this.#head.next = node;
+            node.prev = this.#head;
         }
         else {
             this.#tail.next = node;

diff --git a/fifo-cache/index.ts b/fifo-cache/index.ts
@@ -1,11 +1,14 @@
+import os from 'node:os';
 import { ICache } from '../libs/types.js';
 
 type TNode = {
     data: {
         key: any,
         value: any
     };
+    // reference to the next node
     next: TNode | null;
+    // reference to the previous node
     prev: TNode | null;
 };
 
@@ -36,8 +39,12 @@ class FifoCache implements ICache {
 
         // store is a Doubly Linked List to support fast add (to tail) and delete (from head) records,
         // as well as effective deletion
+
+        // points to first node (head) of the list
         this.#head = null;
+        // points to last node (tail) of the list
         this.#tail = null;
+
         // struct for fast access to cache records, use as <key:node> lookup table
         // to compensate O(N) bottleneck to search node in such list
         this.#map = new Map();
@@ -48,7 +55,11 @@ class FifoCache implements ICache {
             size: this.#map.size,
             capacity: this.#capacity,
             locked: this.#locked,
-            hitRatio: this.#hits / (this.#hits + this.#misses)
+            hitRatio: this.#hits / (this.#hits + this.#misses),
+            memoryUsage: {
+                freeTotalRatio: Math.round(os.freemem() / os.totalmem() * 100) / 100,
+                ...process.memoryUsage()
+            }
         };
     }
 
@@ -76,21 +87,21 @@ class FifoCache implements ICache {
         // check if cache capacity limit is reached
         if (this.#map.size === this.#capacity) {
             // evict head since we are out of capacity
-            const head = this.#head;
-            this.#head = head.next;
-            head.next = null;
-            this.#head.prev = null;
-            this.#map.delete(head.data.key);
+            this.#map.delete(this.#head.data.key);
+            this.#head = this.#head.next;
+            if (this.#head) {
+                this.#head.prev = null;
+            }
         }
 
         const node: TNode = Node({key, value});
 
-        if (this.#map.size === 0) {
+        if (this.#head === null) {
             this.#head = node;
-        } else if (this.#map.size === 1) {
+        } else if (this.#tail === null) {
             this.#tail = node;
-            this.#head.next = this.#tail;
-            this.#tail.prev = this.#head;
+            this.#head.next = node;
+            node.prev = this.#head;
         } else {
             this.#tail.next = node;
             node.prev = this.#tail;

diff --git a/libs/filters/bloom/readme.md b/libs/filters/bloom/readme.md
@@ -0,0 +1,3 @@
+## More information
+
+[Mnemonist: Bloom Filter](https://yomguithereal.github.io/mnemonist/bloom-filter)
diff --git a/libs/types.ts b/libs/types.ts
@@ -7,6 +7,8 @@ type TStats = {
     locked: boolean;
     // measures how effective a cache is at fulfilling requests
     hitRatio: number;
+    // object describing the memory usage of the process
+    memoryUsage: Record<string, number>;
     // @todo: may contain other props like cache misses, etc.
 }
 

diff --git a/rr-cache/index.d.ts b/rr-cache/index.d.ts
@@ -7,6 +7,14 @@ declare class RRCache implements ICache {
         capacity: number;
         locked: boolean;
         hitRatio: number;
+        memoryUsage: {
+            rss: number;
+            heapTotal: number;
+            heapUsed: number;
+            external: number;
+            arrayBuffers: number;
+            freeTotalRatio: number;
+        };
     };
     set lock(state: boolean);
     /**

diff --git a/rr-cache/index.js b/rr-cache/index.js
@@ -1,3 +1,4 @@
+import os from 'node:os';
 class RRCache {
     #hits;
     #misses;
@@ -23,7 +24,11 @@ class RRCache {
             size: this.#store.size,
             capacity: this.#capacity,
             locked: this.#locked,
-            hitRatio: this.#hits / (this.#hits + this.#misses)
+            hitRatio: this.#hits / (this.#hits + this.#misses),
+            memoryUsage: {
+                freeTotalRatio: Math.round(os.freemem() / os.totalmem() * 100) / 100,
+                ...process.memoryUsage()
+            }
         };
     }
     set lock(state) {

diff --git a/rr-cache/index.ts b/rr-cache/index.ts
@@ -1,3 +1,4 @@
+import os from 'node:os';
 import { ICache } from '../libs/types.js';
 
 class RRCache implements ICache {
@@ -28,7 +29,11 @@ class RRCache implements ICache {
             size: this.#store.size,
             capacity: this.#capacity,
             locked: this.#locked,
-            hitRatio: this.#hits / (this.#hits + this.#misses)
+            hitRatio: this.#hits / (this.#hits + this.#misses),
+            memoryUsage: {
+                freeTotalRatio: Math.round(os.freemem() / os.totalmem() * 100) / 100,
+                ...process.memoryUsage()
+            }
         };
     }