[General]Add an option for telemetry opt-in and visualization(#34078)

* Data diagnostics opt-in

* [c++] Drop DROP_PII flag

* Bump telemtry package to 2.0.2

* Drop DropPii from custom actions

* Cleanup

* Do not start manually C# EtwTrace. FZ engine exit event.

* ImageResizer, PowerRename, FileLocksmith prev handlers

* Revert C# handlers exe logging

* Revert "Revert C# handlers exe logging"

This reverts commit 4c75a3953b.

* Do not recreate EtwTrace

* consume package

* xaml formatting

* Fix deps.json audit

* Update telem package paths

* Address PR comments

* Fix AdvancedPaste close on PT close

* Override etl file name for explorer loaded dlls
Start/stop tracer when needed for explorer loaded dlls to prevent explorer overload

* Fix setting desc

* Fix missing events

* Add infobar to restart when enable data viewing

* Flush on timer every 30s

* [Settings] Update View Data diagnostic description text
[New+] Add tracer

* Show Restart info bar for both enable/disable data viewer

* Fix newplus

* Fix stuck on restart and terminate AdvPaste exe on destroy()

* [Installer] Add tracer

* Address PR comment

* Add missing tracers

* Exclude etw dir from BugReport

* Fix bad merge

* [Hosts] Proper exit on initial dialog

* [OOBE] Make Data diagnostic setting visible without scroll

* [OOBE] Add hiperlynk to open general settings

* Disable data view on disabling data diagnostics

* Don't disable View data button

* Fix disabling data viewing

* Add missing dot

* Revert formatting

src/modules/alwaysontop/AlwaysOnTop/AlwaysOnTop.cpp

@@ -32,10 +32,11 @@ bool isExcluded(HWND window)
     return check_excluded_app(window, processPath, AlwaysOnTopSettings::settings().excludedApps);
 }
 
-AlwaysOnTop::AlwaysOnTop(bool useLLKH) :
+AlwaysOnTop::AlwaysOnTop(bool useLLKH, DWORD mainThreadId) :
     SettingsObserver({SettingId::FrameEnabled, SettingId::Hotkey, SettingId::ExcludeApps}),
     m_hinstance(reinterpret_cast<HINSTANCE>(&__ImageBase)),
-    m_useCentralizedLLKH(useLLKH)
+    m_useCentralizedLLKH(useLLKH),
+    m_mainThreadId(mainThreadId)
 {
     s_instance = this;
     DPIAware::EnableDPIAwarenessForThisProcess();
@@ -282,6 +283,7 @@ void AlwaysOnTop::RegisterLLKH()
     }
 	
     m_hPinEvent = CreateEventW(nullptr, false, false, CommonSharedConstants::ALWAYS_ON_TOP_PIN_EVENT);
+    m_hTerminateEvent = CreateEventW(nullptr, false, false, CommonSharedConstants::ALWAYS_ON_TOP_TERMINATE_EVENT);
 
     if (!m_hPinEvent)
     {
@@ -289,11 +291,20 @@ void AlwaysOnTop::RegisterLLKH()
         return;
     }
 
