fix handling of ?size= param for autocomplete

sanitiser/_size.js

@@ -5,32 +5,40 @@ var MIN_SIZE = 1,
     DEFAULT_SIZE = 10;
 
 // validate inputs, convert types and apply defaults
-function sanitize( raw, clean ){
-
-  // error & warning messages
-  var messages = { errors: [], warnings: [] };
-
-  // coercions
-  clean.size = parseInt( raw.size, 10 );
-
-  // invalid numeric input
-  if( isNaN( clean.size ) ){
-    clean.size = DEFAULT_SIZE;
-  }
-  // ensure size falls within defined range
-  else if( clean.size > MAX_SIZE ){
-    // set the max size
-    messages.warnings.push('out-of-range integer \'size\', using MAX_SIZE');
-    clean.size = MAX_SIZE;
-  }
-  else if( clean.size < MIN_SIZE ){
-    // set the min size
-    messages.warnings.push('out-of-range integer \'size\', using MIN_SIZE');
-    clean.size = MIN_SIZE;
-  }
-
-  return messages;
+function setup( size_min, size_max, size_def ){
+
+  // allow caller to inject custom min/max/default values
+  if( !check.number( size_min ) ){ size_min = MIN_SIZE; }
+  if( !check.number( size_max ) ){ size_max = MAX_SIZE; }
+  if( !check.number( size_def ) ){ size_def = DEFAULT_SIZE; }
+
+  return function sanitize( raw, clean ){
+
+    // error & warning messages
+    var messages = { errors: [], warnings: [] };
+
+    // coercions
+    clean.size = parseInt( raw.size, 10 );
+
+    // invalid numeric input
+    if( isNaN( clean.size ) ){
+      clean.size = size_def;
+    }
+    // ensure size falls within defined range
+    else if( clean.size > size_max ){
+      // set the max size
+      messages.warnings.push('out-of-range integer \'size\', using MAX_SIZE');
+      clean.size = size_max;
+    }
+    else if( clean.size < size_min ){
+      // set the min size
+      messages.warnings.push('out-of-range integer \'size\', using MIN_SIZE');
+      clean.size = size_min;
+    }
+
+    return messages;
+  };
 }
 
 // export function
-module.exports = sanitize;
+module.exports = setup;

sanitiser/autocomplete.js

@@ -2,7 +2,7 @@ var sanitizeAll = require('../sanitiser/sanitizeAll'),
     sanitizers = {
       singleScalarParameters: require('../sanitiser/_single_scalar_parameters'),
       text: require('../sanitiser/_text'),
-      size: require('../sanitiser/_size'),
+      size: require('../sanitiser/_size')(10, 10, 10),
       private: require('../sanitiser/_flag_bool')('private', false),
       geo_autocomplete: require('../sanitiser/_geo_autocomplete'),
     };

sanitiser/reverse.js

@@ -7,7 +7,7 @@ var sanitizeAll = require('../sanitiser/sanitizeAll'),
       sources: require('../sanitiser/_targets')('sources', type_mapping.source_mapping),
       // depends on the layers and sources sanitisers, must be run after them
       sources_and_layers: require('../sanitiser/_sources_and_layers'),
-      size: require('../sanitiser/_size'),
+      size: require('../sanitiser/_size')(/* use defaults*/),
       private: require('../sanitiser/_flag_bool')('private', false),
       geo_reverse: require('../sanitiser/_geo_reverse'),
       boundary_country: require('../sanitiser/_boundary_country'),

sanitiser/search.js

@@ -4,7 +4,7 @@ var sanitizeAll = require('../sanitiser/sanitizeAll'),
     sanitizers = {
       singleScalarParameters: require('../sanitiser/_single_scalar_parameters'),
       text: require('../sanitiser/_text'),
-      size: require('../sanitiser/_size'),
+      size: require('../sanitiser/_size')(/* use defaults*/),
       layers: require('../sanitiser/_targets')('layers', type_mapping.layer_mapping),
       sources: require('../sanitiser/_targets')('sources', type_mapping.source_mapping),
       // depends on the layers and sources sanitisers, must be run after them

test/ciao/autocomplete/size_not_default.coffee

@@ -0,0 +1,34 @@
+
+#> set size (autocomplete does not allow size to be changed)
+path: '/v1/autocomplete?text=a&size=3'
+
+#? 200 ok
+response.statusCode.should.be.equal 200
+response.should.have.header 'charset', 'utf8'
+response.should.have.header 'content-type', 'application/json; charset=utf-8'
+
+#? valid geocoding block
+should.exist json.geocoding
+should.exist json.geocoding.version
+should.exist json.geocoding.attribution
+should.exist json.geocoding.query
+should.exist json.geocoding.engine
+should.exist json.geocoding.engine.name
+should.exist json.geocoding.engine.author
+should.exist json.geocoding.engine.version
+should.exist json.geocoding.timestamp
+
+#? valid geojson
+json.type.should.be.equal 'FeatureCollection'
+json.features.should.be.instanceof Array
+
+#? expected errors
+should.not.exist json.geocoding.errors
+
+#? expected warnings
+should.exist json.geocoding.warnings
+json.geocoding.warnings.should.eql [ 'out-of-range integer \'size\', using MIN_SIZE' ]
+
+#? inputs
+json.geocoding.query['text'].should.eql 'a'
+json.geocoding.query['size'].should.eql 10 # should remain the default size