Key path filtered notifications in Object and Collection
#6310
Conversation
This file contains 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
takameyer
reviewed
Dec 11, 2023
elle-j
reviewed
Dec 11, 2023
| [ | ||
| EMPTY_OBJECT_CHANGESET, | ||
| () => { | ||
| // Updating the age to 42 will ensure the object doesn't leave the results |
There was a problem hiding this comment.
Suggested change
| // Updating the age to 42 will ensure the object doesn't leave the results | |
| // Updating the age will ensure the listener is not triggered by a non-specified key path. |
kraenhansen
force-pushed
the
kh/key-path-filtered-notifications
branch
from
d7fc197 to
d3498ba
Compare
kraenhansen
force-pushed
the
kh/key-path-filtered-notifications
branch
from
9f8c7db to
d687e74
Compare
kneth
reviewed
Dec 13, 2023
kraenhansen
force-pushed
the
kh/key-path-filtered-notifications
branch
from
32a3760 to
bacd09c
Compare
kneth
approved these changes
Dec 18, 2023
takameyer
approved these changes
Dec 18, 2023
Co-authored-by: LJ <[email protected]>
Co-authored-by: LJ <[email protected]>
… union is indeed used
kraenhansen
force-pushed
the
kh/key-path-filtered-notifications
branch
from
b46b689 to
852122c
Compare
bimusiek
pushed a commit
to bimusiek/realm-js
that referenced
this pull request
Mar 14, 2024
) * Pin Listeners to throwOnReAdd * Adding key path filtering to Collection * Tests WIP * Show the entire diff when deep.equals fails * Implemented key-path notifications for RealmObject * Adding an entry to the changelog * Passing key-paths through for Dictionary * Adding dictionary tests * Adding changelog entry about the dictionary fix * Adding a note on the breaking change * Apply suggestions from code review Co-authored-by: LJ <[email protected]> * Adding string overload to Object#addListener * Adding @param doc strings * Adding an example to the changelog and doc comments. * Refactored to use a common "expectNotifications" function * Moved keyPaths before changesAndActions * Apply suggestions from code review Co-authored-by: LJ <[email protected]> * Adding a few more tests * Adding a test using wildcard (*) * Using key-path array of strings in tests again * Adding multiple listeners with different key paths to verify that the union is indeed used * Separated key-path tests into separate "it"s * Update SDK unit tests * Moved changelog entry from breaking changes to fixed * Update CHANGELOG.md * Updated doc comments * Updated readd tests * Updating a comment --------- Co-authored-by: LJ <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What, How & Why?
This closes #6285 by exposing an optional third argument to the
addListenermethods.This also updates Core to v13.24.0 to pull in the new APIs that got added to the spec.yml and depends on one additional change that hasn't been merged and released yet.
NOTE: Because of 30d99c0 adding a listener twice, will start throwing instead of being a no-op. We had tests for this, but it wasn't explicitly documented, so technically not a breaking change to the documented API, but it still might result in runtime errors in some consuming code-bases.
☑️ ToDos
Compatibilitylabel is updated or copied from previous entryCOMPATIBILITY.mdObject,ResultsandDictionary- missing tests onListandSet, but they hit the same code)package.jsons (if updating internal packages)Breakinglabel has been applied or is not necessary