fable 3.0.78 → 3.0.80

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "fable",
-    "version": "3.0.78",
+    "version": "3.0.80",
     "description": "An entity behavior management and API bundling library.",
     "main": "source/Fable.js",
     "scripts": {
@@ -58,7 +58,7 @@
         "cachetrax": "^1.0.4",
         "cookie": "^0.5.0",
         "data-arithmatic": "^1.0.7",
-        "fable-log": "^3.0.10",
+        "fable-log": "^3.0.12",
         "fable-serviceproviderbase": "^3.0.10",
         "fable-settings": "^3.0.8",
         "fable-uuid": "^3.0.5",

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

@@ -423,6 +423,24 @@ class DataFormat extends libFableServiceProviderBase
 		return tmpMonths[pJavascriptDate.getMonth()];
 	}
 
+	formatMonthDayYearFromDate (pJavascriptDate, pStrict)
+	{
+		let tmpStrict = (typeof(pStrict) !== 'undefined') ? pStrict : false;
+
+		let tmpMonth = pJavascriptDate.getMonth() + 1;
+		let tmpDay = pJavascriptDate.getDate();
+		let tmpYear = pJavascriptDate.getFullYear();
+		
+		if (tmpStrict)
+		{
+			tmpMonth = this.stringPadStart(tmpMonth, 2, '0');
+			tmpDay = this.stringPadStart(tmpDay, 2, '0');
+			tmpYear = this.stringPadStart(tmpYear, 4, '0');
+		}
+
+		return `${tmpMonth}/${tmpDay}/${tmpYear}`;
+	}
+	
 	formatSortableStringFromDate (pDate)
 	{
 		return pDate.getFullYear()+this.stringPadStart(pDate.getMonth(),2,'0')+this.stringPadStart(pDate.getDate(),2,'0');

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

@@ -9,6 +9,11 @@ class FableOperation extends libFableServiceBase
 	{
         super(pFable, pOptions, pServiceHash);
 
+		// Timestamps will just be the long ints
+		this.timeStamps = {};
+		// ProgressTrackers have an object format of: {Hash:'SomeHash',EndTime:UINT,CurrentTime:UINT,TotalCount:INT,CurrentCount:INT}
+		this.progressTrackers = {};
+
         this.serviceType = 'PhasedOperation';
 
 		this.state = JSON.parse(_OperationStatePrototypeString);
@@ -79,6 +84,195 @@ class FableOperation extends libFableServiceBase
 		this.writeOperationErrors(pLogText, pLogObject);
 		this.fable.log.fatal(pLogText, pLogObject);
 	}
+	
+	/************************************************************************
+	 * BEGINNING OF -->  Telemetry Helpers
+	 */
+	createTimeStamp(pTimeStampHash)
+	{
+		let tmpTimeStampHash = (typeof(pTimeStampHash) == 'string') ? pTimeStampHash : 'Default';
+		this.timeStamps[tmpTimeStampHash] = +new Date();
+		return this.timeStamps[tmpTimeStampHash];
+	}
+	
+	getTimeDelta(pTimeStampHash)
+	{
+		let tmpTimeStampHash = (typeof(pTimeStampHash) == 'string') ? pTimeStampHash : 'Default';
+		if (this.timeStamps.hasOwnProperty(tmpTimeStampHash))
+		{
+			let tmpEndTime = +new Date();
+			return tmpEndTime-this.timeStamps[tmpTimeStampHash];	
+		}
+		else
+		{
+			return -1;
+		}
+	}
+	
+	logTimeDelta(pTimeStampHash, pMessage)
+	{
+		let tmpTimeStampHash = (typeof(pTimeStampHash) == 'string') ? pTimeStampHash : 'Default';
+		let tmpMessage = (typeof(pMessage) !== 'undefined') ? pMessage : `Elapsed for ${tmpTimeStampHash}: `;
+		let tmpOperationTime = this.getTimeDelta(pTimeStampHash);
+		this.info(tmpMessage +' ('+tmpOperationTime+'ms)');
+		return tmpOperationTime;
+	}
+	
+	createProgressTracker(pTotalOperations, pProgressTrackerHash)
+	{
+		let tmpProgressTrackerHash = (typeof(pProgressTrackerHash) == 'string') ? pProgressTrackerHash : 'DefaultProgressTracker';
+		let tmpTotalOperations = (typeof(pTotalOperations) == 'number') ? pTotalOperations : 100;
+	
+		let tmpProgressTracker = (
+			{
+				Hash: tmpProgressTrackerHash,
+				StartTime: this.createTimeStamp(tmpProgressTrackerHash),
+				EndTime: 0,
+				CurrentTime: 0,
+				PercentComplete: -1,
+				AverageOperationTime: -1,
+				EstimatedCompletionTime: -1,
+				TotalCount: tmpTotalOperations,
+				CurrentCount:-1
+			});
+	
+		this.progressTrackers[tmpProgressTrackerHash] = tmpProgressTracker;
+	
+		return tmpProgressTracker;
+	}
+	
+	solveProgressTrackerStatus(pProgressTrackerHash)
+	{
+		let tmpProgressTrackerHash = (typeof(pProgressTrackerHash) == 'string') ? pProgressTrackerHash : 'DefaultProgressTracker';
+	
+		if (!this.progressTrackers.hasOwnProperty(tmpProgressTrackerHash))
+		{
+			this.createProgressTracker(100, tmpProgressTrackerHash);
+		}
+	
+		let tmpProgressTracker = this.progressTrackers[tmpProgressTrackerHash];
+	
+		tmpProgressTracker.CurrentTime = this.getTimeDelta(tmpProgressTracker.Hash);
+	
+		if ((tmpProgressTracker.CurrentCount > 0) && (tmpProgressTracker.TotalCount > 0))
+		{
+			tmpProgressTracker.PercentComplete = (tmpProgressTracker.CurrentCount / tmpProgressTracker.TotalCount) * 100.0;
+		}
+	
+		if ((tmpProgressTracker.CurrentCount > 0) && (tmpProgressTracker.CurrentTime > 0))
+		{
+			tmpProgressTracker.AverageOperationTime = tmpProgressTracker.CurrentTime / tmpProgressTracker.CurrentCount;
+		}
+	
+		if ((tmpProgressTracker.CurrentCount < tmpProgressTracker.TotalCount) && (tmpProgressTracker.AverageOperationTime > 0))
+		{
+			tmpProgressTracker.EstimatedCompletionTime = (tmpProgressTracker.TotalCount - tmpProgressTracker.CurrentCount) * tmpProgressTracker.AverageOperationTime;
+		}
+	}
+	
+	updateProgressTrackerStatus(pProgressTrackerHash, pCurrentOperations)
+	{
+		let tmpProgressTrackerHash = (typeof(pProgressTrackerHash) == 'string') ? pProgressTrackerHash : 'DefaultProgressTracker';
+		let tmpCurrentOperations = parseInt(pCurrentOperations);
+	
+		if (isNaN(tmpCurrentOperations))
+		{
+			return false;
+		}
+	
+		if (!this.progressTrackers.hasOwnProperty(tmpProgressTrackerHash))
+		{
+			this.createProgressTracker(100, tmpProgressTrackerHash);
+		}
+	
+		this.progressTrackers[tmpProgressTrackerHash].CurrentCount = tmpCurrentOperations;
+		this.progressTrackers[tmpProgressTrackerHash].CurrentTime = this.getTimeDelta(tmpProgressTrackerHash);
+	
+		this.solveProgressTrackerStatus(tmpProgressTrackerHash);
+	
+		return this.progressTrackers[tmpProgressTrackerHash];
+	}
+	
+	incrementProgressTrackerStatus(pProgressTrackerHash, pIncrementSize)
+	{
+		let tmpProgressTrackerHash = (typeof(pProgressTrackerHash) == 'string') ? pProgressTrackerHash : 'DefaultProgressTracker';
+		let tmpIncrementSize = parseInt(pIncrementSize);
+	
+		if (isNaN(tmpIncrementSize))
+		{
+			return false;
+		}
+	
+		if (!this.progressTrackers.hasOwnProperty(tmpProgressTrackerHash))
+		{
+			this.createProgressTracker(100, tmpProgressTrackerHash);
+		}
+	
+		this.progressTrackers[tmpProgressTrackerHash].CurrentCount = this.progressTrackers[tmpProgressTrackerHash].CurrentCount + tmpIncrementSize;
+		this.progressTrackers[tmpProgressTrackerHash].CurrentTime = this.getTimeDelta(tmpProgressTrackerHash);
+	
+		this.solveProgressTrackerStatus(tmpProgressTrackerHash);
+	
+		return this.progressTrackers[tmpProgressTrackerHash];
+	}
+	
+	setProgressTrackerEndTime(pProgressTrackerHash, pCurrentOperations)
+	{
+		let tmpProgressTrackerHash = (typeof(pProgressTrackerHash) == 'string') ? pProgressTrackerHash : 'DefaultProgressTracker';
+		let tmpCurrentOperations = parseInt(pCurrentOperations);
+	
+		if (!this.progressTrackers.hasOwnProperty(tmpProgressTrackerHash))
+		{
+			return false;
+		}
+		if (!isNaN(tmpCurrentOperations))
+		{
+			this.updateProgressTrackerStatus(tmpProgressTrackerHash, tmpCurrentOperations);
+		}
+	
+		this.progressTrackers[tmpProgressTrackerHash].EndTime = this.getTimeDelta(tmpProgressTrackerHash);
+		
+		this.solveProgressTrackerStatus(tmpProgressTrackerHash);
+	
+		return this.progressTrackers[tmpProgressTrackerHash];
+	}
+	
+	printProgressTrackerStatus(pProgressTrackerHash)
+	{
+		let tmpProgressTrackerHash = (typeof(pProgressTrackerHash) == 'string') ? pProgressTrackerHash : 'DefaultProgressTracker';
+		
+		if (!this.progressTrackers.hasOwnProperty(tmpProgressTrackerHash))
+		{
+			this.info(`>> Progress Tracker ${tmpProgressTrackerHash} does not exist!  No stats to display.`);
+		}
+		else
+		{
+			const tmpProgressTracker = this.progressTrackers[tmpProgressTrackerHash];
+	
+			if (tmpProgressTracker.CurrentCount < 1)
+			{
+				this.info(`>> Progress Tracker ${tmpProgressTracker.Hash} has no completed operations.  ${tmpProgressTracker.CurrentTime}ms have elapsed since it was started.`);
+			}
+			else if (tmpProgressTracker.EndTime < 1)
+			{
+				this.info(`>> Progress Tracker ${tmpProgressTracker.Hash} is ${tmpProgressTracker.PercentComplete.toFixed(3)}% completed - ${tmpProgressTracker.CurrentCount} / ${tmpProgressTracker.TotalCount} operations over ${tmpProgressTracker.CurrentTime}ms (median ${tmpProgressTracker.AverageOperationTime.toFixed(3)} per).  Estimated completion in ${tmpProgressTracker.EstimatedCompletionTime.toFixed(0)}ms or ${(tmpProgressTracker.EstimatedCompletionTime / 1000 / 60).toFixed(2)}minutes`)
+			}
+			else
+			{
+				this.info(`>> Progress Tracker ${tmpProgressTracker.Hash} is done and completed ${tmpProgressTracker.CurrentCount} / ${tmpProgressTracker.TotalCount} operations in ${tmpProgressTracker.EndTime}ms.`)
+			}
+		}
+	}
+	
+	// logMemoryResourcesUsed()
+	// {
+	// 
+	// 	const tmpResourcesUsed = process.memoryUsage().heapUsed / 1024 / 1024;
+	// 	this.info(`Memory usage at ${Math.round(tmpResourcesUsed * 100) / 100} MB`);		
+	// }
+	/*
+	 * END OF       -->  Logging and Telemetry Helpers
+	 ************************************************************************/
 }
 
 module.exports = FableOperation;

package/test/DataFormat-StringDateFormatting_tests.js

@@ -103,6 +103,34 @@ suite
 						return fTestComplete();
 					}
 				)
+				test
+				(
+					'Get a human readable string from date',
+					(fTestComplete) =>
+					{
+						let testFable = new libFable();
+						let _DataFormat = testFable.services.DataFormat;
+						let tmpDateInput = new Date('1/02/1986');
+						Expect(_DataFormat
+							.formatMonthDayYearFromDate(tmpDateInput, true))
+							.to.equal('01/02/1986');
+						return fTestComplete();
+					}
+				)
+				test
+				(
+					'Get a human readable string from date no zerofill',
+					(fTestComplete) =>
+					{
+						let testFable = new libFable();
+						let _DataFormat = testFable.services.DataFormat;
+						let tmpDateInput = new Date('06/02/1999');
+						Expect(_DataFormat
+							.formatMonthDayYearFromDate(tmpDateInput, false))
+							.to.equal('6/2/1999');
+						return fTestComplete();
+					}
+				)
 			}
 		);
 	}