Bobbyg603/issue19 (#40)

* Adds Crashes client support

* Fixes TODO in e2e test
Fixes #19

* Removes unused import from table data client

* Removes TODO that had already been addressed

* Addresses todo in crashes api row

* Removes non-existent event property from crashes api row

* Cleans up imports

Adds tsconfig paths. Adds index files to export public types.

* Lint fixes

Author: bobbyg603

package-lock.json

@@ -9,12 +9,12 @@
   ],
   "scripts": {
     "pretest": "npm run lint:fix",
-    "test": "ts-node node_modules/jasmine/bin/jasmine --config=spec/support/jasmine.spec.json",
-    "test:teamcity": "ts-node node_modules/jasmine/bin/jasmine --config=spec/support/jasmine.teamcity.spec.json",
+    "test": "ts-node -r tsconfig-paths/register node_modules/jasmine/bin/jasmine --config=spec/support/jasmine.spec.json",
+    "test:teamcity": "ts-node -r tsconfig-paths/register node_modules/jasmine/bin/jasmine --config=spec/support/jasmine.teamcity.spec.json",
     "lint": "eslint . --ext .js,.ts",
     "lint:fix": "npm run lint -- --fix",
-    "e2e": "ts-node node_modules/jasmine/bin/jasmine --config=spec/support/jasmine.e2e.json",
-    "e2e:teamcity": "ts-node node_modules/jasmine/bin/jasmine --config=spec/support/jasmine.teamcity.e2e.json",
+    "e2e": "ts-node -r tsconfig-paths/register node_modules/jasmine/bin/jasmine --config=spec/support/jasmine.e2e.json",
+    "e2e:teamcity": "ts-node -r tsconfig-paths/register node_modules/jasmine/bin/jasmine --config=spec/support/jasmine.teamcity.e2e.json",
     "release": "npm run build && npm publish --access public",
     "build": "npm run build:cjs && npm run build:esm",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -48,6 +48,7 @@
     "jasmine": "^3.7.0",
     "jasmine-reporters": "^2.4.0",
     "ts-node": "^10.0.0",
-    "typescript": "^4.2.4"
+    "tsconfig-paths": "^3.11.0",
+    "typescript": "^4.4.3"
   }
 }

package.json

