@budibase/server 2.1.40-alpha.5 → 2.1.40-alpha.7

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/server",
   "email": "hi@budibase.com",
-  "version": "2.1.40-alpha.5",
+  "version": "2.1.40-alpha.7",
   "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.1.40-alpha.5",
-    "@budibase/client": "2.1.40-alpha.5",
-    "@budibase/pro": "2.1.40-alpha.4",
-    "@budibase/string-templates": "2.1.40-alpha.5",
-    "@budibase/types": "2.1.40-alpha.5",
+    "@budibase/backend-core": "2.1.40-alpha.7",
+    "@budibase/client": "2.1.40-alpha.7",
+    "@budibase/pro": "2.1.40-alpha.6",
+    "@budibase/string-templates": "2.1.40-alpha.7",
+    "@budibase/types": "2.1.40-alpha.7",
     "@bull-board/api": "3.7.0",
     "@bull-board/koa": "3.9.4",
     "@elastic/elasticsearch": "7.10.0",
@@ -165,5 +165,5 @@
   "optionalDependencies": {
     "oracledb": "5.3.0"
   },
-  "gitHead": "b9a56cbf4c9044ef49d6cea53e429e74baacda98"
+  "gitHead": "254d7d3a69e88042f2cca9ead848afbe5bf6bcea"
 }

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/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/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
+      }
     }
   }