Skip to content

feat: subscribeChanges #30

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

samwillis
Copy link
Contributor

@samwillis samwillis commented Apr 30, 2025

This adds a few public APIs:

  • collection.derivedChanges is a tanstack/store Derived state, it is replaced with the latest changes (insert/update/delete) each time the derived state changes. This can be used inside an Effect along with other collections to essentially subscribe to a set of charges across the collections. This will be the foundation of the IVM queries.
  • collection.currentStateAsChanges returns the current state as a set of inserts. It's needed to bootstrap the initial state of a query.
  • collection.subscribeChanges is a thin wrapper of the above as a higher level public api

Copy link

changeset-bot bot commented Apr 30, 2025

⚠️ No Changeset found

Latest commit: b8c1a9c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

pkg-pr-new bot commented Apr 30, 2025

examples/react/todo

npm i https://pkg.pr.new/@tanstack/optimistic@30
npm i https://pkg.pr.new/@tanstack/react-optimistic@30

commit: b8c1a9c

@samwillis samwillis marked this pull request as ready for review April 30, 2025 14:02
} else if (!prevDerivedState.has(key) && derivedState.has(key)) {
changes.push({ type: `insert`, key, value: derivedState.get(key)! })
} else if (prevDerivedState.has(key) && derivedState.has(key)) {
// Check if the value has changed and only emit a change if it has
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd say it's the collections job to figure out if something has changed. Deep equality is pretty fast but not that fast and it should be far more efficient for someone else to do it. So I'd remove all this checking code and just push out the updates.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If we remove this check the tests fail, we get an insert and then two updates, when it should just be an insert.

When doing an inserting transaction we are somewhere triggering optimisticOperations to be derived three times. That causes derivedState and derivedChanges to then be run three times.

I would only expect this to be triggered once.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Oh I was reacting to the code below:

 // TODO: Better way to do this? deep equality?
            const prevValue = JSON.stringify(prevDerivedState.get(key))
            const newValue = JSON.stringify(derivedState.get(key))
            if (prevValue !== newValue) {

Is this check necessary?

Copy link
Collaborator

Choose a reason for hiding this comment

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

But sounds like this is a bug somewhere else?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep, removing the JSON.stringify check that the two values have changed results in the test failing.

I'm suspicious something else is triggering excessive recomputations.

@KyleAMathews KyleAMathews added this to the v0.1.0 Release milestone May 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants