FIX: Make links and icons setting migration more resilient
#39
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
tgxworld
force-pushed
the
make_migration_more_resistant_to_invalid_formats
branch
from
0fb54ed to
51920ec
Compare
This commit updates the migrations to assume that the old setting value may be invalid so that we don't end up with a new setting which fails the objects schema validation. This is a follow up to 7e304e0 which added migrations for the `links` and `icons` settings. We have gotten reports of errors happening with the migrations because the value of the old setting before migration did not follow the "informal" format required previously. Since there was nothing enforcing the format for the value previously, we need to assume the worst possible cases in our migrations.
tgxworld
force-pushed
the
make_migration_more_resistant_to_invalid_formats
branch
from
51920ec to
4756128
Compare
nattsw
reviewed
Apr 26, 2024
| target | ||
| } | ||
| oldSetting.split("|").forEach((link) => { | ||
| let [text, url, target] = link.split(",").map((s) => s.trim()); |
There was a problem hiding this comment.
Do you expect text, url, target to mutate?
There was a problem hiding this comment.
Ah ok, I see below that target might. All good.
nattsw
reviewed
Apr 26, 2024
|
|
||
| settings.set("icons", newSetting); | ||
| settings.set("icons", newIcons); |
There was a problem hiding this comment.
Jut to check,
{
icon_name: iconName,
url: undefined,
target: undefined,
}
is valid for settings? since the split(",") may land up with just one item in the array. (same for newLinks)
There was a problem hiding this comment.
We don't get undefined anymore since this is what the PR is trying to solve now. target will always be set and we only add a link if icon_name and url is not undefined.
nattsw
approved these changes
Apr 26, 2024
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.
This commit updates the migrations to assume that the old setting value
may be invalid so that we don't end up with a new setting which fails
the objects schema validation.
This is a follow up to 7e304e0 which
added migrations for the
linksandiconssettings. We havegotten reports of errors happening with the migrations because the value of the old
setting before migration did not follow the "informal" format required
previously. Since there was nothing enforcing the format for the value
previously, we need to assume the worst possible cases in our
migrations.