@budibase/server/src/db/tests/linkTests.spec.ts

Budibase Web Server

import { context } from "@budibase/backend-core"
import { FieldType, RelationshipType, Table } from "@budibase/types"
import TestConfig from "../../tests/utilities/TestConfiguration"
import { basicTable } from "../../tests/utilities/structures"
import * as linkUtils from "../linkedRows/linkUtils"

describe("test link functionality", () => {
  const config = new TestConfig()
  let appId: string

  describe("getLinkedTable", () => {
    let table: Table
    beforeAll(async () => {
      const app = await config.init()
      appId = app.appId
      table = await config.createTable()
    })

    it("should be able to retrieve a linked table from a list", async () => {
      await context.doInWorkspaceContext(appId, async () => {
        const retrieved = await linkUtils.getLinkedTable(table._id!, [table])
        expect(retrieved._id).toBe(table._id)
      })
    })

    it("should be able to retrieve a table from DB and update list", async () => {
      const tables: Table[] = []
      await context.doInWorkspaceContext(appId, async () => {
        const retrieved = await linkUtils.getLinkedTable(table._id!, tables)
        expect(retrieved._id).toBe(table._id)
        expect(tables[0]).toBeDefined()
      })
    })
  })

  describe("getRelatedTableForField", () => {
    const link = basicTable()
    link.schema.link = {
      name: "link",
      relationshipType: RelationshipType.ONE_TO_MANY,
      fieldName: "otherLink",
      tableId: "tableID",
      type: FieldType.LINK,
    }

    it("should get the field from the table directly", () => {
      expect(linkUtils.getRelatedTableForField(link.schema, "link")).toBe(
        "tableID"
      )
    })

    it("should get the field from the link", () => {
      expect(linkUtils.getRelatedTableForField(link.schema, "otherLink")).toBe(
        "tableID"
      )
    })
  })

  describe("getLinkDocuments", () => {
    it("should create the link view when it doesn't exist", async () => {
      // create the DB and a very basic app design DB
      await context.doInWorkspaceContext(appId, async () => {
        const output = await linkUtils.getLinkDocuments({
          tableId: "test",
          rowId: "test",
          includeDocs: false,
        })
        expect(Array.isArray(output)).toBe(true)
      })
    })
  })
})