-    m_thread = std::thread([this]() {
+    if (!m_hTerminateEvent)
+    {
+        Logger::warn(L"Failed to create terminateEvent. {}", get_last_error_or_default(GetLastError()));
+        return;
+    }
+
+    HANDLE handles[2] = { m_hPinEvent,
+                          m_hTerminateEvent };
+
+    m_thread = std::thread([this, handles]() {
         MSG msg;
         while (m_running)
         {
-            DWORD dwEvt = MsgWaitForMultipleObjects(1, &m_hPinEvent, false, INFINITE, QS_ALLINPUT);
+            DWORD dwEvt = MsgWaitForMultipleObjects(2, handles, false, INFINITE, QS_ALLINPUT);
             if (!m_running)
             {
                 break;
@@ -307,6 +318,9 @@ void AlwaysOnTop::RegisterLLKH()
                 }
                 break;
             case WAIT_OBJECT_0 + 1:
+                PostThreadMessage(m_mainThreadId, WM_QUIT, 0, 0);
+                break;
+            case WAIT_OBJECT_0 + 2:
                 if (PeekMessageW(&msg, nullptr, 0, 0, PM_REMOVE))
                 {
                     TranslateMessage(&msg);

src/modules/alwaysontop/AlwaysOnTop/AlwaysOnTop.h

@@ -13,7 +13,7 @@
 class AlwaysOnTop : public SettingsObserver
 {
 public:
-    AlwaysOnTop(bool useLLKH);
+    AlwaysOnTop(bool useLLKH, DWORD mainThreadId);
     ~AlwaysOnTop();
 
 protected:
@@ -48,6 +48,8 @@ private:
     HINSTANCE m_hinstance;
     std::map<HWND, std::unique_ptr<WindowBorder>> m_topmostWindows{};
     HANDLE m_hPinEvent;
+    HANDLE m_hTerminateEvent;
+    DWORD m_mainThreadId;
     std::thread m_thread;
     const bool m_useCentralizedLLKH;
     bool m_running = true;

src/modules/alwaysontop/AlwaysOnTop/AlwaysOnTop.vcxproj

@@ -170,6 +170,9 @@
     <ProjectReference Include="..\..\..\common\notifications\notifications.vcxproj">
       <Project>{1d5be09d-78c0-4fd7-af00-ae7c1af7c525}</Project>
     </ProjectReference>
+    <ProjectReference Include="..\..\..\common\Telemetry\EtwTrace\EtwTrace.vcxproj">
+      <Project>{8f021b46-362b-485c-bfba-ccf83e820cbd}</Project>
+    </ProjectReference>
   </ItemGroup>
   <ItemGroup>
     <ResourceCompile Include="Generated Files/AlwaysOnTop.rc" />

src/modules/alwaysontop/AlwaysOnTop/main.cpp

@@ -1,11 +1,12 @@
 #include "pch.h"
 
+#include <common/utils/logger_helper.h>
 #include <common/utils/ProcessWaiter.h>
 #include <common/utils/window.h>
 #include <common/utils/UnhandledExceptionHandler.h>
 #include <common/utils/gpo.h>
 
-#include <common/utils/logger_helper.h>
+#include <common/Telemetry/EtwTrace/EtwTrace.h>
 
 #include <AlwaysOnTop.h>
 #include <trace.h>
@@ -17,6 +18,9 @@ const std::wstring instanceMutexName = L"Local\\PowerToys_AlwaysOnTop_InstanceMu
 
 int WINAPI wWinMain(_In_ HINSTANCE hInstance, _In_opt_ HINSTANCE hPrevInstance, _In_ PWSTR lpCmdLine, _In_ int nCmdShow)
 {
+    Shared::Trace::ETWTrace trace;
+    trace.UpdateState(true);
+
     winrt::init_apartment();
     LoggerHelpers::init_logger(moduleName, internalPath, LogSettings::alwaysOnTopLoggerName);
 
@@ -39,10 +43,11 @@ int WINAPI wWinMain(_In_ HINSTANCE hInstance, _In_opt_ HINSTANCE hPrevInstance,
         return 0;
     }
 
+    auto mainThreadId = GetCurrentThreadId();
+
     std::wstring pid = std::wstring(lpCmdLine);
     if (!pid.empty())
     {
-        auto mainThreadId = GetCurrentThreadId();
         ProcessWaiter::OnProcessTerminate(pid, [mainThreadId](int err) {
             if (err != ERROR_SUCCESS)
             {
@@ -58,13 +63,15 @@ int WINAPI wWinMain(_In_ HINSTANCE hInstance, _In_opt_ HINSTANCE hPrevInstance,
         });
     }
 
-    Trace::RegisterProvider();
+    Trace::AlwaysOnTop::RegisterProvider();
 
-    AlwaysOnTop app(!pid.empty());
+    AlwaysOnTop app(!pid.empty(), mainThreadId);
 
     run_message_loop();
 
-    Trace::UnregisterProvider();
-    
+    Trace::AlwaysOnTop::UnregisterProvider();
+
+    trace.Flush();
+
     return 0;
 }

src/modules/alwaysontop/AlwaysOnTop/pch.h

@@ -4,7 +4,6 @@
 #include <winrt/base.h>
 #include <wil/resource.h>
 #include <wil/filesystem.h>
-#include <ProjectTelemetry.h>
 #include <common/logger/logger.h>
 
 #include <functional>

src/modules/alwaysontop/AlwaysOnTop/trace.cpp

@@ -1,6 +1,8 @@
 #include "pch.h"
 #include "trace.h"
 
+#include <common/Telemetry/TraceBase.h>
+
 // Telemetry strings should not be localized.
 #define LoggingProviderKey "Microsoft.PowerToys"
 
@@ -16,19 +18,9 @@ TRACELOGGING_DEFINE_PROVIDER(
     (0x38e8889b, 0x9731, 0x53f5, 0xe9, 0x01, 0xe8, 0xa7, 0xc1, 0x75, 0x30, 0x74),
     TraceLoggingOptionProjectTelemetry());
 
-void Trace::RegisterProvider() noexcept
-{
-    TraceLoggingRegister(g_hProvider);
-}
-
-void Trace::UnregisterProvider() noexcept
-{
-    TraceLoggingUnregister(g_hProvider);
-}
-
 void Trace::AlwaysOnTop::Enable(bool enabled) noexcept
 {
-    TraceLoggingWrite(
+    TraceLoggingWriteWrapper(
         g_hProvider,
         EventEnableAlwaysOnTopKey,
         ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
@@ -38,7 +30,7 @@ void Trace::AlwaysOnTop::Enable(bool enabled) noexcept
 
 void Trace::AlwaysOnTop::PinWindow() noexcept
 {
-    TraceLoggingWrite(
+    TraceLoggingWriteWrapper(
         g_hProvider,
         EventPinWindowKey,
         ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
@@ -47,7 +39,7 @@ void Trace::AlwaysOnTop::PinWindow() noexcept
 
 void Trace::AlwaysOnTop::UnpinWindow() noexcept
 {
-    TraceLoggingWrite(
+    TraceLoggingWriteWrapper(
         g_hProvider,
         EventUnpinWindowKey,
         ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),

src/modules/alwaysontop/AlwaysOnTop/trace.h

@@ -1,12 +1,11 @@
 #pragma once
 
+#include <common/Telemetry/TraceBase.h>
+
 class Trace
 {
 public:
-    static void RegisterProvider() noexcept;
-    static void UnregisterProvider() noexcept;
-
-    class AlwaysOnTop
+    class AlwaysOnTop : public telemetry::TraceBase
     {
     public:
         static void Enable(bool enabled) noexcept;

src/modules/alwaysontop/AlwaysOnTopModuleInterface/dllmain.cpp

@@ -35,7 +35,7 @@ BOOL APIENTRY DllMain(HMODULE /*hModule*/, DWORD ul_reason_for_call, LPVOID /*lp
     switch (ul_reason_for_call)
     {
     case DLL_PROCESS_ATTACH:
-        Trace::RegisterProvider();
+        Trace::AlwaysOnTop::RegisterProvider();
         break;
 
     case DLL_THREAD_ATTACH:
@@ -43,7 +43,7 @@ BOOL APIENTRY DllMain(HMODULE /*hModule*/, DWORD ul_reason_for_call, LPVOID /*lp
         break;
 
     case DLL_PROCESS_DETACH:
-        Trace::UnregisterProvider();
+        Trace::AlwaysOnTop::UnregisterProvider();
         break;
     }
     return TRUE;
@@ -174,6 +174,7 @@ public:
         app_name = L"AlwaysOnTop"; //TODO: localize
         app_key = NonLocalizable::ModuleKey;
         m_hPinEvent = CreateDefaultEvent(CommonSharedConstants::ALWAYS_ON_TOP_PIN_EVENT);
+        m_hTerminateEvent = CreateDefaultEvent(CommonSharedConstants::ALWAYS_ON_TOP_TERMINATE_EVENT);
         init_settings();
     }
 
@@ -221,6 +222,12 @@ private:
             Trace::AlwaysOnTop::Enable(false);
         }
 
+        SetEvent(m_hTerminateEvent);
+
+        // Wait for 1.5 seconds for the process to end correctly and stop etw tracer
+        WaitForSingleObject(m_hProcess, 1500);
+
+        // If process is still running, terminate it
         if (m_hProcess)
         {
             TerminateProcess(m_hProcess, 0);
@@ -294,6 +301,7 @@ private:
 
     // Handle to event used to pin/unpin windows
     HANDLE m_hPinEvent;
+    HANDLE m_hTerminateEvent;
 };
 
 extern "C" __declspec(dllexport) PowertoyModuleIface* __cdecl powertoy_create()

src/modules/alwaysontop/AlwaysOnTopModuleInterface/pch.h

@@ -5,7 +5,5 @@
 #include <winrt/base.h>
 #include <winrt/Windows.Foundation.h>
 #include <winrt/Windows.Foundation.Collections.h>
-#include <ProjectTelemetry.h>
-#include <TraceLoggingActivity.h>
 #include <wil\common.h>
 #include <wil\result.h>