[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/NewPlus/NewShellExtensionContextMenu/NewShellExtensionContextMenu.vcxproj

@@ -167,6 +167,9 @@ MakeAppx.exe pack /d . /p $(OutDir)NewPlusPackage.msix /nv</Command>
     <ProjectReference Include="..\..\..\common\SettingsAPI\SettingsAPI.vcxproj">
       <Project>{6955446d-23f7-4023-9bb3-8657f904af99}</Project>
     </ProjectReference>
+    <ProjectReference Include="..\..\..\common\Telemetry\EtwTrace\EtwTrace.vcxproj">
+      <Project>{8f021b46-362b-485c-bfba-ccf83e820cbd}</Project>
+    </ProjectReference>
     <ProjectReference Include="..\..\..\common\Themes\Themes.vcxproj">
       <Project>{98537082-0fdb-40de-abd8-0dc5a4269bab}</Project>
     </ProjectReference>

src/modules/NewPlus/NewShellExtensionContextMenu/dll_main.cpp

@@ -4,7 +4,10 @@
 #include "dll_main.h"
 #include "trace.h"
 
+#include <common/Telemetry/EtwTrace/EtwTrace.h>
+
 HMODULE module_instance_handle = 0;
+Shared::Trace::ETWTrace trace(L"NewPlusShellExtension");
 
 BOOL APIENTRY DllMain(HMODULE module_handle, DWORD ul_reason_for_call, LPVOID reserved)
 {

src/modules/NewPlus/NewShellExtensionContextMenu/dll_main.h

@@ -1,3 +1,6 @@
 #pragma once
 
-extern HMODULE module_instance_handle;
+#include <common/Telemetry/EtwTrace/EtwTrace.h>
+
+extern HMODULE module_instance_handle;
+extern Shared::Trace::ETWTrace trace;

src/modules/NewPlus/NewShellExtensionContextMenu/shell_context_sub_menu.cpp

@@ -7,6 +7,7 @@ using namespace Microsoft::WRL;
 // // Sub context menu command enumerator
 shell_context_sub_menu::shell_context_sub_menu(const ComPtr<IUnknown> site_of_folder)
 {
+    trace.UpdateState(true);
     this->site_of_folder = site_of_folder;
 
     // Determine the New+ Template folder location

src/modules/NewPlus/NewShellExtensionContextMenu/shell_context_sub_menu_item.cpp

@@ -63,8 +63,11 @@ IFACEMETHODIMP shell_context_sub_menu_item::GetState(_In_opt_ IShellItemArray* s
 
 IFACEMETHODIMP shell_context_sub_menu_item::Invoke(_In_opt_ IShellItemArray*, _In_opt_ IBindCtx*) noexcept
 {
+    HRESULT hr = S_OK;
     try
     {
+        trace.UpdateState(true);
+
         // Determine target path of where context menu was displayed
         const auto target_path_name = utilities::get_path_from_unknown_site(site_of_folder);
 
@@ -90,16 +93,19 @@ IFACEMETHODIMP shell_context_sub_menu_item::Invoke(_In_opt_ IShellItemArray*, _I
         this->template_entry->enter_rename_mode(site_of_folder, target_final_fullpath);
 
         Trace::EventCopyTemplateResult(S_OK);
-
-        return S_OK;
     }
     catch (const std::exception& ex)
     {
         Trace::EventCopyTemplateResult(S_FALSE);
         Logger::error(ex.what());
+
+        hr = S_FALSE;
     }
 
-    return S_FALSE;
+    trace.Flush();
+    trace.UpdateState(false);
+
+    return hr;
 }
 
 IFACEMETHODIMP shell_context_sub_menu_item::GetFlags(_Out_ EXPCMDFLAGS* returned_flags)

src/modules/NewPlus/NewShellExtensionContextMenu/trace.cpp

@@ -10,19 +10,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::EventToggleOnOff(_In_ const bool enabled) noexcept
 {
-    TraceLoggingWrite(
+    TraceLoggingWriteWrapper(
         g_hProvider,
         "NewPlus_EventToggleOnOff",
         ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
@@ -32,7 +22,7 @@ void Trace::EventToggleOnOff(_In_ const bool enabled) noexcept
 
 void Trace::EventChangedTemplateLocation() noexcept
 {
-    TraceLoggingWrite(
+    TraceLoggingWriteWrapper(
         g_hProvider,
         "NewPlus_ChangedTemplateLocation",
         ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
@@ -41,7 +31,7 @@ void Trace::EventChangedTemplateLocation() noexcept
 
 void Trace::EventShowTemplateItems(const size_t number_of_templates) noexcept
 {
-    TraceLoggingWrite(
+    TraceLoggingWriteWrapper(
         g_hProvider,
         "NewPlus_EventShowTemplateItems",
         ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
@@ -51,7 +41,7 @@ void Trace::EventShowTemplateItems(const size_t number_of_templates) noexcept
 
 void Trace::EventCopyTemplate(_In_ const std::wstring template_file_extension) noexcept
 {
-    TraceLoggingWrite(
+    TraceLoggingWriteWrapper(
         g_hProvider,
         "NewPlus_EventCopyTemplate",
         ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
@@ -61,7 +51,7 @@ void Trace::EventCopyTemplate(_In_ const std::wstring template_file_extension) n
 
 void Trace::EventCopyTemplateResult(_In_ const HRESULT hr) noexcept
 {
-    TraceLoggingWrite(
+    TraceLoggingWriteWrapper(
         g_hProvider,
         "NewPlus_EventCopyTemplateResult",
         ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),

src/modules/NewPlus/NewShellExtensionContextMenu/trace.h

@@ -2,11 +2,11 @@
 
 #include "pch.h"
 
-class Trace
+#include <common/Telemetry/TraceBase.h>
+
+class Trace : public telemetry::TraceBase
 {
 public:
-    static void RegisterProvider() noexcept;
-    static void UnregisterProvider() noexcept;
     static void EventToggleOnOff(_In_ const bool new_enabled_state) noexcept;
     static void EventChangedTemplateLocation() noexcept;
     static void EventShowTemplateItems(_In_ const size_t number_of_templates) noexcept;