@budibase/server 2.2.12-alpha.1 → 2.2.12

package/specs/openapi.json

@@ -567,40 +567,6 @@
           "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",
@@ -1967,56 +1933,6 @@
         }
       }
     },
-    "/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,30 +411,6 @@ 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
@@ -1477,35 +1453,6 @@ 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,22 +80,6 @@ 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: {
@@ -120,7 +104,4 @@ module.exports = new Resource()
         items: applicationOutputSchema,
       },
     }),
-    deploymentOutput: object({
-      data: deploymentOutputSchema,
-    }),
   })

package/src/api/controllers/application.ts

@@ -23,18 +23,21 @@ import {
   errors,
   events,
   migrations,
-  objectStore,
 } from "@budibase/backend-core"
 import { USERS_TABLE_SCHEMA } from "../../constants"
 import { buildDefaultDocs } from "../../db/defaultData/datasource_bb_default"
 import { removeAppFromUserRoles } from "../../utilities/workerRequests"
-import { stringToReadStream, isQsTrue } from "../../utilities"
+import {
+  clientLibraryPath,
+  stringToReadStream,
+  isQsTrue,
+} from "../../utilities"
 import { getLocksById } from "../../utilities/redis"
 import {
   updateClientLibrary,
   backupClientLibrary,
   revertClientLibrary,
-} from "../../utilities/fileSystem"
+} from "../../utilities/fileSystem/clientLibrary"
 import { cleanupAutomations } from "../../automations/utils"
 import { checkAppMetadata } from "../../automations/logging"
 import { getUniqueRows } from "../../utilities/usageQuota/rows"
@@ -46,9 +49,9 @@ import {
   MigrationType,
   BBContext,
   Database,
-  UserCtx,
 } from "@budibase/types"
 import { BASE_LAYOUT_PROP_IDS } from "../../constants/layouts"
+import { enrichPluginURLs } from "../../utilities/plugins"
 import sdk from "../../sdk"
 
 // utility function, need to do away with this
@@ -201,34 +204,27 @@ export async function fetchAppDefinition(ctx: BBContext) {
   }
 }
 
