Don't include serviceId filter for getInfo & Circuit-Path if EMT is enabled

Author: Chris Wiechmann

apibuilder4elastic/custom_flow_nodes/api-builder-plugin-traffic-monitor-api-utils/src/actions.js

@@ -135,7 +135,7 @@ async function handleFilterFields(parameters, options) {
 
 
 async function createCircuitPathQuery(parameters, options) {
-	const { params, user, authzConfig } = parameters;
+	const { params, user, authzConfig, gatewayTopology } = parameters;
 	const { logger } = options;
 	if (!params) {
 		throw new Error('Missing required parameter: params');
@@ -149,14 +149,21 @@ async function createCircuitPathQuery(parameters, options) {
 	if (!params.correlationID) {
 		throw new Error('Missing required parameter: params.correlationID');
 	}
-	if (!params.serviceID) {
-		throw new Error('Missing required parameter: params.serviceID');
+	if (!gatewayTopology) {
+		throw new Error('Missing required parameter: gatewayTopology');
+	}
+	if (!gatewayTopology.emtEnabled && !params.serviceID) {
+		throw new Error('Missing required parameter: params.serviceID when not using EMT.');
 	}
 	var elasticQuery = { bool: { must: [
                 { term: { correlationId: params.correlationID } },
-                { term: { 'processInfo.serviceId': params.serviceID } }
             ] }
     };
+	if(!gatewayTopology.emtEnabled) { // Don't include serviceId filter, if EMT is enabled
+		elasticQuery.bool.must.push(
+			{ term: { 'processInfo.serviceId': params.serviceID } }
+		);
+	}
 	// If user is an Admin or AuthZ is disabled, return the base query
 	if (user.gatewayManager.isAdmin || authzConfig.enableUserAuthorization == false) {
 		return elasticQuery;

apibuilder4elastic/custom_flow_nodes/api-builder-plugin-traffic-monitor-api-utils/src/flow-nodes.yml

@@ -131,7 +131,12 @@ flow-nodes:
             required: true
             schema:
               type: object
-              
+          gatewayTopology:
+            name: API-Gateway Topology
+            description: "The API-Gateway topology as read by flow-node: axway-api-management->lookupTopology"
+            required: true
+            schema:
+              type: object
         returns:
           name: Next
           description: Returns the created search query for the circuit path

apibuilder4elastic/custom_flow_nodes/api-builder-plugin-traffic-monitor-api-utils/test/testCreateCircuitPathQuery.js

@@ -1,6 +1,7 @@
 const { expect } = require('chai');
 const { MockRuntime } = require('@axway/api-builder-test-utils');
 const getPlugin = require('../src');
+const fs = require('fs');
 
 describe('Flow node CreateCircuitPath query', () => {
 	let plugin;
@@ -44,15 +45,15 @@ describe('Flow node CreateCircuitPath query', () => {
 		});
 
 		it('should error when required parameter params.serviceId is missing', async () => {
-			const { value, output } = await flowNode.createCircuitPathQuery({ params: { correlationID: 123 }, user: {}, authzConfig: {} } );
+			const { value, output } = await flowNode.createCircuitPathQuery({ params: { correlationID: 123 }, user: {}, authzConfig: {}, gatewayTopology: {} } );
 
 			expect(value).to.be.instanceOf(Error)
-				.and.to.have.property('message', 'Missing required parameter: params.serviceID');
+				.and.to.have.property('message', 'Missing required parameter: params.serviceID when not using EMT.');
 			expect(output).to.equal('error');
 		});
 
 		it('should succeed with valid parameters as an API-Manager User', async () => {
-			const { value, output } = await flowNode.createCircuitPathQuery( { params: { correlationID: "MyCorrelationId", serviceID: "TestServiceId" }, user: {
+			const { value, output } = await flowNode.createCircuitPathQuery( { params: { correlationID: "MyCorrelationId", serviceID: "TestServiceId" }, gatewayTopology: {}, user: {
 				apiManager: { role: "user", organizationName: "Test-Org" },  
 				gatewayManager: {}
 			}, authzConfig: { 
@@ -73,7 +74,7 @@ describe('Flow node CreateCircuitPath query', () => {
 		});
 
 		it('should succeed with valid parameters having API-Manager Org-AuthZ disabled', async () => {
-			const { value, output } = await flowNode.createCircuitPathQuery( { params: { correlationID: "MyCorrelationId", serviceID: "TestServiceId" }, user: {
+			const { value, output } = await flowNode.createCircuitPathQuery( { params: { correlationID: "MyCorrelationId", serviceID: "TestServiceId" }, gatewayTopology: {}, user: {
 				apiManager: { role: "user", organizationName: "Test-Org" },  
 				gatewayManager: {}
 			}, authzConfig: { 
@@ -93,7 +94,7 @@ describe('Flow node CreateCircuitPath query', () => {
 		});
 
 		it('should succeed with valid parameters with API-Manager Admin-Role', async () => {
-			const { value, output } = await flowNode.createCircuitPathQuery( { params: { correlationID: "MyCorrelationId", serviceID: "TestServiceId" }, user: {
+			const { value, output } = await flowNode.createCircuitPathQuery( { params: { correlationID: "MyCorrelationId", serviceID: "TestServiceId" }, gatewayTopology: {}, user: {
 				apiManager: { role: "admin", organizationName: "Test-Org" },  
 				gatewayManager: {}
 			}, authzConfig: { 
@@ -112,5 +113,26 @@ describe('Flow node CreateCircuitPath query', () => {
 				}
 			});
 		});
+
+		it('should succeed when EMT is enabled', async () => {
+			var topology = JSON.parse(fs.readFileSync('./test/mockedReplies/emtTopology.json'), null);
+			const { value, output } = await flowNode.createCircuitPathQuery( { params: { correlationID: "MyCorrelationId", serviceID: "TestServiceId" }, gatewayTopology: topology, user: {
+				apiManager: { role: "admin", organizationName: "Test-Org" },  
+				gatewayManager: {}
+			}, authzConfig: { 
+				apimanagerOrganization: { enabled: true }
+			} } );
+
+			expect(output).to.equal('next');
+			expect(value).to.be.a('object');
+			expect(value).to.deep.equal({
+				bool: {
+					must: [
+						{ term: { correlationId: "MyCorrelationId" } },
+						{ exists: { field: "transactionSummary.serviceContext" } }
+					]
+				}
+			});
+		});
 	});
 });