Add Serializer to CascadiaSettings #8018

carlos-zamora · 2020-10-22T23:15:40Z

Summary of the Pull Request

This adds ToJson functions to Profile, GlobalAppSettings, and ColorScheme. They are used in CascadiaSettings to completely serialize an instance of the settings model. Thanks to #7923, all of the settings are std::optional, and JsonUtils only writes out values that are actually populated.

CascadiaSettings::WriteSettingsToDisk serializes the current settings and writes them to the settings.json. A backup file is created with your old contents.

Limitations:

all of the color schemes are serialized regardless of them coming from defaults.json or settings.json
keybindings/actions are copied/pasted

References

#1564 - Settings UI
TSM Specs (#6904 and #7876)

PR Checklist

Tests added/passed

## Summary of the Pull Request This PR replaces `CascadiaSettings::_profiles` with... - `_allProfiles`: the list of all available profiles in the settings model (i.e. settings.json, dynamic profiles, etc...) - `_activeProfiles`: the list of all non-hidden profiles (used for the new tab dropdown) ## References #8018: maintaining a list of all profiles allows us to serialize hidden profiles #1564: Settings UI can link to `AllProfiles()` instead of `ActiveProfiles()` to expose hidden profiles ## PR Checklist * [x] Closes #4139 * [x] Tests added/passed ## Validation Steps Performed Deploy and testing succeeded

DHowett · 2020-10-28T16:28:10Z

If you know that a PR targets another branch, you may need to not use automerge ;)

This reverts commit 17e5fb4.

Co-authored-by: Dustin L. Howett <duhowett@microsoft.com>

src/cascadia/TerminalSettingsModel/CascadiaSettingsSerialization.cpp

…crosoft/Terminal into dev/cazamor/tsm/serialization

The JsonUtils changes in #8018 revealed that we need more robust, configurable optional handling. We learned that there's a class of values that was previously underrepresented in our API: _strings that have an explicit empty value_. The Settings model supports starting directory, icon, background image et al values that are empty. That emptiness _overrides_ a value set in a lower layer, so it is not sufficient to represent the empty value for any one of those fields as an unset optional. There are a couple other settings for which we've implemented a hand-rolled option type (for roughly the same reason): foreground, background, any color fields that override values from the color scheme _or_ the lower layer profile. These requirements are best fulfilled by better optional support in JsonUtils. Where the library would originally detect known types of optional and pre-filter them out during `GetValue` and `SetValue`, it will now defer to another conversion trait. This commit introduces a helper conversion trait and an "option oracle". The conversion trait will use the option oracle to detect emptiness, generate empty option values, and read values out of option types. In so doing, the trait is insulated from the implementation details of any specific option type. Any special logic for handling JSON null and option types has been stripped from GetValue. Due to this, there is an express change in behavior for some converters: * `GetValue<T>(jsonNull)` where `T` is **not** an option type[1] has been upgraded from a silent no-op to an exception. Further, I took the opportunity to replace NullableSetting with std::optional<std::optional<T>>, which accurately represents "setting that the user might explicitly clear". I've added a test to JsonUtilsTests to make sure it can serialize/deserialize double optionals the way we expect it to. Tests (Local, Unit for TerminalApp/SettingsModel): Summary: Total=140, Passed=140, Failed=0, Blocked=0, Not Run=0, Skipped=0 [1]: Explicitly, if `T` is not an option type _and the converter does not support null_.

…lization # Conflicts: # src/cascadia/TerminalSettingsModel/JsonUtils.h

src/cascadia/TerminalSettingsModel/Profile.cpp

DHowett · 2020-11-11T20:14:40Z

src/cascadia/TerminalSettingsModel/CascadiaSettingsSerialization.cpp

+
+    // write current settings to current settings file
+    const auto json{ ToJson() };
+    _WriteSettings(json.toStyledString(), settingsPath);


i hope to heck that this doesn't use the json format with the spaces before the colons for some reason

Yeah. Just switched to a StreamWriterBuilder. Looks better now. The only thing that really bugs me, is that everything is written in alphabetical order. So we'll get some global settings written all the way at the bottom.

src/cascadia/TerminalSettingsModel/CascadiaSettingsSerialization.cpp

