[FancyZones] Clasify strings in FancyZones to localizable and non-localizable (#5315)

* Clasify strings in FancyZones to localizable and non-localizable

* Address PR comments

* Better handling of FirePropertyChanged event

* Address PR comments

* Update properties

src/modules/fancyzones/lib/trace.cpp

@@ -5,9 +5,59 @@
 #include "lib/FancyZonesData.h"
 #include "lib/FancyZonesDataTypes.h"
 
+// Telemetry strings should not be localized.
+#define LoggingProviderKey "Microsoft.PowerToys"
+
+#define EventEnableFancyZonesKey "FancyZones_EnableFancyZones"
+#define EventKeyDownKey "FancyZones_OnKeyDown"
+#define EventZoneSettingsChangedKey "FancyZones_ZoneSettingsChanged"
+#define EventEditorLaunchKey "FancyZones_EditorLaunch"
+#define EventSettingsChangedKey "FancyZones_SettingsChanged"
+#define EventDesktopChangedKey "FancyZones_VirtualDesktopChanged"
+#define EventZoneWindowKeyUpKey "FancyZones_ZoneWindowKeyUp"
+#define EventMoveSizeEndKey "FancyZones_MoveSizeEnd"
+#define EventCycleActiveZoneSetKey "FancyZones_CycleActiveZoneSet"
+
+#define EventEnabledKey "Enabled"
+#define PressedKeyCodeKey "Hotkey"
+#define PressedWindowKey "WindowsKey"
+#define PressedControlKey "ControlKey"
+#define MoveSizeActionKey "InMoveSize"
+#define AppsInHistoryCountKey "AppsInHistoryCount"
+#define CustomZoneSetCountKey "CustomZoneSetCount"
+#define NumberOfZonesForEachCustomZoneSetKey "NumberOfZonesForEachCustomZoneSet"
+#define ActiveZoneSetsCountKey "ActiveZoneSetsCount"
+#define ActiveZoneSetsListKey "ActiveZoneSetsList"
+#define EditorLaunchValueKey "Value"
+#define ShiftDragKey "ShiftDrag"
+#define MouseSwitchKey "MouseSwitch"
+#define MoveWindowsOnDisplayChangeKey "MoveWindowsOnDisplayChange"
+#define FlashZonesOnZoneSetChangeKey "FlashZonesOnZoneSetChange"
+#define MoveWindowsOnZoneSetChangeKey "MoveWindowsOnZoneSetChange"
+#define OverrideSnapHotKeysKey "OverrideSnapHotKeys"
+#define MoveWindowAcrossMonitorsKey "MoveWindowAcrossMonitors"
+#define MoveWindowsToLastZoneOnAppOpeningKey "MoveWindowsToLastZoneOnAppOpening"
+#define OpenWindowOnActiveMonitorKey "OpenWindowOnActiveMonitor"
+#define RestoreSizeKey "RestoreSize"
+#define UseCursorPosOnEditorStartupKey "UseCursorPosOnEditorStartup"
+#define ShowZonesOnAllMonitorsKey "ShowZonesOnAllMonitors"
+#define SpanZonesAcrossMonitorsKey "SpanZonesAcrossMonitors"
+#define MakeDraggedWindowTransparentKey "MakeDraggedWindowTransparent"
+#define ZoneColorKey "ZoneColor"
+#define ZoneBorderColorKey "ZoneBorderColor"
+#define ZoneHighlightColorKey "ZoneHighlightColor"
+#define ZoneHighlightOpacityKey "ZoneHighlightOpacity"
+#define HotkeyKey "Hotkey"
+#define ExcludedAppsCountKey "ExcludedAppsCount"
+#define KeyboardValueKey "KeyboardValue"
+#define ActiveSetKey "ActiveSet"
+#define NumberOfZonesKey "NumberOfZones"
+#define NumberOfWindowsKey "NumberOfWindows"
+#define InputModeKey "InputMode"
+
 TRACELOGGING_DEFINE_PROVIDER(
     g_hProvider,
-    "Microsoft.PowerToys",
+    LoggingProviderKey,
     // {38e8889b-9731-53f5-e901-e8a7c1753074}
     (0x38e8889b, 0x9731, 0x53f5, 0xe9, 0x01, 0xe8, 0xa7, 0xc1, 0x75, 0x30, 0x74),
     TraceLoggingOptionProjectTelemetry());
@@ -51,23 +101,23 @@ void Trace::FancyZones::EnableFancyZones(bool enabled) noexcept
 {
     TraceLoggingWrite(
         g_hProvider,
-        "FancyZones_EnableFancyZones",
+        EventEnableFancyZonesKey,
         ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
         TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE),
-        TraceLoggingBoolean(enabled, "Enabled"));
+        TraceLoggingBoolean(enabled, EventEnabledKey));
 }
 
 void Trace::FancyZones::OnKeyDown(DWORD vkCode, bool win, bool control, bool inMoveSize) noexcept
 {
     TraceLoggingWrite(
         g_hProvider,
-        "FancyZones_OnKeyDown",
+        EventKeyDownKey,
         ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
         TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE),
-        TraceLoggingValue(vkCode, "Hotkey"),
-        TraceLoggingBoolean(win, "WindowsKey"),
-        TraceLoggingBoolean(control, "ControlKey"),
-        TraceLoggingBoolean(inMoveSize, "InMoveSize"));
+        TraceLoggingValue(vkCode, PressedKeyCodeKey),
+        TraceLoggingBoolean(win, PressedWindowKey),
+        TraceLoggingBoolean(control, PressedControlKey),
+        TraceLoggingBoolean(inMoveSize, MoveSizeActionKey));
 }
 
 void Trace::FancyZones::DataChanged() noexcept