-export async function fetchAppPackage(ctx: UserCtx) {
+export async function fetchAppPackage(ctx: BBContext) {
   const db = context.getAppDB()
   let application = await db.get(DocumentType.APP_METADATA)
   const layouts = await getLayouts()
   let screens = await getScreens()
 
   // Enrich plugin URLs
-  application.usedPlugins = objectStore.enrichPluginURLs(
-    application.usedPlugins
-  )
+  application.usedPlugins = enrichPluginURLs(application.usedPlugins)
 
   // Only filter screens if the user is not a builder
-  if (!(ctx.user.builder && ctx.user.builder.global)) {
+  if (!(ctx.user?.builder && ctx.user.builder.global)) {
     const userRoleId = getUserRoleId(ctx)
     const accessController = new roles.AccessController()
     screens = await accessController.checkScreensAccess(screens, userRoleId)
   }
 
-  const clientLibPath = objectStore.clientLibraryUrl(
-    ctx.params.appId,
-    application.version
-  )
-
   ctx.body = {
     application,
     screens,
     layouts,
-    clientLibPath,
+    clientLibPath: clientLibraryPath(ctx.params.appId, application.version),
   }
 }
 
@@ -374,7 +370,7 @@ async function appPostCreate(ctx: BBContext, app: App) {
         if (err.code && err.code === errors.codes.USAGE_LIMIT_EXCEEDED) {
           // this import resulted in row usage exceeding the quota
           // delete the app
-          // skip pre and post-steps as no rows have been added to quotas yet
+          // skip pre- and post-steps as no rows have been added to quotas yet
           ctx.params.appId = app.appId
           await destroyApp(ctx)
         }
@@ -464,47 +460,41 @@ 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
-  appId = dbCore.getProdAppID(appId)
-  const devAppId = dbCore.getDevAppID(appId)
+  let isUnpublish = ctx.query && ctx.query.unpublish
 
-  // check if we need to unpublish first
-  if (await dbCore.dbExists(appId)) {
-    // app is deployed, run through unpublish flow
+  if (isUnpublish) {
+    appId = dbCore.getProdAppID(appId)
+    const devAppId = dbCore.getDevAppID(appId)
+    // sync before removing the published app
     await sdk.applications.syncApp(devAppId)
-    await unpublishApp(ctx)
   }
 
-  const db = dbCore.getDB(devAppId)
-  // standard app deletion flow
+  const db = isUnpublish ? context.getProdAppDB() : context.getAppDB()
   const app = await db.get(DocumentType.APP_METADATA)
   const result = await db.destroy()
-  await quotas.removeApp()
-  await events.app.deleted(app)
 
-  if (!env.isTest()) {
-    await deleteApp(appId)
+  if (isUnpublish) {
+    await events.app.unpublished(app)
+  } else {
+    await quotas.removeApp()
+    await events.app.deleted(app)
   }
 
-  await removeAppFromUserRoles(ctx, appId)
-  await cache.app.invalidateAppMetadata(devAppId)
+  /* istanbul ignore next */
+  if (!env.isTest() && !isUnpublish) {
+    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)
   return result
 }
 
@@ -529,21 +519,6 @@ 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/auth.ts

@@ -3,7 +3,7 @@ import { InternalTables } from "../../db/utils"
 import { getFullUser } from "../../utilities/users"
 import { roles, context } from "@budibase/backend-core"
 import { groups } from "@budibase/pro"
-import { ContextUser, User, Row, UserCtx } from "@budibase/types"
+import { ContextUser, User, Row } from "@budibase/types"
 
 const PUBLIC_ROLE = roles.BUILTIN_ROLE_IDS.PUBLIC
 
@@ -16,7 +16,7 @@ const addSessionAttributesToUser = (ctx: any) => {
   }
 }
 
-export async function fetchSelf(ctx: UserCtx) {
+export async function fetchSelf(ctx: any) {
   let userId = ctx.user.userId || ctx.user._id
   /* istanbul ignore next */
   if (!userId || !ctx.isAuthenticated) {

package/src/api/controllers/cloud.ts

@@ -5,8 +5,8 @@ import { stringToReadStream } from "../../utilities"
 import { getDocParams, DocumentType, isDevAppID } from "../../db/utils"
 import { create } from "./application"
 import { join } from "path"
+import { App, BBContext, Database } from "@budibase/types"
 import sdk from "../../sdk"
-import { App, Ctx, Database } from "@budibase/types"
 
 async function createApp(appName: string, appDirectory: string) {
   const ctx = {
@@ -35,7 +35,7 @@ async function getAllDocType(db: Database, docType: string) {
   return response.rows.map(row => row.doc)
 }
 
-export async function exportApps(ctx: Ctx) {
+export async function exportApps(ctx: BBContext) {
   if (env.SELF_HOSTED || !env.MULTI_TENANCY) {
     ctx.throw(400, "Exporting only allowed in multi-tenant cloud environments.")
   }
@@ -65,13 +65,13 @@ async function checkHasBeenImported() {
   return apps.length !== 0
 }
 
-export async function hasBeenImported(ctx: Ctx) {
+export async function hasBeenImported(ctx: BBContext) {
   ctx.body = {
     imported: await checkHasBeenImported(),
   }
 }
 
-export async function importApps(ctx: Ctx) {
+export async function importApps(ctx: BBContext) {
   if (!env.SELF_HOSTED || env.MULTI_TENANCY) {
     ctx.throw(400, "Importing only allowed in self hosted environments.")
   }
@@ -82,16 +82,12 @@ export async function importApps(ctx: Ctx) {
       "Import file is required and environment must be fresh to import apps."
     )
   }
-  const file = ctx.request.files.importFile as any
-  if (Array.isArray(file)) {
-    ctx.throw(400, "Single file is required")
-  }
-  if (file.type !== "application/gzip") {
+  if (ctx.request.files.importFile.type !== "application/gzip") {
     ctx.throw(400, "Import file must be a gzipped tarball.")
   }
 
   // initially get all the app databases out of the tarball
-  const tmpPath = sdk.backups.untarFile(file)
+  const tmpPath = sdk.backups.untarFile(ctx.request.files.importFile)
   const globalDbImport = sdk.backups.getGlobalDBFile(tmpPath)
   const appNames = sdk.backups.getListOfAppsInMulti(tmpPath)
 

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

@@ -9,7 +9,6 @@ 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,44 +94,7 @@ async function initDeployedApp(prodAppId: any) {
   })
 }
 
-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
+async function deployApp(deployment: any, userId: string) {
   let replication
   try {
     const appId = context.getAppId()!
@@ -145,7 +108,7 @@ export const publishApp = async function (ctx: any) {
         productionAppId,
         AppBackupTrigger.PUBLISH,
         {
-          createdBy: ctx.user._id,
+          createdBy: userId,
         }
       )
     }
@@ -184,7 +147,7 @@ export const publishApp = async function (ctx: any) {
     console.log("Deployed app initialised, setting deployment to successful")
     deployment.setStatus(DeploymentStatus.SUCCESS)
     await storeDeploymentHistory(deployment)
-    app = appDoc
+    return appDoc
   } catch (err: any) {
     deployment.setStatus(DeploymentStatus.FAILURE, err.message)
     await storeDeploymentHistory(deployment)
@@ -197,7 +160,62 @@ export const publishApp = async function (ctx: any) {
       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/plugin/index.ts

@@ -1,14 +1,10 @@
 import { npmUpload, urlUpload, githubUpload, fileUpload } from "./uploaders"
-import {
-  plugins as pluginCore,
-  db as dbCore,
-  tenancy,
-  objectStore,
-} from "@budibase/backend-core"
-import { PluginType, FileType, PluginSource, Plugin } from "@budibase/types"
+import { plugins as pluginCore, tenancy } from "@budibase/backend-core"
+import { PluginType, FileType, PluginSource } from "@budibase/types"
 import env from "../../../environment"
 import { ClientAppSocket } from "../../../websocket"
-import { sdk as pro } from "@budibase/pro"
+import { db as dbCore } from "@budibase/backend-core"
+import { plugins } from "@budibase/pro"
 
 export async function getPlugins(type?: PluginType) {
   const db = tenancy.getGlobalDB()
@@ -17,10 +13,9 @@ export async function getPlugins(type?: PluginType) {
       include_docs: true,
     })
   )
-  let plugins = response.rows.map((row: any) => row.doc) as Plugin[]
-  plugins = objectStore.enrichPluginURLs(plugins)
+  const plugins = response.rows.map((row: any) => row.doc)
   if (type) {
-    return plugins.filter((plugin: Plugin) => plugin.schema?.type === type)
+    return plugins.filter((plugin: any) => plugin.schema?.type === type)
   } else {
     return plugins
   }
@@ -89,7 +84,7 @@ export async function create(ctx: any) {
       )
     }
 
-    const doc = await pro.plugins.storePlugin(metadata, directory, source)
+    const doc = await plugins.storePlugin(metadata, directory, source)
 
     ClientAppSocket.emit("plugins-update", { name, hash: doc.hash })
     ctx.body = {
@@ -112,7 +107,7 @@ export async function destroy(ctx: any) {
   const { pluginId } = ctx.params
 
   try {
-    await pro.plugins.deletePlugin(pluginId)
+    await plugins.deletePlugin(pluginId)
 
     ctx.body = { message: `Plugin ${ctx.params.pluginId} deleted.` }
   } catch (err: any) {
@@ -132,7 +127,7 @@ export async function processUploadedPlugin(
     throw new Error("Only component plugins are supported outside of self-host")
   }
 
-  const doc = await pro.plugins.storePlugin(metadata, directory, source)
+  const doc = await plugins.storePlugin(metadata, directory, source)
   ClientAppSocket.emit("plugin-update", { name: doc.name, hash: doc.hash })
   return doc
 }

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

@@ -1,7 +1,6 @@
 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) {
@@ -75,26 +74,10 @@ 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/controllers/row/ExternalRequest.ts

@@ -21,6 +21,7 @@ import { getDatasourceAndQuery } from "./utils"
 import { FieldTypes, RelationshipTypes } from "../../../constants"
 import { breakExternalTableId, isSQL } from "../../../integrations/utils"
 import { processObjectSync } from "@budibase/string-templates"
+// @ts-ignore
 import { cloneDeep } from "lodash/fp"
 import { processFormulas, processDates } from "../../../utilities/rowProcessor"
 import { context } from "@budibase/backend-core"