Skip to content

Prepare for performance improvements #3684

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 3 commits into from
Apr 10, 2025
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
20 changes: 19 additions & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 5 additions & 3 deletions packages/@headlessui-react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@
},
"scripts": {
"prepublishOnly": "npm run build",
"build": "../../scripts/build.sh --external:react --external:react-dom",
"watch": "../../scripts/watch.sh --external:react --external:react-dom",
"build": "../../scripts/build.sh --external:react --external:react-dom --external:use-sync-external-store",
"watch": "../../scripts/watch.sh --external:react --external:react-dom --external:use-sync-external-store",
"test": "../../scripts/test.sh",
"lint": "../../scripts/lint.sh",
"lint-types": "npm run attw -P --workspaces --if-present",
Expand All @@ -49,6 +49,7 @@
"@testing-library/react": "^15.0.7",
"@types/react": "^18.3.3",
"@types/react-dom": "^18.3.0",
"@types/use-sync-external-store": "^1.5.0",
"jsdom-testing-mocks": "^1.13.1",
"react": "^18.3.1",
"react-dom": "^18.3.1",
Expand All @@ -58,6 +59,7 @@
"@floating-ui/react": "^0.26.16",
"@react-aria/focus": "^3.17.1",
"@react-aria/interactions": "^3.21.3",
"@tanstack/react-virtual": "^3.11.1"
"@tanstack/react-virtual": "^3.11.1",
"use-sync-external-store": "^1.5.0"
}
}
129 changes: 129 additions & 0 deletions packages/@headlessui-react/src/machine.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
import { DefaultMap } from './utils/default-map'
import { disposables } from './utils/disposables'

export abstract class Machine<State, Event extends { type: number | string }> {
#state: State = {} as State
#eventSubscribers = new DefaultMap<Event['type'], Set<(state: State, event: Event) => void>>(
() => new Set()
)
#subscribers: Set<Subscriber<State, any>> = new Set()

constructor(initialState: State) {
this.#state = initialState
}

get state(): Readonly<State> {
return this.#state
}

abstract reduce(state: Readonly<State>, event: Event): Readonly<State>

subscribe<Slice>(
selector: (state: Readonly<State>) => Slice,
callback: (state: Slice) => void
): () => void {
let subscriber: Subscriber<State, Slice> = {
selector,
callback,
current: selector(this.#state),
}
this.#subscribers.add(subscriber)

return () => {
this.#subscribers.delete(subscriber)
}
}

on(type: Event['type'], callback: (state: State, event: Event) => void) {
this.#eventSubscribers.get(type).add(callback)
return () => {
this.#eventSubscribers.get(type).delete(callback)
}
}

send(event: Event) {
this.#state = this.reduce(this.#state, event)

for (let subscriber of this.#subscribers) {
let slice = subscriber.selector(this.#state)
if (shallowEqual(subscriber.current, slice)) continue

subscriber.current = slice
subscriber.callback(slice)
}

for (let callback of this.#eventSubscribers.get(event.type)) {
callback(this.#state, event)
}
}
}

interface Subscriber<State, Slice> {
selector: (state: Readonly<State>) => Slice
callback: (state: Slice) => void
current: Slice
}

export function shallowEqual(a: any, b: any): boolean {
// Exact same reference
if (Object.is(a, b)) return true

// Must be some type of object
if (typeof a !== 'object' || a === null || typeof b !== 'object' || b === null) return false

// Arrays
if (Array.isArray(a) && Array.isArray(b)) {
if (a.length !== b.length) return false
return compareEntries(a[Symbol.iterator](), b[Symbol.iterator]())
}

// Map and Set
if ((a instanceof Map && b instanceof Map) || (a instanceof Set && b instanceof Set)) {
if (a.size !== b.size) return false
return compareEntries(a.entries(), b.entries())
}

// Plain objects
if (isPlainObject(a) && isPlainObject(b)) {
return compareEntries(
Object.entries(a)[Symbol.iterator](),
Object.entries(b)[Symbol.iterator]()
)
}

// TODO: Not sure how to compare other types of objects
return false
}

function compareEntries(a: IterableIterator<any>, b: IterableIterator<any>): boolean {
do {
let aResult = a.next()
let bResult = b.next()

if (aResult.done && bResult.done) return true
if (aResult.done || bResult.done) return false

if (!Object.is(aResult.value, bResult.value)) return false
} while (true)
}

function isPlainObject<T>(value: T): value is T & Record<keyof T, unknown> {
if (Object.prototype.toString.call(value) !== '[object Object]') {
return false
}

let prototype = Object.getPrototypeOf(value)
return prototype === null || Object.getPrototypeOf(prototype) === null
}

export function batch<F extends (...args: any[]) => void, P extends any[] = Parameters<F>>(
setup: () => [callback: F, handle: () => void]
) {
let [callback, handle] = setup()
let d = disposables()
return (...args: P) => {
callback(...args)
d.dispose()
d.microTask(handle)
}
}
22 changes: 22 additions & 0 deletions packages/@headlessui-react/src/react-glue.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import { useSyncExternalStoreWithSelector } from 'use-sync-external-store/with-selector'

import { useEvent } from './hooks/use-event'
import { shallowEqual, type Machine } from './machine'

export function useSlice<M extends Machine<any, any>, Slice>(
machine: M,
selector: (state: Readonly<M extends Machine<infer State, any> ? State : never>) => Slice,
compare = shallowEqual
) {
return useSyncExternalStoreWithSelector(
useEvent((onStoreChange) => machine.subscribe(identity, onStoreChange)),
useEvent(() => machine.state),
useEvent(() => machine.state),
useEvent(selector),
compare
)
}

function identity<T>(value: T) {
return value
}
3 changes: 2 additions & 1 deletion scripts/watch.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ sharedOptions+=("--bundle")
sharedOptions+=("--platform=browser")
sharedOptions+=("--target=es2020")


# Generate actual builds
npx esbuild $input --format=esm --outfile=$outdir/$name.esm.js --sourcemap ${sharedOptions[@]} $@ --watch
NODE_ENV=development npx esbuild $input --format=esm --outfile=$outdir/$name.esm.js --sourcemap ${sharedOptions[@]} $@ --watch