pelias-schema 10.1.0 → 10.1.1

package/configValidation.js

@@ -3,15 +3,15 @@ const Joi = require('@hapi/joi');
 // Schema Configuration
 // schema.indexName: populated by defaults if not overridden
 // schema.icuTokenizer: boolean, optional, defaults to false
-// schema.unstoredFields: array of field paths to index but omit from _source, optional
-// schema.excludedFields: array of field paths to remove from the mapping, optional
+// schema.sourceExcludedFields: array of field paths to index but omit from _source, optional
+// schema.unmappedFields: array of field paths to remove from the mapping, optional
 // esclient: object, validation performed by elasticsearch module
 const schema = Joi.object().required().keys({
   schema: Joi.object().required().keys({
     indexName: Joi.string().required(),
     icuTokenizer: Joi.boolean().optional(),
-    unstoredFields: Joi.array().items(Joi.string()).optional(),
-    excludedFields: Joi.array().items(Joi.string()).optional()
+    sourceExcludedFields: Joi.array().items(Joi.string()).optional(),
+    unmappedFields: Joi.array().items(Joi.string()).optional()
   }),
   esclient: Joi.object().required()
 }).unknown(true);

package/mappings/configureFields.js

@@ -6,21 +6,21 @@ const mappingPath = (field) => _.flatMap(field.split('.'), (part) => ['propertie
 /**
  * apply field configuration from `schema` section of pelias config to a mapping
  *
- * unstoredFields: fields that are indexed but omitted from _source
- * excludedFields: fields removed from the mapping entirely
+ * sourceExcludedFields: fields that are indexed but omitted from _source
+ * unmappedFields: fields removed from the mapping entirely
  */
 function configureFields(mapping, schemaConfig) {
-  const unstored = _.get(schemaConfig, 'unstoredFields', []);
-  const excluded = _.get(schemaConfig, 'excludedFields', []);
+  const sourceExcluded = _.get(schemaConfig, 'sourceExcludedFields', []);
+  const unmapped = _.get(schemaConfig, 'unmappedFields', []);
 
   const configured = _.cloneDeep(mapping);
 
-  if (!_.isEmpty(unstored)) {
+  if (!_.isEmpty(sourceExcluded)) {
     const excludes = _.get(configured, '_source.excludes', []);
-    _.set(configured, '_source.excludes', _.union(excludes, unstored));
+    _.set(configured, '_source.excludes', _.union(excludes, sourceExcluded));
   }
 
-  excluded.forEach((field) => _.unset(configured, mappingPath(field)));
+  unmapped.forEach((field) => _.unset(configured, mappingPath(field)));
 
   return configured;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pelias-schema",
-  "version": "10.1.0",
+  "version": "10.1.1",
   "author": "pelias",
   "description": "Elasticsearch schema files and tooling for Pelias",
   "homepage": "https://github.com/pelias/schema",

package/test/configValidation.js

@@ -84,12 +84,12 @@ module.exports.tests.interface = function(test, common) {
 
   });
 
-  test('config with array of strings for unstoredFields and excludedFields should not throw error', function(t) {
+  test('config with array of strings for sourceExcludedFields and unmappedFields should not throw error', function(t) {
     var config = {
       schema: {
         indexName: 'example_index',
-        unstoredFields: ['addendum', 'parent.county_a'],
-        excludedFields: ['popularity']
+        sourceExcludedFields: ['addendum', 'parent.county_a'],
+        unmappedFields: ['popularity']
       },
       esclient: {}
     };
@@ -101,8 +101,8 @@ module.exports.tests.interface = function(test, common) {
     t.end();
   });
 
-  test('config with non-array unstoredFields or excludedFields should throw error', function(t) {
-    ['unstoredFields', 'excludedFields'].forEach((key) => {
+  test('config with non-array sourceExcludedFields or unmappedFields should throw error', function(t) {
+    ['sourceExcludedFields', 'unmappedFields'].forEach((key) => {
       [null, 17, 'addendum', {}, true, [17]].forEach((value) => {
         var config = {
           schema: {

package/test/configureFields.js

@@ -3,24 +3,24 @@ const document = require('../mappings/document');
 
 module.exports.tests = {};
 
-module.exports.tests.unstored = function(test, common) {
+module.exports.tests.sourceExcluded = function(test, common) {
   test('no config leaves mapping unchanged', function(t) {
     t.deepEqual(configureFields(document, undefined), document);
     t.deepEqual(configureFields(document, {}), document);
     t.end();
   });
 
-  test('unstored fields are appended to _source excludes', function(t) {
-    const mapping = configureFields(document, { unstoredFields: ['addendum', 'parent.*_a', 'shape'] });
+  test('sourceExcluded fields are appended to _source excludes', function(t) {
+    const mapping = configureFields(document, { sourceExcludedFields: ['addendum', 'parent.*_a', 'shape'] });
     t.deepEqual(mapping._source.excludes, ['shape', 'phrase', 'addendum', 'parent.*_a']);
     t.deepEqual(mapping.properties, document.properties, 'properties unchanged');
     t.end();
   });
 };
 
-module.exports.tests.excluded = function(test, common) {
-  test('excluded fields are removed from mapping', function(t) {
-    const mapping = configureFields(document, { excludedFields: ['popularity', 'parent.county_a', 'not_a_field'] });
+module.exports.tests.unmapped = function(test, common) {
+  test('unmapped fields are removed from mapping', function(t) {
+    const mapping = configureFields(document, { unmappedFields: ['popularity', 'parent.county_a', 'not_a_field'] });
     t.false(mapping.properties.popularity, 'top level field removed');
     t.false(mapping.properties.parent.properties.county_a, 'nested field removed');
     t.true(mapping.properties.parent.properties.county, 'sibling field kept');
@@ -29,7 +29,7 @@ module.exports.tests.excluded = function(test, common) {
   });
 
   test('original mapping is not modified', function(t) {
-    configureFields(document, { unstoredFields: ['addendum'], excludedFields: ['popularity', 'parent.county_a'] });
+    configureFields(document, { sourceExcludedFields: ['addendum'], unmappedFields: ['popularity', 'parent.county_a'] });
     t.deepEqual(document._source.excludes, ['shape', 'phrase']);
     t.true(document.properties.popularity);
     t.true(document.properties.parent.properties.county_a);