meadow-endpoints 3.0.7 → 4.0.2

package/source/controller/Meadow-Endpoints-Controller-Base.js

@@ -0,0 +1,161 @@
+const libAsyncWaterfall = require('async/waterfall');
+
+const libBaseLogController = require('./components/Meadow-Endpoints-Controller-Log.js')
+
+const libBaseErrorController = require('./components/Meadow-Endpoints-Controller-Error.js');
+const libBaseBehaviorInjectionController = require('./components/Meadow-Endpoints-Controller-BehaviorInjection.js');
+
+const libMeadowEndpointsFilterParser = require('./utility/Meadow-Endpoints-Filter-Parser.js');
+const libMeadowEndpointsSessionMarshaler = require('./utility/Meadow-Endpoints-Session-Marshaler.js');
+const libMeadowEndpointsStreamRecordArray = require('./utility/Meadow-Endpoints-Stream-RecordArray.js');
+
+class MeadowEndpointControllerBase
+{
+	constructor(pMeadowEndpoints)
+	{
+		this.DAL = pMeadowEndpoints.DAL;
+		this.ControllerOptions = pMeadowEndpoints._ControllerOptions
+
+		// Application Services
+		this._Settings = false;
+		this._LogController = false;
+
+		// Logic and Behavior
+		this._BehaviorInjectionController = false;
+		this._ErrorController = false;
+
+		// Internal async utility functions
+		this.waterfall = this.DAL.fable.Utility.waterfall;
+		this.eachLimit = this.DAL.fable.Utility.eachLimit;
+		this.extend = this.DAL.fable.Utility.extend;
+
+		if ((typeof(pControllerOptions) != 'object') || pControllerOptions.hasOwnProperty('ControllerClass'))
+		{
+			this.initializeDefaultUnsetControllers(this);
+		}
+
+		// Behavior functions
+		this._FilterParser = new libMeadowEndpointsFilterParser(this);
+		this._SessionMarshaler = new libMeadowEndpointsSessionMarshaler(this);
+		this._StreamRecordArray = new libMeadowEndpointsStreamRecordArray(this);
+	}
+
+	initializeDefaultUnsetControllers(pController)
+	{
+		// Application Services
+		if (!this._Settings)
+		{
+			this._Settings = pController.DAL.fable.settings;
+		}
+		if (!this._Settings.hasOwnProperty('MeadowEndpointsDefaultSessionObject'))
+		{
+			this._Settings.MeadowEndpointsDefaultSessionObject = (
+				{
+					CustomerID: 0,
+					SessionID: '0x0000',
+					DeviceID: 'Unset',
+					UserID: 0,
+					UserRole: 'None',
+					UserRoleIndex: 0,
+					LoggedIn: false
+				});
+		}
+		if (!this._LogController)
+		{
+			this._LogController = new libBaseLogController(pController);
+		}
+		if (!this._BehaviorInjectionController)
+		{
+			this._BehaviorInjectionController = new libBaseBehaviorInjectionController(pController);
+		}
+		if (!this._ErrorController)
+		{
+			this._ErrorController = new libBaseErrorController(pController);
+		}
+	}
+
+	initializeRequestState(pRequest, pVerb)
+	{
+		let tmpRequestState = {};
+
+		tmpRequestState.Verb = (typeof(pVerb) == 'string') ? pVerb : 'Unnamed_Custom_Behavior';
+		tmpRequestState.SessionData = this.getSessionData(pRequest);
+
+		return tmpRequestState;
+	}
+
+	// Clone the session data and verb to a new request state object
+	cloneAsyncSafeRequestState(pRequestState, pNewVerb)
+	{
+		let tmpSafeRequestState = (
+			{
+				ParentRequestState: pRequestState,
+				SessionData: pRequestState.SessionData
+			});
+
+		tmpSafeRequestState.Verb = (typeof(pNewVerb) == 'string') ? pNewVerb : pRequestState.Verb;
+
+		return tmpSafeRequestState;
+	}
+
+	// Override this to provide an alternate ending function that is run with every endpoint.
+	_BeginDataRequestFunction(pRequest, pResponse, fNext)
+	{
+		return fNext();
+	}
+
+	beginMeadowRequest(pRequest, pResponse, fNext)
+	{
+		this._BeginDataRequestFunction(pRequest, pResponse, fNext);
+	}
+
+	// Override this to provide an alternate ending function that is run with every endpoint.
+	_EndDataRequestFunction(pRequest, pResponse, fNext)
+	{
+		return fNext();
+	}
+
+	endMeadowRequest(pRequest, pResponse, fNext)
+	{
+		this._EndDataRequestFunction(pRequest, pResponse, fNext);
+	}
+
+	// Application Services
+	get settings() {return this._Settings; }
+	set settings(pSettings) { this._Settings = pSettings; }
+
+	get log() {return this._LogController; }
+	set log(pLogController) { this._LogController = pLogController; }
+
+	// Logic and Behavior
+	get BehaviorInjection() {return this._BehaviorInjectionController; }
+	set BehaviorInjection(pBehaviorInjectionController) { this._BehaviorInjectionController = pBehaviorInjectionController; }
+
+	get ErrorHandler() {return this._ErrorController; }
+	set ErrorHandler(pErrorController) { this._ErrorController = pErrorController; }
+
+	parseFilter(pFilterString, pQuery)
+	{
+		return this._FilterParser.parseFilter(pFilterString, pQuery);
+	}
+
+	doStreamRecordArray(pResponse, pRecords, fCallback)
+	{
+		return this._StreamRecordArray.streamRecordArray(pResponse, pRecords, fCallback);
+	}
+
+	getSessionData(pRequest)
+	{
+		return this._SessionMarshaler.getSessionData(pRequest);
+	}
+}
+
+module.exports = MeadowEndpointControllerBase;
+
+// Export the base classes for the controller components, for inheritance
+module.exports.BaseErrorController = libBaseErrorController;
+module.exports.BaseBehaviorInjectionController = libBaseBehaviorInjectionController;
+
+module.exports.BaseFilterParser = libMeadowEndpointsFilterParser;
+module.exports.BaseSessionMarshaler = libMeadowEndpointsSessionMarshaler;
+module.exports.BaseStreamRecordArray = libMeadowEndpointsStreamRecordArray;

