@budibase/server 1.0.199 → 1.0.200-alpha.2

package/src/api/controllers/dev.js

@@ -7,6 +7,7 @@ const { Replication, getProdAppID } = require("@budibase/backend-core/db")
 const { DocumentTypes } = require("../../db/utils")
 const { app: appCache } = require("@budibase/backend-core/cache")
 const { getProdAppDB, getAppDB } = require("@budibase/backend-core/context")
+const { events } = require("@budibase/backend-core")
 
 async function redirect(ctx, method, path = "global") {
   const { devPath } = ctx.params
@@ -102,7 +103,11 @@ exports.revert = async ctx => {
     target: appId,
   })
   try {
-    await replication.rollback()
+    if (!env.isTest()) {
+      // in-memory db stalls on rollback
+      await replication.rollback()
+    }
+
     // update appID in reverted app to be dev version again
     const db = getAppDB()
     const appDoc = await db.get(DocumentTypes.APP_METADATA)
@@ -113,6 +118,7 @@ exports.revert = async ctx => {
     ctx.body = {
       message: "Reverted changes successfully.",
     }
+    await events.app.reverted(appDoc)
   } catch (err) {
     ctx.throw(400, `Unable to revert. ${err}`)
   } finally {
@@ -121,7 +127,9 @@ exports.revert = async ctx => {
 }
 
 exports.getBudibaseVersion = async ctx => {
+  const version = require("../../../package.json").version
   ctx.body = {
-    version: require("../../../package.json").version,
+    version,
   }
+  await events.version.checked(version)
 }

package/src/api/controllers/layout.js

@@ -4,6 +4,7 @@ const {
 } = require("../../constants/layouts")
 const { generateLayoutID, getScreenParams } = require("../../db/utils")
 const { getAppDB } = require("@budibase/backend-core/context")
+const { events } = require("@budibase/backend-core")
 
 exports.save = async function (ctx) {
   const db = getAppDB()
@@ -19,6 +20,7 @@ exports.save = async function (ctx) {
 
   layout._id = layout._id || generateLayoutID()
   const response = await db.put(layout)
+  await events.layout.created(layout)
   layout._rev = response.rev
 
   ctx.body = layout
@@ -46,6 +48,7 @@ exports.destroy = async function (ctx) {
   }
 
   await db.remove(layoutId, layoutRev)
+  await events.layout.deleted(layoutId)
   ctx.body = { message: "Layout deleted successfully" }
   ctx.status = 200
 }

package/src/api/controllers/query/import/index.ts

@@ -3,10 +3,12 @@ import { generateQueryID } from "../../../../db/utils"
 import { ImportInfo, ImportSource } from "./sources/base"
 import { OpenAPI2 } from "./sources/openapi2"
 import { OpenAPI3 } from "./sources/openapi3"
-import { Query } from "./../../../../definitions/common"
 import { Curl } from "./sources/curl"
 // @ts-ignore
 import { getAppDB } from "@budibase/backend-core/context"
+import { events } from "@budibase/backend-core"
+import { Datasource, Query } from "@budibase/types"
+
 interface ImportResult {
   errorQueries: Query[]
   queries: Query[]
@@ -36,7 +38,7 @@ export class RestImporter {
   }
 
   importQueries = async (datasourceId: string): Promise<ImportResult> => {
-    // constuct the queries
+    // construct the queries
     let queries = await this.source.getQueries(datasourceId)
 
     // validate queries
@@ -76,9 +78,20 @@ export class RestImporter {
       }
     })
 
+    const successQueries = Object.values(queryIndex)
+
+    // events
+    const count = successQueries.length
+    const importSource = this.source.getImportSource()
+    const datasource: Datasource = await db.get(datasourceId)
+    await events.query.imported(datasource, importSource, count)
+    for (let query of successQueries) {
+      await events.query.created(datasource, query)
+    }
+
     return {
       errorQueries,
-      queries: Object.values(queryIndex),
+      queries: successQueries,
     }
   }
 }

package/src/api/controllers/query/import/sources/base/index.ts

@@ -1,4 +1,4 @@
-import { Query, QueryParameter } from "../../../../../../definitions/datasource"
+import { Query, QueryParameter } from "@budibase/types"
 import { URL } from "url"
 
 export interface ImportInfo {
@@ -17,6 +17,7 @@ export abstract class ImportSource {
   abstract isSupported(data: string): Promise<boolean>
   abstract getInfo(): Promise<ImportInfo>
   abstract getQueries(datasourceId: string): Promise<Query[]>
+  abstract getImportSource(): string
 
   constructQuery = (
     datasourceId: string,

package/src/api/controllers/query/import/sources/curl.ts

@@ -71,6 +71,10 @@ export class Curl extends ImportSource {
     }
   }
 
+  getImportSource(): string {
+    return "curl"
+  }
+
   getQueries = async (datasourceId: string): Promise<Query[]> => {
     const url = this.getUrl()
     const name = url.pathname

package/src/api/controllers/query/import/sources/openapi2.ts

@@ -70,6 +70,10 @@ export class OpenAPI2 extends OpenAPISource {
     }
   }
 
+  getImportSource(): string {
+    return "openapi2.0"
+  }
+
   getQueries = async (datasourceId: string): Promise<Query[]> => {
     const url = this.getUrl()
     const queries = []

package/src/api/controllers/query/import/sources/openapi3.ts

@@ -106,6 +106,10 @@ export class OpenAPI3 extends OpenAPISource {
     }
   }
 
+  getImportSource(): string {
+    return "openapi3.0"
+  }
+
   getQueries = async (datasourceId: string): Promise<Query[]> => {
     let url: string | URL | undefined
     if (this.document.servers?.length) {

package/src/api/controllers/query/import/tests/index.spec.js

@@ -1,9 +1,8 @@
 const TestConfig = require("../../../../../tests/utilities/TestConfiguration")
-
 const { RestImporter } = require("../index")
-
 const fs = require("fs")
 const path = require('path')
+const { events} = require("@budibase/backend-core")
 
 const getData = (file) => {
   return fs.readFileSync(path.join(__dirname, `../sources/tests/${file}`), "utf8")
@@ -54,9 +53,11 @@ describe("Rest Importer", () => {
   }
 
   const runTest = async (test, assertions) => {
-    for (let [key, data] of Object.entries(datasets)) {
-      await test(key, data, assertions)
-    }
+    await config.doInContext(config.appId, async () => {
+      for (let [key, data] of Object.entries(datasets)) {
+        await test(key, data, assertions)
+      }
+    })
   }
 
   const testGetInfo = async (key, data, assertions) => {
@@ -103,9 +104,12 @@ describe("Rest Importer", () => {
 
   const testImportQueries = async (key, data, assertions) => {
     await init(data)
-    const importResult = await restImporter.importQueries("datasourceId")
+    const datasource = await config.createDatasource()
+    const importResult = await restImporter.importQueries(datasource._id)
     expect(importResult.errorQueries.length).toBe(0)
     expect(importResult.queries.length).toBe(assertions[key].count)
+    expect(events.query.imported).toBeCalledTimes(1)
+    expect(events.query.imported).toBeCalledWith(datasource, assertions[key].source, assertions[key].count)
     jest.clearAllMocks()
   }
 
@@ -116,32 +120,41 @@ describe("Rest Importer", () => {
       // openapi2 (swagger)
       "oapi2CrudJson" : {
         count: 6,
+        source: "openapi2.0",
       },
       "oapi2CrudYaml" :{
         count: 6,
+        source: "openapi2.0"
       },
       "oapi2PetstoreJson" : {
         count: 20,
+        source: "openapi2.0"
       },
       "oapi2PetstoreYaml" :{
         count: 20,
+        source: "openapi2.0"
       },
       // openapi3
       "oapi3CrudJson" : {
         count: 6,
+        source: "openapi3.0"
       },
       "oapi3CrudYaml" :{
         count: 6,
+        source: "openapi3.0"
       },
       "oapi3PetstoreJson" : {
         count: 19,
+        source: "openapi3.0"
       },
       "oapi3PetstoreYaml" :{
         count: 19,
+        source: "openapi3.0"
       },
       // curl
       "curl": {
-        count: 1
+        count: 1,
+        source: "curl"
       }
     }
     await runTest(testImportQueries, assertions)

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

@@ -7,6 +7,7 @@ import { invalidateDynamicVariables } from "../../../threads/utils"
 import { QUERY_THREAD_TIMEOUT } from "../../../environment"
 import { getAppDB } from "@budibase/backend-core/context"
 import { quotas } from "@budibase/pro"
+import { events } from "@budibase/backend-core"
 
 const Runner = new Thread(ThreadType.QUERY, {
   timeoutMs: QUERY_THREAD_TIMEOUT || 10000,
@@ -80,11 +81,18 @@ export async function save(ctx: any) {
   const db = getAppDB()
   const query = ctx.request.body
 
+  const datasource = await db.get(query.datasourceId)
+
+  let eventFn
   if (!query._id) {
     query._id = generateQueryID(query.datasourceId)
+    eventFn = () => events.query.created(datasource, query)
+  } else {
+    eventFn = () => events.query.updated(datasource, query)
   }
 
   const response = await db.put(query)
+  await eventFn()
   query._rev = response.rev
 
   ctx.body = query
@@ -106,10 +114,10 @@ export async function preview(ctx: any) {
   const db = getAppDB()
 
   const datasource = await db.get(ctx.request.body.datasourceId)
+  const query = ctx.request.body
   // preview may not have a queryId as it hasn't been saved, but if it does
   // this stops dynamic variables from calling the same query
-  const { fields, parameters, queryVerb, transformer, queryId } =
-    ctx.request.body
+  const { fields, parameters, queryVerb, transformer, queryId } = query
 
   try {
     const runFn = () =>
@@ -124,6 +132,7 @@ export async function preview(ctx: any) {
       })
 
     const { rows, keys, info, extra } = await quotas.addQuery(runFn)
+    await events.query.previewed(datasource, query)
     ctx.body = {
       rows,
       schemaFields: [...new Set(keys)],
@@ -207,8 +216,12 @@ const removeDynamicVariables = async (queryId: any) => {
 
 export async function destroy(ctx: any) {
   const db = getAppDB()
-  await removeDynamicVariables(ctx.params.queryId)
+  const queryId = ctx.params.queryId
+  await removeDynamicVariables(queryId)
+  const query = await db.get(queryId)
+  const datasource = await db.get(query.datasourceId)
   await db.remove(ctx.params.queryId, ctx.params.revId)
   ctx.message = `Query deleted.`
   ctx.status = 200
+  await events.query.deleted(datasource, query)
 }

package/src/api/controllers/role.js

@@ -10,6 +10,7 @@ const {
   InternalTables,
 } = require("../../db/utils")
 const { getAppDB } = require("@budibase/backend-core/context")
+const { events } = require("@budibase/backend-core")
 
 const UpdateRolesOptions = {
   CREATED: "created",
@@ -50,8 +51,10 @@ exports.find = async function (ctx) {
 exports.save = async function (ctx) {
   const db = getAppDB()
   let { _id, name, inherits, permissionId } = ctx.request.body
+  let isCreate = false
   if (!_id) {
     _id = generateRoleID()
+    isCreate = true
   } else if (isBuiltin(_id)) {
     ctx.throw(400, "Cannot update builtin roles.")
   }
@@ -62,6 +65,11 @@ exports.save = async function (ctx) {
     role._rev = ctx.request.body._rev
   }
   const result = await db.put(role)
+  if (isCreate) {
+    await events.role.created(role)
+  } else {
+    await events.role.updated(role)
+  }
   await updateRolesOnUserTable(db, _id, UpdateRolesOptions.CREATED)
   role._rev = result.rev
   ctx.body = role
@@ -71,6 +79,7 @@ exports.save = async function (ctx) {
 exports.destroy = async function (ctx) {
   const db = getAppDB()
   const roleId = ctx.params.roleId
+  const role = await db.get(roleId)
   if (isBuiltin(roleId)) {
     ctx.throw(400, "Cannot delete builtin role.")
   }
@@ -88,6 +97,7 @@ exports.destroy = async function (ctx) {
   }
 
   await db.remove(roleId, ctx.params.rev)
+  await events.role.deleted(role)
   await updateRolesOnUserTable(
     db,
     ctx.params.roleId,

package/src/api/controllers/screen.js

@@ -1,6 +1,7 @@
 const { getScreenParams, generateScreenID } = require("../../db/utils")
 const { AccessController } = require("@budibase/backend-core/roles")
 const { getAppDB } = require("@budibase/backend-core/context")
+const { events } = require("@budibase/backend-core")
 
 exports.fetch = async ctx => {
   const db = getAppDB()
@@ -23,11 +24,17 @@ exports.save = async ctx => {
   const db = getAppDB()
   let screen = ctx.request.body
 
+  let eventFn
   if (!screen._id) {
     screen._id = generateScreenID()
+    eventFn = events.screen.created
   }
+
   const response = await db.put(screen)
 
+  if (eventFn) {
+    await eventFn(screen)
+  }
   ctx.message = `Screen ${screen.name} saved.`
   ctx.body = {
     ...screen,
@@ -38,7 +45,12 @@ exports.save = async ctx => {
 
 exports.destroy = async ctx => {
   const db = getAppDB()
-  await db.remove(ctx.params.screenId, ctx.params.screenRev)
+  const id = ctx.params.screenId
+  const screen = await db.get(id)
+
+  await db.remove(id, ctx.params.screenRev)
+
+  await events.screen.deleted(screen)
   ctx.body = {
     message: "Screen deleted successfully",
   }

package/src/api/controllers/static/index.js

@@ -14,10 +14,11 @@ const env = require("../../../environment")
 const { clientLibraryPath } = require("../../../utilities")
 const { upload } = require("../../../utilities/fileSystem")
 const { attachmentsRelativeURL } = require("../../../utilities")
-const { DocumentTypes } = require("../../../db/utils")
+const { DocumentTypes, isDevAppID } = require("../../../db/utils")
 const { getAppDB, getAppId } = require("@budibase/backend-core/context")
 const AWS = require("aws-sdk")
 const AWS_REGION = env.AWS_REGION ? env.AWS_REGION : "eu-west-1"
+const { events } = require("@budibase/backend-core")
 
 async function prepareUpload({ s3Key, bucket, metadata, file }) {
   const response = await upload({
@@ -41,6 +42,7 @@ async function prepareUpload({ s3Key, bucket, metadata, file }) {
 exports.serveBuilder = async function (ctx) {
   let builderPath = resolve(TOP_LEVEL_PATH, "builder")
   await send(ctx, ctx.file, { root: builderPath })
+  await events.serve.servedBuilder()
 }
 
 exports.uploadFile = async function (ctx) {
@@ -65,25 +67,36 @@ exports.uploadFile = async function (ctx) {
 }
 
 exports.serveApp = async function (ctx) {
-  const App = require("./templates/BudibaseApp.svelte").default
   const db = getAppDB({ skip_setup: true })
   const appInfo = await db.get(DocumentTypes.APP_METADATA)
   let appId = getAppId()
 
-  const { head, html, css } = App.render({
-    title: appInfo.name,
-    production: env.isProd(),
-    appId,
-    clientLibPath: clientLibraryPath(appId, appInfo.version),
-  })
+  if (!env.isJest()) {
+    const App = require("./templates/BudibaseApp.svelte").default
+    const { head, html, css } = App.render({
+      title: appInfo.name,
+      production: env.isProd(),
+      appId,
+      clientLibPath: clientLibraryPath(appId, appInfo.version),
+    })
 
-  const appHbs = loadHandlebarsFile(`${__dirname}/templates/app.hbs`)
-  ctx.body = await processString(appHbs, {
-    head,
-    body: html,
-    style: css.code,
-    appId,
-  })
+    const appHbs = loadHandlebarsFile(`${__dirname}/templates/app.hbs`)
+    ctx.body = await processString(appHbs, {
+      head,
+      body: html,
+      style: css.code,
+      appId,
+    })
+  } else {
+    // just return the app info for jest to assert on
+    ctx.body = appInfo
+  }
+
+  if (isDevAppID(appInfo.appId)) {
+    await events.serve.servedAppPreview(appInfo)
+  } else {
+    await events.serve.servedApp(appInfo)
+  }
 }
 
 exports.serveClientLibrary = async function (ctx) {

package/src/api/controllers/table/external.js

@@ -19,6 +19,7 @@ const { cloneDeep } = require("lodash/fp")
 const csvParser = require("../../../utilities/csvParser")
 const { handleRequest } = require("../row/external")
 const { getAppDB } = require("@budibase/backend-core/context")
+const { events } = require("@budibase/backend-core")
 
 async function makeTableRequest(
   datasource,
@@ -314,5 +315,6 @@ exports.bulkImport = async function (ctx) {
   await handleRequest(DataSourceOperation.BULK_CREATE, table._id, {
     rows,
   })
+  await events.rows.imported(table, "csv", rows.length)
   return table
 }

package/src/api/controllers/table/index.js

@@ -5,6 +5,7 @@ const { isExternalTable, isSQL } = require("../../../integrations/utils")
 const { getDatasourceParams } = require("../../../db/utils")
 const { getAppDB } = require("@budibase/backend-core/context")
 const { getTable, getAllInternalTables } = require("./utils")
+const { events } = require("@budibase/backend-core")
 
 function pickApi({ tableId, table }) {
   if (table && !tableId) {
@@ -55,7 +56,17 @@ exports.find = async function (ctx) {
 exports.save = async function (ctx) {
   const appId = ctx.appId
   const table = ctx.request.body
+  const importFormat =
+    table.dataImport && table.dataImport.csvString ? "csv" : undefined
   const savedTable = await pickApi({ table }).save(ctx)
+  if (!table._id) {
+    await events.table.created(savedTable)
+  } else {
+    await events.table.updated(savedTable)
+  }
+  if (importFormat) {
+    await events.table.imported(savedTable, importFormat)
+  }
   ctx.status = 200
   ctx.message = `Table ${table.name} saved successfully.`
   ctx.eventEmitter &&
@@ -67,6 +78,7 @@ exports.destroy = async function (ctx) {
   const appId = ctx.appId
   const tableId = ctx.params.tableId
   const deletedTable = await pickApi({ tableId }).destroy(ctx)
+  await events.table.deleted(deletedTable)
   ctx.eventEmitter &&
     ctx.eventEmitter.emitTable(`table:delete`, appId, deletedTable)
   ctx.status = 200

package/src/api/controllers/table/utils.ts

@@ -26,7 +26,8 @@ import { getViews, saveView } from "../view/utils"
 import viewTemplate from "../view/viewBuilder"
 const { getAppDB } = require("@budibase/backend-core/context")
 import { cloneDeep } from "lodash/fp"
-import { quotas, QuotaUsageType, StaticQuotaName } from "@budibase/pro"
+import { quotas } from "@budibase/pro"
+import { events } from "@budibase/backend-core"
 
 export async function clearColumns(table: any, columnNames: any) {
   const db = getAppDB()
@@ -148,8 +149,7 @@ export async function handleDataImport(user: any, table: any, dataImport: any) {
   }
 
   await quotas.addRows(finalData.length, () => db.bulkDocs(finalData))
-  let response = await db.put(table)
-  table._rev = response._rev
+  await events.rows.imported(table, "csv", finalData.length)
   return table
 }
 
@@ -245,7 +245,7 @@ class TableSaveFunctions {
   // after saving
   async after(table: any) {
     table = await handleSearchIndexes(table)
-    table = await handleDataImport(this.user, table, this.dataImport)
+    await handleDataImport(this.user, table, this.dataImport)
     return table
   }
 

package/src/api/controllers/view/index.js

@@ -6,6 +6,9 @@ const { fetchView } = require("../row")
 const { getTable } = require("../table/utils")
 const { FieldTypes } = require("../../../constants")
 const { getAppDB } = require("@budibase/backend-core/context")
+const { events } = require("@budibase/backend-core")
+const { DocumentTypes } = require("../../../db/utils")
+const { cloneDeep, isEqual } = require("lodash")
 
 exports.fetch = async ctx => {
   ctx.body = await getViews()
@@ -15,24 +18,28 @@ exports.save = async ctx => {
   const db = getAppDB()
   const { originalName, ...viewToSave } = ctx.request.body
   const view = viewTemplate(viewToSave)
+  const viewName = viewToSave.name
 
-  if (!viewToSave.name) {
+  if (!viewName) {
     ctx.throw(400, "Cannot create view without a name")
   }
 
-  await saveView(originalName, viewToSave.name, view)
+  await saveView(originalName, viewName, view)
 
   // add views to table document
-  const table = await db.get(ctx.request.body.tableId)
+  const existingTable = await db.get(ctx.request.body.tableId)
+  const table = cloneDeep(existingTable)
   if (!table.views) table.views = {}
   if (!view.meta.schema) {
     view.meta.schema = table.schema
   }
-  table.views[viewToSave.name] = view.meta
+  table.views[viewName] = view.meta
   if (originalName) {
     delete table.views[originalName]
+    existingTable.views[viewName] = existingTable.views[originalName]
   }
   await db.put(table)
+  await handleViewEvents(existingTable.views[viewName], table.views[viewName])
 
   ctx.body = {
     ...table.views[viewToSave.name],
@@ -40,6 +47,62 @@ exports.save = async ctx => {
   }
 }
 
+const calculationEvents = async (existingView, newView) => {
+  const existingCalculation = existingView && existingView.calculation
+  const newCalculation = newView && newView.calculation
+
+  if (existingCalculation && !newCalculation) {
+    await events.view.calculationDeleted(existingView)
+  }
+
+  if (!existingCalculation && newCalculation) {
+    await events.view.calculationCreated(newView)
+  }
+
+  if (
+    existingCalculation &&
+    newCalculation &&
+    existingCalculation !== newCalculation
+  ) {
+    await events.view.calculationUpdated(newView)
+  }
+}
+
+const filterEvents = async (existingView, newView) => {
+  const hasExistingFilters = !!(
+    existingView &&
+    existingView.filters &&
+    existingView.filters.length
+  )
+  const hasNewFilters = !!(newView && newView.filters && newView.filters.length)
+
+  if (hasExistingFilters && !hasNewFilters) {
+    await events.view.filterDeleted(newView)
+  }
+
+  if (!hasExistingFilters && hasNewFilters) {
+    await events.view.filterCreated(newView)
+  }
+
+  if (
+    hasExistingFilters &&
+    hasNewFilters &&
+    !isEqual(existingView.filters, newView.filters)
+  ) {
+    await events.view.filterUpdated(newView)
+  }
+}
+
+const handleViewEvents = async (existingView, newView) => {
+  if (!existingView) {
+    await events.view.created(newView)
+  } else {
+    await events.view.updated(newView)
+  }
+  await calculationEvents(existingView, newView)
+  await filterEvents(existingView, newView)
+}
+
 exports.destroy = async ctx => {
   const db = getAppDB()
   const viewName = decodeURI(ctx.params.viewName)
@@ -47,6 +110,7 @@ exports.destroy = async ctx => {
   const table = await db.get(view.meta.tableId)
   delete table.views[viewName]
   await db.put(table)
+  await events.view.deleted(view)
 
   ctx.body = view
 }
@@ -79,9 +143,9 @@ exports.exportView = async ctx => {
   let rows = ctx.body
 
   let schema = view && view.meta && view.meta.schema
+  const tableId = ctx.params.tableId || view.meta.tableId
+  const table = await getTable(tableId)
   if (!schema) {
-    const tableId = ctx.params.tableId || view.meta.tableId
-    const table = await getTable(tableId)
     schema = table.schema
   }
 
@@ -116,4 +180,10 @@ exports.exportView = async ctx => {
   // send down the file
   ctx.attachment(filename)
   ctx.body = apiFileReturn(exporter(headers, rows))
+
+  if (viewName.startsWith(DocumentTypes.TABLE)) {
+    await events.table.exported(table, format)
+  } else {
+    await events.view.exported(table, format)
+  }
 }