-
Notifications
You must be signed in to change notification settings - Fork 22
Chore/fix chain bug #1069
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.
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
Merged
Merged
Chore/fix chain bug #1069
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| import { act, renderHook } from '@testing-library/react' | ||
| import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest' | ||
| import useActiveChainSwitch from '../use-active-chain-switch' | ||
|
|
||
| const mocks = vi.hoisted(() => ({ | ||
| switchChain: vi.fn(), | ||
| walletChain: 56 as number | undefined, | ||
| })) | ||
|
|
||
| vi.mock('jotai', () => ({ | ||
| useAtomValue: () => mocks.walletChain, | ||
| })) | ||
|
|
||
| vi.mock('@/state/atoms', () => ({ | ||
| walletChainAtom: Symbol('walletChainAtom'), | ||
| })) | ||
|
|
||
| vi.mock('wagmi', () => ({ | ||
| useSwitchChain: () => ({ switchChain: mocks.switchChain }), | ||
| })) | ||
|
|
||
| describe('useActiveChainSwitch', () => { | ||
| let hasFocus = true | ||
| let visibilityState: DocumentVisibilityState = 'visible' | ||
|
|
||
| beforeEach(() => { | ||
| mocks.switchChain.mockReset() | ||
| mocks.walletChain = 56 | ||
| hasFocus = true | ||
| visibilityState = 'visible' | ||
| vi.spyOn(document, 'hasFocus').mockImplementation(() => hasFocus) | ||
| vi.spyOn(document, 'visibilityState', 'get').mockImplementation( | ||
| () => visibilityState | ||
| ) | ||
| }) | ||
|
|
||
| afterEach(() => { | ||
| vi.restoreAllMocks() | ||
| }) | ||
|
|
||
| it('switches to the target chain when the document is focused and visible', () => { | ||
| renderHook(() => useActiveChainSwitch(1)) | ||
|
|
||
| expect(mocks.switchChain).toHaveBeenCalledOnce() | ||
| expect(mocks.switchChain).toHaveBeenCalledWith({ chainId: 1 }) | ||
| }) | ||
|
|
||
| it('does not switch from a background tab', () => { | ||
| hasFocus = false | ||
|
|
||
| renderHook(() => useActiveChainSwitch(1)) | ||
|
|
||
| expect(mocks.switchChain).not.toHaveBeenCalled() | ||
| }) | ||
|
|
||
| it('does not switch from a hidden document that still reports focus', () => { | ||
| visibilityState = 'hidden' | ||
|
|
||
| renderHook(() => useActiveChainSwitch(1)) | ||
|
|
||
| expect(mocks.switchChain).not.toHaveBeenCalled() | ||
| }) | ||
|
|
||
| it('claims the target chain when a background tab becomes active', () => { | ||
| hasFocus = false | ||
| const { rerender } = renderHook(() => useActiveChainSwitch(1)) | ||
| expect(mocks.switchChain).not.toHaveBeenCalled() | ||
|
|
||
| hasFocus = true | ||
| act(() => { | ||
| window.dispatchEvent(new Event('focus')) | ||
| }) | ||
| rerender() | ||
|
|
||
| expect(mocks.switchChain).toHaveBeenCalledOnce() | ||
| expect(mocks.switchChain).toHaveBeenCalledWith({ chainId: 1 }) | ||
| }) | ||
|
|
||
| it('claims the target chain when a focused document becomes visible', () => { | ||
| visibilityState = 'hidden' | ||
| renderHook(() => useActiveChainSwitch(1)) | ||
| expect(mocks.switchChain).not.toHaveBeenCalled() | ||
|
|
||
| visibilityState = 'visible' | ||
| act(() => { | ||
| document.dispatchEvent(new Event('visibilitychange')) | ||
| }) | ||
|
|
||
| expect(mocks.switchChain).toHaveBeenCalledOnce() | ||
| expect(mocks.switchChain).toHaveBeenCalledWith({ chainId: 1 }) | ||
| }) | ||
|
|
||
| it('ignores wallet-chain changes after the tab moves to the background', () => { | ||
| mocks.walletChain = 1 | ||
| const { rerender } = renderHook(() => useActiveChainSwitch(1)) | ||
|
|
||
| hasFocus = false | ||
| act(() => { | ||
| window.dispatchEvent(new Event('blur')) | ||
| }) | ||
|
|
||
| mocks.walletChain = 56 | ||
| rerender() | ||
|
|
||
| expect(mocks.switchChain).not.toHaveBeenCalled() | ||
| }) | ||
|
|
||
| it('rechecks focus before switching when the cached active state is stale', () => { | ||
| mocks.walletChain = 1 | ||
| const { rerender } = renderHook(() => useActiveChainSwitch(1)) | ||
|
|
||
| hasFocus = false | ||
| mocks.walletChain = 56 | ||
| rerender() | ||
|
|
||
| expect(mocks.switchChain).not.toHaveBeenCalled() | ||
| }) | ||
|
|
||
| it('does not switch when disabled', () => { | ||
| renderHook(() => useActiveChainSwitch(1, false)) | ||
|
|
||
| expect(mocks.switchChain).not.toHaveBeenCalled() | ||
| }) | ||
| }) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| import { walletChainAtom } from '@/state/atoms' | ||
| import type { AvailableChain } from '@/utils/chains' | ||
| import { useAtomValue } from 'jotai' | ||
| import { useEffect, useState } from 'react' | ||
| import { useSwitchChain } from 'wagmi' | ||
|
|
||
| const getIsDocumentActive = () => | ||
| typeof document !== 'undefined' && | ||
| document.visibilityState === 'visible' && | ||
| document.hasFocus() | ||
|
|
||
| const useIsDocumentActive = () => { | ||
| const [isActive, setIsActive] = useState(getIsDocumentActive) | ||
|
|
||
| useEffect(() => { | ||
| const update = () => setIsActive(getIsDocumentActive()) | ||
|
|
||
| window.addEventListener('focus', update) | ||
| window.addEventListener('blur', update) | ||
| document.addEventListener('visibilitychange', update) | ||
|
|
||
| return () => { | ||
| window.removeEventListener('focus', update) | ||
| window.removeEventListener('blur', update) | ||
| document.removeEventListener('visibilitychange', update) | ||
| } | ||
| }, []) | ||
|
|
||
| return isActive | ||
| } | ||
|
|
||
| const useActiveChainSwitch = ( | ||
| targetChain: AvailableChain | undefined, | ||
| enabled = true | ||
| ) => { | ||
| const { switchChain } = useSwitchChain() | ||
| const walletChain = useAtomValue(walletChainAtom) | ||
| const isDocumentActive = useIsDocumentActive() | ||
|
|
||
| useEffect(() => { | ||
| if ( | ||
| enabled && | ||
| isDocumentActive && | ||
| getIsDocumentActive() && | ||
| targetChain && | ||
| walletChain && | ||
| targetChain !== walletChain | ||
| ) { | ||
| switchChain({ chainId: targetChain }) | ||
| } | ||
| }, [enabled, isDocumentActive, targetChain, walletChain, switchChain]) | ||
| } | ||
|
|
||
| export default useActiveChainSwitch | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.