package/source/controller/components/Meadow-Endpoints-Controller-BehaviorInjection.js

@@ -0,0 +1,125 @@
+class MeadowEndpointsControllerBehaviorInjectionBase
+{
+    constructor(pController)
+	{
+        this._Controller = pController;
+
+        // The template compilation function
+		this.template = this._Controller.DAL.fable.Utility.template;
+
+		// An object to hold modifications to specific behaviors.
+		this._BehaviorFunctions = {};
+
+		// A set of objects to hold the specific templates and their compiled functions
+		this._Templates = {};
+		this._TemplateFunctions = {};
+    }
+
+	/**
+	* Set a specific behavior.
+	*
+	* The anatomy of a behavior function is as follows:
+	*
+	* var someBehavior = function(pRequest, fCallback)
+	* {
+	*      // Do some stuff with pRequest...
+	*      if (pRequest.UserSession.UserRoleIndex < 5)
+	*          tmpRequestState.Query.addFilter('Customer', pRequest.UserSession.IDCustomer);
+	*      return fCallback(false);
+	* }
+	*
+	* It is important to note that the fCallback function expects false if no error, or a string message if there is one.
+	*/
+	setBehavior(pBehaviorHash, fBehavior)
+	{
+		this._BehaviorFunctions[pBehaviorHash] = fBehavior;
+	}
+
+	/**
+	* This method runs a behavior at a specific hash, and returns true.
+	* Or it returns false if there was no behavior there.
+	* Behaviors should expect their state to be in the pRequest object, per the example in setBehavior
+	*/
+	runBehavior(pBehaviorHash, pController, pRequest, pRequestState, fCallback)
+	{
+		// Run an injected behavior (if it exists)
+		if (this._BehaviorFunctions.hasOwnProperty(pBehaviorHash))
+		{
+			try
+			{
+				// Call the behavior with the scoped [this] of the Meadow behavior
+				// NOTE: If you define a behavior with lambda arrow syntax, it will *not* respect the call
+				return this._BehaviorFunctions[pBehaviorHash].call(pController, pRequest, pRequestState, fCallback);
+			}
+			catch (pInjectedBehaviorError)
+			{
+				return fCallback(pInjectedBehaviorError);
+			}
+		}
+
+		return fCallback();
+	}
+
+	/**
+	* Get a template.
+	*/
+	getTemplate(pTemplateHash)
+	{
+		if (this._Templates.hasOwnProperty(pTemplateHash))
+		{
+			return this._Templates[pTemplateHash];
+		}
+		else
+		{
+			return false;
+		}
+	}
+
+	/**
+	* Set a template.
+	*/
+	setTemplate(pTemplateHash, pTemplate)
+	{
+		// Store both the cached text as well as the function
+		this._Templates[pTemplateHash] = pTemplate;
+		this._TemplateFunctions[pTemplateHash] = this.template(pTemplate);
+	}
+
+	/**
+	* Get a template function.
+	*/
+	getTemplateFunction(pTemplateHash)
+	{
+		if (this._TemplateFunctions.hasOwnProperty(pTemplateHash))
+		{
+			return this._TemplateFunctions[pTemplateHash];
+		}
+		else
+		{
+			return false;
+		}
+	}
+
+	/**
+	* Process a template at a hash, and return the result.
+	*/
+	processTemplate(pTemplateHash, pTemplateData, pDefaultTemplate)
+	{
+		var tmpTemplateFunction = this.getTemplateFunction(pTemplateHash);
+		var tmpTemplateData = (typeof(pTemplateData) === 'undefined') ? {} : pTemplateData;
+
+		// This makes the function fairly laziliy loading.
+		if (tmpTemplateFunction === false)
+		{
+			// If the template doesn't exist, try to use the passed-in default and set that as the template.
+			// Otherwise make it empty.
+			this.setTemplate(pTemplateHash, (typeof(pDefaultTemplate) === 'undefined') ? '' : pDefaultTemplate);
+			tmpTemplateFunction = this.getTemplateFunction(pTemplateHash);
+		}
+
+		// Now process and return the underscore template.
+		return tmpTemplateFunction(tmpTemplateData);
+	}
+}
+
+module.exports = MeadowEndpointsControllerBehaviorInjectionBase;

