FABN-1557 NodeSDK all restart event service (#237)

Event Service would not reconnect after a disconnect. Checking to
avoid connecting during a connect was not reset during the disconnect.

Added more logging and testing.

Signed-off-by: Bret Harrison <beharrison@nc.rr.com>

Author: harrisob

fabric-common/lib/EventService.js

@@ -169,6 +169,8 @@ class EventService extends ServiceAction {
 			this._current_eventer.disconnect();
 			logger.debug('%s - closing stream %s', method, this.currentStreamNumber);
 			this._current_eventer = null;
+		} else {
+			logger.debug('%s - no current eventer - not shutting down stream', method);
 		}
 		this._close_running = false;
 
@@ -356,16 +358,20 @@ class EventService extends ServiceAction {
 		for (const target of this.targets) {
 			try {
 				if (target.stream) {
+					logger.debug('%s - target has a stream, is already listening %s', method, target.toString());
 					start_error = Error(`Event service ${target.name} is currently listening`);
 				} else {
 					if (target.isConnectable()) {
+						logger.debug('%s - target needs to connect %s', method, target.toString());
 						await target.connect(); // target endpoint has been previously assigned, but not connected yet
 					}
 					const isConnected = await target.checkConnection();
 					if (!isConnected) {
 						start_error = Error(`Event service ${target.name} is not connected`);
+						logger.debug('%s - target is not connected %s', method, target.toString());
 					} else {
 						this._current_eventer = await this._startService(target, envelope, requestTimeout);
+						logger.debug('%s - set current eventer %s', method, this._current_eventer.toString());
 					}
 				}
 			} catch (error) {
@@ -384,8 +390,11 @@ class EventService extends ServiceAction {
 		// if we ran through the all targets and have start_error then we
 		// have not found a working target endpoint, so tell user error
 		if (start_error) {
+			logger.error('%s - no targets started - %s', method, start_error);
 			throw start_error;
 		}
+
+		logger.debug('%s - end', method);
 	}
 
 	/*

fabric-common/lib/Eventer.js

@@ -117,7 +117,7 @@ class Eventer extends ServiceEndpoint {
 			}
 		}
 
-		logger.debug('%s - end', method);
+		logger.debug('%s - end return:%s', method, result);
 		return result;
 	}
 

fabric-common/lib/ServiceEndpoint.js

@@ -120,7 +120,7 @@ class ServiceEndpoint {
 		logger.debug(`${method} - create the grpc service for ${this.name}`);
 		this.service = new this.serviceClass(this.endpoint.addr, this.endpoint.creds, this.options);
 		await this.waitForReady(this.service);
-		logger.debug(`${method} - completed the waitForReady for ${this.name}`);
+		logger.debug(`${method} - end - completed the waitForReady for ${this.name}`);
 	}
 
 	/**
@@ -135,14 +135,16 @@ class ServiceEndpoint {
 			this.service.close();
 			this.service = null;
 			this.connected = false;
+			this.connectAttempted = false;
 		}
 	}
 
 	/**
 	 * Check the connection status
 	 */
 	async checkConnection() {
-		logger.debug(`checkConnection[${this.name}] - start `);
+		const method = `checkConnection[${this.name}]`;
+		logger.debug('%s - start - connected:%s', method, this.connected);
 
 		if (this.connected) {
 			try {
@@ -153,6 +155,7 @@ class ServiceEndpoint {
 			}
 		}
 
+		logger.debug('%s - end - connected:%s', method, this.connected);
 		return this.connected;
 	}
 
@@ -227,7 +230,7 @@ class ServiceEndpoint {
 			url = this.endpoint.url;
 		}
 
-		return `${this.type}- name: ${this.name}, url:${url}`;
+		return `${this.type}- name: ${this.name}, url:${url}, connected:${this.connected}, connectAttempted:${this.connectAttempted}`;
 	}
 
 }

fabric-common/test/Channel.js

@@ -512,7 +512,7 @@ describe('Channel', () => {
 			channel.addCommitter(getCommitter('committer1'));
 			const channel_string = channel.toString();
 			assert.equal(channel_string,
-				'{"name":"mychannel","committers":["Committer- name: committer1, url:<not connected>"],"endorsers":["Endorser- name: endorser1, url:<not connected>"]}',
+				'{"name":"mychannel","committers":["Committer- name: committer1, url:<not connected>, connected:true, connectAttempted:false"],"endorsers":["Endorser- name: endorser1, url:<not connected>, connected:true, connectAttempted:false"]}',
 				'toString has all this'
 			);
 		});

fabric-common/test/ServiceEndpoint.js

@@ -236,12 +236,12 @@ describe('ServiceEndpoint', () => {
 	describe('#toString', () => {
 		it('should get a string url', async () => {
 			const results = serviceEndpoint.toString();
-			results.should.be.equal('ServiceEndpoint- name: myserviceEndpoint, url:grpc://host:2700');
+			results.should.be.equal('ServiceEndpoint- name: myserviceEndpoint, url:grpc://host:2700, connected:true, connectAttempted:false');
 		});
 		it('should get a string result', async () => {
 			serviceEndpoint.endpoint = null;
 			const results = serviceEndpoint.toString();
-			results.should.be.equal('ServiceEndpoint- name: myserviceEndpoint, url:<not connected>');
+			results.should.be.equal('ServiceEndpoint- name: myserviceEndpoint, url:<not connected>, connected:true, connectAttempted:false');
 		});
 	});
 });

package.json

@@ -37,7 +37,7 @@
     "test:cucumber": "cucumber-js -f node_modules/cucumber-pretty ./test/scenario/features/*.feature",
     "test:ts-cucumber": "cucumber-js -f node_modules/cucumber-pretty ./test/ts-scenario/features/*.feature --require './test/ts-scenario/steps/**/*.ts' --require './test/ts-scenario/support/**/*.ts' --require-module ts-node/register",
     "test:ts-cucumberNoHSM": "cucumber-js -f node_modules/cucumber-pretty ./test/ts-scenario/features/*.feature --require './test/ts-scenario/steps/**/*.ts' --require './test/ts-scenario/support/**/*.ts' --require-module ts-node/register --tags 'not @gateway_hsm'",
-    "test:ts-cucumber-tagged": "npm run test:ts-cucumber -- --tags @base_api_1",
+    "test:ts-cucumber-tagged": "npm run test:ts-cucumber -- --tags @base_api_2",
     "testHeadless": "run-s cleanUp compile lint unitTest:all",
     "tapeAndCucumber": "run-s tapeIntegration dockerClean cucumberScenario"
   },

test/ts-scenario/features/base_api_v2.feature

@@ -38,7 +38,6 @@ Scenario: Using only fabric-common on V2 channel
 	And the request named myDiscoveryRequest for client fred has a event result matching {"result":"Commit success"}
 	And the request named myDiscoveryRequest for client fred has a commit result matching {"status":"SUCCESS"}
 
-
 	When I create an event service myFilteredEventService as client fred on channel basev2channel
 	And I regisister a block listener named myFilteredBlockListener with myFilteredEventService for startBlock 1 and endBlock 3 as client fred
 	And I regisister a chaincode listener named myFilteredChaincodeListener with myFilteredEventService for createCar event on contract fabcar as client fred
@@ -57,3 +56,16 @@ Scenario: Using only fabric-common on V2 channel
 	Then the event listener myFullBlockListener of myFullEventService has results matching {"block":"4"} as client fred
 	Then the event listener myFullChaincodeListener of myFullEventService has results matching {"createCar":"Focus"} as client fred
 	Then the event listener myFullTransactionListener of myFullEventService has results matching {"transaction":"7"} as client fred
+
+	When I disconnect Event Service myFilteredEventService as client fred
+	And I regisister a block listener named myRestartListener with myFilteredEventService for startBlock 1 and endBlock 6 as client fred
+	And I restart the event service myFilteredEventService as filtered blocks to start at block 0 and end at block 6 as client fred
+	When I build a new endorsement request named myEventRequest for smart contract named fabcar with arguments [createCar,2008,Chrysler,PTCurser,white,Jones] as client fred on discovery channel basev2channel
+	And I commit the endorsement request named myEventRequest as client fred on channel basev2channel
+	Then the event listener myRestartListener of myFilteredEventService has results matching {"block":"6"} as client fred
+	When I disconnect Event Service myFilteredEventService as client fred
+	And I regisister a block listener named myRestartListener with myFilteredEventService for startBlock 1 and endBlock 6 as client fred
+	And I restart the event service myFilteredEventService as filtered blocks to start at block 0 and end at block 6 as client fred
+	When I build a new endorsement request named myEventRequest for smart contract named fabcar with arguments [createCar,2008,Chrysler,PTCurser,white,Jones] as client fred on discovery channel basev2channel
+	And I commit the endorsement request named myEventRequest as client fred on channel basev2channel
+	Then the event listener myRestartListener of myFilteredEventService has results matching {"block":"6"} as client fred

test/ts-scenario/steps/base_api.ts

@@ -62,9 +62,9 @@ When(/^I create an event service (.+?) as client (.+?) on channel (.+?)$/, { tim
 	await ClientHelper.createEventService(eventServiceName, clientName, channelName);
 });
 
-Then(/^I start the event service (.+?) as (.+?) blocks to start at block (.+?) and end at block (.+?) as client (.+?)$/, { timeout: Constants.INC_SHORT as number },
-	async (eventServiceName: string, blockType: 'filtered' | 'full' | 'private' | undefined, startBlock: string, endBlock: string, clientName: string) => {
-	await ClientHelper.startEventService(blockType, eventServiceName, clientName, startBlock, endBlock);
+Then(/^I (.+?) the event service (.+?) as (.+?) blocks to start at block (.+?) and end at block (.+?) as client (.+?)$/, { timeout: Constants.INC_SHORT as number },
+	async (start: 'start' | 'restart', eventServiceName: string, blockType: 'filtered' | 'full' | 'private' | undefined, startBlock: string, endBlock: string, clientName: string) => {
+		await ClientHelper.startEventService(blockType, eventServiceName, clientName, startBlock, endBlock, start);
 });
 
 Then(/^I regisister a block listener named (.+?) with (.+?) for startBlock (.+?) and endBlock (.+?) as client (.+?)$/, { timeout: Constants.INC_SHORT as number },
@@ -86,3 +86,7 @@ Then(/^the event listener (.+?) of (.+?) has results matching (.+?) as client (.
 	async (listenerName: string, eventServiceName: string, check: string, clientName: string) => {
 	await ClientHelper.checkEventListenerResults(eventServiceName, clientName, listenerName, check);
 });
+
+When(/^I disconnect Event Service (.+?) as client (.+?)$/, {timeout: Constants.HUGE_TIME as number }, async (eventServiceName: string, clientName: string) => {
+	await ClientHelper.disconnectEventService(eventServiceName, clientName);
+});

test/ts-scenario/steps/lib/utility/clientUtils.ts

@@ -599,7 +599,14 @@ export async function createEventService(eventServiceName: string, clientName: s
 	}
 }
 
-export async function startEventService(blockType: 'filtered' | 'full' | 'private' | undefined, eventServiceName: string, clientName: string, startBlock: string, endBlock: string): Promise<void> {
+export async function startEventService(
+	blockType: 'filtered' | 'full' | 'private' | undefined,
+	eventServiceName: string,
+	clientName: string,
+	startBlock: string,
+	endBlock: string,
+	start: string): Promise<void> {
+
 	const clientObject: any = retrieveClientObject(clientName);
 	const client: Client = clientObject.client;
 	const ccp: CommonConnectionProfileHelper = clientObject.ccp;
@@ -631,6 +638,12 @@ export async function startEventService(blockType: 'filtered' | 'full' | 'privat
 		const peerNames: any = ccp.getPeersForChannel(channelName);
 		const endpoints: Endpoint[] = [];
 
+		if (start === 'restart') {
+			// we want to use the targets that we used last time
+			await eventService.send();
+			return;
+		}
+
 		for (const peerName of peerNames) {
 			const peerObject: any = ccp.getPeer(peerName);
 			const endpoint: Endpoint = client.newEndpoint({
@@ -805,3 +818,11 @@ export async function checkEventListenerResults(
 		BaseUtils.logAndThrow(`Listener object not found ${listenerName}`);
 	}
 }
+
+export async function disconnectEventService(
+	eventServiceName: string, clientName: string): Promise<void> {
+	const clientObject: any = retrieveClientObject(clientName);
+	const eventServiceObject: any = clientObject.eventServices.get(eventServiceName);
+
+	eventServiceObject.eventService.close();
+}