fix(wire-service): add lifecycle hook guards #1092
Merged
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
Benchmark resultsBase commit: lwc-engine-benchmark
|
kevinv11n
suggested changes
Mar 5, 2019
| @@ -110,6 +110,9 @@ const wireService = { | |||
|
|
|||
| connected: (cmp: LightningElement, data: object, def: ElementDef, context: Context) => { | |||
| let listeners: NoArgumentListener[]; | |||
| if (process.env.NODE_ENV !== 'production') { | |||
There was a problem hiding this comment.
We shouldn't need this check because wiring -> connected transition is sync so it's not possible for this invariant to be violated
There was a problem hiding this comment.
I can reproduce this in a test if I register the wire adapter after calling createElement and before pushing to the DOM.
There was a problem hiding this comment.
also, keep in mind that the error boundary protocol allows a sync removal of the elements when the error occur, which means that if a child element throws during construction, the parent shadow will be cleaned up before the connect is invoked all together.
There was a problem hiding this comment.
If a child element throws during construction, is the wiring hook called for that component? I assume connect and disconnect are not called at all.
the parent shadow will be cleaned up before the connect is invoked all together.
What does cleaned up entail?
There was a problem hiding this comment.
cleaned up means that the offender VM/CustomElement will get its shadow root cleaned (empty of any element due to a broken state).
throws could occur at many levels, including constructor of the parent, constructor of a child, connected of parent, render of parent, connected of child, render of child, renderedCallback of child, renderedCallback of parent. Plus, the wiring in the middle, which we don't protect today (eventually will). The consequence of a failure will depend on when and where it happens though.
| @@ -118,6 +121,9 @@ const wireService = { | |||
|
|
|||
| disconnected: (cmp: LightningElement, data: object, def: ElementDef, context: Context) => { | |||
| let listeners: NoArgumentListener[]; | |||
| if (process.env.NODE_ENV !== 'production') { | |||
| assert.isTrue(context[CONTEXT_ID], 'wire adapter "disconnected" hook called without an established context'); | |||
There was a problem hiding this comment.
Suggested change
| assert.isTrue(context[CONTEXT_ID], 'wire adapter "disconnected" hook called without an established context'); | |
| assert.isTrue(context[CONTEXT_ID], 'wire service was not initialized prior to component creation: "disconnected" service hook invoked without necessary context'); |
kevinv11n
approved these changes
Mar 5, 2019
Benchmark resultsBase commit: lwc-engine-benchmark
|
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.
Details
In tests we provide an API that allows users to register a test wire adapter and emit data through the wire. If a user registers the adapter after the element is created they get a cryptic error when that element is disconnected from the DOM.
Users should always register the adapter before creating the element, but we should also have a better error message than a NPE when they don't.
Does this PR introduce a breaking change?