Add store.onSessionEnd for reliably detecting session end - #504
Open
kvvasuu wants to merge 1 commit into
Open
Conversation
session.addEventListener('end', ...) is easy to attach to a stale session
reference across re-renders. XRStore already tracks this internally via
its own 'end' listener, so expose it as a store subscription helper
instead of making every consumer reimplement prev/current session diffing.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Problem
There's no documented, supported way to react to an XR session ending.
session.addEventListener('end', ...)looks like the obvious approach, but it's easy to end up attached to a stale/incorrect session reference across re-renders, since consumers typically getsessionreactively (e.g.useXR(state => state.session)).Internally,
<XR>already solves this correctly by diffingstate.sessionin astore.subscribecallback - but that pattern wasn't exposed or documented anywhere.Change
store.onSessionEnd(callback): a thin wrapper aroundstore.subscribethat fires when the session transitions from non-null to null, and returns an unsubscribe function. Mirrors the existingdestroy()doc comment ("for exiting XR usestore.getState().session?.end()") with a symmetric, documented way to detect the end.Testing
pnpm -r check:prettier✅pnpm -r check:eslint✅pnpm -r build✅