Update ClassMap before notifying schema change listeners
#5955
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
kraenhansen
reviewed
Jun 29, 2023
kraenhansen
reviewed
Jun 29, 2023
packages/realm/src/Realm.ts
Outdated
| @@ -599,7 +599,7 @@ export class Realm { | |||
| public readonly syncSession: SyncSession | null; | |||
|
|
|||
| private schemaExtras: RealmSchemaExtra = {}; | |||
| private classes: ClassMap; | |||
| private classes!: ClassMap; | |||
There was a problem hiding this comment.
I'm almost thinking that this drawback from deferring to a method at line 688 isn't worth it. As we don't expect to have to initialize the class map more than twice and it's not too complex, I would probably suggest duplicating and inlining it on 662 and 688 instead.
There was a problem hiding this comment.
You make a good point, I'll inline those calls 👍
P.S. would be nice to add something in function signatures that tells TS that a certain property will be set. Similar to asserts or is. That would remove the risks of having to use ! as in the above case.
kraenhansen
approved these changes
Jun 29, 2023
papafe
approved these changes
Jun 30, 2023
kneth
approved these changes
Jun 30, 2023
See the comments in the test regarding potentially unexpected behavior.
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?
When calling
Realm._updateSchema()in a write transaction, the schema change listener is fired after the call into Core, but before_updateSchema()returns (and thus before the write transaction is completed).The
ClassMapinstance on the Realm was previously updated/reinitialized in_updateSchema(), but since the listener was fired before that, theClassMaphad not been updated in time. This PR moves that update into theschemaDidChangecallback, updating it before notifying schema change listeners.This closes #5574
☑️ ToDos