Supertest augmented assert

app/api/utils/specs/supertestExtensions.spec.ts

@@ -0,0 +1,29 @@
+// @ts-ignore
+import Test from 'supertest/lib/test';
+import { extendSupertest } from '../supertestExtensions';
+
+describe('assertStatus', () => {
+  const mockError = new Error('mock error');
+  const assertStatusMock = jest.fn().mockReturnValue(mockError);
+  beforeEach(() => {
+    Test.prototype._assertStatus = assertStatusMock;
+    extendSupertest();
+  });
+
+  it('should use the original method', () => {
+    const result = Test.prototype._assertStatus(0, {});
+    expect(assertStatusMock).toHaveBeenCalledWith(0, {});
+    expect(result).toBe(mockError);
+  });
+
+  describe('when the assert fails', () => {
+    it('should add the body for a 400 code', async () => {
+      const result = Test.prototype._assertStatus(200, {
+        status: 400,
+        text: JSON.stringify('validation error'),
+      });
+      await expect(result.message).toMatch('validation error');
+      expect(result.stack).toBeUndefined();
+    });
+  });
+});

app/api/utils/supertestExtensions.ts

@@ -0,0 +1,24 @@
+import { Response } from 'supertest';
+// @ts-ignore
+import Test from 'supertest/lib/test';
+
+function extractStatusDebugInfo(res: Response): string {
+  try {
+    return JSON.stringify(JSON.parse(res.text), null, 2);
+  } catch (e) {
+    return res.text;
+  }
+}
+
+export function extendSupertest() {
+  const { _assertStatus } = Test.prototype;
+
+  Test.prototype._assertStatus = function extendedAssertStatus(status: number, res: Response) {
+    const err: Error = _assertStatus(status, res);
+    if (err) {
+      err.message += `\n ${extractStatusDebugInfo(res)}`;
+      delete err.stack;
+    }
+    return err;
+  };
+}

app/api/utils/testingRoutes.ts

@@ -4,6 +4,9 @@ import { Response as SuperTestResponse } from 'supertest';
 
 import errorHandlingMiddleware from 'api/utils/error_handling_middleware';
 import languageMiddleware from 'api/utils/languageMiddleware';
+import { extendSupertest } from './supertestExtensions';
+
+extendSupertest();
 
 const iosocket = jasmine.createSpyObj('socket', ['emit']);