Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(react): improved useTimeout and added usePreservedCallback #966

Merged
merged 5 commits into from
Jun 24, 2024
Merged

fix(react): improved useTimeout and added usePreservedCallback #966

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c7808b0
feat(react): improved useTimeout and added usePreservedCallback
ssi02014 Jun 24, 2024
0ac379d
test(react): test 코드 리팩토링
ssi02014 Jun 24, 2024
89affd0
Merge branch 'main' into feat/usePreservedCallback
ssi02014 Jun 24, 2024
a4845c9
Create dull-windows-juggle.md
manudeli Jun 24, 2024
4cb88a4
Merge branch 'main' into feat/usePreservedCallback
manudeli Jun 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/dull-windows-juggle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@suspensive/react": patch
---

fix(react): improved useTimeout and added usePreservedCallback
54 changes: 54 additions & 0 deletions packages/react/src/hooks/usePreservedCallback.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
import { renderHook, waitFor } from '@testing-library/react'
import { usePreservedCallback } from './usePreservedCallback'

describe('usePreservedCallback', () => {
it('should preserve the callback function', () => {
let counter = 0

const { result, rerender } = renderHook(({ callback }) => usePreservedCallback(callback), {
initialProps: {
callback: () => counter,
},
})

expect(result.current()).toBe(0)

counter = 1
rerender({ callback: () => counter })

expect(result.current()).toBe(1)
})

it('should not recreate the callback on each render', () => {
const callback = vi.fn()
const { result, rerender } = renderHook(() => usePreservedCallback(callback))

const preservedCallback = result.current

rerender()
expect(result.current).toBe(preservedCallback)
})

it('should call the latest callback', async () => {
const callback1 = vi.fn()
const callback2 = vi.fn()

const { result, rerender } = renderHook(({ callback }) => usePreservedCallback(callback), {
initialProps: { callback: callback1 },
})

await waitFor(() => {
result.current()
})
expect(callback1).toHaveBeenCalledTimes(1)

rerender({ callback: callback2 })

await waitFor(() => {
result.current()
})

expect(callback2).toHaveBeenCalledTimes(1)
expect(callback1).toHaveBeenCalledTimes(1)
})
})
14 changes: 14 additions & 0 deletions packages/react/src/hooks/usePreservedCallback.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import { useCallback, useRef } from 'react'
import { useIsomorphicLayoutEffect } from './useIsomorphicLayoutEffect'

export const usePreservedCallback = <T extends (...args: unknown[]) => unknown>(callback: T) => {
const callbackRef = useRef<T>(callback)

useIsomorphicLayoutEffect(() => {
callbackRef.current = callback
}, [callback])

return useCallback((...args: unknown[]) => {
return callbackRef.current(...args)
}, []) as T
}
Comment on lines +1 to +14
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is slightly different from toss/slash's usePreservedCallback.

I used useIsomorphicLayoutEffect instead of useEffect, and changed the type to unknown instead of any.

19 changes: 19 additions & 0 deletions packages/react/src/hooks/useTimeout.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,25 @@ describe('useTimeout', () => {
expect(spy).toHaveBeenCalledTimes(1)
})

it('should call the modified function when the given function is changed', async () => {
const timeoutMockFn1 = vi.fn()
const timeoutMockFn2 = vi.fn()

const { rerender } = renderHook(({ fn }) => useTimeout(fn, ms('0.1s')), {
initialProps: { fn: timeoutMockFn1 },
})

rerender({ fn: timeoutMockFn2 })

expect(timeoutMockFn1).toHaveBeenCalledTimes(0)
expect(timeoutMockFn2).toHaveBeenCalledTimes(0)

await sleep(ms('0.1s'))

expect(timeoutMockFn1).toHaveBeenCalledTimes(0)
expect(timeoutMockFn2).toHaveBeenCalledTimes(1)
})
Comment on lines +19 to +36
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it's existing code, it won't call the changed function as intended, and the test will fail. 😭


it('should not re-call callback received as argument even if component using this hook is rerendered', async () => {
const TestComponent = () => {
const [number, setNumber] = useState(0)
Expand Down
14 changes: 5 additions & 9 deletions packages/react/src/hooks/useTimeout.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
import { useEffect, useRef } from 'react'
import { useIsomorphicLayoutEffect } from './useIsomorphicLayoutEffect'
import { useEffect } from 'react'
import { usePreservedCallback } from './usePreservedCallback'

export const useTimeout = (fn: () => void, ms: number) => {
const fnRef = useRef(fn)

useIsomorphicLayoutEffect(() => {
fnRef.current = fn
}, [fn])
const preservedCallback = usePreservedCallback(fn)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think Components(Delay) using useTimeout should use useCallback too.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ssi02014 I absolutely accept your opinion #966 (comment) but anyway

I think Components(Delay) using useTimeout should use useCallback too. doesn't it right?

TO-BE

import { type PropsWithChildren, type ReactNode, useContext, useState } from 'react'
import { DelayDefaultPropsContext } from './contexts'
import { useTimeout } from './hooks'
import { Message_Delay_ms_prop_should_be_greater_than_or_equal_to_0, SuspensiveError } from './models/SuspensiveError'

export interface DelayProps extends PropsWithChildren {
  ms?: number
  fallback?: ReactNode
}

export const Delay = (props: DelayProps) => {
  if (process.env.NODE_ENV === 'development') {
    if (typeof props.ms === 'number') {
      SuspensiveError.assert(props.ms >= 0, Message_Delay_ms_prop_should_be_greater_than_or_equal_to_0)
    }
  }
  const defaultProps = useContext(DelayDefaultPropsContext)
  const ms = props.ms ?? defaultProps.ms ?? 0

  const [isDelaying, setIsDelaying] = useState(ms > 0)
-  useTimeout(() => setIsDelaying(false), ms)
+  useTimeout(useCallback(() => setIsDelaying(false), []), ms)

  const fallback = typeof props.fallback === 'undefined' ? defaultProps.fallback : props.fallback
  return <>{isDelaying ? fallback : props.children}</>
}
if (process.env.NODE_ENV === 'development') {
  Delay.displayName = 'Delay'
}

Copy link
Contributor Author

@ssi02014 ssi02014 Jun 24, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@manudeli Oh no, useTimeout works the same way.
No need to change it! 👍

In usePreservedCallback, the callback is wrapped in useCallback, so there is no difference in usage.

 useTimeout(() => setIsDelaying(false), ms)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah! I understood what you mean! Thanks

useEffect(() => {
const id = setTimeout(fnRef.current, ms)
const id = setTimeout(preservedCallback, ms)
return () => clearTimeout(id)
}, [ms])
}, [preservedCallback, ms])
}
Loading