@budibase/server 2.2.4-alpha.7 → 2.2.4-alpha.9

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/server",
   "email": "hi@budibase.com",
-  "version": "2.2.4-alpha.7",
+  "version": "2.2.4-alpha.9",
   "description": "Budibase Web Server",
   "main": "src/index.ts",
   "repository": {
@@ -43,11 +43,11 @@
   "license": "GPL-3.0",
   "dependencies": {
     "@apidevtools/swagger-parser": "10.0.3",
-    "@budibase/backend-core": "2.2.4-alpha.7",
-    "@budibase/client": "2.2.4-alpha.7",
-    "@budibase/pro": "2.2.4-alpha.6",
-    "@budibase/string-templates": "2.2.4-alpha.7",
-    "@budibase/types": "2.2.4-alpha.7",
+    "@budibase/backend-core": "2.2.4-alpha.9",
+    "@budibase/client": "2.2.4-alpha.9",
+    "@budibase/pro": "2.2.4-alpha.8",
+    "@budibase/string-templates": "2.2.4-alpha.9",
+    "@budibase/types": "2.2.4-alpha.9",
     "@bull-board/api": "3.7.0",
     "@bull-board/koa": "3.9.4",
     "@elastic/elasticsearch": "7.10.0",
@@ -167,5 +167,5 @@
   "optionalDependencies": {
     "oracledb": "5.3.0"
   },
-  "gitHead": "2a69f0d281f915953b7a8bf281dd1f60fdb4a261"
+  "gitHead": "f923199296c2c55de0e1566daa31dea5d9438237"
 }

package/specs/openapi.json

@@ -567,6 +567,40 @@
           "data"
         ]
       },
+      "deploymentOutput": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "type": "object",
+            "properties": {
+              "_id": {
+                "description": "The ID of the app.",
+                "type": "string"
+              },
+              "status": {
+                "description": "Status of the deployment, whether it succeeded or failed",
+                "type": "string",
+                "enum": [
+                  "SUCCESS",
+                  "FAILURE"
+                ]
+              },
+              "appUrl": {
+                "description": "The URL of the published app",
+                "type": "string"
+              }
+            },
+            "required": [
+              "_id",
+              "status",
+              "appUrl"
+            ]
+          }
+        },
+        "required": [
+          "data"
+        ]
+      },
       "row": {
         "description": "The row to be created/updated, based on the table schema.",
         "type": "object",
@@ -1933,6 +1967,56 @@
         }
       }
     },
+    "/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."
+          }
+        }
+      }
+    },
+    "/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"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/applications/search": {
       "post": {
         "operationId": "search",

package/specs/openapi.yaml

@@ -411,6 +411,30 @@ components:
               - version
       required:
         - data
+    deploymentOutput:
+      type: object
+      properties:
+        data:
+          type: object
+          properties:
+            _id:
+              description: The ID of the app.
+              type: string
+            status:
+              description: Status of the deployment, whether it succeeded or failed
+              type: string
+              enum:
+                - SUCCESS
+                - FAILURE
+            appUrl:
+              description: The URL of the published app
+              type: string
+          required:
+            - _id
+            - status
+            - appUrl
+      required:
+        - data
     row:
       description: The row to be created/updated, based on the table schema.
       type: object
@@ -1453,6 +1477,35 @@ paths:
               examples:
                 application:
                   $ref: "#/components/examples/application"
+  "/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.
+  "/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"
   /applications/search:
     post:
       operationId: search

package/specs/resources/application.js

@@ -80,6 +80,22 @@ const applicationOutputSchema = object(
   }
 )
 
+const deploymentOutputSchema = object({
+  _id: {
+    description: "The ID of the app.",
+    type: "string",
+  },
+  status: {
+    description: "Status of the deployment, whether it succeeded or failed",
+    type: "string",
+    enum: ["SUCCESS", "FAILURE"],
+  },
+  appUrl: {
+    description: "The URL of the published app",
+    type: "string",
+  },
+})
+
 module.exports = new Resource()
   .setExamples({
     application: {
@@ -104,4 +120,7 @@ module.exports = new Resource()
         items: applicationOutputSchema,
       },
     }),
+    deploymentOutput: object({
+      data: deploymentOutputSchema,
+    }),
   })

package/src/api/controllers/application.ts

@@ -50,6 +50,7 @@ import {
 } from "@budibase/types"
 import { BASE_LAYOUT_PROP_IDS } from "../../constants/layouts"
 import sdk from "../../sdk"
