From a701933f48ad5f4f141cd85d18f9f86938cbe410 Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Mon, 23 Oct 2023 17:57:25 +0100
Subject: [PATCH 01/20] Frontend changes for the user column migration work.

---
 packages/frontend-core/src/api/tables.js      |  9 +++++++
 .../components/grid/cells/HeaderCell.svelte   | 24 +++++++++++++++++++
 2 files changed, 33 insertions(+)

diff --git a/packages/frontend-core/src/api/tables.js b/packages/frontend-core/src/api/tables.js
index a08e35d3d8..34d2371e1a 100644
--- a/packages/frontend-core/src/api/tables.js
+++ b/packages/frontend-core/src/api/tables.js
@@ -140,4 +140,13 @@ export const buildTableEndpoints = API => ({
       },
     })
   },
+  migrateColumn: async ({ tableId, oldColumn, newColumn }) => {
+    return await API.post({
+      url: `/api/tables/${tableId}/migrate`,
+      body: {
+        oldColumn,
+        newColumn,
+      },
+    })
+  },
 })
diff --git a/packages/frontend-core/src/components/grid/cells/HeaderCell.svelte b/packages/frontend-core/src/components/grid/cells/HeaderCell.svelte
index d6cbcb582d..01c759a15c 100644
--- a/packages/frontend-core/src/components/grid/cells/HeaderCell.svelte
+++ b/packages/frontend-core/src/components/grid/cells/HeaderCell.svelte
@@ -10,6 +10,7 @@
   export let orderable = true
 
   const {
+    API,
     reorder,
     isReordering,
     isResizing,
@@ -114,6 +115,24 @@
     open = false
   }
 
+  const migrateUserColumn = async () => {
+    let subtype = "users"
+    if (column.schema.relationshipType === "one-to-many") {
+      subtype = "user"
+    }
+
+    await API.migrateColumn({
+      tableId: $definition._id,
+      oldColumn: column.schema,
+      newColumn: {
+        name: `${column.schema.name} migrated`,
+        type: "bb_reference",
+        subtype,
+      },
+    })
+    open = false
+  }
+
   const duplicateColumn = async () => {
     open = false
 
@@ -262,6 +281,11 @@
       >
         Hide column
       </MenuItem>
+      {#if column.schema.type === "link" && column.schema.tableId === "ta_users"}
+        <MenuItem icon="User" on:click={migrateUserColumn}>
+          Migrate to user column
+        </MenuItem>
+      {/if}
     </Menu>
   {/if}
 </Popover>

From 2f0a40e9bb8c8e8893517d6dfcca1433ff088173 Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Tue, 24 Oct 2023 15:18:46 +0100
Subject: [PATCH 02/20] Introduce modal to show warning to users, and toast to
 show success.

---
 .../backend/DataTable/TableDataTable.svelte   |  6 +++
 .../components/grid/cells/HeaderCell.svelte   | 42 +++++++++----------
 .../grid/controls/MigrationModal.svelte       | 42 +++++++++++++++++++
 3 files changed, 69 insertions(+), 21 deletions(-)
 create mode 100644 packages/frontend-core/src/components/grid/controls/MigrationModal.svelte

diff --git a/packages/builder/src/components/backend/DataTable/TableDataTable.svelte b/packages/builder/src/components/backend/DataTable/TableDataTable.svelte
index 5fee849afb..22deacbe03 100644
--- a/packages/builder/src/components/backend/DataTable/TableDataTable.svelte
+++ b/packages/builder/src/components/backend/DataTable/TableDataTable.svelte
@@ -53,6 +53,11 @@
       await datasources.fetch()
     }
   }
+
+  const refreshDefinitions = async () => {
+    await tables.fetch()
+    await datasources.fetch()
+  }
 </script>
 
 <div class="wrapper">
@@ -66,6 +71,7 @@
     schemaOverrides={isUsersTable ? userSchemaOverrides : null}
     showAvatars={false}
     on:updatedatasource={handleGridTableUpdate}
+    on:refreshdefinitions={refreshDefinitions}
   >
     <svelte:fragment slot="filter">
       {#if isUsersTable && $store.features.disableUserMetadata}
diff --git a/packages/frontend-core/src/components/grid/cells/HeaderCell.svelte b/packages/frontend-core/src/components/grid/cells/HeaderCell.svelte
index 01c759a15c..9b05f9ef79 100644
--- a/packages/frontend-core/src/components/grid/cells/HeaderCell.svelte
+++ b/packages/frontend-core/src/components/grid/cells/HeaderCell.svelte
@@ -1,9 +1,17 @@
 <script>
   import { getContext, onMount, tick } from "svelte"
   import { canBeDisplayColumn, canBeSortColumn } from "@budibase/shared-core"
-  import { Icon, Popover, Menu, MenuItem, clickOutside } from "@budibase/bbui"
+  import {
+    Icon,
+    Popover,
+    Menu,
+    MenuItem,
+    clickOutside,
+    Modal,
+  } from "@budibase/bbui"
   import GridCell from "./GridCell.svelte"
   import { getColumnIcon } from "../lib/utils"
+  import MigrationModal from "../controls/MigrationModal.svelte"
 
   export let column
   export let idx
@@ -32,6 +40,7 @@
   let editIsOpen = false
   let timeout
   let popover
+  let migrationModal
 
   $: sortedBy = column.name === $sort.column
   $: canMoveLeft = orderable && idx > 0
@@ -115,24 +124,6 @@
     open = false
   }
 
-  const migrateUserColumn = async () => {
-    let subtype = "users"
-    if (column.schema.relationshipType === "one-to-many") {
-      subtype = "user"
-    }
-
-    await API.migrateColumn({
-      tableId: $definition._id,
-      oldColumn: column.schema,
-      newColumn: {
-        name: `${column.schema.name} migrated`,
-        type: "bb_reference",
-        subtype,
-      },
-    })
-    open = false
-  }
-
   const duplicateColumn = async () => {
     open = false
 
@@ -160,9 +151,18 @@
     })
   }
 
+  const openMigrationModal = () => {
+    migrationModal.show()
+    open = false
+  }
+
   onMount(() => subscribe("close-edit-column", cancelEdit))
 </script>
 
+<Modal bind:this={migrationModal}>
+  <MigrationModal {column} />
+</Modal>
+
 <div
   class="header-cell"
   class:open
@@ -281,8 +281,8 @@
       >
         Hide column
       </MenuItem>
