meadow-endpoints 2.0.12 → 3.0.0

package/source/crud/Meadow-Endpoint-ReadDistinctList.js

@@ -0,0 +1,146 @@
+/**
+* Meadow Endpoint - Read a list of Records with a specified set of columns, distinct by those columns.
+*
+* @license MIT
+*
+* @author Alex Decker <alex.decker@headlight.com>
+* @module Meadow
+*/
+const libAsync = require('async');
+const meadowFilterParser = require('meadow-filter').parse;
+const marshalDistinctList = require('./Meadow-Marshal-DistinctList.js');
+const streamRecordsToResponse = require('./Meadow-StreamRecordArray');
+
+/**
+* Get a set of records from a DAL.
+*/
+const doAPIReadDistinctEndpoint = function(pRequest, pResponse, fNext)
+{
+	// This state is the requirement for the UserRoleIndex value in the UserSession object... processed by default as >=
+	// The default here is that any authenticated user can use this endpoint.
+	pRequest.EndpointAuthorizationRequirement = pRequest.EndpointAuthorizationLevels.Reads;
+
+	// INJECT: Pre authorization (for instance to change the authorization level)
+
+	if (pRequest.CommonServices.authorizeEndpoint(pRequest, pResponse, fNext) === false)
+	{
+		// If this endpoint fails, it's sent an error automatically.
+		return;
+	}
+
+	let tmpDistinctColumns;
+	libAsync.waterfall(
+		[
+			// 1a. Get the records
+			function (fStageComplete)
+			{
+				pRequest.Query = pRequest.DAL.query.setDistinct(true);
+				// TODO: Limit the query to the columns we need for the templated expression
+
+				let tmpCap = false;
+				let tmpBegin = false;
+				if (typeof(pRequest.params.Begin) === 'string' ||
+					typeof(pRequest.params.Begin) === 'number')
+				{
+					tmpBegin = parseInt(pRequest.params.Begin, 10);
+				}
+				if (typeof(pRequest.params.Cap) === 'string' ||
+					typeof(pRequest.params.Cap) === 'number')
+				{
+					tmpCap = parseInt(pRequest.params.Cap, 10);
+				}
+				else
+				{
+					//maximum number of records to return by default on Read queries. Override via "MeadowDefaultMaxCap" fable setting.
+					tmpCap = pRequest.DEFAULT_MAX_CAP;
+				}
+				pRequest.Query.setCap(tmpCap).setBegin(tmpBegin);
+				if (typeof(pRequest.params.Filter) === 'string')
+				{
+					// If a filter has been passed in, parse it and add the values to the query.
+					meadowFilterParser(pRequest.params.Filter, pRequest.Query);
+				}
+				else if (pRequest.params.Filter)
+				{
+					pRequest.Query.setFilter(pRequest.params.Filter);
+				}
+				if (typeof(pRequest.params.Columns) === 'string')
+				{
+					tmpDistinctColumns = pRequest.params.Columns.split(',');
+					if (!tmpDistinctColumns)
+					{
+						return fStageComplete({Code:400,Message:'Columns to distinct on must be provided.'});
+					}
+					pRequest.Query.setDataElements(tmpDistinctColumns);
+				}
+				fStageComplete(false);
+			},
+			// 1b. INJECT: Query configuration
+			function (fStageComplete)
+			{
+				pRequest.BehaviorModifications.runBehavior('Reads-QueryConfiguration', pRequest, fStageComplete);
+			},
+			// 1b2. INJECT: Query pre-authorization behavior (ex. if authorizer needs fields to be included, it can add them)
+			function (fStageComplete)
+			{
+				pRequest.BehaviorModifications.runBehavior('Reads-PreAuth', pRequest, fStageComplete);
+			},
+			// 1c. Do the record read
+			function (fStageComplete)
+			{
+				pRequest.DAL.doReads(pRequest.Query, fStageComplete);
+			},
+			// 2. Post processing of the records
+			function (pQuery, pRecords, fStageComplete)
+			{
+				if (pRecords.length < 1)
+				{
+					pRecords = [];
+				}
+
+				pRequest.Records = pRecords;
+
+				// Complete the waterfall operation
+				fStageComplete(false);
+			},
+			// 2.5: Check if there is an authorizer set for this endpoint and user role combination, and authorize based on that
+			function (fStageComplete)
+			{
+				// shared permission with reads
+				pRequest.Authorizers.authorizeRequest('Reads', pRequest, fStageComplete);
+			},
+			// 2.6: Check if authorization or post processing denied security access to the record
+			function (fStageComplete)
+			{
+				if (pRequest.MeadowAuthorization)
+				{
+					return fStageComplete(false);
+				}
+
+				// It looks like this record was not authorized.  Send an error.
+				return fStageComplete({Code:405,Message:'UNAUTHORIZED ACCESS IS NOT ALLOWED'});
+			},
+			// 3. Marshalling of records into the hash list, using underscore templates.
+			function (fStageComplete)
+			{
+				fStageComplete(false, marshalDistinctList(pRequest.Records, pRequest, tmpDistinctColumns));
+			}
+		],
+		// 3. Return the results to the user
+		function(pError, pResultRecords)
+		{
+			// Remove 'Records' object from pRequest, instead return template results (pResultRecords) for the records
+			delete pRequest['Records'];
+
+			if (pError)
+			{
+				return pRequest.CommonServices.sendCodedError('Error retreiving a recordset.', pError, pRequest, pResponse, fNext);
+			}
+
+			pRequest.CommonServices.log.info('Read a recordset lite list with '+pResultRecords.length+' results.', {SessionID:pRequest.UserSession.SessionID, RequestID:pRequest.RequestUUID, RequestURL:pRequest.url, Action:pRequest.DAL.scope+'-ReadDistinct'}, pRequest);
+			return streamRecordsToResponse(pResponse, pResultRecords, fNext);
+		}
+	);
+};
+
+module.exports = doAPIReadDistinctEndpoint;

