change query module interfaces to allow for additional meta data

controller/search.js

@@ -10,6 +10,11 @@ function setup( config, backend, query ){
   backend = backend || require('../src/backend');
   query = query || require('../query/search');
 
+  // verify that we don't let an old style query object slip through the cracks here
+  if (typeof query !== 'object' || !query.hasOwnProperty('query_type')) {
+    throw new Error('Search queries must return an object with query and query_type');
+  }
+
   function controller( req, res, next ){
     // do not run controller when a request
     // validation error has occurred.
@@ -31,7 +36,7 @@ function setup( config, backend, query ){
     // log clean parameters for stats
     logger.info('[req]', 'endpoint=' + req.path, cleanOutput);
 
-    var query_body = query(req.clean);
+    var query_body = query.query(req.clean);
 
     // if there's no query to call ES with, skip the service
     if (_.isUndefined(query_body)) {
@@ -61,7 +66,9 @@ function setup( config, backend, query ){
       // set response data
       else {
         res.data = docs;
-        res.meta = meta;
+        res.meta = meta || {};
+        // store the query_type for subsequent middleware
+        res.meta.query_type = query.query_type;
       }
       logger.debug('[ES response]', docs);
       next();

query/autocomplete.js

@@ -117,4 +117,7 @@ function generateQuery( clean ){
   return query.render( vs );
 }
 
-module.exports = generateQuery;
+module.exports = {
+  query: generateQuery,
+  query_type: 'autocomplete'
+};

query/reverse.js

@@ -74,4 +74,7 @@ function generateQuery( clean ){
   return query.render( vs );
 }
 
-module.exports = generateQuery;
+module.exports = {
+  query: generateQuery,
+  query_type: 'reverse'
+};

query/search.js

@@ -134,4 +134,8 @@ function hasStreet(vs) {
   return vs.isset('input:street');
 }
 
-module.exports = generateQuery;
+module.exports = {
+  query: generateQuery,
+  // this could later be set to disambiguation when appropriate
+  query_type: 'fallback'
+};

query/search_original.js

@@ -128,4 +128,8 @@ function generateQuery( clean ){
   return query.render( vs );
 }
 
-module.exports = generateQuery;
+
+module.exports = {
+  query: generateQuery,
+  query_type: 'original'
+};

test/unit/mock/search_query.js

@@ -1,10 +1,8 @@
-
-function setup(){
-  return query;
-}
-
 function query( clean ){
   return clean;
 }
 
-module.exports = setup;
+module.exports = {
+  query: query,
+  query_type: 'mock'
+};

test/unit/query/autocomplete.js

@@ -1,11 +1,24 @@
-
+var query = require('../../../query/autocomplete');
-var generate = require('../../../query/autocomplete');
+var generate = query.query;
 
 module.exports.tests = {};
 
 module.exports.tests.interface = function(test, common) {
   test('valid interface', function(t) {
-    t.equal(typeof generate, 'function', 'valid function');
+    t.equal(typeof query, 'object', 'valid query object');
+    t.end();
+  });
+  test('valid interface', function(t) {
+    t.true(query.hasOwnProperty('query'), 'query is valid function');
+    t.true(query.hasOwnProperty('query_type'), 'query is valid function');
+    t.end();
+  });
+  test('valid interface', function(t) {
+    t.equal(typeof query.query, 'function', 'valid function');
+    t.end();
+  });
+  test('valid interface', function(t) {
+    t.equal(typeof query.query_type, 'string', 'valid query_type');
     t.end();
   });
 };

test/unit/query/reverse.js

@@ -1,10 +1,24 @@
-var generate = require('../../../query/reverse');
+var query = require('../../../query/reverse');
+var generate = query.query;
 
 module.exports.tests = {};
 
 module.exports.tests.interface = function(test, common) {
   test('valid interface', function(t) {
-    t.equal(typeof generate, 'function', 'valid function');
+    t.equal(typeof query, 'object', 'valid query object');
+    t.end();
+  });
+  test('valid interface', function(t) {
+    t.true(query.hasOwnProperty('query'), 'query is valid function');
+    t.true(query.hasOwnProperty('query_type'), 'query is valid function');
+    t.end();
+  });
+  test('valid interface', function(t) {
+    t.equal(typeof query.query, 'function', 'valid function');
+    t.end();
+  });
+  test('valid interface', function(t) {
+    t.equal(typeof query.query_type, 'string', 'valid query_type');
     t.end();
   });
 };

test/unit/query/search.js

@@ -1,11 +1,25 @@
-var generate = require('../../../query/search');
+var query = require('../../../query/search');
+var generate = query.query;
 var fs = require('fs');
 
 module.exports.tests = {};
 
 module.exports.tests.interface = function(test, common) {
   test('valid interface', function(t) {
-    t.equal(typeof generate, 'function', 'valid function');
+    t.equal(typeof query, 'object', 'valid query object');
+    t.end();
+  });
+  test('valid interface', function(t) {
+    t.true(query.hasOwnProperty('query'), 'query is valid function');
+    t.true(query.hasOwnProperty('query_type'), 'query is valid function');
+    t.end();
+  });
+  test('valid interface', function(t) {
+    t.equal(typeof query.query, 'function', 'valid function');
+    t.end();
+  });
+  test('valid interface', function(t) {
+    t.equal(typeof query.query_type, 'string', 'valid query_type');
     t.end();
   });
 };

test/unit/query/search_original.js

@@ -1,10 +1,24 @@
-var generate = require('../../../query/search_original');
+var query = require('../../../query/search_original');
+var generate = query.query;
 
 module.exports.tests = {};
 
 module.exports.tests.interface = function(test, common) {
   test('valid interface', function(t) {
-    t.equal(typeof generate, 'function', 'valid function');
+    t.equal(typeof query, 'object', 'valid query object');
+    t.end();
+  });
+  test('valid interface', function(t) {
+    t.true(query.hasOwnProperty('query'), 'query is valid function');
+    t.true(query.hasOwnProperty('query_type'), 'query is valid function');
+    t.end();
+  });
+  test('valid interface', function(t) {
+    t.equal(typeof query.query, 'function', 'valid function');
+    t.end();
+  });
+  test('valid interface', function(t) {
+    t.equal(typeof query.query_type, 'string', 'valid query_type');
     t.end();
   });
 };