From 9d8a87bc4a4e179417a08a16bcabbea95636fc0e Mon Sep 17 00:00:00 2001
From: "Eric Wong (PAX)" <eriwong@microsoft.com>
Date: Thu, 16 May 2019 18:07:57 -0700
Subject: [PATCH] Telemetry for visual state

---
 src/CalcViewModel/Common/TraceLogger.cpp     | 47 +++++++++++++-------
 src/CalcViewModel/Common/TraceLogger.h       |  1 +
 src/Calculator/App.xaml                      |  3 +-
 src/Calculator/App.xaml.h                    |  2 +-
 src/Calculator/Views/Calculator.xaml         |  4 +-
 src/Calculator/Views/Calculator.xaml.cpp     |  7 +++
 src/Calculator/Views/Calculator.xaml.h       |  1 +
 src/Calculator/Views/DateCalculator.xaml     |  2 +-
 src/Calculator/Views/DateCalculator.xaml.cpp |  6 +++
 src/Calculator/Views/DateCalculator.xaml.h   |  1 +
 src/Calculator/Views/UnitConverter.xaml      |  2 +-
 src/Calculator/Views/UnitConverter.xaml.cpp  |  8 ++++
 src/Calculator/Views/UnitConverter.xaml.h    |  1 +
 13 files changed, 61 insertions(+), 24 deletions(-)

diff --git a/src/CalcViewModel/Common/TraceLogger.cpp b/src/CalcViewModel/Common/TraceLogger.cpp
index bb1ca7bd..d97555c9 100644
--- a/src/CalcViewModel/Common/TraceLogger.cpp
+++ b/src/CalcViewModel/Common/TraceLogger.cpp
@@ -79,6 +79,7 @@ namespace CalculatorApp
     constexpr auto EVENT_NAME_DATE_CALCULATION_MODE_USED = L"DateCalculationModeUsed";
     constexpr auto EVENT_NAME_HISTORY_ITEM_LOAD = L"HistoryItemLoad";
     constexpr auto EVENT_NAME_MEMORY_ITEM_LOAD = L"MemoryItemLoad";
+    constexpr auto EVENT_NAME_VISUAL_STATE_CHANGED = L"VisualStateChanged";
 
     constexpr auto EVENT_NAME_EXCEPTION = L"Exception";
 
@@ -102,14 +103,14 @@ namespace CalculatorApp
 
     TraceLogger::TraceLogger()
         : g_calculatorProvider(
-            L"MicrosoftCalculator",
-            LoggingChannelOptions(GUID{ 0x4f50731a, 0x89cf, 0x4782, 0xb3, 0xe0, 0xdc, 0xe8, 0xc9, 0x4, 0x76, 0xba }), // Microsoft Telemetry group
-            GUID{ 0x905ca09, 0x610e, 0x401e, 0xb6, 0x50, 0x2f, 0x21, 0x29, 0x80, 0xb9, 0xe0 })
+              L"MicrosoftCalculator",
+              LoggingChannelOptions(GUID{ 0x4f50731a, 0x89cf, 0x4782, 0xb3, 0xe0, 0xdc, 0xe8, 0xc9, 0x4, 0x76, 0xba }), // Microsoft Telemetry group
+              GUID{ 0x905ca09, 0x610e, 0x401e, 0xb6, 0x50, 0x2f, 0x21, 0x29, 0x80, 0xb9, 0xe0 })
         , // Unique providerID {0905CA09-610E-401E-B650-2F212980B9E0}
         m_appLaunchActivity{ nullptr }
     {
         // initialize the function array
-//        InitFunctionLogArray();
+        //        InitFunctionLogArray();
     }
 
     TraceLogger::~TraceLogger()
@@ -229,6 +230,19 @@ namespace CalculatorApp
         }
     }
 