@@ -142,24 +192,24 @@ void Trace::FancyZones::DataChanged() noexcept
 
     TraceLoggingWrite(
         g_hProvider,
-        "FancyZones_ZoneSettingsChanged",
+        EventZoneSettingsChangedKey,
         ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
         TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE),
-        TraceLoggingInt32(appsHistorySize, "AppsInHistoryCount"),
-        TraceLoggingInt32(static_cast<int>(customZones.size()), "CustomZoneSetCount"),
-        TraceLoggingInt32Array(customZonesArray.get(), static_cast<int>(customZones.size()), "NumberOfZonesForEachCustomZoneSet"),
-        TraceLoggingInt32(static_cast<int>(devices.size()), "ActiveZoneSetsCount"),
-        TraceLoggingWideString(activeZoneSetInfo.c_str(), "ActiveZoneSetsList"));
+        TraceLoggingInt32(appsHistorySize, AppsInHistoryCountKey),
+        TraceLoggingInt32(static_cast<int>(customZones.size()), CustomZoneSetCountKey),
+        TraceLoggingInt32Array(customZonesArray.get(), static_cast<int>(customZones.size()), NumberOfZonesForEachCustomZoneSetKey),
+        TraceLoggingInt32(static_cast<int>(devices.size()), ActiveZoneSetsCountKey),
+        TraceLoggingWideString(activeZoneSetInfo.c_str(), ActiveZoneSetsListKey));
 }
 
 void Trace::FancyZones::EditorLaunched(int value) noexcept
 {
     TraceLoggingWrite(
         g_hProvider,
-        "FancyZones_EditorLaunch",
+        EventEditorLaunchKey,
         ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
         TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE),
-        TraceLoggingInt32(value, "Value"));
+        TraceLoggingInt32(value, EditorLaunchValueKey));
 }
 
 void Trace::SettingsChanged(const Settings& settings) noexcept
@@ -174,36 +224,36 @@ void Trace::SettingsChanged(const Settings& settings) noexcept
     
     TraceLoggingWrite(
         g_hProvider,
-        "FancyZones_SettingsChanged",
+        EventSettingsChangedKey,
         ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
         TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE),
