@budibase/server 2.2.26 → 2.2.27-alpha.1

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

@@ -1,6 +1,7 @@
 import controller from "../../controllers/public/applications"
 import Endpoint from "./utils/Endpoint"
 const { nameValidator, applicationValidator } = require("../utils/validators")
+import { db } from "@budibase/backend-core"
 
 const read = [],
   write = []
@@ -94,6 +95,49 @@ write.push(
  */
 write.push(new Endpoint("delete", "/applications/:appId", controller.destroy))
 
+/**
+ * @openapi
+ * /applications/{appId}/unpublish:
+ *   post:
+ *     operationId: unpublish
+ *     summary: Unpublish an application
+ *     tags:
+ *       - applications
+ *     parameters:
+ *       - $ref: '#/components/parameters/appIdUrl'
+ *     responses:
+ *       204:
+ *         description: The app was published successfully.
+ */
+write.push(
+  new Endpoint("post", "/applications/:appId/unpublish", controller.unpublish)
+)
+
+/**
+ * @openapi
+ * /applications/{appId}/publish:
+ *   post:
+ *     operationId: publish
+ *     summary: Unpublish an application
+ *     tags:
+ *       - applications
+ *     parameters:
+ *       - $ref: '#/components/parameters/appIdUrl'
+ *     responses:
+ *       200:
+ *         description: Returns the deployment object.
+ *         content:
+ *           application/json:
+ *             schema:
+ *               $ref: '#/components/schemas/deploymentOutput'
+ *             examples:
+ *               deployment:
+ *                 $ref: '#/components/examples/deploymentOutput'
+ */
+write.push(
+  new Endpoint("post", "/applications/:appId/publish", controller.publish)
+)
+
 /**
  * @openapi
  * /applications/{appId}:

package/src/api/routes/public/middleware/mapper.ts

@@ -54,9 +54,13 @@ function processQueries(ctx: any) {
 }
 
 export default async (ctx: any, next: any) => {
+  if (!ctx.body) {
+    return await next()
+  }
   let urlParts = ctx.url.split("/")
   urlParts = urlParts.slice(4, urlParts.length)
   let body = {}
+
   switch (urlParts[0]) {
     case Resources.APPLICATION:
       body = processApplications(ctx)

package/src/api/routes/query.ts

@@ -58,4 +58,4 @@ router
     queryController.executeV2 as any
   )
 
-export = router
+export default router

package/src/api/routes/role.ts

@@ -21,4 +21,4 @@ router
     controller.destroy
   )
 
-export = router
+export default router

package/src/api/routes/routing.ts

@@ -11,4 +11,4 @@ router
   // gets the full structure, not just the correct screen ID for user role
   .get("/api/routing", authorized(permissions.BUILDER), controller.fetch)
 
-export = router
+export default router

package/src/api/routes/row.ts

@@ -3,7 +3,7 @@ import * as rowController from "../controllers/row"
 import authorized from "../../middleware/authorized"
 import { paramResource, paramSubResource } from "../../middleware/resourceId"
 import { permissions } from "@budibase/backend-core"
-const { internalSearchValidator } = require("./utils/validators")
+import { internalSearchValidator } from "./utils/validators"
 const { PermissionType, PermissionLevel } = permissions
 
 const router: Router = new Router()

package/src/api/routes/screen.ts

@@ -20,4 +20,4 @@ router
     controller.destroy
   )
 
-export = router
+export default router

package/src/api/routes/script.ts

@@ -7,4 +7,4 @@ const router: Router = new Router()
 
 router.post("/api/script", authorized(permissions.BUILDER), controller.save)
 
-export = router
+export default router

package/src/api/routes/static.ts

@@ -3,7 +3,7 @@ import * as controller from "../controllers/static"
 import { budibaseTempDir } from "../../utilities/budibaseDir"
 import authorized from "../../middleware/authorized"
 import { permissions } from "@budibase/backend-core"
-import * as env from "../../environment"
+import env from "../../environment"
 import { paramResource } from "../../middleware/resourceId"
 const { BUILDER, PermissionType, PermissionLevel } = permissions
 
@@ -62,4 +62,4 @@ router
     controller.getSignedUploadURL
   )
 
-export = router
+export default router

package/src/api/routes/table.ts

@@ -67,10 +67,7 @@ router
    * structure, and the "updated", new column name should also be supplied. The schema should also be updated, this field
    * lets the server know that a field hasn't just been deleted, that the data has moved to a new name, this will fix
    * the rows in the table. This functionality is only available for internal tables.
-   * @apiParam (Body) {object} [dataImport] When creating an internal table it can be built from a CSV, by using the
-   * CSV validation endpoint. Send the CSV data to the validation endpoint, then put the results of that call
-   * into this property, along with the CSV and a table/rows will be built from it. This is not supported when updating
-   * or for external tables.
+   * @apiParam (Body) {object[]} [rows] When creating a table using a compatible data source, an array of objects to be imported into the new table can be provided.
    *
    * @apiParamExample {json} Example:
    * {
@@ -99,15 +96,7 @@ router
    *     "old": "columnName",
    *     "updated": "newColumnName",
    *   },
-   *   "dataImport": {
-   *     "csvString": "column\nvalue",
-   *     "primaryDisplay": "column",
-   *     "schema": {
-   *       "column": {
-   *         "type": "string"
-   *       }
-   *     }
-   *   }
+   *   "rows": []
    * }
    *
    * @apiSuccess {object} table The response body will contain the table structure after being cleaned up and
@@ -121,30 +110,20 @@ router
     tableValidator(),
     tableController.save
   )
-  /**
-   * @api {post} /api/tables/csv/validate Validate a CSV for a table
-   * @apiName Validate a CSV for a table
-   * @apiGroup tables
-   * @apiPermission builder
-   * @apiDescription When creating a new table, or importing a CSV to an existing table the CSV must be validated and
-   * converted into a Budibase schema; this endpoint does this.
-   *
-   * @apiParam (Body) {string} csvString The CSV which is to be validated as a string.
-   * @apiParam (Body) {object} [schema] When a CSV has been validated it is possible to re-validate after changing the
-   * type of a field, by default everything will be strings as there is no way to infer types. The returned schema can
-   * be updated and then returned to the endpoint to re-validate and check if the type will work for the CSV, e.g.
-   * using a number instead of strings.
-   * @apiParam (Body) {string} [tableId] If importing data to an existing table this will pull the current table and
-   * remove any fields from the CSV schema which do not exist on the table/don't match the type of the table. When
-   * importing a CSV to an existing table only fields that are present on the table can be imported.
-   *
-   * @apiSuccess {object} schema The response body will contain a "schema" object that represents the schema found for
-   * the CSV - this will be in the same format used for table schema.s
-   */
   .post(
-    "/api/tables/csv/validate",
+    "/api/convert/csvToJson",
+    authorized(BUILDER),
+    tableController.csvToJson
+  )
+  .post(
+    "/api/tables/validateNewTableImport",
+    authorized(BUILDER),
+    tableController.validateNewTableImport
+  )
+  .post(
+    "/api/tables/validateExistingTableImport",
     authorized(BUILDER),
-    tableController.validateCSVSchema
+    tableController.validateExistingTableImport
   )
   /**
    * @api {post} /api/tables/:tableId/:revId Delete a table
@@ -177,9 +156,7 @@ router
    *
    * @apiParam {string} tableId The ID of the table which the data should be imported to.
    *
-   * @apiParam (Body) {object} dataImport This is the same as the structure used when creating an internal table with
-   * a CSV, it will have the "schema" returned from the CSV validation endpoint and the "csvString" which is to be
-   * turned into rows.
+   * @apiParam (Body) {object[]} rows An array of objects representing the rows to be imported, key-value pairs not matching the table schema will be ignored.
    *
    * @apiSuccess {string} message A message stating that the data was imported successfully.
    */
@@ -190,4 +167,4 @@ router
     tableController.bulkImport
   )
 
