fable 3.0.118 → 3.0.120

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "fable",
-    "version": "3.0.118",
+    "version": "3.0.120",
     "description": "Anentity behavior management and API bundling library.",
     "main": "source/Fable.js",
     "scripts": {
@@ -50,7 +50,7 @@
     },
     "homepage": "https://github.com/stevenvelozo/fable",
     "devDependencies": {
-        "quackage": "^1.0.25"
+        "quackage": "^1.0.29"
     },
     "dependencies": {
         "async.eachlimit": "^0.5.2",
@@ -59,12 +59,12 @@
         "cachetrax": "^1.0.4",
         "cookie": "^0.6.0",
         "data-arithmatic": "^1.0.7",
-        "dayjs": "^1.11.10",
+        "dayjs": "^1.11.11",
         "fable-log": "^3.0.13",
-        "fable-serviceproviderbase": "^3.0.12",
+        "fable-serviceproviderbase": "^3.0.13",
         "fable-settings": "^3.0.9",
         "fable-uuid": "^3.0.6",
-        "manyfest": "^1.0.28",
+        "manyfest": "^1.0.29",
         "simple-get": "^4.0.1"
     }
 }

package/source/Fable.js

@@ -75,9 +75,9 @@ class Fable extends libFableServiceBase.CoreServiceProviderBase
 		this.addServiceType('RestClient', require('./services/Fable-Service-RestClient.js'));
 		this.addServiceType('Manifest', require('manyfest'));
 		this.addServiceType('ObjectCache', require('cachetrax'));
-		this.addServiceType('Operation', require('./services/Fable-Service-Operation.js'));
-		this.addServiceType('ProgressTracker', require('./services/Fable-Service-ProgressTracker.js'));
 		this.addAndInstantiateServiceType('ProgressTime', require('./services/Fable-Service-ProgressTime.js'));
+		this.addServiceType('ProgressTrackerSet', require('./services/Fable-Service-ProgressTrackerSet.js'));
+		this.addServiceType('Operation', require('./services/Fable-Service-Operation.js'));
 		this.addServiceType('CSVParser', require('./services/Fable-Service-CSVParser.js'));
 		this.addServiceType('FilePersistence', require('./services/Fable-Service-FilePersistence.js'));
 	}

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

@@ -27,9 +27,9 @@ class FableOperation extends libFableServiceBase
 		this.state.Metadata.Name = (typeof(this.options.Name) == 'string') ? this.options.Name : `Unnamed Operation ${this.state.Metadata.UUID}`;
 		this.name = this.state.Metadata.Name;
 
-		this.progressTrackers = this.fable.instantiateServiceProviderWithoutRegistration('ProgressTracker');
+		this.progressTrackerSet = this.fable.instantiateServiceProviderWithoutRegistration('ProgressTrackerSet');
 
-		this.state.OverallProgressTracker = this.progressTrackers.createProgressTracker(`Overall-${this.state.Metadata.UUID}`);
+		this.state.OverallProgressTracker = this.progressTrackerSet.createProgressTracker(`Overall-${this.state.Metadata.UUID}`);
 
 		// This is here to use the pass-through logging functions in the operation itself.
 		this.log = this;
@@ -45,8 +45,8 @@ class FableOperation extends libFableServiceBase
 
 		let tmpAnticipate = this.fable.instantiateServiceProviderWithoutRegistration('Anticipate');
 		
-		this.progressTrackers.setProgressTrackerTotalOperations(this.state.OverallProgressTracker.Hash, this.state.Status.StepCount);
-		this.progressTrackers.startProgressTracker(this.state.OverallProgressTracker.Hash);
+		this.progressTrackerSet.setProgressTrackerTotalOperations(this.state.OverallProgressTracker.Hash, this.state.Status.StepCount);
+		this.progressTrackerSet.startProgressTracker(this.state.OverallProgressTracker.Hash);
 		this.info(`Operation [${this.state.Metadata.UUID}] ${this.state.Metadata.Name} starting...`);
 
 		for (let i = 0; i < this.state.Steps.length; i++)
