Skip to content

feat(bind): factory with nested keys #78

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 2 commits into from
Aug 16, 2020
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
47 changes: 29 additions & 18 deletions packages/core/src/bind/connectFactoryObservable.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import {
import { bind } from "../"
import { TestErrorBoundary } from "../test-helpers/TestErrorBoundary"

const wait = (ms: number) => new Promise(res => setTimeout(res, ms))
const wait = (ms: number) => new Promise((res) => setTimeout(res, ms))

describe("connectFactoryObservable", () => {
const originalError = console.error
Expand Down Expand Up @@ -86,24 +86,26 @@ describe("connectFactoryObservable", () => {
const [
useLatestNumber,
latestNumber$,
] = bind((id: number, value: number) =>
concat(observable$, of(id + value)),
] = bind((id: number, value: { val: number }) =>
concat(observable$, of(id + value.val)),
)
expect(subscriberCount).toBe(0)

renderHook(() => useLatestNumber(1, 1))
const first = { val: 1 }
renderHook(() => useLatestNumber(1, first))
expect(subscriberCount).toBe(1)

renderHook(() => useLatestNumber(1, 1))
renderHook(() => useLatestNumber(1, first))
expect(subscriberCount).toBe(1)

latestNumber$(1, 1).subscribe()
latestNumber$(1, first).subscribe()
expect(subscriberCount).toBe(1)

renderHook(() => useLatestNumber(1, 2))
const second = { val: 2 }
renderHook(() => useLatestNumber(1, second))
expect(subscriberCount).toBe(2)

renderHook(() => useLatestNumber(2, 2))
renderHook(() => useLatestNumber(2, second))
expect(subscriberCount).toBe(3)
})

Expand All @@ -125,9 +127,16 @@ describe("connectFactoryObservable", () => {
expect(result.current).toBe(2)
})

it("handles optional args correctly", () => {
const [, getNumber$] = bind((x: number, y?: number) => of(x + (y ?? 0)))

expect(getNumber$(5)).toBe(getNumber$(5, undefined))
expect(getNumber$(6, undefined)).toBe(getNumber$(6))
})

it("suspends the component when the factory-observable hasn't emitted yet.", async () => {
const [useDelayedNumber] = bind((x: number) => of(x).pipe(delay(50)))
const Result: React.FC<{ input: number }> = p => (
const Result: React.FC<{ input: number }> = (p) => (
<div>Result {useDelayedNumber(p.input)}</div>
)
const TestSuspense: React.FC = () => {
Expand All @@ -137,7 +146,7 @@ describe("connectFactoryObservable", () => {
<Suspense fallback={<span>Waiting</span>}>
<Result input={input} />
</Suspense>
<button onClick={() => setInput(x => x + 1)}>increase</button>
<button onClick={() => setInput((x) => x + 1)}>increase</button>
</>
)
}
Expand Down Expand Up @@ -231,7 +240,7 @@ describe("connectFactoryObservable", () => {
})

it("allows sync errors to be caught in error boundaries with suspense", () => {
const errStream = new Observable(observer =>
const errStream = new Observable((observer) =>
observer.error("controlled error"),
)
const [useError] = bind((_: string) => errStream)
Expand Down Expand Up @@ -294,7 +303,7 @@ describe("connectFactoryObservable", () => {
"key of the hook to an observable that throws synchronously",
async () => {
const normal$ = new Subject<string>()
const errored$ = new Observable<string>(observer => {
const errored$ = new Observable<string>((observer) => {
observer.error("controlled error")
})

Expand Down Expand Up @@ -345,7 +354,9 @@ describe("connectFactoryObservable", () => {
const valueStream = new BehaviorSubject(1)
const [useValue, value$] = bind(() => valueStream)
const [useError] = bind(() =>
value$().pipe(switchMap(v => (v === 1 ? of(v) : throwError("error")))),
value$().pipe(
switchMap((v) => (v === 1 ? of(v) : throwError("error"))),
),
)

const ErrorComponent: FC = () => {
Expand Down Expand Up @@ -382,12 +393,12 @@ describe("connectFactoryObservable", () => {
let diff = -1
const [useLatestNumber, getShared] = bind((_: number) => {
diff++
return from([1, 2, 3, 4].map(val => val + diff))
return from([1, 2, 3, 4].map((val) => val + diff))
}, 0)

let latestValue1: number = 0
let nUpdates = 0
const sub1 = getShared(0).subscribe(x => {
const sub1 = getShared(0).subscribe((x) => {
latestValue1 = x
nUpdates += 1
})
Expand All @@ -400,7 +411,7 @@ describe("connectFactoryObservable", () => {
expect(nUpdates).toBe(4)

let latestValue2: number = 0
const sub2 = getShared(0).subscribe(x => {
const sub2 = getShared(0).subscribe((x) => {
latestValue2 = x
nUpdates += 1
})
Expand All @@ -409,7 +420,7 @@ describe("connectFactoryObservable", () => {
expect(sub2.closed).toBe(true)

let latestValue3: number = 0
const sub3 = getShared(0).subscribe(x => {
const sub3 = getShared(0).subscribe((x) => {
latestValue3 = x
nUpdates += 1
})
Expand All @@ -421,7 +432,7 @@ describe("connectFactoryObservable", () => {
await wait(10)

let latestValue4: number = 0
const sub4 = getShared(0).subscribe(x => {
const sub4 = getShared(0).subscribe((x) => {
latestValue4 = x
nUpdates += 1
})
Expand Down
70 changes: 58 additions & 12 deletions packages/core/src/bind/connectFactoryObservable.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,30 +28,30 @@ import { takeUntilComplete } from "../internal/take-until-complete"
* subscription, then the hook will leverage React Suspense while it's waiting
* for the first value.
*/
export default function connectFactoryObservable<
A extends (number | string | boolean | null)[],
O
>(
export default function connectFactoryObservable<A extends [], O>(
getObservable: (...args: A) => Observable<O>,
unsubscribeGraceTime: number,
): [
(...args: A) => Exclude<O, typeof SUSPENSE>,
(...args: A) => Observable<O>,
] {
const cache = new Map<string, [Observable<O>, BehaviorObservable<O>]>()
const cache = new NestedMap<A, [Observable<O>, BehaviorObservable<O>]>()

const getSharedObservables$ = (
...input: A
input: A,
): [Observable<O>, BehaviorObservable<O>] => {
const key = JSON.stringify(input)
const cachedVal = cache.get(key)
for (let i = input.length - 1; input[i] === undefined && i > -1; i--) {
input.splice(-1)
}
const keys = ([input.length, ...input] as any) as A
Copy link
Collaborator

Choose a reason for hiding this comment

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

This reminded me of something exciting: The TS release for this month (4.0) will include variadic tuple types - Which will allow us to represent this type as [number, ...A].

const cachedVal = cache.get(keys)

if (cachedVal !== undefined) {
return cachedVal
}

const sharedObservable$ = shareLatest(getObservable(...input), () => {
cache.delete(key)
cache.delete(keys)
})

const reactObservable$ = reactEnhancer(
Expand All @@ -64,12 +64,58 @@ export default function connectFactoryObservable<
reactObservable$,
]

cache.set(key, result)
cache.set(keys, result)
return result
}

return [
(...input: A) => useObservable(getSharedObservables$(...input)[1]),
(...input: A) => getSharedObservables$(...input)[0],
(...input: A) => useObservable(getSharedObservables$(input)[1]),
(...input: A) => getSharedObservables$(input)[0],
]
}

class NestedMap<K extends [], V extends Object> {
private root: Map<K, any>
constructor() {
this.root = new Map()
}

get(keys: K[]): V | undefined {
let current: any = this.root
for (let i = 0; i < keys.length; i++) {
current = current.get(keys[i])
if (!current) return undefined
}
return current
}

set(keys: K[], value: V): void {
let current: Map<K, any> = this.root
let i
for (i = 0; i < keys.length - 1; i++) {
let nextCurrent = current.get(keys[i])
if (!nextCurrent) {
nextCurrent = new Map<K, any>()
current.set(keys[i], nextCurrent)
}
current = nextCurrent
}
current.set(keys[i], value)
}

delete(keys: K[]): void {
const maps: Map<K, any>[] = [this.root]
let current: Map<K, any> = this.root

for (let i = 0; i < keys.length - 1; i++) {
maps.push((current = current.get(keys[i])))
}

let mapIdx = maps.length - 1
maps[mapIdx].delete(keys[mapIdx])

while (--mapIdx > -1 && maps[mapIdx].get(keys[mapIdx]).size === 0) {
maps[mapIdx].delete(keys[mapIdx])
}
}
}
4 changes: 2 additions & 2 deletions packages/core/src/bind/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,12 @@ export function bind<T>(
* subscription, then the hook will leverage React Suspense while it's waiting
* for the first value.
*/
export function bind<A extends (number | string | boolean | null)[], O>(
export function bind<A extends unknown[], O>(
getObservable: (...args: A) => Observable<O>,
unsubscribeGraceTime?: number,
): [(...args: A) => Exclude<O, typeof SUSPENSE>, (...args: A) => Observable<O>]

export function bind<A extends (number | string | boolean | null)[], O>(
export function bind<A extends unknown[], O>(
obs: ((...args: A) => Observable<O>) | Observable<O>,
unsubscribeGraceTime = 200,
) {
Expand Down