-export = router
+export default router

package/src/api/routes/templates.ts

@@ -13,4 +13,4 @@ router
     controller.downloadTemplate
   )
 
-export = router
+export default router

package/src/api/routes/tests/__snapshots__/{datasource.spec.js.snap → 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.js → application.spec.ts}

@@ -11,14 +11,13 @@ jest.mock("../../../utilities/redis", () => ({
   checkDebounce: jest.fn(),
   shutdown: jest.fn(),
 }))
+import { clearAllApps, checkBuilderEndpoint } from "./utilities/TestFunctions"
+import * as setup from "./utilities"
+import { AppStatus } from "../../../db/utils"
+import { events, utils } from "@budibase/backend-core"
+import env from "../../../environment"
 
-const {
-  clearAllApps,
-  checkBuilderEndpoint,
-} = require("./utilities/TestFunctions")
-const setup = require("./utilities")
-const { AppStatus } = require("../../../db/utils")
-const { events } = require("@budibase/backend-core")
+jest.setTimeout(15000)
 
 describe("/applications", () => {
   let request = setup.getRequest()
@@ -26,9 +25,11 @@ describe("/applications", () => {
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
-    await clearAllApps()
+  beforeAll(async () => {
     await config.init()
+  })
+
+  beforeEach(async () => {
     jest.clearAllMocks()
   })
 
@@ -36,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)
@@ -47,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
@@ -62,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")
@@ -109,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")
@@ -162,33 +168,30 @@ describe("/applications", () => {
     })
   })
 
-  describe("delete", () => {
-    it("should delete app", async () => {
-      await config.createApp("to-delete")
+  describe("publish", () => {
+    it("should publish app with dev app ID", async () => {
       const appId = config.getAppId()
       await request
-        .delete(`/api/applications/${appId}`)
+        .post(`/api/applications/${appId}/publish`)
         .set(config.defaultHeaders())
         .expect("Content-Type", /json/)
         .expect(200)
-      expect(events.app.deleted).toBeCalledTimes(1)
+      expect(events.app.published).toBeCalledTimes(1)
     })
 
-    it("should unpublish app", async () => {
-      await config.createApp("to-unpublish")
+    it("should publish app with prod app ID", async () => {
       const appId = config.getProdAppId()
       await request
-        .delete(`/api/applications/${appId}?unpublish=true`)
+        .post(`/api/applications/${appId}/publish`)
         .set(config.defaultHeaders())
         .expect("Content-Type", /json/)
         .expect(200)
-      expect(events.app.unpublished).toBeCalledTimes(1)
+      expect(events.app.published).toBeCalledTimes(1)
     })
   })
 
   describe("manage client library version", () => {
     it("should be able to update the app client library version", async () => {
-      console.log(config.getAppId())
       await request
         .post(`/api/applications/${config.getAppId()}/client/update`)
         .set(config.defaultHeaders())
@@ -196,6 +199,7 @@ describe("/applications", () => {
         .expect(200)
       expect(events.app.versionUpdated).toBeCalledTimes(1)
     })
+
     it("should be able to revert the app client library version", async () => {
       // We need to first update the version so that we can then revert
       await request
@@ -234,4 +238,90 @@ describe("/applications", () => {
       expect(getRes.body.application.updatedAt).toBeDefined()
     })
   })
+
+  describe("sync", () => {
+    it("app should sync correctly", async () => {
+      const res = await request
+        .post(`/api/applications/${config.getAppId()}/sync`)
+        .set(config.defaultHeaders())
+        .expect("Content-Type", /json/)
+        .expect(200)
+      expect(res.body.message).toEqual("App sync completed successfully.")
+    })
+
+    it("app should not sync if production", async () => {
+      const res = await request
+        .post(`/api/applications/app_123456/sync`)
+        .set(config.defaultHeaders())
+        .expect("Content-Type", /json/)
+        .expect(400)
+      expect(res.body.message).toEqual(
+        "This action cannot be performed for production apps"
+      )
+    })
+
+    it("app should not sync if sync is disabled", async () => {
+      env._set("DISABLE_AUTO_PROD_APP_SYNC", true)
+      const res = await request
+        .post(`/api/applications/${config.getAppId()}/sync`)
+        .set(config.defaultHeaders())
+        .expect("Content-Type", /json/)
+        .expect(200)
+      expect(res.body.message).toEqual(
+        "App sync disabled. You can reenable with the DISABLE_AUTO_PROD_APP_SYNC environment variable."
+      )
+      env._set("DISABLE_AUTO_PROD_APP_SYNC", false)
+    })
+  })
+
+  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
+        .post(`/api/applications/${appId}/unpublish`)
+        .set(config.defaultHeaders())
+        .expect(204)
+      expect(events.app.unpublished).toBeCalledTimes(1)
+    })
+
+    it("should unpublish app with prod app ID", async () => {
+      const appId = config.getProdAppId()
+      await request
+        .post(`/api/applications/${appId}/unpublish`)
+        .set(config.defaultHeaders())
+        .expect(204)
+      expect(events.app.unpublished).toBeCalledTimes(1)
+    })
+  })
+
+  describe("delete", () => {
+    it("should delete published app and dev apps with dev app ID", async () => {
+      await config.createApp("to-delete")
+      const appId = config.getAppId()
+      await request
+        .delete(`/api/applications/${appId}`)
+        .set(config.defaultHeaders())
+        .expect("Content-Type", /json/)
+        .expect(200)
+      expect(events.app.deleted).toBeCalledTimes(1)
+      expect(events.app.unpublished).toBeCalledTimes(1)
+    })
+
+    it("should delete published app and dev app with prod app ID", async () => {
+      await config.createApp("to-delete")
+      const appId = config.getProdAppId()
+      await request
+        .delete(`/api/applications/${appId}`)
+        .set(config.defaultHeaders())
+        .expect("Content-Type", /json/)
+        .expect(200)
+      expect(events.app.deleted).toBeCalledTimes(1)
+      expect(events.app.unpublished).toBeCalledTimes(1)
+    })
+  })
 })

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()
   })
@@ -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.js → backup.spec.ts}

@@ -1,16 +1,7 @@
-jest.mock("@budibase/backend-core", () => {
-  const core = jest.requireActual("@budibase/backend-core")
-  return {
-    ...core,
-    objectStore: {
-      budibaseTempDir: core.objectStore.budibaseTempDir,
-    },
-  }
-})
-
-const { checkBuilderEndpoint } = require("./utilities/TestFunctions")
-const setup = require("./utilities")
-const { events } = require("@budibase/backend-core")
+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()
@@ -30,7 +21,7 @@ describe("/backups", () => {
         .expect(200)
       expect(res.text).toBeDefined()
       expect(res.headers["content-type"]).toEqual("application/gzip")
-      expect(events.app.exported.mock.calls.length).toBe(1)
+      expect(events.app.exported).toBeCalledTimes(1)
     })
 
     it("should apply authorization to endpoint", async () => {
@@ -41,4 +32,15 @@ describe("/backups", () => {
       })
     })
   })
-})
+
+  describe("calculateBackupStats", () => {
+    it("should be able to calculate the backup statistics", async () => {
+      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.seq.spec.ts

@@ -0,0 +1,59 @@
+import { AppStatus } from "../../../db/utils"
+
+import * as setup from "./utilities"
+
+import { wipeDb } from "./utilities/TestFunctions"
+
+describe("/cloud", () => {
+  let request = setup.getRequest()
+  let config = setup.getConfig()
+
+  afterAll(setup.afterAll)
+
+  beforeAll(() => {
+    // Importing is only allowed in self hosted environments
+    config.modeSelf()
+  })
+
+  beforeEach(async () => {
+    await config.init()
+  })
+
+  afterEach(async () => {
+    // clear all mocks
+    jest.clearAllMocks()
+  })
+
+  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 wipeDb()
+
+      // 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)
+
+      // Perform the import
+      const res = await request
+        .post(`/api/cloud/import`)
+        .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())
+        .expect("Content-Type", /json/)
+        .expect(200)
+
+      // There are two apps in the file that was imported so check for this
+      expect(postImportApps.body.length).toEqual(2)
+    })
+  })
+})

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

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