[DataGrid] Prevent commit if preProcessEditCellProps resolves with an error

[m4theushw]

Fixes #3304

Before: https://codesandbox.io/s/datagridpro-v5-quick-start-forked-pxc4e?file=/src/App.tsx

After: https://codesandbox.io/s/datagridpro-v5-quick-start-forked-rzyrl?file=/src/App.tsx

The bug happens because we don't keep a track if the validation is running or not. With singleSelect, the preProcessEditCellProps is called when the value is changed and also when commiting, which occur at the same time in this component. To fix it, we should have a flag tracking when the validation is running or not. If it's running, we don't commit the value nor call the callback again. To properly implement this, it involves changing the state which, since the state is passed to all edit components as props, could cause a warning if users spread the props directly into the DOM node without sanitizing them. Since we can't release that breaking change, I added temporarily a new prop called preventCommitWhileValidating for users to opt-in. Once it's enabled, we update the isValidating prop in the editing state before and after calling preProcessEditCellProps. During commit we check if it's validating or not. In v6 I want to make that the default behavior and remove the temp prop.

The code is very ugly. There're opportunities to refactor it but it's better to do it after #3219.

If you open the CodeSandbox above, you may notice that it only updates the Select value after preProcessEditCellProps has resolved. That's another PR.

[github-actions]

This pull request has conflicts, please resolve those before we can evaluate the pull request.

[mui-bot]

These are the results for the performance tests:

Test case	Unit	Min	Max	Median	Mean	σ
Filter 100k rows	ms	146.4	385.9	250	251.72	87.278
Sort 100k rows	ms	317.5	652.1	605.4	527.18	127.256
Select 100k rows	ms	148.7	328.8	189.2	207.02	64.055
Deselect 100k rows	ms	123.9	217	168.8	166.12	34.213

Generated by 🚫 dangerJS against 369d4f9

[flaviendelangle]

If preventCommitWhileValidating is temporary, maybe we could put it under experimentalFeatures ?
Or at least explain on the doc that we only add this strange prop temporarily to avoid any breaking change and that it will be removed on v6.

[github-actions]

This pull request has conflicts, please resolve those before we can evaluate the pull request.

[m4theushw]

If preventCommitWhileValidating is temporary, maybe we could put it under experimentalFeatures ?

@flaviendelangle I moved to experimentalFeatures. I had to make other changes to have access to this prop inside the hook. For the row grouping, you created an additional prop besides the one in experimentalFeatures.

[flaviendelangle]

@m4theushw yes for the row grouping, disableRowGrouping made sense even when the feature will be marked as stable.