Fix broken reset button on some profile settings by carlos-zamora · Pull Request #12275 · microsoft/terminal

carlos-zamora · 2022-01-27T22:06:21Z

Summary of the Pull Request

This fixes a bug where several settings would not show the reset button. The root cause of this issue is two fold:

Hooking up CurrentXXX
- GETSET_BINDABLE_ENUM_SETTING was hooked up to the settings model profile object instead of the view model profile object. Since the settings model has no PropertyChanged system, any changes were directly being applied to the setting, but not notifying the view model (and thus, the view, by extension) to update themselves.
- This fix required me to slightly modify the macro. Rather than using two parameters (object and function name), I used one parameter (path to getter/setter).
Responding to the PropertyChanged notifications
- Now that we're actually dispatching the PropertyChanged notifications, we need to actually respond to them. This behavior was defined in Profiles::OnNavigatedTo() in the PropertyChanged() handler. Funny enough, that code was still there, it just didn't do anything because it was trying to notify that Profiles::CurrentXXX changed. This is invalid because CurrentXXX got moved to ProfileViewModel.
- The fix here was pretty easy. Just move the property changed handler to ProfileViewModel's PropertyChanged handler that is defined in the ctor.

References

Bug introduced in #11877

Validation Steps Performed

✅ Profile termination behavior
✅ Bell notification style
✅ Text antialiasing
✅ Scrollbar visibility

carlos-zamora · 2022-01-27T22:07:03Z

src/cascadia/TerminalSettingsEditor/ProfileViewModel.cpp

+            else if (viewModelProperty == L"AntialiasingMode")
+            {
+                _NotifyChanges(L"CurrentAntiAliasingMode");
+            }
+            else if (viewModelProperty == L"CloseOnExit")
+            {
+                _NotifyChanges(L"CurrentCloseOnExitMode");
+            }
+            else if (viewModelProperty == L"BellStyle")
+            {
+                _NotifyChanges(L"IsBellStyleFlagSet");
+            }
+            else if (viewModelProperty == L"ScrollState")
+            {
+                _NotifyChanges(L"CurrentScrollState");
+            }


This got moved over from Profiles.cpp.

This is step 2 of my PR description.

carlos-zamora · 2022-01-27T22:07:50Z

src/cascadia/TerminalSettingsEditor/ProfileViewModel.h

+        GETSET_BINDABLE_ENUM_SETTING(AntiAliasingMode, Microsoft::Terminal::Control::TextAntialiasingMode, AntialiasingMode);
+        GETSET_BINDABLE_ENUM_SETTING(CloseOnExitMode, Microsoft::Terminal::Settings::Model::CloseOnExitMode, CloseOnExit);
+        GETSET_BINDABLE_ENUM_SETTING(ScrollState, Microsoft::Terminal::Control::ScrollbarState, ScrollState);


Had to move this down so that it could find the getters/setters defined in the OBSERVABLE_PROJECTED_SETTING macros above.

Do you want to leave a comment that says "don't shuffle this section up or you're gonna have a bad time?"

Eh, if somebody moves them, the errors are pretty clear. So I think it's fine.

carlos-zamora · 2022-01-27T22:08:18Z

src/cascadia/TerminalSettingsEditor/Utils.h

+#define GETSET_BINDABLE_ENUM_SETTING(name, enumType, viewModelSettingGetSet)                                                             \
+public:                                                                                                                                  \
+    winrt::Windows::Foundation::Collections::IObservableVector<winrt::Microsoft::Terminal::Settings::Editor::EnumEntry> name##List()     \
+    {                                                                                                                                    \
+        return _##name##List;                                                                                                            \
+    }                                                                                                                                    \
+                                                                                                                                         \
+    winrt::Windows::Foundation::IInspectable Current##name()                                                                             \
+    {                                                                                                                                    \
+        return winrt::box_value<winrt::Microsoft::Terminal::Settings::Editor::EnumEntry>(_##name##Map.Lookup(viewModelSettingGetSet())); \
+    }                                                                                                                                    \
+                                                                                                                                         \
+    void Current##name(const winrt::Windows::Foundation::IInspectable& enumEntry)                                                        \
+    {                                                                                                                                    \
+        if (auto ee = enumEntry.try_as<winrt::Microsoft::Terminal::Settings::Editor::EnumEntry>())                                       \
+        {                                                                                                                                \
+            auto setting = winrt::unbox_value<enumType>(ee.EnumValue());                                                                 \
+            viewModelSettingGetSet(setting);                                                                                             \
+        }                                                                                                                                \
+    }                                                                                                                                    \


This change is what I was talking about in step 1 of my PR description.

miniksa · 2022-01-27T22:40:54Z

src/cascadia/TerminalSettingsEditor/ProfileViewModel.cpp

                    Opacity(1.0);
                }
            }
+            else if (viewModelProperty == L"AntialiasingMode")


