From 6580796d32de0962321d2d773655b14bb00c5eb3 Mon Sep 17 00:00:00 2001 From: Benjamin Santos Date: Tue, 25 Aug 2026 16:07:29 -0400 Subject: [PATCH 1/9] fix: headers in table state to fix desync w/ rows fix: move headers to table state to prevent desync with rows a fix for issue 22714. Previously, the header props were passed directly to the table. This led to a situation where the table rendered with the new headers, but old rows (useEffect had not ran yet). Now, both headers and rows are derived from the Data Table state --- .../src/components/DataTable/DataTable.tsx | 13 +++++----- .../getDerivedStateFromProps-test.js | 25 +++++++++++++++++++ .../state/getDerivedStateFromProps.js | 1 + 3 files changed, 32 insertions(+), 7 deletions(-) diff --git a/packages/react/src/components/DataTable/DataTable.tsx b/packages/react/src/components/DataTable/DataTable.tsx index b973cd2ff85f..085d32c25db4 100644 --- a/packages/react/src/components/DataTable/DataTable.tsx +++ b/packages/react/src/components/DataTable/DataTable.tsx @@ -333,6 +333,7 @@ interface DataTableState { isExpandedAll: boolean; rowIds: string[]; rowsById: Record>; + headers: DataTableHeader[]; shouldShowBatchActions: boolean; sortDirection: DataTableSortState; sortHeaderKey: string | null; @@ -367,7 +368,6 @@ export const DataTable = ( radio, rows, } = props; - const instanceId = useMemo(() => getInstanceId(), []); const [state, setState] = useState>(() => ({ @@ -380,10 +380,10 @@ export const DataTable = ( const nextRowIds = rows.map((row) => row.id); const nextHeaders = headers.map((header) => header.key); const hasRowIdsChanged = !isEqual(nextRowIds, state.rowIds); - const currentHeaders = Array.from( - new Set(Object.keys(state.cellsById).map((id) => id.split(':')[1])) + const hasHeadersChanged = !isEqual( + nextHeaders, + state.headers.map((h) => h.key) ); - const hasHeadersChanged = !isEqual(nextHeaders, currentHeaders); const currentRows = state.rowIds.map((id) => { const row = state.rowsById[id]; return { @@ -653,7 +653,7 @@ export const DataTable = ( ? filterRows({ cellsById: state.cellsById, getCellId, - headers, + headers: state.headers, inputValue: state.filterInputValue, rowIds: state.rowIds, }) @@ -847,11 +847,10 @@ export const DataTable = ( setState((prev) => ({ ...prev, filterInputValue: value })); }; - const renderProps: RenderProps = { // Data derived from state rows: denormalize(filteredRowIds, state.rowsById, state.cellsById), - headers: headers, + headers: state.headers, selectedRows: denormalize(selectedRows, state.rowsById, state.cellsById), // Prop accessors/getters diff --git a/packages/react/src/components/DataTable/state/__tests__/getDerivedStateFromProps-test.js b/packages/react/src/components/DataTable/state/__tests__/getDerivedStateFromProps-test.js index 666ef4a7fb87..eea6d2d5ab34 100644 --- a/packages/react/src/components/DataTable/state/__tests__/getDerivedStateFromProps-test.js +++ b/packages/react/src/components/DataTable/state/__tests__/getDerivedStateFromProps-test.js @@ -33,6 +33,31 @@ describe('getDerivedStateFromProps', () => { ); }); + it('stores headers from props in state', () => { + const headers = [{ key: 'name', header: 'Name' }]; + const props = { rows: [], headers }; + const state = getDerivedStateFromProps(props, {}); + expect(state.headers).toBe(headers); + }); + + it('updates headers in state when props.headers changes', () => { + const headersA = [{ key: 'name', header: 'Name' }]; + const headersB = [ + { key: 'col1', header: 'Column 1' }, + { key: 'col2', header: 'Column 2' }, + ]; + const stateA = getDerivedStateFromProps( + { rows: [], headers: headersA }, + {} + ); + expect(stateA.headers).toBe(headersA); + const stateB = getDerivedStateFromProps( + { rows: [], headers: headersB }, + stateA + ); + expect(stateB.headers).toBe(headersB); + }); + describe('with previous state', () => { let mockProps; diff --git a/packages/react/src/components/DataTable/state/getDerivedStateFromProps.js b/packages/react/src/components/DataTable/state/getDerivedStateFromProps.js index ba750260a1c5..0f0fc75a9017 100644 --- a/packages/react/src/components/DataTable/state/getDerivedStateFromProps.js +++ b/packages/react/src/components/DataTable/state/getDerivedStateFromProps.js @@ -22,6 +22,7 @@ const getDerivedStateFromProps = (props, prevState) => { prevState ); const state = { + headers: props.headers, rowIds, rowsById, cellsById, From 19e48dabeefa646c80eb2cde9ef7130fc3f39681 Mon Sep 17 00:00:00 2001 From: Benjamin Santos Date: Tue, 25 Aug 2026 17:10:37 -0400 Subject: [PATCH 2/9] fix: revert white space changes fix: revert white space changes formatter deleted whitespace want to keep my diff clean --- packages/react/src/components/DataTable/DataTable.tsx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/react/src/components/DataTable/DataTable.tsx b/packages/react/src/components/DataTable/DataTable.tsx index 085d32c25db4..af0e9b981076 100644 --- a/packages/react/src/components/DataTable/DataTable.tsx +++ b/packages/react/src/components/DataTable/DataTable.tsx @@ -368,6 +368,7 @@ export const DataTable = ( radio, rows, } = props; + const instanceId = useMemo(() => getInstanceId(), []); const [state, setState] = useState>(() => ({ @@ -847,6 +848,7 @@ export const DataTable = ( setState((prev) => ({ ...prev, filterInputValue: value })); }; + const renderProps: RenderProps = { // Data derived from state rows: denormalize(filteredRowIds, state.rowsById, state.cellsById), From 3513cc45dec032e9d712bbcf2add6ee40451906d Mon Sep 17 00:00:00 2001 From: Benjamin Santos Date: Thu, 27 Aug 2026 13:45:00 -0400 Subject: [PATCH 3/9] fix: compare complete headers (not just keys) fix: do a deep comparison of the state vs incoming headers comparing by keys is not enough header can have same keys but slug, decorator, or label may have changed --- packages/react/src/components/DataTable/DataTable.tsx | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/packages/react/src/components/DataTable/DataTable.tsx b/packages/react/src/components/DataTable/DataTable.tsx index af0e9b981076..baff4ed0398c 100644 --- a/packages/react/src/components/DataTable/DataTable.tsx +++ b/packages/react/src/components/DataTable/DataTable.tsx @@ -379,12 +379,8 @@ export const DataTable = ( useEffect(() => { const nextRowIds = rows.map((row) => row.id); - const nextHeaders = headers.map((header) => header.key); const hasRowIdsChanged = !isEqual(nextRowIds, state.rowIds); - const hasHeadersChanged = !isEqual( - nextHeaders, - state.headers.map((h) => h.key) - ); + const hasHeadersChanged = !isEqual(headers, state.headers); const currentRows = state.rowIds.map((id) => { const row = state.rowsById[id]; return { From 116212e7b2d6e91f66b4220b5cbc6ec351dab539 Mon Sep 17 00:00:00 2001 From: Benjamin Santos Date: Mon, 31 Aug 2026 10:20:10 -0400 Subject: [PATCH 4/9] fix: use copy of headers for data table state fix: use copy of headers for data table state to avoid desync between cellsById and header keys when filtering --- .../state/__tests__/getDerivedStateFromProps-test.js | 6 +++--- .../components/DataTable/state/getDerivedStateFromProps.js | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/react/src/components/DataTable/state/__tests__/getDerivedStateFromProps-test.js b/packages/react/src/components/DataTable/state/__tests__/getDerivedStateFromProps-test.js index eea6d2d5ab34..90050b7b73e2 100644 --- a/packages/react/src/components/DataTable/state/__tests__/getDerivedStateFromProps-test.js +++ b/packages/react/src/components/DataTable/state/__tests__/getDerivedStateFromProps-test.js @@ -37,7 +37,7 @@ describe('getDerivedStateFromProps', () => { const headers = [{ key: 'name', header: 'Name' }]; const props = { rows: [], headers }; const state = getDerivedStateFromProps(props, {}); - expect(state.headers).toBe(headers); + expect(state.headers).toEqual(headers); }); it('updates headers in state when props.headers changes', () => { @@ -50,12 +50,12 @@ describe('getDerivedStateFromProps', () => { { rows: [], headers: headersA }, {} ); - expect(stateA.headers).toBe(headersA); + expect(stateA.headers).toEqual(headersA); const stateB = getDerivedStateFromProps( { rows: [], headers: headersB }, stateA ); - expect(stateB.headers).toBe(headersB); + expect(stateB.headers).toEqual(headersB); }); describe('with previous state', () => { diff --git a/packages/react/src/components/DataTable/state/getDerivedStateFromProps.js b/packages/react/src/components/DataTable/state/getDerivedStateFromProps.js index 0f0fc75a9017..330210b9d07b 100644 --- a/packages/react/src/components/DataTable/state/getDerivedStateFromProps.js +++ b/packages/react/src/components/DataTable/state/getDerivedStateFromProps.js @@ -22,7 +22,7 @@ const getDerivedStateFromProps = (props, prevState) => { prevState ); const state = { - headers: props.headers, + headers: props.headers.slice(), rowIds, rowsById, cellsById, From 30e3f67f7fb59f3a5a770002cd5d871c64662689 Mon Sep 17 00:00:00 2001 From: Benjamin Santos Date: Mon, 31 Aug 2026 16:47:37 -0400 Subject: [PATCH 5/9] fix: create new headers elements for states, better test coverage fix: create new headers elements for states, better test coverage --- .../state/__tests__/getDerivedStateFromProps-test.js | 12 ++++++++++++ .../DataTable/state/getDerivedStateFromProps.js | 2 +- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/packages/react/src/components/DataTable/state/__tests__/getDerivedStateFromProps-test.js b/packages/react/src/components/DataTable/state/__tests__/getDerivedStateFromProps-test.js index 90050b7b73e2..e2293492f00a 100644 --- a/packages/react/src/components/DataTable/state/__tests__/getDerivedStateFromProps-test.js +++ b/packages/react/src/components/DataTable/state/__tests__/getDerivedStateFromProps-test.js @@ -58,6 +58,18 @@ describe('getDerivedStateFromProps', () => { expect(stateB.headers).toEqual(headersB); }); + it('should not update headers in state when props.headers is mutated in-place', () => { + const headersA = [{ key: 'name', header: 'Name' }]; + const stateA = getDerivedStateFromProps( + { rows: [], headers: headersA }, + {} + ); + expect(stateA.headers).not.toBe(headersA); + expect(stateA.headers[0]).not.toBe(headersA[0]); + headersA[0].key = 'newKey'; + expect(stateA.headers[0].key).toEqual('name'); + }); + describe('with previous state', () => { let mockProps; diff --git a/packages/react/src/components/DataTable/state/getDerivedStateFromProps.js b/packages/react/src/components/DataTable/state/getDerivedStateFromProps.js index 330210b9d07b..e071ef4adc58 100644 --- a/packages/react/src/components/DataTable/state/getDerivedStateFromProps.js +++ b/packages/react/src/components/DataTable/state/getDerivedStateFromProps.js @@ -22,7 +22,7 @@ const getDerivedStateFromProps = (props, prevState) => { prevState ); const state = { - headers: props.headers.slice(), + headers: props.headers.map((header) => ({ ...header })), rowIds, rowsById, cellsById, From b07d255e9579bdf4cc7eaf69cf7b04bd71526912 Mon Sep 17 00:00:00 2001 From: Benjamin Santos Date: Tue, 27 Oct 2026 09:43:33 -0400 Subject: [PATCH 6/9] Update getDerivedStateFromProps-test.js --- .../DataTable/state/__tests__/getDerivedStateFromProps-test.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/react/src/components/DataTable/state/__tests__/getDerivedStateFromProps-test.js b/packages/react/src/components/DataTable/state/__tests__/getDerivedStateFromProps-test.js index e2293492f00a..4d9d3a30d597 100644 --- a/packages/react/src/components/DataTable/state/__tests__/getDerivedStateFromProps-test.js +++ b/packages/react/src/components/DataTable/state/__tests__/getDerivedStateFromProps-test.js @@ -58,7 +58,7 @@ describe('getDerivedStateFromProps', () => { expect(stateB.headers).toEqual(headersB); }); - it('should not update headers in state when props.headers is mutated in-place', () => { + it('should copy headers so that prop mutations do not affect already-derived state', () => { const headersA = [{ key: 'name', header: 'Name' }]; const stateA = getDerivedStateFromProps( { rows: [], headers: headersA }, From a11b94cd391c0d9b90404437497ae868c65d2601 Mon Sep 17 00:00:00 2001 From: Benjamin Santos Date: Tue, 3 Nov 2026 16:26:32 -0500 Subject: [PATCH 7/9] fix: add coverage for updated derived props via mutation --- .../state/__tests__/getDerivedStateFromProps-test.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/packages/react/src/components/DataTable/state/__tests__/getDerivedStateFromProps-test.js b/packages/react/src/components/DataTable/state/__tests__/getDerivedStateFromProps-test.js index f2fd7d9c4036..0065dda05131 100644 --- a/packages/react/src/components/DataTable/state/__tests__/getDerivedStateFromProps-test.js +++ b/packages/react/src/components/DataTable/state/__tests__/getDerivedStateFromProps-test.js @@ -68,6 +68,11 @@ describe('getDerivedStateFromProps', () => { expect(stateA.headers[0]).not.toBe(headersA[0]); headersA[0].key = 'newKey'; expect(stateA.headers[0].key).toEqual('name'); + const stateB = getDerivedStateFromProps( + { rows: [], headers: headersA }, + stateA + ); + expect(stateB.headers[0].key).toEqual('newKey'); }); describe('with previous state', () => { From 3b8c8619f612a62c747508370787ec08a96015c5 Mon Sep 17 00:00:00 2001 From: Benjamin Santos Date: Thu, 5 Nov 2026 11:27:54 -0500 Subject: [PATCH 8/9] chore: verify DataTable render props use same header/row versions chore: verify DataTable render props use same header/row versions --- .../DataTable/__tests__/DataTable-test.js | 77 +++++++++++++++++++ 1 file changed, 77 insertions(+) diff --git a/packages/react/src/components/DataTable/__tests__/DataTable-test.js b/packages/react/src/components/DataTable/__tests__/DataTable-test.js index bb7964de4003..9c474a3b73e0 100644 --- a/packages/react/src/components/DataTable/__tests__/DataTable-test.js +++ b/packages/react/src/components/DataTable/__tests__/DataTable-test.js @@ -1206,6 +1206,83 @@ describe('DataTable', () => { 'Field 3:A!', ]); }); + + it('should never use mismatched headers and rows for render props while syncing new props', () => { + const childrenSpy = jest.fn(() => null); + const initialHeaders = [ + { key: 'fieldA', header: 'Field A' }, + { key: 'fieldB', header: 'Field B' }, + ]; + const initialRows = [ + { id: 'a', fieldA: 'A:1', fieldB: 'B:1' }, + { id: 'b', fieldA: 'A:2', fieldB: 'B:2' }, + ]; + const nextHeaders = [ + { key: 'fieldB', header: 'Field B' }, + { key: 'fieldC', header: 'Field C' }, + ]; + const nextRows = [ + { id: 'a', fieldB: 'B:1', fieldC: 'C:1' }, + { id: 'b', fieldB: 'B:2', fieldC: 'C:2' }, + { id: 'c', fieldB: 'B:3', fieldC: 'C:3' }, + ]; + + const { rerender } = render( + + {childrenSpy} + + ); + + // Every render must use headers and rows from the same version: + // each row has exactly one cell per header, in header order. + const expectCellsToMatchHeaders = ({ headers, rows }) => { + const headerKeys = headers.map((header) => header.key); + rows.forEach((row) => { + expect(row.cells.map((cell) => cell.info.header)).toEqual( + headerKeys + ); + }); + }; + + childrenSpy.mock.calls.forEach(([renderProps]) => + expectCellsToMatchHeaders(renderProps) + ); + childrenSpy.mockClear(); + + rerender( + + {childrenSpy} + + ); + + const calls = childrenSpy.mock.calls.map( + ([renderProps]) => renderProps + ); + + // The render that happens before the sync effect still exposes the + // previous version of both headers and rows. + expect(calls.length).toBeGreaterThan(1); + expect(calls[0].headers.map((header) => header.key)).toEqual([ + 'fieldA', + 'fieldB', + ]); + expect(calls[0].rows.map((row) => row.id)).toEqual(['a', 'b']); + + calls.forEach(expectCellsToMatchHeaders); + + // The render that happens after the sync effect still uses the + // new versions of both headers and rows. + const lastCall = calls[1]; + expect(lastCall.headers.map((header) => header.key)).toEqual([ + 'fieldB', + 'fieldC', + ]); + expect(lastCall.rows.map((row) => row.id)).toEqual(['a', 'b', 'c']); + expect(lastCall.rows[2].cells.map((cell) => cell.value)).toEqual([ + 'B:3', + 'C:3', + ]); + }); }); describe('row click behavior', () => { From db902f9195ec8e58f22f6ac0904a2262e5904e92 Mon Sep 17 00:00:00 2001 From: benjamin-t-santos <115251181+benjamin-t-santos@users.noreply.github.com> Date: Thu, 5 Nov 2026 12:02:09 -0500 Subject: [PATCH 9/9] fix: use length for last call Co-authored-by: Adam Alston --- .../react/src/components/DataTable/__tests__/DataTable-test.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/react/src/components/DataTable/__tests__/DataTable-test.js b/packages/react/src/components/DataTable/__tests__/DataTable-test.js index 9c474a3b73e0..05a257e42144 100644 --- a/packages/react/src/components/DataTable/__tests__/DataTable-test.js +++ b/packages/react/src/components/DataTable/__tests__/DataTable-test.js @@ -1272,7 +1272,7 @@ describe('DataTable', () => { // The render that happens after the sync effect still uses the // new versions of both headers and rows. - const lastCall = calls[1]; + const lastCall = calls[calls.length - 1]; expect(lastCall.headers.map((header) => header.key)).toEqual([ 'fieldB', 'fieldC',