budibase/packages/server/src/api/routes/tests/viewV2.spec.ts

1138 lines
30 KiB
TypeScript
Raw Normal View History

2023-07-12 16:13:00 +02:00
import * as setup from "./utilities"
2023-07-19 15:43:21 +02:00
import {
CreateViewRequest,
Datasource,
2023-08-01 12:08:40 +02:00
FieldSchema,
2023-07-19 15:43:21 +02:00
FieldType,
INTERNAL_TABLE_SOURCE_ID,
PermissionLevel,
QuotaUsageType,
SaveTableRequest,
SearchFilterOperator,
2023-07-19 15:43:21 +02:00
SortOrder,
SortType,
StaticQuotaName,
2023-07-19 15:43:21 +02:00
Table,
TableSourceType,
2023-09-12 20:17:21 +02:00
UIFieldMetadata,
2023-08-02 13:37:58 +02:00
UpdateViewRequest,
2023-07-19 15:43:21 +02:00
ViewV2,
} from "@budibase/types"
import { generator, mocks } from "@budibase/backend-core/tests"
import { DatabaseName, getDatasource } from "../../../integrations/tests/utils"
import merge from "lodash/merge"
import { quotas } from "@budibase/pro"
import { roles } from "@budibase/backend-core"
2024-05-27 13:39:43 +02:00
import * as schemaUtils from "../../../utilities/schema"
jest.mock("../../../utilities/schema", () => {
return {
__esModule: true,
...jest.requireActual("../../../utilities/schema"),
}
})
2023-07-12 16:13:00 +02:00
2023-08-29 16:13:44 +02:00
describe.each([
["internal", undefined],
[DatabaseName.POSTGRES, getDatasource(DatabaseName.POSTGRES)],
[DatabaseName.MYSQL, getDatasource(DatabaseName.MYSQL)],
[DatabaseName.SQL_SERVER, getDatasource(DatabaseName.SQL_SERVER)],
[DatabaseName.MARIADB, getDatasource(DatabaseName.MARIADB)],
])("/v2/views (%s)", (_, dsProvider) => {
const config = setup.getConfig()
const isInternal = !dsProvider
2023-07-12 16:13:00 +02:00
2023-08-29 16:13:44 +02:00
let table: Table
let datasource: Datasource
function saveTableRequest(
...overrides: Partial<Omit<SaveTableRequest, "name">>[]
): SaveTableRequest {
const req: SaveTableRequest = {
name: generator.guid().replaceAll("-", "").substring(0, 16),
type: "table",
sourceType: datasource
? TableSourceType.EXTERNAL
: TableSourceType.INTERNAL,
sourceId: datasource ? datasource._id! : INTERNAL_TABLE_SOURCE_ID,
primary: ["id"],
schema: {
id: {
type: FieldType.AUTO,
name: "id",
autocolumn: true,
constraints: {
presence: true,
},
},
},
}
return merge(req, ...overrides)
}
function priceTable(): SaveTableRequest {
return saveTableRequest({
schema: {
Price: {
type: FieldType.NUMBER,
name: "Price",
constraints: {},
},
Category: {
type: FieldType.STRING,
name: "Category",
constraints: {
type: "string",
},
},
},
})
}
2023-07-12 16:13:00 +02:00
beforeAll(async () => {
await config.init()
if (dsProvider) {
datasource = await config.createDatasource({
datasource: await dsProvider,
})
}
table = await config.api.table.save(priceTable())
2023-07-12 16:13:00 +02:00
})
afterAll(async () => {
setup.afterAll()
})
2023-08-29 16:13:44 +02:00
const getRowUsage = async () => {
const { total } = await config.doInContext(undefined, () =>
quotas.getCurrentUsageValues(QuotaUsageType.STATIC, StaticQuotaName.ROWS)
)
return total
}
const assertRowUsage = async (expected: number) => {
const usage = await getRowUsage()
expect(usage).toBe(expected)
}
2023-07-12 16:13:00 +02:00
describe("create", () => {
it("persist the view when the view is successfully created", async () => {
2023-07-19 15:43:21 +02:00
const newView: CreateViewRequest = {
2023-07-18 10:14:13 +02:00
name: generator.name(),
2023-08-29 16:13:44 +02:00
tableId: table._id!,
2023-07-18 10:14:13 +02:00
}
2023-07-19 18:26:24 +02:00
const res = await config.api.viewV2.create(newView)
2023-07-12 16:13:00 +02:00
2023-07-19 12:38:01 +02:00
expect(res).toEqual({
...newView,
2023-08-29 16:13:44 +02:00
id: expect.stringMatching(new RegExp(`${table._id!}_`)),
2023-07-19 15:43:21 +02:00
version: 2,
2023-07-12 16:13:00 +02:00
})
})
2023-07-18 14:34:23 +02:00
2023-08-02 13:37:58 +02:00
it("can persist views with all fields", async () => {
const newView: Required<CreateViewRequest> = {
2023-07-18 14:34:23 +02:00
name: generator.name(),
2023-08-29 16:13:44 +02:00
tableId: table._id!,
2023-08-02 13:37:58 +02:00
primaryDisplay: generator.word(),
query: [
{
operator: SearchFilterOperator.EQUAL,
field: "field",
value: "value",
},
],
2023-08-02 13:37:58 +02:00
sort: {
field: "fieldToSort",
order: SortOrder.DESCENDING,
type: SortType.STRING,
},
schema: {
2024-05-24 16:07:07 +02:00
Price: {
2023-08-02 13:37:58 +02:00
visible: true,
},
},
2023-07-18 14:34:23 +02:00
}
2023-07-19 18:26:24 +02:00
const res = await config.api.viewV2.create(newView)
2023-07-18 14:34:23 +02:00
2023-07-19 12:50:52 +02:00
expect(res).toEqual({
...newView,
2024-05-24 16:07:07 +02:00
schema: {
Price: {
visible: true,
},
},
2023-07-19 15:43:21 +02:00
id: expect.any(String),
version: 2,
2023-07-18 14:34:23 +02:00
})
})
2023-08-01 10:45:00 +02:00
2023-08-01 10:57:03 +02:00
it("persist only UI schema overrides", async () => {
2023-08-01 10:45:00 +02:00
const newView: CreateViewRequest = {
name: generator.name(),
2023-08-29 16:13:44 +02:00
tableId: table._id!,
2023-08-01 10:45:00 +02:00
schema: {
Price: {
name: "Price",
type: FieldType.NUMBER,
2023-08-01 10:45:00 +02:00
visible: true,
2023-08-01 10:57:03 +02:00
order: 1,
width: 100,
2023-08-01 10:45:00 +02:00
},
Category: {
name: "Category",
2023-08-01 10:45:00 +02:00
type: FieldType.STRING,
visible: false,
2023-08-01 10:57:03 +02:00
icon: "ic",
2023-08-01 10:45:00 +02:00
},
2023-08-01 12:08:40 +02:00
} as Record<string, FieldSchema>,
2023-08-01 10:45:00 +02:00
}
const createdView = await config.api.viewV2.create(newView)
expect(createdView).toEqual({
2023-08-01 10:45:00 +02:00
...newView,
schema: {
Price: {
2023-08-01 10:45:00 +02:00
visible: true,
2023-08-01 10:57:03 +02:00
order: 1,
width: 100,
2023-08-01 10:45:00 +02:00
},
},
id: createdView.id,
version: 2,
})
})
it("will not throw an exception if the schema is 'deleting' non UI fields", async () => {
const newView: CreateViewRequest = {
name: generator.name(),
2023-08-29 16:13:44 +02:00
tableId: table._id!,
schema: {
Price: {
name: "Price",
type: FieldType.NUMBER,
visible: true,
},
Category: {
name: "Category",
type: FieldType.STRING,
},
2023-08-01 12:08:40 +02:00
} as Record<string, FieldSchema>,
}
await config.api.viewV2.create(newView, {
2024-03-01 18:35:51 +01:00
status: 201,
})
})
2024-05-24 16:15:24 +02:00
it("does not persist non-visible fields", async () => {
const newView: CreateViewRequest = {
name: generator.name(),
tableId: table._id!,
primaryDisplay: generator.word(),
schema: {
Price: { visible: true },
Category: { visible: false },
},
}
const res = await config.api.viewV2.create(newView)
expect(res).toEqual({
...newView,
schema: {
Price: {
visible: true,
},
},
id: expect.any(String),
version: 2,
})
})
it("throws bad request when the schema fields are not valid", async () => {
const newView: CreateViewRequest = {
name: generator.name(),
tableId: table._id!,
schema: {
nonExisting: {
visible: true,
},
},
}
await config.api.viewV2.create(newView, {
status: 400,
body: {
message: 'Field "nonExisting" is not valid for the requested table',
},
})
})
2024-05-27 13:39:43 +02:00
2024-05-27 13:59:39 +02:00
it("readonly fields are persisted", async () => {
const table = await config.api.table.save(
saveTableRequest({
schema: {
name: {
name: "name",
type: FieldType.STRING,
},
description: {
name: "description",
type: FieldType.STRING,
},
},
})
)
const newView: CreateViewRequest = {
name: generator.name(),
tableId: table._id!,
schema: {
name: {
visible: true,
readonly: true,
},
description: {
readonly: true,
},
},
}
const res = await config.api.viewV2.create(newView)
expect(res.schema).toEqual({
name: {
visible: true,
readonly: true,
},
description: {
readonly: true,
},
})
})
2024-05-27 13:39:43 +02:00
it("required fields cannot be marked as readonly", async () => {
const isRequiredSpy = jest.spyOn(schemaUtils, "isRequired")
2024-05-27 14:11:50 +02:00
isRequiredSpy.mockReturnValueOnce(true)
2024-05-27 13:39:43 +02:00
const table = await config.api.table.save(
saveTableRequest({
schema: {
name: {
name: "name",
type: FieldType.STRING,
},
description: {
name: "description",
type: FieldType.STRING,
},
},
})
)
const newView: CreateViewRequest = {
name: generator.name(),
tableId: table._id!,
schema: {
name: {
readonly: true,
},
},
}
await config.api.viewV2.create(newView, {
status: 400,
body: {
message: 'Field "name" cannot be readonly as it is a required field',
status: 400,
},
})
})
2023-07-12 16:13:00 +02:00
})
2023-07-12 18:09:13 +02:00
2023-07-25 15:34:25 +02:00
describe("update", () => {
let view: ViewV2
2023-07-25 15:41:04 +02:00
beforeEach(async () => {
table = await config.api.table.save(priceTable())
2023-08-29 16:39:19 +02:00
view = await config.api.viewV2.create({
tableId: table._id!,
name: generator.guid(),
})
2023-07-25 15:34:25 +02:00
})
2023-07-25 15:35:48 +02:00
it("can update an existing view data", async () => {
2023-08-29 16:13:44 +02:00
const tableId = table._id!
2023-07-25 15:35:48 +02:00
await config.api.viewV2.update({
...view,
query: [
{
operator: SearchFilterOperator.EQUAL,
field: "newField",
value: "thatValue",
},
],
2023-07-25 15:35:48 +02:00
})
2023-08-29 16:39:19 +02:00
expect((await config.api.table.get(tableId)).views).toEqual({
[view.name]: {
...view,
query: [{ operator: "equal", field: "newField", value: "thatValue" }],
schema: expect.anything(),
2023-07-25 15:35:48 +02:00
},
2023-08-02 13:37:58 +02:00
})
})
it("can update all fields", async () => {
2023-08-29 16:13:44 +02:00
const tableId = table._id!
2023-08-02 13:37:58 +02:00
const updatedData: Required<UpdateViewRequest> = {
version: view.version,
id: view.id,
tableId,
name: view.name,
primaryDisplay: generator.word(),
2023-08-07 13:16:23 +02:00
query: [
{
operator: SearchFilterOperator.EQUAL,
2023-08-07 13:16:23 +02:00
field: generator.word(),
value: generator.word(),
},
],
2023-08-02 13:37:58 +02:00
sort: {
field: generator.word(),
order: SortOrder.DESCENDING,
type: SortType.STRING,
},
schema: {
Category: {
visible: false,
},
2024-05-27 14:11:50 +02:00
Price: {
visible: true,
readonly: true,
},
2023-08-02 13:37:58 +02:00
},
}
await config.api.viewV2.update(updatedData)
2023-08-29 16:39:19 +02:00
expect((await config.api.table.get(tableId)).views).toEqual({
[view.name]: {
...updatedData,
schema: {
...table.schema,
id: expect.objectContaining({
visible: false,
}),
2023-08-29 16:39:19 +02:00
Category: expect.objectContaining({
visible: false,
}),
Price: expect.objectContaining({
2024-05-27 14:11:50 +02:00
visible: true,
readonly: true,
2023-08-29 16:39:19 +02:00
}),
2023-08-02 13:37:58 +02:00
},
},
2023-07-25 15:35:48 +02:00
})
})
2023-07-25 15:34:25 +02:00
it("can update an existing view name", async () => {
2023-08-29 16:13:44 +02:00
const tableId = table._id!
const newName = generator.guid()
await config.api.viewV2.update({ ...view, name: newName })
2023-07-25 15:34:25 +02:00
2023-07-25 15:41:04 +02:00
expect(await config.api.table.get(tableId)).toEqual(
expect.objectContaining({
views: {
[newName]: { ...view, name: newName, schema: expect.anything() },
2023-07-25 15:41:04 +02:00
},
})
)
})
it("cannot update an unexisting views nor edit ids", async () => {
2023-08-29 16:13:44 +02:00
const tableId = table._id!
2023-07-25 15:41:04 +02:00
await config.api.viewV2.update(
{ ...view, id: generator.guid() },
2024-03-01 18:35:51 +01:00
{ status: 404 }
2023-07-25 15:41:04 +02:00
)
expect(await config.api.table.get(tableId)).toEqual(
expect.objectContaining({
views: {
[view.name]: {
...view,
schema: expect.anything(),
},
},
})
)
})
it("cannot update views with the wrong tableId", async () => {
2023-08-29 16:13:44 +02:00
const tableId = table._id!
2023-07-25 15:41:04 +02:00
await config.api.viewV2.update(
{
...view,
tableId: generator.guid(),
query: [
{
operator: SearchFilterOperator.EQUAL,
field: "newField",
value: "thatValue",
},
],
2023-07-25 15:34:25 +02:00
},
2024-03-01 18:35:51 +01:00
{ status: 404 }
2023-07-25 15:41:04 +02:00
)
expect(await config.api.table.get(tableId)).toEqual(
expect.objectContaining({
views: {
[view.name]: {
...view,
schema: expect.anything(),
},
},
})
)
2023-07-25 15:34:25 +02:00
})
2023-07-25 15:49:32 +02:00
it("cannot update views v1", async () => {
const viewV1 = await config.api.legacyView.save({
tableId: table._id!,
name: generator.guid(),
filters: [],
schema: {},
})
await config.api.viewV2.update(viewV1 as unknown as ViewV2, {
status: 400,
body: {
message: "Only views V2 can be updated",
2024-03-01 18:35:51 +01:00
status: 400,
},
})
2023-07-25 15:49:32 +02:00
})
2023-07-25 19:46:46 +02:00
it("cannot update the a view with unmatching ids between url and body", async () => {
const anotherView = await config.api.viewV2.create({
tableId: table._id!,
name: generator.guid(),
})
2023-07-25 19:46:46 +02:00
const result = await config
.request!.put(`/api/v2/views/${anotherView.id}`)
.send(view)
.set(config.defaultHeaders())
.expect("Content-Type", /json/)
.expect(400)
expect(result.body).toEqual({
message: "View id does not match between the body and the uri path",
status: 400,
})
})
2023-08-01 11:38:36 +02:00
it("updates only UI schema overrides", async () => {
const updatedView = await config.api.viewV2.update({
2023-08-01 11:38:36 +02:00
...view,
schema: {
Price: {
name: "Price",
type: FieldType.NUMBER,
visible: true,
order: 1,
width: 100,
},
Category: {
name: "Category",
type: FieldType.STRING,
visible: false,
icon: "ic",
},
2023-08-01 12:08:40 +02:00
} as Record<string, FieldSchema>,
2023-08-01 11:38:36 +02:00
})
expect(updatedView).toEqual({
2023-08-01 11:38:36 +02:00
...view,
schema: {
2023-08-01 11:38:36 +02:00
Price: {
visible: true,
order: 1,
width: 100,
},
},
id: view.id,
version: 2,
})
})
it("will not throw an exception if the schema is 'deleting' non UI fields", async () => {
await config.api.viewV2.update(
{
...view,
schema: {
Price: {
name: "Price",
type: FieldType.NUMBER,
visible: true,
},
Category: {
name: "Category",
type: FieldType.STRING,
},
2023-08-01 12:08:40 +02:00
} as Record<string, FieldSchema>,
2023-08-01 11:38:36 +02:00
},
{
2024-03-01 18:35:51 +01:00
status: 200,
2023-08-01 11:38:36 +02:00
}
)
})
2023-07-25 15:34:25 +02:00
})
2023-07-12 18:09:13 +02:00
describe("delete", () => {
2023-07-18 09:58:43 +02:00
let view: ViewV2
2023-07-12 18:09:13 +02:00
beforeAll(async () => {
view = await config.api.viewV2.create({
tableId: table._id!,
name: generator.guid(),
})
2023-07-12 18:09:13 +02:00
})
it("can delete an existing view", async () => {
2023-08-29 16:13:44 +02:00
const tableId = table._id!
2023-07-19 15:47:45 +02:00
const getPersistedView = async () =>
(await config.api.table.get(tableId)).views![view.name]
2023-07-12 18:09:13 +02:00
2023-07-19 15:47:45 +02:00
expect(await getPersistedView()).toBeDefined()
2023-07-12 18:09:13 +02:00
2023-07-19 18:02:15 +02:00
await config.api.viewV2.delete(view.id)
2023-07-19 15:47:45 +02:00
expect(await getPersistedView()).toBeUndefined()
2023-07-12 18:09:13 +02:00
})
})
describe("fetch view (through table)", () => {
it("should be able to fetch a view V2", async () => {
const res = await config.api.viewV2.create({
name: generator.name(),
tableId: table._id!,
schema: {
Price: { visible: false },
Category: { visible: true },
},
})
expect(res.schema?.Price).toBeUndefined()
const view = await config.api.viewV2.get(res.id)
2023-09-12 20:17:21 +02:00
const updatedTable = await config.api.table.get(table._id!)
const viewSchema = updatedTable.views![view!.name!].schema as Record<
string,
UIFieldMetadata
>
expect(viewSchema.Price?.visible).toEqual(false)
})
})
describe("read", () => {
it("views have extra data trimmed", async () => {
const table = await config.api.table.save(
saveTableRequest({
schema: {
Country: {
type: FieldType.STRING,
name: "Country",
},
Story: {
type: FieldType.STRING,
name: "Story",
},
},
})
)
const view = await config.api.viewV2.create({
tableId: table._id!,
name: generator.guid(),
schema: {
Country: {
visible: true,
},
},
})
let row = await config.api.row.save(view.id, {
Country: "Aussy",
Story: "aaaaa",
})
row = await config.api.row.get(table._id!, row._id!)
expect(row.Story).toBeUndefined()
expect(row.Country).toEqual("Aussy")
})
})
2024-03-18 10:18:45 +01:00
describe("row operations", () => {
let table: Table, view: ViewV2
beforeEach(async () => {
table = await config.api.table.save(
saveTableRequest({
schema: {
one: { type: FieldType.STRING, name: "one" },
two: { type: FieldType.STRING, name: "two" },
},
})
)
view = await config.api.viewV2.create({
tableId: table._id!,
name: generator.guid(),
schema: {
two: { visible: true },
},
})
})
describe("create", () => {
it("should persist a new row with only the provided view fields", async () => {
const newRow = await config.api.row.save(view.id, {
tableId: table!._id,
_viewId: view.id,
one: "foo",
two: "bar",
})
const row = await config.api.row.get(table._id!, newRow._id!)
expect(row.one).toBeUndefined()
expect(row.two).toEqual("bar")
})
})
describe("patch", () => {
it("should update only the view fields for a row", async () => {
const newRow = await config.api.row.save(table._id!, {
one: "foo",
two: "bar",
})
await config.api.row.patch(view.id, {
tableId: table._id!,
_id: newRow._id!,
_rev: newRow._rev!,
one: "newFoo",
two: "newBar",
})
const row = await config.api.row.get(table._id!, newRow._id!)
expect(row.one).toEqual("foo")
expect(row.two).toEqual("newBar")
})
})
describe("destroy", () => {
it("should be able to delete a row", async () => {
const createdRow = await config.api.row.save(table._id!, {})
const rowUsage = await getRowUsage()
await config.api.row.bulkDelete(view.id, { rows: [createdRow] })
await assertRowUsage(rowUsage - 1)
await config.api.row.get(table._id!, createdRow._id!, {
status: 404,
})
})
it("should be able to delete multiple rows", async () => {
const rows = await Promise.all([
config.api.row.save(table._id!, {}),
config.api.row.save(table._id!, {}),
config.api.row.save(table._id!, {}),
])
const rowUsage = await getRowUsage()
await config.api.row.bulkDelete(view.id, { rows: [rows[0], rows[2]] })
await assertRowUsage(rowUsage - 2)
await config.api.row.get(table._id!, rows[0]._id!, {
status: 404,
})
await config.api.row.get(table._id!, rows[2]._id!, {
status: 404,
})
await config.api.row.get(table._id!, rows[1]._id!, { status: 200 })
})
})
describe("search", () => {
it("returns empty rows from view when no schema is passed", async () => {
const rows = await Promise.all(
Array.from({ length: 10 }, () => config.api.row.save(table._id!, {}))
)
const response = await config.api.viewV2.search(view.id)
expect(response.rows).toHaveLength(10)
expect(response).toEqual({
rows: expect.arrayContaining(
rows.map(r => ({
_viewId: view.id,
tableId: table._id,
_id: r._id,
_rev: r._rev,
...(isInternal
? {
type: "row",
updatedAt: expect.any(String),
createdAt: expect.any(String),
}
: {}),
}))
),
...(isInternal
? {}
: {
hasNextPage: false,
}),
})
})
it("searching respects the view filters", async () => {
await config.api.row.save(table._id!, {
one: "foo",
two: "bar",
})
const two = await config.api.row.save(table._id!, {
one: "foo2",
two: "bar2",
})
const view = await config.api.viewV2.create({
tableId: table._id!,
name: generator.guid(),
query: [
{
operator: SearchFilterOperator.EQUAL,
field: "two",
value: "bar2",
},
],
schema: {
two: { visible: true },
},
})
const response = await config.api.viewV2.search(view.id)
expect(response.rows).toHaveLength(1)
expect(response).toEqual({
rows: expect.arrayContaining([
{
_viewId: view.id,
tableId: table._id,
two: two.two,
_id: two._id,
_rev: two._rev,
...(isInternal
? {
type: "row",
createdAt: expect.any(String),
updatedAt: expect.any(String),
}
: {}),
},
]),
...(isInternal
? {}
: {
hasNextPage: false,
}),
})
})
it("views without data can be returned", async () => {
const response = await config.api.viewV2.search(view.id)
expect(response.rows).toHaveLength(0)
})
it("respects the limit parameter", async () => {
await Promise.all(
Array.from({ length: 10 }, () => config.api.row.save(table._id!, {}))
)
const limit = generator.integer({ min: 1, max: 8 })
const response = await config.api.viewV2.search(view.id, {
limit,
query: {},
})
expect(response.rows).toHaveLength(limit)
})
it("can handle pagination", async () => {
await Promise.all(
Array.from({ length: 10 }, () => config.api.row.save(table._id!, {}))
)
const rows = (await config.api.viewV2.search(view.id)).rows
const page1 = await config.api.viewV2.search(view.id, {
paginate: true,
limit: 4,
query: {},
})
expect(page1).toEqual({
rows: expect.arrayContaining(rows.slice(0, 4)),
totalRows: isInternal ? 10 : undefined,
hasNextPage: true,
bookmark: expect.anything(),
})
const page2 = await config.api.viewV2.search(view.id, {
paginate: true,
limit: 4,
bookmark: page1.bookmark,
query: {},
})
expect(page2).toEqual({
rows: expect.arrayContaining(rows.slice(4, 8)),
totalRows: isInternal ? 10 : undefined,
hasNextPage: true,
bookmark: expect.anything(),
})
const page3 = await config.api.viewV2.search(view.id, {
paginate: true,
limit: 4,
bookmark: page2.bookmark,
query: {},
})
expect(page3).toEqual({
rows: expect.arrayContaining(rows.slice(8)),
totalRows: isInternal ? 10 : undefined,
hasNextPage: false,
bookmark: expect.anything(),
})
})
const sortTestOptions: [
{
field: string
order?: SortOrder
type?: SortType
},
string[]
][] = [
[
{
field: "name",
order: SortOrder.ASCENDING,
type: SortType.STRING,
},
["Alice", "Bob", "Charly", "Danny"],
],
[
{
field: "name",
},
["Alice", "Bob", "Charly", "Danny"],
],
[
{
field: "name",
order: SortOrder.DESCENDING,
},
["Danny", "Charly", "Bob", "Alice"],
],
[
{
field: "name",
order: SortOrder.DESCENDING,
type: SortType.STRING,
},
["Danny", "Charly", "Bob", "Alice"],
],
[
{
field: "age",
order: SortOrder.ASCENDING,
type: SortType.NUMBER,
},
["Danny", "Alice", "Charly", "Bob"],
],
[
{
field: "age",
order: SortOrder.ASCENDING,
},
["Danny", "Alice", "Charly", "Bob"],
],
[
{
field: "age",
order: SortOrder.DESCENDING,
},
["Bob", "Charly", "Alice", "Danny"],
],
[
{
field: "age",
order: SortOrder.DESCENDING,
type: SortType.NUMBER,
},
["Bob", "Charly", "Alice", "Danny"],
],
]
describe("sorting", () => {
let table: Table
const viewSchema = { age: { visible: true }, name: { visible: true } }
beforeAll(async () => {
table = await config.api.table.save(
saveTableRequest({
type: "table",
schema: {
name: {
type: FieldType.STRING,
name: "name",
},
surname: {
type: FieldType.STRING,
name: "surname",
},
age: {
type: FieldType.NUMBER,
name: "age",
},
address: {
type: FieldType.STRING,
name: "address",
},
jobTitle: {
type: FieldType.STRING,
name: "jobTitle",
},
},
})
)
const users = [
{ name: "Alice", age: 25 },
{ name: "Bob", age: 30 },
{ name: "Charly", age: 27 },
{ name: "Danny", age: 15 },
]
await Promise.all(
users.map(u =>
config.api.row.save(table._id!, {
tableId: table._id,
...u,
})
)
)
})
it.each(sortTestOptions)(
"allow sorting (%s)",
async (sortParams, expected) => {
const view = await config.api.viewV2.create({
tableId: table._id!,
name: generator.guid(),
sort: sortParams,
schema: viewSchema,
})
const response = await config.api.viewV2.search(view.id)
expect(response.rows).toHaveLength(4)
expect(response.rows).toEqual(
expected.map(name => expect.objectContaining({ name }))
)
}
)
it.each(sortTestOptions)(
"allow override the default view sorting (%s)",
async (sortParams, expected) => {
const view = await config.api.viewV2.create({
tableId: table._id!,
name: generator.guid(),
sort: {
field: "name",
order: SortOrder.ASCENDING,
type: SortType.STRING,
},
schema: viewSchema,
})
const response = await config.api.viewV2.search(view.id, {
sort: sortParams.field,
sortOrder: sortParams.order,
sortType: sortParams.type,
query: {},
})
expect(response.rows).toHaveLength(4)
expect(response.rows).toEqual(
expected.map(name => expect.objectContaining({ name }))
)
}
)
})
})
describe("permissions", () => {
beforeEach(async () => {
mocks.licenses.useViewPermissions()
await Promise.all(
Array.from({ length: 10 }, () => config.api.row.save(table._id!, {}))
)
})
it("does not allow public users to fetch by default", async () => {
await config.publish()
await config.api.viewV2.publicSearch(view.id, undefined, {
status: 403,
})
})
it("allow public users to fetch when permissions are explicit", async () => {
await config.api.permission.add({
roleId: roles.BUILTIN_ROLE_IDS.PUBLIC,
level: PermissionLevel.READ,
resourceId: view.id,
})
await config.publish()
const response = await config.api.viewV2.publicSearch(view.id)
expect(response.rows).toHaveLength(10)
})
it("allow public users to fetch when permissions are inherited", async () => {
await config.api.permission.add({
roleId: roles.BUILTIN_ROLE_IDS.PUBLIC,
level: PermissionLevel.READ,
resourceId: table._id!,
})
await config.publish()
const response = await config.api.viewV2.publicSearch(view.id)
expect(response.rows).toHaveLength(10)
})
it("respects inherited permissions, not allowing not public views from public tables", async () => {
await config.api.permission.add({
roleId: roles.BUILTIN_ROLE_IDS.PUBLIC,
level: PermissionLevel.READ,
resourceId: table._id!,
})
await config.api.permission.add({
roleId: roles.BUILTIN_ROLE_IDS.POWER,
level: PermissionLevel.READ,
resourceId: view.id,
})
await config.publish()
await config.api.viewV2.publicSearch(view.id, undefined, {
status: 403,
})
})
})
})
2023-07-12 16:13:00 +02:00
})