Merge pull request #14929 from Budibase/use-existing-ids-non-ds-plus

Allow tables to handle _id values in non DS+ rows

packages/client/src/components/app/GridBlock.svelte

@@ -60,8 +60,11 @@
 
   // Provide additional data context for live binding eval
   export const getAdditionalDataContext = () => {
-    const rows = get(grid?.getContext()?.rows)
+    const gridContext = grid?.getContext()
-    const goldenRow = generateGoldenSample(rows)
+    const rows = get(gridContext?.rows) || []
+    const clean = gridContext?.rows.actions.cleanRow || (x => x)
+    const cleaned = rows.map(clean)
+    const goldenRow = generateGoldenSample(cleaned)
     const id = get(component).id
     return {
       // Not sure what this one is for...

packages/frontend-core/src/components/grid/lib/constants.js

@@ -10,6 +10,8 @@ export const DefaultColumnWidth = 200
 export const MinColumnWidth = 80
 export const NewRowID = "new"
 export const BlankRowID = "blank"
+export const GeneratedIDPrefix = "‽‽"
+export const CellIDSeparator = "‽‽"
 export const RowPageSize = 100
 export const FocusedCellMinOffset = ScrollBarSize * 3
 export const ControlsHeight = 50

packages/frontend-core/src/components/grid/lib/utils.js

@@ -1,18 +1,17 @@
-// We can't use "-" as a separator as this can be present in the ID
+import { GeneratedIDPrefix, CellIDSeparator } from "./constants"
-// or column name, so we use something very unusual to avoid this problem
+import { Helpers } from "@budibase/bbui"
-const JOINING_CHARACTER = "‽‽"
 
 export const parseCellID = cellId => {
   if (!cellId) {
     return { rowId: undefined, field: undefined }
   }
-  const parts = cellId.split(JOINING_CHARACTER)
+  const parts = cellId.split(CellIDSeparator)
   const field = parts.pop()
-  return { rowId: parts.join(JOINING_CHARACTER), field }
+  return { rowId: parts.join(CellIDSeparator), field }
 }
 
 export const getCellID = (rowId, fieldName) => {
-  return `${rowId}${JOINING_CHARACTER}${fieldName}`
+  return `${rowId}${CellIDSeparator}${fieldName}`
 }
 
 export const parseEventLocation = e => {
@@ -21,3 +20,11 @@ export const parseEventLocation = e => {
     y: e.clientY ?? e.touches?.[0]?.clientY,
   }
 }
+
+export const generateRowID = () => {
+  return `${GeneratedIDPrefix}${Helpers.uuid()}`
+}
+
+export const isGeneratedRowID = id => {
+  return id?.startsWith(GeneratedIDPrefix)
+}

packages/frontend-core/src/components/grid/stores/rows.js

@@ -1,7 +1,12 @@
 import { writable, derived, get } from "svelte/store"
 import { fetchData } from "../../../fetch"
 import { NewRowID, RowPageSize } from "../lib/constants"
-import { getCellID, parseCellID } from "../lib/utils"
+import {
+  generateRowID,
+  getCellID,
+  isGeneratedRowID,
+  parseCellID,
+} from "../lib/utils"
 import { tick } from "svelte"
 import { Helpers } from "@budibase/bbui"
 import { sleep } from "../../../utils/utils"
@@ -634,10 +639,10 @@ export const createActions = context => {
       newRow = newRows[i]
 
       // Ensure we have a unique _id.
-      // This means generating one for non DS+, overwriting any that may already
+      // We generate one for non DS+ where required, but trust that any existing
-      // exist as we cannot allow duplicates.
+      // _id values are unique (e.g. Mongo)
-      if (!$hasBudibaseIdentifiers) {
+      if (!$hasBudibaseIdentifiers && !newRow._id?.length) {
-        newRow._id = Helpers.uuid()
+        newRow._id = generateRowID()
       }
 
       if (!rowCacheMap[newRow._id]) {
@@ -674,7 +679,7 @@ export const createActions = context => {
     let clone = { ...row }
     delete clone.__idx
     delete clone.__metadata
-    if (!get(hasBudibaseIdentifiers)) {
+    if (!get(hasBudibaseIdentifiers) && isGeneratedRowID(clone._id)) {
       delete clone._id
     }
     return clone