Event support in hlfv1, web and embedded runtime

.gitignore

@@ -52,3 +52,6 @@ packages/composer-website/jekylldocs/jsdoc/
 packages/composer-playground/src/assets/npmlist.json
 
 packages/composer-systests/systestv1/tls/ca/fabric-ca-server.db
+packages/composer-runtime-hlfv1/vendor/github.com/
+packages/composer-runtime-hlfv1/vendor/gopkg.in/sourcemap.v1/
+

packages/composer-admin/lib/adminconnection.js

@@ -91,9 +91,6 @@ class AdminConnection {
                 if (businessNetworkIdentifier) {
                     return this.connection.ping(this.securityContext);
                 }
-            })
-            .then(() => {
-
             });
     }
 

packages/composer-client/lib/businessnetworkconnection.js

@@ -282,8 +282,16 @@ class BusinessNetworkConnection extends EventEmitter {
      * @return {Promise} A promise to a BusinessNetworkDefinition that indicates the connection is complete
      */
     connect(connectionProfile, businessNetwork, enrollmentID, enrollmentSecret, additionalConnectOptions) {
+        const method = 'connect';
+        LOG.entry(method, connectionProfile, businessNetwork, enrollmentID, enrollmentSecret, additionalConnectOptions);
         return this.connectionProfileManager.connect(connectionProfile, businessNetwork, additionalConnectOptions)
             .then((connection) => {
+                connection.on('events', (events) => {
+                    events.forEach((event) => {
+                        let serializedEvent = this.getBusinessNetwork().getSerializer().fromJSON(event);
+                        this.emit('event', serializedEvent);
+                    });
+                });
                 this.connection = connection;
                 return connection.login(enrollmentID, enrollmentSecret);
             })
@@ -301,6 +309,7 @@ class BusinessNetworkConnection extends EventEmitter {
             })
             .then((businessNetwork) => {
                 this.businessNetwork = businessNetwork;
+                LOG.exit(method);
                 return this.businessNetwork;
             });
     }
@@ -321,14 +330,20 @@ class BusinessNetworkConnection extends EventEmitter {
      * terminated.
      */
     disconnect() {
+        const method = 'disconnect';
+        LOG.entry(method);
         if (!this.connection) {
             return Promise.resolve();
         }
         return this.connection.disconnect()
             .then(() => {
+                this.connection.removeListener('events', () => {
+                    LOG.debug(method, 'removeLisener');
+                });
                 this.connection = null;
                 this.securityContext = null;
                 this.businessNetwork = null;
+                LOG.exit(method);
             });
     }
 

packages/composer-client/scripts/tsgen.js

@@ -41,22 +41,30 @@ function renderClass(key, clazz) {
             fileContents += `  static ${statick}(${insert}): any;\n`;
         }
     });
-    let members = Object.getOwnPropertyNames(clazz.prototype);
-    members.forEach((member) => {
-        let func = clazz.prototype[member];
-        if (typeof func === 'function') {
-            const args = new Array(func.length).fill('temp');
-            args.forEach((value, index, array) => {
-                args[index] = `arg${index}?: any`;
-            });
-            const insert = args.join(', ');
-            if (member === 'constructor') {
-                fileContents += `  ${member}(${insert});\n`;
-            } else {
-                fileContents += `  ${member}(${insert}): any;\n`;
+    let foundConstructor = false;
+    let prototype = clazz.prototype;
+    while(prototype) {
+        let members = Object.getOwnPropertyNames(prototype);
+        members.forEach((member) => {
+            let func = prototype[member];
+            if (typeof func === 'function') {
+                const args = new Array(func.length).fill('temp');
+                args.forEach((value, index, array) => {
+                    args[index] = `arg${index}?: any`;
+                });
+                const insert = args.join(', ');
+                if (member === 'constructor') {
+                    if (!foundConstructor) {
+                        foundConstructor = true;
+                        fileContents += `  ${member}(${insert});\n`;
+                    }
+                } else {
+                    fileContents += `  ${member}(${insert}): any;\n`;
+                }
             }
-        }
-    });
+        });
+        prototype = Object.getPrototypeOf(prototype);
+    }
     fileContents += '}\n';
 }
 