@@ -55,7 +55,7 @@ class FableOperation extends libFableServiceBase
 				function(fNext)
 				{
 					this.fable.log.info(`Step #${i} [${this.state.Steps[i].GUIDStep}] ${this.state.Steps[i].Name} starting...`);
-					this.progressTrackers.startProgressTracker(this.state.Steps[i].ProgressTracker.Hash);
+					this.progressTrackerSet.startProgressTracker(this.state.Steps[i].ProgressTracker.Hash);
 					return fNext();
 				}.bind(this));
 			// Steps are executed in a custom context with 
@@ -65,26 +65,10 @@ class FableOperation extends libFableServiceBase
 					fable:this.fable,
 					options:this.state.Steps[i].Metadata,
 					metadata:this.state.Steps[i].Metadata,
-					ProgressTracker:this.progressTrackers.getProgressTracker(this.state.Steps[i].ProgressTracker.Hash),
-					updateProgressTracker: function(pProgressAmount)
-						{
-							return this.progressTrackers.updateProgressTracker(this.state.Steps[i].ProgressTracker.Hash, pProgressAmount);
-						}.bind(this),
-					incrementProgressTracker: function(pProgressIncrementAmount)
-						{
-							return this.progressTrackers.incrementProgressTracker(this.state.Steps[i].ProgressTracker.Hash, pProgressIncrementAmount);
-						}.bind(this),
-					setProgressTrackerTotalOperations: function(pTotalOperationCount)
-						{
-							return this.progressTrackers.setProgressTrackerTotalOperations(this.state.Steps[i].ProgressTracker.Hash, pTotalOperationCount);
-						}.bind(this),
-					getProgressTrackerStatusString: function() 
-						{
-							return this.progressTrackers.getProgressTrackerStatusString(this.state.Steps[i].ProgressTracker.Hash);
-						}.bind(this),
+					ProgressTracker:this.progressTrackerSet.getProgressTracker(this.state.Steps[i].ProgressTracker.Hash),
 					logProgressTrackerStatus: function() 
 						{
-							return this.log.info(`Step #${i} [${this.state.Steps[i].GUIDStep}]: ${this.progressTrackers.getProgressTrackerStatusString(this.state.Steps[i].ProgressTracker.Hash)}`);
+							return this.log.info(`Step #${i} [${this.state.Steps[i].GUIDStep}]: ${this.progressTrackerSet.getProgressTrackerStatusString(this.state.Steps[i].ProgressTracker.Hash)}`);
 						}.bind(this),
 					OperationState:this.state,
 					StepState:this.state.Steps[i]
@@ -92,13 +76,13 @@ class FableOperation extends libFableServiceBase
 			tmpAnticipate.anticipate(
 				function(fNext)
 				{
-					this.progressTrackers.endProgressTracker(this.state.Steps[i].ProgressTracker.Hash);
-					let tmpStepTimingMessage = this.progressTrackers.getProgressTrackerStatusString(this.state.Steps[i].ProgressTracker.Hash);
+					this.progressTrackerSet.endProgressTracker(this.state.Steps[i].ProgressTracker.Hash);
+					let tmpStepTimingMessage = this.progressTrackerSet.getProgressTrackerStatusString(this.state.Steps[i].ProgressTracker.Hash);
 					this.fable.log.info(`Step #${i} [${this.state.Steps[i].GUIDStep}] ${this.state.Steps[i].Name} complete.`);
 					this.fable.log.info(`Step #${i} [${this.state.Steps[i].GUIDStep}] ${this.state.Steps[i].Name} ${tmpStepTimingMessage}.`);
 			
-					this.progressTrackers.incrementProgressTracker(this.state.OverallProgressTracker.Hash, 1);
-					let tmpOperationTimingMessage = this.progressTrackers.getProgressTrackerStatusString(this.state.OverallProgressTracker.Hash);
+					this.progressTrackerSet.incrementProgressTracker(this.state.OverallProgressTracker.Hash, 1);
+					let tmpOperationTimingMessage = this.progressTrackerSet.getProgressTrackerStatusString(this.state.OverallProgressTracker.Hash);
 					this.fable.log.info(`Operation [${this.state.Metadata.UUID}] ${tmpOperationTimingMessage}.`);
 					return fNext();
 				}.bind(this));
