rework xhr transport test

Author: Lms24

packages/browser/src/transports/new-xhr.ts

@@ -9,8 +9,8 @@ import { SyncPromise } from '@sentry/utils';
 
 export interface XHRTransportOptions extends BaseTransportOptions {
   // TODO choose whatever is preferred here (I like record more for easier readability)
-  headers?: { [key: string]: string };
-  // headers?: Record<string, string>;
+  //headers?: { [key: string]: string };
+  headers?: Record<string, string>;
 }
 
 /**
@@ -22,6 +22,7 @@ export function makeNewXHRTransport(options: XHRTransportOptions): NewTransport
       const xhr = new XMLHttpRequest();
 
       xhr.onreadystatechange = (): void => {
+        // TODO make 4 a constant
         if (xhr.readyState === 4) {
           const response = {
             body: xhr.response,
@@ -33,7 +34,6 @@ export function makeNewXHRTransport(options: XHRTransportOptions): NewTransport
             statusCode: xhr.status,
           };
 
-          // TODO when to reject? is it necessary at all, given that createTransport handles rejections?
           resolve(response);
         }
       };

packages/browser/test/unit/transports/new-xhr.test.ts

@@ -33,33 +33,40 @@ function createXHRMock() {
     },
   };
 
-  //@ts-ignore
+  //@ts-ignore because TS thinks window doesn't have XMLHttpRequest
   jest.spyOn(window, 'XMLHttpRequest').mockImplementation(() => xhrMock as XMLHttpRequest);
 
   return xhrMock;
 }
 
 describe('NewXHRTransport', () => {
-  it('makes an XHR request to the given URL', done => {
-    const xhrMock: Partial<XMLHttpRequest> = createXHRMock();
+  const xhrMock: Partial<XMLHttpRequest> = createXHRMock();
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
 
+  afterAll(() => {
+    jest.restoreAllMocks();
+  });
+
+  it('makes an XHR request to the given URL', done => {
     const transport = makeNewXHRTransport(DEFAULT_XHR_TRANSPORT_OPTIONS);
     expect(xhrMock.open).toHaveBeenCalledTimes(0);
     expect(xhrMock.setRequestHeader).toHaveBeenCalledTimes(0);
     expect(xhrMock.send).toHaveBeenCalledTimes(0);
 
-    transport.send(ERROR_ENVELOPE).then(res => {
-      expect(xhrMock.open).toHaveBeenCalledTimes(1);
-      expect(xhrMock.open).toHaveBeenCalledWith('POST', DEFAULT_XHR_TRANSPORT_OPTIONS.url);
-      expect(xhrMock.send).toBeCalledWith(serializeEnvelope(ERROR_ENVELOPE));
-
-      expect(res).toBeTruthy;
-      expect(res.status).toEqual('success');
+    Promise.all([transport.send(ERROR_ENVELOPE), (xhrMock as XMLHttpRequest).onreadystatechange(null)]).then(
+      ([res]) => {
+        expect(xhrMock.open).toHaveBeenCalledTimes(1);
+        expect(xhrMock.open).toHaveBeenCalledWith('POST', DEFAULT_XHR_TRANSPORT_OPTIONS.url);
+        expect(xhrMock.send).toBeCalledWith(serializeEnvelope(ERROR_ENVELOPE));
 
-      done();
-    });
+        expect(res).toBeDefined();
+        expect(res.status).toEqual('success');
 
-    //@ts-ignore
-    xhrMock.onreadystatechange();
+        done();
+      },
+    );
   });
 });