packages/composer-client/test/businessnetworkconnection.js

@@ -155,6 +155,28 @@ describe('BusinessNetworkConnection', () => {
             });
         });
 
+        it('should create a connection, listen for events, and emit the events it detects individually', () => {
+            sandbox.stub(businessNetworkConnection.connectionProfileManager, 'connect').resolves(mockConnection);
+            mockConnection.login.resolves(mockSecurityContext);
+            mockConnection.ping.resolves();
+            const buffer = Buffer.from(JSON.stringify({
+                data: 'aGVsbG8='
+            }));
+            sandbox.stub(Util, 'queryChainCode').withArgs(mockSecurityContext, 'getBusinessNetwork', []).resolves(buffer);
+            sandbox.stub(BusinessNetworkDefinition, 'fromArchive').resolves(mockBusinessNetworkDefinition);
+            const cb = sinon.stub();
+            businessNetworkConnection.on('event', cb);
+            mockConnection.on.withArgs('events', sinon.match.func).yields(['event1', 'event2']);
+            mockSerializer.fromJSON.onCall(0).returns('event1#serialized');
+            mockSerializer.fromJSON.onCall(1).returns('event2#serialized');
+
+            return businessNetworkConnection.connect('testprofile', 'testnetwork', 'enrollmentID', 'enrollmentSecret', { some: 'other', options: true })
+            .then((result) => {
+                sinon.assert.calledTwice(cb); // two events
+                sinon.assert.calledWith(cb, 'event1#serialized');
+                sinon.assert.calledWith(cb, 'event2#serialized');
+            });
+        });
     });
 
     describe('#disconnect', () => {
@@ -169,9 +191,11 @@ describe('BusinessNetworkConnection', () => {
             return businessNetworkConnection.disconnect()
                 .then(() => {
                     sinon.assert.calledOnce(mockConnection.disconnect);
+                    sinon.assert.calledOnce(mockConnection.removeListener);
                     return businessNetworkConnection.disconnect();
                 })
                 .then(() => {
+                    mockConnection.removeListener.withArgs('events', sinon.match.func).yield(['event1', 'event2']);
                     should.equal(businessNetworkConnection.connection, null);
                     sinon.assert.calledOnce(mockConnection.disconnect);
                 });

packages/composer-common/api.txt

@@ -31,6 +31,7 @@ class Factory {
    + Resource newConcept(string,string,Object,boolean,string) throws ModelException
    + Relationship newRelationship(string,string,string) throws ModelException
    + Resource newTransaction(string,string,string,Object,string) 
+   + Resource newEvent(string,string,Object,string) 
    + Object toJSON() 
 }
 class FileWallet extends Wallet {

packages/composer-common/changelog.txt

@@ -12,6 +12,9 @@
 # Note that the latest public API is documented using JSDocs and is available in api.txt.
 #
 
+Version 0.7.1 {90a630e8b408292357ee801e5b79512c} 2017-05-04
+- Added Factory.newEvent
+
 Version 0.7.0 {632a80837e835bbe0343d4b37ce12742} 2017-05-01
 - Added Typed.instanceOf
 

packages/composer-common/lib/connection.js

@@ -15,6 +15,7 @@
 'use strict';
 
 const ConnectionManager = require('./connectionmanager');
+const EventEmitter = require('events');
 
 /**
  * Base class representing a connection to a business network.
@@ -23,7 +24,7 @@ const ConnectionManager = require('./connectionmanager');
  * @class
  * @memberof module:composer-common
  */
-class Connection {
+class Connection extends EventEmitter {
 
     /**
      * Constructor.
@@ -32,6 +33,7 @@ class Connection {
      * @param {string} businessNetworkIdentifier The identifier of the business network for this connection, or null if an admin connection
      */
     constructor(connectionManager, connectionProfile, businessNetworkIdentifier) {
+        super();
         if (!(connectionManager instanceof ConnectionManager)) {
             throw new Error('connectionManager not specified');
         } else if (!connectionProfile) {

packages/composer-common/lib/factory.js

@@ -29,6 +29,7 @@ const Concept = require('./model/concept');
 const ValidatedConcept = require('./model/validatedconcept');
 
 const TransactionDeclaration = require('./introspect/transactiondeclaration');
+const EventDeclaration = require('./introspect/eventdeclaration');
 
 const uuid = require('uuid');
 
@@ -304,6 +305,36 @@ class Factory {
         return transaction;
     }
 
+    /**
+     * Create a new event object. The identifier of the event is
+     * set to a UUID.
+     * @param {string} ns - the namespace of the event.
+     * @param {string} type - the type of the event.
+     * @param {Object} [options] - an optional set of options
+     * @param {string} [options.generate] - Pass one of: <dl>
+     * <dt>sample</dt><dd>return a resource instance with generated sample data.</dd>
+     * <dt>empty</dt><dd>return a resource instance with empty property values.</dd></dl>
+     * @return {Resource} A resource for the new event.
+     */
+    newEvent(ns, type, options) {
+        if (!ns) {
+            throw new Error('ns not specified');
+        } else if (!type) {
+            throw new Error('type not specified');
+        }
+        const id = 'valid';
+        let event = this.newResource(ns, type, id, options);
+        const classDeclaration = event.getClassDeclaration();
+        if (!(classDeclaration instanceof EventDeclaration)) {
+            throw new Error(event.getClassDeclaration().getFullyQualifiedName() + ' is not an event');
+        }
+
+        // set the timestamp
+        event.timestamp = new Date();
+
+        return event;
+    }
+
     /**
      * Stop serialization of this object.
      * @return {Object} An empty object.

packages/composer-common/test/factory.js

@@ -44,6 +44,10 @@ describe('Factory', () => {
         transaction MyTransaction identified by transactionId {
             o String transactionId
             o String newValue
+        }
+        event MyEvent identified by eventId {
+            o String eventId
+            o String value
         }`);
         factory = new Factory(modelManager);
         sandbox = sinon.sandbox.create();
@@ -217,6 +221,39 @@ describe('Factory', () => {
 
     });
 
+    describe('#newEvent', () => {
+        it('should throw if ns not specified', () => {
+            (() => {
+                factory.newEvent(null, 'MyEvent');
+            }).should.throw(/ns not specified/);
+        });
+
+        it('should throw if type not specified', () => {
+            (() => {
+                factory.newEvent('org.acme.test', null);
+            }).should.throw(/type not specified/);
+        });
+
+        it('should throw if a non event type was specified', () => {
+            (() => {
+                factory.newEvent('org.acme.test', 'MyTransaction');
+            }).should.throw(/not an event/);
+        });
+
+        it('should create a new instance with a generated ID', () => {
+            let resource = factory.newEvent('org.acme.test', 'MyEvent');
+            resource.eventId.should.equal('valid');
+            resource.timestamp.should.be.an.instanceOf(Date);
+        });
+
+        it('should pass options onto newEvent', () => {
+            let spy = sandbox.spy(factory, 'newResource');
+            factory.newEvent('org.acme.test', 'MyEvent', { hello: 'world' });
+            sinon.assert.calledOnce(spy);
+            sinon.assert.calledWith(spy, 'org.acme.test', 'MyEvent', 'valid', { hello: 'world' });
+        });
+    });
+
     describe('#toJSON', () => {
 
         it('should return an empty object', () => {

packages/composer-connector-embedded/lib/embeddedconnection.js

@@ -182,7 +182,7 @@ class EmbeddedConnection extends Connection {
         let engine = EmbeddedConnection.createEngine(container);
         EmbeddedConnection.addBusinessNetwork(businessNetwork.getName(), this.connectionProfile, chaincodeUUID);
         EmbeddedConnection.addChaincode(chaincodeUUID, container, engine);
-        let context = new EmbeddedContext(engine, userID);
+        let context = new EmbeddedContext(engine, userID, this);
         return businessNetwork.toArchive()
             .then((businessNetworkArchive) => {
                 return engine.init(context, 'init', [businessNetworkArchive.toString('base64')]);
@@ -246,7 +246,7 @@ class EmbeddedConnection extends Connection {
         let userID = securityContext.getUserID();
         let chaincodeUUID = securityContext.getChaincodeID();
         let chaincode = EmbeddedConnection.getChaincode(chaincodeUUID);
-        let context = new EmbeddedContext(chaincode.engine, userID);
+        let context = new EmbeddedContext(chaincode.engine, userID, this);
         return chaincode.engine.query(context, functionName, args)
             .then((data) => {
                 return Buffer.from(JSON.stringify(data));
@@ -265,7 +265,7 @@ class EmbeddedConnection extends Connection {
         let userID = securityContext.getUserID();
         let chaincodeUUID = securityContext.getChaincodeID();
         let chaincode = EmbeddedConnection.getChaincode(chaincodeUUID);
-        let context = new EmbeddedContext(chaincode.engine, userID);
+        let context = new EmbeddedContext(chaincode.engine, userID, this);
         return chaincode.engine.invoke(context, functionName, args)
             .then((data) => {
                 return undefined;

packages/composer-connector-hlf/lib/hfcconnection.js

@@ -50,6 +50,8 @@ class HFCConnection extends Connection {
         LOG.info('constructor', 'Creating connection', this.getIdentifier());
         this.chain = chain;
         this.connectOptions = connectOptions;
+
+        this.composerEventId = null;
     }
 
     /**
@@ -66,6 +68,7 @@ class HFCConnection extends Connection {
      * terminated, or rejected with an error.
      */
     disconnect() {
+        // this.chain.getEventHub().unregisterChaincodeEvent(this.composerEventId);
         this.chain.eventHubDisconnect();
         this.businessNetworkIdentifier = null;
         this.connectionProfile = null;
@@ -99,6 +102,7 @@ class HFCConnection extends Connection {
                 result.setUser(enrollmentID);
                 result.setEnrolledMember(enrolledMember);
                 result.setEventHub(self.chain.getEventHub());
+
                 LOG.info('login', 'Successful login', self.getIdentifier());
                 resolve(result);
             });
@@ -126,6 +130,7 @@ class HFCConnection extends Connection {
                         }
                     })
                     .then(() => {
+                        this.subscribeToEvents(securityContext.getChaincodeID());
                         return securityContext;
                     });
             });
@@ -336,6 +341,20 @@ class HFCConnection extends Connection {
             });
     }
 
+    /**
+     * Subscribe to events emitted by transactions
+     * @param {String} chaincodeID The chaincode ID
+     */
+    subscribeToEvents(chaincodeID) {
+        if (this.chain.getEventHub() && chaincodeID) {
+            LOG.entry('registerChaincodeEvent', chaincodeID, 'composer');
+            this.composerEventId = this.chain.getEventHub().registerChaincodeEvent(chaincodeID, 'composer', (event) => {
+                const jsonEvent = JSON.parse(event.payload.toString('utf8'));
+                this.emit('events', jsonEvent);
+            });
+        }
+    }
+
 }
 
 module.exports = HFCConnection;

packages/composer-connector-hlf/test/hfcconnection.js

@@ -130,17 +130,28 @@ describe('HFCConnection', () => {
         });
 
         it('should enroll against the Hyperledger Fabric', function() {
-
+            const events = {
+                payload: {
+                    toString: () => {
+                        return '{"events": "events"}';
+                    }
+                }
+            };
+            connection.emit = sinon.stub();
             // Login to the Hyperledger Fabric using the mock hfc.
             let enrollmentID = 'doge';
             let enrollmentSecret = 'suchsecret';
             return connection
                 .login('doge', 'suchsecret')
                 .then(function(securityContext) {
+                    mockEventHub.registerChaincodeEvent.withArgs('123', 'composer', sinon.match.func).yield(events);
                     sinon.assert.calledOnce(mockChain.enroll);
                     sinon.assert.calledWith(mockChain.enroll, enrollmentID, enrollmentSecret);
                     sinon.assert.calledOnce(mockChain.setRegistrar);
                     sinon.assert.calledWith(mockChain.setRegistrar, mockMember);
+                    sinon.assert.calledOnce(mockEventHub.registerChaincodeEvent);
+                    sinon.assert.calledOnce(connection.emit);
+                    sinon.assert.calledWith(connection.emit, 'events', {'events':'events'});
                     securityContext.should.be.a.instanceOf(HFCSecurityContext);
                     securityContext.getEnrolledMember().should.equal(mockMember);
                     securityContext.getEventHub().should.equal(mockEventHub);