src/cascadia/TerminalSettingsModel/GlobalAppSettings.cpp

DHowett · 2020-11-11T20:19:14Z

src/cascadia/TerminalSettingsModel/Profile.cpp

@@ -291,6 +291,7 @@ void Profile::LayerJson(const Json::Value& json)
    JsonUtils::GetValueForKey(json, NameKey, _Name);
    JsonUtils::GetValueForKey(json, GuidKey, _Guid);
    JsonUtils::GetValueForKey(json, HiddenKey, _Hidden);
+    JsonUtils::GetValueForKey(json, SourceKey, _Source);


Why did you remove it? Why had you added it? It seems very important to serialize it, but i’m surprised it wasn’t there before

Don’t just go deleting lines of code because someone commented on them!

Oof. I forgot to run the tests anyways. So, this is interesting. I looked through the history of Profile.cpp and it looks like it was always missing (checked the inheritance and winrt-ification PRs). But, we need this so that the following roundtrip test passes:

{ "name": "Weird Profile", "tabColor": null, "foreground": null, "source": "local" }

I think we just always relied on source being set by the dynamic profile generator, so we never had to care. But now with inheritance and serialization, we need this? Still a bit weird because really the user shouldn't be setting a source, Terminal should. Thoughts? Is this even a valid test?

it was set by "generateStub", if I recall correctly.

If there is a source, it must be present in the user's settings.

because source is part of the primary key we use to match up dynamic profiles.

Ok. Then I added it back in.

DHowett

Lets do this

ghost · 2020-11-17T00:37:01Z

Hello @DHowett!

Because this pull request has the AutoMerge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

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 (`@msftbot`) and give me an instruction to get started! Learn more here.

## Summary of the Pull Request Adds an event handler for the Save and Reset buttons. "Save" writes the settings to disk using the API introduced by #8018. "Reset" simply overwrites the `settingsClone` (what the Settings UI reads from) with `settingsSource` (provided by TermApp on Settings UI initialization). ## References #1564 - Settings UI ## Validation Steps Performed The following scenarios were tested and are verified to work properly: - Change default profile in SUI, then save/reset - Hide a profile, then save/reset - Modifying the settings.json directly propagates changes to SUI - "Reset" updates the current page

This comment has been minimized.

Sign in to view

ghost closed this Oct 27, 2020

ghost deleted the branch main October 27, 2020 17:35

carlos-zamora reopened this Oct 27, 2020

carlos-zamora force-pushed the dev/cazamor/tsm/serialization branch from 14bf652 to 3104f7a Compare October 27, 2020 17:43

carlos-zamora changed the base branch from dev/cazamor/tsm/inheritance to main October 27, 2020 17:44

carlos-zamora force-pushed the dev/cazamor/tsm/serialization branch from 3104f7a to b7e7ca6 Compare October 27, 2020 17:46

carlos-zamora mentioned this pull request Oct 28, 2020

Store and expose hidden profiles #8070

Merged

2 tasks

carlos-zamora force-pushed the dev/cazamor/tsm/serialization branch from 17e5fb4 to f0b2c01 Compare October 28, 2020 07:07

carlos-zamora changed the base branch from main to dev/cazamor/tsm/hidden-vs-active-profiles October 28, 2020 07:07

carlos-zamora force-pushed the dev/cazamor/tsm/serialization branch from f0b2c01 to e9cd2dc Compare October 28, 2020 07:18

carlos-zamora marked this pull request as ready for review October 28, 2020 07:28

zadjii-msft self-assigned this Oct 28, 2020

ghost closed this Oct 28, 2020

ghost deleted the branch main October 28, 2020 16:22

carlos-zamora added 9 commits October 28, 2020 09:52

Add Serializer to CascadiaSettings

48d8d06

fix up new tests (mostly)

a3695fa

only perform guid generation in getter

5db3d03

serialize hidden shells

8ba6394

Revert "serialize hidden shells"

e6b1bef

This reverts commit 17e5fb4.

fix tests

fda5ddd

polish

5833bb9

fix unit test

df10fc4

add Export()

6bb948f

carlos-zamora reopened this Oct 28, 2020

