@budibase/server 2.1.44 → 2.1.46-alpha.0

package/src/migrations/functions/appUrls.ts

@@ -1,5 +1,5 @@
-const { DocumentType } = require("@budibase/backend-core/db")
-import { getAppUrl } from "../../api/controllers/application"
+import { db as dbCore } from "@budibase/backend-core"
+import sdk from "../../sdk"
 
 /**
  * Date:
@@ -11,7 +11,7 @@ import { getAppUrl } from "../../api/controllers/application"
 export const run = async (appDb: any) => {
   let metadata
   try {
-    metadata = await appDb.get(DocumentType.APP_METADATA)
+    metadata = await appDb.get(dbCore.DocumentType.APP_METADATA)
   } catch (e) {
     // sometimes the metadata document doesn't exist
     // exit early instead of failing the migration
@@ -20,14 +20,7 @@ export const run = async (appDb: any) => {
   }
 
   if (!metadata.url) {
-    const context = {
-      request: {
-        body: {
-          name: metadata.name,
-        },
-      },
-    }
-    metadata.url = getAppUrl(context)
+    metadata.url = sdk.applications.getAppUrl({ name: metadata.name })
     console.log(`Adding url to app: ${metadata.url}`)
     await appDb.put(metadata)
   }

package/src/migrations/functions/backfill/app/tables.ts

@@ -1,11 +1,8 @@
 import { events } from "@budibase/backend-core"
+import { Database } from "@budibase/types"
 import sdk from "../../../../sdk"
-import PouchDB from "pouchdb"
 
-export const backfill = async (
-  appDb: PouchDB.Database,
-  timestamp: string | number
-) => {
+export const backfill = async (appDb: Database, timestamp: string | number) => {
   const tables = await sdk.tables.getAllInternalTables(appDb)
 
   for (const table of tables) {

package/src/migrations/functions/backfill/global.ts

@@ -149,7 +149,7 @@ export const run = async (db: any) => {
     }
 
     try {
-      const allApps: App[] = await dbUtils.getAllApps({ dev: true })
+      const allApps = (await dbUtils.getAllApps({ dev: true })) as App[]
       totals.apps = allApps.length
 
       totals.usage = await quotas.backfill(allApps)

package/src/migrations/functions/tableSettings.ts

@@ -0,0 +1,145 @@
+import { getScreenParams } from "../../db/utils"
+import { Screen } from "@budibase/types"
+import { makePropSafe as safe } from "@budibase/string-templates"
+/**
+ * Date:
+ * November 2022
+ *
+ * Description:
+ * Update table settings to use actions instead of links. We do not remove the
+ * legacy values here as we cannot guarantee that their apps are up-t-date.
+ * It is safe to simply save both the new and old structure in the definition.
+ *
+ * Migration 1:
+ * Legacy "linkRows", "linkURL", "linkPeek" and "linkColumn" settings on tables
+ * and table blocks are migrated into a "Navigate To" action under the new
+ * "onClick" setting.
+ *
+ * Migration 2:
+ * Legacy "titleButtonURL" and "titleButtonPeek" settings on table blocks are
+ * migrated into a "Navigate To" action under the new "onClickTitleButton"
+ * setting.
+ */
+export const run = async (appDb: any) => {
+  // Get all app screens
+  let screens: Screen[]
+  try {
+    screens = (
+      await appDb.allDocs(
+        getScreenParams(null, {
+          include_docs: true,
+        })
+      )
+    ).rows.map((row: any) => row.doc)
+  } catch (e) {
+    // sometimes the metadata document doesn't exist
+    // exit early instead of failing the migration
+    console.error("Error retrieving app metadata. Skipping", e)
+    return
+  }
+
+  // Recursively update any relevant components and mutate the screen docs
+  for (let screen of screens) {
+    const changed = migrateTableSettings(screen.props)
+
+    // Save screen if we updated it
+    if (changed) {
+      await appDb.put(screen)
+      console.log(
+        `Screen ${screen.routing?.route} contained table settings which were migrated`
+      )
+    }
+  }
+}
+
+// Recursively searches and mutates a screen doc to migrate table component
+// and table block settings
+const migrateTableSettings = (component: any) => {
+  let changed = false
+  if (!component) {
+    return changed
+  }
+
+  // Migration 1: migrate table row click settings
+  if (
+    component._component.endsWith("/table") ||
+    component._component.endsWith("/tableblock")
+  ) {
+    const { linkRows, linkURL, linkPeek, linkColumn, onClick } = component
+    if (linkRows && !onClick) {
+      const column = linkColumn || "_id"
+      const action = convertLinkSettingToAction(linkURL, !!linkPeek, column)
+      if (action) {
+        changed = true
+        component.onClick = action
+        if (component._component.endsWith("/tableblock")) {
+          component.clickBehaviour = "actions"
+        }
+      }
+    }
+  }
+
+  // Migration 2: migrate table block title button settings
+  if (component._component.endsWith("/tableblock")) {
+    const {
+      showTitleButton,
+      titleButtonURL,
+      titleButtonPeek,
+      onClickTitleButton,
+    } = component
+    if (showTitleButton && !onClickTitleButton) {
+      const action = convertLinkSettingToAction(
+        titleButtonURL,
+        !!titleButtonPeek
+      )
+      if (action) {
+        changed = true
+        component.onClickTitleButton = action
+        component.titleButtonClickBehaviour = "actions"
+      }
+    }
+  }
+
+  // Recurse down the tree as needed
+  component._children?.forEach((child: any) => {
+    const childChanged = migrateTableSettings(child)
+    changed = changed || childChanged
+  })
+  return changed
+}
+
+// Util ti convert the legacy settings into a navigation action structure
+const convertLinkSettingToAction = (
+  linkURL: string,
+  linkPeek: boolean,
+  linkColumn?: string
+) => {
+  // Sanity check we have a URL
+  if (!linkURL) {
+    return null
+  }
+
+  // Default URL to the old URL setting
+  let url = linkURL
+
+  // If we enriched the old URL with a column, update the url
+  if (linkColumn && linkURL.includes("/:")) {
+    // Convert old link URL setting, which is a screen URL, into a valid
+    // binding using the new clicked row binding
+    const split = linkURL.split("/:")
+    const col = linkColumn || "_id"
+    const binding = `{{ ${safe("eventContext")}.${safe("row")}.${safe(col)} }}`
+    url = `${split[0]}/${binding}`
+  }
+
+  // Create action structure
+  return [
+    {
+      "##eventHandlerType": "Navigate To",
+      parameters: {
+        url,
+        peek: linkPeek,
+      },
+    },
+  ]
+}

