feat!: s3 symserv upload support (#112)

* feat: upload via spdbsv2

* fix: export symbols client

* chore: add tests and refactor

BREAKING CHANGE: drop support for fs.ReadableStream, as it's not browser-compatible. Use ReadStream.toWeb(...) to convert to web-compatible ReadableStream.

Author: bobbyg603

spec/fakes/common/bugsplat-api-client.ts

@@ -1,7 +1,9 @@
+import { ApiClient } from '@common';
+
 export function createFakeBugSplatApiClient(
     formData: FormData,
     response: any
-): any {
+): jasmine.SpyObj<ApiClient> {
     const fakeBugSplatApiClient = jasmine.createSpyObj('BugSplatApiClient', [
         'createFormData',
         'fetch'

spec/files/create-bugsplat-file.ts

@@ -1,9 +1,11 @@
 import { UploadableFile } from '@common';
-import fs, { statSync } from 'fs';
-import path from 'path';
+import { createReadStream, ReadStream } from 'node:fs';
+import { stat } from 'node:fs/promises';
+import { basename } from 'node:path';
 
-export function createUploadableFile(filePath: string): UploadableFile {
-    const fileSize = statSync(filePath).size;
-    const fileName = path.basename(filePath);
-    return new UploadableFile(fileName, fileSize, fs.createReadStream(filePath));
+export async function createUploadableFile(filePath: string): Promise<UploadableFile> {
+    const fileSize = await stat(filePath).then(stats => stats.size);
+    const fileName = basename(filePath);
+    const readableStream = ReadStream.toWeb(createReadStream(filePath));
+    return new UploadableFile(fileName, fileSize, readableStream);
 }

spec/files/create-symbol-file.ts

@@ -0,0 +1,12 @@
+import { SymbolFile } from '@common';
+import { stat } from 'node:fs/promises';
+import { createUploadableFile } from './create-bugsplat-file';
+
+export async function createSymbolFile(path: string): Promise<SymbolFile> {
+    const uploadableFile = await createUploadableFile(path);
+    const uncompressedSize = await stat(path).then(stats => stats.size);
+    return {
+        ...uploadableFile,
+        uncompressedSize
+    };
+}

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

@@ -5,15 +5,16 @@ import { VersionsApiClient } from '@versions';
 import { firstValueFrom, timer } from 'rxjs';
 import { PostCrashResponse } from 'src/post/post-crash-response';
 import { createUploadableFile } from '../create-bugsplat-file';
+import { createSymbolFile } from '../create-symbol-file';
 
 export async function postNativeCrashAndSymbols(
     authenticatedClient: BugSplatApiClient,
     database: string,
     application: string,
     version: string
 ): Promise<PostCrashResponse> {
-    const exeFile = createUploadableFile('./spec/files/native/myConsoleCrasher.exe');
-    const pdbFile = createUploadableFile('./spec/files/native/myConsoleCrasher.pdb');
+    const exeFile = await createSymbolFile('./spec/files/native/myConsoleCrasher.exe');
+    const pdbFile = await createSymbolFile('./spec/files/native/myConsoleCrasher.pdb');
     const files = [exeFile, pdbFile];
     const symbolsApiClient = new VersionsApiClient(authenticatedClient);
     await symbolsApiClient.postSymbols(
@@ -31,7 +32,7 @@ export async function postNativeCrash(
     application: string,
     version: string
 ): Promise<PostCrashResponse> {
-    const crashFile = createUploadableFile('./spec/files/native/myConsoleCrasher.zip');
+    const crashFile = await createUploadableFile('./spec/files/native/myConsoleCrasher.zip');
     const crashPostClient = new CrashPostClient(database);
     await firstValueFrom(timer(2000)); // Prevent rate-limiting
     const postCrashResult = await crashPostClient.postCrash(
@@ -81,4 +82,4 @@ export async function postNativeCrashAndWaitForCrashToProcess(
         crashId,
         stackKeyId
     };
-}
+}

src/common/file/bugsplat-file.ts

@@ -1,9 +1,9 @@
-import type fs from 'fs';
+import type { ReadableStream } from 'node:stream/web';
 
 export class UploadableFile {
     constructor(
         public readonly name: string,
         public readonly size: number,
-        public readonly file: File | fs.ReadStream | Buffer
+        public readonly file: File | Buffer | ReadableStream
     ) { }
 }

src/common/file/index.ts

@@ -0,0 +1,2 @@
+export { UploadableFile } from './bugsplat-file';
+export { GZippedSymbolFile, SymbolFile } from './symbol-file';

src/common/file/symbol-file.ts

@@ -0,0 +1,5 @@
+import { UploadableFile } from '@common';
+import type { ReadableStream } from 'node:stream/web';
+
+export type SymbolFile = UploadableFile & { dbgId?: string, lastModified?: Date, moduleName?: string, uncompressedSize: number };
+export type GZippedSymbolFile = Omit<Required<SymbolFile>, 'file'> &  { file: ReadableStream };

src/common/index.ts

@@ -1,5 +1,6 @@
 export * from './client';
 export * from './data';
-export { bugsplatAppHostUrl } from './host';
-export { UploadableFile } from './file/bugsplat-file';
 export { Environment } from './environment';
+export * from './file';
+export { bugsplatAppHostUrl } from './host';
+

src/index.ts

@@ -4,4 +4,5 @@ export * from './crashes';
 export * from './events';
 export * from './post';
 export * from './summary';
-export * from './versions';
+export * from './versions';
+export * from './symbols';

src/post/crash-post-client.e2e.ts

@@ -11,7 +11,7 @@ describe('CrashPostClient', () => {
             const application = 'myConsoleCrasher';
             const version = `${Math.random() * 1000000}`;
             const md5 = 'ebe24c1cd1a0912904658fa4fad2b539';
-            const crashFile = createUploadableFile('spec/files/native/myConsoleCrasher.zip');
+            const crashFile = await createUploadableFile('spec/files/native/myConsoleCrasher.zip');
             const crashPostClient = new CrashPostClient(config.database);
             const result = await crashPostClient.postCrash(
                 application,