Scc 4346/non roman 2

lib/elasticsearch/config.js

@@ -74,20 +74,20 @@ const SEARCH_SCOPES = {
 }
 
 const FILTER_CONFIG = {
-  recordType: { operator: 'match', field: 'recordTypeId', repeatable: true },
-  owner: { operator: 'match', field: 'items.owner_packed', repeatable: true, path: 'items' },
-  subjectLiteral: { operator: 'match', field: 'subjectLiteral_exploded', repeatable: true },
-  holdingLocation: { operator: 'match', field: 'items.holdingLocation_packed', repeatable: true, path: 'items' },
-  buildingLocation: { operator: 'match', field: 'buildingLocationIds', repeatable: true },
-  language: { operator: 'match', field: 'language_packed', repeatable: true },
-  materialType: { operator: 'match', field: 'materialType_packed', repeatable: true },
-  mediaType: { operator: 'match', field: 'mediaType_packed', repeatable: true },
-  carrierType: { operator: 'match', field: 'carrierType_packed', repeatable: true },
-  publisher: { operator: 'match', field: 'publisherLiteral.raw', repeatable: true },
-  contributorLiteral: { operator: 'match', field: 'contributorLiteral.raw', repeatable: true },
-  creatorLiteral: { operator: 'match', field: 'creatorLiteral.raw', repeatable: true },
-  issuance: { operator: 'match', field: 'issuance_packed', repeatable: true },
-  createdYear: { operator: 'match', field: 'createdYear', repeatable: true },
+  recordType: { operator: 'match', field: ['recordTypeId'], repeatable: true },
+  owner: { operator: 'match', field: ['items.owner_packed'], repeatable: true, path: 'items' },
+  subjectLiteral: { operator: 'match', field: ['subjectLiteral_exploded'], repeatable: true },
+  holdingLocation: { operator: 'match', field: ['items.holdingLocation_packed'], repeatable: true, path: 'items' },
+  buildingLocation: { operator: 'match', field: ['buildingLocationIds'], repeatable: true },
+  language: { operator: 'match', field: ['language_packed'], repeatable: true },
+  materialType: { operator: 'match', field: ['materialType_packed'], repeatable: true },
+  mediaType: { operator: 'match', field: ['mediaType_packed'], repeatable: true },
+  carrierType: { operator: 'match', field: ['carrierType_packed'], repeatable: true },
+  publisher: { operator: 'match', field: ['publisherLiteral.raw'], repeatable: true },
+  contributorLiteral: { operator: 'match', field: ['contributorLiteral.raw'], repeatable: true },
+  creatorLiteral: { operator: 'match', field: ['creatorLiteral.raw'], repeatable: true },
+  issuance: { operator: 'match', field: ['issuance_packed'], repeatable: true },
+  createdYear: { operator: 'match', field: ['createdYear'], repeatable: true },
   dateAfter: {
     operator: 'custom',
     type: 'int'

lib/elasticsearch/elastic-query-builder.js

@@ -488,6 +488,57 @@ class ElasticQueryBuilder {
     }
   }
 
+  buildPackedFieldClause (value, field) {
+    // Figure out the base property (e.g. 'owner')
+    const baseField = field.replace(/_packed$/, '')
+    // Allow supplied val to match against either id or value:
+    return {
+      bool: {
+        should: [
+          { term: { [`${baseField}.id`]: value } },
+          { term: { [`${baseField}.label`]: value } }
+        ]
+      }
+    }
+  }
+
+  buildMultiFieldClause (value, fields) {
+    return {
+      bool:
+        { should: fields.map(field => ({ term: { [field]: value } })) }
+    }
+  }
+
+  // This builds a filter cause from the value:
+  buildClause (value, field) {
+    const filterMatchesOnMoreThanOneField = field.length > 1
+    if (filterMatchesOnMoreThanOneField) {
+      return this.buildMultiFieldClause(value, field)
+    }
+    field = field[0]
+    const valueIsNotPackedValue = value.indexOf('||') < 0
+    const isPackedField = field.match(/_packed$/)
+    if (isPackedField && valueIsNotPackedValue) {
+      return this.buildPackedFieldClause(value, field)
+    } else return { term: { [field]: value } }
+  }
+
+  buildSimpleMatchFilters (simpleMatchFilters) {
+    return simpleMatchFilters.map((prop) => {
+      const config = FILTER_CONFIG[prop]
+      let value = this.request.params.filters[prop]
+
+      // If multiple values given, let's join them with 'should', causing it to operate as a boolean OR
+      // Note: using 'must' here makes it a boolean AND
+      const booleanOperator = 'should'
+
+      if (Array.isArray(value) && value.length === 1) value = value.shift()
+      const clause = (Array.isArray(value)) ? { bool: { [booleanOperator]: value.map((value) => this.buildClause(config.field, value)) } } : this.buildClause(config.field, value)
+
+      return { path: config.path, clause }
+    })
+  }
+
   /**
   * Examine request for user-filters. When found, add them to query.
   */
@@ -505,38 +556,7 @@ class ElasticQueryBuilder {
     const simpleMatchFilters = Object.keys(this.request.params.filters)
       .filter((k) => FILTER_CONFIG[k].operator === 'match')
 
-    filterClausesWithPaths = filterClausesWithPaths.concat(simpleMatchFilters.map((prop) => {
-      const config = FILTER_CONFIG[prop]
-
-      let value = this.request.params.filters[prop]
-
-      // This builds a filter cause from the value:
-      const buildClause = (value) => {
-        // If filtering on a packed field and value isn't a packed value:
-        if (config.operator === 'match' && value.indexOf('||') < 0 && config.field.match(/_packed$/)) {
-          // Figure out the base property (e.g. 'owner')
-          const baseField = config.field.replace(/_packed$/, '')
-          // Allow supplied val to match against either id or value:
-          return {
-            bool: {
-              should: [
-                { term: { [`${baseField}.id`]: value } },
-                { term: { [`${baseField}.label`]: value } }
-              ]
-            }
-          }
-        } else if (config.operator === 'match') return { term: { [config.field]: value } }
-      }
-
-      // If multiple values given, let's join them with 'should', causing it to operate as a boolean OR
-      // Note: using 'must' here makes it a boolean AND
-      const booleanOperator = 'should'
-      // If only one value given, don't wrap it in a useless bool:
-      if (Array.isArray(value) && value.length === 1) value = value.shift()
-      const clause = (Array.isArray(value)) ? { bool: { [booleanOperator]: value.map(buildClause) } } : buildClause(value)
-
-      return { path: config.path, clause }
-    }))
+    filterClausesWithPaths = filterClausesWithPaths.concat(this.buildSimpleMatchFilters(simpleMatchFilters))
 
     // Gather root (not nested) filters:
     let filterClauses = filterClausesWithPaths

test/elastic-query-builder.test.js

@@ -4,6 +4,123 @@ const ElasticQueryBuilder = require('../lib/elasticsearch/elastic-query-builder'
 const ApiRequest = require('../lib/api-request')
 
 describe('ElasticQueryBuilder', () => {
+  describe('buildClause', () => {
+    it('can handle multiple fields', () => {
+      expect(ElasticQueryBuilder.prototype.buildClause('value', ['field', 'parallelField']))
+        .to.deep.equal({
+          bool:
+          {
+            should: [
+              { term: { field: 'value' } },
+              { term: { parallelField: 'value' } }]
+          }
+        })
+    })
+    it('can handle packed fields', () => {
+      expect(ElasticQueryBuilder.prototype.buildClause('not packed value', ['field_packed']))
+        .to.deep.equal({
+          bool: {
+            should: [
+              { term: { 'field.id': 'not packed value' } },
+              { term: { 'field.label': 'not packed value' } }
+            ]
+          }
+        })
+    })
+    it('can handle the simple case', () => {
+      expect(ElasticQueryBuilder.prototype.buildClause('value', ['field']))
+        .to.deep.equal({ term: { field: 'value' } })
+    })
+  })
+  describe('buildSimpleMatchFilters', () => {
+    const mockQueryBuilderFactory = (request) => ({
+      request,
+      buildMultiFieldClause: ElasticQueryBuilder.prototype.buildMultiFieldClause,
+      buildSimpleMatchFilters: ElasticQueryBuilder.prototype.buildSimpleMatchFilters,
+      buildClause: ElasticQueryBuilder.prototype.buildClause,
+      buildPackedFieldClause: ElasticQueryBuilder.prototype.buildPackedFieldClause
+    })
+    it('can handle (multiple) single value, single match field filters, as arrays', () => {
+      const request = new ApiRequest({ filters: { buildingLocation: ['toast'], subjectLiteral: ['spaghetti'] } })
+      const mockQueryBuilder = mockQueryBuilderFactory(request)
+      const simpleMatchFilters = mockQueryBuilder.buildSimpleMatchFilters(['buildingLocation', 'subjectLiteral'])
+      expect(simpleMatchFilters).to.deep.equal([
+        {
+          path: undefined,
+          clause: { term: { buildingLocationIds: 'toast' } }
+        },
+        {
+          path: undefined,
+          clause: { term: { subjectLiteral_exploded: 'spaghetti' } }
+        }
+      ])
+    })
+    it('can handle (multiple) single value, single match field filters, strings', () => {
+      const request = new ApiRequest({ filters: { buildingLocation: 'toast', subjectLiteral: 'spaghetti' } })
+      const mockQueryBuilder = mockQueryBuilderFactory(request)
+      const simpleMatchFilters = mockQueryBuilder.buildSimpleMatchFilters(['buildingLocation', 'subjectLiteral'])
+      expect(simpleMatchFilters).to.deep.equal([
+        {
+          path: undefined,
+          clause: { term: { buildingLocationIds: 'toast' } }
+        },
+        {
+          path: undefined,
+          clause: { term: { subjectLiteral_exploded: 'spaghetti' } }
+        }
+      ])
+    })
+    it('can handle multiple values', () => {
+      const request = new ApiRequest({ filters: { subjectLiteral: ['spaghetti', 'meatballs'] } })
+      const mockQueryBuilder = mockQueryBuilderFactory(request)
+      const simpleMatchFilters = mockQueryBuilder.buildSimpleMatchFilters(['subjectLiteral'])
+      expect(simpleMatchFilters).to.deep.equal([
+        {
+          path: undefined,
+          clause: {
+            bool: {
+              should: [
+                { term: { subjectLiteral_exploded: 'spaghetti' } },
+                { term: { subjectLiteral_exploded: 'meatballs' } }
+              ]
+            }
+          }
+        }
+      ])
+    })
+    it('can handle packed values', () => {
+      const request = new ApiRequest({ filters: { language: ['spanish', 'finnish'] } })
+      const mockQueryBuilder = mockQueryBuilderFactory(request)
+      const simpleMatchFilters = mockQueryBuilder.buildSimpleMatchFilters(['language'])
+      expect(simpleMatchFilters).to.deep.equal([
+        {
+          path: undefined,
+          clause: {
+            bool: {
+              should: [
+                {
+                  bool: {
+                    should: [
+                      { term: { 'language.id': 'spanish' } },
+                      { term: { 'language.label': 'spanish' } }
+                    ]
+                  }
+                },
+                {
+                  bool: {
+                    should: [
+                      { term: { 'language.id': 'finnish' } },
+                      { term: { 'language.label': 'finnish' } }
+                    ]
+                  }
+                }
+              ]
+            }
+          }
+        }
+      ])
+    })
+  })
   describe('search_scope all', () => {
     it('generates an "all" query', () => {
       const request = new ApiRequest({ q: 'toast' })