Merge pull request #92 from pelias/suggest-requires-geo

Suggest requires geo

app.js

@@ -12,7 +12,7 @@ app.use( require('./middleware/jsonp') );
 var sanitisers = {};
 sanitisers.doc      = require('./sanitiser/doc');
 sanitisers.suggest  = require('./sanitiser/suggest');
-sanitisers.search   = sanitisers.suggest;
+sanitisers.search   = require('./sanitiser/search');
 sanitisers.coarse   = require('./sanitiser/coarse');
 sanitisers.reverse  = require('./sanitiser/reverse');
 

sanitiser/search.js

@@ -0,0 +1,26 @@
+
+var logger = require('../src/logger'),
+    _sanitize = require('../sanitiser/_sanitize'),
+    sanitizers = {
+      input: require('../sanitiser/_input'),
+      size: require('../sanitiser/_size'),
+      layers: require('../sanitiser/_layers'),
+      latlonzoom: require('../sanitiser/_geo')
+    };
+
+var sanitize = function(req, cb) { _sanitize(req, sanitizers, cb); };
+
+// export sanitize for testing
+module.exports.sanitize = sanitize;
+
+// middleware
+module.exports.middleware = function( req, res, next ){
+  sanitize( req, function( err, clean ){
+    if( err ){
+      res.status(400); // 400 Bad Request
+      return next(err);
+    }
+    req.clean = clean;
+    next();
+  });
+};

sanitiser/suggest.js

@@ -5,7 +5,10 @@ var logger = require('../src/logger'),
       input: require('../sanitiser/_input'),
       size: require('../sanitiser/_size'),
       layers: require('../sanitiser/_layers'),
-      latlonzoom: require('../sanitiser/_geo')
+      latlonzoom: function( req ) {
+        var geo = require('../sanitiser/_geo');
+        return geo(req, true);
+      }
     };
 
 var sanitize = function(req, cb) { _sanitize(req, sanitizers, cb); };

test/unit/run.js

