add missing prop comments when merging global configs on upgrade #1004
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
Fixes an issue where new prop comments would not be added to a user's
global config on upgrade. This issue occurred due to how comment-json
stores comments in CommentToken arrays, under a symbol determined by the
closest json property, such as `Symbol.for('before:sessionTracking)`
When a comment-json assign is done on two CommentJSONValue-s that both
have comments under the same symbol, the json with higher priority will override
the other, as opposed to magically merging the arrays together with no duplicates.
This was fixed by re-adding in any missing comments.
No guarantees are made about the exact locations of re-added comments, to avoid
risk associated with a larger rework. I re-added them to the front for now, because
that works the best for the specific issue pointed out ("token" missing").
J=SLAP-1694
TEST=manual,auto
jambo upgrade, saw token added to my global config
tmeyer2115
approved these changes
Nov 15, 2021
Merged
nmanu1
added a commit
that referenced
this pull request
Nov 16, 2021
## Version 1.26.0 ### Features - Add support for the auth token, with a new global_config `token` field (#976) - Add support for the visitor, which can be set or changed at runtime (#970) - Add support for generic thumbs up/down feedback buttons to all cards (#973, #1005) - Handle page and template names with spaces (#988) ### Changes - Update styling of navigation ‘More’ menu (#989) - Update hover color of search bar buttons (#1000) - Internal repo changes (automate WCAG testing (#987)) ### Bugfixes - Fix console error which would appear on google maps (#955) - Fix extra query when loading in iframe integrations (#986) - Fix bug that displayed links that didn’t exist (#990) - Allow microphone access for voice search in iframe (#991) - Fix issue with custom search icon size (#992) - Fix bug with new prop comments not being added (#1004) - Fix distance alignment on location cards (#1006)
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.
Fixes an issue where new prop comments would not be added to a user's
global config on upgrade. This issue occurred due to how comment-json
stores comments in CommentToken arrays. Each CommentToken[] is associated
with a symbol determined by the closest json property, such as
Symbol.for('before:sessionTracking).During a comment-json assign, CommentToken arrays associated with the same symbol
are not magically merged with no duplicates. Instead, the higher priority json will override the other.
This was fixed by re-adding in any missing comments.
No guarantees are made about the exact locations of re-added comments, to avoid
risk associated with a larger rework. I re-added them to the front for now, because
that works the best for the specific issue pointed out ("token" missing").
J=SLAP-1694
TEST=manual,auto
jambo upgrade, saw token added to my global config