@budibase/server 2.2.11 → 2.2.12-alpha.0

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/tests/{application.spec.js → application.spec.ts}

@@ -11,14 +11,11 @@ jest.mock("../../../utilities/redis", () => ({
   checkDebounce: jest.fn(),
   shutdown: jest.fn(),
 }))
-
-const {
-  clearAllApps,
-  checkBuilderEndpoint,
-} = require("./utilities/TestFunctions")
-const setup = require("./utilities")
-const { AppStatus } = require("../../../db/utils")
-const { events } = require("@budibase/backend-core")
+import { clearAllApps, checkBuilderEndpoint } from "./utilities/TestFunctions"
+import * as setup from "./utilities"
+import { AppStatus } from "../../../db/utils"
+import { events } from "@budibase/backend-core"
+import env from "../../../environment"
 
 describe("/applications", () => {
   let request = setup.getRequest()
@@ -162,33 +159,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 +190,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 +229,85 @@ 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", () => {
+    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/{backup.spec.js → backup.spec.ts}

@@ -8,10 +8,10 @@ jest.mock("@budibase/backend-core", () => {
   }
 })
 
-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()
   let config = setup.getConfig()
@@ -30,7 +30,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 +41,15 @@ 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())
+      expect(res.automations).toEqual(1)
+      expect(res.datasources).toEqual(1)
+      expect(res.screens).toEqual(1)
+    })
+  })
+})

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

