-
Notifications
You must be signed in to change notification settings - Fork 67
fix & test: usePostMessage #427
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,130 @@ | ||||||||||||||||||||||
| import { act, renderHook } from '@testing-library/react'; | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| import { createTrigger, renderHookServer } from '@/tests'; | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| import { usePostMessage } from './usePostMessage'; | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| const trigger = createTrigger<string, (event: Event) => void>(); | ||||||||||||||||||||||
| const mockPostMessage = vi.fn(); | ||||||||||||||||||||||
| const mockAddEventListener = vi.fn(); | ||||||||||||||||||||||
| const mockRemoveEventListener = vi.fn(); | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| beforeEach(() => { | ||||||||||||||||||||||
| vi.clearAllMocks(); | ||||||||||||||||||||||
| trigger.clear(); | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Object.assign(window, { | ||||||||||||||||||||||
| postMessage: mockPostMessage, | ||||||||||||||||||||||
| addEventListener: (type: string, callback: (event: Event) => void) => { | ||||||||||||||||||||||
| mockAddEventListener(type, callback); | ||||||||||||||||||||||
| trigger.add(type, callback); | ||||||||||||||||||||||
| }, | ||||||||||||||||||||||
| removeEventListener: (type: string, callback: (event: Event) => void) => { | ||||||||||||||||||||||
| mockRemoveEventListener(type, callback); | ||||||||||||||||||||||
| if (trigger.get(type) === callback) trigger.delete(type); | ||||||||||||||||||||||
| }, | ||||||||||||||||||||||
| dispatchEvent: (event: Event) => { | ||||||||||||||||||||||
| trigger.callback(event.type, event); | ||||||||||||||||||||||
| return true; | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
| }); | ||||||||||||||||||||||
| }); | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| it('Should use postMessage', () => { | ||||||||||||||||||||||
| const { result } = renderHook(() => usePostMessage('*', vi.fn())); | ||||||||||||||||||||||
| expect(result.current).toBeTypeOf('function'); | ||||||||||||||||||||||
| }); | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| it('Should use postMessage on server side', () => { | ||||||||||||||||||||||
| const { result } = renderHookServer(() => usePostMessage('*', vi.fn())); | ||||||||||||||||||||||
| expect(result.current).toBeTypeOf('function'); | ||||||||||||||||||||||
| }); | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| it('Should postMessage when handler is called', () => { | ||||||||||||||||||||||
| const { result } = renderHook(() => usePostMessage('*', vi.fn())); | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| act(() => { | ||||||||||||||||||||||
| result.current({ data: 'test-message', origin: 'origin1' }); | ||||||||||||||||||||||
| }); | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| expect(mockPostMessage).toHaveBeenCalledOnce(); | ||||||||||||||||||||||
| expect(mockPostMessage).toHaveBeenCalledWith({ data: 'test-message', origin: 'origin1' }, '*'); | ||||||||||||||||||||||
|
Comment on lines
+47
to
+51
|
||||||||||||||||||||||
| result.current({ data: 'test-message', origin: 'origin1' }); | |
| }); | |
| expect(mockPostMessage).toHaveBeenCalledOnce(); | |
| expect(mockPostMessage).toHaveBeenCalledWith({ data: 'test-message', origin: 'origin1' }, '*'); | |
| result.current('test-message'); | |
| }); | |
| expect(mockPostMessage).toHaveBeenCalledOnce(); | |
| expect(mockPostMessage).toHaveBeenCalledWith('test-message', '*'); |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,13 +23,18 @@ export const usePostMessage = <Message>( | |
| ): UsePostMessageReturn<Message> => { | ||
| const internalCallbackRef = useRef(callback); | ||
| internalCallbackRef.current = callback; | ||
| const internalOriginRef = useRef(origin); | ||
| internalOriginRef.current = origin; | ||
|
|
||
| useEffect(() => { | ||
| const onMessage = (event: MessageEvent<Message>) => { | ||
| if ( | ||
| (Array.isArray(origin) && (!origin.includes(event.origin) || !origin.includes('*'))) || | ||
| (event.origin !== origin && origin !== '*') | ||
| ) | ||
| if (Array.isArray(internalOriginRef.current)) { | ||
| if ( | ||
| !internalOriginRef.current.includes(event.origin) && | ||
| !internalOriginRef.current.includes('*') | ||
| ) | ||
| return; | ||
| } else if (internalOriginRef.current !== '*' && event.origin !== internalOriginRef.current) | ||
| return; | ||
|
|
||
| internalCallbackRef.current(event.data as Message, event); | ||
|
|
@@ -40,12 +45,10 @@ export const usePostMessage = <Message>( | |
| }, []); | ||
|
|
||
| const postMessage = (message: Message) => { | ||
| if (Array.isArray(origin)) { | ||
| origin.forEach((origin) => window.postMessage(message, origin)); | ||
| return; | ||
| } | ||
| if (Array.isArray(internalOriginRef.current)) | ||
| return internalOriginRef.current.forEach((origin) => window.postMessage(message, origin)); | ||
|
|
||
| window.postMessage(message, origin); | ||
| window.postMessage(message, internalOriginRef.current); | ||
| }; | ||
|
Comment on lines
47
to
52
|
||
|
|
||
| return postMessage; | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The postMessage function accesses window.postMessage without checking if window is defined. This could cause a runtime error if the function is called during server-side rendering or before the component mounts. Consider adding a guard check like
if (typeof window === 'undefined') return;at the beginning of the function, similar to how other hooks in this codebase handle window access.