+    void TraceLogger::LogVisualStateChanged(ViewMode mode, wstring_view state) const
+    {
+        if (!GetTraceLoggingProviderEnabled())
+        {
+            return;
+        }
+
+        LoggingFields fields{};
+        fields.AddString(L"CalculatorMode", NavCategory::GetFriendlyName(mode)->Data());
+        fields.AddString(L"VisualState", state);
+        LogLevel2Event(EVENT_NAME_VISUAL_STATE_CHANGED, fields);
+    }
+
     // call comes here at the time of ApplicationViewModel initialisation
     void TraceLogger::LogCalculatorModeViewed(ViewMode mode, int windowId)
     {
@@ -767,9 +781,8 @@ namespace CalculatorApp
     {
         // Writer lock for the static resources
         reader_writer_lock::scoped_lock lock(s_traceLoggerLock);
-        vector<FuncLog>::iterator it = std::find_if(funcLog.begin(), funcLog.end(), [functionId, mode](const FuncLog& f) -> bool {
-            return f.functionId == functionId && f.mode == mode;
-        });
+        vector<FuncLog>::iterator it =
+            std::find_if(funcLog.begin(), funcLog.end(), [functionId, mode](const FuncLog& f) -> bool { return f.functionId == functionId && f.mode == mode; });
         if (it != funcLog.end())
         {
             it->count++;
@@ -781,7 +794,7 @@ namespace CalculatorApp
         }
     }
 
-    //void TraceLogger::InitFunctionLogArray()
+    // void TraceLogger::InitFunctionLogArray()
     //{
     //    int i = -1;
     //    for (int funcIndex = 0; funcIndex != maxFunctionSize; funcIndex++)
@@ -808,15 +821,15 @@ namespace CalculatorApp
         return s_programmerType[0];
     }
 
-   /* bool TraceLogger::GetIndex(int& index)
-    {
-        if (findIndex[index] > 0)
-        {
-            index = findIndex[index];
-            return true;
-        }
-        return false;
-    }*/
+    /* bool TraceLogger::GetIndex(int& index)
+     {
+         if (findIndex[index] > 0)
+         {
+             index = findIndex[index];
+             return true;
+         }
+         return false;
+     }*/
 
     void TraceLogger::UpdateWindowCount(size_t windowCount)
     {
diff --git a/src/CalcViewModel/Common/TraceLogger.h b/src/CalcViewModel/Common/TraceLogger.h
index b908145a..304de6b2 100644
--- a/src/CalcViewModel/Common/TraceLogger.h
+++ b/src/CalcViewModel/Common/TraceLogger.h
@@ -87,6 +87,7 @@ namespace CalculatorApp
         void LogAppPrelaunchedBySystem();
         void UpdateWindowCount(size_t windowCount);
         bool UpdateWindowIdLog(int windowId);
+        void LogVisualStateChanged(CalculatorApp::Common::ViewMode mode, std::wstring_view state) const;
         void LogMaxWindowCount();
         void LogWindowActivated() const;
         void LogWindowLaunched() const;
diff --git a/src/Calculator/App.xaml b/src/Calculator/App.xaml
index 918034c0..50c05eca 100644
--- a/src/Calculator/App.xaml
+++ b/src/Calculator/App.xaml
@@ -353,8 +353,7 @@
                 <Setter Property="ZoomMode" Value="Disabled"/>
             </Style>
 
-            <Style x:Key="CalculationResultStyle"
-                   TargetType="Controls:CalculationResult">
+            <Style x:Key="CalculationResultStyle" TargetType="Controls:CalculationResult">
                 <Setter Property="Background" Value="Transparent"/>
                 <Setter Property="Foreground" Value="{ThemeResource SystemControlPageTextBaseHighBrush}"/>
                 <Setter Property="HorizontalAlignment" Value="Stretch"/>
diff --git a/src/Calculator/App.xaml.h b/src/Calculator/App.xaml.h
index 1de1aa8c..79c38e25 100644
--- a/src/Calculator/App.xaml.h
+++ b/src/Calculator/App.xaml.h
@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
 //
diff --git a/src/Calculator/Views/Calculator.xaml b/src/Calculator/Views/Calculator.xaml
index dffa3270..ead6a425 100644
--- a/src/Calculator/Views/Calculator.xaml
+++ b/src/Calculator/Views/Calculator.xaml
@@ -35,7 +35,7 @@
         </DataTemplate>
 
         <!-- TextBox Styles -->
-               
+
         <Style TargetType="controls:OverflowTextBlock">
             <Setter Property="HorizontalAlignment" Value="Stretch"/>
             <Setter Property="Template">
@@ -319,7 +319,7 @@
                 </VisualState>
             </VisualStateGroup>
             <!-- Layout specific -->
-            <VisualStateGroup>
+            <VisualStateGroup CurrentStateChanged="OnVisualStateChanged">
                 <VisualState x:Name="Portrait768x1366">
                     <VisualState.StateTriggers>
                         <AdaptiveTrigger MinWindowHeight="1366" MinWindowWidth="768"/>
diff --git a/src/Calculator/Views/Calculator.xaml.cpp b/src/Calculator/Views/Calculator.xaml.cpp
index 5dc424de..31e696ac 100644
--- a/src/Calculator/Views/Calculator.xaml.cpp
+++ b/src/Calculator/Views/Calculator.xaml.cpp
@@ -713,3 +713,10 @@ void CalculatorApp::Calculator::DockPivot_SelectionChanged(Platform::Object ^ se
         TraceLogger::GetInstance().LogMemoryBodyOpened();
     }
 }
