@budibase/server 1.0.79 → 1.0.80-alpha.0

package/src/api/routes/public/tests/compare.spec.js

@@ -0,0 +1,184 @@
+const jestOpenAPI = require("jest-openapi").default
+const generateSchema = require("../../../../../specs/generate")
+const setup = require("../../tests/utilities")
+const { checkSlashesInUrl } = require("../../../../utilities")
+
+const yamlPath = generateSchema()
+jestOpenAPI(yamlPath)
+
+let request = setup.getRequest()
+let config = setup.getConfig()
+let apiKey, table, app
+
+beforeAll(async () => {
+  app = await config.init()
+  table = await config.updateTable()
+  apiKey = await config.generateApiKey()
+})
+
+afterAll(setup.afterAll)
+
+async function makeRequest(method, endpoint, body, appId = config.getAppId()) {
+  const extraHeaders = {
+    "x-budibase-api-key": apiKey,
+  }
+  if (appId) {
+    extraHeaders["x-budibase-app-id"] = appId
+  }
+  const req = request
+    [method](checkSlashesInUrl(`/api/public/v1/${endpoint}`))
+    .set(config.defaultHeaders(extraHeaders))
+  if (body) {
+    req.send(body)
+  }
+  const res = await req.expect("Content-Type", /json/).expect(200)
+  expect(res.body).toBeDefined()
+  return res
+}
+
+describe("check the applications endpoints", () => {
+  it("should allow retrieving applications through search", async () => {
+    const res = await makeRequest("post", "/applications/search")
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow creating an application", async () => {
+    const res = await makeRequest("post", "/applications", {
+      name: "new App"
+    }, null)
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow updating an application", async () => {
+    const app = config.getApp()
+    const appId = config.getAppId()
+    const res = await makeRequest("put", `/applications/${appId}`, {
+      ...app,
+      name: "updated app name",
+    }, appId)
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow retrieving an application", async () => {
+    const res = await makeRequest("get", `/applications/${config.getAppId()}`)
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow deleting an application", async () => {
+    const res = await makeRequest("delete", `/applications/${config.getAppId()}`)
+    expect(res).toSatisfyApiSpec()
+  })
+})
+
+describe("check the tables endpoints", () => {
+  it("should allow retrieving tables through search", async () => {
+    await config.createApp("new app 1")
+    table = await config.updateTable()
+    const res = await makeRequest("post", "/tables/search")
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow creating a table", async () => {
+    const res = await makeRequest("post", "/tables", {
+      name: "table name",
+      primaryDisplay: "column1",
+      schema: {
+        column1: {
+          type: "string",
+          constraints: {},
+        }
+      }
+    })
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow updating a table", async () => {
+    const updated = { ...table, _rev: undefined, name: "new name" }
+    const res = await makeRequest("put", `/tables/${table._id}`, updated)
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow retrieving a table", async () => {
+    const res = await makeRequest("get", `/tables/${table._id}`)
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow deleting a table", async () => {
+    const res = await makeRequest("delete", `/tables/${table._id}`)
+    expect(res).toSatisfyApiSpec()
+  })
+})
+
+describe("check the rows endpoints", () => {
+  let row
+  it("should allow retrieving rows through search", async () => {
+    table = await config.updateTable()
+    const res = await makeRequest("post", `/tables/${table._id}/rows/search`, {
+      query: {
+      },
+    })
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow creating a row", async () => {
+    const res = await makeRequest("post", `/tables/${table._id}/rows`, {
+      name: "test row",
+    })
+    expect(res).toSatisfyApiSpec()
+    row = res.body.data
+  })
+
+  it("should allow updating a row", async () => {
+    const res = await makeRequest("put", `/tables/${table._id}/rows/${row._id}`, {
+      name: "test row updated",
+    })
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow retrieving a row", async () => {
+    const res = await makeRequest("get", `/tables/${table._id}/rows/${row._id}`)
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow deleting a row", async () => {
+    const res = await makeRequest("delete", `/tables/${table._id}/rows/${row._id}`)
+    expect(res).toSatisfyApiSpec()
+  })
+})
+
+describe("check the users endpoints", () => {
+  let user
+  it("should allow retrieving users through search", async () => {
+    user = await config.createUser()
+    const res = await makeRequest("post", "/users/search")
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow creating a user", async () => {
+    const res = await makeRequest("post", "/users")
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow updating a user", async () => {
+    const res = await makeRequest("put", `/users/${user._id}`)
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow retrieving a user", async () => {
+    const res = await makeRequest("get", `/users/${user._id}`)
+    expect(res).toSatisfyApiSpec()
+  })
+
+  it("should allow deleting a user", async () => {
+    const res = await makeRequest("delete", `/users/${user._id}`)
+    expect(res).toSatisfyApiSpec()
+  })
+})
+
+describe("check the queries endpoints", () => {
+  it("should allow retrieving queries through search", async () => {
+    const res = await makeRequest("post", "/queries/search")
+    expect(res).toSatisfyApiSpec()
+  })
+})
+

