Ensure did-update only re-runs when arguments change (avoid recomputing when tracked properties update within callback)
#54
Conversation
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
mogstad
force-pushed
the
untrack-did-update-callback
branch
from
a4f7e8a to
bc012f7
Compare
|
Is this fixing the issue I described here by any chance? |
|
Yes, this patch should fix that! |
rwjblue
reviewed
Dec 13, 2021
addon/modifiers/did-update.js
Outdated
| @@ -1,5 +1,6 @@ | |||
| import { setModifierManager, capabilities } from '@ember/modifier'; | |||
| import { gte } from 'ember-compatibility-helpers'; | |||
| import { untrack } from '@glimmer/validator'; | |||
There was a problem hiding this comment.
I don't see how this import will work for ember-source < 3.27, in versions prior to 3.27 these sorts of internal ember modules were hidden and not available for import...
There was a problem hiding this comment.
I approved the CI run, so we should see those failures (in 3.24 at least)
There was a problem hiding this comment.
From the Ember 3.12 ember-try scenario:
not ok 5 Chrome 96.0 - [38 ms] - Integration | Modifier | did-update: it basically works
---
stack: >
Error: Could not find module `@glimmer/validator` imported from `@ember/render-modifiers/modifiers/did-update`
at missingModule (http://localhost:7357/assets/vendor.js:259:11)
at findModule (http://localhost:7357/assets/vendor.js:270:7)
at Module.findDeps (http://localhost:7357/assets/vendor.js:180:24)
at findModule (http://localhost:7357/assets/vendor.js:274:11)
at Module.findDeps (http://localhost:7357/assets/vendor.js:180:24)
at findModule (http://localhost:7357/assets/vendor.js:274:11)
at requireModule (http://localhost:7357/assets/vendor.js:36:15)
at ModuleRegistry.get (http://localhost:7357/assets/vendor.js:67734:14)
at Class._extractDefaultExport (http://localhost:7357/assets/vendor.js:68170:41)
at Class.resolveOther (http://localhost:7357/assets/vendor.js:67830:32)
There was a problem hiding this comment.
I've pushed a commit that should resolve this issue...
Modifier capabillities in 3.22, requires all arguments to be consumed, to be tracked. This meant `disableAutoTracking` had to be set to `false` for the modifier to work with 3.22 capabillities. This had the sideeffect that any other consumed tags ended up being tracked. Meaning the `did-update` callback was invoked whenever those tags changed.
rwjblue
force-pushed
the
untrack-did-update-callback
branch
from
57268a9 to
95a3fe5
Compare
rwjblue
reviewed
Dec 13, 2021
| @@ -27,6 +27,7 @@ | |||
| "test:ember-compatibility": "ember try:each" | |||
| }, | |||
| "dependencies": { | |||
| "@embroider/macros": ">= 0.48.1 < 2.0.0-alpha.1", | |||
There was a problem hiding this comment.
@embroider/macros is "stable", this ensures that we can continually get the most recent version (and don't force an app to end up with a bunch of versions due to our dependency).
rwjblue
force-pushed
the
untrack-did-update-callback
branch
from
95a3fe5 to
94b3132
Compare
rwjblue
force-pushed
the
untrack-did-update-callback
branch
from
cf434e3 to
8dd14c7
Compare
rwjblue
changed the title
did-update callback in an untracked framedid-update only re-runs when arguments change (avoid recomputing when tracked properties update within callback)
Open
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.
Modifier capabillities in 3.22, requires all arguments to be consumed,
to be tracked. This meant
disableAutoTrackinghad to be set tofalsefor the modifier to work with 3.22 capabillities. This had the
sideeffect that any other consumed tags ended up being tracked. Meaning
the
did-updatecallback was invoked whenever those tags changed.