From 67e034f5f2b17066c75bb05b9cf351c85cf0f1ce Mon Sep 17 00:00:00 2001 From: Diana Shkolnikov Date: Fri, 11 Sep 2015 15:11:55 -0400 Subject: [PATCH 1/3] Rename `source` to `sources` ... with a dash of refactoring thrown in for good measure --- helper/types.js | 20 ++++++--- middleware/_types.js | 30 ++++++++----- query/sources.js | 8 +++- sanitiser/_source.js | 44 ------------------- sanitiser/_sources.js | 44 +++++++++++++++++++ sanitiser/reverse.js | 2 +- sanitiser/search.js | 2 +- test/unit/helper/types.js | 32 +++++++++----- test/unit/run.js | 2 +- .../sanitiser/{_source.js => _sources.js} | 31 ++++++++----- 10 files changed, 128 insertions(+), 87 deletions(-) delete mode 100644 sanitiser/_source.js create mode 100644 sanitiser/_sources.js rename test/unit/sanitiser/{_source.js => _sources.js} (70%) diff --git a/helper/types.js b/helper/types.js index 7455476e..249c27a0 100644 --- a/helper/types.js +++ b/helper/types.js @@ -9,23 +9,29 @@ var intersection = function intersection(set1, set2) { }); }; +/** + * Combine all types and determine the unique subset + * + * @param {Array} clean_types + * @returns {Array} + */ module.exports = function calculate_types(clean_types) { - if (!clean_types) { - return undefined; + if (!clean_types || !(clean_types.from_layers || clean_types.from_sources || clean_types.from_address_parser)) { + throw new Error('clean_types should not be null or undefined'); } /* the layers and source parameters are cumulative: - * perform a set insersection of their specified types + * perform a set intersection of their specified types */ - if (clean_types.from_layers || clean_types.from_source) { + if (clean_types.from_layers || clean_types.from_sources) { var types = valid_types; if (clean_types.from_layers) { types = intersection(types, clean_types.from_layers); } - if (clean_types.from_source) { - types = intersection(types, clean_types.from_source); + if (clean_types.from_sources) { + types = intersection(types, clean_types.from_sources); } return types; @@ -38,4 +44,6 @@ module.exports = function calculate_types(clean_types) { if (clean_types.from_address_parser) { return clean_types.from_address_parser; } + + throw new Error('no types specified'); }; \ No newline at end of file diff --git a/middleware/_types.js b/middleware/_types.js index 8b12719f..baad127e 100644 --- a/middleware/_types.js +++ b/middleware/_types.js @@ -8,17 +8,27 @@ var types_helper = require( '../helper/types' ); * message instead of searching at all. */ function middleware(req, res, next) { - var types = types_helper(req.clean.types); + req.clean = req.clean || {}; - if (types !== undefined && types.length !== undefined) { - if (types.length === 0) { - var err = 'You have specified both the `source` and `layers` ' + - 'parameters in a combination that will return no results.'; - res.status(400); // 400 Bad Request - return next(err); - } else { - req.clean.type = types; - } + if (req.clean.hasOwnProperty('types') === false) { + return next(); + } + + try { + var types = types_helper(req.clean.types); + + if ((types instanceof Array) && types.length === 0) { + var err = 'You have specified both the `sources` and `layers` ' + + 'parameters in a combination that will return no results.'; + res.status(400); // 400 Bad Request + return next(err); + } + + req.clean.type = types; + } + catch (err) { + // this means there were no types specified + delete req.clean.types; } next(); diff --git a/query/sources.js b/query/sources.js index 77be7fb9..3715be86 100644 --- a/query/sources.js +++ b/query/sources.js @@ -3,8 +3,12 @@ */ module.exports = { - 'geonames': ['geoname'], + 'gn' : ['geoname'], + 'geonames' : ['geoname'], + 'oa' : ['openaddresses'], 'openaddresses' : ['openaddresses'], - 'quattroshapes': ['admin0', 'admin1', 'admin2', 'neighborhood', 'locality', 'local_admin'], + 'qs' : ['admin0', 'admin1', 'admin2', 'neighborhood', 'locality', 'local_admin'], + 'quattroshapes' : ['admin0', 'admin1', 'admin2', 'neighborhood', 'locality', 'local_admin'], + 'osm' : ['osmaddress', 'osmnode', 'osmway'], 'openstreetmap' : ['osmaddress', 'osmnode', 'osmway'] }; diff --git a/sanitiser/_source.js b/sanitiser/_source.js deleted file mode 100644 index f8f89a68..00000000 --- a/sanitiser/_source.js +++ /dev/null @@ -1,44 +0,0 @@ -var isObject = require('is-object'); -var sources_map = require( '../query/sources' ); -var all_sources = Object.keys(sources_map); - -function sanitize( req ) { - req.clean = req.clean || {}; - var params = req.query; - - req.clean.types = req.clean.types || {}; - - // ensure the input params are a valid object - if( !isObject( params ) ){ - params = {}; - } - - // default case (no layers specified in GET params) - // don't even set the from_layers key in this case - if('string' !== typeof params.source || !params.source.length){ - return { error: false }; - } - - var sources = params.source.split(','); - - var invalid_sources = sources.filter(function(source) { - return all_sources.indexOf(source) === -1; - }); - - if (invalid_sources.length > 0) { - return { - error: true, - msg: '`' + invalid_sources[0] + '` is an invalid source parameter. Valid options: ' + all_sources.join(', ') - }; - } - - var types = sources.reduce(function(acc, source) { - return acc.concat(sources_map[source]); - }, []); - - req.clean.types.from_source = types; - - return { error: false }; -} - -module.exports = sanitize; diff --git a/sanitiser/_sources.js b/sanitiser/_sources.js new file mode 100644 index 00000000..225f496e --- /dev/null +++ b/sanitiser/_sources.js @@ -0,0 +1,44 @@ +var isObject = require('is-object'); +var sources_map = require( '../query/sources' ); + +function sanitize( req ) { + var params = req.query || {}; + + req.clean = req.clean || {}; + req.clean.types = req.clean.types || {}; + + // default case (no sources specified in GET params) + if (params.hasOwnProperty('sources') === false) { + return { error: false }; + } + + params.sources = params.sources.trim(); + + if (params.sources.trim().length === 0) { + return { + error: true, + message: '`sources` parameter cannot be an empty string. Valid options: ' + Object.keys(sources_map).join(', ') + }; + } + + var sources = params.sources.split(','); + + var invalid_sources = sources.filter(function(source) { + return sources_map.hasOwnProperty(source) === false; + }); + + if (invalid_sources.length > 0) { + return { + error: true, + message: '`' + invalid_sources[0] + '` is an invalid source parameter. Valid options: ' + Object.keys(sources_map).join(', ') + }; + } + + req.clean.types.from_sources = sources.reduce(function(acc, source) { + return acc.concat(sources_map[source]); + }, []); + + return { error: false }; +} + +module.exports = sanitize; diff --git a/sanitiser/reverse.js b/sanitiser/reverse.js index edb8da7e..a74a8c39 100644 --- a/sanitiser/reverse.js +++ b/sanitiser/reverse.js @@ -2,7 +2,7 @@ var _sanitize = require('../sanitiser/_sanitize'), sanitiser = { latlonzoom: require('../sanitiser/_geo_reverse'), layers: require('../sanitiser/_layers'), - suorce: require('../sanitiser/_source'), + suorce: require('../sanitiser/_sources'), details: require('../sanitiser/_details'), size: require('../sanitiser/_size'), categories: function ( req ) { diff --git a/sanitiser/search.js b/sanitiser/search.js index 19263732..c6c9e0d3 100644 --- a/sanitiser/search.js +++ b/sanitiser/search.js @@ -4,7 +4,7 @@ var _sanitize = require('../sanitiser/_sanitize'), text: require('../sanitiser/_text'), size: require('../sanitiser/_size'), layers: require('../sanitiser/_layers'), - source: require('../sanitiser/_source'), + source: require('../sanitiser/_sources'), details: require('../sanitiser/_details'), latlonzoom: require('../sanitiser/_geo_search') }; diff --git a/test/unit/helper/types.js b/test/unit/helper/types.js index 2398c6bb..4638ff12 100644 --- a/test/unit/helper/types.js +++ b/test/unit/helper/types.js @@ -1,20 +1,32 @@ var types = require('../../../helper/types'); -var valid_types = require( '../../../query/types' ); module.exports.tests = {}; module.exports.tests.no_cleaned_types = function(test, common) { test('no cleaned types', function(t) { - var actual = types(undefined); - t.equal(actual, undefined, 'all valid types returned for empty input'); - t.end(); + try { + types(); + t.fail('exception should be thrown'); + } + catch (err) { + t.equal(err.message, 'clean_types should not be null or undefined', 'no input should result in exception'); + } + finally { + t.end(); + } }); test('no cleaned types', function(t) { - var cleaned_types = {}; - var actual = types(cleaned_types); - t.equal(actual, undefined, 'all valid types returned for empty input'); - t.end(); + try { + types({}); + t.fail('exception should be thrown'); + } + catch (err) { + t.equal(err.message, 'clean_types should not be null or undefined', 'no input should result in exception'); + } + finally { + t.end(); + } }); }; @@ -58,7 +70,7 @@ module.exports.tests.layers_parameter_and_address_parser = function(test, common module.exports.tests.source_parameter = function(test, common) { test('source parameter specified', function(t) { var cleaned_types = { - from_source: ['openaddresses'] + from_sources: ['openaddresses'] }; var actual = types(cleaned_types); @@ -72,7 +84,7 @@ module.exports.tests.source_parameter = function(test, common) { module.exports.tests.source_and_layers_parameters = function(test, common) { test('source and layers parameter both specified', function(t) { var cleaned_types = { - from_source: ['openaddresses'], + from_sources: ['openaddresses'], from_layers: ['osmaddress', 'openaddresses'] }; diff --git a/test/unit/run.js b/test/unit/run.js index a8e27d93..17f0f457 100644 --- a/test/unit/run.js +++ b/test/unit/run.js @@ -8,7 +8,7 @@ var tests = [ require('./controller/search'), require('./service/mget'), require('./service/search'), - require('./sanitiser/_source'), + require('./sanitiser/_sources'), require('./sanitiser/search'), require('./sanitiser/reverse'), require('./sanitiser/place'), diff --git a/test/unit/sanitiser/_source.js b/test/unit/sanitiser/_sources.js similarity index 70% rename from test/unit/sanitiser/_source.js rename to test/unit/sanitiser/_sources.js index 235e18c6..6bfea43e 100644 --- a/test/unit/sanitiser/_source.js +++ b/test/unit/sanitiser/_sources.js @@ -1,11 +1,11 @@ -var sanitize = require( '../../../sanitiser/_source' ); +var sanitize = require( '../../../sanitiser/_sources' ); var success_response = { error: false }; module.exports.tests = {}; module.exports.tests.no_sources = function(test, common) { - test('source is not set', function(t) { + test('sources is not set', function(t) { var req = { query: { } }; @@ -20,14 +20,20 @@ module.exports.tests.no_sources = function(test, common) { test('source is empty string', function(t) { var req = { query: { - source: '' + sources: '' } }; + var expected_response = { + error: true, + message: '`sources` parameter cannot be an empty string. ' + + 'Valid options: gn, geonames, oa, openaddresses, qs, quattroshapes, osm, openstreetmap' + }; + var response = sanitize(req); t.deepEqual(req.clean.types, {}, 'clean.types should be empty object'); - t.deepEqual(response, success_response, 'no error returned'); + t.deepEqual(response, expected_response, 'no error returned'); t.end(); }); }; @@ -36,13 +42,13 @@ module.exports.tests.valid_sources = function(test, common) { test('geonames source', function(t) { var req = { query: { - source: 'geonames' + sources: 'geonames' } }; var response = sanitize(req); - t.deepEqual(req.clean.types, { from_source: ['geoname'] }, 'clean.types should contain from_source entry with geonames'); + t.deepEqual(req.clean.types, { from_sources: ['geoname'] }, 'clean.types should contain from_source entry with geonames'); t.deepEqual(response, success_response, 'no error returned'); t.end(); }); @@ -50,11 +56,11 @@ module.exports.tests.valid_sources = function(test, common) { test('openstreetmap source', function(t) { var req = { query: { - source: 'openstreetmap' + sources: 'openstreetmap' } }; var expected_types = { - from_source: ['osmaddress', 'osmnode', 'osmway'] + from_sources: ['osmaddress', 'osmnode', 'osmway'] }; var response = sanitize(req); @@ -67,11 +73,11 @@ module.exports.tests.valid_sources = function(test, common) { test('multiple sources', function(t) { var req = { query: { - source: 'openstreetmap,openaddresses' + sources: 'openstreetmap,openaddresses' } }; var expected_types = { - from_source: ['osmaddress', 'osmnode', 'osmway', 'openaddresses'] + from_sources: ['osmaddress', 'osmnode', 'osmway', 'openaddresses'] }; var response = sanitize(req); @@ -87,12 +93,13 @@ module.exports.tests.invalid_sources = function(test, common) { test('geonames source', function(t) { var req = { query: { - source: 'notasource' + sources: 'notasource' } }; var expected_response = { error: true, - msg: '`notasource` is an invalid source parameter. Valid options: geonames, openaddresses, quattroshapes, openstreetmap' + message: '`notasource` is an invalid source parameter. ' + + 'Valid options: gn, geonames, oa, openaddresses, qs, quattroshapes, osm, openstreetmap' }; var response = sanitize(req); From c069933d5ba37ac97591e359c0b5528344cab884 Mon Sep 17 00:00:00 2001 From: Diana Shkolnikov Date: Fri, 11 Sep 2015 18:45:28 -0400 Subject: [PATCH 2/3] Refactored layers and sources into a common targets module --- helper/layers.js | 25 --------- helper/query_parser.js | 10 +--- package.json | 1 + query/layers.js | 15 ++++++ routes/v1.js | 1 + sanitiser/_layers.js | 52 ------------------ sanitiser/_sources.js | 44 --------------- sanitiser/_targets.js | 57 ++++++++++++++++++++ sanitiser/reverse.js | 27 +++++----- sanitiser/search.js | 12 +++-- test/unit/helper/query_parser.js | 7 ++- test/unit/run.js | 1 + test/unit/sanitiser/_layers.js | 93 ++++++++++++++++++++++++++++++++ test/unit/sanitiser/_sources.js | 6 +-- test/unit/sanitiser/reverse.js | 85 +++-------------------------- test/unit/sanitiser/search.js | 88 ++++-------------------------- 16 files changed, 217 insertions(+), 307 deletions(-) delete mode 100644 helper/layers.js create mode 100644 query/layers.js delete mode 100644 sanitiser/_layers.js delete mode 100644 sanitiser/_sources.js create mode 100644 sanitiser/_targets.js create mode 100644 test/unit/sanitiser/_layers.js diff --git a/helper/layers.js b/helper/layers.js deleted file mode 100644 index a5a57d7f..00000000 --- a/helper/layers.js +++ /dev/null @@ -1,25 +0,0 @@ -module.exports = function(alias_layers) { - // make a copy of the array so, you are not modifying original ref - var layers = alias_layers.slice(0); - - // expand aliases - var expand_aliases = function(alias, layers, layer_indeces) { - var alias_index = layers.indexOf(alias); - if (alias_index !== -1 ) { - layers.splice(alias_index, 1); - layers = layers.concat(layer_indeces); - } - return layers; - }; - - layers = expand_aliases('poi', layers, ['geoname','osmnode','osmway']); - layers = expand_aliases('admin', layers, ['admin0','admin1','admin2','neighborhood','locality','local_admin']); - layers = expand_aliases('address', layers, ['osmaddress','openaddresses']); - - // de-dupe - layers = layers.filter(function(item, pos) { - return layers.indexOf(item) === pos; - }); - - return layers; -}; diff --git a/helper/query_parser.js b/helper/query_parser.js index 20e4c332..b60ebcd8 100644 --- a/helper/query_parser.js +++ b/helper/query_parser.js @@ -1,26 +1,20 @@ var parser = require('addressit'); var extend = require('extend'); -var get_layers_helper = require('../helper/layers'); +var layers_map = require('../query/layers'); var delim = ','; module.exports = {}; module.exports.get_layers = function get_layers(query) { - var tokenized = query.split(/[ ,]+/); - var hasNumber = /\d/.test(query); - if (query.length <= 3 ) { // no address parsing required - return get_layers_helper(['admin']); + return layers_map.coarse; } }; module.exports.get_parsed_address = function get_parsed_address(query) { - var tokenized = query.split(/[ ,]+/); - var hasNumber = /\d/.test(query); - var getAdminPartsBySplittingOnDelim = function(query) { // naive approach - for admin matching during query time // split 'flatiron, new york, ny' into 'flatiron' and 'new york, ny' diff --git a/package.json b/package.json index d2853d8c..e47affc6 100644 --- a/package.json +++ b/package.json @@ -44,6 +44,7 @@ "geolib": "^2.0.18", "geopipes-elasticsearch-backend": "^0.2.0", "is-object": "^1.0.1", + "lodash": "^3.10.1", "markdown": "0.5.0", "microtime": "1.4.0", "morgan": "1.5.2", diff --git a/query/layers.js b/query/layers.js new file mode 100644 index 00000000..7f16d1fb --- /dev/null +++ b/query/layers.js @@ -0,0 +1,15 @@ +/* + * Mapping from data layers to type values + */ + +module.exports = { + 'venue': ['geoname','osmnode','osmway'], + 'address': ['osmaddress','openaddresses'], + 'country': ['admin0'], + 'region': ['admin1'], + 'county': ['admin2'], + 'locality': ['locality'], + 'localadmin': ['local_admin'], + 'neighbourhood': ['neighborhood'], + 'coarse': ['admin0','admin1','admin2','neighborhood','locality','local_admin'], +}; diff --git a/routes/v1.js b/routes/v1.js index 592e6ce3..d041ae32 100644 --- a/routes/v1.js +++ b/routes/v1.js @@ -69,6 +69,7 @@ function addRoutes(app, peliasConfig) { ]), reverse: createRouter([ sanitisers.reverse.middleware, + middleware.types, controllers.search(undefined, reverseQuery), // TODO: add confidence scores postProc.distances(), diff --git a/sanitiser/_layers.js b/sanitiser/_layers.js deleted file mode 100644 index 8feb50e9..00000000 --- a/sanitiser/_layers.js +++ /dev/null @@ -1,52 +0,0 @@ - -var isObject = require('is-object'), - types = require('../query/types'), - get_layers = require('../helper/layers'); - -// validate inputs, convert types and apply defaults -function sanitize( req ){ - var clean = req.clean || {}; - var params= req.query; - - clean.types = clean.types || {}; - - // ensure the input params are a valid object - if( !isObject( params ) ){ - params = {}; - } - - // default case (no layers specified in GET params) - // don't even set the from_layers key in this case - if('string' !== typeof params.layers || !params.layers.length){ - return { 'error': false }; - } - - // decide which layers can be queried - var alias_layers = ['poi', 'admin', 'address']; - var alias_types = types.concat(alias_layers); - - // parse GET params - var layers = params.layers.split(',').map( function( layer ){ - return layer.toLowerCase(); // lowercase inputs - }); - - // validate layer names - for( var x=0; x 0) { - return { - error: true, - message: '`' + invalid_sources[0] + '` is an invalid source parameter. Valid options: ' + Object.keys(sources_map).join(', ') - }; - } - - req.clean.types.from_sources = sources.reduce(function(acc, source) { - return acc.concat(sources_map[source]); - }, []); - - return { error: false }; -} - -module.exports = sanitize; diff --git a/sanitiser/_targets.js b/sanitiser/_targets.js new file mode 100644 index 00000000..43092fd7 --- /dev/null +++ b/sanitiser/_targets.js @@ -0,0 +1,57 @@ +var _ = require('lodash'); + +function setup(paramName, targetMap) { + return function (req ) { + return sanitize(paramName, targetMap, req); + }; +} + +function sanitize( paramName, targetMap, req ) { + var params = req.query || {}; + + req.clean = req.clean || {}; + req.clean.types = req.clean.types || {}; + + // default case (no sources specified in GET params) + // there is a case where the property is present, but set to null or undefined + if (params.hasOwnProperty(paramName) === false || typeof params[paramName] === 'undefined') { + return { error: false }; + } + + params[paramName] = params[paramName].trim(); + + if (params[paramName].length === 0) { + return { + error: true, + message: paramName + ' parameter cannot be an empty string. Valid options: ' + Object.keys(targetMap).join(', ') + }; + } + + var targets = params[paramName].split(',').map( function( target ){ + return target.toLowerCase(); // lowercase inputs + }); + + var invalidTargets = targets.filter(function(target) { + return targetMap.hasOwnProperty(target) === false; + }); + + if (invalidTargets.length > 0) { + return { + error: true, + message: invalidTargets[0] + ' is an invalid ' + paramName + ' parameter. Valid options: ' + Object.keys(targetMap).join(', ') + }; + } + + var cleanPropName = 'from_' + paramName; + + req.clean.types[cleanPropName] = targets.reduce(function(acc, target) { + return acc.concat(targetMap[target]); + }, []); + + // dedupe in case aliases expanded to common things or user typed in duplicates + req.clean.types[cleanPropName] = _.unique(req.clean.types[cleanPropName]); + + return { error: false }; +} + +module.exports = setup; diff --git a/sanitiser/reverse.js b/sanitiser/reverse.js index a74a8c39..1aab041d 100644 --- a/sanitiser/reverse.js +++ b/sanitiser/reverse.js @@ -1,15 +1,16 @@ -var _sanitize = require('../sanitiser/_sanitize'), - sanitiser = { - latlonzoom: require('../sanitiser/_geo_reverse'), - layers: require('../sanitiser/_layers'), - suorce: require('../sanitiser/_sources'), - details: require('../sanitiser/_details'), - size: require('../sanitiser/_size'), - categories: function ( req ) { - var categories = require('../sanitiser/_categories'); - return categories(req); - } - }; +var _sanitize = require('../sanitiser/_sanitize'); + +var sanitiser = { + latlonzoom: require('../sanitiser/_geo_reverse'), + layers: require('../sanitiser/_targets')('layers', require('../query/layers')), + sources: require('../sanitiser/_targets')('sources', require('../query/sources')), + details: require('../sanitiser/_details'), + size: require('../sanitiser/_size'), + categories: function (req) { + var categories = require('../sanitiser/_categories'); + return categories(req); + } +}; var sanitize = function(req, cb) { _sanitize(req, sanitiser, cb); }; @@ -27,3 +28,5 @@ module.exports.middleware = function( req, res, next ){ next(); }); }; + +module.exports.sanitiser_list = sanitiser; diff --git a/sanitiser/search.js b/sanitiser/search.js index c6c9e0d3..0427a2ac 100644 --- a/sanitiser/search.js +++ b/sanitiser/search.js @@ -3,10 +3,14 @@ var _sanitize = require('../sanitiser/_sanitize'), sanitizers = { text: require('../sanitiser/_text'), size: require('../sanitiser/_size'), - layers: require('../sanitiser/_layers'), - source: require('../sanitiser/_sources'), + layers: require('../sanitiser/_targets')('layers', require( '../query/layers' )), + sources: require('../sanitiser/_targets')('sources', require( '../query/sources' )), details: require('../sanitiser/_details'), - latlonzoom: require('../sanitiser/_geo_search') + latlonzoom: require('../sanitiser/_geo_search'), + categories: function (req) { + var categories = require('../sanitiser/_categories'); + return categories(req); + } }; var sanitize = function(req, cb) { _sanitize(req, sanitizers, cb); }; @@ -25,3 +29,5 @@ module.exports.middleware = function( req, res, next ){ next(); }); }; + +module.exports.sanitiser_list = sanitizers; \ No newline at end of file diff --git a/test/unit/helper/query_parser.js b/test/unit/helper/query_parser.js index 1021d37c..ad669ece 100644 --- a/test/unit/helper/query_parser.js +++ b/test/unit/helper/query_parser.js @@ -1,6 +1,6 @@ var parser = require('../../../helper/query_parser'); -var get_layers = require('../../../helper/layers'); +var layers_map = require('../../../query/layers'); module.exports.tests = {}; @@ -43,7 +43,7 @@ module.exports.tests.parse_three_chars_or_less = function(test, common) { var testParse = function(query) { test('query length < 3 (' + query + ')', function(t) { var address = parser.get_parsed_address(query); - var target_layer = get_layers(['admin']); + var target_layer = layers_map.coarse; var layers = parser.get_layers(query); t.equal(typeof address, 'object', 'valid object'); @@ -67,7 +67,7 @@ module.exports.tests.parse_one_or_more_tokens = function(test, common) { var testParse = function(query, parse_address) { test('query with one or more tokens (' + query + ')', function(t) { var address = parser.get_parsed_address(query); - var target_layer = get_layers(['admin', 'poi']); + var target_layer = layers_map.coarse.concat(layers_map.venue); var layers = parser.get_layers(query); t.equal(typeof address, 'object', 'valid object'); @@ -119,7 +119,6 @@ module.exports.tests.parse_address = function(test, common) { query_string = query_string.substring(1); var address = parser.get_parsed_address(query_string); - var non_address_layer = get_layers(['admin', 'poi']); t.equal(typeof address, 'object', 'valid object for the address ('+query_string+')'); diff --git a/test/unit/run.js b/test/unit/run.js index 17f0f457..761d2fef 100644 --- a/test/unit/run.js +++ b/test/unit/run.js @@ -10,6 +10,7 @@ var tests = [ require('./service/search'), require('./sanitiser/_sources'), require('./sanitiser/search'), + require('./sanitiser/_layers'), require('./sanitiser/reverse'), require('./sanitiser/place'), require('./query/types'), diff --git a/test/unit/sanitiser/_layers.js b/test/unit/sanitiser/_layers.js new file mode 100644 index 00000000..3ea3f2c7 --- /dev/null +++ b/test/unit/sanitiser/_layers.js @@ -0,0 +1,93 @@ + +var sanitize = require('../../../sanitiser/_targets')('layers', require('../../../query/layers')); + +module.exports.tests = {}; + +module.exports.tests.sanitize_layers = function(test, common) { + test('unspecified', function(t) { + var res = sanitize({ query: { layers: undefined } }); + t.equal(res.error, false); + t.end(); + }); + test('invalid layer', function(t) { + var req = { query: { layers: 'test_layer' } }; + var res = sanitize(req); + var msg = ' is an invalid layers parameter. Valid options: '; + t.true(res.error, 'error flag set'); + t.true(res.message.match(msg), 'invalid layer requested'); + t.true(res.message.length > msg.length, 'invalid error message'); + t.end(); + }); + test('venue (alias) layer', function(t) { + var venue_layers = ['geoname','osmnode','osmway']; + var req = { query: { layers: 'venue' } }; + sanitize(req); + t.deepEqual(req.clean.types.from_layers, venue_layers, 'venue layers set'); + t.end(); + }); + test('coarse (alias) layer', function(t) { + var admin_layers = ['admin0','admin1','admin2','neighborhood','locality','local_admin']; + var req = { query: { layers: 'coarse' } }; + sanitize(req); + t.deepEqual(req.clean.types.from_layers, admin_layers, 'coarse layers set'); + t.end(); + }); + test('address (alias) layer', function(t) { + var address_layers = ['osmaddress','openaddresses']; + var req = { query: { layers: 'address' } }; + sanitize(req); + t.deepEqual(req.clean.types.from_layers, address_layers, 'address layers set'); + t.end(); + }); + test('venue alias layer plus regular layers', function(t) { + var venue_layers = ['geoname','osmnode','osmway']; + var reg_layers = ['admin0', 'admin1']; + var req = { query: { layers: 'venue,country,region' } }; + sanitize(req); + t.deepEqual(req.clean.types.from_layers, venue_layers.concat(reg_layers), 'venue + regular layers'); + t.end(); + }); + test('coarse alias layer plus regular layers', function(t) { + var admin_layers = ['admin0','admin1','admin2','neighborhood','locality','local_admin']; + var reg_layers = ['geoname', 'osmnode', 'osmway']; + + var req = { query: { layers: 'coarse,venue,country' } }; + sanitize(req); + t.deepEqual(req.clean.types.from_layers, admin_layers.concat(reg_layers), 'coarse + regular layers set'); + t.end(); + }); + test('address alias layer plus regular layers', function(t) { + var address_layers = ['osmaddress','openaddresses']; + var reg_layers = ['admin0', 'locality']; + + var req = { query: { layers: 'address,country,locality' } }; + sanitize(req); + t.deepEqual(req.clean.types.from_layers, address_layers.concat(reg_layers), 'address + regular layers set'); + t.end(); + }); + test('alias layer plus regular layers (no duplicates)', function(t) { + var venue_layers = ['geoname','osmnode','osmway','admin0']; + var req = { query: { layers: 'venue,country' } }; + sanitize(req); + t.deepEqual(req.clean.types.from_layers, venue_layers, 'venue layers found (no duplicates)'); + t.end(); + }); + test('multiple alias layers (no duplicates)', function(t) { + var alias_layers = ['geoname','osmnode','osmway','admin0','admin1','admin2','neighborhood','locality','local_admin']; + var req = { query: { layers: 'venue,coarse' } }; + sanitize(req); + t.deepEqual(req.clean.types.from_layers, alias_layers, 'all layers found (no duplicates)'); + t.end(); + }); +}; + +module.exports.all = function (tape, common) { + + function test(name, testFunction) { + return tape('SANTIZE _layers ' + name, testFunction); + } + + for( var testCase in module.exports.tests ){ + module.exports.tests[testCase](test, common); + } +}; diff --git a/test/unit/sanitiser/_sources.js b/test/unit/sanitiser/_sources.js index 6bfea43e..81bb4a37 100644 --- a/test/unit/sanitiser/_sources.js +++ b/test/unit/sanitiser/_sources.js @@ -1,4 +1,4 @@ -var sanitize = require( '../../../sanitiser/_sources' ); +var sanitize = require( '../../../sanitiser/_targets' )('sources', require('../../../query/sources')); var success_response = { error: false }; @@ -26,7 +26,7 @@ module.exports.tests.no_sources = function(test, common) { var expected_response = { error: true, - message: '`sources` parameter cannot be an empty string. ' + + message: 'sources parameter cannot be an empty string. ' + 'Valid options: gn, geonames, oa, openaddresses, qs, quattroshapes, osm, openstreetmap' }; @@ -98,7 +98,7 @@ module.exports.tests.invalid_sources = function(test, common) { }; var expected_response = { error: true, - message: '`notasource` is an invalid source parameter. ' + + message: 'notasource is an invalid sources parameter. ' + 'Valid options: gn, geonames, oa, openaddresses, qs, quattroshapes, osm, openstreetmap' }; diff --git a/test/unit/sanitiser/reverse.js b/test/unit/sanitiser/reverse.js index bf3659b5..d249bd3a 100644 --- a/test/unit/sanitiser/reverse.js +++ b/test/unit/sanitiser/reverse.js @@ -2,7 +2,6 @@ var suggest = require('../../../sanitiser/reverse'), _sanitize = suggest.sanitize, middleware = suggest.middleware, - delim = ',', defaultError = 'missing param \'lat\'', defaultClean = { lat:0, types: { @@ -29,6 +28,14 @@ module.exports.tests.interface = function(test, common) { }); }; +module.exports.tests.sanitisers = function(test, common) { + test('check sanitiser list', function (t) { + var expected = ['latlonzoom', 'layers', 'sources', 'details', 'size', 'categories']; + t.deepEqual(Object.keys(suggest.sanitiser_list), expected); + t.end(); + }); +}; + module.exports.tests.sanitize_lat = function(test, common) { var lats = { invalid: [], @@ -154,82 +161,6 @@ module.exports.tests.sanitize_details = function(test, common) { }); }; -module.exports.tests.sanitize_layers = function(test, common) { - test('unspecified', function(t) { - sanitize({ layers: undefined, 'point.lat': 0, 'point.lon': 0 }, function( err, clean ){ - t.deepEqual(clean.types.from_layers, defaultClean.types.from_layers, 'default layers set'); - t.end(); - }); - }); - test('invalid layer', function(t) { - sanitize({ layers: 'test_layer', 'point.lat': 0, 'point.lon': 0 }, function( err, clean ){ - var msg = 'invalid param \'layers\': must be one or more of '; - t.true(err.match(msg), 'invalid layer requested'); - t.true(err.length > msg.length, 'invalid error message'); - t.end(); - }); - }); - test('poi (alias) layer', function(t) { - var poi_layers = ['geoname','osmnode','osmway']; - sanitize({ layers: 'poi', 'point.lat': 0, 'point.lon': 0 }, function( err, clean ){ - t.deepEqual(clean.types.from_layers, poi_layers, 'poi layers set'); - t.end(); - }); - }); - test('admin (alias) layer', function(t) { - var admin_layers = ['admin0','admin1','admin2','neighborhood','locality','local_admin']; - sanitize({ layers: 'admin', 'point.lat': 0, 'point.lon': 0 }, function( err, clean ){ - t.deepEqual(clean.types.from_layers, admin_layers, 'admin layers set'); - t.end(); - }); - }); - test('address (alias) layer', function(t) { - var address_layers = ['osmaddress','openaddresses']; - sanitize({ layers: 'address', 'point.lat': 0, 'point.lon': 0 }, function( err, clean ){ - t.deepEqual(clean.types.from_layers, address_layers, 'address layers set'); - t.end(); - }); - }); - test('poi alias layer plus regular layers', function(t) { - var poi_layers = ['geoname','osmnode','osmway']; - var reg_layers = ['admin0', 'admin1']; - sanitize({ layers: 'poi,admin0,admin1', 'point.lat': 0, 'point.lon': 0 }, function( err, clean ){ - t.deepEqual(clean.types.from_layers, reg_layers.concat(poi_layers), 'poi + regular layers'); - t.end(); - }); - }); - test('admin alias layer plus regular layers', function(t) { - var admin_layers = ['admin0','admin1','admin2','neighborhood','locality','local_admin']; - var reg_layers = ['geoname', 'osmway']; - sanitize({ layers: 'admin,geoname,osmway', 'point.lat': 0, 'point.lon': 0 }, function( err, clean ){ - t.deepEqual(clean.types.from_layers, reg_layers.concat(admin_layers), 'admin + regular layers set'); - t.end(); - }); - }); - test('address alias layer plus regular layers', function(t) { - var address_layers = ['osmaddress','openaddresses']; - var reg_layers = ['geoname', 'osmway']; - sanitize({ layers: 'address,geoname,osmway', 'point.lat': 0, 'point.lon': 0 }, function( err, clean ){ - t.deepEqual(clean.types.from_layers, reg_layers.concat(address_layers), 'address + regular layers set'); - t.end(); - }); - }); - test('alias layer plus regular layers (no duplicates)', function(t) { - var poi_layers = ['geoname','osmnode','osmway']; - sanitize({ layers: 'poi,geoname,osmnode', 'point.lat': 0, 'point.lon': 0 }, function( err, clean ){ - t.deepEqual(clean.types.from_layers, poi_layers, 'poi layers found (no duplicates)'); - t.end(); - }); - }); - test('multiple alias layers (no duplicates)', function(t) { - var alias_layers = ['geoname','osmnode','osmway','admin0','admin1','admin2','neighborhood','locality','local_admin']; - sanitize({ layers: 'poi,admin', 'point.lat': 0, 'point.lon': 0 }, function( err, clean ){ - t.deepEqual(clean.types.from_layers, alias_layers, 'all layers found (no duplicates)'); - t.end(); - }); - }); -}; - module.exports.tests.sanitize_categories = function(test, common) { var queryParams = { 'point.lat': 0, 'point.lon': 0 }; test('unspecified', function(t) { diff --git a/test/unit/sanitiser/search.js b/test/unit/sanitiser/search.js index 744c7aa1..bdc791c5 100644 --- a/test/unit/sanitiser/search.js +++ b/test/unit/sanitiser/search.js @@ -5,7 +5,6 @@ var search = require('../../../sanitiser/search'), defaultParsed = _text.defaultParsed, _sanitize = search.sanitize, middleware = search.middleware, - delim = ',', defaultError = 'invalid param \'text\': text length, must be >0', defaultClean = { text: 'test', types: { @@ -26,7 +25,15 @@ module.exports.tests.interface = function(test, common) { }); test('middleware interface', function(t) { t.equal(typeof middleware, 'function', 'middleware is a function'); - t.equal(middleware.length, 3, 'sanitizee has a valid middleware'); + t.equal(middleware.length, 3, 'sanitize has a valid middleware'); + t.end(); + }); +}; + +module.exports.tests.sanitisers = function(test, common) { + test('check sanitiser list', function (t) { + var expected = ['text', 'size', 'layers', 'sources', 'details', 'latlonzoom', 'categories' ]; + t.deepEqual(Object.keys(search.sanitiser_list), expected); t.end(); }); }; @@ -273,83 +280,6 @@ module.exports.tests.sanitize_details = function(test, common) { }); }; -module.exports.tests.sanitize_layers = function(test, common) { - test('unspecified', function(t) { - sanitize({ layers: undefined, text: 'test' }, function( err, clean ){ - t.deepEqual(clean.types.from_layers, defaultClean.types.from_layers, 'default layers set'); - t.end(); - }); - }); - test('invalid layer', function(t) { - sanitize({ layers: 'test_layer', text: 'test' }, function( err, clean ){ - var msg = 'invalid param \'layers\': must be one or more of '; - t.true(err.match(msg), 'invalid layer requested'); - t.true(err.length > msg.length, 'invalid error message'); - t.end(); - }); - }); - test('poi (alias) layer', function(t) { - var poi_layers = ['geoname','osmnode','osmway']; - sanitize({ layers: 'poi', text: 'test' }, function( err, clean ){ - t.deepEqual(clean.types.from_layers, poi_layers, 'poi layers set'); - t.end(); - }); - }); - test('admin (alias) layer', function(t) { - var admin_layers = ['admin0','admin1','admin2','neighborhood','locality','local_admin']; - sanitize({ layers: 'admin', text: 'test' }, function( err, clean ){ - t.deepEqual(clean.types.from_layers, admin_layers, 'admin layers set'); - t.end(); - }); - }); - test('address (alias) layer', function(t) { - var address_layers = ['osmaddress','openaddresses']; - sanitize({ layers: 'address', text: 'test' }, function( err, clean ){ - t.deepEqual(clean.types.from_layers, address_layers, 'types from layers set'); - t.deepEqual(clean.types.from_address_parser, _text.allLayers, 'address parser uses default layers'); - t.end(); - }); - }); - test('poi alias layer plus regular layers', function(t) { - var poi_layers = ['geoname','osmnode','osmway']; - var reg_layers = ['admin0', 'admin1']; - sanitize({ layers: 'poi,admin0,admin1', text: 'test' }, function( err, clean ){ - t.deepEqual(clean.types.from_layers, reg_layers.concat(poi_layers), 'poi + regular layers'); - t.end(); - }); - }); - test('admin alias layer plus regular layers', function(t) { - var admin_layers = ['admin0','admin1','admin2','neighborhood','locality','local_admin']; - var reg_layers = ['geoname', 'osmway']; - sanitize({ layers: 'admin,geoname,osmway', text: 'test' }, function( err, clean ){ - t.deepEqual(clean.types.from_layers, reg_layers.concat(admin_layers), 'admin + regular layers set'); - t.end(); - }); - }); - test('address alias layer plus regular layers', function(t) { - var address_layers = ['osmaddress','openaddresses']; - var reg_layers = ['geoname', 'osmway']; - sanitize({ layers: 'address,geoname,osmway', text: 'test' }, function( err, clean ){ - t.deepEqual(clean.types.from_layers, reg_layers.concat(address_layers), 'address + regular layers set'); - t.end(); - }); - }); - test('alias layer plus regular layers (no duplicates)', function(t) { - var poi_layers = ['geoname','osmnode','osmway']; - sanitize({ layers: 'poi,geoname,osmnode', text: 'test' }, function( err, clean ){ - t.deepEqual(clean.types.from_layers, poi_layers, 'poi layers found (no duplicates)'); - t.end(); - }); - }); - test('multiple alias layers (no duplicates)', function(t) { - var alias_layers = ['geoname','osmnode','osmway','admin0','admin1','admin2','neighborhood','locality','local_admin']; - sanitize({ layers: 'poi,admin', text: 'test' }, function( err, clean ){ - t.deepEqual(clean.types.from_layers, alias_layers, 'all layers found (no duplicates)'); - t.end(); - }); - }); -}; - module.exports.tests.invalid_params = function(test, common) { test('invalid text params', function(t) { sanitize( undefined, function( err, clean ){ From e726636c3df47e6cccb60a85be53899851cb05ce Mon Sep 17 00:00:00 2001 From: Peter Johnson Date: Mon, 14 Sep 2015 19:29:44 +0200 Subject: [PATCH 3/3] merge with master --- controller/status.js | 3 + package.json | 2 +- routes/v1.js | 8 +- sanitiser/_categories.js | 35 ++++----- sanitiser/_details.js | 35 +++------ sanitiser/_geo_common.js | 11 +-- sanitiser/_geo_reverse.js | 37 +++------ sanitiser/_geo_search.js | 37 +++------ sanitiser/_id.js | 129 +++++++++++++++++--------------- sanitiser/_sanitize.js | 17 ----- sanitiser/_size.js | 55 +++++++++----- sanitiser/_targets.js | 102 +++++++++++++++---------- sanitiser/_text.js | 41 +++++----- sanitiser/place.js | 7 +- sanitiser/reverse.js | 26 +++---- sanitiser/sanitizeAll.js | 26 +++++++ sanitiser/search.js | 14 ++-- test/unit/sanitiser/_layers.js | 89 ++++++++++++++-------- test/unit/sanitiser/_sources.js | 69 ++++++++++------- test/unit/sanitiser/reverse.js | 10 +-- test/unit/sanitiser/search.js | 2 +- 21 files changed, 405 insertions(+), 350 deletions(-) create mode 100644 controller/status.js delete mode 100644 sanitiser/_sanitize.js create mode 100644 sanitiser/sanitizeAll.js diff --git a/controller/status.js b/controller/status.js new file mode 100644 index 00000000..7c87af6d --- /dev/null +++ b/controller/status.js @@ -0,0 +1,3 @@ +module.exports = function controller( req, res, next) { + res.send('status: ok'); +}; diff --git a/package.json b/package.json index e47affc6..8018919c 100644 --- a/package.json +++ b/package.json @@ -35,6 +35,7 @@ "dependencies": { "addressit": "1.3.0", "async": "^0.9.0", + "check-types": "^3.3.1", "cluster2": "git://github.com/missinglink/cluster2.git#node_zero_twelve", "express": "^4.8.8", "express-http-proxy": "^0.6.0", @@ -43,7 +44,6 @@ "geojson-extent": "^0.3.1", "geolib": "^2.0.18", "geopipes-elasticsearch-backend": "^0.2.0", - "is-object": "^1.0.1", "lodash": "^3.10.1", "markdown": "0.5.0", "microtime": "1.4.0", diff --git a/routes/v1.js b/routes/v1.js index d041ae32..49fb3021 100644 --- a/routes/v1.js +++ b/routes/v1.js @@ -19,7 +19,8 @@ var middleware = { var controllers = { mdToHTML: require('../controller/markdownToHtml'), place: require('../controller/place'), - search: require('../controller/search') + search: require('../controller/search'), + status: require('../controller/status') }; /** ----------------------- controllers ----------------------- **/ @@ -83,6 +84,9 @@ function addRoutes(app, peliasConfig) { postProc.renamePlacenames(), postProc.geocodeJSON(peliasConfig), postProc.sendJSON + ]), + status: createRouter([ + controllers.status ]) }; @@ -97,6 +101,8 @@ function addRoutes(app, peliasConfig) { app.get ( base + 'search', routers.search ); app.post( base + 'search', routers.search ); app.get ( base + 'reverse', routers.reverse ); + + app.get ( '/status', routers.status ); } /** diff --git a/sanitiser/_categories.js b/sanitiser/_categories.js index f29c9fd0..e76e8767 100644 --- a/sanitiser/_categories.js +++ b/sanitiser/_categories.js @@ -1,36 +1,33 @@ -var isObject = require('is-object'); +var check = require('check-types'); // validate inputs, convert types and apply defaults -function sanitize( req ){ +function sanitize( raw, clean ){ - var clean = req.clean || {}; - var params= req.query; - - // ensure the input params are a valid object - if( !isObject( params ) ){ - params = {}; - } + // error & warning messages + var messages = { errors: [], warnings: [] }; // default case (no categories specified in GET params) - if('string' !== typeof params.categories || !params.categories.length){ - clean.categories = []; - } - else { - // parse GET params - clean.categories = params.categories.split(',') + clean.categories = []; + + // if categories string has been set + if( check.unemptyString( raw.categories ) ){ + + // map input categories to valid format + clean.categories = raw.categories.split(',') .map(function (cat) { return cat.toLowerCase().trim(); // lowercase inputs }) .filter( function( cat ) { return ( cat.length > 0 ); }); - } - // pass validated params to next middleware - req.clean = clean; + if( !clean.categories.length ){ + messages.warnings.push( 'invalid \'categories\': no valid category strings found'); + } + } - return { 'error': false }; + return messages; } diff --git a/sanitiser/_details.js b/sanitiser/_details.js index 6dc2b119..e17c656c 100644 --- a/sanitiser/_details.js +++ b/sanitiser/_details.js @@ -1,36 +1,25 @@ -var isObject = require('is-object'); + +var check = require('check-types'); +var DEFAULT_DETAILS_BOOL = true; // validate inputs, convert types and apply defaults -function sanitize( req, default_value ){ - - var clean = req.clean || {}; - var params= req.query; +function sanitize( raw, clean ){ - if (default_value === undefined) { - default_value = true; - } - - default_value = !!default_value; + // error & warning messages + var messages = { errors: [], warnings: [] }; - // ensure the input params are a valid object - if( !isObject( params ) ){ - params = {}; - } - - if (params.details !== undefined) { - clean.details = isTruthy(params.details); + if( !check.undefined( raw.details ) ){ + clean.details = isTruthy( raw.details ); } else { - clean.details = default_value; + clean.details = DEFAULT_DETAILS_BOOL; } - req.clean = clean; - - return {'error':false}; - + return messages; } +// be lenient with 'truthy' values function isTruthy(val) { - if (typeof val === 'string') { + if( check.string( val ) ){ return ['true', '1', 'yes', 'y'].indexOf(val) !== -1; } diff --git a/sanitiser/_geo_common.js b/sanitiser/_geo_common.js index 2bf8c6a5..71b728cb 100644 --- a/sanitiser/_geo_common.js +++ b/sanitiser/_geo_common.js @@ -1,7 +1,8 @@ /** * helper sanitiser methods for geo parameters */ -var util = require( 'util' ); +var util = require('util'), + check = require('check-types'); /** * Parse and validate bbox parameter @@ -9,15 +10,15 @@ var util = require( 'util' ); * bbox = left, bottom, right, top * bbox = min Longitude, min Latitude, max Longitude, max Latitude * + * @param {object} raw * @param {object} clean - * @param {string} param */ -function sanitize_bbox( clean, param ) { - if( !param ) { +function sanitize_bbox( raw, clean ) { + if( !check.unemptyString( raw.bbox ) ) { return; } - var bboxArr = param.split( ',' ); + var bboxArr = raw.bbox.split( ',' ); if( Array.isArray( bboxArr ) && bboxArr.length === 4 ) { var bbox = bboxArr.map(parseFloat); diff --git a/sanitiser/_geo_reverse.js b/sanitiser/_geo_reverse.js index f613e54f..4b259199 100644 --- a/sanitiser/_geo_reverse.js +++ b/sanitiser/_geo_reverse.js @@ -1,39 +1,26 @@ -var isObject = require('is-object'); + var geo_common = require ('./_geo_common'); +var LAT_LON_IS_REQUIRED = true, + CIRCLE_IS_REQUIRED = false, + CIRCLE_MUST_BE_COMPLETE = false; // validate inputs, convert types and apply defaults -module.exports = function sanitize( req ){ - var clean = req.clean || {}; - var params = req.query; - var latlon_is_required = true; - var circle_is_required = false; - var circle_must_be_complete = false; +module.exports = function sanitize( raw, clean ){ - // ensure the input params are a valid object - if( !isObject( params ) ){ - params = {}; - } - - if( !isObject( params.point ) ){ - params.point = {}; - } + // error & warning messages + var messages = { errors: [], warnings: [] }; try { - geo_common.sanitize_coord( 'lat', clean, params['point.lat'], latlon_is_required ); - geo_common.sanitize_coord( 'lon', clean, params['point.lon'], latlon_is_required ); + geo_common.sanitize_coord( 'lat', clean, raw['point.lat'], LAT_LON_IS_REQUIRED ); + geo_common.sanitize_coord( 'lon', clean, raw['point.lon'], LAT_LON_IS_REQUIRED ); // boundary.circle.* is not mandatory, and only specifying radius is fine, // as point.lat/lon will be used to fill those values by default - geo_common.sanitize_boundary_circle( clean, params, circle_is_required, circle_must_be_complete); + geo_common.sanitize_boundary_circle( clean, raw, CIRCLE_IS_REQUIRED, CIRCLE_MUST_BE_COMPLETE); } catch (err) { - return { - 'error': true, - 'message': err.message - }; + messages.errors.push( err.message ); } - req.clean = clean; - - return { 'error': false }; + return messages; }; diff --git a/sanitiser/_geo_search.js b/sanitiser/_geo_search.js index 1f1fbeb2..cc2fafcb 100644 --- a/sanitiser/_geo_search.js +++ b/sanitiser/_geo_search.js @@ -1,38 +1,21 @@ -var isObject = require('is-object'); + var geo_common = require ('./_geo_common'); +var LAT_LON_IS_REQUIRED = false; // validate inputs, convert types and apply defaults -module.exports = function sanitize( req ){ - var clean = req.clean || {}; - var params = req.query; - var latlon_is_required = false; - - // ensure the input params are a valid object - if( !isObject( params ) ){ - params = {}; - } +module.exports = function sanitize( raw, clean ){ - if( !isObject( params.focus ) ){ - params.focus = {}; - } - - if( !isObject( params.focus.point ) ){ - params.focus.point = {}; - } + // error & warning messages + var messages = { errors: [], warnings: [] }; try { - geo_common.sanitize_coord( 'lat', clean, params['focus.point.lat'], latlon_is_required ); - geo_common.sanitize_coord( 'lon', clean, params['focus.point.lon'], latlon_is_required ); - geo_common.sanitize_bbox(clean, params.bbox); + geo_common.sanitize_coord( 'lat', clean, raw['focus.point.lat'], LAT_LON_IS_REQUIRED ); + geo_common.sanitize_coord( 'lon', clean, raw['focus.point.lon'], LAT_LON_IS_REQUIRED ); + geo_common.sanitize_bbox(raw, clean); } catch (err) { - return { - 'error': true, - 'message': err.message - }; + messages.errors.push( err.message ); } - req.clean = clean; - - return { 'error': false }; + return messages; }; diff --git a/sanitiser/_id.js b/sanitiser/_id.js index 78ff6b1f..77d21fa8 100644 --- a/sanitiser/_id.js +++ b/sanitiser/_id.js @@ -1,72 +1,79 @@ -var isObject = require('is-object'); + +var check = require('check-types'), + types = require('../query/types'); + +var ID_DELIM = ':'; // validate inputs, convert types and apply defaults // id generally looks like 'geoname:4163334' (type:id) // so, both type and id are required fields. -function sanitize( req ){ - req.clean = req.clean || {}; - var params = req.query; - var types = require('../query/types'); - var delim = ':'; - - // ensure params is a valid object - if( !isObject( params ) ){ - params = {}; - } - - var errormessage = function(fieldname, message) { - return { - 'error': true, - 'message': message || ('invalid param \''+ fieldname + '\': text length, must be >0') - }; - }; - - if(('string' === typeof params.id && !params.id.length) || params.id === undefined){ - return errormessage('id'); - } - - if( params && params.id && params.id.length ){ - req.clean.ids = []; - params.ids = Array.isArray(params.id) ? params.id : [params.id]; - - // de-dupe - params.ids = params.ids.filter(function(item, pos) { - return params.ids.indexOf(item) === pos; - }); +function errorMessage(fieldname, message) { + return message || 'invalid param \''+ fieldname + '\': text length, must be >0'; +} + +function sanitize( raw, clean ){ - for (var i=0; i MAX_SIZE ){ + // set the max size + messages.warnings.push('out-of-range integer \'size\', using MAX_SIZE'); + clean.size = MAX_SIZE; + } + else if( _size < MIN_SIZE ){ + // set the min size + messages.warnings.push('out-of-range integer \'size\', using MIN_SIZE'); + clean.size = MIN_SIZE; + } + else { + // set the input size + clean.size = _size; + } + + } + return messages; } // export function diff --git a/sanitiser/_targets.js b/sanitiser/_targets.js index 43092fd7..81e345b6 100644 --- a/sanitiser/_targets.js +++ b/sanitiser/_targets.js @@ -1,57 +1,81 @@ -var _ = require('lodash'); -function setup(paramName, targetMap) { - return function (req ) { - return sanitize(paramName, targetMap, req); +var _ = require('lodash'), + check = require('check-types'); + +function setup( paramName, targetMap ) { + return function( raw, clean ){ + return sanitize( raw, clean, { + paramName: paramName, + targetMap: targetMap, + targetMapKeysString: Object.keys(targetMap).join(',') + }); }; } -function sanitize( paramName, targetMap, req ) { - var params = req.query || {}; +function sanitize( raw, clean, opts ) { - req.clean = req.clean || {}; - req.clean.types = req.clean.types || {}; + // error & warning messages + var messages = { errors: [], warnings: [] }; - // default case (no sources specified in GET params) - // there is a case where the property is present, but set to null or undefined - if (params.hasOwnProperty(paramName) === false || typeof params[paramName] === 'undefined') { - return { error: false }; - } + // init clean.types + clean.types = clean.types || {}; - params[paramName] = params[paramName].trim(); + // the string of targets (comma delimeted) + var targetsString = raw[opts.paramName]; - if (params[paramName].length === 0) { - return { - error: true, - message: paramName + ' parameter cannot be an empty string. Valid options: ' + Object.keys(targetMap).join(', ') - }; - } + // trim whitespace + if( check.unemptyString( targetsString ) ){ + targetsString = targetsString.trim(); - var targets = params[paramName].split(',').map( function( target ){ - return target.toLowerCase(); // lowercase inputs - }); + // param must be a valid non-empty string + if( !check.unemptyString( targetsString ) ){ + messages.errors.push( + opts.paramName + ' parameter cannot be an empty string. Valid options: ' + opts.targetMapKeysString + ); + } + else { - var invalidTargets = targets.filter(function(target) { - return targetMap.hasOwnProperty(target) === false; - }); + // split string in to array and lowercase each target string + var targets = targetsString.split(',').map( function( target ){ + return target.toLowerCase(); // lowercase inputs + }); - if (invalidTargets.length > 0) { - return { - error: true, - message: invalidTargets[0] + ' is an invalid ' + paramName + ' parameter. Valid options: ' + Object.keys(targetMap).join(', ') - }; - } + // emit an error for each target *not* present in the targetMap + targets.filter( function( target ){ + return !opts.targetMap.hasOwnProperty(target); + }).forEach( function( target ){ + messages.errors.push( + '\'' + target + '\' is an invalid ' + opts.paramName + ' parameter. Valid options: ' + opts.targetMapKeysString + ); + }); + + // only set types value when no error occured + if( !messages.errors.length ){ - var cleanPropName = 'from_' + paramName; + // store the values under a new key as 'clean.types.from_*' + var typesKey = 'from_' + opts.paramName; - req.clean.types[cleanPropName] = targets.reduce(function(acc, target) { - return acc.concat(targetMap[target]); - }, []); + // ? + clean.types[typesKey] = targets.reduce(function(acc, target) { + return acc.concat(opts.targetMap[target]); + }, []); + + // dedupe in case aliases expanded to common things or user typed in duplicates + clean.types[typesKey] = _.unique(clean.types[typesKey]); + } + + } + } + + // string is empty + else if( check.string( targetsString ) ){ + messages.errors.push( + opts.paramName + ' parameter cannot be an empty string. Valid options: ' + opts.targetMapKeysString + ); + } - // dedupe in case aliases expanded to common things or user typed in duplicates - req.clean.types[cleanPropName] = _.unique(req.clean.types[cleanPropName]); - return { error: false }; + return messages; } module.exports = setup; diff --git a/sanitiser/_text.js b/sanitiser/_text.js index 41f38d6c..2f1f96af 100644 --- a/sanitiser/_text.js +++ b/sanitiser/_text.js @@ -1,32 +1,33 @@ -var isObject = require('is-object'); -var query_parser = require('../helper/query_parser'); + +var check = require('check-types'), + query_parser = require('../helper/query_parser'); // validate texts, convert types and apply defaults -function sanitize( req ){ - req.clean = req.clean || {}; - var params= req.query; +function sanitize( raw, clean ){ - // ensure the text params are a valid object - if( !isObject( params ) ){ - params = {}; - } + // error & warning messages + var messages = { errors: [], warnings: [] }; - // text text - if('string' !== typeof params.text || !params.text.length){ - return { - 'error': true, - 'message': 'invalid param \'text\': text length, must be >0' - }; + // invalid input 'text' + if( !check.unemptyString( raw.text ) ){ + messages.errors.push('invalid param \'text\': text length, must be >0'); } - req.clean.text = params.text; + // valid input 'text' + else { - req.clean.parsed_text = query_parser.get_parsed_address(params.text); + // valid text + clean.text = raw.text; - req.clean.types = req.clean.layers || {}; - req.clean.types.from_address_parsing = query_parser.get_layers(params.text); + // parse text with query parser + clean.parsed_text = query_parser.get_parsed_address(clean.text); + + // try to set layers from query parser results + clean.types = clean.layers || {}; + clean.types.from_address_parsing = query_parser.get_layers(clean.text); + } - return { 'error': false }; + return messages; } // export function diff --git a/sanitiser/place.js b/sanitiser/place.js index 352777a6..e48f362b 100644 --- a/sanitiser/place.js +++ b/sanitiser/place.js @@ -1,13 +1,15 @@ -var _sanitize = require('../sanitiser/_sanitize'), + +var sanitizeAll = require('../sanitiser/sanitizeAll'), sanitizers = { id: require('../sanitiser/_id'), details: require('../sanitiser/_details') }; -var sanitize = function(req, cb) { _sanitize(req, sanitizers, cb); }; +var sanitize = function(req, cb) { sanitizeAll(req, sanitizers, cb); }; // export sanitize for testing module.exports.sanitize = sanitize; +module.exports.sanitiser_list = sanitizers; // middleware module.exports.middleware = function( req, res, next ){ @@ -16,7 +18,6 @@ module.exports.middleware = function( req, res, next ){ res.status(400); // 400 Bad Request return next(err); } - req.clean = clean; next(); }); }; diff --git a/sanitiser/reverse.js b/sanitiser/reverse.js index 1aab041d..ec86e289 100644 --- a/sanitiser/reverse.js +++ b/sanitiser/reverse.js @@ -1,21 +1,19 @@ -var _sanitize = require('../sanitiser/_sanitize'); -var sanitiser = { - latlonzoom: require('../sanitiser/_geo_reverse'), - layers: require('../sanitiser/_targets')('layers', require('../query/layers')), - sources: require('../sanitiser/_targets')('sources', require('../query/sources')), - details: require('../sanitiser/_details'), - size: require('../sanitiser/_size'), - categories: function (req) { - var categories = require('../sanitiser/_categories'); - return categories(req); - } -}; +var sanitizeAll = require('../sanitiser/sanitizeAll'), + sanitizers = { + layers: require('../sanitiser/_targets')('layers', require('../query/layers')), + sources: require('../sanitiser/_targets')('sources', require('../query/sources')), + size: require('../sanitiser/_size'), + details: require('../sanitiser/_details'), + geo_reverse: require('../sanitiser/_geo_reverse'), + categories: require('../sanitiser/_categories') + }; -var sanitize = function(req, cb) { _sanitize(req, sanitiser, cb); }; +var sanitize = function(req, cb) { sanitizeAll(req, sanitizers, cb); }; // export sanitize for testing module.exports.sanitize = sanitize; +module.exports.sanitiser_list = sanitizers; // middleware module.exports.middleware = function( req, res, next ){ @@ -24,9 +22,7 @@ module.exports.middleware = function( req, res, next ){ res.status(400); // 400 Bad Request return next(err); } - req.clean = clean; next(); }); }; -module.exports.sanitiser_list = sanitiser; diff --git a/sanitiser/sanitizeAll.js b/sanitiser/sanitizeAll.js new file mode 100644 index 00000000..886a64c3 --- /dev/null +++ b/sanitiser/sanitizeAll.js @@ -0,0 +1,26 @@ + +function sanitize( req, sanitizers, cb ){ + + // init an object to store clean + // (sanitized) input parameters + req.clean = {}; + + // source of input parameters + // (in this case from the GET querystring params) + var params = req.query || {}; + + for (var s in sanitizers) { + var sanity = sanitizers[s]( params, req.clean ); + + // errors + if( sanity.errors.length ){ + return cb( sanity.errors[0] ); + } + } + + return cb( undefined, req.clean ); + +} + +// export function +module.exports = sanitize; \ No newline at end of file diff --git a/sanitiser/search.js b/sanitiser/search.js index 0427a2ac..dd042761 100644 --- a/sanitiser/search.js +++ b/sanitiser/search.js @@ -1,22 +1,20 @@ -var _sanitize = require('../sanitiser/_sanitize'), +var sanitizeAll = require('../sanitiser/sanitizeAll'), sanitizers = { text: require('../sanitiser/_text'), size: require('../sanitiser/_size'), layers: require('../sanitiser/_targets')('layers', require( '../query/layers' )), sources: require('../sanitiser/_targets')('sources', require( '../query/sources' )), details: require('../sanitiser/_details'), - latlonzoom: require('../sanitiser/_geo_search'), - categories: function (req) { - var categories = require('../sanitiser/_categories'); - return categories(req); - } + geo_search: require('../sanitiser/_geo_search'), + categories: require('../sanitiser/_categories') }; -var sanitize = function(req, cb) { _sanitize(req, sanitizers, cb); }; +var sanitize = function(req, cb) { sanitizeAll(req, sanitizers, cb); }; // export sanitize for testing module.exports.sanitize = sanitize; +module.exports.sanitiser_list = sanitizers; // middleware module.exports.middleware = function( req, res, next ){ @@ -25,9 +23,7 @@ module.exports.middleware = function( req, res, next ){ res.status(400); // 400 Bad Request return next(err); } - req.clean = clean; next(); }); }; -module.exports.sanitiser_list = sanitizers; \ No newline at end of file diff --git a/test/unit/sanitiser/_layers.js b/test/unit/sanitiser/_layers.js index 3ea3f2c7..12d2cfd3 100644 --- a/test/unit/sanitiser/_layers.js +++ b/test/unit/sanitiser/_layers.js @@ -5,78 +5,105 @@ module.exports.tests = {}; module.exports.tests.sanitize_layers = function(test, common) { test('unspecified', function(t) { - var res = sanitize({ query: { layers: undefined } }); - t.equal(res.error, false); + var messages = sanitize({ layers: undefined }, {}); + t.equal(messages.errors.length, 0, 'no errors'); t.end(); }); test('invalid layer', function(t) { - var req = { query: { layers: 'test_layer' } }; - var res = sanitize(req); + var raw = { layers: 'test_layer' }; + var clean = {}; + + var messages = sanitize(raw, clean); + var msg = ' is an invalid layers parameter. Valid options: '; - t.true(res.error, 'error flag set'); - t.true(res.message.match(msg), 'invalid layer requested'); - t.true(res.message.length > msg.length, 'invalid error message'); + t.equal(messages.errors.length, 1, 'errors set'); + t.true(messages.errors[0].match(msg), 'invalid layer requested'); + t.true(messages.errors[0].length > msg.length, 'invalid error message'); t.end(); }); test('venue (alias) layer', function(t) { var venue_layers = ['geoname','osmnode','osmway']; - var req = { query: { layers: 'venue' } }; - sanitize(req); - t.deepEqual(req.clean.types.from_layers, venue_layers, 'venue layers set'); + var raw = { layers: 'venue' }; + var clean = {}; + + sanitize(raw, clean); + + t.deepEqual(clean.types.from_layers, venue_layers, 'venue layers set'); t.end(); }); test('coarse (alias) layer', function(t) { var admin_layers = ['admin0','admin1','admin2','neighborhood','locality','local_admin']; - var req = { query: { layers: 'coarse' } }; - sanitize(req); - t.deepEqual(req.clean.types.from_layers, admin_layers, 'coarse layers set'); + var raw = { layers: 'coarse' }; + var clean = {}; + + sanitize(raw, clean); + + t.deepEqual(clean.types.from_layers, admin_layers, 'coarse layers set'); t.end(); }); test('address (alias) layer', function(t) { var address_layers = ['osmaddress','openaddresses']; - var req = { query: { layers: 'address' } }; - sanitize(req); - t.deepEqual(req.clean.types.from_layers, address_layers, 'address layers set'); + var raw = { layers: 'address' }; + var clean = {}; + + sanitize(raw, clean); + + t.deepEqual(clean.types.from_layers, address_layers, 'address layers set'); t.end(); }); test('venue alias layer plus regular layers', function(t) { var venue_layers = ['geoname','osmnode','osmway']; var reg_layers = ['admin0', 'admin1']; - var req = { query: { layers: 'venue,country,region' } }; - sanitize(req); - t.deepEqual(req.clean.types.from_layers, venue_layers.concat(reg_layers), 'venue + regular layers'); + var raw = { layers: 'venue,country,region' }; + var clean = {}; + + sanitize(raw, clean); + + t.deepEqual(clean.types.from_layers, venue_layers.concat(reg_layers), 'venue + regular layers'); t.end(); }); test('coarse alias layer plus regular layers', function(t) { var admin_layers = ['admin0','admin1','admin2','neighborhood','locality','local_admin']; var reg_layers = ['geoname', 'osmnode', 'osmway']; - var req = { query: { layers: 'coarse,venue,country' } }; - sanitize(req); - t.deepEqual(req.clean.types.from_layers, admin_layers.concat(reg_layers), 'coarse + regular layers set'); + var raw = { layers: 'coarse,venue,country' }; + var clean = {}; + + sanitize(raw, clean); + + t.deepEqual(clean.types.from_layers, admin_layers.concat(reg_layers), 'coarse + regular layers set'); t.end(); }); test('address alias layer plus regular layers', function(t) { var address_layers = ['osmaddress','openaddresses']; var reg_layers = ['admin0', 'locality']; - var req = { query: { layers: 'address,country,locality' } }; - sanitize(req); - t.deepEqual(req.clean.types.from_layers, address_layers.concat(reg_layers), 'address + regular layers set'); + var raw = { layers: 'address,country,locality' }; + var clean = {}; + + sanitize(raw, clean); + + t.deepEqual(clean.types.from_layers, address_layers.concat(reg_layers), 'address + regular layers set'); t.end(); }); test('alias layer plus regular layers (no duplicates)', function(t) { var venue_layers = ['geoname','osmnode','osmway','admin0']; - var req = { query: { layers: 'venue,country' } }; - sanitize(req); - t.deepEqual(req.clean.types.from_layers, venue_layers, 'venue layers found (no duplicates)'); + var raw = { layers: 'venue,country' }; + var clean = {}; + + sanitize(raw, clean); + + t.deepEqual(clean.types.from_layers, venue_layers, 'venue layers found (no duplicates)'); t.end(); }); test('multiple alias layers (no duplicates)', function(t) { var alias_layers = ['geoname','osmnode','osmway','admin0','admin1','admin2','neighborhood','locality','local_admin']; - var req = { query: { layers: 'venue,coarse' } }; - sanitize(req); - t.deepEqual(req.clean.types.from_layers, alias_layers, 'all layers found (no duplicates)'); + var raw = { layers: 'venue,coarse' }; + var clean = {}; + + sanitize(raw, clean); + + t.deepEqual(clean.types.from_layers, alias_layers, 'all layers found (no duplicates)'); t.end(); }); }; diff --git a/test/unit/sanitiser/_sources.js b/test/unit/sanitiser/_sources.js index 81bb4a37..05507a36 100644 --- a/test/unit/sanitiser/_sources.js +++ b/test/unit/sanitiser/_sources.js @@ -1,19 +1,21 @@ var sanitize = require( '../../../sanitiser/_targets' )('sources', require('../../../query/sources')); -var success_response = { error: false }; +var success_messages = { error: false }; module.exports.tests = {}; module.exports.tests.no_sources = function(test, common) { test('sources is not set', function(t) { var req = { - query: { } + query: { }, + clean: { } }; - var response = sanitize(req); + var messages = sanitize(req.query, req.clean); t.deepEqual(req.clean.types, {}, 'clean.types should be empty object'); - t.deepEqual(response, success_response, 'no error returned'); + t.deepEqual(messages.errors, [], 'no error returned'); + t.deepEqual(messages.warnings, [], 'no warnings returned'); t.end(); }); @@ -21,19 +23,19 @@ module.exports.tests.no_sources = function(test, common) { var req = { query: { sources: '' - } + }, + clean: { } }; - var expected_response = { - error: true, - message: 'sources parameter cannot be an empty string. ' + - 'Valid options: gn, geonames, oa, openaddresses, qs, quattroshapes, osm, openstreetmap' - }; + var expected_error = 'sources parameter cannot be an empty string. ' + + 'Valid options: gn,geonames,oa,openaddresses,qs,quattroshapes,osm,openstreetmap'; - var response = sanitize(req); + var messages = sanitize(req.query, req.clean); t.deepEqual(req.clean.types, {}, 'clean.types should be empty object'); - t.deepEqual(response, expected_response, 'no error returned'); + t.deepEqual(messages.errors.length, 1, 'error returned'); + t.deepEqual(messages.errors[0], expected_error, 'error returned'); + t.deepEqual(messages.warnings, [], 'no warnings returned'); t.end(); }); }; @@ -43,13 +45,16 @@ module.exports.tests.valid_sources = function(test, common) { var req = { query: { sources: 'geonames' - } + }, + clean: { } }; - var response = sanitize(req); + var messages = sanitize(req.query, req.clean); t.deepEqual(req.clean.types, { from_sources: ['geoname'] }, 'clean.types should contain from_source entry with geonames'); - t.deepEqual(response, success_response, 'no error returned'); + t.deepEqual(messages.errors, [], 'no error returned'); + t.deepEqual(messages.warnings, [], 'no warnings returned'); + t.end(); }); @@ -57,16 +62,18 @@ module.exports.tests.valid_sources = function(test, common) { var req = { query: { sources: 'openstreetmap' - } + }, + clean: { } }; var expected_types = { from_sources: ['osmaddress', 'osmnode', 'osmway'] }; - var response = sanitize(req); + var messages = sanitize(req.query, req.clean); t.deepEqual(req.clean.types, expected_types, 'clean.types should contain from_source entry with multiple entries for openstreetmap'); - t.deepEqual(response, success_response, 'no error returned'); + t.deepEqual(messages.errors, [], 'no error returned'); + t.deepEqual(messages.warnings, [], 'no warnings returned'); t.end(); }); @@ -74,17 +81,19 @@ module.exports.tests.valid_sources = function(test, common) { var req = { query: { sources: 'openstreetmap,openaddresses' - } + }, + clean: { } }; var expected_types = { from_sources: ['osmaddress', 'osmnode', 'osmway', 'openaddresses'] }; - var response = sanitize(req); + var messages = sanitize(req.query, req.clean); t.deepEqual(req.clean.types, expected_types, 'clean.types should contain from_source entry with multiple entries for openstreetmap and openadresses'); - t.deepEqual(response, success_response, 'no error returned'); + t.deepEqual(messages.errors, [], 'no error returned'); + t.deepEqual(messages.warnings, [], 'no warnings returned'); t.end(); }); }; @@ -94,17 +103,19 @@ module.exports.tests.invalid_sources = function(test, common) { var req = { query: { sources: 'notasource' - } + }, + clean: { } }; - var expected_response = { - error: true, - message: 'notasource is an invalid sources parameter. ' + - 'Valid options: gn, geonames, oa, openaddresses, qs, quattroshapes, osm, openstreetmap' + var expected_messages = { + errors: [ + '\'notasource\' is an invalid sources parameter. Valid options: gn,geonames,oa,openaddresses,qs,quattroshapes,osm,openstreetmap' + ], + warnings: [] }; - var response = sanitize(req); + var messages = sanitize(req.query, req.clean); - t.deepEqual(response, expected_response, 'error with message returned'); + t.deepEqual(messages, expected_messages, 'error with message returned'); t.deepEqual(req.clean.types, { }, 'clean.types should remain empty'); t.end(); }); @@ -112,7 +123,7 @@ module.exports.tests.invalid_sources = function(test, common) { module.exports.all = function (tape, common) { function test(name, testFunction) { - return tape('SANTIZE _source ' + name, testFunction); + return tape('SANTIZE _sources ' + name, testFunction); } for( var testCase in module.exports.tests ){ diff --git a/test/unit/sanitiser/reverse.js b/test/unit/sanitiser/reverse.js index d249bd3a..5c2a3a9f 100644 --- a/test/unit/sanitiser/reverse.js +++ b/test/unit/sanitiser/reverse.js @@ -1,7 +1,7 @@ -var suggest = require('../../../sanitiser/reverse'), - _sanitize = suggest.sanitize, - middleware = suggest.middleware, +var reverse = require('../../../sanitiser/reverse'), + _sanitize = reverse.sanitize, + middleware = reverse.middleware, defaultError = 'missing param \'lat\'', defaultClean = { lat:0, types: { @@ -30,8 +30,8 @@ module.exports.tests.interface = function(test, common) { module.exports.tests.sanitisers = function(test, common) { test('check sanitiser list', function (t) { - var expected = ['latlonzoom', 'layers', 'sources', 'details', 'size', 'categories']; - t.deepEqual(Object.keys(suggest.sanitiser_list), expected); + var expected = ['layers', 'sources', 'size', 'details', 'geo_reverse', 'categories']; + t.deepEqual(Object.keys(reverse.sanitiser_list), expected); t.end(); }); }; diff --git a/test/unit/sanitiser/search.js b/test/unit/sanitiser/search.js index bdc791c5..e6c39284 100644 --- a/test/unit/sanitiser/search.js +++ b/test/unit/sanitiser/search.js @@ -32,7 +32,7 @@ module.exports.tests.interface = function(test, common) { module.exports.tests.sanitisers = function(test, common) { test('check sanitiser list', function (t) { - var expected = ['text', 'size', 'layers', 'sources', 'details', 'latlonzoom', 'categories' ]; + var expected = ['text', 'size', 'layers', 'sources', 'details', 'geo_search', 'categories' ]; t.deepEqual(Object.keys(search.sanitiser_list), expected); t.end(); });