Now region is used to load the payload / New Integration-Test

Fixes #121

Author: Chris Wiechmann

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Failed to validated API-Manager connection, when using Load-Balanced API-Manager instances [#117](https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/issues/117)
 - For JMS-Traffic the fields: leg0.protocolInfo.recvHeader and leg0.protocolInfo.sentHeader are copied into the summary index, as they are used for JMS-Property filtering
 - Error when setting up Traffic-Summary index without having a Default-API-Manager configured [#119](https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/issues/119)
+- Region is not used to load the payload [#121](https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/issues/121)
 
 ### Changed
 - Added new optional parameter: UNRESTRICTED_PERMISSIONS to control which users see all traffic [#120](https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/issues/120)

apibuilder4elastic/custom_flow_nodes/api-builder-plugin-axway-api-management/src/actions.js

@@ -55,7 +55,6 @@ async function lookupCurrentUser(params, options) {
 	if(!requestHeaders.cookie && !requestHeaders.authorization) {
 		throw new Error('You must provide either the VIDUSR cookie + csrf-token or an HTTP-Basic Authorization header.');
 	}
-	debugger;
 	if (!unrestrictedPermissions || unrestrictedPermissions=="") {
 		unrestrictedPermissions = "adminusers_modify";
 	}
@@ -330,7 +329,6 @@ async function getCustomPropertiesConfig(params, options) {
 	const { logger } = options;
 	cache = options.pluginContext.cache;
 	let apiManagerConfig;
-	debugger;
 	var mergedCustomProperties = {};
 	if(!pluginConfig.apimanager.perGroupAndRegion) {
 		// Using a single API-Manager only.

apibuilder4elastic/custom_flow_nodes/api-builder-plugin-axway-api-management/src/utils.js

@@ -153,7 +153,6 @@ function getManagerConfig(apiManagerConfig, groupId, region) {
 	if(region != undefined && region != "N/A" && region != "n/a") {
 		key = `${groupId}###${region}`.toLowerCase();
 	}
-	debugger;
 	// Check if the requested combination based on groupId and region exists and return it directly
 	if (apiManagerConfig.configs && apiManagerConfig.configs[key]) {
 		return apiManagerConfig.configs[key];
@@ -167,7 +166,6 @@ function getManagerConfig(apiManagerConfig, groupId, region) {
 
 async function checkAPIManagers(apiManagerConfig, options) {
 	var finalResult = { isValid: true };
-	debugger;
 	for (const [key, config] of Object.entries(apiManagerConfig.configs)) {
 		if(typeof config != 'object') continue;
 		finalResult[key] = config;

apibuilder4elastic/flows/trafficMonitorApi-payload.json

@@ -227,6 +227,11 @@
 					"value": "$.params.legID",
 					"metaName": "Leg-Number",
 					"metaDescription": "The Leg-Number"
+				},
+				{
+					"name": "region",
+					"type": "jsonpath",
+					"value": "$.params.region"
 				}
 			],
 			"outputs": {
@@ -726,23 +731,28 @@
 				{
 					"name": "requestHeaders",
 					"type": "jsonpath",
-					"value": "$.request.headers"
+					"value": "$.request.headers",
+					"metaName": "Request Headers",
+					"metaDescription": "The request headers are used to lookup the topology using the currently logged in user."
 				}
 			],
 			"outputs": {
 				"next": {
 					"routes": [
 						"traffic-monitor-api-utils.1"
 					],
-					"context": "$.gatewayTopology"
+					"context": "$.gatewayTopology",
+					"metaName": "Next"
 				},
 				"error": {
 					"routes": [
 						"http.3"
 					],
-					"context": "$.error"
+					"context": "$.error",
+					"metaName": "Error"
 				}
-			}
+			},
+			"metaMethod": "Lookup topology"
 		},
 		"traffic-monitor-api-utils.1": {
 			"type": "nodehandler://api-builder-plugin-traffic-monitor-api-utils/traffic-monitor-api-utils",
@@ -752,38 +762,49 @@
 				{
 					"name": "gatewayTopology",
 					"type": "jsonpath",
-					"value": "$.gatewayTopology"
+					"value": "$.gatewayTopology",
+					"metaName": "API-Gateway Topology",
+					"metaDescription": "The API-Gateway topology as read by flow-node: axway-api-management->lookupTopology"
 				},
 				{
 					"name": "authzConfig",
 					"type": "jsonpath",
-					"value": "$.authzConfig"
+					"value": "$.authzConfig",
+					"metaName": "Authorization configuration",
+					"metaDescription": "The authorization configuration object returned from Get AuthZ Config"
 				},
 				{
 					"name": "params",
 					"type": "jsonpath",
-					"value": "$.params"
+					"value": "$.params",
+					"metaName": "Params",
+					"metaDescription": "The object must contain the given request parameters."
 				},
 				{
 					"name": "user",
 					"type": "jsonpath",
-					"value": "$.user"
+					"value": "$.user",
+					"metaName": "User",
+					"metaDescription": "The user object using the API-Gateway Traffic-Monitor"
 				}
 			],
 			"outputs": {
 				"next": {
 					"routes": [
 						"authorization.1"
 					],
-					"context": "$.elasticsearch.query"
+					"context": "$.elasticsearch.query",
+					"metaName": "Next"
 				},
 				"error": {
 					"routes": [
 						"http.3"
 					],
-					"context": "$.error"
+					"context": "$.error",
+					"metaName": "Error"
 				}
-			}
+			},
+			"metaMethod": "Create circuit path query"
 		}
 	}
 }

apibuilder4elastic/test/mockedReplies/payloads/US-DC1/2020-07-03/08.55/0455ff5e82267be8182a553d-0-sent

@@ -0,0 +1 @@
+US-DC1-SENT-PAYLOAD-LEG-0

apibuilder4elastic/test/mockedReplies/payloads/US-DC1/2020-07-03/08.55/0455ff5e82267be8182a553d-1-received

@@ -0,0 +1 @@
+US-DC1-RECEIVED-PAYLOAD-LEG-1

apibuilder4elastic/test/trafficMonitorAPI/asAdmin/payload/test_payload.js

@@ -57,7 +57,7 @@ describe('Payload', function () {
 
 	describe('Payload tests', () => {
 		it('[Payload-0001]  Should return sent payload for leg 0', () => {
-			const testPayload = fs.readFileSync(`${payloadFolder}/2020-07-03/08.55/0455ff5e82267be8182a553d-0-sent`);
+			const testPayload = fs.readFileSync(`${payloadFolder}/2020-07-03/08.55/0455ff5e82267be8182a553d-0-sent`, { encoding: "UTF-8" });
 			return requestAsync({
 				method: 'GET',  // 
 				uri: `http://localhost:${server.apibuilder.port}/api/elk/v1/api/router/service/instance-1/ops/stream/0455ff5e82267be8182a553d/0/sent`,
@@ -75,7 +75,7 @@ describe('Payload', function () {
 		});
 
 		it('[Payload-0002] Should return the received payload from leg 1', () => {
-			const testPayload = fs.readFileSync(`${payloadFolder}/2020-07-03/08.55/0455ff5e82267be8182a553d-1-received`);
+			const testPayload = fs.readFileSync(`${payloadFolder}/2020-07-03/08.55/0455ff5e82267be8182a553d-1-received`, { encoding: "UTF-8" });
 			return requestAsync({
 				method: 'GET',
 				uri: `http://localhost:${server.apibuilder.port}/api/elk/v1/api/router/service/instance-1/ops/stream/0455ff5e82267be8182a553d/1/received`,
@@ -112,7 +112,7 @@ describe('Payload', function () {
 		});
 
 		it('[Payload-0004] Payload should be SAVED and is NOT limited to a certain size (request is missing a CSRF-Token)', () => {
-			const testPayload = fs.readFileSync(`${payloadFolder}/2021-01-09/10.00/LargePayloadTest-1-received`);
+			const testPayload = fs.readFileSync(`${payloadFolder}/2021-01-09/10.00/LargePayloadTest-1-received`, { encoding: "UTF-8" });
 			return requestAsync({
 				method: 'GET',
 				uri: `http://localhost:${server.apibuilder.port}/api/elk/v1/api/router/service/instance-1/ops/stream/LargePayloadTest/1/received`,
@@ -129,6 +129,23 @@ describe('Payload', function () {
 				expect(body).to.include(testPayload);
 			});
 		});
+
+		it('[Payload-0005] Should return REGIONAL sent payload for leg 0', () => {
+			const testPayload = fs.readFileSync(`${payloadFolder}/US-DC1/2020-07-03/08.55/0455ff5e82267be8182a553d-0-sent`, { encoding: "UTF-8" });
+			return requestAsync({
+				method: 'GET',  // 
+				uri: `http://localhost:${server.apibuilder.port}/api/elk/v1/api/router/service/instance-1/ops/stream/0455ff5e82267be8182a553d/0/sent?region=US-DC1`,
+				headers: {
+					'cookie': 'VIDUSR=Getinfo-0001-DAVID-1597762865-iUI5a8+v+zLkNA%3d%3d; APIMANAGERSTATIC=92122e5c-6bb3-4fd1-ad2f-08b65554d116', 
+					'csrf-token': '04F9F07E59F588CDE469FC367A12ED3A4B845FDA9A9AE2D9A77686823067CDDC'
+				},
+				json: true
+			}).then(({ response, body }) => {
+				expect(response.statusCode).to.equal(200);
+				expect(response.headers["content-type"]).to.equal("application/vordel-xact-data; charset=utf-8");
+				expect(body).to.be.an('String');
+				expect(body).to.include(testPayload);
+			});
+		});
 	});
-});
-	
+});