Just double checking... the property is "Antialiasing" (with the "A" of "aliasing") being lowercase while the Notification string is "AntiAliasing" (with a capital "A")?

It may very well have already been like that and you just copy/pasted... but I'm just checking as it stood out to me.

Yeah, I was actually really surprised this worked haha.

miniksa · 2022-01-27T22:41:26Z

src/cascadia/TerminalSettingsEditor/ProfileViewModel.h

+        GETSET_BINDABLE_ENUM_SETTING(AntiAliasingMode, Microsoft::Terminal::Control::TextAntialiasingMode, AntialiasingMode);
+        GETSET_BINDABLE_ENUM_SETTING(CloseOnExitMode, Microsoft::Terminal::Settings::Model::CloseOnExitMode, CloseOnExit);
+        GETSET_BINDABLE_ENUM_SETTING(ScrollState, Microsoft::Terminal::Control::ScrollbarState, ScrollState);


Do you want to leave a comment that says "don't shuffle this section up or you're gonna have a bad time?"

miniksa · 2022-01-27T22:41:42Z

src/cascadia/TerminalSettingsEditor/Profiles.cpp

        // and propagate those changes to the UI
        _ViewModelChangedRevoker = _Profile.PropertyChanged(winrt::auto_revoke, [=](auto&&, const PropertyChangedEventArgs& args) {
-            const auto settingName{ args.PropertyName() };
-            if (settingName == L"AntialiasingMode")


Oh yeah look the case mismatch was over here too. Ah well.

DHowett · 2022-01-27T23:26:59Z

build is failing but i am going to mark automerge anyway -- let's get this in!

ghost · 2022-01-27T23:27:15Z

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.

Do note that I've been instructed to only help merge pull requests of this repository that have been opened for at least 8 hours, a condition that will be fulfilled in about 6 hours 39 minutes. No worries though, I will be back when the time is right! 😉

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.

DHowett · 2022-01-27T23:27:22Z

@msftbot merge this in 5 minutes

ghost · 2022-01-27T23:27:25Z

Hello @DHowett!

Because you've given me some instructions on how to help merge this pull request, I'll be modifying my merge approach. Here's how I understand your requirements for merging this pull request:

I won't merge this pull request until after the UTC date Thu, 27 Jan 2022 23:32:25 GMT, which is in 5 minutes

If this doesn't seem right to you, you can tell me to cancel these instructions and use the auto-merge policy that has been configured for this repository. Try telling me "forget everything I just told you".

This fixes a bug where several settings would not show the reset button. The root cause of this issue is two fold: 1. Hooking up `CurrentXXX` - `GETSET_BINDABLE_ENUM_SETTING` was hooked up to the **settings** model profile object instead of the **view** model profile object. Since the settings model has no `PropertyChanged` system, any changes were directly being applied to the setting, but not notifying the view model (and thus, the view, by extension) to update themselves. - This fix required me to slightly modify the macro. Rather than using two parameters (object and function name), I used one parameter (path to getter/setter). 2. Responding to the `PropertyChanged` notifications - Now that we're actually dispatching the `PropertyChanged` notifications, we need to actually respond to them. This behavior was defined in `Profiles::OnNavigatedTo()` in the `PropertyChanged()` handler. Funny enough, that code was still there, it just didn't do anything because it was trying to notify that `Profiles::CurrentXXX` changed. This is invalid because `CurrentXXX` got moved to `ProfileViewModel`. - The fix here was pretty easy. Just move the property changed handler to `ProfileViewModel`'s `PropertyChanged` handler that is defined in the ctor. Bug introduced in #11877 ✅ Profile termination behavior ✅ Bell notification style ✅ Text antialiasing ✅ Scrollbar visibility

Fix broken reset button on some profile settings

ce33661

carlos-zamora added the zPreview-Service-Consider label Jan 27, 2022

carlos-zamora commented Jan 27, 2022

View reviewed changes

miniksa approved these changes Jan 27, 2022

View reviewed changes

DHowett approved these changes Jan 27, 2022

View reviewed changes

DHowett added the AutoMerge Marked for automatic merge by the bot when requirements are met label Jan 27, 2022

fix unreferenced formal param

aac7bb8

ghost merged commit 2db4cba into main Jan 28, 2022

ghost deleted the dev/cazamor/bugfix-sui-mvvm-reset-btn branch January 28, 2022 00:13

DHowett removed the zPreview-Service-Consider label Jan 31, 2022

zadjii-msft mentioned this pull request Mar 15, 2022

Merge the Windows 11 styles into 1.12 #12696

Merged

This pull request was closed.

Conversation

carlos-zamora commented Jan 27, 2022

Summary of the Pull Request

References

Validation Steps Performed

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DHowett commented Jan 27, 2022

Uh oh!

ghost commented Jan 27, 2022

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.

Uh oh!

DHowett commented Jan 27, 2022

Uh oh!

ghost commented Jan 27, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

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.