feat(cmd-socketio-server): support multiple BLP in single server

- Add support for starting Cactus CMD SocketIO server with multiple Bussiness Logic Plugins (BLP). All required TransactionManagement request should be routed to the correct BLP. - Add optional onListening callback when starting the cactus cmd socketio server, to simplify tests. - Fix some bugs and hard-coded BLP Ids in TransactionManagement. - Add new unit tests to check newly added functionalities. Closes #2102 Depends on #2030 Signed-off-by: Michal Bajer <[email protected]>
hyperledger-cacti · Nov 29, 2022 · 0f67085 · 0f67085
1 parent 1b352c2
commit 0f67085
Show file tree

Hide file tree

Showing 12 changed files with 533 additions and 54 deletions.
diff --git a/packages/cactus-cmd-socketio-server/package.json b/packages/cactus-cmd-socketio-server/package.json
@@ -42,7 +42,8 @@
     "@types/escape-html": "1.0.1",
     "@types/http-errors": "1.6.3",
     "@types/morgan": "1.9.1",
-    "@types/shelljs": "^0.8.11",
+    "@types/shelljs": "0.8.11",
+    "http-terminator": "3.2.0",
     "ts-node": "8.9.1"
   },
   "publishConfig": {

diff --git a/packages/cactus-cmd-socketio-server/src/main/typescript/business-logic-plugin/BLP_config.ts b/packages/cactus-cmd-socketio-server/src/main/typescript/business-logic-plugin/BLP_config.ts
@@ -7,17 +7,24 @@
 
 import { BusinessLogicPlugin } from "./BusinessLogicPlugin";
 
-let _blp: BusinessLogicPlugin | null = null;
+// Singleton of BLPs
+let _blpMapping = new Map<string, BusinessLogicPlugin>();
 
 export function getTargetBLPInstance(
   businessLogicID: string,
 ): BusinessLogicPlugin | null {
-  return _blp;
+  return _blpMapping.get(businessLogicID) ?? null;
 }
 
 export function setTargetBLPInstance(
   businessLogicID: string,
   blp: BusinessLogicPlugin,
 ) {
-  _blp = blp;
-}
+  _blpMapping.set(businessLogicID, blp);
+}
+
+export function deleteTargetBLPInstance(
+  businessLogicID: string,
+) {
+  return _blpMapping.delete(businessLogicID);
+}
diff --git a/...cactus-cmd-socketio-server/src/main/typescript/business-logic-plugin/BusinessLogicBase.ts b/...cactus-cmd-socketio-server/src/main/typescript/business-logic-plugin/BusinessLogicBase.ts
@@ -83,8 +83,10 @@ export class BusinessLogicBase implements BusinessLogicPlugin {
     return null;
   }
 
+  // This function is optional in setup with single BLP,
+  // that's why value true is returned (to indicate that given Tx always belong to this BLP)
   hasTxIDInTransactions(txID: string): boolean {
     // NOTE: This method implements the BisinessLogcPlugin operation(* Override by subclass)
-    return false;
+    return true;
   }
 }
diff --git a/.../cactus-cmd-socketio-server/src/main/typescript/routing-interface/CactusSocketIOServer.ts b/.../cactus-cmd-socketio-server/src/main/typescript/routing-interface/CactusSocketIOServer.ts
@@ -29,10 +29,17 @@ export type BLPConfig = {
   plugin: BusinessLogicPlugin;
 };
 
