ref: Pure internal state init function (#633)

- Follow the Rules of React to init the query ref once on mount
- Remove access to the queued value, doesn't seem to change
outcome of issue 359

Author: franky47

packages/e2e/cypress/e2e/repro-359.cy.js

@@ -11,7 +11,7 @@ it('repro-359', () => {
   cy.get('#nuqss-component').should('have.text', '')
 
   cy.contains('Component 1 (nuqs)').click()
-  cy.wait(100)
+  // cy.wait(100)
   cy.location('search').should('eq', '?param=comp1&component=comp1')
   cy.get('#comp1').should('have.text', 'comp1')
   cy.get('#comp2').should('not.exist')
@@ -21,7 +21,7 @@ it('repro-359', () => {
   cy.get('#nuqss-component').should('have.text', 'comp1')
 
   cy.contains('Component 2 (nuqs)').click()
-  cy.wait(100)
+  // cy.wait(100)
   cy.location('search').should('eq', '?param=comp2&component=comp2')
   cy.get('#comp1').should('not.exist')
   cy.get('#comp2').should('have.text', 'comp2')
@@ -31,7 +31,7 @@ it('repro-359', () => {
   cy.get('#nuqss-component').should('have.text', 'comp2')
 
   cy.contains('Component 1 (nuq+)').click()
-  cy.wait(100)
+  // cy.wait(100)
   cy.location('search').should('eq', '?param=comp1&component=comp1')
   cy.get('#comp1').should('have.text', 'comp1')
   cy.get('#comp2').should('not.exist')
@@ -41,7 +41,7 @@ it('repro-359', () => {
   cy.get('#nuqss-component').should('have.text', 'comp1')
 
   cy.contains('Component 2 (nuq+)').click()
-  cy.wait(100)
+  // cy.wait(100)
   cy.location('search').should('eq', '?param=comp2&component=comp2')
   cy.get('#comp1').should('not.exist')
   cy.get('#comp2').should('have.text', 'comp2')

packages/nuqs/src/update-queue.ts

@@ -57,10 +57,6 @@ export function enqueueQueryStringUpdate<Value>(
   return serializedOrNull
 }
 
-export function getQueuedValue(key: string) {
-  return updateQueue.get(key) ?? null
-}
-
 /**
  * Eventually flush the update queue to the URL query string.
  *

packages/nuqs/src/useQueryState.ts

@@ -7,7 +7,6 @@ import { emitter, type CrossHookSyncPayload } from './sync'
 import {
   FLUSH_RATE_LIMIT_MS,
   enqueueQueryStringUpdate,
-  getQueuedValue,
   scheduleFlushToURL
 } from './update-queue'
 import { safeParse } from './utils'
@@ -225,13 +224,12 @@ export function useQueryState<T = string>(
   const router = useRouter()
   // Not reactive, but available on the server and on page load
   const initialSearchParams = useSearchParams()
-  const queryRef = React.useRef<string | null>(null)
+  const queryRef = React.useRef<string | null>(
+    initialSearchParams?.get(key) ?? null
+  )
   const [internalState, setInternalState] = React.useState<T | null>(() => {
-    const queueValue = getQueuedValue(key)
-    const urlValue = initialSearchParams?.get(key) ?? null
-    const value = queueValue ?? urlValue
-    queryRef.current = value
-    return value === null ? null : safeParse(parse, value, key)
+    const query = initialSearchParams?.get(key) ?? null
+    return query === null ? null : safeParse(parse, query, key)
   })
   const stateRef = React.useRef(internalState)
   debug(

packages/nuqs/src/useQueryStates.ts

@@ -11,7 +11,6 @@ import { emitter, type CrossHookSyncPayload } from './sync'
 import {
   FLUSH_RATE_LIMIT_MS,
   enqueueQueryStringUpdate,
-  getQueuedValue,
   scheduleFlushToURL
 } from './update-queue'
 import { safeParse } from './utils'
@@ -94,9 +93,13 @@ export function useQueryStates<KeyMap extends UseQueryStatesKeysMap>(
   // Not reactive, but available on the server and on page load
   const initialSearchParams = useSearchParams()
   const queryRef = React.useRef<Record<string, string | null>>({})
+  // Initialise the queryRef with the initial values
+  if (Object.keys(queryRef.current).length !== Object.keys(keyMap).length) {
+    queryRef.current = Object.fromEntries(initialSearchParams?.entries() ?? [])
+  }
+
   const [internalState, setInternalState] = React.useState<V>(() => {
     const source = initialSearchParams ?? new URLSearchParams()
-    queryRef.current = Object.fromEntries(source.entries())
     return parseMap(keyMap, urlKeys, source)
   })
 
@@ -120,8 +123,7 @@ export function useQueryStates<KeyMap extends UseQueryStatesKeysMap>(
   }, [
     Object.keys(resolvedUrlKeys)
       .map(key => initialSearchParams?.get(key))
-      .join('&'),
-    stateKeys
+      .join('&')
   ])
 
   // Sync all hooks together & with external URL changes
@@ -253,9 +255,7 @@ function parseMap<KeyMap extends UseQueryStatesKeysMap>(
   return Object.keys(keyMap).reduce((obj, stateKey) => {
     const urlKey = urlKeys?.[stateKey] ?? stateKey
     const { defaultValue, parse } = keyMap[stateKey]!
-    const urlQuery = searchParams?.get(urlKey) ?? null
-    const queueQuery = getQueuedValue(urlKey)
-    const query = queueQuery ?? urlQuery
+    const query = searchParams?.get(urlKey) ?? null
     if (cachedQuery && cachedState && cachedQuery[urlKey] === query) {
       obj[stateKey as keyof KeyMap] =
         cachedState[stateKey] ?? defaultValue ?? null