@@ -11,6 +11,7 @@ var tests = [
   require('./service/search'),
   require('./service/suggest'),
   require('./sanitiser/suggest'),
+  require('./sanitiser/search'),
   require('./sanitiser/reverse'),
   require('./sanitiser/doc'),
   require('./sanitiser/coarse'),

test/unit/sanitiser/search.js

@@ -0,0 +1,388 @@
+
+var search  = require('../../../sanitiser/search'),
+    _sanitize = search.sanitize,
+    middleware = search.middleware,
+    delim = ',',
+    defaultError = 'invalid param \'input\': text length, must be >0',
+    defaultClean =  { input: 'test', 
+                      layers: [ 'geoname', 'osmnode', 'osmway', 'admin0', 'admin1', 'admin2', 'neighborhood', 
+                                'osmaddress', 'openaddresses' ], 
+                      size: 10
+                    },
+    sanitize = function(query, cb) { _sanitize({'query':query}, cb); };
+
+module.exports.tests = {};
+
+module.exports.tests.interface = function(test, common) {
+  test('sanitize interface', function(t) {
+    t.equal(typeof sanitize, 'function', 'sanitize is a function');
+    t.equal(sanitize.length, 2, 'sanitize interface');
+    t.end();
+  });
+  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.end();
+  });
+};
+
+module.exports.tests.sanitize_input = function(test, common) {
+  var inputs = {
+    invalid: [ '', 100, null, undefined, new Date() ],
+    valid: [ 'a', 'aa', 'aaaaaaaa' ]
+  };
+  test('invalid input', function(t) {  
+    inputs.invalid.forEach( function( input ){
+      sanitize({ input: input }, function( err, clean ){
+        t.equal(err, 'invalid param \'input\': text length, must be >0', input + ' is an invalid input');
+        t.equal(clean, undefined, 'clean not set');
+      });
+    });
+    t.end();
+  });
+  test('valid input', function(t) {  
+    inputs.valid.forEach( function( input ){
+      sanitize({ input: input }, function( err, clean ){
+        var expected = JSON.parse(JSON.stringify( defaultClean ));
+        expected.input = input;
+        t.equal(err, undefined, 'no error');
+        t.deepEqual(clean, expected, 'clean set correctly (' + input + ')');
+      });
+    });
+    t.end();
+  });
+};
+
+module.exports.tests.sanitize_input_with_delim = function(test, common) {
+  var inputs = [ 'a,bcd', '123 main st, admin1', ',,,', ' ' ];
+
+  test('valid inputs with a comma', function(t) {  
+    inputs.forEach( function( input ){
+      sanitize({ input: input }, function( err, clean ){
+        var expected = JSON.parse(JSON.stringify( defaultClean ));
+        expected.input = input;
+
+        var delim_index = input.indexOf(delim);
+        if (delim_index!==-1) {
+          expected.input = input.substring(0, input.indexOf(delim));
+          expected.input_admin = input.substring(delim_index + 1).trim();
+        }
+
+        t.equal(err, undefined, 'no error');
+        t.deepEqual(clean, expected, 'clean set correctly (' + input + ')');
+      });
+    });
+    t.end();
+  });
+};
+
+module.exports.tests.sanitize_lat = function(test, common) {
+  var lats = {
+    invalid: [ -181, -120, -91, 91, 120, 181 ],
+    valid: [ 0, 45, 90, -0, '0', '45', '90' ]
+  };
+  test('invalid lat', function(t) {  
+    lats.invalid.forEach( function( lat ){
+      sanitize({ input: 'test', lat: lat, lon: 0 }, function( err, clean ){
+        t.equal(err, 'invalid param \'lat\': must be >-90 and <90', lat + ' is an invalid latitude');
+        t.equal(clean, undefined, 'clean not set');
+      });
+    });
+    t.end();
+  });
+  test('valid lat', function(t) {  
+    lats.valid.forEach( function( lat ){
+      sanitize({ input: 'test', lat: lat, lon: 0 }, function( err, clean ){
+        var expected = JSON.parse(JSON.stringify( defaultClean ));
+        expected.lat = parseFloat( lat );
+        expected.lon = 0;
+        t.equal(err, undefined, 'no error');
+        t.deepEqual(clean, expected, 'clean set correctly (' + lat + ')');
+      });
+    });
+    t.end();
+  });
+};
+
+module.exports.tests.sanitize_lon = function(test, common) {
+  var lons = {
+    invalid: [ -360, -181, 181, 360 ],
+    valid: [ -180, -1, -0, 0, 45, 90, '-180', '0', '180' ]
+  };
+  test('invalid lon', function(t) {  
+    lons.invalid.forEach( function( lon ){
+      sanitize({ input: 'test', lat: 0, lon: lon }, function( err, clean ){
+        t.equal(err, 'invalid param \'lon\': must be >-180 and <180', lon + ' is an invalid longitude');
+        t.equal(clean, undefined, 'clean not set');
+        
+      });
+    });
+    t.end();
+  });
+  test('valid lon', function(t) {  
+    lons.valid.forEach( function( lon ){
+      sanitize({ input: 'test', lat: 0, lon: lon }, function( err, clean ){
+        var expected = JSON.parse(JSON.stringify( defaultClean ));
+        expected.lon = parseFloat( lon );
+        expected.lat = 0;
+        t.equal(err, undefined, 'no error');
+        t.deepEqual(clean, expected, 'clean set correctly (' + lon + ')');
+      });
+    });
+    t.end();
+  });
+};
+
+module.exports.tests.sanitize_optional_geo = function(test, common) {
+  test('no lat/lon', function(t) {  
+    sanitize({ input: 'test' }, function( err, clean ){
+      var expected = defaultClean;
+      t.equal(err, undefined, 'no error');
+      t.equal(clean.lat, undefined, 'clean set without lat');
+      t.equal(clean.lon, undefined, 'clean set without lon');
+      t.deepEqual(clean, expected, 'clean set without lat/lon');
+    });
+    t.end();
+  });
+  test('no lat', function(t) {  
+    sanitize({ input: 'test', lon: 0 }, function( err, clean ){
+      var expected = JSON.parse(JSON.stringify( defaultClean ));
+      expected.lon = 0;
+      t.equal(err, undefined, 'no error');
+      t.deepEqual(clean, expected, 'clean set correctly (without any lat)');
+    });
+    t.end();
+  });
+  test('no lon', function(t) {  
+    sanitize({ input: 'test', lat: 0 }, function( err, clean ){
+      var expected = JSON.parse(JSON.stringify( defaultClean ));
+      expected.lat = 0;
+      t.equal(err, undefined, 'no error');
+      t.deepEqual(clean, expected, 'clean set correctly (without any lon)');
+    });
+    t.end();
+  });
+};
+
+module.exports.tests.sanitize_bbox = function(test, common) {
+  var bboxes = {
+    invalid_coordinates: [
+      '90,-181,-180,34', // invalid top_right lon, bottom_left lat
+      '91,-170,45,-181', // invalid top_right lat, bottom_left lon
+      '91,-181,-91,181', // invalid top_right lat/lon, bottom_left lat/lon
+      '91, -181,-91,181',// invalid - spaces between coordinates
+    ],
+    invalid: [
+      '91;-181,-91,181', // invalid - semicolon between coordinates
+      '91, -181, -91',   // invalid - missing a coordinate
+      '123,12',          // invalid - missing coordinates
+      ''                 // invalid - empty param
+    ],
+    valid: [
+      '90,-179,-80,34', // valid top_right lat/lon, bottom_left lat/lon
+      '0,0,0,0' // valid top_right lat/lon, bottom_left lat/lon
+    ]
+    
+  };
+  test('invalid bbox coordinates', function(t) {  
+    bboxes.invalid_coordinates.forEach( function( bbox ){
+      sanitize({ input: 'test', bbox: bbox }, function( err, clean ){
+        t.equal(err, 'invalid bbox', bbox + ' is invalid');
+        t.equal(clean, undefined, 'clean not set');
+      });
+    });
+    t.end();
+  });
+  test('invalid bbox', function(t) {  
+    bboxes.invalid.forEach( function( bbox ){
+      sanitize({ input: 'test', bbox: bbox }, function( err, clean ){
+        var expected = JSON.parse(JSON.stringify( defaultClean ));
+        t.equal(err, undefined, 'no error');
+        t.deepEqual(clean, expected, 'falling back on 50km distance from centroid');
+      });
+    });
+    t.end();
+  });
+  test('valid bbox', function(t) {  
+    bboxes.valid.forEach( function( bbox ){
+      sanitize({ input: 'test', bbox: bbox }, function( err, clean ){
+        var expected = JSON.parse(JSON.stringify( defaultClean ));
+        var bboxArray = bbox.split(',').map(function(i) {
+          return parseInt(i);
+        });
+        expected.bbox = {
+          top   : Math.max(bboxArray[0], bboxArray[2]),
+          right : Math.max(bboxArray[1], bboxArray[3]),
+          bottom: Math.min(bboxArray[0], bboxArray[2]),
+          left  : Math.min(bboxArray[1], bboxArray[3])
+        };
+        t.equal(err, undefined, 'no error');
+        t.deepEqual(clean, expected, 'clean set correctly (' + bbox + ')');
+      });
+    });
+    t.end();
+  });
+};
+
+module.exports.tests.sanitize_zoom = function(test, common) {
+  test('invalid zoom value', function(t) {
+    sanitize({ zoom: 'a', input: 'test', lat: 0, lon: 0 }, function( err, clean ){
+      t.equal(clean.zoom, undefined, 'zoom not set');
+      t.end();
+    });
+  });
+  test('below min zoom value', function(t) {
+    sanitize({ zoom: -100, input: 'test', lat: 0, lon: 0 }, function( err, clean ){
+      t.equal(clean.zoom, 1, 'min zoom set');
+      t.end();
+    });
+  });
+  test('above max zoom value', function(t) {
+    sanitize({ zoom: 9999, input: 'test', lat: 0, lon: 0 }, function( err, clean ){
+      t.equal(clean.zoom, 18, 'max zoom set');
+      t.end();
+    });
+  });
+};
+
+module.exports.tests.sanitize_size = function(test, common) {
+  test('invalid size value', function(t) {
+    sanitize({ size: 'a', input: 'test', lat: 0, lon: 0 }, function( err, clean ){
+      t.equal(clean.size, 10, 'default size set');
+      t.end();
+    });
+  });
+  test('below min size value', function(t) {
+    sanitize({ size: -100, input: 'test', lat: 0, lon: 0 }, function( err, clean ){
+      t.equal(clean.size, 1, 'min size set');
+      t.end();
+    });
+  });
+  test('above max size value', function(t) {
+    sanitize({ size: 9999, input: 'test', lat: 0, lon: 0 }, function( err, clean ){
+      t.equal(clean.size, 40, 'max size set');
+      t.end();
+    });
+  });
+};
+
+module.exports.tests.sanitize_layers = function(test, common) {
+  test('unspecified', function(t) {
+    sanitize({ layers: undefined, input: 'test' }, function( err, clean ){
+      t.deepEqual(clean.layers, defaultClean.layers, 'default layers set');
+      t.end();
+    });
+  });
+  test('invalid layer', function(t) {
+    sanitize({ layers: 'test_layer', input: 'test' }, function( err, clean ){
+      var msg = 'invalid param \'layer\': 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', input: 'test' }, function( err, clean ){
+      t.deepEqual(clean.layers, poi_layers, 'poi layers set');
+      t.end();
+    });
+  });
+  test('admin (alias) layer', function(t) {
+    var admin_layers = ['admin0','admin1','admin2','neighborhood'];
+    sanitize({ layers: 'admin', input: 'test' }, function( err, clean ){
+      t.deepEqual(clean.layers, admin_layers, 'admin layers set');
+      t.end();
+    });
+  });
+  test('address (alias) layer', function(t) {
+    var address_layers = ['osmaddress','openaddresses'];
+    sanitize({ layers: 'address', input: 'test' }, function( err, clean ){
+      t.deepEqual(clean.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', input: 'test' }, function( err, clean ){
+      t.deepEqual(clean.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'];
+    var reg_layers   = ['geoname', 'osmway'];
+    sanitize({ layers: 'admin,geoname,osmway', input: 'test' }, function( err, clean ){
+      t.deepEqual(clean.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', input: 'test' }, function( err, clean ){
+      t.deepEqual(clean.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', input: 'test' }, function( err, clean ){
+      t.deepEqual(clean.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'];
+    sanitize({ layers: 'poi,admin', input: 'test' }, function( err, clean ){
+      t.deepEqual(clean.layers, alias_layers, 'all layers found (no duplicates)');
+      t.end();
+    });
+  });
+};
+
+module.exports.tests.invalid_params = function(test, common) {
+  test('invalid input params', function(t) {
+    sanitize( undefined, function( err, clean ){
+      t.equal(err, defaultError, 'handle invalid params gracefully');
+      t.end();
+    });
+  });
+};
+
+module.exports.tests.middleware_failure = function(test, common) {
+  test('middleware failure', function(t) {
+    var res = { status: function( code ){
+      t.equal(code, 400, 'status set');
+    }};
+    var next = function( message ){
+      t.equal(message, defaultError);
+      t.end();
+    };
+    middleware( {}, res, next );
+  });
+};
+
+module.exports.tests.middleware_success = function(test, common) {
+  test('middleware success', function(t) {
+    var req = { query: { input: 'test' }};
+    var next = function( message ){
+      t.equal(message, undefined, 'no error message set');
+      t.deepEqual(req.clean, defaultClean);
+      t.end();
+    };
+    middleware( req, undefined, next );
+  });
+};
+
+module.exports.all = function (tape, common) {
+
+  function test(name, testFunction) {
+    return tape('SANTIZE /search ' + name, testFunction);
+  }
+
+  for( var testCase in module.exports.tests ){
+    module.exports.tests[testCase](test, common);
+  }
+};