Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
65 changes: 65 additions & 0 deletions src/lib/binding/useObservableState.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
import { act, cleanup, renderHook } from "@testing-library/react"
import { afterEach, describe, expect, it } from "vitest"
import { useObservableState } from "./useObservableState"

afterEach(() => {
cleanup()
})

describe("useObservableState", () => {
it("should return the default value on first render", () => {
const { result } = renderHook(() => useObservableState(5))

expect(result.current[0]).toBe(5)
expect(result.current[2].getValue()).toBe(5)
})

it("should re-render with the new value when setState is called", () => {
const { result } = renderHook(() => useObservableState(0))

act(() => {
result.current[1](1)
})

expect(result.current[0]).toBe(1)
})

it("should re-render with the new value when setState is called with an updater", () => {
const { result } = renderHook(() => useObservableState(1))

act(() => {
result.current[1]((prev) => prev + 1)
})

expect(result.current[0]).toBe(2)
})

it("should re-render when the subject is updated directly", () => {
const { result } = renderHook(() => useObservableState(0))

act(() => {
result.current[2].next(10)
})

expect(result.current[0]).toBe(10)
})

it("should not re-render when setState is called with the current value", () => {
let renderCount = 0

const { result } = renderHook(() => {
renderCount++

return useObservableState(0)
})

const renderCountAfterMount = renderCount

act(() => {
result.current[1](0)
})

expect(result.current[0]).toBe(0)
expect(renderCount).toBe(renderCountAfterMount)
})
})
30 changes: 27 additions & 3 deletions src/lib/binding/useObservableState.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
import { type Dispatch, type SetStateAction, useCallback } from "react"
import { BehaviorSubject } from "rxjs"
import {
type Dispatch,
type SetStateAction,
useCallback,
useSyncExternalStore,
} from "react"
import { BehaviorSubject, skip } from "rxjs"
import { useConstant } from "../utils/react/useConstant"

export const useObservableState = <T>(
Expand Down Expand Up @@ -29,7 +34,26 @@ export const useObservableState = <T>(
[subject],
)

const value = subject.getValue()
const subscribe = useCallback(
(onChange: () => void) => {
/**
* `BehaviorSubject` synchronously replays its current value to new
* subscribers while `useSyncExternalStore` reads the initial value
* through `getSnapshot`, so the first emission is skipped to only
* notify React about actual changes.
*/
const sub = subject.pipe(skip(1)).subscribe(onChange)

return () => {
sub.unsubscribe()
}
},
[subject],
)

const getSnapshot = useCallback(() => subject.getValue(), [subject])

const value = useSyncExternalStore(subscribe, getSnapshot, getSnapshot)

return [value, setState, subject]
}