carlos-zamora force-pushed the dev/cazamor/tsm/serialization branch from fdca404 to 6bb948f Compare October 28, 2020 16:53

carlos-zamora changed the base branch from dev/cazamor/tsm/hidden-vs-active-profiles to main October 28, 2020 16:54

carlos-zamora and others added 2 commits November 5, 2020 16:47

timestamp the backup file

c4f2733

remove a semicolon

dd04469

Co-authored-by: Dustin L. Howett <duhowett@microsoft.com>

DHowett reviewed Nov 6, 2020

View reviewed changes

src/cascadia/TerminalSettingsModel/CascadiaSettingsSerialization.cpp Outdated Show resolved Hide resolved

carlos-zamora added 5 commits November 6, 2020 10:47

make timestamp look right

c51f9b4

Merge branch 'dev/cazamor/tsm/serialization' of https://github.com/mi…

92dc467

…crosoft/Terminal into dev/cazamor/tsm/serialization

spellcheck

29f7769

Merge branch 'main' into dev/cazamor/tsm/serialization

8db53af

propagate 'useTabSwitcher'-->'tabSwitcherMode' change

125860e

DHowett mentioned this pull request Nov 6, 2020

Rework JsonUtils' optional handling to let Converters see null #8175

Merged

Merge remote-tracking branch 'origin/main' into dev/cazamor/tsm/seria…

ecf88ae

…lization # Conflicts: # src/cascadia/TerminalSettingsModel/JsonUtils.h

DHowett reviewed Nov 9, 2020

View reviewed changes

src/cascadia/TerminalSettingsModel/Profile.cpp Outdated Show resolved Hide resolved

remove unnecessary comment

4c058e2

carlos-zamora assigned DHowett and unassigned carlos-zamora Nov 11, 2020

DHowett reviewed Nov 11, 2020

View reviewed changes

src/cascadia/TerminalSettingsModel/CascadiaSettingsSerialization.cpp Outdated Show resolved Hide resolved

DHowett requested changes Nov 11, 2020

View reviewed changes

ghost added Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something and removed Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something labels Nov 11, 2020

carlos-zamora added 2 commits November 13, 2020 14:23

polish writing settings to disk (verified)

0c5aedb

deserialize source

5d7fc4a

DHowett approved these changes Nov 17, 2020

View reviewed changes

DHowett added the AutoMerge Marked for automatic merge by the bot when requirements are met label Nov 17, 2020

ghost merged commit 6b503ba into main Nov 17, 2020

ghost deleted the dev/cazamor/tsm/serialization branch November 17, 2020 00:37

DHowett mentioned this pull request Nov 17, 2020

Add a setting to flash the taskbar when the terminal emits BEL #8215

Merged

carlos-zamora mentioned this pull request Nov 20, 2020

Hook up the Save and Reset buttons #8348

Merged

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Serializer to CascadiaSettings #8018

Add Serializer to CascadiaSettings #8018

carlos-zamora commented Oct 22, 2020 •

edited

Loading

This comment has been minimized.

This comment has been minimized.

DHowett commented Oct 28, 2020 •

edited

Loading

DHowett Nov 11, 2020

carlos-zamora Nov 13, 2020

DHowett Nov 11, 2020

carlos-zamora Nov 13, 2020

DHowett Nov 13, 2020

carlos-zamora Nov 13, 2020

DHowett Nov 13, 2020

DHowett Nov 13, 2020

carlos-zamora Nov 13, 2020

DHowett left a comment

ghost commented Nov 17, 2020

Add Serializer to CascadiaSettings #8018

Add Serializer to CascadiaSettings #8018

Conversation

carlos-zamora commented Oct 22, 2020 • edited Loading

Summary of the Pull Request

Limitations:

References

PR Checklist

This comment has been minimized.

This comment has been minimized.

DHowett commented Oct 28, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DHowett left a comment

Choose a reason for hiding this comment

ghost commented Nov 17, 2020

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 (@msftbot) and give me an instruction to get started! Learn more here.

carlos-zamora commented Oct 22, 2020 •

edited

Loading

DHowett commented Oct 28, 2020 •

edited

Loading

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 (`@msftbot`) and give me an instruction to get started! Learn more here.