+import { getDB } from "@budibase/backend-core/src/db"
 
 // utility function, need to do away with this
 async function getLayouts() {
@@ -464,41 +465,47 @@ export async function revertClient(ctx: BBContext) {
   ctx.body = app
 }
 
+const unpublishApp = async (ctx: any) => {
+  let appId = ctx.params.appId
+  appId = dbCore.getProdAppID(appId)
+
+  const db = context.getProdAppDB()
+  const result = await db.destroy()
+
+  await events.app.unpublished({ appId } as App)
+
+  // automations only in production
+  await cleanupAutomations(appId)
+
+  await cache.app.invalidateAppMetadata(appId)
+  return result
+}
+
 async function destroyApp(ctx: BBContext) {
   let appId = ctx.params.appId
-  let isUnpublish = ctx.query && ctx.query.unpublish
+  appId = dbCore.getProdAppID(appId)
+  const devAppId = dbCore.getDevAppID(appId)
 
-  if (isUnpublish) {
-    appId = dbCore.getProdAppID(appId)
-    const devAppId = dbCore.getDevAppID(appId)
-    // sync before removing the published app
+  // check if we need to unpublish first
+  if (await dbCore.dbExists(appId)) {
+    // app is deployed, run through unpublish flow
     await sdk.applications.syncApp(devAppId)
+    await unpublishApp(ctx)
   }
 
-  const db = isUnpublish ? context.getProdAppDB() : context.getAppDB()
+  const db = dbCore.getDB(devAppId)
+  // standard app deletion flow
   const app = await db.get(DocumentType.APP_METADATA)
   const result = await db.destroy()
+  await quotas.removeApp()
+  await events.app.deleted(app)
 
-  if (isUnpublish) {
-    await events.app.unpublished(app)
-  } else {
-    await quotas.removeApp()
-    await events.app.deleted(app)
-  }
-
-  /* istanbul ignore next */
-  if (!env.isTest() && !isUnpublish) {
+  if (!env.isTest()) {
     await deleteApp(appId)
   }
-  // automations only in production
-  if (isUnpublish) {
-    await cleanupAutomations(appId)
-  }
-  // remove app role when the dev app is deleted (no trace of app anymore)
-  else {
-    await removeAppFromUserRoles(ctx, appId)
-  }
-  await cache.app.invalidateAppMetadata(appId)
+
+  await removeAppFromUserRoles(ctx, appId)
+  await cache.app.invalidateAppMetadata(devAppId)
   return result
 }
 
@@ -523,6 +530,21 @@ export async function destroy(ctx: BBContext) {
   ctx.body = result
 }
 
+export const unpublish = async (ctx: BBContext) => {
+  const prodAppId = dbCore.getProdAppID(ctx.params.appId)
+  const dbExists = await dbCore.dbExists(prodAppId)
+
+  // check app has been published
+  if (!dbExists) {
+    return ctx.throw(400, "App has not been published.")
+  }
+
+  await preDestroyApp(ctx)
+  await unpublishApp(ctx)
+  await postDestroyApp(ctx)
+  ctx.status = 204
+}
+
 export async function sync(ctx: BBContext) {
   const appId = ctx.params.appId
   try {

package/src/api/controllers/cloud.ts

@@ -82,7 +82,7 @@ export async function importApps(ctx: Ctx) {
       "Import file is required and environment must be fresh to import apps."
     )
   }
-  const file = ctx.request.files.importFile
+  const file = ctx.request.files.importFile as any
   if (Array.isArray(file)) {
     ctx.throw(400, "Single file is required")
   }

package/src/api/controllers/deploy/Deployment.ts

@@ -9,6 +9,7 @@ export default class Deployment {
   verification: any
   status?: string
   err?: any
+  appUrl?: string
 
   constructor(id = null) {
     this._id = id || newid()

package/src/api/controllers/deploy/index.ts

@@ -94,7 +94,44 @@ async function initDeployedApp(prodAppId: any) {
   })
 }
 
-async function deployApp(deployment: any, userId: string) {
+export async function fetchDeployments(ctx: any) {
+  try {
+    const db = context.getAppDB()
+    const deploymentDoc = await db.get(DocumentType.DEPLOYMENTS)
+    const { updated, deployments } = await checkAllDeployments(deploymentDoc)
+    if (updated) {
+      await db.put(deployments)
+    }
+    ctx.body = Object.values(deployments.history).reverse()
+  } catch (err) {
+    ctx.body = []
+  }
+}
+
+export async function deploymentProgress(ctx: any) {
+  try {
+    const db = context.getAppDB()
+    const deploymentDoc = await db.get(DocumentType.DEPLOYMENTS)
+    ctx.body = deploymentDoc[ctx.params.deploymentId]
+  } catch (err) {
+    ctx.throw(
+      500,
+      `Error fetching data for deployment ${ctx.params.deploymentId}`
+    )
+  }
+}
+
+export const publishApp = async function (ctx: any) {
+  let deployment = new Deployment()
+  console.log("Deployment object created")
+  deployment.setStatus(DeploymentStatus.PENDING)
+  console.log("Deployment object set to pending")
+  deployment = await storeDeploymentHistory(deployment)
+  console.log("Stored deployment history")
+
+  console.log("Deploying app...")
+
+  let app
   let replication
   try {
     const appId = context.getAppId()!
@@ -108,7 +145,7 @@ async function deployApp(deployment: any, userId: string) {
         productionAppId,
         AppBackupTrigger.PUBLISH,
         {
-          createdBy: userId,
+          createdBy: ctx.user._id,
         }
       )
     }
@@ -147,7 +184,7 @@ async function deployApp(deployment: any, userId: string) {
     console.log("Deployed app initialised, setting deployment to successful")
     deployment.setStatus(DeploymentStatus.SUCCESS)
     await storeDeploymentHistory(deployment)
-    return appDoc
+    app = appDoc
   } catch (err: any) {
     deployment.setStatus(DeploymentStatus.FAILURE, err.message)
     await storeDeploymentHistory(deployment)
@@ -160,62 +197,7 @@ async function deployApp(deployment: any, userId: string) {
       await replication.close()
     }
   }
-}
-
-export async function fetchDeployments(ctx: any) {
-  try {
-    const db = context.getAppDB()
-    const deploymentDoc = await db.get(DocumentType.DEPLOYMENTS)
-    const { updated, deployments } = await checkAllDeployments(deploymentDoc)
-    if (updated) {
-      await db.put(deployments)
-    }
-    ctx.body = Object.values(deployments.history).reverse()
-  } catch (err) {
-    ctx.body = []
-  }
-}
-
-export async function deploymentProgress(ctx: any) {
-  try {
-    const db = context.getAppDB()
-    const deploymentDoc = await db.get(DocumentType.DEPLOYMENTS)
-    ctx.body = deploymentDoc[ctx.params.deploymentId]
-  } catch (err) {
-    ctx.throw(
-      500,
-      `Error fetching data for deployment ${ctx.params.deploymentId}`
-    )
-  }
-}
-
-const isFirstDeploy = async () => {
-  try {
-    const db = context.getProdAppDB()
-    await db.get(DocumentType.APP_METADATA)
-  } catch (e: any) {
-    if (e.status === 404) {
-      return true
-    }
-    throw e
-  }
-  return false
-}
-
-const _deployApp = async function (ctx: any) {
-  let deployment = new Deployment()
-  console.log("Deployment object created")
-  deployment.setStatus(DeploymentStatus.PENDING)
-  console.log("Deployment object set to pending")
-  deployment = await storeDeploymentHistory(deployment)
-  console.log("Stored deployment history")
-
-  console.log("Deploying app...")
-
-  let app = await deployApp(deployment, ctx.user._id)
 
   await events.app.published(app)
   ctx.body = deployment
 }
-
-export { _deployApp as deployApp }

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

@@ -1,6 +1,7 @@
 import { db as dbCore, context } from "@budibase/backend-core"
 import { search as stringSearch, addRev } from "./utils"
 import * as controller from "../application"
+import * as deployController from "../deploy"
 import { Application } from "../../../definitions/common"
 
 function fixAppID(app: Application, params: any) {
@@ -74,10 +75,26 @@ export async function destroy(ctx: any, next: any) {
   })
 }
 
+export async function unpublish(ctx: any, next: any) {
+  await context.doInAppContext(ctx.params.appId, async () => {
+    await controller.unpublish(ctx)
+    await next()
+  })
+}
+
+export async function publish(ctx: any, next: any) {
+  await context.doInAppContext(ctx.params.appId, async () => {
+    await deployController.publishApp(ctx)
+    await next()
+  })
+}
+
 export default {
   create,
   update,
   read,
   destroy,
   search,
+  publish,
+  unpublish,
 }

package/src/api/routes/application.ts

@@ -1,5 +1,6 @@
 import Router from "@koa/router"
 import * as controller from "../controllers/application"
+import * as deploymentController from "../controllers/deploy"
 import authorized from "../../middleware/authorized"
 import { permissions } from "@budibase/backend-core"
 import { applicationValidator } from "./utils/validators"
@@ -37,6 +38,16 @@ router
     authorized(permissions.BUILDER),
     controller.revertClient
   )
+  .post(
+    "/api/applications/:appId/publish",
+    authorized(permissions.BUILDER),
+    deploymentController.publishApp
+  )
+  .post(
+    "/api/applications/:appId/unpublish",
+    authorized(permissions.BUILDER),
+    controller.unpublish
+  )
   .delete(
     "/api/applications/:appId",
     authorized(permissions.BUILDER),

package/src/api/routes/deploy.ts

@@ -16,6 +16,5 @@ router
     authorized(permissions.BUILDER),
     controller.deploymentProgress
   )
-  .post("/api/deploy", authorized(permissions.BUILDER), controller.deployApp)
 
 export = router

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)