fable 3.0.39 → 3.0.41

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fable",
-  "version": "3.0.39",
+  "version": "3.0.41",
   "description": "An entity behavior management and API bundling library.",
   "main": "source/Fable.js",
   "scripts": {
@@ -9,7 +9,7 @@
     "test": "./node_modules/.bin/mocha -u tdd -R spec",
     "build": "./node_modules/.bin/gulp build",
     "build-compatible": "GULP_CUSTOM_BUILD_TARGET=compatible ./node_modules/.bin/gulp build",
-    "docker-dev-build-image": "docker build ./ -f Dockerfile_LUXURYCode -t retold/fable:local",
+    "docker-dev-build": "docker build ./ -f Dockerfile_LUXURYCode -t retold/fable:local",
     "docker-dev-run": "docker run -it -d --name retold-fable-dev -p 30001:8080 -p 8086:8086 -v \"$PWD/.config:/home/coder/.config\"  -v \"$PWD:/home/coder/fable\" -u \"$(id -u):$(id -g)\" -e \"DOCKER_USER=$USER\" retold/fable:local",
     "docker-dev-shell": "docker exec -it retold-fable-dev /bin/bash"
   },
@@ -68,6 +68,7 @@
   "dependencies": {
     "async.eachlimit": "^0.5.2",
     "async.waterfall": "^0.5.2",
+    "cachetrax": "^1.0.2",
     "data-arithmatic": "^1.0.7",
     "fable-log": "^3.0.10",
     "fable-serviceproviderbase": "^3.0.3",

package/source/Fable.js

@@ -51,6 +51,7 @@ class Fable
 		this.serviceManager.addServiceType('RestClient', require('./services/Fable-Service-RestClient.js'));
 		this.serviceManager.addServiceType('CSVParser', require('./services/Fable-Service-CSVParser.js'));
 		this.serviceManager.addServiceType('Manifest', require('manyfest'));
+		this.serviceManager.addServiceType('ObjectCache', require('cachetrax'));
 	}
 
 	get isFable()

package/source/services/Fable-Service-RestClient.js

@@ -17,18 +17,30 @@ class FableServiceRestClient extends libFableServiceBase
 		this.dataFormat = this.fable.defaultServices.DataFormat;
 
 		this.serviceType = 'RestClient';
+
+		// This is a function that can be overridden, to allow the management
+		// of the request options before they are passed to the request library.
+		this.prepareRequestOptions = (pOptions) => { return pOptions; };
+	}
+
+	preRequest(pOptions)
+	{
+		// Validate the options object
+		return this.prepareRequestOptions(pOptions);
 	}
 
 	executeChunkedRequest(pOptions, fCallback)
 	{
-		pOptions.RequestStartTime = this.fable.log.getTimeStamp();
+		let tmpOptions = this.preRequest(pOptions);
+
+		tmpOptions.RequestStartTime = this.fable.log.getTimeStamp();
 
 		if (this.TraceLog)
 		{
-			this.fable.log.debug(`Beginning ${pOptions.method} request to ${pOptions.url} at ${pOptions.RequestStartTime}`);
+			this.fable.log.debug(`Beginning ${tmpOptions.method} request to ${tmpOptions.url} at ${tmpOptions.RequestStartTime}`);
 		}
 
-		return libSimpleGet(pOptions,
+		return libSimpleGet(tmpOptions,
 			(pError, pResponse)=>
 			{
 				if (pError)
@@ -39,7 +51,7 @@ class FableServiceRestClient extends libFableServiceBase
 				if (this.TraceLog)
 				{
 					let tmpConnectTime = this.fable.log.getTimeStamp();
-					this.fable.log.debug(`--> ${pOptions.method} connected in ${this.dataFormat.formatTimeDelta(pOptions.RequestStartTime, tmpConnectTime)}ms code ${pResponse.statusCode}`);
+					this.fable.log.debug(`--> ${tmpOptions.method} connected in ${this.dataFormat.formatTimeDelta(tmpOptions.RequestStartTime, tmpConnectTime)}ms code ${pResponse.statusCode}`);
 				}
 
 				let tmpData = '';
@@ -50,7 +62,7 @@ class FableServiceRestClient extends libFableServiceBase
 						if (this.TraceLog)
 						{
 							let tmpChunkTime = this.fable.log.getTimeStamp();
-							this.fable.log.debug(`--> ${pOptions.method} data chunk size ${pChunk.length}b received in ${this.dataFormat.formatTimeDelta(pOptions.RequestStartTime, tmpChunkTime)}ms`);
+							this.fable.log.debug(`--> ${tmpOptions.method} data chunk size ${pChunk.length}b received in ${this.dataFormat.formatTimeDelta(tmpOptions.RequestStartTime, tmpChunkTime)}ms`);
 						}
 						tmpData += pChunk;
 					});
@@ -60,7 +72,7 @@ class FableServiceRestClient extends libFableServiceBase
 						if (this.TraceLog)
 						{
 							let tmpCompletionTime = this.fable.log.getTimeStamp();
-							this.fable.log.debug(`==> ${pOptions.method} completed data size ${tmpData.length}b received in ${this.dataFormat.formatTimeDelta(pOptions.RequestStartTime, tmpCompletionTime)}ms`);
+							this.fable.log.debug(`==> ${tmpOptions.method} completed data size ${tmpData.length}b received in ${this.dataFormat.formatTimeDelta(tmpOptions.RequestStartTime, tmpCompletionTime)}ms`);
 						}
 						return fCallback(pError, pResponse, tmpData);
 					});