@@ -114,13 +98,20 @@ class FableOperation extends libFableServiceBase
 					return fExecutionCompleteCallback(pError);
 				}
 				this.info(`Operation [${this.state.Metadata.UUID}] ${this.state.Metadata.Name} complete.`);
-				let tmpOperationTimingMessage = this.progressTrackers.getProgressTrackerStatusString(this.state.OverallProgressTracker.Hash);
-				this.progressTrackers.endProgressTracker(this.state.OverallProgressTracker.Hash);
+				let tmpOperationTimingMessage = this.progressTrackerSet.getProgressTrackerStatusString(this.state.OverallProgressTracker.Hash);
+				this.progressTrackerSet.endProgressTracker(this.state.OverallProgressTracker.Hash);
 				this.fable.log.info(`Operation [${this.state.Metadata.UUID}] ${tmpOperationTimingMessage}.`);
 				return fExecutionCompleteCallback();
 			});
 	}
 
+	// There are three ways to add steps:
+	// 1. As a basic javascript function
+	//    --
+	//    This is the most basic, java"script" way to add a step.  It will
+	//    setup a "this" context that has the following properties:
+	//    - log: A reference to the operation's log object
+
 	addStep(fStepFunction, pStepMetadata, pStepName, pStepDescription, pGUIDStep)
 	{
 		let tmpStep = {};
@@ -133,7 +124,7 @@ class FableOperation extends libFableServiceBase
 		tmpStep.Name = (typeof(pStepName) !== 'undefined') ? pStepName : `Step [${tmpStep.GUIDStep}]`;
 		tmpStep.Description = (typeof(pStepDescription) !== 'undefined') ? pStepDescription : `Step execution of ${tmpStep.Name}.`;
 
-		tmpStep.ProgressTracker = this.progressTrackers.createProgressTracker(tmpStep.GUIDStep);
+		tmpStep.ProgressTracker = this.progressTrackerSet.createProgressTracker(tmpStep.GUIDStep);
 
 		tmpStep.Metadata = (typeof(pStepMetadata) === 'object') ? pStepMetadata : {};
 
@@ -156,7 +147,7 @@ class FableOperation extends libFableServiceBase
 			return new Error(`Step [${pGUIDStep}] does not exist in operation [${this.state.Metadata.UUID}] ${this.state.Metadata.Name} when attempting to set total operations to ${pTotalOperationCount}.`);
 		}
 
-		this.progressTrackers.setProgressTrackerTotalOperations(this.stepMap[pGUIDStep].ProgressTracker.Hash, pTotalOperationCount);
+		this.progressTrackerSet.setProgressTrackerTotalOperations(this.stepMap[pGUIDStep].ProgressTracker.Hash, pTotalOperationCount);
 	}
 
 	writeOperationLog(pLogLevel, pLogText, pLogObject)

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

@@ -0,0 +1,32 @@
+class ProgressTracker
+{
+	constructor(pProgressTrackerSet, pProgressTrackerHash)
+	{
+		this.progressTrackerSet = pProgressTrackerSet;
+		this.progressTrackerHash = pProgressTrackerHash;
+
+		this.data = this.progressTrackerSet.getProgressTrackerData(this.progressTrackerHash);
+	}
+
+	updateProgressTracker(pProgressAmount)
+	{
+		return this.progressTrackerSet.updateProgressTracker(this.progressTrackerHash, pProgressAmount);
+	}
+
+	incrementProgressTracker(pProgressIncrementAmount)
+	{
+		return this.progressTrackerSet.incrementProgressTracker(this.progressTrackerHash, pProgressIncrementAmount);
+	}
+
+	setProgressTrackerTotalOperations(pTotalOperationCount)
+	{
+		return this.progressTrackerSet.setProgressTrackerTotalOperations(this.progressTrackerHash, pTotalOperationCount);
+	}
+
+	getProgressTrackerStatusString()
+	{
+		return this.progressTrackerSet.getProgressTrackerStatusString(this.progressTrackerHash);
+	}
+}
+
+module.exports = ProgressTracker;

