Now using new API-Builder SDK to solve a number of sec-issues

Author: Chris Wiechmann

api-builder-plugin-fn-foreach/Changelog.md

@@ -4,7 +4,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Unreleased]
+## [2.0.0] 2021-05-31
+### Security
+- Now using new API-Builder SDK to solve a number of security issues
 
 ## [1.0.3] 2020-03-30
 ### Security

api-builder-plugin-fn-foreach/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@axway-api-builder-ext/api-builder-plugin-fn-foreach",
-  "version": "1.0.3",
+  "version": "2.0.0",
   "description": "For each flow node",
   "author": "bladedancer",
   "license": "Apache-2.0",
@@ -30,23 +30,22 @@
     "flows"
   ],
   "dependencies": {
-    "axway-flow-sdk": "^2.0.0"
-  },
-  "peerDependencies": {
-    "@axway/api-builder-runtime": "^4.5.0"
+    "@axway/api-builder-sdk": "^1.1.6",
+    "@axway/api-builder-runtime": "^4.66.0"
   },
   "devDependencies": {
-    "chai": "^4.2.0",
-    "check-node-version": "^4.0.2",
-    "cross-env": "^5.0.5",
-    "eslint": "^6.8.0",
-    "eslint-config-axway": "^2.0.7",
-    "eslint-plugin-chai-friendly": "^0.4.1",
-    "eslint-plugin-mocha": "^4.11.0",
-    "mocha": "^6.2.3",
+    "@axway/api-builder-test-utils": "^1.1.13",
+    "chai": "^4.3.4",
+    "check-node-version": "^4.1.0",
+    "cross-env": "^7.0.3",
+    "eslint": "^7.27.0",
+    "eslint-config-axway": "^6.0.2",
+    "eslint-plugin-chai-friendly": "^0.7.1",
+    "eslint-plugin-mocha": "^8.2.0",
+    "mocha": "^8.4.0",
     "mock-require": "^3.0.2",
-    "nyc": "^15.0.0",
-    "rimraf": "^2.6.2",
+    "nyc": "^15.1.0",
+    "rimraf": "^3.0.2",
     "simple-mock": "^0.8.0"
   },
   "scripts": {

api-builder-plugin-fn-foreach/package.json

@@ -1,22 +1,25 @@
 const APIBuilder = require('@axway/api-builder-runtime');
 
-exports = module.exports = async function (req, cb) {
+async function flowforeach(params, options) {
 	const server = APIBuilder.getGlobal();
 
-	const flowName = req.params.flow;
-	const items = req.params.items || [];
+	const flowName = params.flow;
+	const items = params.items || [];
 
 	if (!server.getFlow(flowName)) {
-		return cb.flowNotFound(null, flowName);
+		return options.setOutput('flowNotFound', `The flow with name: '${flowName}' could not be found.`);
 	}
-
 	try {
 		const results = [];
 		for (let i = 0; i < items.length; ++i) {
-			results[i] = await server.flowManager.flow(flowName, items[i], { logger: server.logger });
+			results[i] = await server.flowManager.flow(flowName, items[i], { options });
 		}
-		return cb.next(null, results);
+		return results;
 	} catch (ex) {
-		return cb.error(null, ex);
+		throw ex;
 	}
 };
+
+module.exports = {
+	flowforeach
+};

…-builder-plugin-fn-foreach/src/action.js …builder-plugin-fn-foreach/src/actions.jsapi-builder-plugin-fn-foreach/src/action.js renamed to api-builder-plugin-fn-foreach/src/actions.js api-builder-plugin-fn-foreach/src/action.js renamed to api-builder-plugin-fn-foreach/src/actions.js

@@ -0,0 +1,44 @@
+flow-nodes:
+  foreach:
+    name: For Each
+    icon: icon.svg
+    description: Loop over items and execute specified flow.
+    category: extension
+    methods:
+      flowforeach:
+        name: Flow
+        description: Execute a flow for each item.
+        parameters:
+          flow:
+            name: Flow name
+            description: The flow to execute.
+            required: true
+            initialType: string
+            schema:
+              type: string
+          items:
+            name: Items
+            description: The list of inputs to the flow.
+            required: false
+            initialType: array
+            schema:
+              type: array
+        outputs:
+          next:
+            name: Next
+            description: The list of results
+            context: $.results
+            schema:
+              type: array
+          flowNotFound:
+            name: Flow not found
+            description: Returned error contains an error message.
+            context: $.error
+            schema:
+              type: string
+          error:
+            name: Error
+            description: error
+            context: $.error
+            schema:
+              type: object

api-builder-plugin-fn-foreach/src/flow-nodes.yml

@@ -1,50 +1,21 @@
-const sdk = require('axway-flow-sdk');
-const action = require('./action');
+const path = require('path');
+const { SDK } = require('@axway/api-builder-sdk');
+const actions = require('./actions');
 
-function getFlowNodes() {
-	const flownodes = sdk.init(module);
-
-	flownodes.add('foreach', {
-		category: 'extension',
-		name: 'For Each',
-		icon: 'icon.svg',
-		description: 'Loop over items and execute specified flow.'
-	})
-		.method('flowforeach', {
-			name: 'Flow',
-			description: 'Execute a flow for each item.'
-		})
-		.parameter('flow', {
-			description: 'The flow to execute.',
-			type: 'string'
-		}, true)
-		.parameter('items', {
-			description: 'The list of inputs to the flow.',
-			type: 'array'
-		}, true)
-		.output('next', {
-			name: 'Next',
-			description: 'The list of results',
-			context: '$.results',
-			schema: {
-				type: 'array'
-			}
-		})
-		.output('flowNotFound', {
-			name: 'Flow not found',
-			context: '$.error',
-			schema: {
-				type: 'string'
-			}
-		})
-		.output('error', {
-			name: 'Error',
-			context: '$.error',
-			schema: {}
-		})
-		.action(action);
-
-	return Promise.resolve(flownodes);
+/**
+ * Resolves the API Builder plugin.
+ * @param {object} pluginConfig - The service configuration for this plugin
+ *   from API Builder config.pluginConfig['api-builder-plugin-pluginName']
+ * @param {string} pluginConfig.proxy - The configured API-builder proxy server
+ * @param {object} options - Additional options and configuration provided by API Builder
+ * @param {string} options.appDir - The current directory of the service using the plugin
+ * @param {string} options.logger - An API Builder logger scoped for this plugin
+ * @returns {object} An API Builder plugin.
+ */
+async function getPlugin(pluginConfig, options) {
+	const sdk = new SDK({ pluginConfig });
+	sdk.load(path.resolve(__dirname, 'flow-nodes.yml'), actions);
+	return sdk.getPlugin();
 }
 
-exports = module.exports = getFlowNodes;
+module.exports = getPlugin;