-        TraceLoggingBoolean(settings.shiftDrag, "ShiftDrag"),
-        TraceLoggingBoolean(settings.mouseSwitch, "MouseSwitch"),
-        TraceLoggingBoolean(settings.displayChange_moveWindows, "MoveWindowsOnDisplayChange"),
-        TraceLoggingBoolean(settings.zoneSetChange_flashZones, "FlashZonesOnZoneSetChange"),
-        TraceLoggingBoolean(settings.zoneSetChange_moveWindows, "MoveWindowsOnZoneSetChange"),
-        TraceLoggingBoolean(settings.overrideSnapHotkeys, "OverrideSnapHotKeys"),
-        TraceLoggingBoolean(settings.moveWindowAcrossMonitors, "MoveWindowAcrossMonitors"),
-        TraceLoggingBoolean(settings.appLastZone_moveWindows, "MoveWindowsToLastZoneOnAppOpening"),
-        TraceLoggingBoolean(settings.openWindowOnActiveMonitor, "OpenWindowOnActiveMonitor"),
-        TraceLoggingBoolean(settings.restoreSize, "RestoreSize"),
-        TraceLoggingBoolean(settings.use_cursorpos_editor_startupscreen, "UseCursorPosOnEditorStartup"),
-        TraceLoggingBoolean(settings.showZonesOnAllMonitors, "ShowZonesOnAllMonitors"),
-        TraceLoggingBoolean(settings.spanZonesAcrossMonitors, "SpanZonesAcrossMonitors"),
-        TraceLoggingBoolean(settings.makeDraggedWindowTransparent, "MakeDraggedWindowTransparent"),
-        TraceLoggingWideString(settings.zoneColor.c_str(), "ZoneColor"),
-        TraceLoggingWideString(settings.zoneBorderColor.c_str(), "ZoneBorderColor"),
-        TraceLoggingWideString(settings.zoneHighlightColor.c_str(), "ZoneHighlightColor"),
-        TraceLoggingInt32(settings.zoneHighlightOpacity, "ZoneHighlightOpacity"),
-        TraceLoggingWideString(hotkeyStr.c_str(), "Hotkey"),
-        TraceLoggingInt32(static_cast<int>(settings.excludedAppsArray.size()), "ExcludedAppsCount"));
+        TraceLoggingBoolean(settings.shiftDrag, ShiftDragKey),
+        TraceLoggingBoolean(settings.mouseSwitch, MouseSwitchKey),
+        TraceLoggingBoolean(settings.displayChange_moveWindows, MoveWindowsOnDisplayChangeKey),
+        TraceLoggingBoolean(settings.zoneSetChange_flashZones, FlashZonesOnZoneSetChangeKey),
+        TraceLoggingBoolean(settings.zoneSetChange_moveWindows, MoveWindowsOnZoneSetChangeKey),
+        TraceLoggingBoolean(settings.overrideSnapHotkeys, OverrideSnapHotKeysKey),
+        TraceLoggingBoolean(settings.moveWindowAcrossMonitors, MoveWindowAcrossMonitorsKey),
+        TraceLoggingBoolean(settings.appLastZone_moveWindows, MoveWindowsToLastZoneOnAppOpeningKey),
+        TraceLoggingBoolean(settings.openWindowOnActiveMonitor, OpenWindowOnActiveMonitorKey),
+        TraceLoggingBoolean(settings.restoreSize, RestoreSizeKey),
+        TraceLoggingBoolean(settings.use_cursorpos_editor_startupscreen, UseCursorPosOnEditorStartupKey),
+        TraceLoggingBoolean(settings.showZonesOnAllMonitors, ShowZonesOnAllMonitorsKey),
+        TraceLoggingBoolean(settings.spanZonesAcrossMonitors, SpanZonesAcrossMonitorsKey),
+        TraceLoggingBoolean(settings.makeDraggedWindowTransparent, MakeDraggedWindowTransparentKey),
+        TraceLoggingWideString(settings.zoneColor.c_str(), ZoneColorKey),
+        TraceLoggingWideString(settings.zoneBorderColor.c_str(), ZoneBorderColorKey),
+        TraceLoggingWideString(settings.zoneHighlightColor.c_str(), ZoneHighlightColorKey),
+        TraceLoggingInt32(settings.zoneHighlightOpacity, ZoneHighlightOpacityKey),
+        TraceLoggingWideString(hotkeyStr.c_str(), HotkeyKey),
+        TraceLoggingInt32(static_cast<int>(settings.excludedAppsArray.size()), ExcludedAppsCountKey));
 }
 
 void Trace::VirtualDesktopChanged() noexcept
 {
     TraceLoggingWrite(
         g_hProvider,
-        "FancyZones_VirtualDesktopChanged",
+        EventDesktopChangedKey,
         ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
         TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
 }
@@ -212,10 +262,10 @@ void Trace::ZoneWindow::KeyUp(WPARAM wParam) noexcept
 {
     TraceLoggingWrite(
         g_hProvider,
-        "FancyZones_ZoneWindowKeyUp",
+        EventZoneWindowKeyUpKey,
         ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
         TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE),
-        TraceLoggingValue(wParam, "KeyboardValue"));
+        TraceLoggingValue(wParam, KeyboardValueKey));
 }
 
 void Trace::ZoneWindow::MoveSizeEnd(_In_opt_ winrt::com_ptr<IZoneSet> activeSet) noexcept
