fix!(connection): Correctly handle multiple highlighted RenderedConnections #6416
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
Modify RenderedConnection.prototype.highlight and .unhighlight to store the highlight path on this rather than as a static property on Connection (which is where it had been stored since this functionality was originally created, previously to RenderedConnection and Connection being split).
cpcallen
added
component: connection
breaking change
|
🤖 I detect that the PR title and the commit message differ and there's only one commit. To use the PR title for the commit history, you can use Github's automerge feature with squashing, or use -- conventional-commit-lint bot |
BeksOmega
approved these changes
Sep 9, 2022
NeilFraser
approved these changes
Sep 9, 2022
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.
The basics
npm run formatandnpm run lintThe details
Resolves
Issue reported in forum.
Proposed Changes
Modify
RenderedConnection.prototype.highlightand.unhighlightto store the highlight path onthisrather than as a static property onConnection(which is where it had been stored since this functionality was originally created, apaprently prior to RenderedConnection and Connection being split).Behaviour Before Change
Calling
.unhighlighton aRenderedConnectioninstance unhighlighted the most recently-highlighted connection, not necessarilythisone.Behaviour After Change
Calling
.unhighlighton aRenderedConnectionunhighlightsthisconnection, if it was highlighted (and does nothing if not).Reason for Changes
To make it possible to highlight more than one connection at a time—and, critically, to then be able to unhighlight any/all of them later.
Test Coverage
Passes
npm test.Manual testing: I have done a basic check in the playground to verify that connection highlighting appears to be working as expected, but being alert to any issues about this in manual testing would be great.
Documentation
The documentation already documented the new behaviour.
BREAKING CHANGE:
This change will break any third-party code which incorrectly relied on
.unhighlightunconditionally removing the most recently-created highlight.