-      {#if column.schema.type === "link" && column.schema.tableId === "ta_users"}
-        <MenuItem icon="User" on:click={migrateUserColumn}>
+      {#if $config.canEditColumns && column.schema.type === "link" && column.schema.tableId === "ta_users"}
+        <MenuItem icon="User" on:click={openMigrationModal}>
           Migrate to user column
         </MenuItem>
       {/if}
diff --git a/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte b/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
new file mode 100644
index 0000000000..b262f93797
--- /dev/null
+++ b/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
@@ -0,0 +1,42 @@
+<script>
+  import { ModalContent, notifications } from "@budibase/bbui"
+  import { getContext } from "svelte"
+
+  const { API, dispatch, definition, rows } = getContext("grid")
+
+  export let column
+
+  const migrateUserColumn = async () => {
+    let subtype = "users"
+    if (column.schema.relationshipType === "one-to-many") {
+      subtype = "user"
+    }
+
+    try {
+      await API.migrateColumn({
+        tableId: $definition._id,
+        oldColumn: column.schema,
+        newColumn: {
+          name: `${column.schema.name} migrated`,
+          type: "bb_reference",
+          subtype,
+        },
+      })
+      notifications.success("Column migrated")
+    } catch (e) {
+      notifications.error(`Failed to migrate: ${e.message}`)
+    }
+    await rows.actions.refreshData()
+    dispatch("refreshdefintions")
+  }
+</script>
+
+<ModalContent
+  title="Migrate column"
+  confirmText="Continue"
+  cancelText="Cancel"
+  onConfirm={migrateUserColumn}
+  size="M"
+>
+  TODO: copy here
+</ModalContent>

From d3670ddf21a43552aee52602c3a40acd7eea7f38 Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Tue, 24 Oct 2023 17:22:49 +0100
Subject: [PATCH 03/20] Add an input to allow the user to choose the new column
 name.

---
 .../backend/DataTable/TableDataTable.svelte   |  1 +
 .../grid/controls/MigrationModal.svelte       | 22 ++++++++++++++++---
 2 files changed, 20 insertions(+), 3 deletions(-)

diff --git a/packages/builder/src/components/backend/DataTable/TableDataTable.svelte b/packages/builder/src/components/backend/DataTable/TableDataTable.svelte
index 22deacbe03..40bcf2b74e 100644
--- a/packages/builder/src/components/backend/DataTable/TableDataTable.svelte
+++ b/packages/builder/src/components/backend/DataTable/TableDataTable.svelte
@@ -55,6 +55,7 @@
   }
 
   const refreshDefinitions = async () => {
+    console.log("woot")
     await tables.fetch()
     await datasources.fetch()
   }
diff --git a/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte b/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
index b262f93797..e329038217 100644
--- a/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
+++ b/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
@@ -1,11 +1,18 @@
 <script>
-  import { ModalContent, notifications } from "@budibase/bbui"
+  import {
+    ModalContent,
+    notifications,
+    Input,
+    InlineAlert,
+  } from "@budibase/bbui"
   import { getContext } from "svelte"
 
   const { API, dispatch, definition, rows } = getContext("grid")
 
   export let column
 
+  let newColumnName = `${column.schema.name} (migrated)`
+
   const migrateUserColumn = async () => {
     let subtype = "users"
     if (column.schema.relationshipType === "one-to-many") {
@@ -17,7 +24,7 @@
         tableId: $definition._id,
         oldColumn: column.schema,
         newColumn: {
-          name: `${column.schema.name} migrated`,
+          name: newColumnName,
           type: "bb_reference",
           subtype,
         },
@@ -38,5 +45,14 @@
   onConfirm={migrateUserColumn}
   size="M"
 >
-  TODO: copy here
+  This operation will kick off a migration of the column "{column.schema.name}"
+  to a new column, with the name provided - this operation may take a moment to
+  complete.
+
+  <InlineAlert
+    type="error"
+    header="Are you sure?"
+    message="This will leave bindings which utilised the user relationship column in a state where they will need to be updated to use the new column instead."
+  />
+  <Input bind:value={newColumnName} label="New column name" />
 </ModalContent>

From f4c6ab7f48960b780d398cd56858512b08221d70 Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Tue, 24 Oct 2023 17:33:49 +0100
Subject: [PATCH 04/20] Make sure the user cannot enter the same column name as
 the old column for the migrated column.

---
 .../src/components/grid/cells/HeaderCell.svelte        |  1 -
 .../src/components/grid/controls/MigrationModal.svelte | 10 +++++++++-
 2 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/packages/frontend-core/src/components/grid/cells/HeaderCell.svelte b/packages/frontend-core/src/components/grid/cells/HeaderCell.svelte
index 9b05f9ef79..420be480e9 100644
--- a/packages/frontend-core/src/components/grid/cells/HeaderCell.svelte
+++ b/packages/frontend-core/src/components/grid/cells/HeaderCell.svelte
@@ -18,7 +18,6 @@
   export let orderable = true
 
   const {
-    API,
     reorder,
     isReordering,
     isResizing,
diff --git a/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte b/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
index e329038217..f4070e7a98 100644
--- a/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
+++ b/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
@@ -12,6 +12,7 @@
   export let column
 
   let newColumnName = `${column.schema.name} (migrated)`
+  $: newAndOldNameMatch = column.schema.name === newColumnName
 
   const migrateUserColumn = async () => {
     let subtype = "users"
@@ -43,6 +44,7 @@
   confirmText="Continue"
   cancelText="Cancel"
   onConfirm={migrateUserColumn}
+  disabled={newAndOldNameMatch}
   size="M"
 >
   This operation will kick off a migration of the column "{column.schema.name}"
@@ -54,5 +56,11 @@
     header="Are you sure?"
     message="This will leave bindings which utilised the user relationship column in a state where they will need to be updated to use the new column instead."
   />
-  <Input bind:value={newColumnName} label="New column name" />
+  <Input
+    bind:value={newColumnName}
+    label="New column name"
+    error={newAndOldNameMatch
+      ? "New column name can't be the same as the existing column name"
+      : undefined}
+  />
 </ModalContent>

From 0f5c2cff00305f4f6e2a87bd9ab8a2f60c1a8b67 Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Tue, 24 Oct 2023 18:06:25 +0100
Subject: [PATCH 05/20] Handle a couple more edge cases more gracefully.

---
 .../server/src/sdk/app/tables/migration.ts    | 24 ++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/packages/server/src/sdk/app/tables/migration.ts b/packages/server/src/sdk/app/tables/migration.ts
index 08c06b28b9..407302cf1a 100644
--- a/packages/server/src/sdk/app/tables/migration.ts
+++ b/packages/server/src/sdk/app/tables/migration.ts
@@ -30,7 +30,15 @@ export async function migrate(
   table.schema[newColumn.name] = newColumn
   table = await sdk.tables.saveTable(table)
 
-  await migrator.doMigration()
+  try {
+    await migrator.doMigration()
+  } catch (e) {
+    // If the migration fails then we need to roll back the table schema
+    // change.
+    delete table.schema[newColumn.name]
+    await sdk.tables.saveTable(table)
+    throw e
+  }
 
   delete table.schema[oldColumn.name]
   table = await sdk.tables.saveTable(table)
@@ -133,6 +141,13 @@ class SingleUserColumnMigrator implements ColumnMigrator {
 
       let userId = dbCore.getGlobalIDFromUserMetadataID(link.doc2.rowId)
       let row = rowsById[link.doc1.rowId]
+      if (!row) {
+        // This can happen if the row has been deleted but the link hasn't,
+        // which was a state that was found during the initial testing of this
+        // feature. Not sure exactly what can cause it, but best to be safe.
+        continue
+      }
+
       row[this.newColumn.name] = userId
     }
 
@@ -171,6 +186,13 @@ class MultiUserColumnMigrator implements ColumnMigrator {
 
       let userId = dbCore.getGlobalIDFromUserMetadataID(link.doc2.rowId)
       let row = rowsById[link.doc1.rowId]
+      if (!row) {
+        // This can happen if the row has been deleted but the link hasn't,
+        // which was a state that was found during the initial testing of this
+        // feature. Not sure exactly what can cause it, but best to be safe.
+        continue
+      }
+
       if (!row[this.newColumn.name]) {
         row[this.newColumn.name] = []
       }

From 78afba63dec506e823589858af382b65804f61d1 Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Wed, 25 Oct 2023 11:03:35 +0100
Subject: [PATCH 06/20] Emit table updates to the builder socket, and some
 minor refactoring.

---
 .../server/src/api/controllers/table/index.ts |   6 +-
 .../server/src/sdk/app/tables/migration.ts    | 148 ++++++++----------
 .../server/src/tests/utilities/api/table.ts   |   9 +-
 3 files changed, 78 insertions(+), 85 deletions(-)

diff --git a/packages/server/src/api/controllers/table/index.ts b/packages/server/src/api/controllers/table/index.ts
index fb7f8d2a5a..1ad8542afd 100644
--- a/packages/server/src/api/controllers/table/index.ts
+++ b/packages/server/src/api/controllers/table/index.ts
@@ -165,7 +165,11 @@ export async function migrate(ctx: UserCtx<MigrateRequest, MigrateResponse>) {
   const { oldColumn, newColumn } = ctx.request.body
   let tableId = ctx.params.tableId as string
   const table = await sdk.tables.getTable(tableId)
-  await sdk.tables.migrate(table, oldColumn, newColumn)
+  let result = await sdk.tables.migrate(table, oldColumn, newColumn)
+
+  for (let table of result.tablesUpdated) {
+    builderSocket?.emitTableUpdate(ctx, table)
+  }
 
   ctx.status = 200
   ctx.body = { message: `Column ${oldColumn.name} migrated.` }
diff --git a/packages/server/src/sdk/app/tables/migration.ts b/packages/server/src/sdk/app/tables/migration.ts
index 407302cf1a..b678b64318 100644
--- a/packages/server/src/sdk/app/tables/migration.ts
+++ b/packages/server/src/sdk/app/tables/migration.ts
@@ -1,37 +1,43 @@
-import { BadRequestError, context } from "@budibase/backend-core"
+import { BadRequestError, context, db as dbCore } from "@budibase/backend-core"
 import {
   BBReferenceFieldMetadata,
   FieldSchema,
   FieldSubtype,
   InternalTable,
-  ManyToManyRelationshipFieldMetadata,
-  ManyToOneRelationshipFieldMetadata,
-  OneToManyRelationshipFieldMetadata,
+  isBBReferenceField,
+  isRelationshipField,
+  LinkDocument,
+  RelationshipFieldMetadata,
   RelationshipType,
   Row,
   Table,
-  isBBReferenceField,
-  isRelationshipField,
 } from "@budibase/types"
 import sdk from "../../../sdk"
-import { isExternalTable } from "../../../../src/integrations/utils"
-import { db as dbCore } from "@budibase/backend-core"
-import { EventType, updateLinks } from "../../../../src/db/linkedRows"
+import { isExternalTable } from "../../../integrations/utils"
+import { EventType, updateLinks } from "../../../db/linkedRows"
 import { cloneDeep } from "lodash"
 
+export interface MigrationResult {
+  tablesUpdated: Table[]
+}
+
 export async function migrate(
   table: Table,
   oldColumn: FieldSchema,
   newColumn: FieldSchema
-) {
-  let migrator = getColumnMigrator(table, oldColumn, newColumn)
-  let oldTable = cloneDeep(table)
+): Promise<MigrationResult> {
+  if (newColumn.name in table.schema) {
+    throw new BadRequestError(`Column "${newColumn.name}" already exists`)
+  }
 
   table.schema[newColumn.name] = newColumn
   table = await sdk.tables.saveTable(table)
 
+  let migrator = getColumnMigrator(table, oldColumn, newColumn)
+  let result: MigrationResult
+
   try {
-    await migrator.doMigration()
+    result = await migrator.doMigration()
   } catch (e) {
     // If the migration fails then we need to roll back the table schema
     // change.
@@ -40,13 +46,11 @@ export async function migrate(
     throw e
   }
 
-  delete table.schema[oldColumn.name]
-  table = await sdk.tables.saveTable(table)
-  await updateLinks({ eventType: EventType.TABLE_UPDATED, table, oldTable })
+  return result
 }
 
 interface ColumnMigrator {
-  doMigration(): Promise<void>
+  doMigration(): Promise<MigrationResult>
 }
 
 function getColumnMigrator(
@@ -54,8 +58,8 @@ function getColumnMigrator(
   oldColumn: FieldSchema,
   newColumn: FieldSchema
 ): ColumnMigrator {
-  // For now we're only supporting migrations of user relationships to user
-  // columns in internal tables. In future we may want to support other
+  // For now, we're only supporting migrations of user relationships to user
+  // columns in internal tables. In the future, we may want to support other
   // migrations but for now return an error if we aren't migrating a user
   // relationship.
   if (isExternalTable(table._id!)) {
@@ -66,10 +70,6 @@ function getColumnMigrator(
     throw new BadRequestError(`Column "${oldColumn.name}" does not exist`)
   }
 
-  if (newColumn.name in table.schema) {
-    throw new BadRequestError(`Column "${newColumn.name}" already exists`)
-  }
-
   if (!isBBReferenceField(newColumn)) {
     throw new BadRequestError(`Column "${newColumn.name}" is not a user column`)
   }
@@ -113,14 +113,17 @@ function getColumnMigrator(
   throw new BadRequestError(`Unknown migration type`)
 }
 
-class SingleUserColumnMigrator implements ColumnMigrator {
+abstract class UserColumnMigrator implements ColumnMigrator {
   constructor(
-    private table: Table,
-    private oldColumn: OneToManyRelationshipFieldMetadata,
-    private newColumn: BBReferenceFieldMetadata
+    protected table: Table,
+    protected oldColumn: RelationshipFieldMetadata,
+    protected newColumn: BBReferenceFieldMetadata
   ) {}
 
-  async doMigration() {
+  abstract updateRow(row: Row, link: LinkDocument): void
+
+  async doMigration(): Promise<MigrationResult> {
+    let oldTable = cloneDeep(this.table)
     let rows = await sdk.rows.fetchRaw(this.table._id!)
     let rowsById = rows.reduce((acc, row) => {
       acc[row._id!] = row
@@ -129,17 +132,14 @@ class SingleUserColumnMigrator implements ColumnMigrator {
 
     let links = await sdk.links.fetchWithDocument(this.table._id!)
     for (let link of links) {
-      if (link.doc1.tableId !== this.table._id) {
-        continue
-      }
-      if (link.doc1.fieldName !== this.oldColumn.name) {
-        continue
-      }
-      if (link.doc2.tableId !== InternalTable.USER_METADATA) {
+      if (
+        link.doc1.tableId !== this.table._id ||
+        link.doc1.fieldName !== this.oldColumn.name ||
+        link.doc2.tableId !== InternalTable.USER_METADATA
+      ) {
         continue
       }
 
-      let userId = dbCore.getGlobalIDFromUserMetadataID(link.doc2.rowId)
       let row = rowsById[link.doc1.rowId]
       if (!row) {
         // This can happen if the row has been deleted but the link hasn't,
@@ -148,58 +148,42 @@ class SingleUserColumnMigrator implements ColumnMigrator {
         continue
       }
 
-      row[this.newColumn.name] = userId
+      this.updateRow(row, link)
     }
 
     let db = context.getAppDB()
     await db.bulkDocs(rows)
-  }
-}
 
-class MultiUserColumnMigrator implements ColumnMigrator {
-  constructor(
-    private table: Table,
-    private oldColumn:
-      | ManyToManyRelationshipFieldMetadata
-      | ManyToOneRelationshipFieldMetadata,
-    private newColumn: BBReferenceFieldMetadata
-  ) {}
+    delete this.table.schema[this.oldColumn.name]
+    this.table = await sdk.tables.saveTable(this.table)
+    await updateLinks({
+      eventType: EventType.TABLE_UPDATED,
+      table: this.table,
+      oldTable,
+    })
 
-  async doMigration() {
-    let rows = await sdk.rows.fetchRaw(this.table._id!)
-    let rowsById = rows.reduce((acc, row) => {
-      acc[row._id!] = row
-      return acc
-    }, {} as Record<string, Row>)
-
-    let links = await sdk.links.fetchWithDocument(this.table._id!)
-    for (let link of links) {
-      if (link.doc1.tableId !== this.table._id) {
-        continue
-      }
-      if (link.doc1.fieldName !== this.oldColumn.name) {
-        continue
-      }
-      if (link.doc2.tableId !== InternalTable.USER_METADATA) {
-        continue
-      }
-
-      let userId = dbCore.getGlobalIDFromUserMetadataID(link.doc2.rowId)
-      let row = rowsById[link.doc1.rowId]
-      if (!row) {
-        // This can happen if the row has been deleted but the link hasn't,
-        // which was a state that was found during the initial testing of this
-        // feature. Not sure exactly what can cause it, but best to be safe.
-        continue
-      }
-
-      if (!row[this.newColumn.name]) {
-        row[this.newColumn.name] = []
-      }
-      row[this.newColumn.name].push(userId)
+    let otherTable = await sdk.tables.getTable(this.oldColumn.tableId)
+    return {
+      tablesUpdated: [this.table, otherTable],
     }
-
-    let db = context.getAppDB()
-    await db.bulkDocs(rows)
+  }
+}
+
+class SingleUserColumnMigrator extends UserColumnMigrator {
+  updateRow(row: Row, link: LinkDocument): void {
+    row[this.newColumn.name] = dbCore.getGlobalIDFromUserMetadataID(
+      link.doc2.rowId
+    )
+  }
+}
+
+class MultiUserColumnMigrator extends UserColumnMigrator {
+  updateRow(row: Row, link: LinkDocument): void {
+    if (!row[this.newColumn.name]) {
+      row[this.newColumn.name] = []
+    }
+    row[this.newColumn.name].push(
+      dbCore.getGlobalIDFromUserMetadataID(link.doc2.rowId)
+    )
   }
 }
diff --git a/packages/server/src/tests/utilities/api/table.ts b/packages/server/src/tests/utilities/api/table.ts
index 501841f6e7..b80c940697 100644
--- a/packages/server/src/tests/utilities/api/table.ts
+++ b/packages/server/src/tests/utilities/api/table.ts
@@ -58,8 +58,13 @@ export class TableAPI extends TestAPI {
       .post(`/api/tables/${tableId}/migrate`)
       .send(data)
       .set(this.config.defaultHeaders())
-      .expect("Content-Type", /json/)
-      .expect(expectStatus)
+    if (res.status !== expectStatus) {
+      throw new Error(
+        `Expected status ${expectStatus} but got ${
+          res.status
+        } with body ${JSON.stringify(res.body)}`
+      )
+    }
     return res.body
   }
 }

From 52f97fbd1fdbb9b017f5f3c001f992dac7ae2f94 Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Wed, 25 Oct 2023 11:38:31 +0100
Subject: [PATCH 07/20] Attempt to emit events that include the originator.

---
 .../server/src/api/controllers/table/index.ts |  2 +-
 packages/server/src/websockets/builder.ts     | 18 ++++++++++-----
 packages/server/src/websockets/websocket.ts   | 23 +++++++++++++++----
 3 files changed, 31 insertions(+), 12 deletions(-)

diff --git a/packages/server/src/api/controllers/table/index.ts b/packages/server/src/api/controllers/table/index.ts
index 1ad8542afd..af3c2c0c15 100644
--- a/packages/server/src/api/controllers/table/index.ts
+++ b/packages/server/src/api/controllers/table/index.ts
@@ -168,7 +168,7 @@ export async function migrate(ctx: UserCtx<MigrateRequest, MigrateResponse>) {
   let result = await sdk.tables.migrate(table, oldColumn, newColumn)
 
   for (let table of result.tablesUpdated) {
-    builderSocket?.emitTableUpdate(ctx, table)
+    builderSocket?.emitTableUpdate(ctx, table, { includeSelf: true })
   }
 
   ctx.status = 200
diff --git a/packages/server/src/websockets/builder.ts b/packages/server/src/websockets/builder.ts
index d2fdbca20c..b1ef473d6c 100644
--- a/packages/server/src/websockets/builder.ts
+++ b/packages/server/src/websockets/builder.ts
@@ -1,5 +1,5 @@
 import authorized from "../middleware/authorized"
-import { BaseSocket } from "./websocket"
+import { BaseSocket, EmitOptions } from "./websocket"
 import { permissions, events, context } from "@budibase/backend-core"
 import http from "http"
 import Koa from "koa"
@@ -100,11 +100,17 @@ export default class BuilderSocket extends BaseSocket {
     })
   }
 
-  emitTableUpdate(ctx: any, table: Table) {
-    this.emitToRoom(ctx, ctx.appId, BuilderSocketEvent.TableChange, {
-      id: table._id,
-      table,
-    })
+  emitTableUpdate(ctx: any, table: Table, options?: EmitOptions) {
+    this.emitToRoom(
+      ctx,
+      ctx.appId,
+      BuilderSocketEvent.TableChange,
+      {
+        id: table._id,
+        table,
+      },
+      options
+    )
     gridSocket?.emitTableUpdate(ctx, table)
   }
 
diff --git a/packages/server/src/websockets/websocket.ts b/packages/server/src/websockets/websocket.ts
index ffaf9e2763..a0dc388d4f 100644
--- a/packages/server/src/websockets/websocket.ts
+++ b/packages/server/src/websockets/websocket.ts
@@ -11,6 +11,12 @@ import { SocketSession } from "@budibase/types"
 import { v4 as uuid } from "uuid"
 import { createContext, runMiddlewares } from "./middleware"
 
+export interface EmitOptions {
+  // Whether to include the originator of the request from the broadcast,
+  // defaults to false.
+  includeSelf?: boolean
+}
+
 const anonUser = () => ({
   _id: uuid(),
   email: "user@mail.com",
@@ -270,10 +276,17 @@ export class BaseSocket {
 
   // Emit an event to everyone in a room, including metadata of whom
   // the originator of the request was
-  emitToRoom(ctx: any, room: string | string[], event: string, payload: any) {
-    this.io.in(room).emit(event, {
-      ...payload,
-      apiSessionId: ctx.headers?.[Header.SESSION_ID],
-    })
+  emitToRoom(
+    ctx: any,
+    room: string | string[],
+    event: string,
+    payload: any,
+    options?: EmitOptions
+  ) {
+    let emitPayload = { ...payload }
+    if (!options?.includeSelf) {
+      emitPayload.apiSessionId = ctx.headers?.[Header.SESSION_ID]
+    }
+    this.io.in(room).emit(event, emitPayload)
   }
 }

From 70f39b6b6bc86ad34ef7f80826b1d6e4707ef39f Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Wed, 25 Oct 2023 14:41:23 +0100
Subject: [PATCH 08/20] Fix missing sourceId on Table sent to the websocket.

---
 packages/builder/src/builderStore/websocket.js     |  1 +
 packages/server/src/api/controllers/table/index.ts |  5 ++++-
 packages/server/src/sdk/app/tables/getters.ts      | 12 ++++++++----
 3 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/packages/builder/src/builderStore/websocket.js b/packages/builder/src/builderStore/websocket.js
index 6121831c38..2aed5a3f8f 100644
--- a/packages/builder/src/builderStore/websocket.js
+++ b/packages/builder/src/builderStore/websocket.js
@@ -47,6 +47,7 @@ export const createBuilderWebsocket = appId => {
 
   // Data section events
   socket.onOther(BuilderSocketEvent.TableChange, ({ id, table }) => {
+    console.log("Table change", id, table)
     tables.replaceTable(id, table)
   })
   socket.onOther(BuilderSocketEvent.DatasourceChange, ({ id, datasource }) => {
diff --git a/packages/server/src/api/controllers/table/index.ts b/packages/server/src/api/controllers/table/index.ts
index af3c2c0c15..f139313086 100644
--- a/packages/server/src/api/controllers/table/index.ts
+++ b/packages/server/src/api/controllers/table/index.ts
@@ -24,6 +24,7 @@ import sdk from "../../../sdk"
 import { jsonFromCsvString } from "../../../utilities/csv"
 import { builderSocket } from "../../../websockets"
 import { cloneDeep, isEqual } from "lodash"
+import { processInternalTable } from "../../../sdk/app/tables/getters"
 
 function pickApi({ tableId, table }: { tableId?: string; table?: Table }) {
   if (table && !tableId) {
@@ -168,7 +169,9 @@ export async function migrate(ctx: UserCtx<MigrateRequest, MigrateResponse>) {
   let result = await sdk.tables.migrate(table, oldColumn, newColumn)
 
   for (let table of result.tablesUpdated) {
-    builderSocket?.emitTableUpdate(ctx, table, { includeSelf: true })
+    builderSocket?.emitTableUpdate(ctx, processInternalTable(table), {
+      includeSelf: true,
+    })
   }
 
   ctx.status = 200
diff --git a/packages/server/src/sdk/app/tables/getters.ts b/packages/server/src/sdk/app/tables/getters.ts
index 02cef748c5..34cddc8dc7 100644
--- a/packages/server/src/sdk/app/tables/getters.ts
+++ b/packages/server/src/sdk/app/tables/getters.ts
@@ -20,11 +20,15 @@ import datasources from "../datasources"
 import sdk from "../../../sdk"
 
 function processInternalTables(docs: AllDocsResponse<Table[]>): Table[] {
-  return docs.rows.map((tableDoc: any) => ({
-    ...tableDoc.doc,
+  return docs.rows.map(tableDoc => processInternalTable(tableDoc.doc))
+}
+
+export function processInternalTable(table: Table): Table {
+  return {
+    ...table,
     type: "internal",
-    sourceId: tableDoc.doc.sourceId || BudibaseInternalDB._id,
-  }))
+    sourceId: table.sourceId || BudibaseInternalDB._id,
+  }
 }
 
 export async function getAllInternalTables(db?: Database): Promise<Table[]> {

From 007e919d0edf97bd138c101981d02a5c06fc8153 Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Wed, 25 Oct 2023 14:53:51 +0100
Subject: [PATCH 09/20] Spring cleaning before review.

---
 packages/server/src/api/controllers/table/index.ts | 4 ++--
 packages/server/src/integrations/utils.ts          | 4 ++++
 packages/server/src/websockets/builder.ts          | 9 +++++++++
 packages/server/src/websockets/websocket.ts        | 8 +++++---
 4 files changed, 20 insertions(+), 5 deletions(-)

diff --git a/packages/server/src/api/controllers/table/index.ts b/packages/server/src/api/controllers/table/index.ts
index f139313086..d2ad63c13e 100644
--- a/packages/server/src/api/controllers/table/index.ts
+++ b/packages/server/src/api/controllers/table/index.ts
@@ -169,8 +169,8 @@ export async function migrate(ctx: UserCtx<MigrateRequest, MigrateResponse>) {
   let result = await sdk.tables.migrate(table, oldColumn, newColumn)
 
   for (let table of result.tablesUpdated) {
-    builderSocket?.emitTableUpdate(ctx, processInternalTable(table), {
-      includeSelf: true,
+    builderSocket?.emitTableUpdate(ctx, table, {
+      includeOriginator: true,
     })
   }
 
diff --git a/packages/server/src/integrations/utils.ts b/packages/server/src/integrations/utils.ts
index 79b18e767c..b37fe9f0ed 100644
--- a/packages/server/src/integrations/utils.ts
+++ b/packages/server/src/integrations/utils.ts
@@ -87,6 +87,10 @@ export function isExternalTable(tableId: string) {
   return tableId.includes(DocumentType.DATASOURCE)
 }
 
+export function isInternalTable(tableId: string) {
+  return !isExternalTable(tableId)
+}
+
 export function buildExternalTableId(datasourceId: string, tableName: string) {
   // encode spaces
   if (tableName.includes(" ")) {
diff --git a/packages/server/src/websockets/builder.ts b/packages/server/src/websockets/builder.ts
index b1ef473d6c..2cff24e635 100644
--- a/packages/server/src/websockets/builder.ts
+++ b/packages/server/src/websockets/builder.ts
@@ -16,6 +16,8 @@ import { gridSocket } from "./index"
 import { clearLock, updateLock } from "../utilities/redis"
 import { Socket } from "socket.io"
 import { BuilderSocketEvent } from "@budibase/shared-core"
+import { processInternalTable } from "../sdk/app/tables/getters"
+import { isExternalTable, isInternalTable } from "../integrations/utils"
 
 export default class BuilderSocket extends BaseSocket {
   constructor(app: Koa, server: http.Server) {
@@ -101,6 +103,13 @@ export default class BuilderSocket extends BaseSocket {
   }
 
   emitTableUpdate(ctx: any, table: Table, options?: EmitOptions) {
+    // This was added to make sure that sourceId is always present when
+    // sending this message to clients. Without this, tables without a
+    // sourceId (e.g. ta_users) won't get correctly updated client-side.
+    if (isInternalTable(table._id!)) {
+      table = processInternalTable(table)
+    }
+
     this.emitToRoom(
       ctx,
       ctx.appId,
diff --git a/packages/server/src/websockets/websocket.ts b/packages/server/src/websockets/websocket.ts
index a0dc388d4f..1dba108d24 100644
--- a/packages/server/src/websockets/websocket.ts
+++ b/packages/server/src/websockets/websocket.ts
@@ -13,8 +13,10 @@ import { createContext, runMiddlewares } from "./middleware"
 
 export interface EmitOptions {
   // Whether to include the originator of the request from the broadcast,
-  // defaults to false.
-  includeSelf?: boolean
+  // defaults to false because it is assumed that the user who triggered
+  // an action will already have the changes of that action reflected in their
+  // own UI, so there is no need to send them again.
+  includeOriginator?: boolean
 }
 
 const anonUser = () => ({
@@ -284,7 +286,7 @@ export class BaseSocket {
     options?: EmitOptions
   ) {
     let emitPayload = { ...payload }
-    if (!options?.includeSelf) {
+    if (!options?.includeOriginator) {
       emitPayload.apiSessionId = ctx.headers?.[Header.SESSION_ID]
     }
     this.io.in(room).emit(event, emitPayload)

From 5779e97e6eaf50687a0829592246d3081fc73a03 Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Wed, 25 Oct 2023 15:29:56 +0100
Subject: [PATCH 10/20] Add column name input validation.

---
 .../builder/src/builderStore/websocket.js     |  1 -
 .../grid/controls/MigrationModal.svelte       | 24 +++++++++++--------
 2 files changed, 14 insertions(+), 11 deletions(-)

diff --git a/packages/builder/src/builderStore/websocket.js b/packages/builder/src/builderStore/websocket.js
index 2aed5a3f8f..6121831c38 100644
--- a/packages/builder/src/builderStore/websocket.js
+++ b/packages/builder/src/builderStore/websocket.js
@@ -47,7 +47,6 @@ export const createBuilderWebsocket = appId => {
 
   // Data section events
   socket.onOther(BuilderSocketEvent.TableChange, ({ id, table }) => {
-    console.log("Table change", id, table)
     tables.replaceTable(id, table)
   })
   socket.onOther(BuilderSocketEvent.DatasourceChange, ({ id, datasource }) => {
diff --git a/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte b/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
index f4070e7a98..ee7fd7bfbe 100644
--- a/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
+++ b/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
@@ -6,13 +6,23 @@
     InlineAlert,
   } from "@budibase/bbui"
   import { getContext } from "svelte"
+  import { ValidColumnNameRegex } from "@budibase/shared-core"
 
   const { API, dispatch, definition, rows } = getContext("grid")
 
   export let column
 
-  let newColumnName = `${column.schema.name} (migrated)`
-  $: newAndOldNameMatch = column.schema.name === newColumnName
+  let newColumnName = `${column.schema.name} migrated`
+  $: error = checkNewColumnName(newColumnName)
+
+  const checkNewColumnName = newColumnName => {
+    if (column.schema.name === newColumnName) {
+      return "New column name can't be the same as the existing column name."
+    }
+    if (newColumnName.match(ValidColumnNameRegex) === null) {
+      return "Illegal character; must be alpha-numeric."
+    }
+  }
 
   const migrateUserColumn = async () => {
     let subtype = "users"
@@ -44,7 +54,7 @@
   confirmText="Continue"
   cancelText="Cancel"
   onConfirm={migrateUserColumn}
-  disabled={newAndOldNameMatch}
+  disabled={error !== undefined}
   size="M"
 >
   This operation will kick off a migration of the column "{column.schema.name}"
@@ -56,11 +66,5 @@
     header="Are you sure?"
     message="This will leave bindings which utilised the user relationship column in a state where they will need to be updated to use the new column instead."
   />
-  <Input
-    bind:value={newColumnName}
-    label="New column name"
-    error={newAndOldNameMatch
-      ? "New column name can't be the same as the existing column name"
-      : undefined}
-  />
+  <Input bind:value={newColumnName} label="New column name" {error} />
 </ModalContent>

From 402a53cacb3e413f64a0473247e63e78355132c9 Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Wed, 25 Oct 2023 15:33:12 +0100
Subject: [PATCH 11/20] User constant for user table ID.

---
 .../frontend-core/src/components/grid/cells/HeaderCell.svelte  | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/packages/frontend-core/src/components/grid/cells/HeaderCell.svelte b/packages/frontend-core/src/components/grid/cells/HeaderCell.svelte
index dee73d17e9..02cf751e30 100644
--- a/packages/frontend-core/src/components/grid/cells/HeaderCell.svelte
+++ b/packages/frontend-core/src/components/grid/cells/HeaderCell.svelte
@@ -14,6 +14,7 @@
   import MigrationModal from "../controls/MigrationModal.svelte"
   import { debounce } from "../../../utils/utils"
   import { FieldType, FormulaTypes } from "@budibase/types"
+  import { TableNames } from "../../../constants"
 
   export let column
   export let idx
@@ -381,7 +382,7 @@
       >
         Hide column
       </MenuItem>
-      {#if $config.canEditColumns && column.schema.type === "link" && column.schema.tableId === "ta_users"}
+      {#if $config.canEditColumns && column.schema.type === "link" && column.schema.tableId === TableNames.USERS}
         <MenuItem icon="User" on:click={openMigrationModal}>
           Migrate to user column
         </MenuItem>

From 0ac6b17ff09441c06ae7d19fe7c51843bf99c069 Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Wed, 25 Oct 2023 15:33:53 +0100
Subject: [PATCH 12/20] Remove stray console.log

---
 .../src/components/backend/DataTable/TableDataTable.svelte       | 1 -
 1 file changed, 1 deletion(-)

diff --git a/packages/builder/src/components/backend/DataTable/TableDataTable.svelte b/packages/builder/src/components/backend/DataTable/TableDataTable.svelte
index 40bcf2b74e..22deacbe03 100644
--- a/packages/builder/src/components/backend/DataTable/TableDataTable.svelte
+++ b/packages/builder/src/components/backend/DataTable/TableDataTable.svelte
@@ -55,7 +55,6 @@
   }
 
   const refreshDefinitions = async () => {
-    console.log("woot")
     await tables.fetch()
     await datasources.fetch()
   }

From c9e3b7a348ce41bd3e9e4bc1bf406a83463f6d35 Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Wed, 25 Oct 2023 16:00:14 +0100
Subject: [PATCH 13/20] Remove the previous attempt at syncing grid state, it
 is no longer needed.

---
 .../src/components/backend/DataTable/TableDataTable.svelte  | 6 ------
 .../src/components/grid/controls/MigrationModal.svelte      | 1 -
 2 files changed, 7 deletions(-)

diff --git a/packages/builder/src/components/backend/DataTable/TableDataTable.svelte b/packages/builder/src/components/backend/DataTable/TableDataTable.svelte
index 22deacbe03..5fee849afb 100644
--- a/packages/builder/src/components/backend/DataTable/TableDataTable.svelte
+++ b/packages/builder/src/components/backend/DataTable/TableDataTable.svelte
@@ -53,11 +53,6 @@
       await datasources.fetch()
     }
   }
-
-  const refreshDefinitions = async () => {
-    await tables.fetch()
-    await datasources.fetch()
-  }
 </script>
 
 <div class="wrapper">
@@ -71,7 +66,6 @@
     schemaOverrides={isUsersTable ? userSchemaOverrides : null}
     showAvatars={false}
     on:updatedatasource={handleGridTableUpdate}
-    on:refreshdefinitions={refreshDefinitions}
   >
     <svelte:fragment slot="filter">
       {#if isUsersTable && $store.features.disableUserMetadata}
diff --git a/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte b/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
index ee7fd7bfbe..111ff86170 100644
--- a/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
+++ b/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
@@ -45,7 +45,6 @@
       notifications.error(`Failed to migrate: ${e.message}`)
     }
     await rows.actions.refreshData()
-    dispatch("refreshdefintions")
   }
 </script>
 

From 7acce7b7c0b0a8ca4363263a8d728007c0eecfb8 Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Wed, 25 Oct 2023 16:01:08 +0100
Subject: [PATCH 14/20] Remove unused dispatch import.

---
 .../src/components/grid/controls/MigrationModal.svelte          | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte b/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
index 111ff86170..ec2972a03e 100644
--- a/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
+++ b/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
@@ -8,7 +8,7 @@
   import { getContext } from "svelte"
   import { ValidColumnNameRegex } from "@budibase/shared-core"
 
-  const { API, dispatch, definition, rows } = getContext("grid")
+  const { API, definition, rows } = getContext("grid")
 
   export let column
 

From 2c5dd99da202a45dfb97a5cb87351862ecc3627e Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Wed, 25 Oct 2023 16:37:15 +0100
Subject: [PATCH 15/20] Use FieldSubtype enum instead of raw strings.

---
 .../src/components/grid/controls/MigrationModal.svelte       | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte b/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
index ec2972a03e..0f173da8b9 100644
--- a/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
+++ b/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
@@ -7,6 +7,7 @@
   } from "@budibase/bbui"
   import { getContext } from "svelte"
   import { ValidColumnNameRegex } from "@budibase/shared-core"
+  import { FieldSubtype } from "@budibase/types"
 
   const { API, definition, rows } = getContext("grid")
 
@@ -25,9 +26,9 @@
   }
 
   const migrateUserColumn = async () => {
-    let subtype = "users"
+    let subtype = FieldSubtype.USERS
     if (column.schema.relationshipType === "one-to-many") {
-      subtype = "user"
+      subtype = FieldSubtype.USER
     }
 
     try {

From ef84e96f98c7a38a6145fb47beee4bdbf5237a73 Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Wed, 25 Oct 2023 16:38:14 +0100
Subject: [PATCH 16/20] Use RelationshipType enum instead of raw string.

---
 .../src/components/grid/controls/MigrationModal.svelte        | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte b/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
index 0f173da8b9..c6a49c6a48 100644
--- a/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
+++ b/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
@@ -7,7 +7,7 @@
   } from "@budibase/bbui"
   import { getContext } from "svelte"
   import { ValidColumnNameRegex } from "@budibase/shared-core"
-  import { FieldSubtype } from "@budibase/types"
+  import { FieldSubtype, RelationshipType } from "@budibase/types"
 
   const { API, definition, rows } = getContext("grid")
 
@@ -27,7 +27,7 @@
 
   const migrateUserColumn = async () => {
     let subtype = FieldSubtype.USERS
-    if (column.schema.relationshipType === "one-to-many") {
+    if (column.schema.relationshipType === RelationshipType.ONE_TO_MANY) {
       subtype = FieldSubtype.USER
     }
 

From c5097487e22438a0e4fbc961f2cb422c07329a00 Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Wed, 25 Oct 2023 16:38:55 +0100
Subject: [PATCH 17/20] Use FieldType constant instead of raw string.

---
 .../src/components/grid/controls/MigrationModal.svelte        | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte b/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
index c6a49c6a48..73ea32408b 100644
--- a/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
+++ b/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
@@ -7,7 +7,7 @@
   } from "@budibase/bbui"
   import { getContext } from "svelte"
   import { ValidColumnNameRegex } from "@budibase/shared-core"
-  import { FieldSubtype, RelationshipType } from "@budibase/types"
+  import { FieldSubtype, FieldType, RelationshipType } from "@budibase/types"
 
   const { API, definition, rows } = getContext("grid")
 
@@ -37,7 +37,7 @@
         oldColumn: column.schema,
         newColumn: {
           name: newColumnName,
-          type: "bb_reference",
+          type: FieldType.BB_REFERENCE,
           subtype,
         },
       })

From e03b1be9d1b2c7c3e8c3ded8f0b3e304a23446bc Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Wed, 25 Oct 2023 16:41:37 +0100
Subject: [PATCH 18/20] Make sure new column name cannot be the same as an
 existing column name.

---
 .../src/components/grid/controls/MigrationModal.svelte        | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte b/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
index 73ea32408b..1957c3259f 100644
--- a/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
+++ b/packages/frontend-core/src/components/grid/controls/MigrationModal.svelte
@@ -17,8 +17,8 @@
   $: error = checkNewColumnName(newColumnName)
 
   const checkNewColumnName = newColumnName => {
-    if (column.schema.name === newColumnName) {
-      return "New column name can't be the same as the existing column name."
+    if (newColumnName in $definition.schema) {
+      return "New column name can't be the same as an existing column name."
     }
     if (newColumnName.match(ValidColumnNameRegex) === null) {
       return "Illegal character; must be alpha-numeric."

From 4a00649f7f7c01d1280a08ff35cedd4963779021 Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Wed, 25 Oct 2023 16:46:14 +0100
Subject: [PATCH 19/20] Simplify the function signature of
 processInternalTables

---
 packages/server/src/sdk/app/tables/getters.ts | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/packages/server/src/sdk/app/tables/getters.ts b/packages/server/src/sdk/app/tables/getters.ts
index 34cddc8dc7..47da0beb40 100644
--- a/packages/server/src/sdk/app/tables/getters.ts
+++ b/packages/server/src/sdk/app/tables/getters.ts
@@ -19,8 +19,8 @@ import {
 import datasources from "../datasources"
 import sdk from "../../../sdk"
 
-function processInternalTables(docs: AllDocsResponse<Table[]>): Table[] {
-  return docs.rows.map(tableDoc => processInternalTable(tableDoc.doc))
+function processInternalTables(tables: Table[]): Table[] {
+  return tables.map(processInternalTable)
 }
 
 export function processInternalTable(table: Table): Table {
@@ -40,7 +40,7 @@ export async function getAllInternalTables(db?: Database): Promise<Table[]> {
       include_docs: true,
     })
   )
-  return processInternalTables(internalTables)
+  return processInternalTables(internalTables.rows.map(row => row.doc!))
 }
 
 async function getAllExternalTables(): Promise<Table[]> {
@@ -110,7 +110,9 @@ export async function getTables(tableIds: string[]): Promise<Table[]> {
     const internalTableDocs = await db.allDocs<Table[]>(
       getMultiIDParams(internalTableIds)
     )
-    tables = tables.concat(processInternalTables(internalTableDocs))
+    tables = tables.concat(
+      processInternalTables(internalTableDocs.rows.map(row => row.doc!))
+    )
   }
   return tables
 }

From 6c3b535863878c521bb312606218b89fa2f0f787 Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Wed, 25 Oct 2023 16:49:29 +0100
Subject: [PATCH 20/20] Simplify try-catch in the migrate function.

---
 packages/server/src/sdk/app/tables/migration.ts | 6 +-----
 1 file changed, 1 insertion(+), 5 deletions(-)

diff --git a/packages/server/src/sdk/app/tables/migration.ts b/packages/server/src/sdk/app/tables/migration.ts
index b678b64318..293f9184d6 100644
--- a/packages/server/src/sdk/app/tables/migration.ts
+++ b/packages/server/src/sdk/app/tables/migration.ts
@@ -34,10 +34,8 @@ export async function migrate(
   table = await sdk.tables.saveTable(table)
 
   let migrator = getColumnMigrator(table, oldColumn, newColumn)
-  let result: MigrationResult
-
   try {
-    result = await migrator.doMigration()
+    return await migrator.doMigration()
   } catch (e) {
     // If the migration fails then we need to roll back the table schema
     // change.
@@ -45,8 +43,6 @@ export async function migrate(
     await sdk.tables.saveTable(table)
     throw e
   }
-
-  return result
 }
 
 interface ColumnMigrator {