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

import * as setup from "./utilities"
import {
  FieldType,
  SortDirection,
  SortType,
  Table,
  ViewV2,
} from "@budibase/types"
import { generator, structures } from "@budibase/backend-core/tests"

function priceTable(): Table {
  return {
    name: "table",
    type: "table",
    schema: {
      Price: {
        type: FieldType.NUMBER,
        name: "Price",
        constraints: {},
      },
      Category: {
        type: FieldType.STRING,
        name: "Category",
        constraints: {
          type: "string",
        },
      },
    },
  }
}

describe("/v2/views", () => {
  const config = setup.getConfig()

  const viewFilters: Omit<ViewV2, "name" | "tableId"> = {
    query: { allOr: false, equal: { field: "value" } },
    sort: {
      field: "fieldToSort",
      order: SortDirection.DESCENDING,
      type: SortType.STRING,
    },
  }

  afterAll(setup.afterAll)

  beforeAll(async () => {
    await config.init()
    await config.createTable(priceTable())
  })

  describe("fetch", () => {
    const views: ViewV2[] = []

    beforeAll(async () => {
      await config.createTable(priceTable())
      for (let id = 0; id < 10; id++) {
        views.push(await config.api.viewV2.create())
      }
    })

    it("returns all views", async () => {
      const res = await config.api.viewV2.fetch()

      expect(res.body.views.length).toBe(10)
      expect(res.body.views).toEqual(
        expect.arrayContaining(views.map(v => expect.objectContaining(v)))
      )
    })

    it("can filter by table id", async () => {
      const newTable = await config.createTable(priceTable(), {
        skipReassigning: true,
      })
      const newViews = []
      for (let id = 0; id < 5; id++) {
        newViews.push(await config.api.viewV2.create({ tableId: newTable._id }))
      }

      const res = await config.api.viewV2.fetch(newTable._id)

      expect(res.body.views.length).toBe(5)
      expect(res.body.views).toEqual(
        expect.arrayContaining(newViews.map(v => expect.objectContaining(v)))
      )
    })

    it("can not filter by multiple table ids", async () => {
      const res = await config
        .getRequest()!
        .get(
          `/api/v2/views?tableId=${structures.generator.guid()}&tableId=${structures.generator.guid()}`
        )
        .set(config.defaultHeaders())
        .expect("Content-Type", /json/)
        .expect(400)

      expect(res.body.message).toBe("tableId type is not valid")
    })

    it("returns views with query info", async () => {
      const newView = await config.api.viewV2.create({ ...viewFilters })
      const res = await request
        .get(`/api/v2/views?tableId=${config.table!._id}`)
        .set(config.defaultHeaders())
        .expect("Content-Type", /json/)
        .expect(200)

      expect(res.body.views.length).toBe(11)
      expect(newView.query).toEqual({ allOr: false, equal: { field: "value" } })
      expect(res.body.views).toEqual(
        expect.arrayContaining([
          expect.objectContaining({
            ...newView,
            ...viewFilters,
          }),
        ])
      )
    })
  })

  describe("getView", () => {
    let view: ViewV2
    beforeAll(async () => {
      view = await config.api.viewV2.create({
        query: { allOr: false, notEqual: { field: "value" } },
      })
    })

    it("can fetch the expected view", async () => {
      const res = await config.api.viewV2.get(view._id!)
      expect(res.status).toBe(200)

      expect(res.body).toEqual({
        data: {
          ...view,
          _id: view._id,
          _rev: view._rev,
          createdAt: expect.any(String),
          updatedAt: expect.any(String),
        },
      })
    })

    it("will return 404 if the unnexisting id is provided", async () => {
      await config.api.viewV2.get(structures.generator.guid(), {
        expectStatus: 404,
      })
    })
  })

  describe("create", () => {
    it("persist the view when the view is successfully created", async () => {
      const newView: ViewV2 = {
        name: generator.name(),
        tableId: config.table!._id!,
      }
      const res = await config.api.viewV2.create(newView)

      expect(res).toEqual({
        ...newView,
        _id: expect.any(String),
        _rev: expect.any(String),
      })
    })

    it("can persist views with queries", async () => {
      const newView: ViewV2 = {
        name: generator.name(),
        tableId: config.table!._id!,
        ...viewFilters,
      }
      const res = await request
        .post(`/api/v2/views`)
        .send(newView)
        .set(config.defaultHeaders())
        .expect("Content-Type", /json/)
        .expect(201)

      expect(res.body).toEqual({
        data: {
          ...newView,
          ...viewFilters,
          _id: expect.any(String),
          _rev: expect.any(String),
        },
      })
    })
  })

  describe("delete", () => {
    let view: ViewV2

    beforeAll(async () => {
      await config.createTable(priceTable())
      view = await config.api.viewV2.create()
    })

    it("can delete an existing view", async () => {
      await config.api.viewV2.get(view._id!, { expectStatus: 200 })

      await config.api.viewV2.delete(view._id!)

      await config.api.viewV2.get(view._id!, { expectStatus: 404 })
    })
  })
})