@budibase/server 2.3.20 → 2.3.21-alpha.0

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

@@ -9,7 +9,7 @@ const read = [],
  * @openapi
  * /queries/{queryId}:
  *   post:
- *     operationId: execute
+ *     operationId: queryExecute
  *     summary: Execute a query
  *     description: Queries which have been created within a Budibase app can be executed using this,
  *     tags:
@@ -43,7 +43,7 @@ write.push(new Endpoint("post", "/queries/:queryId", controller.execute))
  * @openapi
  * /queries/search:
  *   post:
- *     operationId: search
+ *     operationId: querySearch
  *     summary: Search for queries
  *     description: Based on query properties (currently only name) search for queries.
  *     tags:

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

@@ -9,7 +9,7 @@ const read = [],
  * @openapi
  * /tables/{tableId}/rows:
  *   post:
- *     operationId: create
+ *     operationId: rowCreate
  *     summary: Create a row
  *     description: Creates a row within the specified table.
  *     tags:
@@ -44,7 +44,7 @@ write.push(new Endpoint("post", "/tables/:tableId/rows", controller.create))
  * @openapi
  * /tables/{tableId}/rows/{rowId}:
  *   put:
- *     operationId: update
+ *     operationId: rowUpdate
  *     summary: Update a row
  *     description: Updates a row within the specified table.
  *     tags:
@@ -81,7 +81,7 @@ write.push(
  * @openapi
  * /tables/{tableId}/rows/{rowId}:
  *   delete:
- *     operationId: destroy
+ *     operationId: rowDestroy
  *     summary: Delete a row
  *     description: Deletes a row within the specified table.
  *     tags:
@@ -109,7 +109,7 @@ write.push(
  * @openapi
  * /tables/{tableId}/rows/{rowId}:
  *   get:
- *     operationId: getById
+ *     operationId: rowGetById
  *     summary: Retrieve a row
  *     description: This gets a single row, it will be enriched with the full related rows, rather than
  *       the squashed "primaryDisplay" format returned by the search endpoint.
@@ -136,7 +136,7 @@ read.push(new Endpoint("get", "/tables/:tableId/rows/:rowId", controller.read))
  * @openapi
  * /tables/{tableId}/rows/search:
  *   post:
- *     operationId: search
+ *     operationId: rowSearch
  *     summary: Search for rows
  *     tags:
  *       - rows

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

@@ -9,7 +9,7 @@ const read = [],
  * @openapi
  * /tables:
  *   post:
- *     operationId: create
+ *     operationId: tableCreate
  *     summary: Create a table
  *     description: Create a table, this could be internal or external.
  *     tags:
@@ -46,7 +46,7 @@ write.push(
  * @openapi
  * /tables/{tableId}:
  *   put:
- *     operationId: update
+ *     operationId: tableUpdate
  *     summary: Update a table
  *     description: Update a table, this could be internal or external.
  *     tags:
@@ -83,7 +83,7 @@ write.push(
  * @openapi
  * /tables/{tableId}:
  *   delete:
- *     operationId: destroy
+ *     operationId: tableDestroy
  *     summary: Delete a table
  *     description: Delete a table, this could be internal or external.
  *     tags:
@@ -108,7 +108,7 @@ write.push(new Endpoint("delete", "/tables/:tableId", controller.destroy))
  * @openapi
  * /tables/{tableId}:
  *   get:
- *     operationId: getById
+ *     operationId: tableGetById
  *     summary: Retrieve a table
  *     description: Lookup a table, this could be internal or external.
  *     tags:
@@ -133,7 +133,7 @@ read.push(new Endpoint("get", "/tables/:tableId", controller.read))
  * @openapi
  * /tables/search:
  *   post:
- *     operationId: search
+ *     operationId: tableSearch
  *     summary: Search for tables
  *     description: Based on table properties (currently only name) search for tables. This could be
  *       an internal or an external table.

package/src/api/routes/public/tests/{compare.spec.js → compare.spec.ts}

@@ -1,19 +1,20 @@
-const jestOpenAPI = require("jest-openapi").default
-const generateSchema = require("../../../../../specs/generate")
-const setup = require("../../tests/utilities")
-const { generateMakeRequest } = require("./utils")
+import jestOpenAPI from "jest-openapi"
+import { run as generateSchema } from "../../../../../specs/generate"
+import * as setup from "../../tests/utilities"
+import { generateMakeRequest } from "./utils"
+import { Table, App, Row, User } from "@budibase/types"
 
 const yamlPath = generateSchema()
-jestOpenAPI(yamlPath)
+jestOpenAPI(yamlPath!)
 
 let config = setup.getConfig()
-let apiKey, table, app, makeRequest
+let apiKey: string, table: Table, app: App, makeRequest: any
 
 beforeAll(async () => {
   app = await config.init()
   table = await config.updateTable()
   apiKey = await config.generateApiKey()
-  makeRequest = generateMakeRequest(apiKey, setup)
+  makeRequest = generateMakeRequest(apiKey)
 })
 
 afterAll(setup.afterAll)
@@ -25,19 +26,29 @@ describe("check the applications endpoints", () => {
   })
 
   it("should allow creating an application", async () => {
-    const res = await makeRequest("post", "/applications", {
-      name: "new App"
-    }, null)
+    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)
+    const res = await makeRequest(
+      "put",
+      `/applications/${appId}`,
+      {
+        ...app,
+        name: "updated app name",
+      },
+      appId
+    )
     expect(res).toSatisfyApiSpec()
   })
 
@@ -47,7 +58,10 @@ describe("check the applications endpoints", () => {
   })
 
   it("should allow deleting an application", async () => {
-    const res = await makeRequest("delete", `/applications/${config.getAppId()}`)
+    const res = await makeRequest(
+      "delete",
+      `/applications/${config.getAppId()}`
+    )
     expect(res).toSatisfyApiSpec()
   })
 })
@@ -68,8 +82,8 @@ describe("check the tables endpoints", () => {
         column1: {
           type: "string",
           constraints: {},
-        }
-      }
+        },
+      },
     })
     expect(res).toSatisfyApiSpec()
   })