@@ -71,14 +83,16 @@ class FableServiceRestClient extends libFableServiceBase
 	{
 		pOptions.json = true;
 
-		pOptions.RequestStartTime = this.fable.log.getTimeStamp();
+		let tmpOptions = this.preRequest(pOptions);
+
+		tmpOptions.RequestStartTime = this.fable.log.getTimeStamp();
 
 		if (this.TraceLog)
 		{
-			this.fable.log.debug(`Beginning ${pOptions.method} JSON request to ${pOptions.url} at ${pOptions.RequestStartTime}`);
+			this.fable.log.debug(`Beginning ${tmpOptions.method} JSON request to ${tmpOptions.url} at ${tmpOptions.RequestStartTime}`);
 		}
 
-		return libSimpleGet(pOptions,
+		return libSimpleGet(tmpOptions,
 			(pError, pResponse)=>
 			{
 				if (pError)
@@ -89,7 +103,7 @@ class FableServiceRestClient extends libFableServiceBase
 				if (this.TraceLog)
 				{
 					let tmpConnectTime = this.fable.log.getTimeStamp();
-					this.fable.log.debug(`--> JSON ${pOptions.method} connected in ${this.dataFormat.formatTimeDelta(pOptions.RequestStartTime, tmpConnectTime)}ms code ${pResponse.statusCode}`);
+					this.fable.log.debug(`--> JSON ${tmpOptions.method} connected in ${this.dataFormat.formatTimeDelta(tmpOptions.RequestStartTime, tmpConnectTime)}ms code ${pResponse.statusCode}`);
 				}
 
 				pResponse.on('data', (pChunk) =>
@@ -97,7 +111,7 @@ class FableServiceRestClient extends libFableServiceBase
 						if (this.TraceLog)
 						{
 							let tmpChunkTime = this.fable.log.getTimeStamp();
-							this.fable.log.debug(`--> JSON ${pOptions.method} data chunk size ${pChunk.length}b received in ${this.dataFormat.formatTimeDelta(pOptions.RequestStartTime, tmpChunkTime)}ms`);
+							this.fable.log.debug(`--> JSON ${tmpOptions.method} data chunk size ${pChunk.length}b received in ${this.dataFormat.formatTimeDelta(tmpOptions.RequestStartTime, tmpChunkTime)}ms`);
 						}
 						// In a JSON request, the chunk is the serialized method.
 						return fCallback(pError, pResponse, JSON.parse(pChunk));
@@ -108,7 +122,7 @@ class FableServiceRestClient extends libFableServiceBase
 						if (this.TraceLog)
 						{
 							let tmpCompletionTime = this.fable.log.getTimeStamp();
-							this.fable.log.debug(`==> JSON ${pOptions.method} completed - received in ${this.dataFormat.formatTimeDelta(pOptions.RequestStartTime, tmpCompletionTime)}ms`);
+							this.fable.log.debug(`==> JSON ${tmpOptions.method} completed - received in ${this.dataFormat.formatTimeDelta(tmpOptions.RequestStartTime, tmpCompletionTime)}ms`);
 						}
 					});
 			});

package/test/Cache_tests.js

@@ -0,0 +1,92 @@
+/**
+* Unit tests for Fable
+*
+* @license     MIT
+*
+* @author      Steven Velozo <steven@velozo.com>
+*/
+
+var libFable = require('../source/Fable.js');
+
+var Chai = require("chai");
+var Expect = Chai.expect;
+
+suite
+(
+	'Object Cache Test',
+	function()
+	{
+		suite
+		(
+			'Basic object cache',
+			function()
+			{
+				test
+				(
+					'Leverage the object cache',
+					function(fDone)
+					{
+						let testFable = new libFable();
+
+						let testCache = testFable.serviceManager.instantiateServiceProvider('ObjectCache');
+
+						testCache.maxLength = 2;
+
+						// Cache some data
+						testCache.put('ABC', 'A');
+						testCache.put('DEF', 'D');
+						Expect(testCache._List.head.Datum).to.equal('ABC');
+						Expect(testCache._List.tail.Datum).to.equal('DEF');
+						Expect(testCache._List.length).to.equal(2);
+
+						testCache.put('GHI', 'G');
+						Expect(testCache._List.head.Datum).to.equal('DEF');
+						Expect(testCache._List.tail.Datum).to.equal('GHI');
+						Expect(testCache._List.length).to.equal(2);
+
+						testCache.put('JKL', 'J');
+						testCache.put('MNO', 'M');
+						Expect(testCache._List.head.Datum).to.equal('JKL');
+						Expect(testCache._List.tail.Datum).to.equal('MNO');
+						Expect(testCache._List.length).to.equal(2);
+
+						// Now grow the cache, allowing it to hold more items.
+						testCache.maxLength = 5
+						testCache.put('PQR', 'P');
+						testCache.put('STU', 'S');
+						Expect(testCache._List.head.Datum).to.equal('JKL');
+						Expect(testCache._List.tail.Datum).to.equal('STU');
+						Expect(testCache._List.length).to.equal(4);
+
+
+						testCache.put('VWX', 'V');
+						Expect(testCache._List.head.Datum).to.equal('JKL');
+						Expect(testCache._List.tail.Datum).to.equal('VWX');
+						Expect(testCache._List.length).to.equal(5);
+
+						testCache.put('YZ', 'Y');
+						Expect(testCache._List.head.Datum).to.equal('MNO');
+						Expect(testCache._List.tail.Datum).to.equal('YZ');
+						Expect(testCache._List.length).to.equal(5);
+
+						// Now shrink it again... the list will only maintain its length until a prune occurs
+						testCache.maxLength = 2;
+
+						testCache.put('012', '0');
+						Expect(testCache._List.head.Datum).to.equal('PQR');
+						Expect(testCache._List.tail.Datum).to.equal('012');
+						Expect(testCache._List.length).to.equal(5);
+
+						testCache.prune((pRemovedRecords)=>
+						{
+							Expect(testCache._List.head.Datum).to.equal('YZ');
+							Expect(testCache._List.tail.Datum).to.equal('012');
+							Expect(testCache._List.length).to.equal(2);
+							return fDone();
+						});
+					}
+				);
+			}
+		);
+	}
+);

package/test/Manifest_tests.js

@@ -8,9 +8,6 @@
 
 var libFable = require('../source/Fable.js');
 
-const libFS = require('fs');
-const libReadline = require('readline');
-
 var Chai = require("chai");
 var Expect = Chai.expect;
 

package/test/RestClient_test.js

@@ -57,6 +57,12 @@ suite
 						// Instantiate the RestClient Service Provider
                         let tmpRestClient = testFable.serviceManager.instantiateServiceProvider('RestClient', {TraceLog: true}, 'RestClient-99');
 
+						tmpRestClient.prepareRequestOptions = (pOptions) =>
+						{
+							pOptions.headers = {'Content-Type':'application/json'};
+							return pOptions;
+						};
+
 						// Download the wiktionary entry for dog!
 						tmpRestClient.postJSON({url: 'http://localhost:8086/1.0/Author', body:{Name:'Test Author'}},
 							(pError, pResponse, pBody)=>