Added the option for a dynamich filename for fileRead method

Author: Chris Wiechmann

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

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.0.6] 2021-01-09
+### Added
+- Added option for a dynamic path for readFile
+
 ## [0.0.5] 2020-11-16
 ### Added
 - New Exit: NotFound if the file cannot be found

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

@@ -1,6 +1,6 @@
 {
 	"name": "@axway-api-builder-ext/api-builder-plugin-fn-file",
-	"version": "0.0.5",
+	"version": "0.0.6",
 	"description": "File Flow-Node to read/write files as part of an API-Builder flow.",
 	"author": "Chris Wiechmann <cwiechmann@axway.com> (http://www.axway.com)",
 	"license": "Apache-2.0",

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

@@ -232,6 +232,12 @@ flow-nodes:
             schema:
               default: false
               type: boolean
+          data:
+            name: Data
+            description: 'If you are using a dynamic filename that contains variables, you need to provide this data object, which is used to replace your variables. Example: ${conf.myFolder}/some/static/${filename}'
+            required: false
+            schema:
+              type: object
         outputs:
           next:
             name: Next

api-builder-plugin-fn-file/src/standardFileActions.js

@@ -60,7 +60,7 @@ async function writeFile(params, options) {
 }
 
 async function readFile(params, options) {
-	var { filename, encoding, parseJson } = params;
+	var { filename, encoding, parseJson, data } = params;
 	const { logger } = options;
 	if (!filename) {
 		throw new Error('Missing required parameter: filename');
@@ -72,6 +72,10 @@ async function readFile(params, options) {
 	if(params.notFoundFails) {
 		notFoundFails = params.notFoundFails;
 	}
+	debugger;
+	if(data) {
+		filename = await interpolate(filename, data, logger);
+	}
 	try {
 		var content = await fs.readFile(filename, {encoding: encoding});
 	} catch(ex) {
@@ -88,6 +92,38 @@ async function readFile(params, options) {
 	return content;
 }
 
+async function interpolate(string, data, logger) {
+	if(string) {
+		string = JSON.stringify(string);
+	} else {
+		return;
+	}
+	logger.debug(`Got string: ${string}`);
+	var result = string.replace(/\${([^}]+)}/g, (_, target) => {
+		let keys = target.split(".");
+		return keys.reduce((prev, curr) => {
+			if (curr.search(/\[/g) > -1) {
+				//if element/key in target array is array, get the value and return
+				let m_curr = curr.replace(/\]/g, "");
+				let arr = m_curr.split("[");
+				return arr.reduce((pr, cu) => {
+					if(pr[cu] == undefined) {
+						throw new Error(`Missing data for selector: \$\{${curr}\}`);
+					}
+					return pr && pr[cu];
+				}, prev);
+			} else {
+				//else it is a object, get the value and return
+				if(prev[curr] == undefined) {
+					throw new Error(`Missing data for selector: \$\{${curr}\}`);
+				}
+				return prev && prev[curr];
+			}
+		}, data);
+	});
+	return JSON.parse(result);
+};
+
 module.exports = {
 	writeFile, 
 	readFile

api-builder-plugin-fn-file/test/testStandardFileHandling.js

@@ -216,6 +216,24 @@ describe('Standard file handling test', () => {
 			expect(output).to.equal('next');
 			expect(value).to.deep.equal(testData);
 		});
+
+		it('should read a standard file as normal text using a dynamic path', async () => {
+			debugger;
+			const testFilename = getTestFilename('testFile.txt');
+			fs.writeFileSync(testFilename, 'Some data');
+			const testFile = path.parse(testFilename);
+			const data = {
+				fileDetails: {
+					basename: testFile.base
+				}
+			}
+			const givenFilename = testFile.dir + "/${fileDetails.basename}"
+			
+			const { value, output } = await flowNode.readFile({ filename: givenFilename, data: data });
+
+			expect(output).to.equal('next');
+			expect(value).to.equal('Some data');
+		});
 	});
 });