package/src/migrations/functions/tests/appUrls.spec.js

@@ -1,4 +1,4 @@
-const {  DocumentType, doWithDB } = require("@budibase/backend-core/db")
+const { db: dbCore } = require("@budibase/backend-core")
 const TestConfig = require("../../../tests/utilities/TestConfiguration")
 
 const migration = require("../appUrls")
@@ -14,12 +14,12 @@ describe("run", () => {
 
   it("runs successfully", async () => {
     const app = await config.createApp("testApp")
-    const metadata = await doWithDB(app.appId, async db => {
-      const metadataDoc = await db.get( DocumentType.APP_METADATA)
+    const metadata = await dbCore.doWithDB(app.appId, async db => {
+      const metadataDoc = await db.get(dbCore.DocumentType.APP_METADATA)
       delete metadataDoc.url
       await db.put(metadataDoc)
       await migration.run(db)
-      return await db.get( DocumentType.APP_METADATA)
+      return await db.get(dbCore.DocumentType.APP_METADATA)
     })
     expect(metadata.url).toEqual("/testapp")
   })

package/src/migrations/functions/tests/tableSettings.spec.ts

@@ -0,0 +1,144 @@
+import { App, Screen } from "@budibase/types"
+
+import { db as dbCore } from "@budibase/backend-core"
+import TestConfig from "../../../tests/utilities/TestConfiguration"
+import { run as runMigration } from "../tableSettings"
+
+describe("run", () => {
+  const config = new TestConfig(false)
+  let app: App
+  let screen: Screen
+
+  beforeAll(async () => {
+    await config.init()
+    app = await config.createApp("testApp")
+    screen = await config.createScreen()
+  })
+
+  afterAll(config.end)
+
+  it("migrates table block row on click settings", async () => {
+    // Add legacy table block as first child
+    screen.props._children = [
+      {
+        _instanceName: "Table Block",
+        _styles: {},
+        _component: "@budibase/standard-components/tableblock",
+        _id: "foo",
+        linkRows: true,
+        linkURL: "/rows/:id",
+        linkPeek: true,
+        linkColumn: "name",
+      },
+    ]
+    await config.createScreen(screen)
+
+    // Run migration
+    screen = await dbCore.doWithDB(app.appId, async (db: any) => {
+      await runMigration(db)
+      return await db.get(screen._id)
+    })
+
+    // Verify new "onClick" setting
+    const onClick = screen.props._children?.[0].onClick
+    expect(onClick).toBeDefined()
+    expect(onClick.length).toBe(1)
+    expect(onClick[0]["##eventHandlerType"]).toBe("Navigate To")
+    expect(onClick[0].parameters.url).toBe(
+      `/rows/{{ [eventContext].[row].[name] }}`
+    )
+    expect(onClick[0].parameters.peek).toBeTruthy()
+  })
+
+  it("migrates table row on click settings", async () => {
+    // Add legacy table block as first child
+    screen.props._children = [
+      {
+        _instanceName: "Table",
+        _styles: {},
+        _component: "@budibase/standard-components/table",
+        _id: "foo",
+        linkRows: true,
+        linkURL: "/rows/:id",
+        linkPeek: true,
+        linkColumn: "name",
+      },
+    ]
+    await config.createScreen(screen)
+
+    // Run migration
+    screen = await dbCore.doWithDB(app.appId, async (db: any) => {
+      await runMigration(db)
+      return await db.get(screen._id)
+    })
+
+    // Verify new "onClick" setting
+    const onClick = screen.props._children?.[0].onClick
+    expect(onClick).toBeDefined()
+    expect(onClick.length).toBe(1)
+    expect(onClick[0]["##eventHandlerType"]).toBe("Navigate To")
+    expect(onClick[0].parameters.url).toBe(
+      `/rows/{{ [eventContext].[row].[name] }}`
+    )
+    expect(onClick[0].parameters.peek).toBeTruthy()
+  })
+
+  it("migrates table block title button settings", async () => {
+    // Add legacy table block as first child
+    screen.props._children = [
+      {
+        _instanceName: "Table Block",
+        _styles: {},
+        _component: "@budibase/standard-components/tableblock",
+        _id: "foo",
+        showTitleButton: true,
+        titleButtonURL: "/url",
+        titleButtonPeek: true,
+      },
+    ]
+    await config.createScreen(screen)
+
+    // Run migration
+    screen = await dbCore.doWithDB(app.appId, async (db: any) => {
+      await runMigration(db)
+      return await db.get(screen._id)
+    })
+
+    // Verify new "onClickTitleButton" setting
+    const onClick = screen.props._children?.[0].onClickTitleButton
+    expect(onClick).toBeDefined()
+    expect(onClick.length).toBe(1)
+    expect(onClick[0]["##eventHandlerType"]).toBe("Navigate To")
+    expect(onClick[0].parameters.url).toBe("/url")
+    expect(onClick[0].parameters.peek).toBeTruthy()
+  })
+
+  it("ignores components that have already been migrated", async () => {
+    // Add legacy table block as first child
+    screen.props._children = [
+      {
+        _instanceName: "Table Block",
+        _styles: {},
+        _component: "@budibase/standard-components/tableblock",
+        _id: "foo",
+        linkRows: true,
+        linkURL: "/rows/:id",
+        linkPeek: true,
+        linkColumn: "name",
+        onClick: "foo",
+      },
+    ]
+    const initialDefinition = JSON.stringify(screen.props._children?.[0])
+    await config.createScreen(screen)
+
+    // Run migration
+    screen = await dbCore.doWithDB(app.appId, async (db: any) => {
+      await runMigration(db)
+      return await db.get(screen._id)
+    })
+
+    // Verify new "onClick" setting
+    const newDefinition = JSON.stringify(screen.props._children?.[0])
+    expect(initialDefinition).toEqual(newDefinition)
+  })
+})

package/src/migrations/functions/tests/userEmailViewCasing.spec.js

@@ -1,11 +1,16 @@
-jest.mock("@budibase/backend-core/db", () => ({
-  ...jest.requireActual("@budibase/backend-core/db"),
-  createNewUserEmailView: jest.fn(),
-}))
-const coreDb = require("@budibase/backend-core/db")
+jest.mock("@budibase/backend-core", () => {
+  const core = jest.requireActual("@budibase/backend-core")
+  return {
+    ...core,
+    db: {
+      ...core.db,
+      createNewUserEmailView: jest.fn()
+    }
+  }
+})
+const { tenancy, db: dbCore } = require("@budibase/backend-core")
 const TestConfig = require("../../../tests/utilities/TestConfiguration")
 const { TENANT_ID } = require("../../../tests/utilities/structures")
-const { getGlobalDB, doInTenant } = require("@budibase/backend-core/tenancy")
 
 // mock email view creation
 
@@ -21,10 +26,10 @@ describe("run", () => {
     afterAll(config.end)
 
     it("runs successfully", async () => {
-      await doInTenant(TENANT_ID, async () => {
-        const globalDb = getGlobalDB()
+      await tenancy.doInTenant(TENANT_ID, async () => {
+        const globalDb = tenancy.getGlobalDB()
         await migration.run(globalDb)
-        expect(coreDb.createNewUserEmailView).toHaveBeenCalledTimes(1)
+        expect(dbCore.createNewUserEmailView).toHaveBeenCalledTimes(1)
       })
     })
 })

package/src/migrations/functions/usageQuotas/syncApps.ts

@@ -1,15 +1,14 @@
-import { getTenantId } from "@budibase/backend-core/tenancy"
-import { getAllApps } from "@budibase/backend-core/db"
+import { tenancy, db as dbCore } from "@budibase/backend-core"
 import { quotas } from "@budibase/pro"
 import { QuotaUsageType, StaticQuotaName } from "@budibase/types"
 
 export const run = async () => {
   // get app count
-  const devApps = await getAllApps({ dev: true })
+  const devApps = await dbCore.getAllApps({ dev: true })
   const appCount = devApps ? devApps.length : 0
 
   // sync app count
-  const tenantId = getTenantId()
+  const tenantId = tenancy.getTenantId()
   console.log(`[Tenant: ${tenantId}] Syncing app count: ${appCount}`)
   await quotas.setUsage(appCount, StaticQuotaName.APPS, QuotaUsageType.STATIC)
 }

package/src/migrations/functions/usageQuotas/syncRows.ts

@@ -1,12 +1,11 @@
-import { getTenantId } from "@budibase/backend-core/tenancy"
-import { getAllApps } from "@budibase/backend-core/db"
+import { tenancy, db as dbCore } from "@budibase/backend-core"
 import { getUniqueRows } from "../../../utilities/usageQuota/rows"
 import { quotas } from "@budibase/pro"
-import { StaticQuotaName, QuotaUsageType } from "@budibase/types"
+import { StaticQuotaName, QuotaUsageType, App } from "@budibase/types"
 
 export const run = async () => {
   // get all rows in all apps
-  const allApps = await getAllApps({ all: true })
+  const allApps = (await dbCore.getAllApps({ all: true })) as App[]
   const appIds = allApps ? allApps.map((app: { appId: any }) => app.appId) : []
   const { appRows } = await getUniqueRows(appIds)
 
@@ -19,7 +18,7 @@ export const run = async () => {
   })
 
   // sync row count
-  const tenantId = getTenantId()
+  const tenantId = tenancy.getTenantId()
   console.log(`[Tenant: ${tenantId}] Syncing row count: ${rowCount}`)
   await quotas.setUsagePerApp(
     counts,

package/src/migrations/functions/usageQuotas/tests/syncRows.spec.ts

@@ -2,7 +2,7 @@ import TestConfig from "../../../../tests/utilities/TestConfiguration"
 import * as syncRows from "../syncRows"
 import { quotas } from "@budibase/pro"
 import { QuotaUsageType, StaticQuotaName } from "@budibase/types"
-const { getProdAppID } = require("@budibase/backend-core/db")
+const { db: dbCore } = require("@budibase/backend-core")
 
 describe("syncRows", () => {
   let config = new TestConfig(false)
@@ -38,12 +38,12 @@ describe("syncRows", () => {
       // assert the migration worked
       usageDoc = await quotas.getQuotaUsage()
       expect(usageDoc.usageQuota.rows).toEqual(3)
-      expect(usageDoc.apps?.[getProdAppID(app1.appId)].usageQuota.rows).toEqual(
-        1
-      )
-      expect(usageDoc.apps?.[getProdAppID(app2.appId)].usageQuota.rows).toEqual(
-        2
-      )
+      expect(
+        usageDoc.apps?.[dbCore.getProdAppID(app1.appId)].usageQuota.rows
+      ).toEqual(1)
+      expect(
+        usageDoc.apps?.[dbCore.getProdAppID(app2.appId)].usageQuota.rows
+      ).toEqual(2)
     })
   })
 })

package/src/migrations/functions/userEmailViewCasing.ts

@@ -1,4 +1,4 @@
-const { createNewUserEmailView } = require("@budibase/backend-core/db")
+import { db as dbCore } from "@budibase/backend-core"
 
 /**
  * Date:
@@ -8,6 +8,6 @@ const { createNewUserEmailView } = require("@budibase/backend-core/db")
  * Recreate the user email view to include latest changes i.e. lower casing the email address
  */
 
-export const run = async (db: any) => {
-  await createNewUserEmailView(db)
+export const run = async () => {
+  await dbCore.createNewUserEmailView()
 }

package/src/migrations/index.ts

@@ -12,6 +12,7 @@ import env from "../environment"
 import * as userEmailViewCasing from "./functions/userEmailViewCasing"
 import * as syncQuotas from "./functions/syncQuotas"
 import * as appUrls from "./functions/appUrls"
+import * as tableSettings from "./functions/tableSettings"
 import * as backfill from "./functions/backfill"
 /**
  * Populate the migration function and additional configuration from
@@ -73,6 +74,14 @@ export const buildMigrations = () => {
         })
         break
       }
+      case MigrationName.TABLE_SETTINGS_LINKS_TO_ACTIONS: {
+        serverMigrations.push({
+          ...definition,
+          appOpts: { dev: true },
+          fn: tableSettings.run,
+        })
+        break
+      }
     }
   }
 

package/src/migrations/tests/index.spec.ts

@@ -6,7 +6,7 @@ import {
   context,
 } from "@budibase/backend-core"
 import TestConfig from "../../tests/utilities/TestConfiguration"
-import structures from "../../tests/utilities/structures"
+import * as structures from "../../tests/utilities/structures"
 import { MIGRATIONS } from "../"
 import * as helpers from "./helpers"
 

package/src/sdk/app/applications/index.ts

@@ -0,0 +1,7 @@
+import * as sync from "./sync"
+import * as utils from "./utils"
+
+export default {
+  ...sync,
+  ...utils,
+}

package/src/sdk/app/applications/sync.ts

@@ -0,0 +1,61 @@
+import env from "../../../environment"
+import { db as dbCore, context } from "@budibase/backend-core"
+import sdk from "../../"
+
+export async function syncApp(
+  appId: string,
+  opts?: { automationOnly?: boolean }
+) {
+  if (env.DISABLE_AUTO_PROD_APP_SYNC) {
+    return {
+      message:
+        "App sync disabled. You can reenable with the DISABLE_AUTO_PROD_APP_SYNC environment variable.",
+    }
+  }
+
+  if (dbCore.isProdAppID(appId)) {
+    throw new Error("This action cannot be performed for production apps")
+  }
+
+  // replicate prod to dev
+  const prodAppId = dbCore.getProdAppID(appId)
+
+  // specific case, want to make sure setup is skipped
+  const prodDb = context.getProdAppDB({ skip_setup: true })
+  const exists = await prodDb.exists()
+  if (!exists) {
+    // the database doesn't exist. Don't replicate
+    return {
+      message: "App sync not required, app not deployed.",
+    }
+  }
+
+  const replication = new dbCore.Replication({
+    source: prodAppId,
+    target: appId,
+  })
+  let error
+  try {
+    const replOpts = replication.appReplicateOpts()
+    if (opts?.automationOnly) {
+      replOpts.filter = (doc: any) =>
+        doc._id.startsWith(dbCore.DocumentType.AUTOMATION)
+    }
+    await replication.replicate(replOpts)
+  } catch (err) {
+    error = err
+  } finally {
+    await replication.close()
+  }
+
+  // sync the users
+  await sdk.users.syncGlobalUsers()
+
+  if (error) {
+    throw error
+  } else {
+    return {
+      message: "App sync completed successfully.",
+    }
+  }
+}

package/src/sdk/app/applications/utils.ts

@@ -0,0 +1,17 @@
+const URL_REGEX_SLASH = /\/|\\/g
+
+export function getAppUrl(opts?: { name?: string; url?: string }) {
+  // construct the url
+  let url
+  if (opts?.url) {
+    // if the url is provided, use that
+    url = encodeURI(opts?.url)
+  } else if (opts?.name) {
+    // otherwise use the name
+    url = encodeURI(`${opts?.name}`)
+  }
+  if (url) {
+    url = `/${url.replace(URL_REGEX_SLASH, "")}`.toLowerCase()
+  }
+  return url as string
+}

package/src/sdk/app/backups/exports.ts

@@ -1,6 +1,5 @@
-import { db as dbCore } from "@budibase/backend-core"
+import { db as dbCore, objectStore } from "@budibase/backend-core"
 import { budibaseTempDir } from "../../../utilities/budibaseDir"
-import { retrieveDirectory } from "../../../utilities/fileSystem/utilities"
 import { streamFile, createTempFolder } from "../../../utilities/fileSystem"
 import { ObjectStoreBuckets } from "../../../constants"
 import {
@@ -88,7 +87,10 @@ export async function exportApp(appId: string, config?: ExportOpts) {
   // export bucket contents
   let tmpPath
   if (!env.isTest()) {
-    tmpPath = await retrieveDirectory(ObjectStoreBuckets.APPS, appPath)
+    tmpPath = await objectStore.retrieveDirectory(
+      ObjectStoreBuckets.APPS,
+      appPath
+    )
   } else {
     tmpPath = createTempFolder(uuid())
   }