package/source/controller/components/Meadow-Endpoints-Controller-Error-StatusCodes.txt

@@ -0,0 +1,189 @@
+PULLED FROM https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
+
+   Internet Assigned Numbers Authority
+
+   Hypertext Transfer Protocol (HTTP) Status Code Registry
+
+   Last Updated
+           2022-06-08
+
+   Available Formats
+           [IMG]
+           XML [IMG]
+           HTML [IMG]
+           Plain text
+
+   Registry included below
+
+     * HTTP Status Codes
+
+HTTP Status Codes
+
+   Registration Procedure(s)
+
+IETF Review
+
+   Reference
+           [RFC9110, Section 16.2.1]
+
+   Note
+
+ 1xx: Informational - Request received, continuing process
+ 2xx: Success - The action was successfully received, understood, and accepted
+ 3xx: Redirection - Further action must be taken in order to complete the request
+ 4xx: Client Error - The request contains bad syntax or cannot be fulfilled
+ 5xx: Server Error - The server failed to fulfill an apparently valid request
+
+    Value            Description                                 Reference
+     100   Continue                        [RFC9110, Section 15.2.1]
+     101   Switching Protocols             [RFC9110, Section 15.2.2]
+     102   Processing                      [RFC2518]
+     103   Early Hints                     [RFC8297]
+   104-199 Unassigned
+     200   OK                              [RFC9110, Section 15.3.1]
+     201   Created                         [RFC9110, Section 15.3.2]
+     202   Accepted                        [RFC9110, Section 15.3.3]
+     203   Non-Authoritative Information   [RFC9110, Section 15.3.4]
+     204   No Content                      [RFC9110, Section 15.3.5]
+     205   Reset Content                   [RFC9110, Section 15.3.6]
+     206   Partial Content                 [RFC9110, Section 15.3.7]
+     207   Multi-Status                    [RFC4918]
+     208   Already Reported                [RFC5842]
+   209-225 Unassigned
+     226   IM Used                         [RFC3229]
+   227-299 Unassigned
+     300   Multiple Choices                [RFC9110, Section 15.4.1]
+     301   Moved Permanently               [RFC9110, Section 15.4.2]
+     302   Found                           [RFC9110, Section 15.4.3]
+     303   See Other                       [RFC9110, Section 15.4.4]
+     304   Not Modified                    [RFC9110, Section 15.4.5]
+     305   Use Proxy                       [RFC9110, Section 15.4.6]
+     306   (Unused)                        [RFC9110, Section 15.4.7]
+     307   Temporary Redirect              [RFC9110, Section 15.4.8]
+     308   Permanent Redirect              [RFC9110, Section 15.4.9]
+   309-399 Unassigned
+     400   Bad Request                     [RFC9110, Section 15.5.1]
+     401   Unauthorized                    [RFC9110, Section 15.5.2]
+     402   Payment Required                [RFC9110, Section 15.5.3]
+     403   Forbidden                       [RFC9110, Section 15.5.4]
+     404   Not Found                       [RFC9110, Section 15.5.5]
+     405   Method Not Allowed              [RFC9110, Section 15.5.6]
+     406   Not Acceptable                  [RFC9110, Section 15.5.7]
+     407   Proxy Authentication Required   [RFC9110, Section 15.5.8]
+     408   Request Timeout                 [RFC9110, Section 15.5.9]
+     409   Conflict                        [RFC9110, Section 15.5.10]
+     410   Gone                            [RFC9110, Section 15.5.11]
+     411   Length Required                 [RFC9110, Section 15.5.12]
+     412   Precondition Failed             [RFC9110, Section 15.5.13]
+     413   Content Too Large               [RFC9110, Section 15.5.14]
+     414   URI Too Long                    [RFC9110, Section 15.5.15]
+     415   Unsupported Media Type          [RFC9110, Section 15.5.16]
+     416   Range Not Satisfiable           [RFC9110, Section 15.5.17]
+     417   Expectation Failed              [RFC9110, Section 15.5.18]
+     418   (Unused)                        [RFC9110, Section 15.5.19]
+   419-420 Unassigned
+     421   Misdirected Request             [RFC9110, Section 15.5.20]
+     422   Unprocessable Content           [RFC9110, Section 15.5.21]
+     423   Locked                          [RFC4918]
+     424   Failed Dependency               [RFC4918]
+     425   Too Early                       [RFC8470]
+     426   Upgrade Required                [RFC9110, Section 15.5.22]
+     427   Unassigned
+     428   Precondition Required           [RFC6585]
+     429   Too Many Requests               [RFC6585]
+     430   Unassigned
+     431   Request Header Fields Too Large [RFC6585]
+   432-450 Unassigned
+     451   Unavailable For Legal Reasons   [RFC7725]
+   452-499 Unassigned
+     500   Internal Server Error           [RFC9110, Section 15.6.1]
+     501   Not Implemented                 [RFC9110, Section 15.6.2]
+     502   Bad Gateway                     [RFC9110, Section 15.6.3]
+     503   Service Unavailable             [RFC9110, Section 15.6.4]
+     504   Gateway Timeout                 [RFC9110, Section 15.6.5]
+     505   HTTP Version Not Supported      [RFC9110, Section 15.6.6]
+     506   Variant Also Negotiates         [RFC2295]
+     507   Insufficient Storage            [RFC4918]
+     508   Loop Detected                   [RFC5842]
+     509   Unassigned
+     510   Not Extended (OBSOLETED)        [RFC2774][status-change-http-experiments-to-historic]
+     511   Network Authentication Required [RFC6585]
+   512-599 Unassigned
+
+   Licensing Terms
+
+    Value            Description                                 Reference
+     100   Continue                        [RFC9110, Section 15.2.1]
+     101   Switching Protocols             [RFC9110, Section 15.2.2]
+     102   Processing                      [RFC2518]
+     103   Early Hints                     [RFC8297]
+   104-199 Unassigned
+     200   OK                              [RFC9110, Section 15.3.1]
+     201   Created                         [RFC9110, Section 15.3.2]
+     202   Accepted                        [RFC9110, Section 15.3.3]
+     203   Non-Authoritative Information   [RFC9110, Section 15.3.4]
+     204   No Content                      [RFC9110, Section 15.3.5]
+     205   Reset Content                   [RFC9110, Section 15.3.6]
+     206   Partial Content                 [RFC9110, Section 15.3.7]
+     207   Multi-Status                    [RFC4918]
+     208   Already Reported                [RFC5842]
+   209-225 Unassigned
+     226   IM Used                         [RFC3229]
+   227-299 Unassigned
+     300   Multiple Choices                [RFC9110, Section 15.4.1]
+     301   Moved Permanently               [RFC9110, Section 15.4.2]
+     302   Found                           [RFC9110, Section 15.4.3]
+     303   See Other                       [RFC9110, Section 15.4.4]
+     304   Not Modified                    [RFC9110, Section 15.4.5]
+     305   Use Proxy                       [RFC9110, Section 15.4.6]
+     306   (Unused)                        [RFC9110, Section 15.4.7]
+     307   Temporary Redirect              [RFC9110, Section 15.4.8]
+     308   Permanent Redirect              [RFC9110, Section 15.4.9]
+   309-399 Unassigned
+     400   Bad Request                     [RFC9110, Section 15.5.1]
+     401   Unauthorized                    [RFC9110, Section 15.5.2]
+     402   Payment Required                [RFC9110, Section 15.5.3]
+     403   Forbidden                       [RFC9110, Section 15.5.4]
+     404   Not Found                       [RFC9110, Section 15.5.5]
+     405   Method Not Allowed              [RFC9110, Section 15.5.6]
+     406   Not Acceptable                  [RFC9110, Section 15.5.7]
+     407   Proxy Authentication Required   [RFC9110, Section 15.5.8]
+     408   Request Timeout                 [RFC9110, Section 15.5.9]
+     409   Conflict                        [RFC9110, Section 15.5.10]
+     410   Gone                            [RFC9110, Section 15.5.11]
+     411   Length Required                 [RFC9110, Section 15.5.12]
+     412   Precondition Failed             [RFC9110, Section 15.5.13]
+     413   Content Too Large               [RFC9110, Section 15.5.14]
+     414   URI Too Long                    [RFC9110, Section 15.5.15]
+     415   Unsupported Media Type          [RFC9110, Section 15.5.16]
+     416   Range Not Satisfiable           [RFC9110, Section 15.5.17]
+     417   Expectation Failed              [RFC9110, Section 15.5.18]
+     418   (Unused)                        [RFC9110, Section 15.5.19]
+   419-420 Unassigned
+     421   Misdirected Request             [RFC9110, Section 15.5.20]
+     422   Unprocessable Content           [RFC9110, Section 15.5.21]
+     423   Locked                          [RFC4918]
+     424   Failed Dependency               [RFC4918]
+     425   Too Early                       [RFC8470]
+     426   Upgrade Required                [RFC9110, Section 15.5.22]
+     427   Unassigned
+     428   Precondition Required           [RFC6585]
+     429   Too Many Requests               [RFC6585]
+     430   Unassigned
+     431   Request Header Fields Too Large [RFC6585]
+   432-450 Unassigned
+     451   Unavailable For Legal Reasons   [RFC7725]
+   452-499 Unassigned
+     500   Internal Server Error           [RFC9110, Section 15.6.1]
+     501   Not Implemented                 [RFC9110, Section 15.6.2]
+     502   Bad Gateway                     [RFC9110, Section 15.6.3]
+     503   Service Unavailable             [RFC9110, Section 15.6.4]
+     504   Gateway Timeout                 [RFC9110, Section 15.6.5]
+     505   HTTP Version Not Supported      [RFC9110, Section 15.6.6]
+     506   Variant Also Negotiates         [RFC2295]
+     507   Insufficient Storage            [RFC4918]
+     508   Loop Detected                   [RFC5842]
+     509   Unassigned
+     510   Not Extended (OBSOLETED)        [RFC2774][status-change-http-experiments-to-historic]
+     511   Network Authentication Required [RFC6585]
+   512-599 Unassigned