@@ -1,6 +1,6 @@
-import { GroupableThreadCollection, ProcessingStatus } from '../../../src/crash';
-import { EventType } from '../../../src/events/events-api-client/events-api-client';
-import { createFakeEvents } from '../events/events';
+import { GroupableThreadCollection, ProcessingStatus } from '@crash';
+import { EventType } from '@events';
+import { createFakeEvents } from '@spec/fakes/events/events';
 
 export const createFakeCrashApiResponse = () => ({
     processed: ProcessingStatus.Complete,

spec/fakes/crash/crash-api-response.ts

@@ -1,5 +1,5 @@
-import { BugSplatApiClient } from '.';
-import { config } from '../../spec/config';
+import { BugSplatApiClient } from '@common';
+import { config } from '@spec/config';
 
 describe('BugSplatApiClient', () => {
     let client: BugSplatApiClient;
@@ -22,7 +22,7 @@ describe('BugSplatApiClient', () => {
             try {
                 await client.login(email, 'password');
                 fail('login was supposed to throw!');
-            } catch (error) {
+            } catch (error: any) {
                 expect(error.message).toMatch(/Invalid email or password/);
             }
         });

src/common/api-client.ts renamed to src/common/client/api-client.ts

@@ -1,7 +1,6 @@
-import { BugSplatApiClient } from '.';
-import { config } from '../../spec/config';
-import { createFakeResponseBody } from '../../spec/fakes/common/response';
-import { Environment } from './environment';
+import { BugSplatApiClient, Environment } from '@common';
+import { config } from '@spec/config';
+import { createFakeResponseBody } from '@spec/fakes/common/response';
 
 describe('BugSplatApiClient', () => {
     const email = '[email protected]';

src/common/bugsplat-api-client.e2e.ts renamed to src/common/client/bugsplat-api-client.e2e.ts

@@ -1,7 +1,6 @@
+import { ApiClient, BugSplatResponse, Environment } from '@common';
 import fetchPonyfill from 'fetch-ponyfill';
 import FormData from 'form-data';
-import { ApiClient, Environment } from '.';
-import { BugSplatResponse } from './api-client';
 
 export class BugSplatApiClient implements ApiClient {
     private _createFormData = () => new FormData();
@@ -12,7 +11,7 @@ export class BugSplatApiClient implements ApiClient {
         private _host: string = 'https://app.bugsplat.com',
         private _environment: Environment = Environment.Node
     ) { }
-    
+
     static async createAuthenticatedClientForNode(
         host: string,
         email: string,

src/common/bugsplat-api-client.spec.ts renamed to src/common/client/bugsplat-api-client.spec.ts

@@ -0,0 +1,2 @@
+export { ApiClient, BugSplatResponse } from './api-client';
+export { BugSplatApiClient } from './bugsplat-api-client';

src/common/bugsplat-api-client.ts renamed to src/common/client/bugsplat-api-client.ts

@@ -0,0 +1,2 @@
+export * from './search';
+export * from './table-data';

src/common/client/index.ts

@@ -0,0 +1,10 @@
+export const EQUAL = 'EQUAL';
+export const NOT_EQUAL = 'NOT_EQUAL';
+export const CONTAINS = 'CONTAINS';
+export const DOES_NOT_CONTAIN = 'DOES_NOT_CONTAIN';
+export const EMPTY = 'EMPTY';
+export const NOT_EMPTY = 'NOT_EMPTY';
+export const STARTS_WITH = 'STARTS_WITH';
+export const ENDS_WITH = 'ENDS_WITH';
+export const LESS_THAN = 'LESS_THAN';
+export const GREATER_THAN = 'GREATER_THAN';

src/common/data/index.ts

@@ -0,0 +1,37 @@
+import { ApiDataFilter, EQUAL, FilterOperator, GREATER_THAN, LESS_THAN } from '@common';
+
+export class ApiDataFilterGroup {
+  constructor(
+    public filters: Array<ApiDataFilter>,
+    public filterOperator: FilterOperator = FilterOperator.and,
+    public groupOperator: FilterOperator = FilterOperator.and
+  ) {
+    Object.freeze(this);
+  }
+
+  static fromApiTableFilter(filter: ApiDataFilter): ApiDataFilterGroup {
+    return new ApiDataFilterGroup([filter]);
+  }
+
+  static fromColumnValues(
+    values: Array<string>,
+    columnName: string,
+    filterOperator: FilterOperator = FilterOperator.or
+  ): ApiDataFilterGroup {
+    return new ApiDataFilterGroup(values.map(value => new ApiDataFilter(value, EQUAL, columnName)), filterOperator);
+  }
+
+  static fromTimeFrame(columnName: string, startDate?: Date, endDate?: Date): ApiDataFilterGroup {
+    const filters: Array<ApiDataFilter> = [];
+
+    if (startDate) {
+      filters.push(new ApiDataFilter(startDate.toISOString(), GREATER_THAN, columnName));
+    }
+
+    if (endDate) {
+      filters.push(new ApiDataFilter(endDate.toISOString(), LESS_THAN, columnName));
+    }
+
+    return new ApiDataFilterGroup(filters);
+  }
+}

src/common/data/search/filter-condition/filter-condition.ts

@@ -0,0 +1,57 @@
+import { ApiDataFilter, ApiDataFilterGroup, FilterOperator } from '@common';
+
+describe('ApiDataFilterGroup', () => {
+  describe('fromApiDataFilter', () => {
+    it('should return filter group containing filter, filter operator and group operator', () => {
+      const filter = new ApiDataFilter('value', 'condition', 'field');
+
+      const result = ApiDataFilterGroup.fromApiTableFilter(filter);
+
+      expect(result.groupOperator).toEqual(FilterOperator.and);
+      expect(result.filterOperator).toEqual(FilterOperator.and);
+      expect(result.filters).toEqual([filter]);
+    });
+  });
+
+  describe('fromColumnValues', () => {
+    it('should return filter group containing filters, filter operators and group operator', () => {
+      const column = 'Camp Granada';
+      const values = ['hello', 'muddah', 'hello', 'fadduh'];
+
+      const result = ApiDataFilterGroup.fromColumnValues(values, column, FilterOperator.or);
+
+      expect(result.groupOperator).toEqual(FilterOperator.and);
+      expect(result.filterOperator).toEqual(FilterOperator.or);
+      result.filters.forEach((filter, i) => {
+        expect(filter.filterDataField).toEqual(column);
+        expect(filter.filterCondition).toEqual('EQUAL');
+        expect(filter.filterValue).toEqual(values[i]);
+      });
+    });
+  });
+
+  describe('fromTimeFrame', () => {
+    it('should return filter group containing filters, filter operators, and group operator', () => {
+      const startDate = new Date();
+      const endDate = new Date();
+
+      const result = ApiDataFilterGroup.fromTimeFrame('crashTime', startDate, endDate);
+
+      expect(result.filters.length).toEqual(2);
+      expect(result.filterOperator).toEqual(FilterOperator.and);
+      expect(result.groupOperator).toEqual(FilterOperator.and);
+      expect(result.filters[0].filterCondition).toEqual('GREATER_THAN');
+      expect(result.filters[0].filterDataField).toEqual('crashTime');
+      expect(result.filters[0].filterValue).toEqual(startDate.toISOString());
+      expect(result.filters[1].filterCondition).toEqual('LESS_THAN');
+      expect(result.filters[1].filterDataField).toEqual('crashTime');
+      expect(result.filters[1].filterValue).toEqual(endDate.toISOString());
+    });
+
+    it('should return empty filter group if startDate and endDate are falsy', () => {
+      const result = ApiDataFilterGroup.fromTimeFrame('crashTime');
+
+      expect(result.filters.length).toEqual(0);
+    });
+  });
+});

src/common/data/search/filter-group/api-data-filter-group.ts

@@ -0,0 +1,5 @@
+export class FilterOperator {
+  public static readonly and = new FilterOperator('0');
+  public static readonly or = new FilterOperator('1');
+  private constructor(public value: string) { }
+}

src/common/data/search/filter-group/api-data-filter.spec.ts

@@ -0,0 +1,11 @@
+export class ApiDataFilter {
+  constructor(
+    public readonly filterValue: string,
+    public readonly filterCondition: string,
+    public readonly filterDataField: string
+  ) {
+    Object.freeze(this);
+  }
+}
+
+

src/common/data/search/filter-operator/filter-operator.ts

@@ -0,0 +1,6 @@
+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';
+

src/common/data/search/filter/api-data-filter.ts

@@ -0,0 +1,13 @@
+import { OrderFilter } from '@common';
+
+describe('OrderFilter', () => {
+  it('should exist', () => {
+    expect(OrderFilter).toEqual(jasmine.any(Function));
+  });
+
+  it('should have static properties', () => {
+    expect(OrderFilter.ascending).toEqual(jasmine.any(OrderFilter));
+    expect(OrderFilter.descending).toEqual(jasmine.any(OrderFilter));
+    expect(OrderFilter.none).toEqual(jasmine.any(OrderFilter));
+  });
+});