@zeedhi/teknisa-components-common 3.0.0 → 3.0.2

package/tests/unit/components/tek-grid/tek-memory-datasource.spec.ts

@@ -0,0 +1,482 @@
+import {
+  init,
+  Router,
+  URL,
+} from '@zeedhi/core';
+import {
+  TekMemoryDatasource, ITekMemoryDatasource,
+} from '../../../../src';
+import { flushPromises } from '../../__helpers__';
+
+describe('TekMemoryDatasource', () => {
+  init({
+    controllers: {
+      AppController: class AppController {
+        public value = '1';
+      },
+    },
+  });
+
+  let datasource: ITekMemoryDatasource;
+  let router: any;
+
+  beforeEach(() => {
+    datasource = {
+      uniqueKey: 'id',
+      data: [
+        { name: 'name 1', id: 1 }, { name: 'name 2', id: 2 }, { name: 'name 3', id: 3 },
+        { name: 'name 4', id: 4 }, { name: 'name 5', id: 5 }, { name: 'name 6', id: 6 },
+      ],
+    };
+    router = {
+      push: () => jest.fn,
+      replace: (route: any) => {
+        window.history.replaceState(null, '', `${window.location.pathname}?${URL.getFormattedQueryString(route.query)}`);
+      },
+      back: () => jest.fn,
+      getCurrentRoute: () => ({
+        path: '',
+        hash: '',
+        query: {},
+        params: {},
+        fullPath: '',
+      }),
+      getPath: () => '',
+      getHash: () => '',
+      getQuery: () => ({}),
+      getParams: () => ({}),
+      getFullPath: () => '',
+    };
+    Router.setInstance(router);
+  });
+
+  describe('constuctor()', () => {
+    it('should assign all properties', async () => {
+      const instance = new TekMemoryDatasource({
+        ...datasource,
+        dynamicFilter: {
+          name: [{ operation: 'EQUALS', relation: 'AND', value: '1' }],
+        },
+        searchJoin: { col1: ['1', '2'], col2: [2], col3: [] },
+      });
+      await flushPromises();
+
+      expect(instance.dynamicFilter).toEqual({ name: [{ operation: 'EQUALS', relation: 'AND', value: '1' }] });
+      expect(instance.searchJoin).toEqual({ col1: ['1', '2'], col2: [2], col3: [] });
+    });
+
+    it('should assign all properties with accessor', async () => {
+      const instance = new TekMemoryDatasource({
+        ...datasource,
+        dynamicFilter: {
+          name: [{ operation: 'EQUALS', relation: 'AND', value: '{{AppController.value}}' }],
+        },
+        searchJoin: { col1: ['1', '2'], col2: [2], col3: [] },
+      });
+      await flushPromises();
+
+      expect(instance.dynamicFilter).toEqual({ name: [{ operation: 'EQUALS', relation: 'AND', value: '1' }] });
+      expect(instance.searchJoin).toEqual({ col1: ['1', '2'], col2: [2], col3: [] });
+    });
+
+    it('should create using default parameters', async () => {
+      const instance = new TekMemoryDatasource({});
+
+      expect(instance.dynamicFilter).toEqual({});
+      expect(instance.searchJoin).toEqual({});
+    });
+
+    it('should set values from url', () => {
+      router.getFullPath = () => 'localhost/?page=2&limit=10&order=id.asc&search=2&id=1';
+      const instance = new TekMemoryDatasource({
+        ...datasource,
+        watchUrl: true,
+      });
+      expect(instance.filter).toEqual({ id: '1' });
+      expect(instance.limit).toBe(10);
+      expect(instance.order).toEqual(['id.asc']);
+      expect(instance.page).toBe(2);
+      expect(instance.search).toBe('2');
+    });
+
+    it('should set dynamicFilter from url', () => {
+      router.getFullPath = () => 'localhost/?dynamic_filter=eyJuYW1lIjpbeyJvcGVyYXRpb24iOiJFUVVBTFMiLCJyZWxhdGlvbiI6IkFORCIsInZhbHVlIjoiMSJ9XX0='; // eslint-disable-line max-len
+      datasource.watchUrl = true;
+      const instance = new TekMemoryDatasource(datasource);
+      instance.initialize();
+      expect(instance.dynamicFilter).toEqual({ name: [{ operation: 'EQUALS', relation: 'AND', value: '1' }] });
+    });
+
+    it('should set searchJoin from url', () => {
+      router.getFullPath = () => 'localhost/?search_join=eyAiY29sMSI6IFsiMSIsICIyIl0sICJjb2wyIjogWzJdLCAiY29sMyI6IFtdIH0='; // eslint-disable-line max-len
+      datasource.watchUrl = true;
+      const instance = new TekMemoryDatasource(datasource);
+      instance.initialize();
+      expect(instance.searchJoin).toEqual({ col1: ['1', '2'], col2: [2], col3: [] });
+    });
+  });
+
+  describe('dynamicFilter', () => {
+    it('should retrieve data using dynamic filter', async () => {
+      datasource.watchUrl = false;
+      const instance = new TekMemoryDatasource(datasource);
+      instance.initialize();
+
+      await flushPromises();
+      expect(instance.data.length).toBe(6);
+
+      instance.dynamicFilter = {
+        name: [
+          { operation: 'CONTAINS', relation: 'AND', value: '1' },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(1);
+
+      instance.dynamicFilter = {
+        name: [
+          { operation: 'CONTAINS', relation: 'AND', value: 'name' },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(6);
+
+      instance.dynamicFilter = {
+        name: [
+          { operation: 'CONTAINS', relation: 'AND', value: '1' },
+          { operation: 'CONTAINS', relation: 'OR', value: '2' },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(2);
+
+      instance.dynamicFilter = {
+        name: [
+          { operation: 'CONTAINS', relation: 'AND', value: '1' },
+          { operation: 'CONTAINS', relation: 'AND', value: '2' },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(0);
+
+      instance.dynamicFilter = {
+        name: [
+          { operation: 'CONTAINS', relation: 'AND', value: '1' },
+        ],
+        id: [
+          { operation: 'CONTAINS', relation: 'OR', value: '2' },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(2);
+
+      instance.dynamicFilter = {
+        name: [
+          { operation: 'NOT_CONTAINS', relation: 'AND', value: '1' },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(5);
+
+      instance.dynamicFilter = {
+        name: [
+          { operation: 'EQUALS', relation: 'AND', value: '1' },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(0);
+
+      instance.dynamicFilter = {
+        name: [
+          { operation: 'EQUALS', relation: 'AND', value: 'name 1' },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(1);
+
+      instance.dynamicFilter = {
+        name: [
+          { operation: 'NOT_EQUALS', relation: 'AND', value: 'name 1' },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(5);
+
+      instance.dynamicFilter = {
+        id: [
+          { operation: 'GREATER_THAN', relation: 'AND', value: '2' },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(4);
+
+      instance.dynamicFilter = {
+        id: [
+          { operation: 'LESS_THAN', relation: 'AND', value: '2' },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(1);
+
+      instance.dynamicFilter = {
+        id: [
+          { operation: 'GREATER_THAN_EQUALS', relation: 'AND', value: '2' },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(5);
+
+      instance.dynamicFilter = {
+        id: [
+          { operation: 'LESS_THAN_EQUALS', relation: 'AND', value: '2' },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(2);
+
+      instance.dynamicFilter = {
+        name: [
+          { operation: 'GREATER_THAN', relation: 'AND', value: 'name 2' },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(4);
+
+      instance.dynamicFilter = {
+        name: [
+          { operation: 'LESS_THAN', relation: 'AND', value: 'name 2' },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(1);
+
+      instance.dynamicFilter = {
+        name: [
+          { operation: 'GREATER_THAN_EQUALS', relation: 'AND', value: 'name 2' },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(5);
+
+      instance.dynamicFilter = {
+        name: [
+          { operation: 'LESS_THAN_EQUALS', relation: 'AND', value: 'name 2' },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(2);
+
+      instance.dynamicFilter = {
+        id: [
+          { operation: 'IN', relation: 'AND', value: ['1', '2'] },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(2);
+
+      instance.dynamicFilter = {
+        id: [
+          { operation: 'NOT_IN', relation: 'AND', value: ['1', '2'] },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(4);
+
+      instance.dynamicFilter = {
+        id: [
+          { operation: 'BETWEEN', relation: 'AND', value: ['2', '5'] },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(4);
+
+      instance.dynamicFilter = {
+        name: [
+          { operation: 'BETWEEN', relation: 'AND', value: ['name 2', 'name 5'] },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(4);
+
+      instance.dynamicFilter = {
+        name: [
+          { operation: '', relation: 'AND', value: ['1', '2'] },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(0);
+
+      instance.dynamicFilter = {
+        name: [
+          { operation: '', relation: 'AND', value: '1' },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(0);
+    });
+
+    it('should not retrieve data with wrong operator', async () => {
+      const instance = new TekMemoryDatasource(datasource);
+
+      await flushPromises();
+      expect(instance.data.length).toBe(6);
+
+      instance.dynamicFilter = {
+        name: [
+          { operation: 'TEST', relation: 'AND', value: '1' },
+        ],
+      };
+      await instance.get();
+      expect(instance.data.length).toBe(0);
+    });
+  });
+
+  describe('searchJoin', () => {
+    it('should retrieve data using search join', async () => {
+      const instance = new TekMemoryDatasource(datasource);
+      instance.initialize();
+
+      await flushPromises();
+      expect(instance.data.length).toBe(6);
+
+      instance.searchJoin = {
+        name: ['name 1', 'name 2'],
+      };
+      instance.search = 'aaa';
+      await instance.get();
+      expect(instance.data.length).toBe(2);
+    });
+  });
+
+  describe('addDynamicFilter()', () => {
+    it('should add/remove dynamic filter value', () => {
+      const instance = new TekMemoryDatasource(datasource);
+      instance.addDynamicFilter('name', [{ operation: 'EQUALS', relation: 'AND', value: '1' }]);
+      expect(instance.dynamicFilter).toEqual({ name: [{ operation: 'EQUALS', relation: 'AND', value: '1' }] });
+      instance.addDynamicFilter('name', [{ operation: 'foo', relation: 'AND', value: '1' }]);
+      expect(instance.dynamicFilter).toEqual({});
+    });
+  });
+
+  describe('setDynamicFilter()', () => {
+    it('should add/remove dynamic filter value', () => {
+      const instance = new TekMemoryDatasource(datasource);
+      instance.setDynamicFilter({ name: [{ operation: 'EQUALS', relation: 'AND', value: '1' }] });
+      expect(instance.dynamicFilter).toEqual({ name: [{ operation: 'EQUALS', relation: 'AND', value: '1' }] });
+
+      instance.setDynamicFilter({ name: [{ operation: 'foo', relation: 'AND', value: '1' }] });
+      expect(instance.dynamicFilter).toEqual({});
+
+      instance.setDynamicFilter({
+        name: [], id: [{}],
+      });
+      expect(instance.dynamicFilter).toEqual({});
+    });
+
+    it('should add dynamic filter value with watchUrl', () => {
+      let dynamicFilterValue = 'eyJuYW1lIjpbeyJvcGVyYXRpb24iOiJFUVVBTFMiLCJyZWxhdGlvbiI6IkFORCIsInZhbHVlIjoiMSJ9XX0=';
+      router.getFullPath = () => `localhost/?dynamic_filter=${dynamicFilterValue}`;
+      const urlSpy = jest.spyOn(URL, 'updateQueryString');
+
+      datasource.watchUrl = true;
+      const instance = new TekMemoryDatasource(datasource);
+      instance.initialize();
+      expect(instance.dynamicFilter).toEqual({ name: [{ operation: 'EQUALS', relation: 'AND', value: '1' }] });
+
+      dynamicFilterValue = 'eyJuYW1lIjpbeyJvcGVyYXRpb24iOiJFUVVBTFMiLCJyZWxhdGlvbiI6IkFORCIsInZhbHVlIjoiMiJ9XX0=';
+      instance.setDynamicFilter({ name: [{ operation: 'EQUALS', relation: 'AND', value: '2' }] });
+      expect(urlSpy).toHaveBeenCalledWith({
+        dynamic_filter: dynamicFilterValue,
+      });
+      expect(instance.dynamicFilter).toEqual({ name: [{ operation: 'EQUALS', relation: 'AND', value: '2' }] });
+      urlSpy.mockClear();
+    });
+  });
+
+  describe('clearDynamicFilter()', () => {
+    it('should clear dynamic filter', () => {
+      datasource.watchUrl = false;
+      const instance = new TekMemoryDatasource(datasource);
+      instance.setDynamicFilter({ name: [{ operation: 'EQUALS', relation: 'AND', value: '1' }] });
+      expect(instance.dynamicFilter).toEqual({ name: [{ operation: 'EQUALS', relation: 'AND', value: '1' }] });
+      instance.clearDynamicFilter();
+      expect(instance.dynamicFilter).toEqual({});
+    });
+
+    it('should clear dynamic filter value with watchUrl', () => {
+      let dynamicFilterValue = 'eyJuYW1lIjpbeyJvcGVyYXRpb24iOiJFUVVBTFMiLCJyZWxhdGlvbiI6IkFORCIsInZhbHVlIjoiMSJ9XX0=';
+      router.getFullPath = () => `localhost/?dynamic_filter=${dynamicFilterValue}`;
+      const urlSpy = jest.spyOn(URL, 'updateQueryString');
+
+      datasource.watchUrl = true;
+      const instance = new TekMemoryDatasource(datasource);
+      instance.initialize();
+      expect(instance.dynamicFilter).toEqual({ name: [{ operation: 'EQUALS', relation: 'AND', value: '1' }] });
+
+      dynamicFilterValue = '';
+      instance.clearDynamicFilter();
+      expect(urlSpy).toHaveBeenCalledWith({
+        dynamic_filter: undefined,
+      });
+      expect(instance.dynamicFilter).toEqual({});
+      urlSpy.mockClear();
+    });
+  });
+
+  describe('clone', () => {
+    it('should return an object with all datasource props', async () => {
+      const data = [{ value: 'item 1' }];
+      const dynamicFilter = {
+        value: { operation: 'EQUALS', relation: 'AND', value: 'item 1' },
+      };
+      const searchJoin = { col1: ['1', '2'], col2: [2], col3: [] };
+      const instance = new TekMemoryDatasource({
+        data: [...data],
+        dynamicFilter,
+        searchJoin,
+      });
+      instance.initialize();
+
+      const props = instance.clone();
+
+      expect(props).toEqual({
+        data,
+        dynamicFilter,
+        searchJoin,
+        currentRow: {},
+        filter: {},
+        limit: 10,
+        order: [],
+        page: 1,
+        search: '',
+        searchIn: [],
+        uniqueKey: 'id',
+        watchUrl: false,
+        events: {},
+        loadAll: false,
+        type: 'tek-memory',
+        translate: false,
+      });
+    });
+  });
+
+  describe('get()', () => {
+		it('should retrieve data based on filter', async () => {
+      datasource.filter = { name: 'name 1' };
+			const instance = new TekMemoryDatasource(datasource);
+			instance.initialize();
+			const data = await instance.get();
+			expect(data).toEqual([{ id: 1, name: 'name 1' }]);
+		});
+  });
+
+  describe('hasFilter()', () => {
+    it('should return true if there is a filter for the column', () => {
+      const instance = new TekMemoryDatasource(datasource);
+      instance.initialize();
+      expect(instance.hasFilter('name')).toBeFalsy();
+      instance.dynamicFilter = { name: [{ value: 'name 1', operation: 'CONTAINS', relation: 'AND' }] };
+      expect(instance.hasFilter('name')).toBeTruthy();
+    });
+  });
+});