[useAutocomplete] Improve isOptionEqualToValue value argument type

[newsiberian]

I've noticed that isOptionEqualToValue doesn't take into account that value could be a string (freeSolo mode)

• I have followed (at least) the PR section of the contributing guide.

Fixes #38322

[mui-bot]

Netlify deploy preview

https://deploy-preview-37291--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against b782406

[michaldudak]

Is there an issue you ran into because of this? IIRC, the isOptionEqualToValue is called with the actually selected value, not the input text.

[newsiberian]

@michaldudak , yes, this is my issue (with freeSolo)

[ZeeshanTamboli]

@newsiberian Could you please provide a CodeSandbox reproducing the issue? The issue template is a good starting point.

[michaldudak]

There is an issue created independently that describes the problem: #38322

@newsiberian Your solution seems to be correct. Please rebase this PR on the latest master and make sure the checks pass.

[ZeeshanTamboli]

The changes make sense, but it will be a breaking change for apps using Autocomplete with both freeSolo and this prop. TypeScript will throw a compile error now, and users will need to update the value parameter in isOptionEqualToValue using type narrowing. Here's an example:

<Autocomplete
  freeSolo
  options={options}
  getOptionLabel={(option) => (typeof option === 'string' ? option : option.book.name)}
  isOptionEqualToValue={(option, value) =>
    option.book.id === (typeof value !== 'string' ? value.book.id : value)
  }
  renderInput={(params) => <TextField {...params} label="book" />}
/>;

Yes it throws a runtime error as mentioned in #38322 but they might be using optional chaining to fix the runtime error.

[DiegoAndai]

I agree with @ZeeshanTamboli in that this is a breaking change that should be released in a major version. Given that the solution is ready, we could target this for v6.

[newsiberian]

@ZeeshanTamboli , all set. tests were fine

[ZeeshanTamboli]

@newsiberian Can you fix the CI?

[DiegoAndai]

Hey again! After discussing with members of the core team, I confirm that we won't release this in v5. The breaking change is to fix a bug, but it's a breaking change nonetheless. I'm really sorry 😓.

The good news is that we plan to start working on v6 very soon, so we could have this in early alpha releases, with the stable release planned for Q2 2024. We also plan to have more frequent major releases so we don't have to hold bug fixes that require breaking changes like this for too long in the future.