-
-
Save robwormald/8393544 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* Find Records | |
* | |
* An API call to find and return model instances from the data adapter | |
* using the specified criteria. If an id was specified, just the instance | |
* with that unique id will be returned. | |
* | |
* @param {Integer|String} id - the unique id of the particular instance you'd like to look up | |
* @param {Object} where - the find criteria (passed directly to the ORM) | |
* @param {Integer} limit - the maximum number of records to send back (useful for pagination) | |
* @param {Integer} skip - the number of records to skip (useful for pagination) | |
* @param {String} sort - the order of returned records, e.g. `name ASC` or `age DESC` | |
*/ | |
module.exports = function find (req, res) { | |
// Get access to sails (globals might be disabled) | |
var sails = req._sails; | |
// The name of the parameter to use for JSONP callbacks | |
var JSONP_CALLBACK_PARAM = 'callback'; | |
// if req.transport is falsy or doesn't contain the phrase "socket" | |
// and JSONP is enabled for this action, we'll say we're "isJSONPCompatible" | |
var isJSONPCompatible = req.options.jsonp && ! ( req.transport && req.transport.match(/socket/i) ); | |
// Look up the model.... | |
var Model = sails.models[req.options.model]; | |
/** | |
/** | |
* If a valid id was specified, find the particular instance with that id. | |
*/ | |
if (req.param('id')) { | |
Model.findOne(req.param('id')).exec(function found(err, matchingRecord) { | |
// TODO: differentiate between waterline-originated validation errors | |
// and serious underlying issues | |
// TODO: Respond with badRequest if an error is encountered, w/ validation info | |
if (err) return res.serverError(err); | |
// No model instance found with the specified id | |
if(!matchingRecord) return res.notFound(); | |
// // TODO: enable pubsub in blueprints again when new syntax if fully fleshed out | |
// req.socket.subscribe(newInstance); | |
//console.log(matchingRecord) | |
//did we ask for related info? | |
if(req.param('association')){ | |
var associationProp = Model._attributes[req.param('association')] | |
// console.log(matchingRecord[req.param('association')]) | |
if(!associationProp) return res.notFound(); | |
var AssociatedModel = sails.models[associationProp.model || associationProp.collection]; | |
if(!AssociatedModel) return res.serverError('no model / collection found') | |
//to - one query | |
if(associationProp.model){ | |
var pkey = matchingRecord[req.param('association')]; | |
if(!pkey) return res.notFound(); | |
AssociatedModel.findOne(pkey).exec(function(err,matchingRelatedRecord){ | |
if (err) return res.serverError(err); | |
// No model instance found with the specified id | |
if(!matchingRelatedRecord) return res.notFound(); | |
if ( isJSONPCompatible ) { | |
return res.jsonp(matchingRelatedRecord); | |
} | |
else { | |
return res.json(matchingRelatedRecord); | |
} | |
}) | |
} | |
//to - many | |
else if(associationProp.collection){ | |
// console.log(AssociatedModel) | |
return res.json([]) | |
} | |
} | |
// Otherwise serve a JSON(P) API | |
else{ | |
// toJSON() the instance. | |
matchingRecord = matchingRecord.toJSON(); | |
if ( isJSONPCompatible ) { | |
return res.jsonp(matchingRecord); | |
} | |
else { | |
return res.json(matchingRecord); | |
} | |
} | |
}); | |
} | |
/** | |
* If no id was specified, find instances matching the specified criteria. | |
*/ | |
else { | |
var _query = { | |
limit: req.param('limit') || undefined, | |
skip: req.param('skip') || req.param('offset') || undefined, | |
sort: req.param('sort') || req.param('order') || undefined, | |
where: parseWhereParam(req.params.all()) || undefined | |
} | |
console.log(_query) | |
// Lookup for records that match the specified criteria | |
Model.find(_query).exec(function found(err, matchingRecords) { | |
// TODO: differentiate between waterline-originated validation errors | |
// and serious underlying issues | |
// TODO: Respond with badRequest if an error is encountered, w/ validation info | |
if (err) return res.serverError(err); | |
// No instances found | |
if(!matchingRecords) return res.notFound(); | |
// // TODO: enable pubsub in blueprints again when new syntax if fully fleshed out | |
// req.socket.subscribe(matchingRecords); | |
// toJSON() all of the model instances | |
matchingRecords = sails.util.invoke(matchingRecords, 'toJSON'); | |
// Otherwise serve a JSON(P) API | |
if ( isJSONPCompatible ) { | |
return res.jsonp(matchingRecords); | |
} | |
else { | |
return res.json(matchingRecords); | |
} | |
}); | |
} | |
// TODO: | |
// | |
// Replace the following helper with the version in sails.util: | |
// Attempt to parse JSON | |
// If the parse fails, return the error object | |
// If JSON is falsey, return null | |
// (this is so that it will be ignored if not specified) | |
function tryToParseJSON (json) { | |
if (!sails.util.isString(json)) return null; | |
try { | |
return JSON.parse(json); | |
} | |
catch (e) { | |
return e; | |
} | |
} | |
/** | |
* parseWhereParam | |
* | |
* @param {Object} allParams [result of calling req.params.all()] | |
* @return {Object} the WHERE criteria object | |
*/ | |
function parseWhereParam( allParams ) { | |
//console.log(allParams) | |
var where = req.param('where'); | |
// If `where` parameter is a string, try to interpret it as JSON | |
if (sails.util.isString(where)) { | |
where = tryToParseJSON(where); | |
} | |
// If `where` has not been specified, but other unbound parameter variables | |
// **ARE** specified, build the `where` option using them. | |
if (!where) { | |
// Prune params which aren't fit to be used as `where` criteria | |
// to build a proper where query | |
where = sails.util.omit(allParams, ['limit', 'skip', 'sort']); | |
where = sails.util.omit(where, function (p){ if (sails.util.isUndefined(p)) return true; }); | |
console.log(where) | |
if (isJSONPCompatible) { where = sails.util.omit(where, JSONP_CALLBACK_PARAM); } | |
} | |
return where; | |
} | |
}; | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment