pelias
/
api
mirror of https://github.com/pelias/api.git
1
0
Fork 0
Code Issues Releases Activity
Browse Source

call runAllChecks for nearby, reverse, and place sanitizing

pull/942/head
Lily He 7 years ago
parent
1f527be3e3
commit
670c673419
6 changed files with 54 additions and 39 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 10
      sanitizer/nearby.js
  2. 14
      sanitizer/place.js
  3. 20
      sanitizer/reverse.js
  4. 5
      test/unit/sanitizer/nearby.js
  5. 15
      test/unit/sanitizer/place.js
  6. 29
      test/unit/sanitizer/reverse.js

10
sanitizer/nearby.js
Unescape View File

@ -4,10 +4,10 @@ var reverseSanitizers = require('./reverse').sanitizer_list;
// add categories to the sanitizer list // add categories to the sanitizer list
var sanitizers = _.merge({}, reverseSanitizers, { var sanitizers = _.merge({}, reverseSanitizers, {
categories: require('../sanitizer/_categories') categories: require('../sanitizer/_categories')()
}); });
var sanitize = function(req, cb) { sanitizeAll(req, sanitizers, cb); }; var sanitize = sanitizeAll.runAllChecks;
// export sanitize for testing // export sanitize for testing
module.exports.sanitize = sanitize; module.exports.sanitize = sanitize;
@ -15,7 +15,11 @@ module.exports.sanitizer_list = sanitizers;
// middleware // middleware
module.exports.middleware = function( req, res, next ){ module.exports.middleware = function( req, res, next ){
sanitize( req, function( err, clean ){ sanitize(req, sanitizers, ( err, clean ) => {
if( err ){
res.status(400); // 400 Bad Request
return next(err);
}
next(); next();
}); });
}; };

14
sanitizer/place.js
Unescape View File

@ -1,20 +1,24 @@
var sanitizeAll = require('../sanitizer/sanitizeAll'), var sanitizeAll = require('../sanitizer/sanitizeAll'),
sanitizers = { sanitizers = {
singleScalarParameters: require('../sanitizer/_single_scalar_parameters'), singleScalarParameters: require('../sanitizer/_single_scalar_parameters')(),
ids: require('../sanitizer/_ids'), ids: require('../sanitizer/_ids')(),
private: require('../sanitizer/_flag_bool')('private', false) private: require('../sanitizer/_flag_bool')('private', false)
}; };
var sanitize = function(req, cb) { sanitizeAll(req, sanitizers, cb); }; var sanitize = sanitizeAll.runAllChecks;
// export sanitize for testing // export sanitize for testing
module.exports.sanitize = sanitize; module.exports.sanitize = sanitize;
module.exports.sanitizer_list = sanitizers; module.exports.sanitizer_list = sanitizers;
// middleware // middleware
module.exports.middleware = function( req, res, next ){ module.exports.middleware = function(req, res, next){
sanitize( req, function( err, clean ){ sanitize(req, sanitizers, ( err, clean ) => {
if( err ){
res.status(400); // 400 Bad Request
return next(err);
}
next(); next();
}); });
}; };

20
sanitizer/reverse.js
Unescape View File

@ -2,20 +2,20 @@
var type_mapping = require('../helper/type_mapping'); var type_mapping = require('../helper/type_mapping');
var sanitizeAll = require('../sanitizer/sanitizeAll'), var sanitizeAll = require('../sanitizer/sanitizeAll'),
sanitizers = { sanitizers = {
singleScalarParameters: require('../sanitizer/_single_scalar_parameters'), singleScalarParameters: require('../sanitizer/_single_scalar_parameters')(),
quattroshapes_deprecation: require('../sanitizer/_deprecate_quattroshapes'), quattroshapes_deprecation: require('../sanitizer/_deprecate_quattroshapes')(),
layers: require('../sanitizer/_targets')('layers', type_mapping.layer_mapping), layers: require('../sanitizer/_targets')('layers', type_mapping.layer_mapping),
sources: require('../sanitizer/_targets')('sources', type_mapping.source_mapping), sources: require('../sanitizer/_targets')('sources', type_mapping.source_mapping),
// depends on the layers and sources sanitizers, must be run after them // depends on the layers and sources sanitizers, must be run after them
sources_and_layers: require('../sanitizer/_sources_and_layers'), sources_and_layers: require('../sanitizer/_sources_and_layers')(),
geonames_deprecation: require('../sanitizer/_geonames_deprecation'), geonames_deprecation: require('../sanitizer/_geonames_deprecation')(),
size: require('../sanitizer/_size')(/* use defaults*/), size: require('../sanitizer/_size')(/* use defaults*/),
private: require('../sanitizer/_flag_bool')('private', false), private: require('../sanitizer/_flag_bool')('private', false),
geo_reverse: require('../sanitizer/_geo_reverse'), geo_reverse: require('../sanitizer/_geo_reverse')(),
boundary_country: require('../sanitizer/_boundary_country') boundary_country: require('../sanitizer/_boundary_country')()
}; };
var sanitize = function(req, cb) { sanitizeAll(req, sanitizers, cb); }; var sanitize = sanitizeAll.runAllChecks;
// export sanitize for testing // export sanitize for testing
module.exports.sanitize = sanitize; module.exports.sanitize = sanitize;
@ -23,7 +23,11 @@ module.exports.sanitizer_list = sanitizers;
// middleware // middleware
module.exports.middleware = function( req, res, next ){ module.exports.middleware = function( req, res, next ){
sanitize( req, function( err, clean ){ sanitize(req, sanitizers, ( err, clean ) => {
if( err ){
res.status(400); // 400 Bad Request
return next(err);
}
next(); next();
}); });
}; };

