Skip to content

Commit

Permalink
Serialize stub for dynamic profiles (#9964)
Browse files Browse the repository at this point in the history
#9962 was caused by a serialization bug. _Technically_, `ToJson` works
as intended: if the current layer has any values set, write them out to
the json. However, on first load, the dynamic profile `Profile` objects
are actually empty (because they inherit from base layer, then the
dynamic profile generator). This means that `ToJson` writes the dynamic
profiles as empty objects `{}`. Then, on reload, we see that the dynamic
profiles aren't in the JSON, and we write them again.

To get around this issue, we added a simple check to `Profile::ToJson`:
if we have a source, make sure we write out the name, guid, hidden, and
source. This is intended to align with `Profile::GenerateStub`.

Closes #9962

(cherry picked from commit 8f93f76)
  • Loading branch information
carlos-zamora authored and DHowett committed May 14, 2021
1 parent e3ecc4d commit e8fff83
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions src/cascadia/TerminalSettingsModel/Profile.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -485,11 +485,16 @@ Json::Value Profile::ToJson() const
{
Json::Value json{ Json::ValueType::objectValue };

// GH #9962:
// If the settings.json was missing, when we load the dynamic profiles, they are completely empty.
// This caused us to serialize empty profiles "{}" on accident.
const bool writeBasicSettings{ !Source().empty() };

// Profile-specific Settings
JsonUtils::SetValueForKey(json, NameKey, _Name);
JsonUtils::SetValueForKey(json, GuidKey, _Guid);
JsonUtils::SetValueForKey(json, HiddenKey, _Hidden);
JsonUtils::SetValueForKey(json, SourceKey, _Source);
JsonUtils::SetValueForKey(json, NameKey, writeBasicSettings ? Name() : _Name);
JsonUtils::SetValueForKey(json, GuidKey, writeBasicSettings ? Guid() : _Guid);
JsonUtils::SetValueForKey(json, HiddenKey, writeBasicSettings ? Hidden() : _Hidden);
JsonUtils::SetValueForKey(json, SourceKey, writeBasicSettings ? Source() : _Source);

// Core Settings
JsonUtils::SetValueForKey(json, ForegroundKey, _Foreground);
Expand Down

0 comments on commit e8fff83

Please sign in to comment.