@@ -223,12 +273,12 @@ void Trace::ZoneWindow::MoveSizeEnd(_In_opt_ winrt::com_ptr<IZoneSet> activeSet)
     auto const zoneInfo = GetZoneSetInfo(activeSet);
     TraceLoggingWrite(
         g_hProvider,
-        "FancyZones_MoveSizeEnd",
+        EventMoveSizeEndKey,
         ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
         TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE),
-        TraceLoggingValue(reinterpret_cast<void*>(activeSet.get()), "ActiveSet"),
-        TraceLoggingValue(zoneInfo.NumberOfZones, "NumberOfZones"),
-        TraceLoggingValue(zoneInfo.NumberOfWindows, "NumberOfWindows"));
+        TraceLoggingValue(reinterpret_cast<void*>(activeSet.get()), ActiveSetKey),
+        TraceLoggingValue(zoneInfo.NumberOfZones, NumberOfZonesKey),
+        TraceLoggingValue(zoneInfo.NumberOfWindows, NumberOfWindowsKey));
 }
 
 void Trace::ZoneWindow::CycleActiveZoneSet(_In_opt_ winrt::com_ptr<IZoneSet> activeSet, InputMode mode) noexcept
@@ -236,11 +286,11 @@ void Trace::ZoneWindow::CycleActiveZoneSet(_In_opt_ winrt::com_ptr<IZoneSet> act
     auto const zoneInfo = GetZoneSetInfo(activeSet);
     TraceLoggingWrite(
         g_hProvider,
-        "FancyZones_CycleActiveZoneSet",
+        EventCycleActiveZoneSetKey,
         ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
         TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE),
-        TraceLoggingValue(reinterpret_cast<void*>(activeSet.get()), "ActiveSet"),
-        TraceLoggingValue(zoneInfo.NumberOfZones, "NumberOfZones"),
-        TraceLoggingValue(zoneInfo.NumberOfWindows, "NumberOfWindows"),
-        TraceLoggingValue(static_cast<int>(mode), "InputMode"));
+        TraceLoggingValue(reinterpret_cast<void*>(activeSet.get()), ActiveSetKey),
+        TraceLoggingValue(zoneInfo.NumberOfZones, NumberOfZonesKey),
+        TraceLoggingValue(zoneInfo.NumberOfWindows, NumberOfWindowsKey),
+        TraceLoggingValue(static_cast<int>(mode), InputModeKey));
 }