5
test/unit/sanitizer/nearby.js
Unescape View File

@ -3,6 +3,7 @@ var nearby = require('../../../sanitizer/nearby');
var defaults = require('../../../query/reverse_defaults'); var defaults = require('../../../query/reverse_defaults');
var sanitize = nearby.sanitize; var sanitize = nearby.sanitize;
var middleware = nearby.middleware; var middleware = nearby.middleware;
var sanitizer_list = nearby.sanitizer_list;
var defaultClean = { 'point.lat': 0, var defaultClean = { 'point.lat': 0,
'point.lon': 0, 'point.lon': 0,
@ -17,7 +18,7 @@ module.exports.tests = {};
module.exports.tests.interface = function(test, common) { module.exports.tests.interface = function(test, common) {
test('sanitize interface', function(t) { test('sanitize interface', function(t) {
t.equal(typeof sanitize, 'function', 'sanitize is a function'); t.equal(typeof sanitize, 'function', 'sanitize is a function');
t.equal(sanitize.length, 2, 'sanitize interface'); t.equal(sanitize.length, 3, 'sanitize interface takes one argument: req');
t.end(); t.end();
}); });
test('middleware interface', function(t) { test('middleware interface', function(t) {
@ -52,7 +53,7 @@ module.exports.tests.middleware_success = function(test, common) {
module.exports.all = function (tape, common) { module.exports.all = function (tape, common) {
function test(name, testFunction) { function test(name, testFunction) {
return tape('SANTIZE /nearby ' + name, testFunction); return tape('SANITIZE /nearby ' + name, testFunction);
} }
for( var testCase in module.exports.tests ){ for( var testCase in module.exports.tests ){

15
test/unit/sanitizer/place.js
Unescape View File

@ -1,6 +1,7 @@
var place = require('../../../sanitizer/place'), var place = require('../../../sanitizer/place'),
sanitize = place.sanitize, sanitize = place.sanitize,
middleware = place.middleware, middleware = place.middleware,
sanitizer_list = place.sanitizer_list,
defaultClean = { ids: [ { source: 'geonames', layer: 'venue', id: '123' } ], private: false }; defaultClean = { ids: [ { source: 'geonames', layer: 'venue', id: '123' } ], private: false };
// these are the default values you would expect when no input params are specified. // these are the default values you would expect when no input params are specified.
@ -9,7 +10,7 @@ module.exports.tests = {};
module.exports.tests.interface = function(test, common) { module.exports.tests.interface = function(test, common) {
test('sanitize interface', function(t) { test('sanitize interface', function(t) {
t.equal(typeof sanitize, 'function', 'sanitize is a function'); t.equal(typeof sanitize, 'function', 'sanitize is a function');
t.equal(sanitize.length, 2, 'sanitize interface'); t.equal(sanitize.length, 3, 'sanitize interface takes one arg: req');
t.end(); t.end();
}); });
test('middleware interface', function(t) { test('middleware interface', function(t) {
@ -32,7 +33,7 @@ module.exports.tests.sanitize_private = function(test, common) {
invalid_values.forEach(function(value) { invalid_values.forEach(function(value) {
test('invalid private param ' + value, function(t) { test('invalid private param ' + value, function(t) {
var req = { query: { ids:'geonames:venue:123', 'private': value } }; var req = { query: { ids:'geonames:venue:123', 'private': value } };
sanitize(req, function(){ sanitize(req, sanitizer_list, () => {
t.deepEqual( req.errors, [], 'no errors' ); t.deepEqual( req.errors, [], 'no errors' );
t.deepEqual( req.warnings, [], 'no warnings' ); t.deepEqual( req.warnings, [], 'no warnings' );
t.equal(req.clean.private, false, 'default private set (to false)'); t.equal(req.clean.private, false, 'default private set (to false)');
@ -45,7 +46,7 @@ module.exports.tests.sanitize_private = function(test, common) {
valid_values.forEach(function(value) { valid_values.forEach(function(value) {
test('valid private param ' + value, function(t) { test('valid private param ' + value, function(t) {
var req = { query: { ids:'geonames:venue:123', 'private': value } }; var req = { query: { ids:'geonames:venue:123', 'private': value } };
sanitize(req, function(){ sanitize(req, sanitizer_list, () => {
t.deepEqual( req.errors, [], 'no errors' ); t.deepEqual( req.errors, [], 'no errors' );
t.deepEqual( req.warnings, [], 'no warnings' ); t.deepEqual( req.warnings, [], 'no warnings' );
t.equal(req.clean.private, true, 'private set to true'); t.equal(req.clean.private, true, 'private set to true');
@ -58,7 +59,7 @@ module.exports.tests.sanitize_private = function(test, common) {
valid_false_values.forEach(function(value) { valid_false_values.forEach(function(value) {
test('test setting false explicitly ' + value, function(t) { test('test setting false explicitly ' + value, function(t) {
var req = { query: { ids:'geonames:venue:123', 'private': value } }; var req = { query: { ids:'geonames:venue:123', 'private': value } };
sanitize(req, function(){ sanitize(req, sanitizer_list, () => {
t.deepEqual( req.errors, [], 'no errors' ); t.deepEqual( req.errors, [], 'no errors' );
t.deepEqual( req.warnings, [], 'no warnings' ); t.deepEqual( req.warnings, [], 'no warnings' );
t.equal(req.clean.private, false, 'private set to false'); t.equal(req.clean.private, false, 'private set to false');
@ -69,7 +70,7 @@ module.exports.tests.sanitize_private = function(test, common) {
test('test default behavior', function(t) { test('test default behavior', function(t) {
var req = { query: { ids:'geonames:venue:123' } }; var req = { query: { ids:'geonames:venue:123' } };
sanitize(req, function(){ sanitize(req, sanitizer_list, () => {
t.deepEqual( req.errors, [], 'no errors' ); t.deepEqual( req.errors, [], 'no errors' );
t.deepEqual( req.warnings, [], 'no warnings' ); t.deepEqual( req.warnings, [], 'no warnings' );
t.equal(req.clean.private, false, 'private set to false'); t.equal(req.clean.private, false, 'private set to false');
@ -81,7 +82,7 @@ module.exports.tests.sanitize_private = function(test, common) {
module.exports.tests.invalid_params = function(test, common) { module.exports.tests.invalid_params = function(test, common) {
test('no params', function(t) { test('no params', function(t) {
var req = { query: {} }; var req = { query: {} };
sanitize( req, function(){ sanitize(req, sanitizer_list, () => {
t.equal( req.errors[0], 'invalid param \'ids\': length must be >0', 'error for missing `ids` param'); t.equal( req.errors[0], 'invalid param \'ids\': length must be >0', 'error for missing `ids` param');
t.deepEqual( req.warnings, [], 'no warnings' ); t.deepEqual( req.warnings, [], 'no warnings' );
t.end(); t.end();
@ -105,7 +106,7 @@ module.exports.tests.middleware_success = function(test, common) {
module.exports.all = function (tape, common) { module.exports.all = function (tape, common) {
function test(name, testFunction) { function test(name, testFunction) {
return tape('SANTIZE /place ' + name, testFunction); return tape('SANITIZE /place ' + name, testFunction);
} }
for( var testCase in module.exports.tests ){ for( var testCase in module.exports.tests ){

29
test/unit/sanitizer/reverse.js
Unescape View File

@ -4,6 +4,7 @@
var reverse = require('../../../sanitizer/reverse'), var reverse = require('../../../sanitizer/reverse'),
sanitize = reverse.sanitize, sanitize = reverse.sanitize,
middleware = reverse.middleware, middleware = reverse.middleware,
sanitizer_list = reverse.sanitizer_list,
defaults = require('../../../query/reverse_defaults'), defaults = require('../../../query/reverse_defaults'),
defaultError = 'missing param \'lat\'', defaultError = 'missing param \'lat\'',
defaultClean = { 'point.lat': 0, defaultClean = { 'point.lat': 0,
@ -23,7 +24,7 @@ module.exports.tests = {};
module.exports.tests.interface = function(test, common) { module.exports.tests.interface = function(test, common) {
test('sanitize interface', function(t) { test('sanitize interface', function(t) {
t.equal(typeof sanitize, 'function', 'sanitize is a function'); t.equal(typeof sanitize, 'function', 'sanitize is a function');
t.equal(sanitize.length, 2, 'sanitize interface'); t.equal(sanitize.length, 3, 'sanitize interface takes one param: req');
t.end(); t.end();
}); });
test('middleware interface', function(t) { test('middleware interface', function(t) {
@ -52,7 +53,7 @@ module.exports.tests.sanitize_lat = function(test, common) {
test('invalid lat', function(t) { test('invalid lat', function(t) {
lats.invalid.forEach( function( lat ){ lats.invalid.forEach( function( lat ){
var req = { query: { 'point.lat': lat, 'point.lon': 0 } }; var req = { query: { 'point.lat': lat, 'point.lon': 0 } };
sanitize(req, function(){ sanitize(req, sanitizer_list, () => {
t.equal(req.errors[0], 'invalid param \'point.lat\': must be >-90 and <90', lat + ' is an invalid latitude'); t.equal(req.errors[0], 'invalid param \'point.lat\': must be >-90 and <90', lat + ' is an invalid latitude');
t.deepEqual(req.clean, emptyClean, 'clean only has default values set'); t.deepEqual(req.clean, emptyClean, 'clean only has default values set');
}); });
@ -62,7 +63,7 @@ module.exports.tests.sanitize_lat = function(test, common) {
test('valid lat', function(t) { test('valid lat', function(t) {
lats.valid.forEach( function( lat ){ lats.valid.forEach( function( lat ){
var req = { query: { 'point.lat': lat, 'point.lon': 0 } }; var req = { query: { 'point.lat': lat, 'point.lon': 0 } };
sanitize(req, function(){ sanitize(req, sanitizer_list, () => {
var expected_lat = parseFloat( lat ); var expected_lat = parseFloat( lat );
t.deepEqual(req.errors, [], 'no errors'); t.deepEqual(req.errors, [], 'no errors');
}); });
@ -72,7 +73,7 @@ module.exports.tests.sanitize_lat = function(test, common) {
test('missing lat', function(t) { test('missing lat', function(t) {
lats.missing.forEach( function( lat ){ lats.missing.forEach( function( lat ){
var req = { query: { 'point.lat': lat, 'point.lon': 0 } }; var req = { query: { 'point.lat': lat, 'point.lon': 0 } };
sanitize(req, function(){ sanitize(req, sanitizer_list, () => {
t.equal(req.errors[0], 'missing param \'point.lat\'', 'latitude is a required field'); t.equal(req.errors[0], 'missing param \'point.lat\'', 'latitude is a required field');
t.deepEqual(req.clean, emptyClean, 'clean only has default values set'); t.deepEqual(req.clean, emptyClean, 'clean only has default values set');
}); });
@ -89,7 +90,7 @@ module.exports.tests.sanitize_lon = function(test, common) {
test('valid lon', function(t) { test('valid lon', function(t) {
lons.valid.forEach( function( lon ){ lons.valid.forEach( function( lon ){
var req = { query: { 'point.lat': 0, 'point.lon': lon } }; var req = { query: { 'point.lat': 0, 'point.lon': lon } };
sanitize(req, function(){ sanitize(req, sanitizer_list, () => {
var expected_lon = parseFloat( lon ); var expected_lon = parseFloat( lon );
t.deepEqual(req.errors, [], 'no errors'); t.deepEqual(req.errors, [], 'no errors');
}); });
@ -102,7 +103,7 @@ module.exports.tests.sanitize_lon = function(test, common) {
// @todo: why is lat set? // @todo: why is lat set?
var expected = { 'point.lat': 0, private: false, size: 10 }; var expected = { 'point.lat': 0, private: false, size: 10 };
sanitize(req, function(){ sanitize(req, sanitizer_list, () => {
t.equal(req.errors[0], 'missing param \'point.lon\'', 'longitude is a required field'); t.equal(req.errors[0], 'missing param \'point.lon\'', 'longitude is a required field');
t.deepEqual(req.clean, expected, 'clean only has default values set'); t.deepEqual(req.clean, expected, 'clean only has default values set');
}); });
@ -114,21 +115,21 @@ module.exports.tests.sanitize_lon = function(test, common) {
module.exports.tests.sanitize_size = function(test, common) { module.exports.tests.sanitize_size = function(test, common) {
test('invalid size value', function(t) { test('invalid size value', function(t) {
var req = { query: { size: 'a', 'point.lat': 0, 'point.lon': 0 } }; var req = { query: { size: 'a', 'point.lat': 0, 'point.lon': 0 } };
sanitize(req, function(){ sanitize(req, sanitizer_list, () => {
t.equal(req.clean.size, 10, 'default size set'); t.equal(req.clean.size, 10, 'default size set');
t.end(); t.end();
}); });
}); });
test('below min size value', function(t) { test('below min size value', function(t) {
var req = { query: { size: -100, 'point.lat': 0, 'point.lon': 0 } }; var req = { query: { size: -100, 'point.lat': 0, 'point.lon': 0 } };
sanitize(req, function(){ sanitize(req, sanitizer_list, () => {
t.equal(req.clean.size, 1, 'min size set'); t.equal(req.clean.size, 1, 'min size set');
t.end(); t.end();
}); });
}); });
test('above max size value', function(t) { test('above max size value', function(t) {
var req = { query: { size: 9999, 'point.lat': 0, 'point.lon': 0 } }; var req = { query: { size: 9999, 'point.lat': 0, 'point.lon': 0 } };
sanitize(req, function(){ sanitize(req, sanitizer_list, () => {
t.equal(req.clean.size, 40, 'max size set'); t.equal(req.clean.size, 40, 'max size set');
t.end(); t.end();
}); });
@ -140,7 +141,7 @@ module.exports.tests.sanitize_private = function(test, common) {
invalid_values.forEach(function(value) { invalid_values.forEach(function(value) {
test('invalid private param ' + value, function(t) { test('invalid private param ' + value, function(t) {
var req = { query: { 'point.lat': 0, 'point.lon': 0, 'private': value } }; var req = { query: { 'point.lat': 0, 'point.lon': 0, 'private': value } };
sanitize(req, function(){ sanitize(req, sanitizer_list, () => {
t.equal(req.clean.private, false, 'default private set (to false)'); t.equal(req.clean.private, false, 'default private set (to false)');
t.end(); t.end();
}); });
@ -151,7 +152,7 @@ module.exports.tests.sanitize_private = function(test, common) {
valid_values.forEach(function(value) { valid_values.forEach(function(value) {
test('valid private param ' + value, function(t) { test('valid private param ' + value, function(t) {
var req = { query: { 'point.lat': 0, 'point.lon': 0, 'private': value } }; var req = { query: { 'point.lat': 0, 'point.lon': 0, 'private': value } };
sanitize(req, function(){ sanitize(req, sanitizer_list, () => {
t.equal(req.clean.private, true, 'private set to true'); t.equal(req.clean.private, true, 'private set to true');
t.end(); t.end();
}); });
@ -162,7 +163,7 @@ module.exports.tests.sanitize_private = function(test, common) {
valid_false_values.forEach(function(value) { valid_false_values.forEach(function(value) {
test('test setting false explicitly ' + value, function(t) { test('test setting false explicitly ' + value, function(t) {
var req = { query: { 'point.lat': 0, 'point.lon': 0, 'private': value } }; var req = { query: { 'point.lat': 0, 'point.lon': 0, 'private': value } };
sanitize(req, function(){ sanitize(req, sanitizer_list, () => {
t.equal(req.clean.private, false, 'private set to false'); t.equal(req.clean.private, false, 'private set to false');
t.end(); t.end();
}); });
@ -171,7 +172,7 @@ module.exports.tests.sanitize_private = function(test, common) {
test('test default behavior', function(t) { test('test default behavior', function(t) {
var req = { query: { 'point.lat': 0, 'point.lon': 0 } }; var req = { query: { 'point.lat': 0, 'point.lon': 0 } };
sanitize(req, function(){ sanitize(req, sanitizer_list, () => {
t.equal(req.clean.private, false, 'private set to false'); t.equal(req.clean.private, false, 'private set to false');
t.end(); t.end();
}); });
@ -193,7 +194,7 @@ module.exports.tests.middleware_success = function(test, common) {
module.exports.all = function (tape, common) { module.exports.all = function (tape, common) {
function test(name, testFunction) { function test(name, testFunction) {
return tape('SANTIZE /reverse ' + name, testFunction); return tape('SANITIZE /reverse ' + name, testFunction);
} }
for( var testCase in module.exports.tests ){ for( var testCase in module.exports.tests ){

Write Preview
Loading…
Cancel
Save