From f86ee4a40f2202550f27e808c2d96cbeb93acbed Mon Sep 17 00:00:00 2001 From: Adam Rousell Date: Wed, 16 Aug 2017 14:35:29 +0200 Subject: [PATCH 1/2] Added postalcode rules for node-postal call and fallbacks --- middleware/confidenceScoreFallback.js | 20 ++++++++++++++------ middleware/trimByGranularityStructured.js | 2 ++ query/search.js | 16 +++++++++++++++- 3 files changed, 31 insertions(+), 7 deletions(-) diff --git a/middleware/confidenceScoreFallback.js b/middleware/confidenceScoreFallback.js index 472dd841..488bd721 100644 --- a/middleware/confidenceScoreFallback.js +++ b/middleware/confidenceScoreFallback.js @@ -76,6 +76,8 @@ function checkFallbackLevel(req, hit) { return 0.8; case 'street': return 0.8; + case 'postalcode': + return 0.8; case 'localadmin': case 'locality': case 'borough': @@ -137,38 +139,44 @@ const fallbackRules = [ expectedLayers: ['street'] }, { - name: 'neighbourhood', + name: 'postalcode', notSet: ['query', 'number', 'street'], + set: ['postalcode'], + expectedLayers: ['postalcode'] + }, + { + name: 'neighbourhood', + notSet: ['query', 'number', 'street', 'postalcode'], set: ['neighbourhood'], expectedLayers: ['neighbourhood'] }, { name: 'borough', - notSet: ['query', 'number', 'street', 'neighbourhood'], + notSet: ['query', 'number', 'street', 'postalcode', 'neighbourhood'], set: ['borough'], expectedLayers: ['borough'] }, { name: 'city', - notSet: ['query', 'number', 'street', 'neighbourhood', 'borough'], + notSet: ['query', 'number', 'street', 'postalcode', 'neighbourhood', 'borough'], set: ['city'], expectedLayers: ['borough', 'locality', 'localadmin'] }, { name: 'county', - notSet: ['query', 'number', 'street', 'neighbourhood', 'borough', 'city'], + notSet: ['query', 'number', 'street', 'postalcode', 'neighbourhood', 'borough', 'city'], set: ['county'], expectedLayers: ['county'] }, { name: 'state', - notSet: ['query', 'number', 'street', 'neighbourhood', 'borough', 'city', 'county'], + notSet: ['query', 'number', 'street', 'postalcode', 'neighbourhood', 'borough', 'city', 'county'], set: ['state'], expectedLayers: ['region'] }, { name: 'country', - notSet: ['query', 'number', 'street', 'neighbourhood', 'borough', 'city', 'county', 'state'], + notSet: ['query', 'number', 'street', 'postalcode', 'neighbourhood', 'borough', 'city', 'county', 'state'], set: ['country'], expectedLayers: ['country'] } diff --git a/middleware/trimByGranularityStructured.js b/middleware/trimByGranularityStructured.js index 1fe94ce8..5bf4685b 100644 --- a/middleware/trimByGranularityStructured.js +++ b/middleware/trimByGranularityStructured.js @@ -24,6 +24,7 @@ const layers = [ 'venue', 'address', 'street', + 'postalcode', 'neighbourhood', ['borough', 'locality'], 'localadmin', @@ -46,6 +47,7 @@ const explicit_borough_layers = [ 'venue', 'address', 'street', + 'postalcode', 'neighbourhood', 'borough', 'locality', diff --git a/query/search.js b/query/search.js index ce3ac639..991e239c 100644 --- a/query/search.js +++ b/query/search.js @@ -135,7 +135,7 @@ function getQuery(vs) { logger.info(`[query:search] [search_input_type:${determineQueryType(vs)}]`); - if (hasStreet(vs) || isPostalCodeOnly(vs)) { + if (hasStreet(vs) || isPostalCodeOnly(vs) || isPostalCodeWithCountry(vs)) { return { type: 'fallback', body: fallbackQuery.render(vs) @@ -182,4 +182,18 @@ function isPostalCodeOnly(vs) { } + +function isPostalCodeWithCountry(vs) { + var isSet = (layer) => { + return vs.isset(`input:${layer}`); + }; + + var allowedFields = ['postcode', 'country']; + var disallowedFields = ['query', 'category', 'housenumber', 'street', 'locality', + 'neighbourhood', 'borough', 'county', 'region']; + + return allowedFields.every(isSet) && + !disallowedFields.some(isSet); +} + module.exports = generateQuery; From 8d7c01dcbe9182d62da579b1d8f744984ecc8084 Mon Sep 17 00:00:00 2001 From: Adam Rousell Date: Tue, 12 Sep 2017 09:24:57 +0200 Subject: [PATCH 2/2] Added tests for postcode fix --- .../middleware/confidenceScoreFallback.js | 51 +++++++++++++++++++ .../middleware/trimByGranularityStructured.js | 46 +++++++++++++++++ 2 files changed, 97 insertions(+) diff --git a/test/unit/middleware/confidenceScoreFallback.js b/test/unit/middleware/confidenceScoreFallback.js index 3e783de7..7bca1c33 100644 --- a/test/unit/middleware/confidenceScoreFallback.js +++ b/test/unit/middleware/confidenceScoreFallback.js @@ -442,6 +442,57 @@ module.exports.tests.confidenceScore = function(test, common) { t.equal(res.data[0].match_type, 'fallback', 'fallback match indicated'); t.end(); }); + + test('address fallback to postal code should have a score set to 0.8', function(t) { + var req = { + clean: { + text: '123 Main St, City, NM, USA, 1234', + parsed_text: { + number: 123, + street: 'Main St', + state: 'NM', + country: 'USA', + postalcode: '1234' + } + } + }; + var res = { + data: [{ + layer: 'postalcode' + }], + meta: { + query_type: 'fallback' + } + }; + confidenceScore(req, res, function() {}); + t.equal(res.data[0].confidence, 0.8, 'score was set'); + t.equal(res.data[0].match_type, 'fallback', 'fallback match indicated'); + t.end(); + }); + + test('matching address search with postalcode and country should have an exact match with score of 1.0', function(t) { + var req = { + clean: { + text: 'USA, 1234', + parsed_text: { + country: 'USA', + postalcode: '1234' + } + } + }; + var res = { + data: [{ + layer: 'postalcode' + }], + meta: { + query_type: 'fallback' + } + }; + confidenceScore(req, res, function() {}); + t.equal(res.data[0].confidence, 1, 'score was set'); + t.equal(res.data[0].match_type, 'exact', 'exact match indicated'); + t.end(); + }); }; diff --git a/test/unit/middleware/trimByGranularityStructured.js b/test/unit/middleware/trimByGranularityStructured.js index 8e5fe498..17025a57 100644 --- a/test/unit/middleware/trimByGranularityStructured.js +++ b/test/unit/middleware/trimByGranularityStructured.js @@ -21,6 +21,7 @@ module.exports.tests.trimByGranularity = function(test, common) { { name: 'venue 2', _matched_queries: ['fallback.venue'] }, { name: 'address 1', _matched_queries: ['fallback.address'] }, { name: 'street 1', _matched_queries: ['fallback.street'] }, + { name: 'postalcode 1', _matched_queries: ['fallback.postalcode'] }, { name: 'neighbourhood 1', _matched_queries: ['fallback.neighbourhood'] }, { name: 'borough 1', _matched_queries: ['fallback.borough'] }, { name: 'locality 1', _matched_queries: ['fallback.locality'] }, @@ -58,6 +59,7 @@ module.exports.tests.trimByGranularity = function(test, common) { { name: 'address 1', _matched_queries: ['fallback.address'] }, { name: 'address 2', _matched_queries: ['fallback.address'] }, { name: 'street 1', _matched_queries: ['fallback.street'] }, + { name: 'postalcode 1', _matched_queries: ['fallback.postalcode'] }, { name: 'neighbourhood 1', _matched_queries: ['fallback.neighbourhood'] }, { name: 'borough 1', _matched_queries: ['fallback.borough'] }, { name: 'locality 1', _matched_queries: ['fallback.locality'] }, @@ -94,6 +96,7 @@ module.exports.tests.trimByGranularity = function(test, common) { data: [ { name: 'street 1', _matched_queries: ['fallback.street'] }, { name: 'street 2', _matched_queries: ['fallback.street'] }, + { name: 'postalcode 1', _matched_queries: ['fallback.postalcode'] }, { name: 'neighbourhood 1', _matched_queries: ['fallback.neighbourhood'] }, { name: 'borough 1', _matched_queries: ['fallback.borough'] }, { name: 'locality 1', _matched_queries: ['fallback.locality'] }, @@ -122,6 +125,49 @@ module.exports.tests.trimByGranularity = function(test, common) { testIt(); }); + + test('all records with fallback.* matched_queries name should retain only postalcodes when they are most granular', function(t) { + var req = { + clean: { + parsed_text: { + borough: 'borough value' + } + } + }; + + var res = { + data: [ + { name: 'postalcode 1', _matched_queries: ['fallback.postalcode'] }, + { name: 'postalcode 2', _matched_queries: ['fallback.postalcode'] }, + { name: 'neighbourhood 1', _matched_queries: ['fallback.neighbourhood'] }, + { name: 'borough 1', _matched_queries: ['fallback.borough'] }, + { name: 'borough 2', _matched_queries: ['fallback.borough'] }, + { name: 'locality 1', _matched_queries: ['fallback.locality'] }, + { name: 'localadmin 1', _matched_queries: ['fallback.localadmin'] }, + { name: 'county 1', _matched_queries: ['fallback.county'] }, + { name: 'macrocounty 1', _matched_queries: ['fallback.macrocounty'] }, + { name: 'region 1', _matched_queries: ['fallback.region'] }, + { name: 'macroregion 1', _matched_queries: ['fallback.macroregion'] }, + { name: 'dependency 1', _matched_queries: ['fallback.dependency'] }, + { name: 'country 1', _matched_queries: ['fallback.country'] }, + { name: 'unknown', _matched_queries: ['fallback.unknown'] } + ] + }; + + var expected_data = [ + { name: 'postalcode 1', _matched_queries: ['fallback.postalcode'] }, + { name: 'postalcode 2', _matched_queries: ['fallback.postalcode'] }, + ]; + + function testIt() { + trimByGranularity(req, res, function() { + t.deepEquals(res.data, expected_data, 'only postalcode records should be here'); + t.end(); + }); + } + + testIt(); + }); test('all records with fallback.* matched_queries name should retain only neighbourhoods when they are most granular', function(t) { var req = { clean: {} };