-
-
Notifications
You must be signed in to change notification settings - Fork 459
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
fix(ui): fix use observable #1719
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains 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 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
101 changes: 101 additions & 0 deletions
101
packages/ui/src/components/hooks/__tests__/observable.spec.ts
This file contains 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,101 @@ | ||
/** | ||
* Copyright 2023-present DreamNum Inc. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
import { describe, expect, it } from 'vitest'; | ||
import { act, renderHook } from '@testing-library/react-hooks'; | ||
import { of, Subject } from 'rxjs'; | ||
import type { Observable } from 'rxjs'; | ||
|
||
import { useState } from 'react'; | ||
import { useObservable } from '../observable'; | ||
|
||
// New to testing React Hooks? You can refer to https://mayashavin.com/articles/test-react-hooks-with-vitest . | ||
|
||
describe('test "useObservable"', () => { | ||
it('should return undefined when no initial value is provided', () => { | ||
const observable: Observable<boolean> | undefined = undefined; | ||
|
||
const { result } = renderHook(() => useObservable<boolean>(observable)); | ||
expect(result.current).toBeUndefined(); | ||
}); | ||
|
||
it('should return the initial value when provided', () => { | ||
const observable: Observable<boolean> | undefined = undefined; | ||
|
||
const { result } = renderHook(() => useObservable<boolean>(observable, true)); | ||
expect(result.current).toBeTruthy(); | ||
}); | ||
|
||
it('should return the initial value when provided synchronously', () => { | ||
const observable: Observable<boolean> = of(true); | ||
|
||
const { result } = renderHook(() => useObservable<boolean>(observable)); | ||
expect(result.current).toBeTruthy(); | ||
}); | ||
|
||
function useTestUseObservableBed() { | ||
const observable = new Subject<boolean>(); | ||
const result = useObservable(observable, undefined, false); | ||
|
||
return { | ||
observable, | ||
result, | ||
}; | ||
} | ||
|
||
it('should emit new value when observable emits', () => { | ||
const { result } = renderHook(() => useTestUseObservableBed()); | ||
|
||
expect(result.current.result).toBeUndefined(); | ||
|
||
act(() => result.current.observable.next(true)); | ||
expect(result.current.result).toBeTruthy(); | ||
|
||
act(() => result.current.observable.next(false)); | ||
expect(result.current.result).toBeFalsy(); | ||
}); | ||
|
||
function useTestSwitchObservableBed() { | ||
const [observable, setObservable] = useState<Observable<boolean> | undefined>(undefined); | ||
const result = useObservable(observable); | ||
|
||
return { | ||
result, | ||
observable, | ||
setObservable, | ||
}; | ||
} | ||
|
||
it('should emit when passing new observable to the hook', () => { | ||
const { result } = renderHook(() => useTestSwitchObservableBed()); | ||
|
||
expect(result.current.result).toBeUndefined(); | ||
|
||
act(() => result.current.setObservable(of(true))); | ||
expect(result.current.result).toBeTruthy(); | ||
|
||
act(() => result.current.setObservable(of(false))); | ||
expect(result.current.result).toBeFalsy(); | ||
}); | ||
|
||
it('should support a callback function returns an observable', () => { | ||
// const { result } = renderHook(() => useObservable(() => of(true))); | ||
// This line above would cause infinite look. Pass `deps` to fix the problem. | ||
const { result } = renderHook(() => useObservable(() => of(true), undefined, true, [])); | ||
|
||
expect(result.current).toBeTruthy(); | ||
}); | ||
}); |
This file contains 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 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 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 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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.
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.