+
+void CalculatorApp::Calculator::OnVisualStateChanged(Platform::Object ^ sender, Windows::UI::Xaml::VisualStateChangedEventArgs ^ e)
+{
+    auto mode = IsStandard ? ViewMode::Standard : IsScientific ? ViewMode::Scientific : ViewMode::Programmer;
+    auto state = std::wstring(e->NewState->Name->Begin());
+    TraceLogger::GetInstance().LogVisualStateChanged(mode, state);
+}
diff --git a/src/Calculator/Views/Calculator.xaml.h b/src/Calculator/Views/Calculator.xaml.h
index 3814e4ac..44ce8477 100644
--- a/src/Calculator/Views/Calculator.xaml.h
+++ b/src/Calculator/Views/Calculator.xaml.h
@@ -139,5 +139,6 @@ public
         void OnHistoryAccessKeyInvoked(_In_ Windows::UI::Xaml::UIElement ^ sender, _In_ Windows::UI::Xaml::Input::AccessKeyInvokedEventArgs ^ args);
         void OnMemoryAccessKeyInvoked(_In_ Windows::UI::Xaml::UIElement ^ sender, _In_ Windows::UI::Xaml::Input::AccessKeyInvokedEventArgs ^ args);
         void DockPivot_SelectionChanged(Platform::Object ^ sender, Windows::UI::Xaml::Controls::SelectionChangedEventArgs ^ e);
+        void OnVisualStateChanged(Platform::Object ^ sender, Windows::UI::Xaml::VisualStateChangedEventArgs ^ e);
     };
 }
diff --git a/src/Calculator/Views/DateCalculator.xaml b/src/Calculator/Views/DateCalculator.xaml
index 7f627557..c3ca8a88 100644
--- a/src/Calculator/Views/DateCalculator.xaml
+++ b/src/Calculator/Views/DateCalculator.xaml
@@ -358,7 +358,7 @@
         </Grid.RowDefinitions>
 
         <VisualStateManager.VisualStateGroups>
-            <VisualStateGroup>
+            <VisualStateGroup CurrentStateChanged="OnVisualStateChanged">
                 <VisualState x:Name="LeftAlignedLayout">
                     <VisualState.StateTriggers>
                         <AdaptiveTrigger MinWindowWidth="480"/>
