feat(tests): add query tests after calling clearFilters/clearSorters

Author: Ghislain Beaulac

src/app/modules/angular-slickgrid/services/__tests__/graphql.service.spec.ts

@@ -848,6 +848,23 @@ describe('GraphqlService', () => {
 
       expect(removeSpaces(query)).toBe(removeSpaces(expectation));
     });
+
+    it('should return a query without any sorting after clearFilters was called', () => {
+      const expectation = `query{ users(first:10,offset:0) { totalCount,nodes{id, company, gender,name} }}`;
+      const mockColumn = { id: 'gender', field: 'gender' } as Column;
+      const mockColumnFilters = {
+        gender: { columnId: 'gender', columnDef: mockColumn, searchTerms: ['female'], operator: 'EQ' },
+      } as ColumnFilters;
+
+      service.init(serviceOptions, paginationOptions, gridStub);
+      service.updateFilters(mockColumnFilters, false);
+      service.clearFilters();
+      const currentFilters = service.getCurrentFilters();
+      const query = service.buildQuery();
+
+      expect(removeSpaces(query)).toBe(removeSpaces(expectation));
+      expect(currentFilters).toEqual([]);
+    });
   });
 
   describe('updateSorters method', () => {
@@ -927,7 +944,6 @@ describe('GraphqlService', () => {
       expect(currentSorters).toEqual([{ columnId: 'gender', direction: 'DESC' }, { columnId: 'name', direction: 'ASC' }]);
     });
 
-
     it('should return a query without the field sorter when its field property is missing', () => {
       const expectation = `query { users(first:10, offset:0, orderBy:[{field:gender, direction:DESC}]) {
                           totalCount, nodes { id,company,gender,name }}}`;
@@ -944,5 +960,23 @@ describe('GraphqlService', () => {
       expect(removeSpaces(query)).toBe(removeSpaces(expectation));
       expect(currentSorters).toEqual([{ columnId: 'gender', direction: 'DESC' }, { columnId: 'firstName', direction: 'ASC' }]);
     });
+
+    it('should return a query without any sorting after clearSorters was called', () => {
+      const expectation = `query { users(first:10, offset:0) {
+        totalCount, nodes { id,company,gender,name }}}`;
+      const mockColumnSort = [
+        { columnId: 'gender', sortCol: { id: 'gender', field: 'gender' }, sortAsc: false },
+        { columnId: 'firstName', sortCol: { id: 'firstName', field: 'firstName' }, sortAsc: true }
+      ] as ColumnSort[];
+
+      service.init(serviceOptions, paginationOptions, gridStub);
+      service.updateSorters(mockColumnSort);
+      service.clearSorters();
+      const query = service.buildQuery();
+      const currentSorters = service.getCurrentSorters();
+
+      expect(removeSpaces(query)).toBe(removeSpaces(expectation));
+      expect(currentSorters).toEqual([]);
+    });
   });
 });

src/app/modules/angular-slickgrid/services/__tests__/grid-odata.service.spec.ts

@@ -152,17 +152,17 @@ describe('GridOdataService', () => {
 
   describe('clearFilters method', () => {
     it('should call "updateOptions" to clear all filters', () => {
-      const spy = jest.spyOn(service, 'updateOptions');
+      const spy = jest.spyOn(service, 'updateFilters');
       service.clearFilters();
-      expect(spy).toHaveBeenCalledWith({ filteringOptions: [] });
+      expect(spy).toHaveBeenCalledWith([]);
     });
   });
 
   describe('clearSorters method', () => {
     it('should call "updateOptions" to clear all sorting', () => {
-      const spy = jest.spyOn(service, 'updateOptions');
+      const spy = jest.spyOn(service, 'updateSorters');
       service.clearSorters();
-      expect(spy).toHaveBeenCalledWith({ sortingOptions: [] });
+      expect(spy).toHaveBeenCalledWith([]);
     });
   });
 
@@ -658,6 +658,23 @@ describe('GridOdataService', () => {
 
       expect(query).toBe(expectation);
     });
+
+    it('should return a query without any sorting after clearFilters was called', () => {
+      const expectation = `$top=10`;
+      const mockColumn = { id: 'gender', field: 'gender' } as Column;
+      const mockColumnFilters = {
+        gender: { columnId: 'gender', columnDef: mockColumn, searchTerms: ['female'], operator: 'EQ' },
+      } as ColumnFilters;
+
+      service.init(serviceOptions, paginationOptions, gridStub);
+      service.updateFilters(mockColumnFilters, false);
+      service.clearFilters();
+      const currentFilters = service.getCurrentFilters();
+      const query = service.buildQuery();
+
+      expect(query).toBe(expectation);
+      expect(currentFilters).toEqual([]);
+    });
   });
 
   describe('updateSorters method', () => {
@@ -744,6 +761,23 @@ describe('GridOdataService', () => {
       expect(query).toBe(expectation);
       expect(currentSorters).toEqual([{ columnId: 'Gender', direction: 'desc' }, { columnId: 'FirstName', direction: 'asc' }]);
     });
+
+    it('should return a query without any sorting after clearSorters was called', () => {
+      const expectation = `$top=10`;
+      const mockColumnSort = [
+        { columnId: 'gender', sortCol: { id: 'gender', field: 'gender' }, sortAsc: false },
+        { columnId: 'firstName', sortCol: { id: 'firstName', field: 'firstName' }, sortAsc: true }
+      ] as ColumnSort[];
+
+      service.init(serviceOptions, paginationOptions, gridStub);
+      service.updateSorters(mockColumnSort);
+      service.clearSorters();
+      const query = service.buildQuery();
+      const currentSorters = service.getCurrentSorters();
+
+      expect(query).toBe(expectation);
+      expect(currentSorters).toEqual([]);
+    });
   });
 
   describe('mapOdataOperator method', () => {

src/app/modules/angular-slickgrid/services/grid-odata.service.ts

@@ -90,12 +90,12 @@ export class GridOdataService implements BackendService {
 
   clearFilters() {
     this._currentFilters = [];
-    this.updateOptions({ filteringOptions: [] });
+    this.updateFilters([]);
   }
 
   clearSorters() {
     this._currentSorters = [];
-    this.updateOptions({ sortingOptions: [] });
+    this.updateSorters([]);
   }
 
   updateOptions(serviceOptions?: OdataOption) {
@@ -218,7 +218,7 @@ export class GridOdataService implements BackendService {
   }
 
   /**
-   * loop through all columns to inspect filters & update backend service filteringOptions
+   * loop through all columns to inspect filters & update backend service filters
    * @param columnFilters
    */
   updateFilters(columnFilters: ColumnFilters | CurrentFilter[], isUpdatedByPreset?: boolean) {
@@ -475,7 +475,6 @@ export class GridOdataService implements BackendService {
 
     // keep current Sorters and update the service options with the new sorting
     this._currentSorters = currentSorters;
-    // this.updateOptions({ sortingOptions: odataSorters });
 
     // build the OData query which we will use in the WebAPI callback
     return this._odataService.buildQuery();

src/app/modules/angular-slickgrid/services/odata.service.ts

@@ -35,7 +35,7 @@ export class OdataService {
     if (this._odataOptions.orderBy) {
       let argument = '';
       if (Array.isArray(this._odataOptions.orderBy)) {
-        argument = this._odataOptions.orderBy.join(','); // csv, that will form a query example like: $orderby=RoleName asc, Id desc
+        argument = this._odataOptions.orderBy.join(','); // csv, that will form a query, for example: $orderby=RoleName asc, Id desc
       } else {
         argument = this._odataOptions.orderBy;
       }