Improve retention of grid metadata when updating datasources to avoid resetting state

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

@@ -152,14 +152,20 @@ export const initialise = context => {
       return
     }
     const $definition = get(definition)
+    const $columns = get(columns)
+    const $stickyColumn = get(stickyColumn)
+
+    // Generate array of all columns to easily find pre-existing columns
+    let allColumns = $columns || []
+    if ($stickyColumn) {
+      allColumns.push($stickyColumn)
+    }
 
     // Find primary display
     let primaryDisplay
-    if (
+    const candidatePD = $definition.primaryDisplay || $stickyColumn?.name
-      $definition.primaryDisplay &&
+    if (candidatePD && $enrichedSchema[candidatePD]) {
-      $enrichedSchema[$definition.primaryDisplay]
+      primaryDisplay = candidatePD
-    ) {
-      primaryDisplay = $definition.primaryDisplay
     }
 
     // Get field list
@@ -173,14 +179,18 @@ export const initialise = context => {
     // Update columns, removing extraneous columns and adding missing ones
     columns.set(
       fields
-        .map(field => ({
+        .map(field => {
-          name: field,
+          const fieldSchema = $enrichedSchema[field]
-          label: $enrichedSchema[field].displayName || field,
+          const oldColumn = allColumns?.find(x => x.name === field)
-          schema: $enrichedSchema[field],
+          return {
-          width: $enrichedSchema[field].width || DefaultColumnWidth,
+            name: field,
-          visible: $enrichedSchema[field].visible ?? true,
+            label: fieldSchema.displayName || field,
-          order: $enrichedSchema[field].order,
+            schema: fieldSchema,
-        }))
+            width: fieldSchema.width || oldColumn?.width || DefaultColumnWidth,
+            visible: fieldSchema.visible ?? true,
+            order: fieldSchema.order ?? oldColumn?.order,
+          }
+        })
         .sort((a, b) => {
           // Sort by order first
           const orderA = a.order
@@ -208,11 +218,13 @@ export const initialise = context => {
       stickyColumn.set(null)
       return
     }
+    const stickySchema = $enrichedSchema[primaryDisplay]
+    const oldStickyColumn = allColumns?.find(x => x.name === primaryDisplay)
     stickyColumn.set({
       name: primaryDisplay,
-      label: $enrichedSchema[primaryDisplay].displayName || primaryDisplay,
+      label: stickySchema.displayName || primaryDisplay,
-      schema: $enrichedSchema[primaryDisplay],
+      schema: stickySchema,
-      width: $enrichedSchema[primaryDisplay].width || DefaultColumnWidth,
+      width: stickySchema.width || oldStickyColumn?.width || DefaultColumnWidth,
       visible: true,
       order: 0,
       left: GutterWidth,