Merge pull request #863 from nklincoln/v032-bugfix-release

0.3.2 release candidate: web3 version change, mqtt fixes, fabric gateway fixes

.travis.yml

@@ -1,6 +1,6 @@
 language: node_js
 node_js:
-- "8"
+- "10"
 
 services:
 - docker

package.json

@@ -11,7 +11,8 @@
         "bootstrap": "lerna bootstrap",
         "pretest": "npm run licchk",
         "licchk": "license-check-and-add",
-        "test": "lerna run test"
+        "test": "lerna run test",
+        "version-fix": "node ./packages/caliper-publish/publish.js version fix"
     },
     "engines": {
         "node": ">=8.10.0",

packages/caliper-cli/lib/lib/config.yaml

@@ -32,20 +32,20 @@ sut:
         # The name/key of the SDK binding
         1.0.0:
             # Specifies the packages and their versions to install
-            packages: ['[email protected]', '[email protected]', '[email protected]', '[email protected]', '[email protected]']
+            packages: ['[email protected]', '[email protected]', '[email protected]', '[email protected]']
             # The settings to apply during binding. The first setting whose versionRegexp matches the node version will be used
             settings:
             - *new-node-old-grpc
         1.1.0:
-            packages: ['[email protected]', '[email protected]', '[email protected]', '[email protected]', '[email protected]']
+            packages: ['[email protected]', '[email protected]', '[email protected]', '[email protected]']
             settings:
             - *new-node-old-grpc
         1.2.0:
-            packages: ['[email protected]', '[email protected]', '[email protected]', '[email protected]', '[email protected]']
+            packages: ['[email protected]', '[email protected]', '[email protected]', '[email protected]']
             settings:
             - *new-node-old-grpc
         1.3.0:
-            packages: ['[email protected]', '[email protected]', '[email protected]', '[email protected]', '[email protected]']
+            packages: ['[email protected]', '[email protected]', '[email protected]', '[email protected]']
         1.4.0:
             packages: ['[email protected]', '[email protected]', '[email protected]', '[email protected]', '[email protected]']
         1.4.1:
@@ -99,14 +99,14 @@ sut:
 
     ethereum:
         1.2.1: &ethereum-latest
-            packages: ['[email protected].0']
+            packages: ['[email protected].2']
         latest: *ethereum-latest
 
     besu:
         1.3.2:
-            packages: ['[email protected].0']
+            packages: ['[email protected].2']
         1.3:
-            packages: ['[email protected].0']
+            packages: ['[email protected].2']
         1.4: &besu-latest
-            packages: ['[email protected].0']
+            packages: ['[email protected].2']
         latest: *besu-latest

packages/caliper-core/lib/common/messaging/mqtt-master.js

@@ -115,14 +115,16 @@ class MqttMasterMessenger extends MessengerInterface {
      * Clean up any resources associated with the messenger.
      */
     async dispose() {
+        Logger.info('Disconnecting from MQTT service');
         const messengerDisconnectedPromise = new Promise((resolve, reject) => {
             this.messengerDisconnectedPromise = {
                 resolve: resolve,
                 reject:  reject
             };
         });
 
-        this.mqttClient.end(false, undefined, () => {
+        this.mqttClient.end(false, {}, () => {
+            Logger.info('MQTT connection closed');
             this.messengerDisconnectedPromise.resolve();
         });
 

packages/caliper-core/lib/common/messaging/mqtt-worker.js

@@ -124,14 +124,16 @@ class MqttWorkerMessenger extends MessengerInterface {
      * Clean up any resources associated with the messenger.
      */
     async dispose() {
+        Logger.info('Disconnecting from MQTT service');
         const messengerDisconnectedPromise = new Promise((resolve, reject) => {
             this.messengerDisconnectedPromise = {
                 resolve: resolve,
                 reject:  reject
             };
         });
 
-        this.mqttClient.end(true, undefined, () => {
+        this.mqttClient.end(false, {}, () => {
+            Logger.info('MQTT connection closed');
             this.messengerDisconnectedPromise.resolve();
         });
 

packages/caliper-core/lib/common/prometheus/prometheus-push-client.js

@@ -99,7 +99,7 @@ class PrometheusPushClient {
     useGateway(method, body) {
         Logger.debug(`Prometheus client sending body ${body} to target ${this.requestParams.href}`);
         // Convert body to binary, the newline is important
-        body = new Buffer(body + '\n', 'binary');
+        body = Buffer.from(body + '\n', 'binary');
 
         // Assign request options
         const options = Object.assign(this.requestParams, {

packages/caliper-core/lib/master/orchestrators/monitor-orchestrator.js

@@ -125,6 +125,7 @@ class MonitorOrchestrator {
     * @async
     */
     async stopAllMonitors() {
+        logger.info('Stopping all monitors');
         if(this.started === true) {
 
             for (let key of this.monitors.keys()) {

packages/caliper-core/lib/master/orchestrators/worker-orchestrator.js

@@ -56,7 +56,7 @@ class WorkerOrchestrator {
         this.workerArguments = workerArguments;
 
         this.workers = {};
-        this.workerObjects = [];
+        this.workerObjects = [];        // used in the process communications
         this.updates = {id:0, data:[]}; // contains txUpdated messages
         this.results = [];              // cumulative results
 
@@ -486,16 +486,17 @@ class WorkerOrchestrator {
     }
 
     /**
-     * Stop all test workers (child processes)
+     * Stop all test workers and disconnect from messenger
      */
     async stop() {
+        logger.info('Sending exit message to connected workers');
         this.messenger.send(['all'], TYPES.EXIT, {});
-        await this.messenger.dispose();
 
-        for (let workerObject of this.workerObjects) {
-            workerObject.kill();
-        }
+        // Internally spawned workers are killed within the messenger handling of 'exit', but clean the array of processes here
         this.workerObjects = [];
+
+        // dispose of master messenger
+        await this.messenger.dispose();
     }
 
     /**
@@ -538,13 +539,13 @@ class WorkerOrchestrator {
         logger.info(`Launching worker ${index} of ${this.number}`);
 
         // Spawn the worker. The index is assigned upon connection
-        let cliPath = process.argv[1];
-        let workerCommands = ['launch', 'worker'];
-        let remainingArgs = process.argv.slice(4);
+        const cliPath = process.argv[1];
+        const workerCommands = ['launch', 'worker'];
+        const remainingArgs = process.argv.slice(4);
 
-        let nodeArgs = workerCommands.concat(remainingArgs);
+        const nodeArgs = workerCommands.concat(remainingArgs);
 
-        let worker = childProcess.fork(cliPath, nodeArgs, {
+        const worker = childProcess.fork(cliPath, nodeArgs, {
             env: process.env,
             cwd: process.cwd()
         });

packages/caliper-core/lib/master/report/report-builder.js

@@ -16,7 +16,7 @@
 
 const Config = require('../../common/config/config-util');
 const Utils = require('../../common/utils/caliper-utils');
-const Logger = Utils.getLogger('caliper-flow');
+const Logger = Utils.getLogger('report-builder');
 const fs = require('fs');
 const Mustache = require('mustache');
 const path = require('path');

packages/caliper-core/lib/worker/client/caliper-local-client.js

@@ -21,7 +21,8 @@ const bc   = require('../../common/core/blockchain.js');
 const RateControl = require('../rate-control/rateControl.js');
 const PrometheusClient = require('../../common/prometheus/prometheus-push-client');
 
-const Logger = CaliperUtils.getLogger('caliper-local-client.js');
+const Logger = CaliperUtils.getLogger('caliper-local-client');
+
 /**
  * Class for Client Interaction
  */

packages/caliper-core/lib/worker/client/message-handler.js

@@ -30,6 +30,7 @@ class MessageHandler {
      * @param {Messenger} messenger the Messenger to use for communication with the orchestrator
      */
     constructor(handlers, messenger) {
+
         if (!handlers.init) {
             let msg = 'Handler for "init" is not specified';
             logger.error(msg);
@@ -236,7 +237,7 @@ class MessageHandler {
             case 'exit': {
                 logger.info('Handling "exit" message');
                 await context.messenger.dispose();
-                logger.info(`Handled "exit" message for worker ${context.workerId}`);
+                logger.info(`Handled "exit" message for worker ${context.workerId}, exiting process`);
                 process.exit(0);
                 break;
             }

packages/caliper-fabric/lib/adaptor-versions/v1/fabric-gateway-v1.js

@@ -17,12 +17,13 @@
 const FabricClient = require('fabric-client');
 const { DefaultEventHandlerStrategies, DefaultQueryHandlerStrategies, FileSystemWallet, Gateway, InMemoryWallet, X509WalletMixin } = require('fabric-network');
 const { google, common } = require('fabric-protos');
-const { BlockchainInterface, CaliperUtils, TxStatus, Version, ConfigUtil } = require('@hyperledger/caliper-core');
+const { BlockchainInterface, CaliperUtils, TxStatus, ConfigUtil } = require('@hyperledger/caliper-core');
 const logger = CaliperUtils.getLogger('adapters/fabric');
 
 const FabricNetwork = require('../../fabricNetwork.js');
 const ConfigValidator = require('../../configValidator.js');
 const fs = require('fs');
+const semver = require('semver');
 
 const EventStrategies = {
     msp_all : DefaultEventHandlerStrategies.MSPID_SCOPE_ALLFORTX,
@@ -139,7 +140,7 @@ class Fabric extends BlockchainInterface {
         super(networkConfig);
         this.bcType = 'fabric';
         this.workspaceRoot = workspace_root;
-        this.version = new Version(require('fabric-client/package').version);
+        this.version = require('fabric-client/package').version;
 
         this.network = undefined;
         if (typeof networkConfig === 'string') {
@@ -160,6 +161,7 @@ class Fabric extends BlockchainInterface {
         this.wallet = undefined;
         this.userContracts = new Map();
         this.userGateways = new Map();
+        this.peerCache = new Map();
 
         // this value is hardcoded, if it's used, that means that the provided timeouts are not sufficient
         this.configSmallestTimeout = 1000;
@@ -189,11 +191,6 @@ class Fabric extends BlockchainInterface {
         this.fileWalletPath = this.networkUtil.getFileWalletPath();
         this.defaultInvoker = Array.from(this.networkUtil.getClients())[0];
 
-        // Network Wallet/Gateway is only available in SDK versions greater than v1.4.0
-        if (this.version.lessThan('1.4.0')) {
-            throw new Error(`Fabric SDK ${this.version.toString()} is not supported when using a Fabric Gateway object, use at least version 1.4.0`);
-        }
-
         this._prepareWallet();
     }
 
@@ -916,6 +913,7 @@ class Fabric extends BlockchainInterface {
                 strategy: EventStrategies[this.eventStrategy]
             },
             queryHandlerOptions: {
+                requestTimeout: this.configDefaultTimeout,
                 strategy: QueryStrategies[this.queryStrategy]
             }
         };
@@ -1388,6 +1386,27 @@ class Fabric extends BlockchainInterface {
         return channelJoined;
     }
 
+    /**
+     * Initialize channel objects for use in peer targeting. Requires user gateways to have been
+     * formed in advance.
+     */
+    async _initializePeerCache() {
+
+        for (const userName of this.userGateways.keys()) {
+            const gateway = this.userGateways.get(userName);
+            // Loop over known channel names
+            const channelNames = this.networkUtil.getChannels();
+            for (const channelName of channelNames) {
+                const network = await gateway.getNetwork(channelName);
+                const channel = network.getChannel();
+                // Add all peers
+                for (const peerObject of channel.getChannelPeers()) {
+                    this.peerCache.set(peerObject.getName(), peerObject);
+                }
+            }
+        }
+    }
+
     /**
      * Conditionally initializes a wallet depending on user provided options
      * @private
@@ -1500,11 +1519,11 @@ class Fabric extends BlockchainInterface {
 
         // Add transient data if present
         // - passed as key value pairing such as {"hello":"world"}
-        if (invokeSettings.transientData) {
+        if (invokeSettings.transientMap) {
             const transientData = {};
-            const keys = Array.from(Object.keys(invokeSettings.transientData));
+            const keys = Array.from(Object.keys(invokeSettings.transientMap));
             keys.forEach((key) => {
-                transientData[key] = Buffer.from(invokeSettings.transientData[key]);
+                transientData[key] = Buffer.from(invokeSettings.transientMap[key]);
             });
             transaction.setTransient(transientData);
         }
@@ -1515,10 +1534,14 @@ class Fabric extends BlockchainInterface {
             const targetPeerObjects = [];
             for (const name of invokeSettings.targetPeers) {
                 const peer = this.peerCache.get(name);
-                targetPeerObjects.push(peer);
+                if (peer) {
+                    targetPeerObjects.push(peer);
+                }
             }
             // Set the peer objects in the transaction
-            transaction.setEndorsingPeers(targetPeerObjects);
+            if (targetPeerObjects.length > 0) {
+                transaction.setEndorsingPeers(targetPeerObjects);
+            }
         }
 
         try {
@@ -1615,6 +1638,13 @@ class Fabric extends BlockchainInterface {
         // - within submit/evaluate, a contract will be used for a nominated user
         await this._initializeContracts();
 
+        // - use gateways to build a peer cache if the version supports it
+        if (semver.satisfies(semver.coerce(this.version), '>=1.4.5')) {
+            await this._initializePeerCache();
+        } else {
+            logger.warn(`Bound SDK ${this.version} is unable to use target peers; to enable target peer nomination for a gateway transaction, bind Caliper to Fabric 1.4.5 and above`);
+        }
+
         // We are done - return the networkUtil object
         return {
             networkInfo: this.networkUtil,
@@ -1763,6 +1793,9 @@ class Fabric extends BlockchainInterface {
             logger.info(`disconnecting gateway for user ${userName}`);
             gateway.disconnect();
         }
+
+        // Clear peer cache
+        this.peerCache.clear();
     }
 }
 

packages/caliper-fabric/lib/adaptor-versions/v2/fabric-gateway-v2.js

@@ -16,12 +16,13 @@
 
 const { DefaultEventHandlerStrategies, DefaultQueryHandlerStrategies, Gateway, Wallets } = require('fabric-network');
 const { BlockchainInterface, CaliperUtils, TxStatus, Version, ConfigUtil } = require('@hyperledger/caliper-core');
-const logger = CaliperUtils.getLogger('adapters/fabric');
 
 const FabricNetwork = require('../../fabricNetwork.js');
 const ConfigValidator = require('../../configValidator.js');
 const RegistrarHelper = require('./registrarHelper');
 
+const logger = CaliperUtils.getLogger('adapters/fabric');
+
 const EventStrategies = {
     msp_all : DefaultEventHandlerStrategies.MSPID_SCOPE_ALLFORTX,
     msp_any : DefaultEventHandlerStrategies.MSPID_SCOPE_ANYFORTX,
@@ -135,10 +136,6 @@ class Fabric extends BlockchainInterface {
             throw new Error('[FabricNetwork.constructor] Parameter \'networkConfig\' is neither a file path nor an object');
         }
 
-        // validate the network
-        ConfigValidator.validateNetwork(this.network, CaliperUtils.getFlowOptions(),
-            this.configDiscovery, true);
-
         this.clientIndex = clientIndex;
         this.txIndex = -1;
         this.networkUtil = new FabricNetwork(this.network, workspace_root);
@@ -159,6 +156,9 @@ class Fabric extends BlockchainInterface {
         this.configDiscovery = ConfigUtil.get(ConfigUtil.keys.Fabric.Gateway.Discovery, false);
         this.eventStrategy = ConfigUtil.get(ConfigUtil.keys.Fabric.Gateway.EventStrategy, 'msp_all');
         this.queryStrategy = ConfigUtil.get(ConfigUtil.keys.Fabric.Gateway.QueryStrategy, 'msp_single');
+
+        // validate the network
+        ConfigValidator.validateNetwork(this.network, CaliperUtils.getFlowOptions(), this.configDiscovery, true);
     }
 
     ////////////////////////////////
@@ -449,11 +449,11 @@ class Fabric extends BlockchainInterface {
 
         // Add transient data if present
         // - passed as key value pairing such as {"hello":"world"}
-        if (invokeSettings.transientData) {
+        if (invokeSettings.transientMap) {
             const transientData = {};
-            const keys = Array.from(Object.keys(invokeSettings.transientData));
+            const keys = Array.from(Object.keys(invokeSettings.transientMap));
             keys.forEach((key) => {
-                transientData[key] = Buffer.from(invokeSettings.transientData[key]);
+                transientData[key] = Buffer.from(invokeSettings.transientMap[key]);
             });
             transaction.setTransient(transientData);
         }
@@ -690,6 +690,9 @@ class Fabric extends BlockchainInterface {
             logger.info(`disconnecting gateway for user ${userName}`);
             gateway.disconnect();
         }
+
+        // Clear peer cache
+        this.peerCache.clear();
     }}
 
 module.exports = Fabric;