package/source/services/{Fable-Service-ProgressTracker.js → Fable-Service-ProgressTrackerSet.js}

@@ -1,12 +1,14 @@
 const libFableServiceBase = require('fable-serviceproviderbase');
 
-class FableServiceProgressTracker extends libFableServiceBase
+const libProgressTrackerClass = require('./Fable-Service-ProgressTracker/ProgressTracker.js');
+
+class FableServiceProgressTrackerSet extends libFableServiceBase
 {
 	constructor(pFable, pOptions, pServiceHash)
 	{
 		super(pFable, pOptions, pServiceHash);
 
-		this.serviceType = 'ProgressTracker';
+		this.serviceType = 'ProgressTrackerSet';
 
 		this.progressTrackers = {};
 
@@ -27,6 +29,19 @@ class FableServiceProgressTracker extends libFableServiceBase
 			this.createProgressTracker(tmpProgressTrackerHash, 100);
 		}
 
+		return new libProgressTrackerClass(this, pProgressTrackerHash);
+	}
+
+	getProgressTrackerData(pProgressTrackerHash)
+	{
+		let tmpProgressTrackerHash = (typeof(pProgressTrackerHash) == 'string') ? pProgressTrackerHash : 'Default';
+
+		if (!this.progressTrackers.hasOwnProperty(tmpProgressTrackerHash))
+		{
+			this.fable.log.warn(`ProgressTracker ${tmpProgressTrackerHash} does not exist!  Creating a new tracker...`);
+			this.createProgressTracker(tmpProgressTrackerHash, 100);
+		}
+
 		return this.progressTrackers[tmpProgressTrackerHash];
 	}
 
@@ -337,7 +352,7 @@ class FableServiceProgressTracker extends libFableServiceBase
 			// 4. Done
 			else
 			{
-				return `ProgressTracker ${tmpProgressTracker.Hash} is done. It completed ${tmpProgressTracker.CurrentCount} / ${tmpProgressTracker.TotalCount} operations in ${this.progressTimes.formatTimeDuration(tmpProgressTracker.ElapsedTime)} (median ${this.progressTimes.formatTimeDuration(tmpProgressTracker.AverageOperationTime)} per).`;
+				return `ProgressTracker ${tmpProgressTracker.Hash} is done.  ${tmpProgressTracker.CurrentCount} / ${tmpProgressTracker.TotalCount} operations were completed in ${this.progressTimes.formatTimeDuration(tmpProgressTracker.ElapsedTime)} (median ${this.progressTimes.formatTimeDuration(tmpProgressTracker.AverageOperationTime)} per).`;
 			}
 		}
 	}
@@ -348,4 +363,4 @@ class FableServiceProgressTracker extends libFableServiceBase
 	}
 }
 
-module.exports = FableServiceProgressTracker;
+module.exports = FableServiceProgressTrackerSet;

package/test/FableOperation_tests.js

@@ -115,7 +115,7 @@ suite
 												() =>
 												{
 													this.log.info(`Work done for iteration ${i}.`);
-													this.incrementProgressTracker(1);
+													this.ProgressTracker.incrementProgressTracker(1);
 													this.logProgressTrackerStatus();
 													return fWorkComplete();
 												}, tmpDelay);
