@budibase/server/src/sdk/app/rows/search/tests/search.spec.ts

Budibase Web Server

import {
  AutoColumnFieldMetadata,
  AutoFieldSubType,
  Datasource,
  FieldType,
  NumberFieldMetadata,
  Table,
} from "@budibase/types"

import { search } from "../../../../../sdk/app/rows/search"
import { generator } from "@budibase/backend-core/tests"

import { datasourceDescribe } from "../../../../../integrations/tests/utils"
import { tableForDatasource } from "../../../../../tests/utilities/structures"

// These test cases are only for things that cannot be tested through the API
// (e.g. limiting searches to returning specific fields). If it's possible to
// test through the API, it should be done there instead.
const descriptions = datasourceDescribe({ plus: true })

if (descriptions.length) {
  describe.each(descriptions)(
    "search sdk ($dbName)",
    ({ config, dsProvider, isInternal }) => {
      let datasource: Datasource | undefined
      let table: Table

      beforeAll(async () => {
        const ds = await dsProvider()
        datasource = ds.datasource
      })

      beforeEach(async () => {
        const idFieldSchema: NumberFieldMetadata | AutoColumnFieldMetadata =
          isInternal
            ? {
                name: "id",
                type: FieldType.AUTO,
                subtype: AutoFieldSubType.AUTO_ID,
                autocolumn: true,
              }
            : {
                name: "id",
                type: FieldType.NUMBER,
                autocolumn: true,
              }

        table = await config.api.table.save(
          tableForDatasource(datasource, {
            primary: ["id"],
            schema: {
              id: idFieldSchema,
              name: {
                name: "name",
                type: FieldType.STRING,
              },
              surname: {
                name: "surname",
                type: FieldType.STRING,
              },
              age: {
                name: "age",
                type: FieldType.NUMBER,
              },
              address: {
                name: "address",
                type: FieldType.STRING,
              },
            },
          })
        )

        for (let i = 0; i < 10; i++) {
          await config.api.row.save(table._id!, {
            name: generator.first(),
            surname: generator.last(),
            age: generator.age(),
            address: generator.address(),
          })
        }
      })

      afterAll(async () => {
        config.end()
      })

      it("querying by fields will always return data attribute columns", async () => {
        await config.doInContext(config.appId, async () => {
          const { rows } = await search({
            tableId: table._id!,
            query: {},
            fields: ["name", "age"],
          })

          expect(rows).toHaveLength(10)
          for (const row of rows) {
            const keys = Object.keys(row)
            expect(keys).toContain("name")
            expect(keys).toContain("age")
            expect(keys).not.toContain("surname")
            expect(keys).not.toContain("address")
          }
        })
      })

      !isInternal &&
        it("will decode _id in oneOf query", async () => {
          await config.doInContext(config.appId, async () => {
            const result = await search({
              tableId: table._id!,
              query: {
                oneOf: {
                  _id: ["%5B1%5D", "%5B4%5D", "%5B8%5D"],
                },
              },
            })

            expect(result.rows).toHaveLength(3)
            expect(result.rows.map(row => row.id)).toEqual(
              expect.arrayContaining([1, 4, 8])
            )
          })
        })

      it("does not allow accessing hidden fields", async () => {
        await config.doInContext(config.appId, async () => {
          await config.api.table.save({
            ...table,
            schema: {
              ...table.schema,
              name: {
                ...table.schema.name,
                visible: true,
              },
              age: {
                ...table.schema.age,
                visible: false,
              },
            },
          })
          const result = await search({
            tableId: table._id!,
            query: {},
          })
          expect(result.rows).toHaveLength(10)
          for (const row of result.rows) {
            const keys = Object.keys(row)
            expect(keys).toContain("name")
            expect(keys).toContain("surname")
            expect(keys).toContain("address")
            expect(keys).not.toContain("age")
          }
        })
      })

      it("does not allow accessing hidden fields even if requested", async () => {
        await config.doInContext(config.appId, async () => {
          await config.api.table.save({
            ...table,
            schema: {
              ...table.schema,
              name: {
                ...table.schema.name,
                visible: true,
              },
              age: {
                ...table.schema.age,
                visible: false,
              },
            },
          })
          const result = await search({
            tableId: table._id!,
            query: {},
            fields: ["name", "age"],
          })
          expect(result.rows).toHaveLength(10)
          for (const row of result.rows) {
            const keys = Object.keys(row)
            expect(keys).toContain("name")
            expect(keys).not.toContain("age")
            expect(keys).not.toContain("surname")
            expect(keys).not.toContain("address")
          }
        })
      })

      it("should return results when querying valid fields", async () => {
        await config.doInContext(config.appId, async () => {
          const { rows } = await search({
            tableId: table._id!,
            query: {
              $or: {
                conditions: [
                  {
                    $and: {
                      conditions: [
                        { range: { id: { low: 2, high: 4 } } },
                        { range: { id: { low: 3, high: 5 } } },
                      ],
                    },
                  },
                  { equal: { id: 7 } },
                ],
              },
            },
            fields: ["id", "name", "age"],
          })

          expect(rows).toHaveLength(3)
        })
      })

      it("should throw 400 when querying fields not in the restricted field list", async () => {
        await config.doInContext(config.appId, async () => {
          await expect(
            search({
              tableId: table._id!,
              query: {
                $or: {
                  conditions: [
                    {
                      $and: {
                        conditions: [
                          { range: { id: { low: 2, high: 4 } } },
                          { range: { id: { low: 3, high: 5 } } },
                        ],
                      },
                    },
                    { equal: { id: 7 } },
                  ],
                },
              },
              fields: ["name", "age"], // id is not in this list
            })
          ).rejects.toThrow("Invalid filter field: id")
        })
      })
    }
  )
}