feat: expose utils to parse filters (#683)

Author: ghusse

src/index.js

@@ -23,8 +23,10 @@ const PieStatGetter = require('./services/pie-stat-getter');
 const LineStatGetter = require('./services/line-stat-getter');
 const LeaderboardStatGetter = require('./services/leaderboard-stat-getter');
 const QueryStatGetter = require('./services/query-stat-getter');
+const FiltersParser = require('./services/filters-parser');
 
 const RecordsDecorator = require('./utils/records-decorator');
+const makeParseFilter = require('./public/parse-filter');
 
 const REGEX_VERSION = /(\d+\.)?(\d+\.)?(\*|\d+)/;
 
@@ -47,6 +49,8 @@ exports.RecordCreator = Interface.RecordCreator;
 exports.RecordRemover = Interface.RecordRemover;
 exports.RecordsRemover = Interface.RecordsRemover;
 exports.RecordSerializer = Interface.RecordSerializer;
+exports.BaseOperatorDateParser = Interface.BaseOperatorDateParser;
+exports.parseFilter = makeParseFilter(FiltersParser, exports);
 
 exports.PUBLIC_ROUTES = Interface.PUBLIC_ROUTES;
 

src/public/parse-filter.js

@@ -0,0 +1,17 @@
+function makeParseFilter(FiltersParser, publicExports) {
+  /**
+   * @param {*} filter
+   * @param {*} modelSchema
+   * @param {string} timezone
+   * @returns {Promise<any>} Sequelize condition
+   */
+  return function parseFilter(filter, modelSchema, timezone) {
+    if (!publicExports.opts) throw new Error('Liana must be initialized before using parseFilter');
+
+    const parser = new FiltersParser(modelSchema, timezone, publicExports.opts);
+
+    return parser.perform(JSON.stringify(filter));
+  };
+}
+
+module.exports = makeParseFilter;

test/public/parse-filter.test.js

@@ -0,0 +1,43 @@
+const makeParseFilter = require('../../src/public/parse-filter');
+
+describe('parseFilter', () => {
+  function setup() {
+    const perform = jest.fn();
+
+    const FakeFiltersParser = jest.fn(function FakeClass() {
+      this.perform = perform;
+    });
+
+    return { FakeFiltersParser, perform };
+  }
+
+  it('should create the parser and call perform', async () => {
+    expect.assertions(3);
+
+    const { FakeFiltersParser, perform } = setup();
+
+    const opts = { Sequelize: 'fake' };
+    const parseFilter = makeParseFilter(FakeFiltersParser, { opts });
+    perform.mockResolvedValue('parsed-filter');
+
+    const filter = { operator: 'equal', value: 'hello', field: 'label' };
+    const modelSchema = { label: {} };
+    const timezone = 'Europe/Paris';
+    const result = await parseFilter(filter, modelSchema, timezone);
+
+    expect(result).toBe('parsed-filter');
+    expect(FakeFiltersParser).toHaveBeenCalledWith(modelSchema, timezone, opts);
+    expect(perform).toHaveBeenCalledWith(JSON.stringify(filter));
+  });
+
+  it('should throw an error when the liana is not initialized', () => {
+    expect.assertions(1);
+
+    const { FakeFiltersParser } = setup();
+
+    const parseFilter = makeParseFilter(FakeFiltersParser, {});
+
+    expect(() => parseFilter({}, {}, 'Europe/Paris'))
+      .toThrow('Liana must be initialized before using parseFilter');
+  });
+});