@@ -131,7 +131,7 @@ suite
 							{
 								let tmpShortOperationCount = 300;
 
-								this.setProgressTrackerTotalOperations(tmpShortOperationCount);
+								this.ProgressTracker.setProgressTrackerTotalOperations(tmpShortOperationCount);
 								this.logProgressTrackerStatus();
 
 								let tmpAnticipate = testFable.newAnticipate();
@@ -146,7 +146,7 @@ suite
 												() =>
 												{
 													this.log.info(`Leetle work done for iteration ${i}.`);
-													this.incrementProgressTracker(1);
+													this.ProgressTracker.incrementProgressTracker(1);
 													this.logProgressTrackerStatus();
 													return fWorkComplete();
 												}, tmpDelay);

package/test/ProgressTracker_tests.js

@@ -13,7 +13,7 @@ var Expect = Chai.expect;
 
 suite
 (
-	'Progress Tracker Tests',
+	'Progress Tracker Set Tests',
 	function()
 	{
 		suite
@@ -28,7 +28,7 @@ suite
 					{
 						let testFable = new libFable();
 
-						let tmpProgressTracker = testFable.instantiateServiceProvider('ProgressTracker');
+						let tmpProgressTracker = testFable.instantiateServiceProvider('ProgressTrackerSet');
 
 						Expect(tmpProgressTracker).to.be.an('object');
 						Expect(tmpProgressTracker).to.have.property('incrementProgressTracker');
@@ -36,6 +36,83 @@ suite
 						return fDone();
 					}
 				);
+				test
+				(
+					'Simple Progress Tracker',
+					function(fTestComplete)
+					{
+						let testFable = new libFable();
+						let tmpProgressTracker = testFable.instantiateServiceProvider('ProgressTrackerSet');
+
+						tmpProgressTracker.createProgressTracker('TestTracker', 200);
+						tmpProgressTracker.logProgressTrackerStatus('TestTracker');
+
+						let tmpAnticipate = testFable.newAnticipate();
+
+						tmpAnticipate.anticipate(
+							function (fDone)
+							{
+								let tmpWaitTime = Math.floor(Math.random() * 10) + 10;
+								this.log.trace(`Starting tracker in ${tmpWaitTime}ms...`);
+								setTimeout(
+									() =>
+									{
+										testFable.ProgressTrackerSet.startProgressTracker('TestTracker');
+										testFable.ProgressTrackerSet.logProgressTrackerStatus('TestTracker');
+										return fDone();
+									}, tmpWaitTime);
+							}.bind(testFable));
+
+						for (let i = 0; i < 201; i++)
+						{
+							tmpAnticipate.anticipate(
+								function (fDone)
+								{
+									let tmpTracker = testFable.ProgressTrackerSet.getProgressTracker('TestTracker');
+
+									if (tmpTracker.data.PercentComplete >= 100)
+									{
+										return fDone();
+									}
+
+									let tmpWaitTime = Math.floor(Math.random() * 10) + 10;
+									let tmpIncrementAmount = Math.floor(Math.random() * 2) + 2;
+
+									setTimeout(
+										() =>
+										{
+											if (tmpTracker.data.PercentComplete < 100)
+											{
+												testFable.ProgressTrackerSet.incrementProgressTracker('TestTracker', tmpIncrementAmount);
+												testFable.ProgressTrackerSet.logProgressTrackerStatus('TestTracker');
+											}
+											return fDone();
+										}, tmpWaitTime);
+								}.bind(testFable));
+						}
+
+						tmpAnticipate.wait(
+							function (pError)
+							{
+								if (pError)
+								{
+									testFable.log.error(`Error: ${pError}`);
+								}
+
+								let tmpWaitTime = Math.floor(Math.random() * 10) + 10;
+								this.log.trace(`Ending tracker in ${tmpWaitTime}ms...`);
+
+								setTimeout(
+									() =>
+									{
+										testFable.ProgressTrackerSet.endProgressTracker('TestTracker');
+										testFable.ProgressTrackerSet.logProgressTrackerStatus('TestTracker');
+										return fTestComplete();
+									}, tmpWaitTime);
+							}.bind(testFable));
+
+					}
+				)
 			}
 		);
 	}