diff --git a/src/Calculator/Views/DateCalculator.xaml.cpp b/src/Calculator/Views/DateCalculator.xaml.cpp
index 141d65cb..e28e3a93 100644
--- a/src/Calculator/Views/DateCalculator.xaml.cpp
+++ b/src/Calculator/Views/DateCalculator.xaml.cpp
@@ -240,3 +240,9 @@ void DateCalculator::AddSubtractOption_Checked(_In_ Object ^ sender, _In_ Routed
 {
     RaiseLiveRegionChangedAutomationEvent(/* DateDiff mode */ false);
 }
+
+void CalculatorApp::DateCalculator::OnVisualStateChanged(Platform::Object ^ sender, Windows::UI::Xaml::VisualStateChangedEventArgs ^ e)
+{
+    auto state = std::wstring(e->NewState->Name->Begin());
+    TraceLogger::GetInstance().LogVisualStateChanged(ViewMode::Date, state);
+}
diff --git a/src/Calculator/Views/DateCalculator.xaml.h b/src/Calculator/Views/DateCalculator.xaml.h
index e158b937..994029e2 100644
--- a/src/Calculator/Views/DateCalculator.xaml.h
+++ b/src/Calculator/Views/DateCalculator.xaml.h
@@ -50,5 +50,6 @@ namespace CalculatorApp
         void RaiseLiveRegionChangedAutomationEvent(_In_ bool isDateDiffMode);
 
         Windows::Foundation::EventRegistrationToken m_dateCalcOptionChangedEventToken;
+        void OnVisualStateChanged(Platform::Object ^ sender, Windows::UI::Xaml::VisualStateChangedEventArgs ^ e);
     };
 }
diff --git a/src/Calculator/Views/UnitConverter.xaml b/src/Calculator/Views/UnitConverter.xaml
index a1a0a8d0..a26be3f6 100644
--- a/src/Calculator/Views/UnitConverter.xaml
+++ b/src/Calculator/Views/UnitConverter.xaml
@@ -343,7 +343,7 @@
                     </VisualState.Setters>
                 </VisualState>
             </VisualStateGroup>
-            <VisualStateGroup x:Name="Sizing">
+            <VisualStateGroup x:Name="Sizing" CurrentStateChanged="OnVisualStateChanged">
                 <VisualState x:Name="Wide">
                     <VisualState.StateTriggers>
                         <AdaptiveTrigger MinWindowHeight="768" MinWindowWidth="1280"/>
diff --git a/src/Calculator/Views/UnitConverter.xaml.cpp b/src/Calculator/Views/UnitConverter.xaml.cpp
index a9d2e571..0eecc61c 100644
--- a/src/Calculator/Views/UnitConverter.xaml.cpp
+++ b/src/Calculator/Views/UnitConverter.xaml.cpp
@@ -6,6 +6,7 @@
 
 #include "pch.h"
 #include "UnitConverter.xaml.h"
+#include "CalcViewModel/Common/TraceLogger.h"
 #include "CalcViewModel/UnitConverterViewModel.h"
 #include "Controls/CalculationResult.h"
 #include "Controls/CalculatorButton.h"
@@ -368,3 +369,10 @@ void CalculatorApp::UnitConverter::SupplementaryResultsPanelInGrid_SizeChanged(P
     // We add 0.01 to be sure to not create an infinite loop with SizeChanged events cascading due to float approximation
     RowDltrUnits->MinHeight = max(48.0, e->NewSize.Height + 0.01);
 }
+
+void CalculatorApp::UnitConverter::OnVisualStateChanged(Platform::Object ^ sender, Windows::UI::Xaml::VisualStateChangedEventArgs ^ e)
+{
+    auto mode = NavCategory::Deserialize(Model->CurrentCategory->GetModelCategory().id);
+    auto state = std::wstring(e->NewState->Name->Begin());
+    TraceLogger::GetInstance().LogVisualStateChanged(mode, state);
+}
diff --git a/src/Calculator/Views/UnitConverter.xaml.h b/src/Calculator/Views/UnitConverter.xaml.h
index efe870c6..dacb24aa 100644
--- a/src/Calculator/Views/UnitConverter.xaml.h
+++ b/src/Calculator/Views/UnitConverter.xaml.h
@@ -89,5 +89,6 @@ namespace CalculatorApp
 
         bool m_isAnimationEnabled;
         void SupplementaryResultsPanelInGrid_SizeChanged(Platform::Object ^ sender, Windows::UI::Xaml::SizeChangedEventArgs ^ e);
+        void OnVisualStateChanged(Platform::Object ^ sender, Windows::UI::Xaml::VisualStateChangedEventArgs ^ e);
     };
 }