@budibase/server 1.0.123 → 1.0.125

package/src/api/controllers/{application.js → application.ts}

@@ -1,29 +1,29 @@
-const env = require("../../environment")
-const packageJson = require("../../../package.json")
-const {
+import env from "../../environment"
+import packageJson from "../../../package.json"
+import {
   createLinkView,
   createRoutingView,
   createAllSearchIndex,
-} = require("../../db/views/staticViews")
-const {
+} from "../../db/views/staticViews"
+import {
   getTemplateStream,
   createApp,
   deleteApp,
-} = require("../../utilities/fileSystem")
-const {
+} from "../../utilities/fileSystem"
+import {
   generateAppID,
   getLayoutParams,
   getScreenParams,
   generateDevAppID,
   DocumentTypes,
   AppStatus,
-} = require("../../db/utils")
+} from "../../db/utils"
 const {
   BUILTIN_ROLE_IDS,
   AccessController,
 } = require("@budibase/backend-core/roles")
-const { BASE_LAYOUTS } = require("../../constants/layouts")
-const { cloneDeep } = require("lodash/fp")
+import { BASE_LAYOUTS } from "../../constants/layouts"
+import { cloneDeep } from "lodash/fp"
 const { processObject } = require("@budibase/string-templates")
 const {
   getAllApps,
@@ -31,24 +31,27 @@ const {
   getProdAppID,
   Replication,
 } = require("@budibase/backend-core/db")
-const { USERS_TABLE_SCHEMA } = require("../../constants")
-const { removeAppFromUserRoles } = require("../../utilities/workerRequests")
-const { clientLibraryPath, stringToReadStream } = require("../../utilities")
-const { getAllLocks } = require("../../utilities/redis")
-const {
+import { USERS_TABLE_SCHEMA } from "../../constants"
+import { removeAppFromUserRoles } from "../../utilities/workerRequests"
+import { clientLibraryPath, stringToReadStream } from "../../utilities"
+import { getAllLocks } from "../../utilities/redis"
+import {
   updateClientLibrary,
   backupClientLibrary,
   revertClientLibrary,
-} = require("../../utilities/fileSystem/clientLibrary")
+} from "../../utilities/fileSystem/clientLibrary"
 const { getTenantId, isMultiTenant } = require("@budibase/backend-core/tenancy")
-const { syncGlobalUsers } = require("./user")
+import { syncGlobalUsers } from "./user"
 const { app: appCache } = require("@budibase/backend-core/cache")
-const { cleanupAutomations } = require("../../automations/utils")
+import { cleanupAutomations } from "../../automations/utils"
 const {
   getAppDB,
   getProdAppDB,
   updateAppId,
 } = require("@budibase/backend-core/context")
+import { getUniqueRows } from "../../utilities/usageQuota/rows"
+import { quotas } from "@budibase/pro"
+import { errors } from "@budibase/backend-core"
 
 const URL_REGEX_SLASH = /\/|\\/g
 
@@ -61,7 +64,7 @@ async function getLayouts() {
         include_docs: true,
       })
     )
-  ).rows.map(row => row.doc)
+  ).rows.map((row: any) => row.doc)
 }
 
 async function getScreens() {
@@ -72,16 +75,16 @@ async function getScreens() {
         include_docs: true,
       })
     )
-  ).rows.map(row => row.doc)
+  ).rows.map((row: any) => row.doc)
 }
 
