Merge branch 'develop' of github.com:verida/storage-node into develop

README.md

@@ -156,15 +156,18 @@ docker buildx build --platform linux/amd64,linux/arm64 --push -t verida/storage-
 
 Run tests with `yarn run tests`
 
+You will need to update `/test/config.js` with at least the `VDA_PRIVATE_KEY`, `DID_CLIENT_CONFIG.web3Config.privateKey` 
+and possibily `ENDPOINTS` and `SERVER_URL`.
+
 Common issues when running tests:
 
 1. `Bad key`: The key in CouchDB configuration for `jwt_keys/hmac:_default` is not a valid Base64 encoded key
 2. `HMAC error`: The key in CouchDB configuration for `jwt_keys/hmac:_default` does not match `ACCESS_JWT_SIGN_PK` in `.env`
 
 
-## Testing a deplyed node
+## Testing a deployed node
 
 To test a deployed node, do the following
 
-* Modify `tests/config.js` with the correct endpoint URLs
+* Modify `test/config.js` with the correct endpoint URLs
 * Run `yarn test test/server.js`

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verida/storage-node",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "Verida Storage Node middleware that bridges decentralised identities so they can control access to databases within a CouchDB storage engine",
   "main": "dist/server.js",
   "scripts": {

src/build.js

@@ -1 +1 @@
-export const BUILD_DETAILS = {buildTimestamp: "2023-05-04T01:33:06+00:00"};
+export const BUILD_DETAILS = {buildTimestamp: "2023-07-21T04:18:40+00:00"};

src/components/db.js

@@ -1,8 +1,5 @@
-import dotenv from 'dotenv';
-import CouchDb from 'nano';
 import Axios from 'axios';
-
-dotenv.config();
+import CouchDb from 'nano';
 
 class Db {
 
@@ -50,6 +47,23 @@ class Db {
         return info.doc_count
     }
 
+    // Get some useful couch statistics and metrics to include in the status
+    async getCouchStats() {
+        const dsn = this.buildDsn(process.env.DB_USER, process.env.DB_PASS, 'internal');
+
+        try {
+            const metrics = await Axios.get(`${dsn}/_node/_local/_stats/couchdb/`);
+            return {
+                requestMeanTimeMS: metrics.data['request_time']['value']['arithmetic_mean'],
+                requestTimeStdDevMS: metrics.data['request_time']['value']['standard_deviation'],
+                continuousChangesClientCount: metrics.data['httpd']['clients_requesting_changes']['value']
+            }
+        } catch (err) {
+            console.log(err);
+            return undefined
+        }
+    }
+
 }
 
 const db = new Db()

src/controllers/system.js

@@ -12,12 +12,14 @@ import { BUILD_DETAILS } from '../build';
 class SystemController {
 
     async status(req, res) {
-        const currentUsers = await db.totalUsers()
+        const storageSlotsUsed = await db.totalUsers();
+        const metrics = await db.getCouchStats();
         const wallet = new ethers.Wallet(process.env.VDA_PRIVATE_KEY)
 
         const results = {
-            maxUsers: parseInt(process.env.MAX_USERS),
-            currentUsers,
+            maxStorageSlots: parseInt(process.env.MAX_USERS),
+            storageSlotsUsed,
+            metrics: metrics,
             version: packageJson.version,
             publicKey: wallet.publicKey,
             couchUri: db.buildHost(),

test/server.js

@@ -354,9 +354,13 @@ describe("Server tests", function() {
         it("Status", async () => {
             const response = await Axios.get(`${SERVER_URL}/status`);
 
-            assert.equal(response.data.results.maxUsers, process.env.MAX_USERS, 'Correct maximum number of users')
-            assert.ok(response.data.results.currentUsers > 2, 'At least two users')
-            assert.ok(response.data.results.version && response.data.results.version.length, 'Version specified')
+            assert.equal(response.data.results.maxUsers, process.env.MAX_USERS, 'Correct maximum number of users');
+            assert.ok(response.data.results.currentUsers > 2, 'At least two users');
+            assert.ok(response.data.results.version && response.data.results.version.length, 'Version specified');
+            assert.ok(response.data.results.metrics && response.data.results.metrics.length === 3, 'Metrics exist');
+            assert.ok(response.data.results.metrics.continuousChangesClientCount >= 0, 'Metric continuousChangesClientCount is in expected range');
+            assert.ok(response.data.results.metrics.requestMeanTimeMS >= 0, 'Metric requestMeanTimeMS is in expected range');
+            assert.ok(response.data.results.metrics.requestTimeStdDevMS >= 0, 'Metric requestTimeStdDevMS is in expected range');
         })
     })
 })