package/source/controller/components/Meadow-Endpoints-Controller-Error.js

@@ -0,0 +1,118 @@
+class MeadowEndpointsControllerErrorBase
+{
+    constructor(pController)
+	{
+        this._Controller = pController;
+    }
+
+    // Get the error object
+    getError(pMessage, pStatusCode, pSuppressSoftwareTrace)
+    {
+		let tmpError = new Error(pMessage);
+
+    	// Default the error status code to 400 if none is passed
+		tmpError.StatusCode = (typeof(pStatusCode) == 'number') ? pStatusCode : 400;
+		// This suppresses the stack trace from being sent back or logged.
+		// And by default it does not send a stack trace, as we expect errors created this way to be protocol, schema or data related.
+		tmpError.SuppressSoftwareTrace = (typeof(pSuppressSoftwareTrace) != 'undefined') ? pSuppressSoftwareTrace : true;
+
+        return tmpError;
+    }
+
+    // Handle an error if set -- some errors don't send the response back because they aren't fully errory errors.
+	handleErrorIfSet(pRequest, pRequestState, pResponse, pError, fCallback)
+	{
+		if (pError)
+		{
+			return this.sendError(pRequest, pRequestState, pResponse, pError, fCallback);
+		}
+
+		return fCallback();
+	}
+
+    // Send an error object
+	sendError(pRequest, pRequestState, pResponse, pError, fCallback)
+	{
+		this._Controller.log.logRequestError(pRequest, pRequestState, pError);
+
+		// TODO: Detect if we've already sent headers?
+		if (!this._Controller.ControllerOptions.SendErrorStatusCodes)
+		{
+			let tmpStatusCode = (pError.hasOwnProperty('StatusCode')) ? pError.StatusCode : 500;
+			pResponse.status(tmpStatusCode);
+		}
+
+		let tmpResponseObject = (
+			{
+				Error:pError.message,
+				StatusCode:pError.StatusCode
+			});
+
+		tmpResponseObject = this._Controller.ErrorHandler.prepareRequestContextOutputObject(tmpResponseObject, pRequest, pRequestState, pError);
+
+		pResponse.send(tmpResponseObject);
+
+		fCallback(pError);
+	}
+
+	// This looks for some generic markers in the request state and puts them into a log or send object
+	prepareRequestContextOutputObject(pObjectToPopulate, pRequest, pRequestState, pError)
+	{
+		// Internally created errors supress stack traces
+		if (pError)
+		{
+			pObjectToPopulate.Error = pError.message;
+			pObjectToPopulate.Code = pError.code;
+			pObjectToPopulate.StatusCode = pError.StatusCode;
+
+			if (!pError.SuppressSoftwareTrace)
+			{
+				pObjectToPopulate.Stack = pError.stack;
+			}
+
+			if (pRequestState.hasOwnProperty('Record'))
+			{
+				pObjectToPopulate.Record = pRequestState.Record;
+			}
+
+			if (pRequestState.hasOwnProperty('Query') && (typeof(pRequestState.Query) == 'object'))
+			{
+				if (pRequestState.Query.query)
+				{
+					if (typeof(pRequestState.Query.query.body) == 'string')
+					{
+						pObjectToPopulate.Query = pRequestState.Query.query.body;
+					}
+
+					if ((typeof(pRequestState.Query.query.parameters) == 'object'))
+					{
+						pObjectToPopulate.QueryParameters = pRequestState.Query.query.parameters;
+
+						pObjectToPopulate.RebuiltQueryString = (typeof(pObjectToPopulate.Query) == 'string') ? pObjectToPopulate.Query : '';
+
+						// This gnarly bit of code attempts to reconstruct a non prepared string version of the query, to help.
+						let tmpQueryParameterSet = Object.keys(pObjectToPopulate.QueryParameters);
+						for (let i = 0; i < tmpQueryParameterSet.length; i++)
+						{
+							switch(typeof(tmpQueryParameterSet[i]))
+							{
+								case 'number':
+									pObjectToPopulate.RebuiltQueryString  = pObjectToPopulate.RebuiltQueryString.replace(new RegExp(`:${tmpQueryParameterSet[i]}\\b`, 'g'), `'${pObjectToPopulate.QueryParameters[tmpQueryParameterSet[i]]}'`);
+									break;
+								case 'string':
+									// TODO: This may need more ... nuance...
+									default:
+									pObjectToPopulate.RebuiltQueryString  = pObjectToPopulate.RebuiltQueryString.replace(new RegExp(`:${tmpQueryParameterSet[i]}\\b`,'g'), pObjectToPopulate.QueryParameters[tmpQueryParameterSet[i]]);
+									break;
+							}
+						}
+					}
+				}
+			}
+		}
+
+		return pObjectToPopulate;
+	}
+}
+
+module.exports = MeadowEndpointsControllerErrorBase;

