Make search a post request

packages/server/src/api/controllers/row/views.ts

@@ -1,14 +1,8 @@
 import { quotas } from "@budibase/pro"
-import {
-  UserCtx,
-  SearchResponse,
-  SortOrder,
-  SortType,
-  ViewV2,
-} from "@budibase/types"
+import { UserCtx, SearchResponse, ViewV2, SearchRequest } from "@budibase/types"
 import sdk from "../../../sdk"
 
-export async function searchView(ctx: UserCtx<void, SearchResponse>) {
+export async function searchView(ctx: UserCtx<SearchRequest, SearchResponse>) {
   const { viewId } = ctx.params
 
   const view = await sdk.views.get(viewId)
@@ -35,7 +29,7 @@ export async function searchView(ctx: UserCtx<void, SearchResponse>) {
         tableId: view.tableId,
         query: view.query || {},
         fields: viewFields,
-        ...getSortOptions(ctx, view),
+        ...getSortOptions(ctx.request.body, view),
       }),
     {
       datasourceId: view.tableId,
@@ -46,32 +40,12 @@ export async function searchView(ctx: UserCtx<void, SearchResponse>) {
   ctx.body = result
 }
 
-function getSortOptions(
-  ctx: UserCtx,
-  view: ViewV2
-):
-  | {
-      sort: string
-      sortOrder?: SortOrder
-      sortType?: SortType
-    }
-  | undefined {
-  const { sort_column, sort_order, sort_type } = ctx.query
-  if (Array.isArray(sort_column)) {
-    ctx.throw(400, "sort_column cannot be an array")
-  }
-  if (Array.isArray(sort_order)) {
-    ctx.throw(400, "sort_order cannot be an array")
-  }
-  if (Array.isArray(sort_type)) {
-    ctx.throw(400, "sort_type cannot be an array")
-  }
-
-  if (sort_column) {
+function getSortOptions(request: SearchRequest, view: ViewV2) {
+  if (request.sort?.column) {
     return {
-      sort: sort_column,
-      sortOrder: sort_order as SortOrder,
-      sortType: sort_type as SortType,
+      sort: request.sort.column,
+      sortOrder: request.sort.order,
+      sortType: request.sort.type,
     }
   }
   if (view.sort) {
@@ -82,5 +56,5 @@ function getSortOptions(
     }
   }
 
-  return
+  return undefined
 }

packages/server/src/api/routes/row.ts

@@ -269,7 +269,7 @@ router
   )
 
 router
-  .get(
+  .post(
     "/api/v2/views/:viewId/search",
     authorized(PermissionType.VIEW, PermissionLevel.READ),
     rowController.views.searchView

packages/server/src/tests/utilities/api/viewV2.ts

@@ -1,13 +1,12 @@
 import {
   CreateViewRequest,
-  SortOrder,
-  SortType,
   UpdateViewRequest,
   DeleteRowRequest,
   PatchRowRequest,
   PatchRowResponse,
   Row,
   ViewV2,
+  SearchRequest,
 } from "@budibase/types"
 import TestConfiguration from "../TestConfiguration"
 import { TestAPI } from "./base"
@@ -81,31 +80,12 @@ export class ViewV2API extends TestAPI {
 
   search = async (
     viewId: string,
-    options?: {
-      sort: {
-        column: string
-        order?: SortOrder
-        type?: SortType
-      }
-    },
+    params?: SearchRequest,
     { expectStatus } = { expectStatus: 200 }
   ) => {
-    const qs: [string, any][] = []
-    if (options?.sort.column) {
-      qs.push(["sort_column", options.sort.column])
-    }
-    if (options?.sort.order) {
-      qs.push(["sort_order", options.sort.order])
-    }
-    if (options?.sort.type) {
-      qs.push(["sort_type", options.sort.type])
-    }
-    let url = `/api/v2/views/${viewId}/search`
-    if (qs.length) {
-      url += "?" + qs.map(q => q.join("=")).join("&")
-    }
     return this.request
-      .get(url)
+      .post(`/api/v2/views/${viewId}/search`)
+      .send(params)
       .set(this.config.defaultHeaders())
       .expect("Content-Type", /json/)
       .expect(expectStatus)

packages/types/src/api/web/app/rows.ts

@@ -1,4 +1,5 @@
 import { Row } from "../../../documents"
+import { SortOrder, SortType } from "../pagination"
 
 export interface PatchRowRequest extends Row {
   _id: string
@@ -8,6 +9,14 @@ export interface PatchRowRequest extends Row {
 
 export interface PatchRowResponse extends Row {}
 
+export interface SearchRequest {
+  sort?: {
+    column: string
+    order?: SortOrder
+    type?: SortType
+  }
+}
+
 export interface SearchResponse {
   rows: any[]
 }