package/src/api/routes/public/users.ts

@@ -0,0 +1,144 @@
+import controller from "../../controllers/public/users"
+import Endpoint from "./utils/Endpoint"
+import { nameValidator } from "../utils/validators"
+
+const read = [],
+  write = []
+
+/**
+ * @openapi
+ * /users:
+ *   post:
+ *     summary: Create a user
+ *     tags:
+ *       - users
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/user'
+ *     responses:
+ *       200:
+ *         description: Returns the created user.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/userOutput'
+ *             examples:
+ *               user:
+ *                 $ref: '#/components/examples/user'
+ */
+write.push(new Endpoint("post", "/users", controller.create))
+
+/**
+ * @openapi
+ * /users/{userId}:
+ *   put:
+ *     summary: Update a user
+ *     tags:
+ *       - users
+ *     parameters:
+ *       - $ref: '#/components/parameters/userId'
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/user'
+ *     responses:
+ *       200:
+ *         description: Returns the updated user.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/userOutput'
+ *             examples:
+ *               user:
+ *                 $ref: '#/components/examples/user'
+ */
+write.push(new Endpoint("put", "/users/:userId", controller.update))
+
+/**
+ * @openapi
+ * /users/{userId}:
+ *   delete:
+ *     summary: Delete a user
+ *     tags:
+ *       - users
+ *     parameters:
+ *       - $ref: '#/components/parameters/userId'
+ *     responses:
+ *       200:
+ *         description: Returns the deleted user.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/userOutput'
+ *             examples:
+ *               user:
+ *                 $ref: '#/components/examples/user'
+ */
+write.push(new Endpoint("delete", "/users/:userId", controller.destroy))
+
+/**
+ * @openapi
+ * /users/{userId}:
+ *   get:
+ *     summary: Retrieve a user
+ *     tags:
+ *       - users
+ *     parameters:
+ *       - $ref: '#/components/parameters/userId'
+ *     responses:
+ *       200:
+ *         description: Returns the retrieved user.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/userOutput'
+ *             examples:
+ *               user:
+ *                 $ref: '#/components/examples/user'
+ */
+read.push(new Endpoint("get", "/users/:userId", controller.read))
+
+/**
+ * @openapi
+ * /users/search:
+ *   post:
+ *     summary: Search for users
+ *     description: Based on user properties (currently only name) search for users.
+ *     tags:
+ *       - users
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             $ref: '#/components/schemas/nameSearch'
+ *     responses:
+ *       200:
+ *         description: Returns the found users based on search parameters.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               required:
+ *                 - data
+ *               properties:
+ *                 data:
+ *                   type: array
+ *                   items:
+ *                     $ref: '#/components/schemas/user'
+ *             examples:
+ *               users:
+ *                 $ref: '#/components/examples/users'
+ */
+read.push(
+  new Endpoint("post", "/users/search", controller.search).addMiddleware(
+    nameValidator()
+  )
+)
+
+export default { read, write }

package/src/api/routes/public/utils/Endpoint.ts