-export function startCactusSocketIOServer(blp?: BLPConfig) {
+export function startCactusSocketIOServer(blp?: BLPConfig | BLPConfig[], onListening?: () => void) {
   if (blp) {
-    logger.info("Using BLP with id =", blp.id);
-    setTargetBLPInstance(blp.id, blp.plugin);
+      // Support both single and multiple BLPs
+      if(!Array.isArray(blp)) {
+        blp = [blp];
+      }
+
+      blp.forEach((cfg) => {
+        logger.info("Using BLP with id =", cfg.id);
+        setTargetBLPInstance(cfg.id, cfg.plugin);
+      });
   }
 
   runExpressApp();
@@ -85,15 +92,16 @@ export function startCactusSocketIOServer(blp?: BLPConfig) {
   /**
    * Event listener for HTTP server "listening" event.
    */
-
-  function onListening(): void {
-    const addr = server.address();
-    if (addr) {
-      const bind =
-        typeof addr === "string" ? "pipe " + addr : "port " + addr.port;
-      debugModule("Listening on " + bind);
-    } else {
-      throw new Error("Could not get server address!");
+  if (!onListening) {
+    onListening = () => {
+      const addr = server.address();
+      if (addr) {
+        const bind =
+          typeof addr === "string" ? "pipe " + addr : "port " + addr.port;
+        debugModule("Listening on " + bind);
+      } else {
+        throw new Error("Could not get server address!");
+      }
     }
   }
 

diff --git a/...cactus-cmd-socketio-server/src/main/typescript/routing-interface/TransactionManagement.ts b/...cactus-cmd-socketio-server/src/main/typescript/routing-interface/TransactionManagement.ts
@@ -8,15 +8,10 @@
 import { Request } from "express";
 import { BusinessLogicPlugin } from "../business-logic-plugin/BusinessLogicPlugin";
 import { BLPRegistry } from "./util/BLPRegistry";
-import { LPInfoHolder } from "./util/LPInfoHolder";
-import { json2str } from "../verifier/DriverCommon";
-import { Verifier } from "../verifier/Verifier";
 import { IVerifierEventListener, LedgerEvent } from "../verifier/LedgerPlugin";
 import { getTargetBLPInstance } from "../business-logic-plugin/BLP_config";
 import { ConfigUtil } from "./util/ConfigUtil";
 
-const fs = require("fs");
-const path = require("path");
 const config: any = ConfigUtil.getConfig();
 import { getLogger } from "log4js";
 const moduleName = "TransactionManagement";
@@ -117,22 +112,20 @@ export class TransactionManagement implements IVerifierEventListener {
 
     // object judgment
     let result: {} = {};
-    if (businessLogicID === "h40Q9eMD") {
-      const blp = getTargetBLPInstance(businessLogicID);
-      if (blp === null) {
-        logger.warn(
-          `##startBusinessLogic(): not found BusinessLogicPlugin. businessLogicID: ${businessLogicID}`,
-        );
-        return undefined;
-      }
+    const blp = getTargetBLPInstance(businessLogicID);
+    if (blp === null) {
+      logger.warn(
+        `##startBusinessLogic(): not found BusinessLogicPlugin. businessLogicID: ${businessLogicID}`,
+      );
+      return undefined;
+    }
 
-      logger.debug("created instance");
+    logger.debug("created instance");
 
-      // Set business logic config
-      logger.debug(`meterParams = ${req.body.meterParams}`);
-      result = blp.setConfig(req.body.meterParams);
-      logger.debug("set business logic config");
-    }
+    // Set business logic config
+    logger.debug(`meterParams = ${req.body.meterParams}`);
+    result = blp.setConfig(req.body.meterParams);
+    logger.debug("set business logic config");
 
     return result;
   }
@@ -271,12 +264,12 @@ export class TransactionManagement implements IVerifierEventListener {
         continue;
       }
 
-      //            if (blp.hasTxIDInTransactions(txID)) {
-      logger.debug(
-        `####getBLPInstanceFromTxID(): found!, businessLogicID: ${businessLogicID}`,
-      );
-      return blp;
-      //            }
+      if (blp.hasTxIDInTransactions(txID)) {
+        logger.debug(
+          `####getBLPInstanceFromTxID(): found!, businessLogicID: ${businessLogicID}`,
+        );
+        return blp;
+      }
     }
 
     // not found.

diff --git a/packages/cactus-cmd-socketio-server/src/test/typescript/unit/Verifier.test.ts b/packages/cactus-cmd-socketio-server/src/test/typescript/unit/Verifier.test.ts
@@ -63,7 +63,7 @@ import {
   LogLevelDesc,
 } from "@hyperledger/cactus-common";
 
-const logLevel: LogLevelDesc = "error";
+const logLevel: LogLevelDesc = "info";
 const log: Logger = LoggerProvider.getOrCreate({
   label: "test-cmd-socketio-verifier",
   level: logLevel,

diff --git a/packages/cactus-cmd-socketio-server/src/test/typescript/unit/VerifierAuthentication.test.ts b/packages/cactus-cmd-socketio-server/src/test/typescript/unit/VerifierAuthentication.test.ts
@@ -20,7 +20,7 @@ import {
   LogLevelDesc,
 } from "@hyperledger/cactus-common";
 
-const logLevel: LogLevelDesc = "error";
+const logLevel: LogLevelDesc = "info";
 const log: Logger = LoggerProvider.getOrCreate({
   label: "test-cmd-socketio-verifier",
   level: logLevel,

diff --git a/packages/cactus-cmd-socketio-server/src/test/typescript/unit/VerifierFactory.test.ts b/packages/cactus-cmd-socketio-server/src/test/typescript/unit/VerifierFactory.test.ts
@@ -19,7 +19,7 @@ import {
   LogLevelDesc,
 } from "@hyperledger/cactus-common";
 
-const logLevel: LogLevelDesc = "error";
+const logLevel: LogLevelDesc = "info";
 const log: Logger = LoggerProvider.getOrCreate({
   label: "test-cmd-socketio-verifier",
   level: logLevel,