feat!: remove EventStream (#97)

* feat!: remove EventStream

* fix: add uId to event

add postCrashComment
add postStackKeyComment

Fixes #29 Fixes #96

BREAKING CHANGE: removes EventStream

Author: bobbyg603

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

@@ -1,15 +1,16 @@
 import { GroupableThreadCollection, ProcessingStatus } from '@crash';
 import { EventType } from '@events';
 import { createFakeEvents } from '@spec/fakes/events/events';
+import { CrashDetailsRawResponse } from 'src/crash/crash-details/crash-details';
 
 export const createFakeCrashApiResponse = () => ({
-    processed: ProcessingStatus.Complete,
+    processed: ProcessingStatus.Complete as number,
     additionalFiles: ['1.txt', '2.png'],
     appKey: 'ardvark',
     appName: 'boregard',
     appVersion: '1.2.3.4',
     comments: 'blah blah blah',
-    crashTime: '01:00 PM GMT',
+    crashTime: '2023-02-04T17:58:15+0000Z',
     defectLabel: 'weee!',
     defectUrl: 'http://newayz.net',
     description: 'haa!',
@@ -25,9 +26,10 @@ export const createFakeCrashApiResponse = () => ({
     platform: 'NES',
     previousCrashId: 998,
     processor: 'Pentium 4',
+    stackKeyComment: 'hello world!',
     stackKeyId: 117,
     stackKeyDefectLabel: 'idk',
     stackKeyDefectUrl: 'http://toppong.com',
     thread: new GroupableThreadCollection({ stackFrames: [], stackKeyId: 117 }),
     user: 'Fred'
-});
+} as CrashDetailsRawResponse);

spec/files/native/post-native-crash.ts

@@ -1,20 +1,17 @@
 import { BugSplatApiClient } from '@common';
+import { CrashApiClient } from '@crash';
 import { CrashPostClient, CrashType } from '@post';
 import { VersionsApiClient } from '@versions';
 import { firstValueFrom, timer } from 'rxjs';
+import { PostCrashResponse } from 'src/post/post-crash-response';
 import { createUploadableFile } from '../create-bugsplat-file';
 
-export interface CrashInfo {
-    crashId: number;
-    stackKeyId: number;
-}
-
 export async function postNativeCrashAndSymbols(
     authenticatedClient: BugSplatApiClient,
     database: string,
     application: string,
     version: string
-): Promise<CrashInfo> {
+): Promise<PostCrashResponse> {
     const exeFile = createUploadableFile('./spec/files/native/myConsoleCrasher.exe');
     const pdbFile = createUploadableFile('./spec/files/native/myConsoleCrasher.pdb');
     const files = [exeFile, pdbFile];
@@ -33,7 +30,7 @@ export async function postNativeCrash(
     database: string,
     application: string,
     version: string
-): Promise<CrashInfo> {
+): Promise<PostCrashResponse> {
     const crashFile = createUploadableFile('./spec/files/native/myConsoleCrasher.zip');
     const crashPostClient = new CrashPostClient(database);
     await firstValueFrom(timer(2000)); // Prevent rate-limiting
@@ -44,5 +41,44 @@ export async function postNativeCrash(
         crashFile,
         'ebe24c1cd1a0912904658fa4fad2b539'
     );
-    return postCrashResult.json() as Promise<CrashInfo>;
+    return postCrashResult.json();
+}
+
+export async function postNativeCrashAndWaitForCrashToProcess(
+    bugsplat: BugSplatApiClient,
+    crashClient: CrashApiClient,
+    database: string,
+    application: string,
+    version: string
+): Promise<PostCrashResponse> {
+    const result = await postNativeCrashAndSymbols(
+        bugsplat,
+        database,
+        application,
+        version
+    );
+
+    const crashId = result.crashId;
+    let stackKeyId = result.stackKeyId;
+
+    if (stackKeyId > 0) {
+        return {
+            crashId,
+            stackKeyId
+        };
+    }
+
+    for (let i = 0; i < 60; i++) {
+        const crash = await crashClient.getCrashById(database, crashId);
+        stackKeyId = crash.stackKeyId as number;
+        if (stackKeyId > 0) {
+            break;
+        }
+        await firstValueFrom(timer(3000));
+    }
+
+    return {
+        crashId,
+        stackKeyId
+    };
 }

src/crash/crash-api-client/crash-api-client.spec.ts

@@ -1,8 +1,9 @@
-import { CrashApiClient, CrashDetails } from '@crash';
+import { CrashApiClient } from '@crash';
 import { createFakeBugSplatApiClient } from '@spec/fakes/common/bugsplat-api-client';
 import { createFakeFormData } from '@spec/fakes/common/form-data';
 import { createFakeResponseBody } from '@spec/fakes/common/response';
 import { createFakeCrashApiResponse } from '@spec/fakes/crash/crash-api-response';
+import { createCrashDetails } from '../crash-details/crash-details';
 
 describe('CrashApiClient', () => {
     const database = 'fred';
@@ -49,7 +50,7 @@ describe('CrashApiClient', () => {
 
         it('should return response json', () => {
             expect(result).toEqual(
-                jasmine.objectContaining(new CrashDetails(fakeCrashApiResponse))
+                jasmine.objectContaining(createCrashDetails(fakeCrashApiResponse))
             );
         });
 

src/crash/crash-api-client/crash-api-client.ts

@@ -1,7 +1,7 @@
 import { ApiClient } from '@common';
 import { CrashDetails } from '@crash';
 import ac from 'argument-contracts';
-import { CrashDetailsConstructorOptions } from '../crash-details/crash-details';
+import { CrashDetailsRawResponse, createCrashDetails } from '../crash-details/crash-details';
 
 export class CrashApiClient {
 
@@ -33,7 +33,7 @@ export class CrashApiClient {
             throw new Error((json as Error).message);
         }
 
-        return new CrashDetails(json as CrashDetailsConstructorOptions);
+        return createCrashDetails(json as CrashDetailsRawResponse);
     }
 
     async reprocessCrash(database: string, crashId: number, force = false): Promise<SuccessResponse> {
@@ -42,7 +42,7 @@ export class CrashApiClient {
         if (crashId <= 0) {
             throw new Error(`Expected id to be a positive non-zero number. Value received: "${crashId}"`);
         }
-        
+
         const formData = this._client.createFormData();
         formData.append('database', database);
         formData.append('id', crashId.toString());
@@ -62,12 +62,12 @@ export class CrashApiClient {
         if (response.status !== 202) {
             throw new Error((json as ErrorResponse).message);
         }
-        
+
         return json as SuccessResponse;
     }
 }
 
 type SuccessResponse = { success: boolean };
 type ErrorResponse = { message: string };
-type GetCrashByIdResponse = CrashDetailsConstructorOptions | ErrorResponse;
-type ReprocessCrashResponse = SuccessResponse | ErrorResponse;
+type GetCrashByIdResponse = CrashDetailsRawResponse | ErrorResponse;
+type ReprocessCrashResponse = SuccessResponse | ErrorResponse;

src/crash/crash-details/crash-details.spec.ts

@@ -1,31 +1,20 @@
-import { CrashDetails, ProcessingStatus } from '@crash';
-import { EventStreamActionType } from '@events';
+import { AdditionalInfo, ProcessingStatus } from '@crash';
 import { createFakeCrashApiResponse } from '@spec/fakes/crash/crash-api-response';
 import ac from 'argument-contracts';
+import { createEvents } from '../../events/events-api-client/event';
 import * as ThreadCollectionModule from '../thread-collection/thread-collection';
+import { createCrashDetails } from './crash-details';
 
-describe('Crash Details', () => {
+describe('createCrashDetails', () => {
   it('should set all properties', () => {
-    const options = createFakeCrashApiResponse();
+    const options: any = createFakeCrashApiResponse();
 
-    const result = new CrashDetails(options);
+    const result = createCrashDetails(options);
 
-    Object.keys(options).forEach(key => {
-      if (key !== 'events') {
-        expect(options[key]).toEqual(result[key]);
-      } else {
-        expect(result.events).toEqual(jasmine.arrayContaining([
-          jasmine.objectContaining({
-            action: EventStreamActionType.comment,
-            createdDate: new Date(options.events[0].timestamp),
-            subject: {
-              initials: options.events[0].username.substring(0, 2),
-              email: options.events[0].username,
-            },
-            message: options.events[0].message,
-          })
-        ]));
-      }
+    expect(result).toEqual({
+      ...options,
+      events: createEvents(options.events),
+      additionalInfo: jasmine.any(AdditionalInfo),
     });
   });
 
@@ -56,7 +45,7 @@ describe('Crash Details', () => {
       thread: (<any>{ stackFrames: [], stackKeyId: 0 })
     };
 
-    const result = new CrashDetails(<any>options);
+    const result = createCrashDetails(<any>options);
 
     expect(result.comments).toEqual('');
     expect(result.description).toEqual('');