feat(override): allow addendum data to override imported place data (#…

…1494)

* proof of concept for having addendums that override indexed fields

* feat(override): allow addendum data to override imported place data

* use _.has

middleware/applyOverrides.js

@@ -0,0 +1,41 @@
+const _ = require('lodash');
+const logger = require('pelias-logger').get('api');
+const codec = require('pelias-model').codec;
+
+function setup() {
+  return applyOverrides;
+}
+
+function applyOverrides(req, res, next) {
+  // do nothing if no result data set
+  if (!res || !res.data) {
+    return next();
+  }
+
+  res.data = res.data.map(overrideOneRecord);
+
+  next();
+}
+
+/*
+ * Rename the fields in one record
+ */
+function overrideOneRecord(place) {
+  if (_.has(place, 'addendum.override')) {
+    try {
+      const overrideData = codec.decode(place.addendum.override);
+      place = _.merge(place, overrideData);
+    } catch (err) {
+      logger.error('Invalid addendum override json string:', place.addendum);
+    }
+
+    delete place.addendum.override;
+
+    if (_.isEmpty(place.addendum)) {
+      delete place.addendum;
+    }
+  }
+  return place;
+}
+
+module.exports = setup;

routes/v1.js

@@ -229,6 +229,7 @@ function addRoutes(app, peliasConfig) {
       middleware.confidenceScoreFallback(),
       middleware.interpolate(interpolationService, interpolationShouldExecute, interpolationConfiguration),
       middleware.sortResponseData(sorting, predicates.hasAdminOnlyResults),
+      middleware.applyOverrides(),
       middleware.dedupe(),
       middleware.accuracy(),
       middleware.localNamingConventions(),
@@ -251,6 +252,7 @@ function addRoutes(app, peliasConfig) {
       middleware.confidenceScore(peliasConfig.api),
       middleware.confidenceScoreFallback(),
       middleware.interpolate(interpolationService, interpolationShouldExecute, interpolationConfiguration),
+      middleware.applyOverrides(),
       middleware.dedupe(),
       middleware.accuracy(),
       middleware.localNamingConventions(),
@@ -269,6 +271,7 @@ function addRoutes(app, peliasConfig) {
       controllers.search(peliasConfig, esclient, queries.autocomplete, not(hasResponseDataOrRequestErrors)),
       middleware.distance('focus.point.'),
       middleware.confidenceScore(peliasConfig.api),
+      middleware.applyOverrides(),
       middleware.dedupe(),
       middleware.accuracy(),
       middleware.localNamingConventions(),
@@ -290,6 +293,7 @@ function addRoutes(app, peliasConfig) {
       // reverse confidence scoring depends on distance from origin
       //  so it must be calculated first
       middleware.confidenceScoreReverse(),
+      middleware.applyOverrides(),
       middleware.dedupe(),
       middleware.accuracy(),
       middleware.localNamingConventions(),
@@ -310,6 +314,7 @@ function addRoutes(app, peliasConfig) {
       // reverse confidence scoring depends on distance from origin
       //  so it must be calculated first
       middleware.confidenceScoreReverse(),
+      middleware.applyOverrides(),
       middleware.dedupe(),
       middleware.accuracy(),
       middleware.localNamingConventions(),

test/unit/middleware/applyOverrides.js

@@ -0,0 +1,114 @@
+const applyOverrides = require('../../../middleware/applyOverrides')();
+const codec = require('pelias-model').codec;
+
+const proxyquire = require('proxyquire').noCallThru();
+
+module.exports.tests = {};
+
+module.exports.tests.applyOverrides = function(test, common) {
+  test('valid override data with no other addendum', function(t) {
+    const res = {
+      data: [
+        {
+            name: 'aliased name to throw out',
+            addendum: {
+                override: codec.encode({ name: 'Override Name' }),
+            }
+        }
+      ]
+    };
+
+    const expected = {
+      data: [
+        {
+          name: 'Override Name'
+        }
+      ]
+    };
+
+    applyOverrides({}, res, function () {
+      t.deepEquals(res, expected, 'valid override data');
+      t.end();
+    });
+  });
+
+  test('valid override data with other addendum data', function(t) {
+    const res = {
+      data: [
+        {
+            name: 'aliased name to throw out',
+            addendum: {
+                override: codec.encode({ name: 'Override Name' }),
+                other_data: 1234
+            }
+        }
+      ]
+    };
+
+    const expected = {
+      data: [
+        {
+          name: 'Override Name',
+          addendum: {
+              other_data: 1234
+          }
+        }
+      ]
+    };
+
+    applyOverrides({}, res, function () {
+      t.deepEquals(res, expected, 'valid override data');
+      t.end();
+    });
+  });
+
+  test('invalid override data', function(t) {
+    const res = {
+      data: [
+        {
+            name: 'aliased name to throw out',
+            addendum: {
+                override: 'garbage json'
+            }
+        }
+      ]
+    };
+
+    const expected = {
+      data: [
+        {
+          name: 'aliased name to throw out'
+        }
+      ]
+    };
+
+    const proxiedApplyOverrides = proxyquire('../../../middleware/applyOverrides', {
+        'pelias-logger': {
+          get: () => {
+            return {
+              error: (msg1, msg2) => {
+                t.equals(msg1, 'Invalid addendum override json string:');
+                t.deepEquals(msg2, { override: 'garbage json' });
+              }
+            };
+
+          }
+        }
+      })();
+
+      proxiedApplyOverrides({}, res, function () {
+      t.deepEquals(res, expected, 'invalid override data');
+      t.end();
+    });
+  });
+};
+
+module.exports.all = function (tape, common) {
+  function test(name, testFunction) {
+    return tape('[middleware] applyOverrides: ' + name, testFunction);
+  }
+
+  for( var testCase in module.exports.tests ){
+    module.exports.tests[testCase](test, common);
+  }
+};

test/unit/middleware/parseBBox.js

@@ -4,7 +4,7 @@ const proxyquire = require('proxyquire').noCallThru();
 
 module.exports.tests = {};
 
-module.exports.tests.computeDistance = function(test, common) {
+module.exports.tests.parseBBox = function(test, common) {
   test('valid bounding_box json', function(t) {
     var res = {
       data: [

test/unit/run.js

@@ -46,6 +46,7 @@ var tests = [
   require('./helper/unicode'),
   require('./middleware/access_log'),
   require('./middleware/accuracy'),
+  require('./middleware/applyOverrides'),
   require('./middleware/assignLabels'),
   require('./middleware/confidenceScore'),
   require('./middleware/confidenceScoreFallback'),