fix(useRouteHash,useRouteQuery,useRouteParams): re-evaluates the value immediately

[anteriovieira]

Before submitting the PR, please make sure you do the following

• Read the Contributing Guidelines.
• Read the Pull Request Guidelines.
• Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
• Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
• Ideally, include relevant tests that fail without this PR but pass with it.

⚠️ Slowing down new functions

Warning: Slowing down new functions

As the VueUse audience continues to grow, we have been inundated with an overwhelming number of feature requests and pull requests. As a result, maintaining the project has become increasingly challenging and has stretched our capacity to its limits. As such, in the near future, we may need to slow down our acceptance of new features and prioritize the stability and quality of existing functions. Please note that new features for VueUse may not be accepted at this time. If you have any new ideas, we suggest that you first incorporate them into your own codebase, iterate on them to suit your needs and assess their generalizability. If you strongly believe that your ideas are beneficial to the community, you may submit a pull request along with your use cases, and we would be happy to review and discuss them. Thank you for your understanding.

---

Description

It will re-evaluate the value immediately.

Additional context

By default, Vue.js caches the result of a computed property and only re-evaluates it if one of its dependencies has changed. But currently, it seems that it is not updating or getting the correct value on the same tick. These updates will force a re-evaluation after the value has been updated.

Example:

import { useRouteQuery } from '@vueuse/router'

const page = useRouteQuery('page', 1)
const userId = useRouteQuery('user')

const fetch = () => {
   // ... send page and userId as parameters.
}

const searchByUserId(id) {
   page.value = 1
   userId.value = id
   
   fetch()
}

live code

🤖 Generated by Copilot at a4035ad

This pull request refactors and improves the router composables useRouteHash, useRouteParams, and useRouteQuery, by enhancing their reactivity, consistency, and type support. It also adds or updates the corresponding test files to verify their functionality and behavior. Additionally, it renames the RouterQueryValue type to RouteDefaultValue to avoid confusion.

🤖 Generated by Copilot at a4035ad

• Rename RouterQueryValue type to RouteDefaultValue to avoid confusion (link, link, link, link, link)
• Move route-related composables from individual files to _types.ts for consistency (link, link, link)
• Refactor useRouteHash, useRouteParams, and useRouteQuery to use local refs instead of directly modifying the route object, to improve reactivity and avoid side effects (link, link, link)
• Add test file for useRouteHash composable, with two test cases to check the initial and updated values of the hash (link)
• Update test file for useRouteParams composable, to import Ref type, add params argument to getRoute helper, and add two test cases to check the initial and updated values of the param (link, link, link, link)
• Update test file for useRouteQuery composable, to import Ref type, simplify getRoute helper, and add a test case to check the updated value of the query (link, link, link, link)

[antfu]

I think it was on purpose to collect all changes from multiple sources and avoid conflicts

[anteriovieira]

I think it was on purpose to collect all changes from multiple sources and avoid conflicts

History: #901 -> #2646 -> commit

You are right, and I followed those adjustments and worked to not break the tests. But apparently, the tests are not consistent. After your comment, I reviewed the entire code again and did some more tests, and realized that there is a break. I am working on the correction and will send it soon with more tests.

Thank you.

[anteriovieira]

@antfu, the latest updates ensure that the route is updated with multiple sources and add more tests. You can see the code working here.

Check how the current version is working here. As you can see, the current variable value doesn't change correctly even using nextTick.

[antfu]

Thanks for the explaination! I left some concern here.

[anteriovieira]

Working on multiple scope example

[lishaobos]

@anteriovieira i have some questions.

Firstly, this PR is causing some errors: #3173

In my understanding, if we need an immediate value and a reactive value, we can do it like this:

let isChanging = false

const ref = computed<any>({
    get() {
      const val = route.query[name]
      const newVal = _query.get(name)
      const data = (isChanging ? newVal : val) ?? defaultValue
      return transform(data as T)
    },
    set(v) {
      isChanging = true
      _query.set(name, (v === defaultValue || v === null) ? undefined : v)

      nextTick(async () => {
        await router[toValue(mode)]({
          ...route,
          query: { ...route.query, ...Object.fromEntries(_query.entries()) },
        })
        isChanging = false
      })
    },
  })

but, they do not work with scope.stop() because computed is cleaned up and cannot trigger the getter. Maybe we can change the unit test?

[anteriovieira]

Hi @lishaobos , thanks! I'm going to investigate it.

[lishaobos]

Hi @lishaobos , thanks! I'm going to investigate it.

😊，i have another idea, they can pass unit test

watch(() => route.query[name], (v) => {
    _query.set(name, (v === defaultValue || v === null) ? undefined : v)
    _trigger?.()
  }, {
    flush: 'sync',
    immediate: true,
  })

  return customRef<any>((track, trigger) => {
    _trigger = trigger
    return {
      get() {
        track()

        const data = _query.get(name) ?? defaultValue
        return transform(data as T)
      },
      set(v) {
        _query.set(name, (v === defaultValue || v === null) ? undefined : v)

        trigger()

        nextTick(() => {
          router[toValue(mode)]({
            ...route,
            query: { ...route.query, ...Object.fromEntries(_query.entries()) },
          })
        })
      },
    }
  })

[anteriovieira]

Hi @lishaobos , thanks! You had a good solution for that. Sorry for the delay.