package/source/crud/Meadow-Endpoint-ReadLiteList.js

@@ -7,7 +7,7 @@
 * @module Meadow
 */
 var libAsync = require('async');
-var meadowFilterParser = require('./Meadow-Filter-Parse.js');
+const meadowFilterParser = require('meadow-filter').parse;
 var marshalLiteList = require('./Meadow-Marshal-LiteList.js');
 const streamRecordsToResponse = require('./Meadow-StreamRecordArray');
 
@@ -71,6 +71,11 @@ var doAPIReadLiteEndpoint = function(pRequest, pResponse, fNext)
 			{
 				pRequest.BehaviorModifications.runBehavior('Reads-QueryConfiguration', pRequest, fStageComplete);
 			},
+			// 1b2. INJECT: Query pre-authorization behavior (ex. if authorizer needs fields to be included, it can add them)
+			function (fStageComplete)
+			{
+				pRequest.BehaviorModifications.runBehavior('Reads-PreAuth', pRequest, fStageComplete);
+			},
 			// 1c. Do the record read
 			function (fStageComplete)
 			{
@@ -92,7 +97,8 @@ var doAPIReadLiteEndpoint = function(pRequest, pResponse, fNext)
 			// 2.5: Check if there is an authorizer set for this endpoint and user role combination, and authorize based on that
 			function (fStageComplete)
 			{
-				pRequest.Authorizers.authorizeRequest('ReadLite', pRequest, fStageComplete);
+				// shared permission with reads
+				pRequest.Authorizers.authorizeRequest('Reads', pRequest, fStageComplete);
 			},
 			// 2.6: Check if authorization or post processing denied security access to the record
 			function (fStageComplete)

package/source/crud/Meadow-Endpoint-ReadSelectList.js

@@ -7,7 +7,7 @@
 * @module Meadow
 */
 var libAsync = require('async');
-var meadowFilterParser = require('./Meadow-Filter-Parse.js');
+const meadowFilterParser = require('meadow-filter').parse;
 const streamRecordsToResponse = require('./Meadow-StreamRecordArray');
 
 /**
@@ -66,6 +66,11 @@ var doAPIReadSelectListEndpoint = function(pRequest, pResponse, fNext)
 			{
 				pRequest.BehaviorModifications.runBehavior('Reads-QueryConfiguration', pRequest, fStageComplete);
 			},
+			// 1b2. INJECT: Query pre-authorization behavior (ex. if authorizer needs fields to be included, it can add them)
+			function (fStageComplete)
+			{
+				pRequest.BehaviorModifications.runBehavior('Reads-PreAuth', pRequest, fStageComplete);
+			},
 			// 1c. Do the record read
 			function (fStageComplete)
 			{

package/source/crud/Meadow-Endpoint-Reads.js

@@ -7,7 +7,7 @@
 * @module Meadow
 */
 var libAsync = require('async');
-var meadowFilterParser = require('./Meadow-Filter-Parse.js');
+const meadowFilterParser = require('meadow-filter').parse;
 const streamRecordsToResponse = require('./Meadow-StreamRecordArray');
 
 /**
@@ -67,6 +67,11 @@ var doAPIReadsEndpoint = function(pRequest, pResponse, fNext)
 			{
 				pRequest.BehaviorModifications.runBehavior('Reads-QueryConfiguration', pRequest, fStageComplete);
 			},
+			// 2b. INJECT: Query pre-authorization behavior (ex. if authorizer needs fields to be included, it can add them)
+			function (fStageComplete)
+			{
+				pRequest.BehaviorModifications.runBehavior('Reads-PreAuth', pRequest, fStageComplete);
+			},
 			// 3. Execute the query
 			function (fStageComplete)
 			{

package/source/crud/Meadow-Endpoint-ReadsBy.js

@@ -94,6 +94,11 @@ var doAPIReadsByEndpoint = function(pRequest, pResponse, fNext)
 			{
 				pRequest.BehaviorModifications.runBehavior('Reads-QueryConfiguration', pRequest, fStageComplete);
 			},
+			// 3b. INJECT: Query pre-authorization behavior (ex. if authorizer needs fields to be included, it can add them)
+			function (fStageComplete)
+			{
+				pRequest.BehaviorModifications.runBehavior('Reads-PreAuth', pRequest, fStageComplete);
+			},
 			// 4. Execute the query
 			function (fStageComplete)
 			{

package/source/crud/Meadow-Marshal-DistinctList.js

@@ -0,0 +1,55 @@
+/**
+* Meadow Operation - Marshal an array of records into a lite list
+*
+* @license MIT
+*
+* @author Steven Velozo <steven@velozo.com>
+* @module Meadow
+*/
+/**
+* Shared record marshaling code
+*/
+
+var marshalDistinctList = (pRecords, pRequest, pFieldList) =>
+{
+	if (pRecords.length < 1)
+		return [];
+
+	let tmpDistinctList = [];
+	// Allow the caller to pass in a list of fields.
+	let tmpFieldList = (typeof(pFieldList) !== 'undefined') ? pFieldList : [];
+
+	// See if this record has a GUID in the schema
+	let tmpGUID = (pRequest.DAL.defaultGUIdentifier && pRequest.DAL.defaultGUIdentifier.length > 0) ? pRequest.DAL.defaultGUIdentifier : false;
+	// Peek at the first record to check for updatedate
+	let tmpHasUpdateDate = (pRecords[0].hasOwnProperty('UpdateDate')) ? true : false;
+	//Include all GUID and ID fields on the record
+	let tmpRecordFields = Object.keys(pRecords[0]);
+
+	let h = 0;
+	while (h < tmpFieldList.length)
+	{
+		// Remove any fields in the list that aren't in the first record.
+		if (!pRecords[0].hasOwnProperty(tmpFieldList[0]))
+			tmpFieldList.splice(h, 1);
+		else
+			h++;
+	}
+
+	for (let i = 0; i < pRecords.length; i++)
+	{
+		let tmpDistinctRecord = { };
+
+		tmpFieldList.forEach(
+			(pField) =>
+			{
+				tmpDistinctRecord[pField] = pRecords[i][pField];
+			});
+
+		tmpDistinctList.push(tmpDistinctRecord);
+	}
+
+	return tmpDistinctList;
+};
+
+module.exports = marshalDistinctList;

package/test/MeadowEndpoints_basic_tests.js

@@ -22,6 +22,9 @@ var tmpFableSettings = 	(
 
 	"UnauthorizedRequestDelay": 10,
 
+	MeadowAuthenticationMode: 'LoggedIn',
+	MeadowAuthorizationMode: 'SimpleOwnership',
+
 	APIServerPort: 9080,
 
 	MySQL:
@@ -40,7 +43,6 @@ var tmpFableSettings = 	(
 var libFable = require('fable').new(tmpFableSettings);
 tmpFableSettings = libFable.settings;
 
-var libMySQL = require('mysql2');
 libFable.MeadowMySQLConnectionPool = libMySQL.createPool
 	(
 		{
@@ -807,7 +809,6 @@ suite
 					function(fDone)
 					{
 						libSuperTest('http://localhost:9080/')
-						// Get page 2, 2 records per page.
 						.get('1.0/FableTests/FilteredTo/FBV~Type~EQ~Frog')
 						.end(
 							function (pError, pResponse)
@@ -819,13 +820,88 @@ suite
 							}
 						);
 					}
-				);				test
+				);
+				test
+				(
+					'reads: get distinct values for a column',
+					function(fDone)
+					{
+						libSuperTest('http://localhost:9080/')
+						.get('1.0/FableTests/Distinct/Type')
+						.end(
+							function (pError, pResponse)
+							{
+								var tmpResults = JSON.parse(pResponse.text);
+								Expect(tmpResults.length).to.equal(5);
+								const types = tmpResults.map((r) => r.Type);
+								Expect(types).to.have.members(['Bunny', 'Girl', 'Dog', 'Frog', 'Mammoth']);
+								fDone();
+							}
+						);
+					}
+				);
+				test
+				(
+					'reads: get distinct values for a column with filter',
+					function(fDone)
+					{
+						libSuperTest('http://localhost:9080/')
+						.get('1.0/FableTests/Distinct/Type/FilteredTo/FBV~IDAnimal~LT~3')
+						.end(
+							function (pError, pResponse)
+							{
+								var tmpResults = JSON.parse(pResponse.text);
+								Expect(tmpResults.length).to.equal(2);
+								const types = new Set(tmpResults.map((r) => r.Type));
+								Expect(types.size).to.equal(2);
+								fDone();
+							}
+						);
+					}
+				);
+				test
+				(
+					'reads: get distinct values for a column with filter and pagination',
+					function(fDone)
+					{
+						libSuperTest('http://localhost:9080/')
+						.get('1.0/FableTests/Distinct/Type/FilteredTo/FBV~IDAnimal~LT~3/0/1')
+						.end(
+							function (pError, pResponse)
+							{
+								var tmpResults = JSON.parse(pResponse.text);
+								Expect(tmpResults.length).to.equal(1);
+								fDone();
+							}
+						);
+					}
+				);
+				test
+				(
+					'reads: get distinct values for a column with pagination',
+					function(fDone)
+					{
+						libSuperTest('http://localhost:9080/')
+						.get('1.0/FableTests/Distinct/Type/2/2')
+						.end(
+							function (pError, pResponse)
+							{
+								var tmpResults = JSON.parse(pResponse.text);
+								Expect(tmpResults.length).to.equal(2);
+								const types = new Set(tmpResults.map((r) => r.Type));
+								Expect(types.size).to.equal(2);
+								fDone();
+							}
+						);
+					}
+				);
+				test
 				(
 					'reads: get a filtered paged set of records',
 					function(fDone)
 					{
 						libSuperTest('http://localhost:9080/')
-						// Get page 2, 2 records per page.
+						// Skip one record, 2 records per page.
 						.get('1.0/FableTests/FilteredTo/FBV~Type~EQ~Dog/1/2')
 						.end(
 							function (pError, pResponse)