From ca9340ddbbf5dcb9cfdbe2744a54b02cd31e8d31 Mon Sep 17 00:00:00 2001
From: "Ghislain B." <gbeaulac@gmail.com>
Date: Sat, 14 Dec 2024 16:03:17 -0500
Subject: [PATCH] fix: add missing collection observer to watch changes (#443)

---
 src/examples/slickgrid/Example3.tsx           |  1 -
 .../components/slickgrid-react.tsx            | 24 ++++++++++++++++---
 2 files changed, 21 insertions(+), 4 deletions(-)

diff --git a/src/examples/slickgrid/Example3.tsx b/src/examples/slickgrid/Example3.tsx
index 5fea67f..1b0caa9 100644
--- a/src/examples/slickgrid/Example3.tsx
+++ b/src/examples/slickgrid/Example3.tsx
@@ -634,7 +634,6 @@ export default function Example3() {
 
     /*
     // remove your column the full set of columns
-    // and use slice or spread [...] to trigger an React dirty change
     allOriginalColumns.pop();
     columnDefinitions = allOriginalColumns.slice();
     */
diff --git a/src/slickgrid-react/components/slickgrid-react.tsx b/src/slickgrid-react/components/slickgrid-react.tsx
index 30c3c35..ff75de1 100644
--- a/src/slickgrid-react/components/slickgrid-react.tsx
+++ b/src/slickgrid-react/components/slickgrid-react.tsx
@@ -22,6 +22,7 @@ import {
 
   // services
   BackendUtilityService,
+  collectionObserver,
   CollectionService,
   EventNamingStyle,
   ExtensionService,
@@ -97,6 +98,7 @@ export class SlickgridReact<TData = any> extends React.Component<SlickgridReactP
   protected _currentDatasetLength = 0;
   protected _dataset: any[] | null = null;
   protected _elm?: HTMLDivElement | null;
+  protected _collectionObservers: Array<null | ({ disconnect: () => void; })> = [];
   protected _eventHandler!: SlickEventHandler;
   protected _eventPubSubService!: EventPubSubService;
   protected _hideHeaderRowAfterPageLoad = false;
@@ -602,6 +604,9 @@ export class SlickgridReact<TData = any> extends React.Component<SlickgridReactP
     this.instances = reactElementInstance;
     this.setStateValue('instances', reactElementInstance);
     this._eventPubSubService.publish(`onReactGridCreated`, reactElementInstance);
+
+    // subscribe to column definitions assignment changes
+    this.observeColumnDefinitions();
   }
 
   componentWillUnmount(shouldEmptyDomElementContainer = false) {
@@ -614,6 +619,7 @@ export class SlickgridReact<TData = any> extends React.Component<SlickgridReactP
       this.emptyGridContainerElm();
     }
 
+    this._collectionObservers.forEach(obs => obs?.disconnect());
     this._eventPubSubService.publish(`onAfterGridDestroyed`, true);
 
     // dispose of all Services
@@ -696,7 +702,7 @@ export class SlickgridReact<TData = any> extends React.Component<SlickgridReactP
 
     if (this.props.columnDefinitions !== prevProps.columnDefinitions) {
       this._columnDefinitions = this.props.columnDefinitions;
-      this.columnDefinitionsChanged();
+      this.columnDefinitionsChanged(this.props.columnDefinitions);
     }
 
     if (this.props.dataset !== prevProps.dataset) {
@@ -709,8 +715,10 @@ export class SlickgridReact<TData = any> extends React.Component<SlickgridReactP
     this.suggestDateParsingWhenHelpful();
   }
 
-  columnDefinitionsChanged() {
-    this._columnDefinitions = this.props.columnDefinitions;
+  columnDefinitionsChanged(columnDefinitions?: Column[]) {
+    if (columnDefinitions) {
+      this._columnDefinitions = columnDefinitions;
+    }
     if (this._isGridInitialized) {
       this.updateColumnDefinitionsList(this._columnDefinitions);
     }
@@ -1176,6 +1184,16 @@ export class SlickgridReact<TData = any> extends React.Component<SlickgridReactP
   // protected functions
   // ------------------
 
+  /**
+   * assignment changes are not triggering on the column definitions, for that
+   * we can use our internal array observer for any changes done via (push, pop, shift, ...)
+   */
+  protected observeColumnDefinitions(): void {
+    this._collectionObservers.push(
+      collectionObserver(this._columnDefinitions, this.columnDefinitionsChanged.bind(this))
+    );
+  }
+
   /**
    * Loop through all column definitions and copy the original optional `width` properties optionally provided by the user.
    * We will use this when doing a resize by cell content, if user provided a `width` it won't override it.