@@ -0,0 +1,65 @@
+import { db as dbCore } from "@budibase/backend-core"
+import { AppStatus } from "../../../db/utils"
+
+import * as setup from "./utilities"
+
+describe("/cloud", () => {
+  let request = setup.getRequest()
+  let config = setup.getConfig()
+
+  afterAll(setup.afterAll)
+
+  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 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)
+
+      // 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/{datasource.spec.js → datasource.spec.ts}

@@ -1,16 +1,16 @@
 jest.mock("pg")
+import * as setup from "./utilities"
+import { checkBuilderEndpoint } from "./utilities/TestFunctions"
+import { checkCacheForDynamicVariable } from "../../../threads/utils"
+import { events } from "@budibase/backend-core"
 
-let setup = require("./utilities")
 let { basicDatasource } = setup.structures
-let { checkBuilderEndpoint } = require("./utilities/TestFunctions")
 const pg = require("pg")
-const { checkCacheForDynamicVariable } = require("../../../threads/utils")
-const { events } = require("@budibase/backend-core") 
 
 describe("/datasources", () => {
   let request = setup.getRequest()
   let config = setup.getConfig()
-  let datasource
+  let datasource: any
 
   afterAll(setup.afterAll)
 
@@ -26,7 +26,7 @@ describe("/datasources", () => {
         .post(`/api/datasources`)
         .send(basicDatasource())
         .set(config.defaultHeaders())
-        .expect('Content-Type', /json/)
+        .expect("Content-Type", /json/)
         .expect(200)
 
       expect(res.body.datasource.name).toEqual("Test")
@@ -42,7 +42,7 @@ describe("/datasources", () => {
         .put(`/api/datasources/${datasource._id}`)
         .send(datasource)
         .set(config.defaultHeaders())
-        .expect('Content-Type', /json/)
+        .expect("Content-Type", /json/)
         .expect(200)
 
       expect(res.body.datasource.name).toEqual("Updated Test")
@@ -51,25 +51,34 @@ describe("/datasources", () => {
     })
 
     describe("dynamic variables", () => {
-      async function preview(datasource, fields) {
+      async function preview(
+        datasource: any,
+        fields: { path: string; queryString: string }
+      ) {
         return config.previewQuery(request, config, datasource, fields)
       }
 
       it("should invalidate changed or removed variables", async () => {
         const { datasource, query } = await config.dynamicVariableDatasource()
         // preview once to cache variables
-        await preview(datasource, { path: "www.test.com", queryString: "test={{ variable3 }}" })
+        await preview(datasource, {
+          path: "www.test.com",
+          queryString: "test={{ variable3 }}",
+        })
         // check variables in cache
-        let contents = await checkCacheForDynamicVariable(query._id, "variable3")
+        let contents = await checkCacheForDynamicVariable(
+          query._id,
+          "variable3"
+        )
         expect(contents.rows.length).toEqual(1)
-        
+
         // update the datasource to remove the variables
         datasource.config.dynamicVariables = []
         const res = await request
           .put(`/api/datasources/${datasource._id}`)
           .send(datasource)
           .set(config.defaultHeaders())
-          .expect('Content-Type', /json/)
+          .expect("Content-Type", /json/)
           .expect(200)
         expect(res.body.errors).toBeUndefined()
 
@@ -85,7 +94,7 @@ describe("/datasources", () => {
       const res = await request
         .get(`/api/datasources`)
         .set(config.defaultHeaders())
-        .expect('Content-Type', /json/)
+        .expect("Content-Type", /json/)
         .expect(200)
 
       const datasources = res.body
@@ -160,7 +169,7 @@ describe("/datasources", () => {
       const res = await request
         .get(`/api/datasources`)
         .set(config.defaultHeaders())
-        .expect('Content-Type', /json/)
+        .expect("Content-Type", /json/)
         .expect(200)
 
       expect(res.body.length).toEqual(1)
@@ -174,6 +183,5 @@ describe("/datasources", () => {
         url: `/api/datasources/${datasource._id}/${datasource._rev}`,
       })
     })
-
   })
 })

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

@@ -92,7 +92,7 @@ describe("/permission", () => {
   describe("check public user allowed", () => {
     it("should be able to read the row", async () => {
       // replicate changes before checking permissions
-      await config.deploy()
+      await config.publish()
 
       const res = await request
         .get(`/api/${table._id}/rows`)

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

@@ -0,0 +1,179 @@
+let mockObjectStore = jest.fn().mockImplementation(() => {
+  return [{ name: "test.js" }]
+})
+
+let deleteFolder = jest.fn().mockImplementation()
+jest.mock("@budibase/backend-core", () => {
+  const core = jest.requireActual("@budibase/backend-core")
+  return {
+    ...core,
+    objectStore: {
+      ...core.objectStore,
+      upload: jest.fn(),
+      uploadDirectory: mockObjectStore,
+      deleteFolder: deleteFolder,
+    },
+  }
+})
+
+import { events } from "@budibase/backend-core"
+import * as setup from "./utilities"
+
+describe("/plugins", () => {
+  let request = setup.getRequest()
+  let config = setup.getConfig()
+
+  afterAll(setup.afterAll)
+
+  beforeEach(async () => {
+    await config.init()
+    jest.clearAllMocks()
+  })
+
+  const createPlugin = async (status?: number) => {
+    return request
+      .post(`/api/plugin/upload`)
+      .attach("file", "src/api/routes/tests/data/comment-box-1.0.2.tar.gz")
+      .set(config.defaultHeaders())
+      .expect("Content-Type", /json/)
+      .expect(status ? status : 200)
+  }
+
+  const getPlugins = async (status?: number) => {
+    return request
+      .get(`/api/plugin`)
+      .set(config.defaultHeaders())
+      .expect("Content-Type", /json/)
+      .expect(status ? status : 200)
+  }
+
+  describe("upload", () => {
+    it("should be able to upload a plugin", async () => {
+      let res = await createPlugin()
+      expect(res.body).toBeDefined()
+      expect(res.body.plugins).toBeDefined()
+      expect(res.body.plugins[0]._id).toEqual("plg_comment-box")
+      expect(events.plugin.imported).toHaveBeenCalledTimes(1)
+    })
+
+    it("should not be able to create a plugin if there is an error", async () => {
+      mockObjectStore.mockImplementationOnce(() => {
+        throw new Error()
+      })
+      let res = await createPlugin(400)
+      expect(res.body.message).toEqual("Failed to import plugin: Error")
+      expect(events.plugin.imported).toHaveBeenCalledTimes(0)
+    })
+  })
+
+  describe("fetch", () => {
+    it("should be able to fetch plugins", async () => {
+      await createPlugin()
+      const res = await getPlugins()
+      expect(res.body).toBeDefined()
+      expect(res.body[0]._id).toEqual("plg_comment-box")
+    })
+  })
+
+  describe("destroy", () => {
+    it("should be able to delete a plugin", async () => {
+      await createPlugin()
+      const res = await request
+        .delete(`/api/plugin/plg_comment-box`)
+        .set(config.defaultHeaders())
+        .expect("Content-Type", /json/)
+        .expect(200)
+      expect(res.body).toBeDefined()
+      expect(res.body.message).toEqual("Plugin plg_comment-box deleted.")
+
+      const plugins = await getPlugins()
+      expect(plugins.body).toBeDefined()
+      expect(plugins.body.length).toEqual(0)
+      expect(events.plugin.deleted).toHaveBeenCalledTimes(1)
+    })
+    it("should handle an error deleting a plugin", async () => {
+      deleteFolder.mockImplementationOnce(() => {
+        throw new Error()
+      })
+
+      await createPlugin()
+      const res = await request
+        .delete(`/api/plugin/plg_comment-box`)
+        .set(config.defaultHeaders())
+        .expect("Content-Type", /json/)
+        .expect(400)
+
+      expect(res.body.message).toEqual("Failed to delete plugin: Error")
+      expect(events.plugin.deleted).toHaveBeenCalledTimes(0)
+      const plugins = await getPlugins()
+      expect(plugins.body).toBeDefined()
+      expect(plugins.body.length).toEqual(1)
+    })
+  })
+
+  describe("github", () => {
+    const createGithubPlugin = async (status?: number, url?: string) => {
+      return await request
+        .post(`/api/plugin`)
+        .send({
+          source: "Github",
+          url,
+          githubToken: "token",
+        })
+        .set(config.defaultHeaders())
+        .expect("Content-Type", /json/)
+        .expect(status ? status : 200)
+    }
+    it("should be able to create a plugin from github", async () => {
+      const res = await createGithubPlugin(
+        200,
+        "https://github.com/my-repo/budibase-comment-box.git"
+      )
+      expect(res.body).toBeDefined()
+      expect(res.body.plugin).toBeDefined()
+      expect(res.body.plugin._id).toEqual("plg_comment-box")
+    })
+    it("should fail if the url is not from github", async () => {
+      const res = await createGithubPlugin(
+        400,
+        "https://notgithub.com/my-repo/budibase-comment-box"
+      )
+      expect(res.body.message).toEqual(
+        "Failed to import plugin: The plugin origin must be from Github"
+      )
+    })
+  })
+  describe("npm", () => {
+    it("should be able to create a plugin from npm", async () => {
+      const res = await request
+        .post(`/api/plugin`)
+        .send({
+          source: "NPM",
+          url: "https://www.npmjs.com/package/budibase-component",
+        })
+        .set(config.defaultHeaders())
+        .expect("Content-Type", /json/)
+        .expect(200)
+      expect(res.body).toBeDefined()
+      expect(res.body.plugin._id).toEqual("plg_budibase-component")
+      expect(events.plugin.imported).toHaveBeenCalled()
+    })
+  })
+
+  describe("url", () => {
+    it("should be able to create a plugin from a URL", async () => {
+      const res = await request
+        .post(`/api/plugin`)
+        .send({
+          source: "URL",
+          url: "https://www.someurl.com/comment-box/comment-box-1.0.2.tar.gz",
+        })
+        .set(config.defaultHeaders())
+        .expect("Content-Type", /json/)
+        .expect(200)
+      expect(res.body).toBeDefined()
+      expect(res.body.plugin._id).toEqual("plg_comment-box")
+      expect(events.plugin.imported).toHaveBeenCalledTimes(1)
+    })
+  })
+})

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

@@ -9,7 +9,6 @@ const route = "/test"
 // there are checks which are disabled in test env,
 // these checks need to be enabled for this test
 
-
 describe("/routing", () => {
   let request = setup.getRequest()
   let config = setup.getConfig()
@@ -26,7 +25,7 @@ describe("/routing", () => {
     screen2.routing.roleId = BUILTIN_ROLE_IDS.POWER
     screen2.routing.route = route
     screen2 = await config.createScreen(screen2)
-    await config.deploy()
+    await config.publish()
   })
 
   describe("fetch", () => {

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

@@ -10,6 +10,7 @@ const {
   StaticQuotaName,
   MonthlyQuotaName,
 } = require("@budibase/types")
+const { structures } = require("@budibase/backend-core/tests");
 
 describe("/rows", () => {
   let request = setup.getRequest()
@@ -494,12 +495,13 @@ describe("/rows", () => {
   describe("attachments", () => {
     it("should allow enriching attachment rows", async () => {
       const table = await config.createAttachmentTable()
+      const attachmentId = `${structures.uuid()}.csv`
       const row = await config.createRow({
         name: "test",
         description: "test",
         attachment: [
           {
-            key: `${config.getAppId()}/attachments/test/thing.csv`,
+            key: `${config.getAppId()}/attachments/${attachmentId}`,
           },
         ],
         tableId: table._id,
@@ -509,7 +511,7 @@ describe("/rows", () => {
         context.doInAppContext(config.getAppId(), async () => {
           const enriched = await outputProcessing(table, [row])
           expect(enriched[0].attachment[0].url).toBe(
-            `/prod-budi-app-assets/${config.getAppId()}/attachments/test/thing.csv`
+            `/files/signed/prod-budi-app-assets/${config.getProdAppId()}/attachments/${attachmentId}`
           )
         })
       })