@@ -0,0 +1,51 @@
+import Router from "koa-router"
+
+export type CtxFn = (ctx: any, next?: any) => void | Promise<any>
+
+class Endpoint {
+  method: string
+  url: string
+  controller: CtxFn
+  middlewares: CtxFn[]
+  outputMiddlewares: CtxFn[]
+
+  constructor(method: string, url: string, controller: CtxFn) {
+    this.method = method
+    this.url = url
+    this.controller = controller
+    this.middlewares = []
+    this.outputMiddlewares = []
+  }
+
+  addMiddleware(middleware: CtxFn) {
+    this.middlewares.push(middleware)
+    return this
+  }
+
+  addOutputMiddleware(middleware: CtxFn) {
+    this.outputMiddlewares.push(middleware)
+    return this
+  }
+
+  apply(router: Router) {
+    const method = this.method,
+      url = this.url
+    const middlewares = this.middlewares,
+      controller = this.controller,
+      outputMiddlewares = this.outputMiddlewares
+    // need a function to do nothing to stop the execution at the end
+    // middlewares are circular so if they always keep calling next, it'll just keep looping
+    const complete = () => {}
+    const params = [
+      url,
+      ...middlewares,
+      controller,
+      ...outputMiddlewares,
+      complete,
+    ]
+    // @ts-ignore
+    router[method](...params)
+  }
+}
+
+export default Endpoint

package/src/api/routes/role.js

@@ -1,34 +1,13 @@
 const Router = require("@koa/router")
 const controller = require("../controllers/role")
 const authorized = require("../../middleware/authorized")
-const Joi = require("joi")
-const joiValidator = require("../../middleware/joi-validator")
-const {
-  BUILTIN_PERMISSION_IDS,
-  BUILDER,
-  PermissionLevels,
-} = require("@budibase/backend-core/permissions")
+const { BUILDER } = require("@budibase/backend-core/permissions")
+const { roleValidator } = require("./utils/validators")
 
 const router = Router()
 
-function generateValidator() {
-  const permLevelArray = Object.values(PermissionLevels)
-  // prettier-ignore
-  return joiValidator.body(Joi.object({
-    _id: Joi.string().optional(),
-    _rev: Joi.string().optional(),
-    name: Joi.string().required(),
-    // this is the base permission ID (for now a built in)
-    permissionId: Joi.string().valid(...Object.values(BUILTIN_PERMISSION_IDS)).required(),
-    permissions: Joi.object()
-      .pattern(/.*/, [Joi.string().valid(...permLevelArray)])
-      .optional(),
-    inherits: Joi.string().optional(),
-  }).unknown(true))
-}
-
 router
-  .post("/api/roles", authorized(BUILDER), generateValidator(), controller.save)
+  .post("/api/roles", authorized(BUILDER), roleValidator(), controller.save)
   .get("/api/roles", authorized(BUILDER), controller.fetch)
   .get("/api/roles/:roleId", authorized(BUILDER), controller.find)
   .delete("/api/roles/:roleId/:rev", authorized(BUILDER), controller.destroy)

package/src/api/routes/row.js

@@ -10,6 +10,7 @@ const {
   PermissionLevels,
   PermissionTypes,
 } = require("@budibase/backend-core/permissions")
+const { internalSearchValidator } = require("./utils/validators")
 
 const router = Router()
 
@@ -119,8 +120,6 @@ router
    *    "notEqual": {},
    *    "empty": {},
    *    "notEmpty": {},
-   *    "contains": {},
-   *    "notContains": {}
    *    "oneOf": {
    *      "columnName": ["value"]
    *    }