@@ -92,12 +106,11 @@ describe("check the tables endpoints", () => {
 })
 
 describe("check the rows endpoints", () => {
-  let row
+  let row: Row
   it("should allow retrieving rows through search", async () => {
     table = await config.updateTable()
     const res = await makeRequest("post", `/tables/${table._id}/rows/search`, {
-      query: {
-      },
+      query: {},
     })
     expect(res).toSatisfyApiSpec()
   })
@@ -111,9 +124,13 @@ describe("check the rows endpoints", () => {
   })
 
   it("should allow updating a row", async () => {
-    const res = await makeRequest("put", `/tables/${table._id}/rows/${row._id}`, {
-      name: "test row updated",
-    })
+    const res = await makeRequest(
+      "put",
+      `/tables/${table._id}/rows/${row._id}`,
+      {
+        name: "test row updated",
+      }
+    )
     expect(res).toSatisfyApiSpec()
   })
 
@@ -123,13 +140,16 @@ describe("check the rows endpoints", () => {
   })
 
   it("should allow deleting a row", async () => {
-    const res = await makeRequest("delete", `/tables/${table._id}/rows/${row._id}`)
+    const res = await makeRequest(
+      "delete",
+      `/tables/${table._id}/rows/${row._id}`
+    )
     expect(res).toSatisfyApiSpec()
   })
 })
 
 describe("check the users endpoints", () => {
-  let user
+  let user: User
   it("should allow retrieving users through search", async () => {
     user = await config.createUser()
     const res = await makeRequest("post", "/users/search")
@@ -163,4 +183,3 @@ describe("check the queries endpoints", () => {
     expect(res).toSatisfyApiSpec()
   })
 })
-

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

@@ -10,7 +10,7 @@ beforeAll(async () => {
   await config.init()
   globalUser = await config.globalUser()
   apiKey = await config.generateApiKey(globalUser._id)
-  makeRequest = generateMakeRequest(apiKey, setup)
+  makeRequest = generateMakeRequest(apiKey)
   workerRequests.readGlobalUser.mockReturnValue(globalUser)
 })
 

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

@@ -1,13 +1,27 @@
+import * as setup from "../../tests/utilities"
 import { checkSlashesInUrl } from "../../../../utilities"
+import supertest from "supertest"
 
-export function generateMakeRequest(apiKey: string, setup: any) {
-  const request = setup.getRequest()
-  const config = setup.getConfig()
+export type HttpMethod = "post" | "get" | "put" | "delete" | "patch"
+
+export type MakeRequestResponse = (
+  method: HttpMethod,
+  endpoint: string,
+  body?: any,
+  intAppId?: string
+) => Promise<supertest.Response>
+
+export function generateMakeRequest(
+  apiKey: string,
+  isInternal = false
+): MakeRequestResponse {
+  const request = setup.getRequest()!
+  const config = setup.getConfig()!
   return async (
-    method: string,
+    method: HttpMethod,
     endpoint: string,
     body?: any,
-    intAppId: string = config.getAppId()
+    intAppId: string | null = config.getAppId()
   ) => {
     const extraHeaders: any = {
       "x-budibase-api-key": apiKey,
@@ -15,9 +29,12 @@ export function generateMakeRequest(apiKey: string, setup: any) {
     if (intAppId) {
       extraHeaders["x-budibase-app-id"] = intAppId
     }
-    const req = request[method](
-      checkSlashesInUrl(`/api/public/v1/${endpoint}`)
-    ).set(config.defaultHeaders(extraHeaders))
+
+    const url = isInternal
+      ? endpoint
+      : checkSlashesInUrl(`/api/public/v1/${endpoint}`)
+
+    const req = request[method](url).set(config.defaultHeaders(extraHeaders))
     if (body) {
       req.send(body)
     }

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

@@ -9,7 +9,7 @@ const read = [],
  * @openapi
  * /users:
  *   post:
- *     operationId: create
+ *     operationId: userCreate
  *     summary: Create a user
  *     tags:
  *       - users
@@ -36,7 +36,7 @@ write.push(new Endpoint("post", "/users", controller.create))
  * @openapi
  * /users/{userId}:
  *   put:
- *     operationId: update
+ *     operationId: userUpdate
  *     summary: Update a user
  *     tags:
  *       - users
@@ -65,7 +65,7 @@ write.push(new Endpoint("put", "/users/:userId", controller.update))
  * @openapi
  * /users/{userId}:
  *   delete:
- *     operationId: destroy
+ *     operationId: userDestroy
  *     summary: Delete a user
  *     tags:
  *       - users
@@ -88,7 +88,7 @@ write.push(new Endpoint("delete", "/users/:userId", controller.destroy))
  * @openapi
  * /users/{userId}:
  *   get:
- *     operationId: getById
+ *     operationId: userGetById
  *     summary: Retrieve a user
  *     tags:
  *       - users
@@ -111,7 +111,7 @@ read.push(new Endpoint("get", "/users/:userId", controller.read))
  * @openapi
  * /users/search:
  *   post:
- *     operationId: search
+ *     operationId: userSearch
  *     summary: Search for users
  *     description: Based on user properties (currently only name) search for users.
  *     tags:

package/src/api/routes/tests/__snapshots__/datasource.spec.ts.snap

@@ -7,7 +7,7 @@ Array [
     "entities": Array [
       Object {
         "_id": "ta_users",
-        "_rev": "1-6f4013e796887f1771bf7837598d87e7",
+        "_rev": "1-2375e1bc58aeec664dc1b1f04ad43e44",
         "createdAt": "2020-01-01T00:00:00.000Z",
         "name": "Users",
         "primaryDisplay": "email",

package/src/api/routes/tests/analytics.spec.js

@@ -10,8 +10,11 @@ describe("/static", () => {
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
+  beforeAll(async () => {
     app = await config.init()
+  })
+  
+  beforeEach(()=>{
     jest.clearAllMocks()
   })
 

package/src/api/routes/tests/apikeys.spec.js

@@ -7,7 +7,7 @@ describe("/api/keys", () => {
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
+  beforeAll(async () => {
     await config.init()
   })
 

package/src/api/routes/tests/application.spec.ts

@@ -14,18 +14,22 @@ jest.mock("../../../utilities/redis", () => ({
 import { clearAllApps, checkBuilderEndpoint } from "./utilities/TestFunctions"
 import * as setup from "./utilities"
 import { AppStatus } from "../../../db/utils"
-import { events } from "@budibase/backend-core"
+import { events, utils } from "@budibase/backend-core"
 import env from "../../../environment"
 
+jest.setTimeout(15000)
+
 describe("/applications", () => {
   let request = setup.getRequest()
   let config = setup.getConfig()
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
-    await clearAllApps()
+  beforeAll(async () => {
     await config.init()
+  })
+
+  beforeEach(async () => {
     jest.clearAllMocks()
   })
 
@@ -33,7 +37,7 @@ describe("/applications", () => {
     it("creates empty app", async () => {
       const res = await request
         .post("/api/applications")
-        .field("name", "My App")
+        .field("name", utils.newid())
         .set(config.defaultHeaders())
         .expect("Content-Type", /json/)
         .expect(200)
@@ -44,7 +48,7 @@ describe("/applications", () => {
     it("creates app from template", async () => {
       const res = await request
         .post("/api/applications")
-        .field("name", "My App")
+        .field("name", utils.newid())
         .field("useTemplate", "true")
         .field("templateKey", "test")
         .field("templateString", "{}") // override the file download
@@ -59,7 +63,7 @@ describe("/applications", () => {
     it("creates app from file", async () => {
       const res = await request
         .post("/api/applications")
-        .field("name", "My App")
+        .field("name", utils.newid())
         .field("useTemplate", "true")
         .set(config.defaultHeaders())
         .attach("templateFile", "src/api/routes/tests/data/export.txt")
@@ -106,6 +110,11 @@ describe("/applications", () => {
   })
 
   describe("fetch", () => {
+    beforeEach(async () => {
+      // Clean all apps but the onde from config
+      await clearAllApps(config.getTenantId(), [config.getAppId()!])
+    })
+
     it("lists all applications", async () => {
       await config.createApp("app1")
       await config.createApp("app2")
@@ -266,6 +275,11 @@ describe("/applications", () => {
   })
 
   describe("unpublish", () => {
+    beforeEach(async () => {
+      // We want to republish as the unpublish will delete the prod app
+      await config.publish()
+    })
+
     it("should unpublish app with dev app ID", async () => {
       const appId = config.getAppId()
       await request

package/src/api/routes/tests/auth.spec.js

@@ -7,7 +7,7 @@ describe("/authenticate", () => {
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
+  beforeAll(async () => {
     await config.init()
   })
 
@@ -18,7 +18,7 @@ describe("/authenticate", () => {
         .set(config.defaultHeaders())
         .expect("Content-Type", /json/)
         .expect(200)
-      expect(res.body._id).toEqual(generateUserMetadataID("us_uuid1"))
+      expect(res.body._id).toEqual(generateUserMetadataID(config.user._id))
     })
   })
 })

package/src/api/routes/tests/automation.spec.js

@@ -10,12 +10,16 @@ const MAX_RETRIES = 4
 const { TRIGGER_DEFINITIONS, ACTION_DEFINITIONS } = require("../../../automations")
 const { events } = require("@budibase/backend-core")
 
+
+jest.setTimeout(30000)
+
 describe("/automations", () => {
   let request = setup.getRequest()
   let config = setup.getConfig()
 
   afterAll(setup.afterAll)
 
+  // For some reason this cannot be a beforeAll or the test "tests the automation successfully" fail
   beforeEach(async () => {
     await config.init()
   })
@@ -145,7 +149,7 @@ describe("/automations", () => {
         let elements = await getAllTableRows(config)
         // don't test it unless there are values to test
         if (elements.length > 1) {
-          expect(elements.length).toEqual(5)
+          expect(elements.length).toBeGreaterThanOrEqual(MAX_RETRIES)
           expect(elements[0].name).toEqual("Test")
           expect(elements[0].description).toEqual("TEST")
           return
@@ -305,7 +309,7 @@ describe("/automations", () => {
         .expect('Content-Type', /json/)
         .expect(200)
 
-        expect(res.body[0]).toEqual(expect.objectContaining(autoConfig))
+      expect(res.body[0]).toEqual(expect.objectContaining(autoConfig))
     })
 
     it("should apply authorization to endpoint", async () => {

package/src/api/routes/tests/backup.spec.ts

@@ -1,17 +1,8 @@
-jest.mock("@budibase/backend-core", () => {
-  const core = jest.requireActual("@budibase/backend-core")
-  return {
-    ...core,
-    objectStore: {
-      budibaseTempDir: core.objectStore.budibaseTempDir,
-    },
-  }
-})
-
 import * as setup from "./utilities"
 import { events } from "@budibase/backend-core"
 import sdk from "../../../sdk"
 import { checkBuilderEndpoint } from "./utilities/TestFunctions"
+
 describe("/backups", () => {
   let request = setup.getRequest()
   let config = setup.getConfig()
@@ -28,7 +19,6 @@ describe("/backups", () => {
         .get(`/api/backups/export?appId=${config.getAppId()}&appname=test`)
         .set(config.defaultHeaders())
         .expect(200)
-      expect(res.text).toBeDefined()
       expect(res.headers["content-type"]).toEqual("application/gzip")
       expect(events.app.exported).toBeCalledTimes(1)
     })
@@ -44,9 +34,9 @@ describe("/backups", () => {
 
   describe("calculateBackupStats", () => {
     it("should be able to calculate the backup statistics", async () => {
-      config.createAutomation()
-      config.createScreen()
-      let res = await sdk.backups.calculateBackupStats(config.getAppId())
+      await config.createAutomation()
+      await config.createScreen()
+      let res = await sdk.backups.calculateBackupStats(config.getAppId()!)
       expect(res.automations).toEqual(1)
       expect(res.datasources).toEqual(1)
       expect(res.screens).toEqual(1)

package/src/api/routes/tests/cloud.spec.ts

@@ -1,65 +1,54 @@
-import { db as dbCore } from "@budibase/backend-core"
+import { App } from "@budibase/types"
+
+jest.setTimeout(30000)
+
 import { AppStatus } from "../../../db/utils"
 
 import * as setup from "./utilities"
 
+import { wipeDb } from "./utilities/TestFunctions"
+import { tenancy } from "@budibase/backend-core"
+
 describe("/cloud", () => {
-  let request = setup.getRequest()
+  let request = setup.getRequest()!
   let config = setup.getConfig()
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
+  beforeAll(async () => {
+    // Importing is only allowed in self hosted environments
     await config.init()
-  })
-
-  afterEach(async () => {
-    // clear all mocks
-    jest.clearAllMocks()
+    config.modeSelf()
   })
 
   describe("import", () => {
     it("should be able to import apps", async () => {
       // first we need to delete any existing apps on the system so it looks clean otherwise the
       // import will not run
-      await request
-        .post(
-          `/api/applications/${dbCore.getProdAppID(
-            config.getAppId()
-          )}/unpublish`
-        )
-        .set(config.defaultHeaders())
-        .expect(204)
-      await request
-        .delete(`/api/applications/${config.getAppId()}`)
-        .set(config.defaultHeaders())
-        .expect("Content-Type", /json/)
-        .expect(200)
-
-      // get a count of apps before the import
-      const preImportApps = await request
-        .get(`/api/applications?status=${AppStatus.ALL}`)
-        .set(config.defaultHeaders())
-        .expect("Content-Type", /json/)
-        .expect(200)
+      await wipeDb()
 
       // Perform the import
       const res = await request
         .post(`/api/cloud/import`)
+        .set(config.publicHeaders())
         .attach("importFile", "src/api/routes/tests/data/export-test.tar.gz")
-        .set(config.defaultHeaders())
         .expect(200)
       expect(res.body.message).toEqual("Apps successfully imported.")
 
       // get a count of apps after the import
       const postImportApps = await request
         .get(`/api/applications?status=${AppStatus.ALL}`)
-        .set(config.defaultHeaders())
+        .set(config.publicHeaders())
         .expect("Content-Type", /json/)
         .expect(200)
 
+      const apps = postImportApps.body as App[]
       // There are two apps in the file that was imported so check for this
-      expect(postImportApps.body.length).toEqual(2)
+      expect(apps.length).toEqual(2)
+      // The new tenant id was assigned to the imported apps
+      expect(tenancy.getTenantIDFromAppID(apps[0].appId)).toBe(
+        config.getTenantId()
+      )
     })
   })
 })

package/src/api/routes/tests/component.spec.js

@@ -7,7 +7,7 @@ describe("/component", () => {
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
+  beforeAll(async () => {
     await config.init()
   })