fix: add sortOrder to table-data-request (#67)

Fixes #64
BugSplat-Git · Dec 9, 2021 · 80e2bde · 80e2bde
1 parent 638c2e7
commit 80e2bde
Show file tree

Hide file tree

Showing 10 changed files with 52 additions and 47 deletions.
diff --git a/spec/files/native/post-native-crash.ts b/spec/files/native/post-native-crash.ts
@@ -20,6 +20,14 @@ export async function postNativeCrashAndSymbols(
         files
     );
 
+    return postNativeCrash(database, application, version);
+}
+
+export async function postNativeCrash(
+    database: string,
+    application: string,
+    version: string
+): Promise<number> {
     const crashFile = createUploadableFile('./spec/files/native/myConsoleCrasher.zip');
     const crashPostClient = new CrashPostClient(database);
     const postCrashResult = await crashPostClient.postCrash(

diff --git a/src/common/data/search/index.ts b/src/common/data/search/index.ts
@@ -2,5 +2,3 @@ export * from './filter-condition/filter-condition';
 export { ApiDataFilterGroup } from './filter-group/api-data-filter-group';
 export { FilterOperator } from './filter-operator/filter-operator';
 export { ApiDataFilter } from './filter/api-data-filter';
-export { OrderFilter } from './order-filter/order-filter';
-
diff --git a/src/common/data/search/order-filter/order-filter.spec.ts b/src/common/data/search/order-filter/order-filter.spec.ts
diff --git a/src/common/data/search/order-filter/order-filter.ts b/src/common/data/search/order-filter/order-filter.ts
diff --git a/src/common/data/table-data/index.ts b/src/common/data/table-data/index.ts
@@ -1,4 +1,5 @@
 export { TableDataClient } from './table-data-client/table-data-client';
 export { TableDataRequest } from './table-data-client/table-data-request';
 export { TableDataResponse } from './table-data-client/table-data-response';
-export { TableDataFormDataBuilder } from './table-data-form-data-builder/table-data-form-data-builder';
+export { ColumnSortOrder } from './table-data-form-data-builder/column-sort-order';
+export { TableDataFormDataBuilder } from './table-data-form-data-builder/table-data-form-data-builder';
diff --git a/src/common/data/table-data/table-data-client/table-data-request.ts b/src/common/data/table-data/table-data-client/table-data-request.ts
@@ -1,4 +1,4 @@
-import { ApiDataFilterGroup, OrderFilter } from '@common';
+import { ApiDataFilterGroup, ColumnSortOrder } from '@common';
 
 export interface TableDataRequest {
   database?: string;
@@ -7,5 +7,5 @@ export interface TableDataRequest {
   page?: number;
   pageSize?: number;
   sortColumn?: string;
-  sortOrder?: OrderFilter;
+  sortOrder?: ColumnSortOrder;
 }
diff --git a/src/common/data/table-data/table-data-form-data-builder/column-sort-order.ts b/src/common/data/table-data/table-data-form-data-builder/column-sort-order.ts
@@ -0,0 +1 @@
+export type ColumnSortOrder = 'asc' | 'desc' | '';
diff --git a/src/common/data/table-data/table-data-form-data-builder/table-data-form-data-builder.spec.ts b/src/common/data/table-data/table-data-form-data-builder/table-data-form-data-builder.spec.ts
@@ -1,4 +1,4 @@
-import { ApiDataFilter, ApiDataFilterGroup, OrderFilter } from '@common';
+import { ApiDataFilter, ApiDataFilterGroup } from '@common';
 import { TableDataFormDataBuilder } from './table-data-form-data-builder';
 
 describe('TableDataFormDataBuilder', () => {
@@ -121,18 +121,17 @@ describe('TableDataFormDataBuilder', () => {
 
   describe('withSortOrder', () => {
     it('should add sortOrder', () => {
-      const sortOrder = OrderFilter.ascending;
-      const expectedSortOrder = 'asc';
+      const sortOrder = 'asc';
 
       const result = <FakeFormData><unknown>new TableDataFormDataBuilder(formDataFactory)
         .withSortOrder(sortOrder)
         .build();
 
-      expect(result.get('sortorder')).toEqual(expectedSortOrder);
+      expect(result.get('sortorder')).toEqual(sortOrder);
     });
 
     it('should not add sortorder if sortOrder is none', () => {
-      const sortOrder = OrderFilter.none;
+      const sortOrder = '';
 
       const result = <FakeFormData><unknown>new TableDataFormDataBuilder(formDataFactory)
         .withSortOrder(sortOrder)

diff --git a/src/common/data/table-data/table-data-form-data-builder/table-data-form-data-builder.ts b/src/common/data/table-data/table-data-form-data-builder/table-data-form-data-builder.ts
@@ -1,6 +1,7 @@
 
-import { ApiDataFilterGroup, OrderFilter } from '@common';
+import { ApiDataFilterGroup } from '@common';
 import FormData from 'form-data';
+import { ColumnSortOrder } from './column-sort-order';
 
 export class TableDataFormDataBuilder {
 
@@ -63,17 +64,9 @@ export class TableDataFormDataBuilder {
     return this;
   }
 
-  withSortOrder(sortOrder: OrderFilter | undefined): TableDataFormDataBuilder {
+  withSortOrder(sortOrder: ColumnSortOrder | undefined): TableDataFormDataBuilder {
     if (sortOrder) {
-      let translatedSortOrder;
-      if (sortOrder === OrderFilter.none) {
-        return this;
-      } else if (sortOrder === OrderFilter.ascending) {
-        translatedSortOrder = 'asc';
-      } else if (sortOrder === OrderFilter.descending) {
-        translatedSortOrder = 'desc';
-      }
-      this._formParts.sortorder = translatedSortOrder;
+      this._formParts.sortorder = sortOrder;
     }
     return this;
   }

diff --git a/src/crashes/crashes-api-client/crashes-api-client.e2e.ts b/src/crashes/crashes-api-client/crashes-api-client.e2e.ts
@@ -1,8 +1,8 @@
 import { config } from '@spec/config';
-import { BugSplatApiClient } from '@common';
+import { ApiDataFilterGroup, BugSplatApiClient, FilterOperator } from '@common';
 import { CrashApiClient } from '@crash';
 import { CrashesApiClient } from '@crashes';
-import { postNativeCrashAndSymbols } from '@spec/files/native/post-native-crash';
+import { postNativeCrash, postNativeCrashAndSymbols } from '@spec/files/native/post-native-crash';
 
 describe('CrashesApiClient', () => {
     let crashClient: CrashApiClient;
@@ -30,9 +30,9 @@ describe('CrashesApiClient', () => {
         it('should return 200 and array of crashes', async () => {
             const database = config.database;
             const pageSize = 1;
-            
+
             const result = await crashesClient.getCrashes({ database, pageSize });
-            
+
             const row = result.rows.find(row => Number(row.id) === id);
             expect(result.rows).toBeTruthy();
             expect(result.rows.length).toEqual(pageSize);
@@ -45,21 +45,45 @@ describe('CrashesApiClient', () => {
             const database = config.database;
             const pageSize = 1;
             const columnGroups = ['stackKey'];
-            
+
             const result = await crashesClient.getCrashes({ database, pageSize, columnGroups });
-            
+
             const row = result.rows[0];
             expect(result.rows).toBeTruthy();
             expect(result.rows.length).toEqual(pageSize);
             expect(row?.groupByCount).toBeGreaterThanOrEqual(1);
         });
+
+        it('should return 200 with crashes sorted by sortColumn and sortOrder', async () => {
+            const database = config.database;
+            const pageSize = 2;
+            const sortColumn = 'id';
+            const sortOrder = 'asc';
+            const newestCrashId = await postNativeCrash(
+                config.database,
+                application,
+                version
+            );
+            const filterGroups = [ApiDataFilterGroup.fromColumnValues([`${id}`, `${newestCrashId}`], 'id', FilterOperator.or)];
+
+            const result = await crashesClient.getCrashes({
+                database,
+                filterGroups,
+                pageSize,
+                sortColumn,
+                sortOrder
+            });
+
+            const row = result.rows[0];
+            expect(row.id).toEqual(id);
+        });
     });
 
     describe('postNotes', () => {
         it('should return 200', async () => {
             const database = config.database;
             const notes = 'BugSplat rocks!';
-            
+
             await crashesClient.postNotes(database, id, notes);
             const result = await crashClient.getCrashById(database, id);