Attempt to heal settings files damaged by #9962 #10143
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
The bug that caused #9962 resulted in folks getting profiles written to their settings that didn't contain any identifying information (name or guid), sometimes multiple times. These profiles look (somewhat) like this: ```json { "colorScheme": "Campbell" }, {}, ``` An empty profile serves no purpose -- it shows up in the list as being named "Default", and it only launches CMD (unless the commandline is the thing that the user successfully changed.) We can heal the settings file by simply ignoring those profiles that have *no identifying information* (a guid or a name that can be converted into a guid). Validation ---------- I created a number of profiles that fit this format and made sure that they were ignored on load and destroyed on save.
DHowett
commented
May 20, 2021
| static bool _IsValidProfileObject(const Json::Value& profileJson) | ||
| { | ||
| return profileJson.isMember(&*NameKey.begin(), &*NameKey.end()) || // has a name (can generate a guid) | ||
| profileJson.isMember(&*GuidKey.begin(), &*GuidKey.end()); // or has a guid |
There was a problem hiding this comment.
frick, I meant to fix this -- this will throw in debug
DHowett
commented
May 20, 2021
Comment on lines
+806
to
+807
| return profileJson.isMember(&*NameKey.cbegin(), (&*NameKey.cbegin()) + NameKey.size()) || // has a name (can generate a guid) | ||
| profileJson.isMember(&*GuidKey.cbegin(), (&*GuidKey.cbegin()) + GuidKey.size()); // or has a guid |
There was a problem hiding this comment.
i know, the iterator math is ugly. this is the alternative to creating a copy of the name/guid string views as strings every time we want to check.
This should be in JsonUtils as another "string_view adapter" (like GetValue and SetValue do), but I am not doing this in this PR.
zadjii-msft
approved these changes
May 21, 2021
34 tasks
ghost
requested review from
miniksa,
carlos-zamora,
leonMSFT,
PankajBhojwani and
lhecker
miniksa
approved these changes
May 21, 2021
DHowett
added
the
AutoMerge
|
Hello @DHowett! Because this pull request has the p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (
|
DHowett
added a commit
that referenced
this pull request
May 24, 2021
The bug that caused #9962 resulted in folks getting profiles written to their settings that didn't contain any identifying information (name or guid), sometimes multiple times. These profiles look (somewhat) like this: ```json { "colorScheme": "Campbell" }, {}, ``` An empty profile serves no purpose -- it shows up in the list as being named "Default", and it only launches CMD (unless the commandline is the thing that the user successfully changed.) We can heal the settings file by simply ignoring those profiles that have *no identifying information* (a guid or a name that can be converted into a guid). Validation ---------- I created a number of profiles that fit this format and made sure that they were ignored on load and destroyed on save. ## PR Checklist * [x] Closes an annoyance we discovered after 9962. (cherry picked from commit 84f6a29)
|
🎉 Handy links: |
|
🎉 Handy links: |
This pull request was closed.
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 bug that caused #9962 resulted in folks getting profiles written to
their settings that didn't contain any identifying information (name or
guid), sometimes multiple times.
These profiles look (somewhat) like this:
{ "colorScheme": "Campbell" }, {},An empty profile serves no purpose -- it shows up in the list as being
named "Default", and it only launches CMD (unless the commandline is the
thing that the user successfully changed.)
We can heal the settings file by simply ignoring those profiles that
have no identifying information (a guid or a name that can be
converted into a guid).
Validation
I created a number of profiles that fit this format and made sure that
they were ignored on load and destroyed on save.
PR Checklist