@@ -140,6 +139,7 @@ router
    */
   .post(
     "/api/:tableId/search",
+    internalSearchValidator(),
     paramResource("tableId"),
     authorized(PermissionTypes.TABLE, PermissionLevels.READ),
     rowController.search
@@ -195,6 +195,7 @@ router
     "/api/:tableId/rows",
     paramResource("tableId"),
     authorized(PermissionTypes.TABLE, PermissionLevels.WRITE),
+    usage,
     rowController.patch
   )
   /**

package/src/api/routes/screen.js

@@ -2,40 +2,13 @@ const Router = require("@koa/router")
 const controller = require("../controllers/screen")
 const authorized = require("../../middleware/authorized")
 const { BUILDER } = require("@budibase/backend-core/permissions")
-const joiValidator = require("../../middleware/joi-validator")
-const Joi = require("joi")
+const { screenValidator } = require("./utils/validators")
 
 const router = Router()
 
-function generateSaveValidation() {
-  // prettier-ignore
-  return joiValidator.body(Joi.object({
-    name: Joi.string().required(),
-    routing: Joi.object({
-      route: Joi.string().required(),
-      roleId: Joi.string().required().allow(""),
-    }).required().unknown(true),
-    props: Joi.object({
-      _id: Joi.string().required(),
-      _component: Joi.string().required(),
-      _children: Joi.array().required(),
-      _instanceName: Joi.string().required(),
-      _styles: Joi.object().required(),
-      type: Joi.string().optional(),
-      table: Joi.string().optional(),
-      layoutId: Joi.string().optional(),
-    }).required().unknown(true),
-  }).unknown(true))
-}
-
 router
   .get("/api/screens", authorized(BUILDER), controller.fetch)
-  .post(
-    "/api/screens",
-    authorized(BUILDER),
-    generateSaveValidation(),
-    controller.save
-  )
+  .post("/api/screens", authorized(BUILDER), screenValidator(), controller.save)
   .delete(
     "/api/screens/:screenId/:screenRev",
     authorized(BUILDER),

package/src/api/routes/table.js

@@ -7,25 +7,10 @@ const {
   PermissionLevels,
   PermissionTypes,
 } = require("@budibase/backend-core/permissions")
-const joiValidator = require("../../middleware/joi-validator")
-const Joi = require("joi")
+const { tableValidator } = require("./utils/validators")
 
 const router = Router()
 
-function generateSaveValidator() {
-  // prettier-ignore
-  return joiValidator.body(Joi.object({
-    _id: Joi.string(),
-    _rev: Joi.string(),
-    type: Joi.string().valid("table", "internal", "external"),
-    primaryDisplay: Joi.string(),
-    schema: Joi.object().required(),
-    name: Joi.string().required(),
-    views: Joi.object(),
-    dataImport: Joi.object(),
-  }).unknown(true))
-}
-
 router
   /**
    * @api {get} /api/tables Fetch all tables
@@ -53,8 +38,8 @@ router
    * @apiSuccess {object[]} body The response body will be the table that was found.
    */
   .get(
-    "/api/tables/:id",
-    paramResource("id"),
+    "/api/tables/:tableId",
+    paramResource("tableId"),
     authorized(PermissionTypes.TABLE, PermissionLevels.READ),
     tableController.find
   )
@@ -136,7 +121,7 @@ router
     // allows control over updating a table
     bodyResource("_id"),
     authorized(BUILDER),
-    generateSaveValidator(),
+    tableValidator(),
     tableController.save
   )
   /**

package/src/api/routes/tests/utilities/index.js

@@ -2,6 +2,18 @@ const TestConfig = require("../../../../tests/utilities/TestConfiguration")
 const structures = require("../../../../tests/utilities/structures")
 const env = require("../../../../environment")
 
+function user() {
+  return {
+    _id: "user",
+    _rev: "rev",
+    createdAt: Date.now(),
+    email: "test@test.com",
+    roles: {},
+    tenantId: "default",
+    status: "active",
+  }
+}
+
 jest.mock("../../../../utilities/workerRequests", () => ({
   getGlobalUsers: jest.fn(() => {
     return {
@@ -13,6 +25,18 @@ jest.mock("../../../../utilities/workerRequests", () => ({
       _id: "us_uuid1",
     }
   }),
+  allGlobalUsers: jest.fn(() => {
+    return [user()]
+  }),
+  readGlobalUser: jest.fn(() => {
+    return user()
+  }),
+  saveGlobalUser: jest.fn(() => {
+    return { _id: "user", _rev: "rev" }
+  }),
+  deleteGlobalUser: jest.fn(() => {
+    return { message: "deleted user" }
+  }),
   removeAppFromUserRoles: jest.fn(),
 }))