From cf74f19381d8341c6fe4658658b0ac82c3072b46 Mon Sep 17 00:00:00 2001
From: Adria Navarro <adria@budibase.com>
Date: Wed, 13 Sep 2023 10:13:54 +0200
Subject: [PATCH] Use test api

---
 .../server/src/api/controllers/row/index.ts   |  6 ++-
 .../server/src/api/routes/tests/row.spec.ts   | 42 +++++++------------
 .../server/src/tests/utilities/api/row.ts     | 17 +++++++-
 packages/types/src/api/web/app/rows.ts        | 11 ++++-
 4 files changed, 46 insertions(+), 30 deletions(-)

diff --git a/packages/server/src/api/controllers/row/index.ts b/packages/server/src/api/controllers/row/index.ts
index e86b466601..f0f2462019 100644
--- a/packages/server/src/api/controllers/row/index.ts
+++ b/packages/server/src/api/controllers/row/index.ts
@@ -16,6 +16,8 @@ import {
   SearchParams,
   GetRowResponse,
   ValidateResponse,
+  ExportRowsRequest,
+  ExportRowsResponse,
 } from "@budibase/types"
 import * as utils from "./utils"
 import { gridSocket } from "../../../websockets"
@@ -239,7 +241,9 @@ export async function fetchEnrichedRow(ctx: any) {
   )
 }
 
-export const exportRows = async (ctx: any) => {
+export const exportRows = async (
+  ctx: Ctx<ExportRowsRequest, ExportRowsResponse>
+) => {
   const tableId = utils.getTableId(ctx)
 
   const format = ctx.query.format
diff --git a/packages/server/src/api/routes/tests/row.spec.ts b/packages/server/src/api/routes/tests/row.spec.ts
index 6a7a0210ef..09cc2d1888 100644
--- a/packages/server/src/api/routes/tests/row.spec.ts
+++ b/packages/server/src/api/routes/tests/row.spec.ts
@@ -771,11 +771,10 @@ describe.each([
       const queryUsage = await getQueryUsage()
 
       // test basic enrichment
-      const resBasic = await request
-        .get(`/api/${linkedTable._id}/rows/${secondRow._id}`)
-        .set(config.defaultHeaders())
-        .expect("Content-Type", /json/)
-        .expect(200)
+      const resBasic = await config.api.row.get(
+        linkedTable._id!,
+        secondRow._id!
+      )
       expect(resBasic.body.link.length).toBe(1)
       expect(resBasic.body.link[0]).toEqual({
         _id: firstRow._id,
@@ -783,11 +782,10 @@ describe.each([
       })
 
       // test full enrichment
-      const resEnriched = await request
-        .get(`/api/${linkedTable._id}/${secondRow._id}/enrich`)
-        .set(config.defaultHeaders())
-        .expect("Content-Type", /json/)
-        .expect(200)
+      const resEnriched = await config.api.row.getEnriched(
+        linkedTable._id!,
+        secondRow._id!
+      )
       expect(resEnriched.body.link.length).toBe(1)
       expect(resEnriched.body.link[0]._id).toBe(firstRow._id)
       expect(resEnriched.body.link[0].name).toBe("Test Contact")
@@ -837,14 +835,9 @@ describe.each([
 
     it("should allow exporting all columns", async () => {
       const existing = await config.createRow()
-      const res = await request
-        .post(`/api/${table._id}/rows/exportRows?format=json`)
-        .set(config.defaultHeaders())
-        .send({
-          rows: [existing._id],
-        })
-        .expect("Content-Type", /json/)
-        .expect(200)
+      const res = await config.api.row.exportRows(table._id!, {
+        rows: [existing._id!],
+      })
       const results = JSON.parse(res.text)
       expect(results.length).toEqual(1)
       const row = results[0]
@@ -860,15 +853,10 @@ describe.each([
 
     it("should allow exporting only certain columns", async () => {
       const existing = await config.createRow()
-      const res = await request
-        .post(`/api/${table._id}/rows/exportRows?format=json`)
-        .set(config.defaultHeaders())
-        .send({
-          rows: [existing._id],
-          columns: ["_id"],
-        })
-        .expect("Content-Type", /json/)
-        .expect(200)
+      const res = await config.api.row.exportRows(table._id!, {
+        rows: [existing._id!],
+        columns: ["_id"],
+      })
       const results = JSON.parse(res.text)
       expect(results.length).toEqual(1)
       const row = results[0]
diff --git a/packages/server/src/tests/utilities/api/row.ts b/packages/server/src/tests/utilities/api/row.ts
index 2338285ed4..686c8c031b 100644
--- a/packages/server/src/tests/utilities/api/row.ts
+++ b/packages/server/src/tests/utilities/api/row.ts
@@ -3,6 +3,7 @@ import {
   SaveRowRequest,
   Row,
   ValidateResponse,
+  ExportRowsRequest,
 } from "@budibase/types"
 import TestConfiguration from "../TestConfiguration"
 import { TestAPI } from "./base"
@@ -33,7 +34,7 @@ export class RowAPI extends TestAPI {
     { expectStatus } = { expectStatus: 200 }
   ) => {
     const request = this.request
-      .get(`/api/${sourceId}/rows/${rowId}/enrich`)
+      .get(`/api/${sourceId}/${rowId}/enrich`)
       .set(this.config.defaultHeaders())
       .expect(expectStatus)
     if (expectStatus !== 404) {
@@ -107,4 +108,18 @@ export class RowAPI extends TestAPI {
 
     return (await request).body
   }
+
+  exportRows = async (
+    tableId: string,
+    body: ExportRowsRequest,
+    { expectStatus } = { expectStatus: 200 }
+  ) => {
+    const request = this.request
+      .post(`/api/${tableId}/rows/exportRows?format=json`)
+      .set(this.config.defaultHeaders())
+      .send(body)
+      .expect("Content-Type", /json/)
+      .expect(expectStatus)
+    return request
+  }
 }
diff --git a/packages/types/src/api/web/app/rows.ts b/packages/types/src/api/web/app/rows.ts
index a99ef0e837..62ea90a6a4 100644
--- a/packages/types/src/api/web/app/rows.ts
+++ b/packages/types/src/api/web/app/rows.ts
@@ -1,5 +1,6 @@
-import { SearchParams } from "../../../sdk"
+import { SearchFilters, SearchParams } from "../../../sdk"
 import { Row } from "../../../documents"
+import { ReadStream } from "fs"
 
 export interface SaveRowRequest extends Row {}
 
@@ -28,3 +29,11 @@ export interface SearchViewRowRequest
 export interface SearchRowResponse {
   rows: any[]
 }
+
+export interface ExportRowsRequest {
+  rows: string[]
+  columns?: string[]
+  query?: SearchFilters
+}
+
+export type ExportRowsResponse = ReadStream