setSearchParams should not navigate if the state is unchanged

[vezaynk]

I'd like to be able to write code like this to avoid unnecessary navigation events:

  setSearchParams((searchParams) => {
      const nextParams = computeNextParams(searchParams, nextData);
      // This should avoid the rerender, but apparently it doesn't.
      if (nextParams.toString() === searchParams.toString()) {
        // skip update due to reference
        return searchParams;
      }
      return nextParams;
    });

With this change, I should also be able to write this:

  setSearchParams((searchParams) => {
      const nextParams = computeNextParams(searchParams, nextData);
      // skip update due to value
      return nextParams;
    });

Additionally, I've made setSearchParams return a Promise to be consistent with navigate, since both are async actions.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 985ff06

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[remix-cla-bot]

Hi @vezaynk,

Welcome, and thank you for contributing to React Router!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at [email protected].

Thanks!

- The Remix team

[remix-cla-bot]

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

[timdorr]

This needs at least one test to go along with the change.

[vezaynk]

@timdorr Will the contribution be accepted with tests? I'll go you a few by the end of the day.