TanStack / table

🤖 Headless UI for building powerful tables & datagrids for TS/JS - React-Table, Vue-Table, Solid-Table, Svelte-Table
https://tanstack.com/table
MIT License
25.02k stars 3.07k forks source link

`getValue` cache not invalidating when `accessorFn` is updated #5363

Open danny-does-stuff opened 7 months ago

danny-does-stuff commented 7 months ago

TanStack Table version

v8.12.0

Framework/Library version

React v18.2.0

Describe the bug and the steps to reproduce it

When the accessorFn for a column is updated to return a new value, the new value is never displayed in the table. Through a sophisticated series of console.logs, I discovered that when getValue is called on the rerender, the new accessorFn is never called, presumably due to caching on column id.

The use case is a column that displays the name of the person for the current row. We want the user to be able to choose whether to display first or last name first (e.g. Tanner Linsley or Linsley, Tanner). We could just change the column id when the accessorFn is updated, but then we lose the current sort state for that column, ie if the table is currently sorted by name, we want to stay sorted by name after the name format is changed.

Steps to reproduce:

  1. Define a column where the accessorFn returns a different value based on some piece of state
  2. Update that piece of state
  3. The values in the column don't change

Your Minimal, Reproducible Example - (Sandbox Highly Recommended)

https://stackblitz.com/edit/tanstack-table-rnjqkx?file=src%2Fmain.tsx

Screenshots or Videos (Optional)

No response

Do you intend to try to help solve this bug with your own PR?

No, because I do not know how

Terms & Code of Conduct

badench commented 6 months ago

Any updates on this? I'm seeing the same issue where a piece of state changes the value returned by the accessorFn but the new value isn't being shown in the table

takoshi commented 4 months ago

I found the same issue on my project. I suspect that the following code causes it

https://github.com/TanStack/table/blob/6d89e41533324d62eb17922e49007b4c082609e5/packages/table-core/src/core/row.ts#L113-L129

https://github.com/TanStack/table/blob/6d89e41533324d62eb17922e49007b4c082609e5/packages/table-core/src/utils/getCoreRowModel.ts#L9-L48

Summary

I think there are some ways to fix the bug.

andbjer commented 3 weeks ago

We had the same issue in our project. The suggested fix in #5582 fixes the issue for us. We've applied the fix with yarn patch until it is merged and released.