package/source/controller/components/Meadow-Endpoints-Controller-Log.js

@@ -0,0 +1,103 @@
+class MeadowEndpointsControllerLogBase
+{
+    constructor(pController)
+	{
+        this._Controller = pController;
+    }
+
+	// This is called for every successful request log line.  Be careful what you add in overloads!
+	prepareLogData(pRequest, pRequestState, pLogData)
+	{
+		// TODO: Discuss if these should be configurations
+		if (pRequestState.hasOwnProperty('Record'))
+		{
+			if (pRequestState.Record.hasOwnProperty(this._Controller.DAL.defaultIdentifier))
+			{
+				pLogData[this._Controller.DAL.defaultIdentifier] = pRequestState.Record[this._Controller.DAL.defaultIdentifier];
+			}
+			if (pRequestState.Record.hasOwnProperty(this._Controller.DAL.defaultGUIdentifier))
+			{
+				pLogData[this._Controller.DAL.defaultGUIdentifier] = pRequestState.Record[this._Controller.DAL.defaultGUIdentifier];
+			}
+		}
+		if (pRequestState.hasOwnProperty('UpdatedRecords'))
+		{
+			pLogData.UpdatedRecordCount = pRequestState.UpdatedRecords.length;
+		}
+		if (pRequestState.hasOwnProperty('CreatedRecords'))
+		{
+			pLogData.UpdatedRecordCount = pRequestState.CreatedRecords.length;
+		}
+		if (pRequestState.hasOwnProperty('UpsertedRecords'))
+		{
+			pLogData.UpdatedRecordCount = pRequestState.UpsertedRecords.length;
+		}
+		return pLogData;
+	}
+
+    // This is called whenever an endpoint is completed successfully
+	requestCompletedSuccessfully(pRequest, pRequestState, pActionSummary)
+	{
+		let tmpLogData = (
+			{
+				SessionID: pRequestState.SessionData.SessionID,
+				RequestID: pRequest.RequestUUID,
+				RequestURL: pRequest.url,
+				Scope: this._Controller.DAL.scope,
+				Action: `${this._Controller.DAL.scope}-${pRequestState.Verb}`,
+				Verb: pRequestState.Verb
+			});
+
+		this._Controller.log.info(pActionSummary, this.prepareLogData(pRequest, pRequestState, tmpLogData));
+	}
+
+    // This is called whenever an endpoint is completed successfully
+	logRequestError(pRequest, pRequestState, pError)
+	{
+		let tmpErrorLogData = (
+			{
+				SessionID: pRequestState.SessionData.SessionID,
+				RequestID: pRequest.RequestUUID,
+				RequestURL: pRequest.url,
+				Scope: this._Controller.DAL.scope,
+				Action: `${this._Controller.DAL.scope}-${pRequestState.Verb}`,
+				Verb: pRequestState.Verb,
+			});
+
+		tmpErrorLogData = this._Controller.ErrorHandler.prepareRequestContextOutputObject(tmpErrorLogData, pRequest, pRequestState, pError);
+
+		this._Controller.log.error(pError.message, this.prepareLogData(pRequest, pRequestState, tmpErrorLogData));
+	}
+
+    trace(pLogText, pLogObject)
+	{
+		this._Controller.DAL.log.trace(pLogText, pLogObject);
+	}
+
+	debug(pLogText, pLogObject)
+	{
+		this._Controller.DAL.log.debug(pLogText, pLogObject);
+	}
+
+	info(pLogText, pLogObject)
+	{
+		this._Controller.DAL.log.info(pLogText, pLogObject);
+	}
+
+	warn(pLogText, pLogObject)
+	{
+		this._Controller.DAL.log.warn(pLogText, pLogObject);
+	}
+
+	error(pLogText, pLogObject)
+	{
+		this._Controller.DAL.log.error(pLogText, pLogObject);
+	}
+
+	fatal(pLogText, pLogObject)
+	{
+		this._Controller.DAL.log.fatal(pLogText, pLogObject);
+	}
+}
+
+module.exports = MeadowEndpointsControllerLogBase;