Merge branch 'main' into docs/codeline-highlight

.changeset/rare-chefs-behave.md

@@ -0,0 +1,5 @@
+---
+"@suspensive/react": patch
+---
+
+perf(react): remove unnecessary useSetTimeout's callback calling

configs/test-utils/src/ThrowError.tsx

@@ -1,11 +1,21 @@
 import type { PropsWithChildren } from 'react'
-import { useEffect, useState } from 'react'
+import { useEffect, useLayoutEffect, useRef, useState } from 'react'
+
+const isClient = typeof window !== 'undefined'
+export const useIsomorphicLayoutEffect = isClient ? useLayoutEffect : useEffect
+
+export const useTimeout = (fn: () => void, ms: number) => {
+  const fnRef = useRef(fn)
+
+  useIsomorphicLayoutEffect(() => {
+    fnRef.current = fn
+  }, [fn])
 
-const useSetTimeout = (fn: (...args: []) => void, delay: number) =>
   useEffect(() => {
-    const timeout = setTimeout(fn, delay)
-    return () => clearTimeout(timeout)
-  }, [fn, delay])
+    const id = setTimeout(fnRef.current, ms)
+    return () => clearTimeout(id)
+  }, [ms])
+}
 
 const throwErrorIsNeed = { current: false }
 type ThrowErrorProps = PropsWithChildren<{ message: string; after?: number }>
@@ -14,7 +24,7 @@ export const ThrowError = ({ message, after = 0, children }: ThrowErrorProps) =>
   if (isNeedError) {
     throw new Error(message)
   }
-  useSetTimeout(() => setIsNeedError(true), after)
+  useTimeout(() => setIsNeedError(true), after)
   return <>{children}</>
 }
 
@@ -24,7 +34,7 @@ export const ThrowNull = ({ after, children }: ThrowNullProps) => {
   if (isNeedError) {
     throw null
   }
-  useSetTimeout(() => setIsNeedError(true), after)
+  useTimeout(() => setIsNeedError(true), after)
   return <>{children}</>
 }
 

packages/react/src/Delay.tsx

@@ -1,6 +1,6 @@
 import type { ComponentProps, ComponentType, PropsWithChildren } from 'react'
 import { createContext, useContext, useState } from 'react'
-import { useSetTimeout } from './hooks'
+import { useTimeout } from './hooks'
 import type { PropsWithoutChildren } from './types'
 
 export type DelayProps = PropsWithChildren<{
@@ -11,7 +11,7 @@ export const Delay = ({ ms, children }: DelayProps) => {
   const delayContextValue = useContext(DelayContext)
   const delayMs = ms ?? delayContextValue.ms ?? 0
   const [isDelayed, setIsDelayed] = useState(delayMs === 0)
-  useSetTimeout(() => setIsDelayed(true), delayMs)
+  useTimeout(() => setIsDelayed(true), delayMs)
   return <>{isDelayed ? children : null}</>
 }
 

packages/react/src/ErrorBoundary.spec.tsx

@@ -4,7 +4,7 @@ import type { ComponentProps, ComponentRef } from 'react'
 import { createElement, createRef } from 'react'
 import { createRoot } from 'react-dom/client'
 import { vi } from 'vitest'
-import { useSetTimeout } from './hooks'
+import { useTimeout } from './hooks'
 import { assert } from './utils'
 import { ErrorBoundary, useErrorBoundary, useErrorBoundaryFallbackProps, withErrorBoundary } from '.'
 
@@ -257,12 +257,12 @@ describe('useErrorBoundary', () => {
       onError,
       fallback: function ErrorBoundaryFallback() {
         const props = useErrorBoundaryFallbackProps()
-        useSetTimeout(props.reset, MS_100)
+        useTimeout(props.reset, MS_100)
         return <>{props.error.message}</>
       },
       children: createElement(() => {
         const errorBoundary = useErrorBoundary()
-        useSetTimeout(() => errorBoundary.setError(new Error(ERROR_MESSAGE)), MS_100)
+        useTimeout(() => errorBoundary.setError(new Error(ERROR_MESSAGE)), MS_100)
         return <>{TEXT}</>
       }),
     })
@@ -320,7 +320,7 @@ describe('useErrorBoundaryFallbackProps', () => {
       onReset,
       fallback: function ErrorBoundaryFallback() {
         const props = useErrorBoundaryFallbackProps()
-        useSetTimeout(props.reset, MS_100)
+        useTimeout(props.reset, MS_100)
 
         return <>{props.error.message}</>
       },

packages/react/src/hooks/index.ts

@@ -3,4 +3,4 @@ export { useIsClient } from './useIsClient'
 export { useIsomorphicLayoutEffect } from './useIsomorphicLayoutEffect'
 export { useKey } from './useKey'
 export { usePrevious } from './usePrevious'
-export { useSetTimeout } from './useSetTimeout'
+export { useTimeout } from './useTimeout'

packages/react/src/hooks/useSetTimeout.spec.ts → packages/react/src/hooks/useTimeout.spec.ts

@@ -1,14 +1,14 @@
 import { MS_100 } from '@suspensive/test-utils'
 import { act, renderHook } from '@testing-library/react'
 import { describe, expect, it, vi } from 'vitest'
-import { useSetTimeout } from '.'
+import { useTimeout } from '.'
 
 vi.useFakeTimers()
 
-describe('useSetTimeout', () => {
+describe('useTimeout', () => {
   it('should run given function once after given timeout', () => {
     const fn = vi.fn()
-    const rendered = renderHook(() => useSetTimeout(fn, MS_100))
+    const rendered = renderHook(() => useTimeout(fn, MS_100))
     expect(fn).toHaveBeenCalledTimes(0)
     act(() => vi.advanceTimersByTime(MS_100))
     expect(fn).toHaveBeenCalledTimes(1)

packages/react/src/hooks/useTimeout.ts

@@ -0,0 +1,15 @@
+import { useEffect, useRef } from 'react'
+import { useIsomorphicLayoutEffect } from './useIsomorphicLayoutEffect'
+
+export const useTimeout = (fn: () => void, ms: number) => {
+  const fnRef = useRef(fn)
+
+  useIsomorphicLayoutEffect(() => {
+    fnRef.current = fn
+  }, [fn])
+
+  useEffect(() => {
+    const id = setTimeout(fnRef.current, ms)
+    return () => clearTimeout(id)
+  }, [ms])
+}