From 3203cc3d72b8a95e4bc5e02bac1df7d1d52ab4c9 Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Wed, 28 Feb 2024 16:27:14 +0000
Subject: [PATCH] Convert TableAPI.

---
 .../server/src/api/routes/tests/table.spec.ts |  8 +--
 .../server/src/tests/utilities/api/base.ts    | 65 +++++++++++++++++-
 .../server/src/tests/utilities/api/table.ts   | 67 ++++---------------
 3 files changed, 81 insertions(+), 59 deletions(-)

diff --git a/packages/server/src/api/routes/tests/table.spec.ts b/packages/server/src/api/routes/tests/table.spec.ts
index ce119e56f0..4c83237a49 100644
--- a/packages/server/src/api/routes/tests/table.spec.ts
+++ b/packages/server/src/api/routes/tests/table.spec.ts
@@ -831,7 +831,7 @@ describe("/tables", () => {
               subtype: FieldSubtype.USERS,
             },
           },
-          { expectStatus: 400 }
+          { status: 400 }
         )
       })
 
@@ -846,7 +846,7 @@ describe("/tables", () => {
               subtype: FieldSubtype.USERS,
             },
           },
-          { expectStatus: 400 }
+          { status: 400 }
         )
       })
 
@@ -861,7 +861,7 @@ describe("/tables", () => {
               subtype: FieldSubtype.USERS,
             },
           },
-          { expectStatus: 400 }
+          { status: 400 }
         )
       })
 
@@ -880,7 +880,7 @@ describe("/tables", () => {
               subtype: FieldSubtype.USERS,
             },
           },
-          { expectStatus: 400 }
+          { status: 400 }
         )
       })
     })
diff --git a/packages/server/src/tests/utilities/api/base.ts b/packages/server/src/tests/utilities/api/base.ts
index 34120277c0..61f2c64610 100644
--- a/packages/server/src/tests/utilities/api/base.ts
+++ b/packages/server/src/tests/utilities/api/base.ts
@@ -2,7 +2,7 @@ import TestConfiguration from "../TestConfiguration"
 import { SuperTest, Test } from "supertest"
 
 export interface TestAPIOpts {
-  headers?: any
+  headers?: Record<string, string | string[] | undefined>
   status?: number
 }
 
@@ -14,4 +14,67 @@ export abstract class TestAPI {
     this.config = config
     this.request = config.request!
   }
+
+  protected _get = async <T>(
+    url: string,
+    opts: TestAPIOpts = {}
+  ): Promise<T> => {
+    return await this._request<T>("get", url, undefined, opts)
+  }
+
+  protected _post = async <T>(
+    url: string,
+    body: Record<string, any>,
+    opts: TestAPIOpts = {}
+  ): Promise<T> => {
+    return await this._request<T>("post", url, body, opts)
+  }
+
+  protected _put = async <T>(
+    url: string,
+    body: Record<string, any>,
+    opts: TestAPIOpts = {}
+  ): Promise<T> => {
+    return await this._request<T>("put", url, body, opts)
+  }
+
+  protected _patch = async <T>(
+    url: string,
+    body: Record<string, any>,
+    opts: TestAPIOpts = {}
+  ): Promise<T> => {
+    return await this._request<T>("patch", url, body, opts)
+  }
+
+  protected _delete = async <T>(
+    url: string,
+    body: Record<string, any>,
+    opts: TestAPIOpts = {}
+  ): Promise<T> => {
+    return await this._request<T>("delete", url, body, opts)
+  }
+
+  protected _request = async <T>(
+    method: "get" | "post" | "put" | "patch" | "delete",
+    url: string,
+    body?: Record<string, any>,
+    opts: TestAPIOpts = {}
+  ): Promise<T> => {
+    const { headers = {}, status = 200 } = opts
+    const response = await this.request[method](url)
+      .send(body)
+      .set(this.config.defaultHeaders())
+      .set(headers)
+      .expect("Content-Type", /json/)
+
+    if (response.status !== status) {
+      throw new Error(
+        `Expected status ${status} but got ${
+          response.status
+        } with body ${JSON.stringify(response.body)}`
+      )
+    }
+
+    return response.body as T
+  }
 }
diff --git a/packages/server/src/tests/utilities/api/table.ts b/packages/server/src/tests/utilities/api/table.ts
index 5a9654e3bc..d2f16e0e1b 100644
--- a/packages/server/src/tests/utilities/api/table.ts
+++ b/packages/server/src/tests/utilities/api/table.ts
@@ -5,74 +5,33 @@ import {
   SaveTableResponse,
   Table,
 } from "@budibase/types"
-import TestConfiguration from "../TestConfiguration"
-import { TestAPI } from "./base"
+import { TestAPI, TestAPIOpts } from "./base"
 
 export class TableAPI extends TestAPI {
-  constructor(config: TestConfiguration) {
-    super(config)
-  }
-
   save = async (
     data: SaveTableRequest,
-    { expectStatus } = { expectStatus: 200 }
+    opts?: TestAPIOpts
   ): Promise<SaveTableResponse> => {
-    const res = await this.request
-      .post(`/api/tables`)
-      .send(data)
-      .set(this.config.defaultHeaders())
-      .expect("Content-Type", /json/)
-
-    if (res.status !== expectStatus) {
-      throw new Error(
-        `Expected status ${expectStatus} but got ${
-          res.status
-        } with body ${JSON.stringify(res.body)}`
-      )
-    }
-
-    return res.body
+    return await this._post<SaveTableResponse>("/api/tables", data, opts)
   }
 
-  fetch = async (
-    { expectStatus } = { expectStatus: 200 }
-  ): Promise<Table[]> => {
-    const res = await this.request
-      .get(`/api/tables`)
-      .set(this.config.defaultHeaders())
-      .expect("Content-Type", /json/)
-      .expect(expectStatus)
-    return res.body
+  fetch = async (opts?: TestAPIOpts): Promise<Table[]> => {
+    return await this._get<Table[]>("/api/tables", opts)
   }
 
-  get = async (
-    tableId: string,
-    { expectStatus } = { expectStatus: 200 }
-  ): Promise<Table> => {
-    const res = await this.request
-      .get(`/api/tables/${tableId}`)
-      .set(this.config.defaultHeaders())
-      .expect("Content-Type", /json/)
-      .expect(expectStatus)
-    return res.body
+  get = async (tableId: string, opts?: TestAPIOpts): Promise<Table> => {
+    return await this._get<Table>(`/api/tables/${tableId}`, opts)
   }
 
   migrate = async (
     tableId: string,
     data: MigrateRequest,
-    { expectStatus } = { expectStatus: 200 }
+    opts?: TestAPIOpts
   ): Promise<MigrateResponse> => {
-    const res = await this.request
-      .post(`/api/tables/${tableId}/migrate`)
-      .send(data)
-      .set(this.config.defaultHeaders())
-    if (res.status !== expectStatus) {
-      throw new Error(
-        `Expected status ${expectStatus} but got ${
-          res.status
-        } with body ${JSON.stringify(res.body)}`
-      )
-    }
-    return res.body
+    return await this._post<MigrateResponse>(
+      `/api/tables/${tableId}/migrate`,
+      data,
+      opts
+    )
   }
 }