-function getUserRoleId(ctx) {
+function getUserRoleId(ctx: any) {
   return !ctx.user.role || !ctx.user.role._id
     ? BUILTIN_ROLE_IDS.PUBLIC
     : ctx.user.role._id
 }
 
-exports.getAppUrl = ctx => {
+export const getAppUrl = (ctx: any) => {
   // construct the url
   let url
   if (ctx.request.body.url) {
@@ -97,29 +100,34 @@ exports.getAppUrl = ctx => {
   return url
 }
 
-const checkAppUrl = (ctx, apps, url, currentAppId) => {
+const checkAppUrl = (ctx: any, apps: any, url: any, currentAppId?: string) => {
   if (currentAppId) {
-    apps = apps.filter(app => app.appId !== currentAppId)
+    apps = apps.filter((app: any) => app.appId !== currentAppId)
   }
-  if (apps.some(app => app.url === url)) {
+  if (apps.some((app: any) => app.url === url)) {
     ctx.throw(400, "App URL is already in use.")
   }
 }
 
-const checkAppName = (ctx, apps, name, currentAppId) => {
+const checkAppName = (
+  ctx: any,
+  apps: any,
+  name: any,
+  currentAppId?: string
+) => {
   // TODO: Replace with Joi
   if (!name) {
     ctx.throw(400, "Name is required")
   }
   if (currentAppId) {
-    apps = apps.filter(app => app.appId !== currentAppId)
+    apps = apps.filter((app: any) => app.appId !== currentAppId)
   }
-  if (apps.some(app => app.name === name)) {
+  if (apps.some((app: any) => app.name === name)) {
     ctx.throw(400, "App name is already in use.")
   }
 }
 
-async function createInstance(template) {
+async function createInstance(template: any) {
   const tenantId = isMultiTenant() ? getTenantId() : null
   const baseAppId = generateAppID(tenantId)
   const appId = generateDevAppID(baseAppId)
@@ -160,7 +168,7 @@ async function createInstance(template) {
   return { _id: appId }
 }
 
-exports.fetch = async ctx => {
+export const fetch = async (ctx: any) => {
   const dev = ctx.query && ctx.query.status === AppStatus.DEV
   const all = ctx.query && ctx.query.status === AppStatus.ALL
   const apps = await getAllApps({ dev, all })
@@ -172,7 +180,7 @@ exports.fetch = async ctx => {
       if (app.status !== "development") {
         continue
       }
-      const lock = locks.find(lock => lock.appId === app.appId)
+      const lock = locks.find((lock: any) => lock.appId === app.appId)
       if (lock) {
         app.lockedBy = lock.user
       } else {
@@ -185,7 +193,7 @@ exports.fetch = async ctx => {
   ctx.body = apps
 }
 
-exports.fetchAppDefinition = async ctx => {
+export const fetchAppDefinition = async (ctx: any) => {
   const layouts = await getLayouts()
   const userRoleId = getUserRoleId(ctx)
   const accessController = new AccessController()
@@ -200,7 +208,7 @@ exports.fetchAppDefinition = async ctx => {
   }
 }
 
-exports.fetchAppPackage = async ctx => {
+export const fetchAppPackage = async (ctx: any) => {
   const db = getAppDB()
   const application = await db.get(DocumentTypes.APP_METADATA)
   const layouts = await getLayouts()
@@ -221,7 +229,7 @@ exports.fetchAppPackage = async ctx => {
   }
 }
 
-exports.create = async ctx => {
+const performAppCreate = async (ctx: any) => {
   const apps = await getAllApps({ dev: true })
   const name = ctx.request.body.name
   checkAppName(ctx, apps, name)
@@ -229,7 +237,7 @@ exports.create = async ctx => {
   checkAppUrl(ctx, apps, url)
 
   const { useTemplate, templateKey, templateString } = ctx.request.body
-  const instanceConfig = {
+  const instanceConfig: any = {
     useTemplate,
     key: templateKey,
     templateString,
@@ -280,13 +288,41 @@ exports.create = async ctx => {
   }
 
   await appCache.invalidateAppMetadata(appId, newApplication)
-  ctx.status = 200
+  return newApplication
+}
+
+const appPostCreate = async (ctx: any, appId: string) => {
+  // app import & template creation
+  if (ctx.request.body.useTemplate === "true") {
+    const rows = await getUniqueRows([appId])
+    const rowCount = rows ? rows.length : 0
+    if (rowCount) {
+      try {
+        await quotas.addRows(rowCount)
+      } catch (err: any) {
+        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
+          ctx.params.appId = appId
+          await destroyApp(ctx)
+        }
+        throw err
+      }
+    }
+  }
+}
+
+export const create = async (ctx: any) => {
+  const newApplication = await quotas.addApp(() => performAppCreate(ctx))
+  await appPostCreate(ctx, newApplication.appId)
   ctx.body = newApplication
+  ctx.status = 200
 }
 
 // This endpoint currently operates as a PATCH rather than a PUT
 // Thus name and url fields are handled only if present
-exports.update = async ctx => {
+export const update = async (ctx: any) => {
   const apps = await getAllApps({ dev: true })
   // validation
   const name = ctx.request.body.name
@@ -304,7 +340,7 @@ exports.update = async ctx => {
   ctx.body = data
 }
 
-exports.updateClient = async ctx => {
+export const updateClient = async (ctx: any) => {
   // Get current app version
   const db = getAppDB()
   const application = await db.get(DocumentTypes.APP_METADATA)
@@ -326,7 +362,7 @@ exports.updateClient = async ctx => {
   ctx.body = data
 }
 
-exports.revertClient = async ctx => {
+export const revertClient = async (ctx: any) => {
   // Check app can be reverted
   const db = getAppDB()
   const application = await db.get(DocumentTypes.APP_METADATA)
@@ -349,26 +385,57 @@ exports.revertClient = async ctx => {
   ctx.body = data
 }
 
-exports.delete = async ctx => {
-  const db = getAppDB()
+const destroyApp = async (ctx: any) => {
+  let appId = ctx.params.appId
+  let isUnpublish = ctx.query && ctx.query.unpublish
 
+  if (isUnpublish) {
+    appId = getProdAppID(appId)
+  }
+
+  const db = isUnpublish ? getProdAppDB() : getAppDB()
   const result = await db.destroy()
+
+  if (isUnpublish) {
+    await quotas.removePublishedApp()
+  } else {
+    await quotas.removeApp()
+  }
+
   /* istanbul ignore next */
-  if (!env.isTest() && !ctx.query.unpublish) {
-    await deleteApp(ctx.params.appId)
+  if (!env.isTest() && !isUnpublish) {
+    await deleteApp(appId)
   }
-  if (ctx.query && ctx.query.unpublish) {
-    await cleanupAutomations(ctx.params.appId)
+  if (isUnpublish) {
+    await cleanupAutomations(appId)
   }
   // make sure the app/role doesn't stick around after the app has been deleted
-  await removeAppFromUserRoles(ctx, ctx.params.appId)
-  await appCache.invalidateAppMetadata(ctx.params.appId)
+  await removeAppFromUserRoles(ctx, appId)
+  await appCache.invalidateAppMetadata(appId)
+  return result
+}
+
+const preDestroyApp = async (ctx: any) => {
+  const rows = await getUniqueRows([ctx.params.appId])
+  ctx.rowCount = rows.length
+}
+
+const postDestroyApp = async (ctx: any) => {
+  const rowCount = ctx.rowCount
+  if (rowCount) {
+    await quotas.removeRows(rowCount)
+  }
+}
 
+export const destroy = async (ctx: any) => {
+  await preDestroyApp(ctx)
+  const result = await destroyApp(ctx)
+  await postDestroyApp(ctx)
   ctx.status = 200
   ctx.body = result
 }
 
-exports.sync = async (ctx, next) => {
+export const sync = async (ctx: any, next: any) => {
   const appId = ctx.params.appId
   if (!isDevAppID(appId)) {
     ctx.throw(400, "This action cannot be performed for production apps")
@@ -398,7 +465,7 @@ exports.sync = async (ctx, next) => {
   let error
   try {
     await replication.replicate({
-      filter: function (doc) {
+      filter: function (doc: any) {
         return doc._id !== DocumentTypes.APP_METADATA
       },
     })
@@ -420,7 +487,7 @@ exports.sync = async (ctx, next) => {
   }
 }
 
-const updateAppPackage = async (appPackage, appId) => {
+const updateAppPackage = async (appPackage: any, appId: any) => {
   const db = getAppDB()
   const application = await db.get(DocumentTypes.APP_METADATA)
 
@@ -439,7 +506,7 @@ const updateAppPackage = async (appPackage, appId) => {
   return response
 }
 
-const createEmptyAppPackage = async (ctx, app) => {
+const createEmptyAppPackage = async (ctx: any, app: any) => {
   const db = getAppDB()
 
   let screensAndLayouts = []

package/src/api/controllers/deploy/{index.js → index.ts}

@@ -1,20 +1,18 @@
-const Deployment = require("./Deployment")
-const {
+import Deployment from "./Deployment"
+import {
   Replication,
   getProdAppID,
   getDevelopmentAppID,
-} = require("@budibase/backend-core/db")
-const { DocumentTypes, getAutomationParams } = require("../../../db/utils")
-const {
-  disableAllCrons,
-  enableCronTrigger,
-} = require("../../../automations/utils")
-const { app: appCache } = require("@budibase/backend-core/cache")
-const {
+} from "@budibase/backend-core/db"
+import { DocumentTypes, getAutomationParams } from "../../../db/utils"
+import { disableAllCrons, enableCronTrigger } from "../../../automations/utils"
+import { app as appCache } from "@budibase/backend-core/cache"
+import {
   getAppId,
   getAppDB,
   getProdAppDB,
-} = require("@budibase/backend-core/context")
+} from "@budibase/backend-core/context"
+import { quotas } from "@budibase/pro"
 
 // the max time we can wait for an invalidation to complete before considering it failed
 const MAX_PENDING_TIME_MS = 30 * 60000
@@ -25,9 +23,10 @@ const DeploymentStatus = {
 }
 
 // checks that deployments are in a good state, any pending will be updated
-async function checkAllDeployments(deployments) {
+async function checkAllDeployments(deployments: any) {
   let updated = false
-  for (let deployment of Object.values(deployments.history)) {
+  let deployment: any
+  for (deployment of Object.values(deployments.history)) {
     // check that no deployments have crashed etc and are now stuck
     if (
       deployment.status === DeploymentStatus.PENDING &&
@@ -41,7 +40,7 @@ async function checkAllDeployments(deployments) {
   return { updated, deployments }
 }
 
-async function storeDeploymentHistory(deployment) {
+async function storeDeploymentHistory(deployment: any) {
   const deploymentJSON = deployment.getJSON()
   const db = getAppDB()
 
@@ -70,7 +69,7 @@ async function storeDeploymentHistory(deployment) {
   return deployment
 }
 
-async function initDeployedApp(prodAppId) {
+async function initDeployedApp(prodAppId: any) {
   const db = getProdAppDB()
   console.log("Reading automation docs")
   const automations = (
@@ -79,7 +78,7 @@ async function initDeployedApp(prodAppId) {
         include_docs: true,
       })
     )
-  ).rows.map(row => row.doc)
+  ).rows.map((row: any) => row.doc)
   console.log("You have " + automations.length + " automations")
   const promises = []
   console.log("Disabling prod crons..")
@@ -93,21 +92,27 @@ async function initDeployedApp(prodAppId) {
   console.log("Enabled cron triggers for deployed app..")
 }
 
-async function deployApp(deployment) {
+async function deployApp(deployment: any) {
   let replication
   try {
     const appId = getAppId()
     const devAppId = getDevelopmentAppID(appId)
     const productionAppId = getProdAppID(appId)
-    replication = new Replication({
+
+    const config: any = {
       source: devAppId,
       target: productionAppId,
-    })
+    }
+    replication = new Replication(config)
+
     console.log("Replication object created")
     await replication.replicate()
     console.log("replication complete.. replacing app meta doc")
     const db = getProdAppDB()
     const appDoc = await db.get(DocumentTypes.APP_METADATA)
+
+    deployment.appUrl = appDoc.url
+
     appDoc.appId = productionAppId
     appDoc.instance._id = productionAppId
     await db.put(appDoc)
@@ -117,7 +122,7 @@ async function deployApp(deployment) {
     console.log("Deployed app initialised, setting deployment to successful")
     deployment.setStatus(DeploymentStatus.SUCCESS)
     await storeDeploymentHistory(deployment)
-  } catch (err) {
+  } catch (err: any) {
     deployment.setStatus(DeploymentStatus.FAILURE, err.message)
     await storeDeploymentHistory(deployment)
     throw {
@@ -125,18 +130,17 @@ async function deployApp(deployment) {
       message: `Deployment Failed: ${err.message}`,
     }
   } finally {
-    await replication.close()
+    if (replication) {
+      await replication.close()
+    }
   }
 }
 
-exports.fetchDeployments = async function (ctx) {
+export async function fetchDeployments(ctx: any) {
   try {
     const db = getAppDB()
     const deploymentDoc = await db.get(DocumentTypes.DEPLOYMENTS)
-    const { updated, deployments } = await checkAllDeployments(
-      deploymentDoc,
-      ctx.user
-    )
+    const { updated, deployments } = await checkAllDeployments(deploymentDoc)
     if (updated) {
       await db.put(deployments)
     }
@@ -146,7 +150,7 @@ exports.fetchDeployments = async function (ctx) {
   }
 }
 
-exports.deploymentProgress = async function (ctx) {
+export async function deploymentProgress(ctx: any) {
   try {
     const db = getAppDB()
     const deploymentDoc = await db.get(DocumentTypes.DEPLOYMENTS)
@@ -159,7 +163,20 @@ exports.deploymentProgress = async function (ctx) {
   }
 }
 
-exports.deployApp = async function (ctx) {
+const isFirstDeploy = async () => {
+  try {
+    const db = getProdAppDB()
+    await db.get(DocumentTypes.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)
@@ -168,7 +185,14 @@ exports.deployApp = async function (ctx) {
   console.log("Stored deployment history")
 
   console.log("Deploying app...")
-  await deployApp(deployment)
+
+  if (await isFirstDeploy()) {
+    await quotas.addPublishedApp(() => deployApp(deployment))
+  } else {
+    await deployApp(deployment)
+  }
 
   ctx.body = deployment
 }
+
+export { _deployApp as deployApp }

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

@@ -1,7 +1,7 @@
 const { getAllApps } = require("@budibase/backend-core/db")
 const { updateAppId } = require("@budibase/backend-core/context")
 import { search as stringSearch } from "./utils"
-import { default as controller } from "../application"
+import * as controller from "../application"
 import { Application } from "../../../definitions/common"
 
 function fixAppID(app: Application, params: any) {
@@ -59,7 +59,7 @@ export async function destroy(ctx: any, next: any) {
   // get the app before deleting it
   await setResponseApp(ctx)
   const body = ctx.body
-  await controller.delete(ctx)
+  await controller.destroy(ctx)
   // overwrite the body again
   ctx.body = body
   await next()

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

@@ -1,5 +1,5 @@
 import { search as stringSearch } from "./utils"
-import { default as queryController } from "../query"
+import * as queryController from "../query"
 
 export async function search(ctx: any, next: any) {
   await queryController.fetch(ctx)

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

@@ -1,4 +1,4 @@
-import { default as rowController } from "../row"
+import * as rowController from "../row"
 import { addRev } from "./utils"
 import { Row } from "../../../definitions/common"
 import { convertBookmark } from "../../../utilities"