[data grid] using treeData and onRowSelectionModelChange with controlled rowSelectionModel causing infinite render loop

[annawatson-wk]

Steps to reproduce

Link to live example: (required)

Steps:

1. Click the row selection checkbox on Sarah, Thomas, or Mary

Here's a video of the behavior:
https://github.com/user-attachments/assets/253ec8c4-b2ed-4154-a3af-4c5d59bea555

Current behavior

In the case when we're using treeData and onRowSelectionModelChange with controlled rowSelectionModel - the selected row toggles between selected and unselected when the row selection checkbox is used.

Expected behavior

In the case when we're using treeData and onRowSelectionModelChange with controlled rowSelectionModel - the selected row reflects it's selected state when remains selected when using the row selection checkbox.

Context

When you click a row to select row selection, the component goes into an infinite loop of calling onRowSelectionModelChange. The first time it calls it, it contains the id of the row you just selected and then it is called again with an empty list in the case of this example, causing the flashing behavior. In general, onRowSelectionModelChange gets called again with whatever the rowSelectionModel was before the click occurred. For example, if there's an initially selected row when it first mounts - it will go back to that.

It appears as though this issue was introduced in 7.19.0.

I'm not sure if it's related to other onRowSelectionModelChange open issues. This could potentially be related: #14859

Your environment

npx @mui/envinfo

System:
    OS: macOS 13.6.2
  Binaries:
    Node: 20.8.1 - ~/.asdf/installs/nodejs/20.8.1/bin/node
    npm: 10.1.0 - ~/.asdf/plugins/nodejs/shims/npm
    pnpm: Not Found
  Browsers:
    Chrome: 130.0.6723.71
    Edge: Not Found
    Safari: 17.1

Search keywords: data grid premium pro treeData onRowSelectionModelChange rowSelectionModel rowSelection
Order ID: 82849

[github-actions]

This issue has been closed. If you have a similar problem but not exactly the same, please open a new issue.
Now, if you have additional information related to this issue or things that could help future readers, feel free to leave a comment.

Note

@annawatson-wk How did we do? Your experience with our support team matters to us. If you have a moment, please share your thoughts in this short Support Satisfaction survey.