@ocap/statedb 1.20.16 → 1.21.0

package/lib/table.js

@@ -1,4 +1,6 @@
+/* eslint-disable no-shadow */
 /* eslint-disable no-underscore-dangle */
+const crypto = require('crypto');
 const Kareem = require('kareem');
 const omit = require('lodash/omit');
 const pick = require('lodash/pick');
@@ -7,9 +9,12 @@ const { isValid } = require('@arcblock/did');
 const { toAddress } = require('@ocap/util');
 
 class StateDBTable extends Ready {
-  constructor() {
+  constructor(uniqIndex) {
     super();
 
+    this.uniqIndex = uniqIndex;
+    this.primaryKey = typeof uniqIndex === 'string' ? uniqIndex : 'id';
+
     const hooks = new Kareem();
 
     Object.defineProperty(this, 'pre', { value: (name, fn) => hooks.pre(name, fn) });
@@ -93,6 +98,45 @@ class StateDBTable extends Ready {
   updateOrCreate(id, attrs, context) {
     throw new Error('`updateOrCreate` must be implemented in sub statedb');
   }
+
+  /**
+   * Generate an ID composed of multiple primary keys
+   */
+  generatePrimaryKey(doc) {
+    if (typeof doc === 'string') {
+      return doc;
+    }
+
+    // composite primary key
+    if (Array.isArray(this.uniqIndex)) {
+      const key = this.uniqIndex
+        .map((id) => doc[id])
+        .map((item) => (typeof item === 'object' ? JSON.stringify(item) : item))
+        .join('-');
+      return crypto.createHash('md5').update(key).digest('hex');
+    }
+
+    return doc[this.uniqIndex];
+  }
+
+  /** update cache for context */
+  updateCache(data, context) {
+    if (!context) return;
+    if (!context.cacheStates?.[this.name]) {
+      context.cacheStates = context.cacheStates || {};
+      context.cacheStates[this.name] = {};
+    }
+
+    const cacheKey = this.generatePrimaryKey(data);
+    context.cacheStates[this.name][cacheKey] = data;
+  }
+
+  /** get data from cache for context */
+  getCache(key, context) {
+    const cacheStates = context.cacheStates || {};
+    const cacheKey = this.generatePrimaryKey(key);
+    return cacheStates[this.name]?.[cacheKey] || null;
+  }
 }
 
 module.exports = StateDBTable;

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.20.16",
+  "version": "1.21.0",
   "description": "Defines the basic interface for OCAP StateDB",
   "main": "lib/index.js",
   "files": [
@@ -18,9 +18,9 @@
   "dependencies": {
     "kareem": "^2.4.1",
     "lodash": "^4.17.21",
-    "@ocap/state": "1.20.16",
-    "@ocap/util": "1.20.16",
-    "@arcblock/did": "1.20.16"
+    "@arcblock/did": "1.21.0",
+    "@ocap/state": "1.21.0",
+    "@ocap/util": "1.21.0"
   },
   "scripts": {
     "lint": "eslint tests lib",