mirror of https://github.com/pelias/api.git
Lily He
8 years ago
8 changed files with 548 additions and 209 deletions
@ -0,0 +1,34 @@ |
|||||||
|
var sanitizeAll = require('../sanitizer/sanitizeAll'), |
||||||
|
sanitizers = { |
||||||
|
text: require('../sanitizer/_text_addressit')() |
||||||
|
}; |
||||||
|
|
||||||
|
var logger = require('pelias-logger').get('api'); |
||||||
|
var logging = require( '../helper/logging' ); |
||||||
|
var _ = require('lodash'); |
||||||
|
|
||||||
|
// middleware
|
||||||
|
module.exports.middleware = function( req, res, next ){ |
||||||
|
// if res.data already has results then don't call the _text_autocomplete sanitizer
|
||||||
|
// this has been put into place for when the libpostal integration way of querying
|
||||||
|
// ES doesn't return anything and we want to fallback to the old logic
|
||||||
|
if (_.get(res, 'data', []).length > 0) { |
||||||
|
return next(); |
||||||
|
} |
||||||
|
|
||||||
|
// log the query that caused a fallback since libpostal+new-queries didn't return anything
|
||||||
|
if (req.path === '/v1/search') { |
||||||
|
const queryText = logging.isDNT(req) ? '[text removed]' : req.clean.text; |
||||||
|
logger.info(`fallback queryText: ${queryText}`); |
||||||
|
} |
||||||
|
// calls to sanitize the input
|
||||||
|
// omits check if parameters are valid since it only calls _text_addressit
|
||||||
|
sanitizeAll.sanitize(req, sanitizers, ( err, clean ) => { |
||||||
|
if( err ){ |
||||||
|
res.status(400); // 400 Bad Request
|
||||||
|
return next(err); |
||||||
|
} |
||||||
|
next(); |
||||||
|
}); |
||||||
|
|
||||||
|
}; |
@ -0,0 +1,197 @@ |
|||||||
|
var proxyquire = require('proxyquire').noCallThru(); |
||||||
|
|
||||||
|
module.exports.tests = {}; |
||||||
|
|
||||||
|
module.exports.tests.sanitize = function(test, common) { |
||||||
|
test('verify that all sanitizers were called as expected when `res` is undefined', function(t) { |
||||||
|
var called_sanitizers = []; |
||||||
|
|
||||||
|
// rather than re-verify the functionality of all the sanitizers, this test just verifies that they
|
||||||
|
// were all called correctly
|
||||||
|
var search = proxyquire('../../../sanitizer/search_fallback', { |
||||||
|
'../sanitizer/_text_addressit': function () { |
||||||
|
return { |
||||||
|
sanitize: () => { |
||||||
|
called_sanitizers.push('_text_addressit'); |
||||||
|
return { errors: [], warnings: [] }; |
||||||
|
} |
||||||
|
}; |
||||||
|
} |
||||||
|
}); |
||||||
|
|
||||||
|
var expected_sanitizers = [ |
||||||
|
'_text_addressit' |
||||||
|
]; |
||||||
|
|
||||||
|
var req = {}; |
||||||
|
|
||||||
|
search.middleware(req, undefined, function(){ |
||||||
|
t.deepEquals(called_sanitizers, expected_sanitizers); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
}); |
||||||
|
|
||||||
|
test('verify that all sanitizers were called as expected when `res` has no `data` property', function(t) { |
||||||
|
var called_sanitizers = []; |
||||||
|
|
||||||
|
// rather than re-verify the functionality of all the sanitizers, this test just verifies that they
|
||||||
|
// were all called correctly
|
||||||
|
var search = proxyquire('../../../sanitizer/search_fallback', { |
||||||
|
'../sanitizer/_text_addressit': function () { |
||||||
|
return { |
||||||
|
sanitize: () => { |
||||||
|
called_sanitizers.push('_text_addressit'); |
||||||
|
return { errors: [], warnings: [] }; |
||||||
|
} |
||||||
|
}; |
||||||
|
}, |
||||||
|
}); |
||||||
|
|
||||||
|
var expected_sanitizers = [ |
||||||
|
'_text_addressit' |
||||||
|
]; |
||||||
|
|
||||||
|
var req = {}; |
||||||
|
var res = {}; |
||||||
|
|
||||||
|
search.middleware(req, res, function(){ |
||||||
|
t.deepEquals(called_sanitizers, expected_sanitizers); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
}); |
||||||
|
|
||||||
|
test('verify that all sanitizers were called as expected when res.data is empty', function(t) { |
||||||
|
var called_sanitizers = []; |
||||||
|
|
||||||
|
// rather than re-verify the functionality of all the sanitizers, this test just verifies that they
|
||||||
|
// were all called correctly
|
||||||
|
var search = proxyquire('../../../sanitizer/search_fallback', { |
||||||
|
'../sanitizer/_text_addressit': function () { |
||||||
|
return { |
||||||
|
sanitize: () => { |
||||||
|
called_sanitizers.push('_text_addressit'); |
||||||
|
return { errors: [], warnings: [] }; |
||||||
|
} |
||||||
|
}; |
||||||
|
}, |
||||||
|
}); |
||||||
|
|
||||||
|
var expected_sanitizers = [ |
||||||
|
'_text_addressit' |
||||||
|
]; |
||||||
|
|
||||||
|
var req = {}; |
||||||
|
var res = { |
||||||
|
data: [] |
||||||
|
}; |
||||||
|
|
||||||
|
search.middleware(req, res, function(){ |
||||||
|
t.deepEquals(called_sanitizers, expected_sanitizers); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
}); |
||||||
|
|
||||||
|
test('non-empty res.data should not call the _text_autocomplete sanitizer', function(t) { |
||||||
|
var called_sanitizers = []; |
||||||
|
|
||||||
|
// rather than re-verify the functionality of all the sanitizers, this test just verifies that they
|
||||||
|
// were all called correctly
|
||||||
|
var search = proxyquire('../../../sanitizer/search_fallback', { |
||||||
|
'../sanitizer/_text_autocomplete': function() { |
||||||
|
throw new Error('_text_autocomplete sanitizer should not have been called'); |
||||||
|
} |
||||||
|
}); |
||||||
|
|
||||||
|
var expected_sanitizers = []; |
||||||
|
|
||||||
|
var req = {}; |
||||||
|
var res = { |
||||||
|
data: [{}] |
||||||
|
}; |
||||||
|
|
||||||
|
search.middleware(req, res, function(){ |
||||||
|
t.deepEquals(called_sanitizers, expected_sanitizers); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
}); |
||||||
|
|
||||||
|
test('req.clean.text should be logged when isDNT=false', (t) => { |
||||||
|
const infoLog = []; |
||||||
|
|
||||||
|
const search = proxyquire('../../../sanitizer/search_fallback', { |
||||||
|
'pelias-logger': { |
||||||
|
get: () => { |
||||||
|
return { |
||||||
|
info: (msg) => { |
||||||
|
infoLog.push(msg); |
||||||
|
} |
||||||
|
}; |
||||||
|
} |
||||||
|
}, |
||||||
|
'../helper/logging': { |
||||||
|
isDNT: () => { return false; } |
||||||
|
} |
||||||
|
}); |
||||||
|
|
||||||
|
const req = { |
||||||
|
path: '/v1/search', |
||||||
|
clean: { |
||||||
|
text: 'this is the query text' |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
search.middleware(req, undefined, () => { |
||||||
|
t.deepEquals(infoLog, [`fallback queryText: ${req.clean.text}`]); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
}); |
||||||
|
|
||||||
|
test('req.clean.text should not be logged when isDNT=true', (t) => { |
||||||
|
const infoLog = []; |
||||||
|
|
||||||
|
const search = proxyquire('../../../sanitizer/search_fallback', { |
||||||
|
'pelias-logger': { |
||||||
|
get: () => { |
||||||
|
return { |
||||||
|
info: (msg) => { |
||||||
|
infoLog.push(msg); |
||||||
|
} |
||||||
|
}; |
||||||
|
} |
||||||
|
}, |
||||||
|
'../helper/logging': { |
||||||
|
isDNT: () => { return true; } |
||||||
|
} |
||||||
|
}); |
||||||
|
|
||||||
|
const req = { |
||||||
|
path: '/v1/search', |
||||||
|
clean: { |
||||||
|
text: 'this is the query text' |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
search.middleware(req, undefined, () => { |
||||||
|
t.deepEquals(infoLog, ['fallback queryText: [text removed]']); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
|
||||||
|
}); |
||||||
|
|
||||||
|
}; |
||||||
|
|
||||||
|
module.exports.all = function (tape, common) { |
||||||
|
|
||||||
|
function test(name, testFunction) { |
||||||
|
return tape('SANITIZE /search_fallback ' + name, testFunction); |
||||||
|
} |
||||||
|
|
||||||
|
for( var testCase in module.exports.tests ){ |
||||||
|
module.exports.tests[testCase](test, common); |
||||||
|
} |
||||||
|
}; |
Loading…
Reference in new issue