Merge pull request #5 from lemonde/joins

Index joins
lemonde · Apr 8, 2014 · c282504 · c282504
2 parents f544482 + 048355e
commit c282504
Show file tree

Hide file tree

Showing 3 changed files with 220 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -149,7 +149,7 @@ function outputFormatter(document) {
 
 Type: `Object`
 
-Filters formatter that are used in `index.search`.
+Filters formatter that can be used in `index.search`.
 
 ```js
 new Index({
@@ -167,6 +167,29 @@ function formatIdFilter(value, context) {
 }
 ```
 
+#### joins
+
+Type: `Object`
+
+Joins that can be used in `index.search`.
+
+```js
+new Index({
+  joins: {
+    myJoin: {
+      index: customIndex,
+      queryTemplate: 'customQueryTemplate',
+      localField: 'local_id',
+      foreignField: 'id',
+      type: 'INNER',
+      returnFields: false,
+      returnScores: false,
+      eturnFacets: false
+    }
+  }
+});
+```
+
 ### index.create(documents, [options], callback)
 
 Insert a new document in the index.
@@ -192,7 +215,7 @@ index.create([
 ], { lang: 'FRENCH' }, function (err) { ... });
 ```
 
-## index.destroy(values, [options], callback)
+### index.destroy(values, [options], callback)
 
 Destroy a documents in the index.
 
@@ -259,6 +282,26 @@ index.search('my query', {
 }, function (err, res) { ... });
 ```
 
+#### joins
+
+Type: `Object`
+
+Joins applied to the query. Joins used the joins defined in the constructor.
+
+```js
+index.search('my query', {
+  joins: {
+    myJoin: {
+      query: 'join query',
+      template: 'myTemplate',
+      filters: {
+        myJoinFilter: 'test'
+      }
+    }
+  }
+})
+```
+
 #### OSS search options
 
 All [search options known by OSS](https://github.com/jaeksoft/opensearchserver/wiki/Search-field) can be used in the search function.

diff --git a/lib/index.js b/lib/index.js
@@ -31,6 +31,7 @@ function Index(options) {
   this.formatters = options.formatters || {};
   this.templates = options.templates || {};
   this.filters = options.filters || {};
+  this.joins = options.joins || {};
   this.lang = options.lang || 'ENGLISH';
 
   // Accept single indexer.
@@ -200,6 +201,56 @@ Index.prototype.search = function search(query, options, callback) {
     return filters;
   }, []);
 
+  // Map joins.
+  options.joins = _.map(options.joins, function (join, name) {
+
+    // Get join index options.
+    var indexJoin = index.joins[name];
+
+    // If join is not found on the index, return null.
+    if (! indexJoin) return null;
+
+    // Default template and filters.
+    join = _.defaults(join, {
+      template: 'default',
+      filters: {}
+    });
+
+    // Get template.
+    var template = indexJoin.index.templates[join.template];
+
+    // If template is not found, return null.
+    if (! template) return null;
+
+    // Build query.
+    var query = _.map(template.searchFields, function (field) {
+      return field.field + ':(' + join.query + ')^' + field.boost;
+    })
+    .join(' OR ');
+
+
+    // Build filters and append them to query.
+    query = _.map(join.filters, function (value, key) {
+      return indexJoin.index.filters[key](value);
+    })
+    .filter(function (filter) {
+      return filter.type === 'QueryFilter';
+    })
+    .map(function (filter) {
+      return filter.negative ? '-(' + filter.query + ')' : '(' + filter.query + ')';
+    })
+    .concat(['(' + query + ')'])
+    .join(' AND ');
+
+    return _.defaults({
+      queryString: query,
+      indexName: indexJoin.index.name
+    }, _.omit(indexJoin, 'index'));
+  })
+  .filter(function (join) {
+    return join;
+  });
+
   // Remove unknown keys.
   options = _.omit(options, 'template', 'filterOptions');
 

diff --git a/test/index.js b/test/index.js
@@ -239,7 +239,8 @@ describe('Index', function () {
         expect(searcher.search).to.be.calledWith('my_index', {
           lang: 'ENGLISH',
           query: 'my query',
-          filters: []
+          filters: [],
+          joins: []
         });
         done();
       });
@@ -253,7 +254,8 @@ describe('Index', function () {
           lang: 'ENGLISH',
           query: 'my query',
           foo: 'bar',
-          filters: []
+          filters: [],
+          joins: []
         });
         done();
       });
@@ -270,7 +272,8 @@ describe('Index', function () {
           query: 'my query',
           foo: 'bar',
           x: 'y',
-          filters: []
+          filters: [],
+          joins: []
         });
         done();
       });
@@ -286,7 +289,8 @@ describe('Index', function () {
           lang: 'ENGLISH',
           query: 'my query',
           z: 'x',
-          filters: []
+          filters: [],
+          joins: []
         });
         done();
       });
@@ -326,7 +330,8 @@ describe('Index', function () {
         expect(searcher.search).to.be.calledWith('my_index', {
           lang: 'ENGLISH',
           query: 'my query',
-          filters: []
+          filters: [],
+          joins: []
         });
         done();
       });
@@ -355,7 +360,8 @@ describe('Index', function () {
               negative: false,
               query: 'id:x'
             }
-          ]
+          ],
+          joins: []
         });
         done();
       });
@@ -396,7 +402,8 @@ describe('Index', function () {
               negative: false,
               query: 'id2:x'
             }
-          ]
+          ],
+          joins: []
         });
         done();
       });
@@ -415,7 +422,8 @@ describe('Index', function () {
         expect(searcher.search).to.be.calledWith('my_index', {
           lang: 'ENGLISH',
           query: 'my query',
-          filters: []
+          filters: [],
+          joins: []
         });
         done();
       });
@@ -444,10 +452,118 @@ describe('Index', function () {
               negative: false,
               query: 'id:bar'
             }
+          ],
+          joins: []
+        });
+        done();
+      });
+    });
+
+    it('should handle joins', function (done) {
+      index.filters = {
+        id: function (value) {
+          return {
+            type: 'QueryFilter',
+            negative: false,
+            query: 'id:' + value
+          };
+        }
+      };
+
+      index.joins = {
+        articles: {
+          index: new Index({
+            name: 'articles',
+            templates: {
+              searchText: {
+                returnedFields: [
+                  'id'
+                ],
+                searchFields: [
+                  {
+                    field: 'title',
+                    mode: 'TERM_AND_PHRASE',
+                    boost: 2
+                  },
+                  {
+                    field: 'text',
+                    mode: 'TERM_AND_PHRASE',
+                    boost: 1
+                  }
+                ]
+              }
+            },
+            searcher: searcher,
+            filters: {
+              sectionId: function (value) {
+                return {
+                  type: 'QueryFilter',
+                  negative: false,
+                  query: 'section_id:' + value
+                };
+              },
+              roleId: function (value) {
+                return {
+                  type: 'QueryFilter',
+                  negative: true,
+                  query: 'role_id:' + value
+                };
+              }
+            }
+          }),
+          queryTemplate: 'generic',
+          localField: 'article_id',
+          foreignField: 'id',
+          type: 'INNER',
+          returnFields: false,
+          returnScores: false,
+          returnFacets: false
+        }
+      };
+
+
+      index.search('my query', {
+        filters: { id: 210384 },
+        joins: {
+          articles: {
+            query: 'join query',
+            template: 'searchText',
+            filters: {
+              sectionId: 213,
+              roleId: 230
+            }
+          }
+        }
+      }, function (err, res) {
+        if (err) return done(err);
+        expect(res.documents).to.eql([]);
+        expect(searcher.search).to.be.calledWith('my_index', {
+          lang: 'ENGLISH',
+          query: 'my query',
+          filters: [
+            {
+              type: 'QueryFilter',
+              negative: false,
+              query: 'id:210384'
+            }
+          ],
+          joins: [
+            {
+              foreignField: 'id',
+              indexName: 'articles',
+              localField: 'article_id',
+              queryString: '(section_id:213) AND -(role_id:230) AND (title:(join query)^2 OR text:(join query)^1)',
+              queryTemplate: 'generic',
+              returnFacets: false,
+              returnFields: false,
+              returnScores: false,
+              type: 'INNER'
+            }
           ]
         });
         done();
       });
+
     });
   });
 });