microsoft
/
WindowsAppSDK
зеркало из https://github.com/microsoft/WindowsAppSDK.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Introducing WIL activities for AppNotifications (#3127) 

Now it's time to bring WIL activities goodness to App Notifications.

How verified: While running the AppNotificationTests suite, I recorded AppNotificationTelemetry traces in an etl file and I was able to see the new activities there.

Bonus: I fixed a couple of minor test bugs on AppNotificationTests.
This commit is contained in:
Daniel Ayala 2022-11-10 15:24:05 -08:00 коммит произвёл GitHub
Родитель 785175d524
Коммит 707c97826d
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
4 изменённых файлов: 399 добавлений и 574 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

253
dev/AppNotifications/AppNotificationManager.cpp
Просмотреть файл

@ -115,14 +115,8 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
return;
}
HRESULT hr{ S_OK };
auto logTelemetry{ AppNotificationTelemetry::Register::Start(g_telemetryHelper, m_appId) };
auto logTelemetry{ wil::scope_exit([&]() {
AppNotificationTelemetry::LogRegister(hr, m_appId);
}) };
try
{
{
auto lock{ m_lock.lock_exclusive() };
THROW_HR_IF_MSG(HRESULT_FROM_WIN32(ERROR_OPERATION_IN_PROGRESS), m_registering, "Registration is in progress!");
@ -151,12 +145,8 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
// Register the AppNotificationManager as a COM server for Shell to Activate and Invoke
RegisterComServer(registeredClsid);
}
catch (...)
{
hr = wil::ResultFromCaughtException();
throw;
}
logTelemetry.Stop();
}
void AppNotificationManager::Register(hstring const& displayName, winrt::Windows::Foundation::Uri const& iconUri)
@ -166,14 +156,8 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
return;
}
HRESULT hr{ S_OK };
auto logTelemetry{ AppNotificationTelemetry::Register::Start(g_telemetryHelper, m_appId) };
auto logTelemetry{ wil::scope_exit([&]() {
AppNotificationTelemetry::LogRegister(hr, m_appId);
}) };
try
{
THROW_HR_IF_MSG(E_ILLEGAL_METHOD_CALL, AppModel::Identity::IsPackagedProcess(), "Not applicable for packaged applications");
THROW_HR_IF(E_INVALIDARG, displayName.empty() || (iconUri == nullptr));
@ -199,12 +183,8 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
// Register the AppNotificationManager as a COM server for Shell to Activate and Invoke
RegisterComServer(registeredClsid);
}
catch (...)
{
hr = wil::ResultFromCaughtException();
throw;
}
logTelemetry.Stop();
}
void AppNotificationManager::RegisterComServer(winrt::guid const& registeredClsid)
@ -276,14 +256,8 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
return;
}
HRESULT hr{ S_OK };
auto logTelemetry{ AppNotificationTelemetry::Unregister::Start(g_telemetryHelper, m_appId) };
auto logTelemetry{ wil::scope_exit([&]() {
AppNotificationTelemetry::LogUnregister(hr, m_appId);
}) };
try
{
auto lock{ m_lock.lock_exclusive() };
THROW_HR_IF_MSG(HRESULT_FROM_WIN32(ERROR_OPERATION_IN_PROGRESS), m_registering, "Register or Unregister currently in progress!");
m_registering = true;
@ -294,12 +268,8 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
THROW_HR_IF_MSG(HRESULT_FROM_WIN32(ERROR_NOT_FOUND), !m_notificationComActivatorRegistration, "Not Registered for App Notifications!");
UnregisterHelper();
}
catch (...)
{
hr = wil::ResultFromCaughtException();
throw;
}
logTelemetry.Stop();
}
void AppNotificationManager::UnregisterAll()
@ -309,14 +279,8 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
return;
}
HRESULT hr{ S_OK };
auto logTelemetry{ AppNotificationTelemetry::UnregisterAll::Start(g_telemetryHelper, m_appId) };
auto logTelemetry{ wil::scope_exit([&]() {
AppNotificationTelemetry::LogUnregisterAll(hr, m_appId);
}) };
try
{
{
auto lock{ m_lock.lock_exclusive() };
UnregisterHelper();
@ -352,12 +316,8 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
UnRegisterNotificationAppIdentifierFromRegistry();
THROW_IF_FAILED(PushNotifications_UnregisterFullTrustApplication(m_appId.c_str()));
}
}
catch (...)
{
hr = wil::ResultFromCaughtException();
throw;
}
logTelemetry.Stop();
}
winrt::event_token AppNotificationManager::NotificationInvoked(winrt::Windows::Foundation::TypedEventHandler<winrt::Microsoft::Windows::AppNotifications::AppNotificationManager, winrt::Microsoft::Windows::AppNotifications::AppNotificationActivatedEventArgs> const& handler)
@ -389,6 +349,12 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
[[maybe_unused]] NOTIFICATION_USER_INPUT_DATA const* data,
[[maybe_unused]] ULONG dataCount) noexcept try
{
auto logTelemetry{ AppNotificationTelemetry::Activated::Start(
g_telemetryHelper,
m_appId,
invokedArgs,
m_firstNotificationReceived,
!!m_notificationHandlers) };
winrt::IMap<winrt::hstring, winrt::hstring> userInput{ winrt::single_threaded_map<winrt::hstring, winrt::hstring>() };
for (unsigned long i = 0; i < dataCount; i++)
@ -398,14 +364,6 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
winrt::AppNotificationActivatedEventArgs activatedEventArgs = winrt::make<implementation::AppNotificationActivatedEventArgs>(invokedArgs, userInput);
HRESULT hr{ S_OK };
auto logTelemetry{ wil::scope_exit([&]() {
AppNotificationTelemetry::LogActivated(hr, m_appId, invokedArgs, m_firstNotificationReceived, !!m_notificationHandlers);
}) };
try
{
// Need to store the first notification in the case of ToastActivation
auto lock{ m_lock.lock_exclusive() };
@ -457,13 +415,9 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
m_notificationHandlers(Default(), activatedEventArgs);
}
return hr;
}
catch (...)
{
hr = wil::ResultFromCaughtException();
throw;
}
logTelemetry.Stop();
return S_OK;
}
CATCH_RETURN()
@ -474,16 +428,15 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
return;
}
auto logTelemetry{ AppNotificationTelemetry::Show::Start(
g_telemetryHelper,
m_appId,
notification.Payload(),
notification.Tag(),
notification.Group()) };
THROW_HR_IF(WPN_E_NOTIFICATION_POSTED, notification.Id() != 0);
HRESULT hr{ S_OK };
auto logTelemetry{ wil::scope_exit([&]() {
AppNotificationTelemetry::LogShow(hr, m_appId, notification.Payload(), notification.Tag(), notification.Group());
}) };
try
{
winrt::com_ptr<::ABI::Microsoft::Internal::ToastNotifications::INotificationProperties> notificationProperties = winrt::make_self<NotificationProperties>(notification);
winrt::com_ptr<::ABI::Microsoft::Internal::ToastNotifications::INotificationTransientProperties> notificationTransientProperties = winrt::make_self<NotificationTransientProperties>(notification);
@ -495,12 +448,8 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
implementation::AppNotification* notificationImpl = get_self<implementation::AppNotification>(notification);
notificationImpl->SetNotificationId(notificationId);
}
catch (...)
{
hr = wil::ResultFromCaughtException();
throw;
}
logTelemetry.Stop();
}
winrt::Windows::Foundation::IAsyncOperation<winrt::Microsoft::Windows::AppNotifications::AppNotificationProgressResult> AppNotificationManager::UpdateAsync(winrt::Microsoft::Windows::AppNotifications::AppNotificationProgressData const data, hstring const tag, hstring const group)
@ -513,19 +462,14 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
THROW_HR_IF_MSG(E_INVALIDARG, tag == winrt::hstring(L""), "Update operation isn't guaranteed to find a specific notification to replace correctly.");
THROW_HR_IF_MSG(E_INVALIDARG, data.SequenceNumber() == 0, "Sequence Number for Updates should be greater than 0!");
HRESULT hr{ S_OK };
auto strong = get_strong();
co_await resume_background();
auto logTelemetry{ wil::scope_exit([&]() {
AppNotificationTelemetry::LogUpdateAsync(hr, m_appId, tag, group);
}) };
auto logTelemetry{ AppNotificationTelemetry::UpdateAsync::Start(g_telemetryHelper, m_appId, tag, group) };
try
{
winrt::com_ptr<ToastABI::IToastProgressData> toastProgressData{ winrt::make_self<NotificationProgressData>(data) };
HRESULT hr{ S_OK };
hr = ToastNotifications_UpdateNotificationData(m_appId.c_str(), tag.c_str(), group.c_str(), toastProgressData.get());
if (SUCCEEDED(hr))
@ -540,12 +484,8 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
{
THROW_HR(hr);
}
}
catch (...)
{
hr = wil::ResultFromCaughtException();
throw;
}
logTelemetry.Stop();
}
winrt::Windows::Foundation::IAsyncOperation<winrt::Microsoft::Windows::AppNotifications::AppNotificationProgressResult> AppNotificationManager::UpdateAsync(winrt::Microsoft::Windows::AppNotifications::AppNotificationProgressData const data, hstring const tag)
@ -560,24 +500,15 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
return AppNotificationSetting::Unsupported;
}
HRESULT hr{ S_OK };
auto logTelemetry{ AppNotificationTelemetry::Setting::Start(g_telemetryHelper, m_appId) };
auto logTelemetry{ wil::scope_exit([&]() {
AppNotificationTelemetry::LogSetting(hr, m_appId);
}) };
try
{
DWORD appNotificationSetting{ 0 };
ToastNotifications_QuerySettings(m_appId.c_str(), &appNotificationSetting);
logTelemetry.Stop();
return static_cast<winrt::Microsoft::Windows::AppNotifications::AppNotificationSetting>(appNotificationSetting);
}
catch (...)
{
hr = wil::ResultFromCaughtException();
throw;
}
}
winrt::Windows::Foundation::IAsyncAction AppNotificationManager::RemoveByIdAsync(uint32_t notificationId)
{
@ -586,26 +517,19 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
return;
}
auto logTelemetry{ AppNotificationTelemetry::RemoveByIdAsync::Start(g_telemetryHelper, m_appId, notificationId) };
THROW_HR_IF(E_INVALIDARG, notificationId == 0);
HRESULT hr{ S_OK };
auto strong = get_strong();
logTelemetry.IgnoreCurrentThread();
co_await winrt::resume_background();
auto logTelemetry{ wil::scope_exit([&]() {
AppNotificationTelemetry::LogRemoveByIdAsync(hr, m_appId, notificationId);
}) };
auto logTelemetryContinuation = logTelemetry.ContinueOnCurrentThread();
try
{
THROW_IF_FAILED(ToastNotifications_RemoveToast(m_appId.c_str(), notificationId));
}
catch (...)
{
hr = wil::ResultFromCaughtException();
throw;
}
logTelemetry.Stop();
}
winrt::Windows::Foundation::IAsyncAction AppNotificationManager::RemoveByTagAsync(hstring const tag)
@ -615,26 +539,19 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
return;
}
auto logTelemetry{ AppNotificationTelemetry::RemoveByTagAsync::Start(g_telemetryHelper, m_appId, tag) };
THROW_HR_IF(E_INVALIDARG, tag == winrt::hstring(L""));
HRESULT hr{ S_OK };
auto strong = get_strong();
logTelemetry.IgnoreCurrentThread();
co_await winrt::resume_background();
auto logTelemetry{ wil::scope_exit([&]() {
AppNotificationTelemetry::LogRemoveByTagAsync(hr, m_appId, tag);
}) };
auto logTelemetryContinuation = logTelemetry.ContinueOnCurrentThread();
try
{
THROW_IF_FAILED(ToastNotifications_RemoveToastsWithTagAndGroup(m_appId.c_str(), tag.c_str(), nullptr));
}
catch (...)
{
hr = wil::ResultFromCaughtException();
throw;
}
logTelemetry.Stop();
}
winrt::Windows::Foundation::IAsyncAction AppNotificationManager::RemoveByTagAndGroupAsync(hstring const tag, hstring const group)
@ -644,27 +561,20 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
return;
}
auto logTelemetry{ AppNotificationTelemetry::RemoveByTagAndGroupAsync::Start(g_telemetryHelper, m_appId, tag, group) };
THROW_HR_IF(E_INVALIDARG, tag == winrt::hstring(L""));
THROW_HR_IF(E_INVALIDARG, group == winrt::hstring(L""));
HRESULT hr{ S_OK };
auto strong = get_strong();
logTelemetry.IgnoreCurrentThread();
co_await winrt::resume_background();
auto logTelemetry{ wil::scope_exit([&]() {
AppNotificationTelemetry::LogRemoveByTagAndGroupAsync(hr, m_appId, tag, group);
}) };
auto logTelemetryContinuation = logTelemetry.ContinueOnCurrentThread();
try
{
THROW_IF_FAILED(ToastNotifications_RemoveToastsWithTagAndGroup(m_appId.c_str(), tag.c_str(), group.c_str()));
}
catch (...)
{
hr = wil::ResultFromCaughtException();
throw;
}
logTelemetry.Stop();
}
winrt::Windows::Foundation::IAsyncAction AppNotificationManager::RemoveByGroupAsync(hstring const group)
@ -674,26 +584,19 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
return;
}
auto logTelemetry{ AppNotificationTelemetry::RemoveByGroupAsync::Start(g_telemetryHelper, m_appId, group) };
THROW_HR_IF(E_INVALIDARG, group == winrt::hstring(L""));
HRESULT hr{ S_OK };
auto strong = get_strong();
logTelemetry.IgnoreCurrentThread();
co_await winrt::resume_background();
auto logTelemetry{ wil::scope_exit([&]() {
AppNotificationTelemetry::LogRemoveByGroupAsync(hr, m_appId);
}) };
auto logTelemetryContinuation = logTelemetry.ContinueOnCurrentThread();
try
{
THROW_IF_FAILED(ToastNotifications_RemoveToastsWithTagAndGroup(m_appId.c_str(), nullptr, group.c_str()));
}
catch (...)
{
hr = wil::ResultFromCaughtException();
throw;
}
logTelemetry.Stop();
}
winrt::Windows::Foundation::IAsyncAction AppNotificationManager::RemoveAllAsync()
@ -703,24 +606,14 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
return;
}
HRESULT hr{ S_OK };
auto strong = get_strong();
co_await winrt::resume_background();
auto logTelemetry{ wil::scope_exit([&]() {
AppNotificationTelemetry::LogRemoveAllAsync(hr, m_appId);
}) };
auto logTelemetry{ AppNotificationTelemetry::RemoveAllAsync::Start(g_telemetryHelper, m_appId) };
try
{
THROW_IF_FAILED(ToastNotifications_RemoveAllToastsForApp(m_appId.c_str()));
}
catch (...)
{
hr = wil::ResultFromCaughtException();
throw;
}
logTelemetry.Stop();
}
winrt::Windows::Foundation::IAsyncOperation<winrt::Windows::Foundation::Collections::IVector<winrt::Microsoft::Windows::AppNotifications::AppNotification>> AppNotificationManager::GetAllAsync()
@ -730,17 +623,11 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
co_return{};
}
HRESULT hr{ S_OK };
auto strong = get_strong();
co_await winrt::resume_background();
auto logTelemetry{ wil::scope_exit([&](){
AppNotificationTelemetry::LogGetAllAsync(hr, m_appId);
}) };
auto logTelemetry{ AppNotificationTelemetry::GetAllAsync::Start(g_telemetryHelper, m_appId) };
try
{
winrt::com_ptr<ToastABI::IVector<ToastABI::INotificationProperties*>> toastPropertiesCollection{};
auto result{ ToastNotifications_GetHistory(m_appId.c_str(), toastPropertiesCollection.put()) };
@ -764,12 +651,8 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
toastNotifications.Append(toastNotification);
}
logTelemetry.Stop();
co_return toastNotifications;
}
catch (...)
{
hr = wil::ResultFromCaughtException();
throw;
}
}
}

295
dev/AppNotifications/AppNotificationTelemetry.h
Просмотреть файл

@ -11,270 +11,211 @@ DECLARE_TRACELOGGING_CLASS(AppNotificationTelemetryProvider,
// {1825c850-a487-537d-b768-f0ab298d2565}
(0x1825c850, 0xa487, 0x537d, 0xb7, 0x68, 0xf0, 0xab, 0x29, 0x8d, 0x25, 0x65));
class AppNotificationTelemetry : public wil::TraceLoggingProvider
{
IMPLEMENT_TELEMETRY_CLASS(AppNotificationTelemetry, AppNotificationTelemetryProvider);
public:
DEFINE_EVENT_METHOD(LogRegister)(
winrt::hresult hr,
std::wstring const& appId) noexcept try
{
if (m_telemetryHelper.ShouldLogEvent())
{
TraceLoggingClassWriteMeasure(
"Register",
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance),
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingHexUInt32(hr, "OperationResult"),
TraceLoggingWideString(appId.c_str(), "AppId"),
TraceLoggingBool(m_telemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(m_telemetryHelper.GetAppName().c_str(), "AppName"));
}
}
CATCH_LOG()
DEFINE_EVENT_METHOD(LogUnregister)(
winrt::hresult hr,
std::wstring const& appId) noexcept try
BEGIN_COMPLIANT_MEASURES_ACTIVITY_CLASS(Register, PDT_ProductAndServicePerformance);
DEFINE_ACTIVITY_START(NotificationTelemetryHelper& notificationTelemetryHelper, std::wstring const& appId)
{
if (m_telemetryHelper.ShouldLogEvent())
{
TraceLoggingClassWriteMeasure(
"Unregister",
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance),
TraceLoggingClassWriteStart(
Register,
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingHexUInt32(hr, "OperationResult"),
TraceLoggingWideString(appId.c_str(), "AppId"),
TraceLoggingBool(m_telemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(m_telemetryHelper.GetAppName().c_str(), "AppName"));
TraceLoggingBool(notificationTelemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(notificationTelemetryHelper.GetAppName().c_str(), "AppName"));
}
}
CATCH_LOG()
END_ACTIVITY_CLASS();
DEFINE_EVENT_METHOD(LogUnregisterAll)(
winrt::hresult hr,
std::wstring const& appId) noexcept try
BEGIN_COMPLIANT_MEASURES_ACTIVITY_CLASS(Unregister, PDT_ProductAndServicePerformance);
DEFINE_ACTIVITY_START(NotificationTelemetryHelper& notificationTelemetryHelper, std::wstring const& appId)
{
if (m_telemetryHelper.ShouldLogEvent())
{
TraceLoggingClassWriteMeasure(
"UnregisterAll",
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance),
TraceLoggingClassWriteStart(
Unregister,
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingHexUInt32(hr, "OperationResult"),
TraceLoggingWideString(appId.c_str(), "AppId"),
TraceLoggingBool(m_telemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(m_telemetryHelper.GetAppName().c_str(), "AppName"));
TraceLoggingBool(notificationTelemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(notificationTelemetryHelper.GetAppName().c_str(), "AppName"));
}
}
CATCH_LOG()
END_ACTIVITY_CLASS();
DEFINE_EVENT_METHOD(LogShow)(
winrt::hresult hr,
BEGIN_COMPLIANT_MEASURES_ACTIVITY_CLASS(UnregisterAll, PDT_ProductAndServicePerformance);
DEFINE_ACTIVITY_START(NotificationTelemetryHelper& notificationTelemetryHelper, std::wstring const& appId)
{
TraceLoggingClassWriteStart(
UnregisterAll,
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingWideString(appId.c_str(), "AppId"),
TraceLoggingBool(notificationTelemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(notificationTelemetryHelper.GetAppName().c_str(), "AppName"));
}
END_ACTIVITY_CLASS();
BEGIN_COMPLIANT_MEASURES_ACTIVITY_CLASS(Show, PDT_ProductAndServicePerformance);
DEFINE_ACTIVITY_START(
NotificationTelemetryHelper& notificationTelemetryHelper,
std::wstring const& appId,
winrt::hstring const& payload,
winrt::hstring const& tag,
winrt::hstring const& group) noexcept try
winrt::hstring const& group)
{
if (m_telemetryHelper.ShouldLogEvent())
{
TraceLoggingClassWriteMeasure(
"Show",
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance),
TraceLoggingClassWriteStart(
Show,
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingHexUInt32(hr, "OperationResult"),
TraceLoggingWideString(appId.c_str(), "AppId"),
TraceLoggingUInt32(payload.size(), "PayloadSize"),
TraceLoggingUInt32(tag.size(), "TagSize"),
TraceLoggingUInt32(group.size(), "GroupSize"),
TraceLoggingBool(m_telemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(m_telemetryHelper.GetAppName().c_str(), "AppName"));
TraceLoggingBool(notificationTelemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(notificationTelemetryHelper.GetAppName().c_str(), "AppName"));
}
}
CATCH_LOG()
END_ACTIVITY_CLASS();
DEFINE_EVENT_METHOD(LogUpdateAsync)(
winrt::hresult hr,
BEGIN_COMPLIANT_MEASURES_ACTIVITY_CLASS(UpdateAsync, PDT_ProductAndServicePerformance);
DEFINE_ACTIVITY_START(
NotificationTelemetryHelper& notificationTelemetryHelper,
std::wstring const& appId,
winrt::hstring const& tag,
winrt::hstring const& group) noexcept try
winrt::hstring const& group)
{
if (m_telemetryHelper.ShouldLogEvent())
{
TraceLoggingClassWriteMeasure(
"UpdateAsync",
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance),
TraceLoggingClassWriteStart(
UpdateAsync,
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingHexUInt32(hr, "OperationResult"),
TraceLoggingWideString(appId.c_str(), "AppId"),
TraceLoggingUInt32(tag.size(), "TagSize"),
TraceLoggingUInt32(group.size(), "GroupSize"),
TraceLoggingBool(m_telemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(m_telemetryHelper.GetAppName().c_str(), "AppName"));
TraceLoggingBool(notificationTelemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(notificationTelemetryHelper.GetAppName().c_str(), "AppName"));
}
}
CATCH_LOG()
END_ACTIVITY_CLASS();
DEFINE_EVENT_METHOD(LogSetting)(
winrt::hresult hr,
std::wstring const& appId) noexcept try
BEGIN_COMPLIANT_MEASURES_ACTIVITY_CLASS(Setting, PDT_ProductAndServicePerformance);
DEFINE_ACTIVITY_START(
NotificationTelemetryHelper& notificationTelemetryHelper,
std::wstring const& appId)
{
if (m_telemetryHelper.ShouldLogEvent())
{
TraceLoggingClassWriteMeasure(
"Setting",
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance),
TraceLoggingClassWriteStart(
Setting,
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingHexUInt32(hr, "OperationResult"),
TraceLoggingWideString(appId.c_str(), "AppId"),
TraceLoggingBool(m_telemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(m_telemetryHelper.GetAppName().c_str(), "AppName"));
TraceLoggingBool(notificationTelemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(notificationTelemetryHelper.GetAppName().c_str(), "AppName"));
}
}
CATCH_LOG()
END_ACTIVITY_CLASS();
DEFINE_EVENT_METHOD(LogRemoveByIdAsync)(
winrt::hresult hr,
BEGIN_COMPLIANT_MEASURES_ACTIVITY_CLASS(RemoveByIdAsync, PDT_ProductAndServicePerformance);
DEFINE_ACTIVITY_START(
NotificationTelemetryHelper& notificationTelemetryHelper,
std::wstring const& appId,
uint32_t notificationId) noexcept try
uint32_t notificationId)
{
if (m_telemetryHelper.ShouldLogEvent())
{
TraceLoggingClassWriteMeasure(
"RemoveByIdAsync",
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance),
TraceLoggingClassWriteStart(
RemoveByIdAsync,
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingHexUInt32(hr, "OperationResult"),
TraceLoggingWideString(appId.c_str(), "AppId"),
TraceLoggingHexUInt32(notificationId, "NotificationId"),
TraceLoggingBool(m_telemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(m_telemetryHelper.GetAppName().c_str(), "AppName"));
TraceLoggingBool(notificationTelemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(notificationTelemetryHelper.GetAppName().c_str(), "AppName"));
}
}
CATCH_LOG()
END_ACTIVITY_CLASS();
DEFINE_EVENT_METHOD(LogRemoveByTagAsync)(
winrt::hresult hr,
BEGIN_COMPLIANT_MEASURES_ACTIVITY_CLASS(RemoveByTagAsync, PDT_ProductAndServicePerformance);
DEFINE_ACTIVITY_START(
NotificationTelemetryHelper& notificationTelemetryHelper,
std::wstring const& appId,
winrt::hstring const& tag) noexcept try
winrt::hstring const& tag)
{
if (m_telemetryHelper.ShouldLogEvent())
{
TraceLoggingClassWriteMeasure(
"RemoveByTagAsync",
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance),
TraceLoggingClassWriteStart(
RemoveByTagAsync,
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingHexUInt32(hr, "OperationResult"),
TraceLoggingWideString(appId.c_str(), "AppId"),
TraceLoggingUInt32(tag.size(), "TagSize"),
TraceLoggingBool(m_telemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(m_telemetryHelper.GetAppName().c_str(), "AppName"));
TraceLoggingBool(notificationTelemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(notificationTelemetryHelper.GetAppName().c_str(), "AppName"));
}
}
CATCH_LOG()
END_ACTIVITY_CLASS();
DEFINE_EVENT_METHOD(LogRemoveByTagAndGroupAsync)(
winrt::hresult hr,
BEGIN_COMPLIANT_MEASURES_ACTIVITY_CLASS(RemoveByTagAndGroupAsync, PDT_ProductAndServicePerformance);
DEFINE_ACTIVITY_START(
NotificationTelemetryHelper& notificationTelemetryHelper,
std::wstring const& appId,
winrt::hstring const& tag,
winrt::hstring const& group) noexcept try
winrt::hstring const& group)
{
if (m_telemetryHelper.ShouldLogEvent())
{
TraceLoggingClassWriteMeasure(
"RemoveByTagAndGroupAsync",
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance),
TraceLoggingClassWriteStart(
RemoveByTagAndGroupAsync,
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingHexUInt32(hr, "OperationResult"),
TraceLoggingWideString(appId.c_str(), "AppId"),
TraceLoggingUInt32(tag.size(), "TagSize"),
TraceLoggingUInt32(group.size(), "GroupSize"),
TraceLoggingBool(m_telemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(m_telemetryHelper.GetAppName().c_str(), "AppName"));
TraceLoggingBool(notificationTelemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(notificationTelemetryHelper.GetAppName().c_str(), "AppName"));
}
}
CATCH_LOG()
END_ACTIVITY_CLASS();
DEFINE_EVENT_METHOD(LogRemoveByGroupAsync)(
winrt::hresult hr,
std::wstring const& appId) noexcept try
BEGIN_COMPLIANT_MEASURES_ACTIVITY_CLASS(RemoveByGroupAsync, PDT_ProductAndServicePerformance);
DEFINE_ACTIVITY_START(
NotificationTelemetryHelper& notificationTelemetryHelper,
std::wstring const& appId,
winrt::hstring const& group)
{
if (m_telemetryHelper.ShouldLogEvent())
{
TraceLoggingClassWriteMeasure(
"RemoveByGroupAsync",
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance),
TraceLoggingClassWriteStart(
RemoveByGroupAsync,
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingHexUInt32(hr, "OperationResult"),
TraceLoggingWideString(appId.c_str(), "AppId"),
TraceLoggingBool(m_telemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(m_telemetryHelper.GetAppName().c_str(), "AppName"));
TraceLoggingUInt32(group.size(), "GroupSize"),
TraceLoggingBool(notificationTelemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(notificationTelemetryHelper.GetAppName().c_str(), "AppName"));
}
}
CATCH_LOG()
END_ACTIVITY_CLASS();
DEFINE_EVENT_METHOD(LogRemoveAllAsync)(
winrt::hresult hr,
std::wstring const& appId) noexcept try
BEGIN_COMPLIANT_MEASURES_ACTIVITY_CLASS(RemoveAllAsync, PDT_ProductAndServicePerformance);
DEFINE_ACTIVITY_START(
NotificationTelemetryHelper& notificationTelemetryHelper,
std::wstring const& appId)
{
if (m_telemetryHelper.ShouldLogEvent())
{
TraceLoggingClassWriteMeasure(
"RemoveAllAsync",
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance),
TraceLoggingClassWriteStart(
RemoveAllAsync,
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingHexUInt32(hr, "OperationResult"),
TraceLoggingWideString(appId.c_str(), "AppId"),
TraceLoggingBool(m_telemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(m_telemetryHelper.GetAppName().c_str(), "AppName"));
TraceLoggingBool(notificationTelemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(notificationTelemetryHelper.GetAppName().c_str(), "AppName"));
}
}
CATCH_LOG()
END_ACTIVITY_CLASS();
DEFINE_EVENT_METHOD(LogGetAllAsync)(
winrt::hresult hr,
std::wstring const& appId) noexcept try
BEGIN_COMPLIANT_MEASURES_ACTIVITY_CLASS(GetAllAsync, PDT_ProductAndServicePerformance);
DEFINE_ACTIVITY_START(
NotificationTelemetryHelper& notificationTelemetryHelper,
std::wstring const& appId)
{
if (m_telemetryHelper.ShouldLogEvent())
{
TraceLoggingClassWriteMeasure(
"GetAllAsync",
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance),
TraceLoggingClassWriteStart(
GetAllAsync,
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingHexUInt32(hr, "OperationResult"),
TraceLoggingWideString(appId.c_str(), "AppId"),
TraceLoggingBool(m_telemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(m_telemetryHelper.GetAppName().c_str(), "AppName"));
TraceLoggingBool(notificationTelemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(notificationTelemetryHelper.GetAppName().c_str(), "AppName"));
}
}
CATCH_LOG()
END_ACTIVITY_CLASS();
DEFINE_EVENT_METHOD(LogActivated)(
winrt::hresult hr,
BEGIN_COMPLIANT_MEASURES_ACTIVITY_CLASS(Activated, PDT_ProductAndServicePerformance);
DEFINE_ACTIVITY_START(
NotificationTelemetryHelper& notificationTelemetryHelper,
std::wstring const& appId,
winrt::hstring const& arguments,
bool firstNotificationReceived,
bool hasNotificationHandlers) noexcept try
bool hasNotificationHandlers)
{
if (m_telemetryHelper.ShouldLogEvent())
{
TraceLoggingClassWriteMeasure(
"Activated",
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance),
TraceLoggingClassWriteStart(
Activated,
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingHexUInt32(hr, "OperationResult"),
TraceLoggingWideString(appId.c_str(), "AppId"),
TraceLoggingUInt32(arguments.size(), "ArgumentsSize"),
TraceLoggingBool(firstNotificationReceived, "FirstNotificationReceived"),
TraceLoggingBool(hasNotificationHandlers, "HasNotificationHandlers"),
TraceLoggingBool(m_telemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(m_telemetryHelper.GetAppName().c_str(), "AppName"));
TraceLoggingBool(notificationTelemetryHelper.IsPackagedApp(), "IsAppPackaged"),
TraceLoggingWideString(notificationTelemetryHelper.GetAppName().c_str(), "AppName"));
}
}
CATCH_LOG()
private:
NotificationTelemetryHelper m_telemetryHelper;
END_ACTIVITY_CLASS();
};

3
test/AppNotificationTests/AppNotifications.Test.h
Просмотреть файл

@ -129,8 +129,9 @@ namespace AppNotifications::Test
break;
case ExpectedTransientProperties::DEFAULT:
// The default priority value is Default, and the default for SuppressDisplay is false.
VERIFY_ARE_EQUAL(winrt::Microsoft::Windows::AppNotifications::AppNotificationPriority::Default, actual.Priority());
VERIFY_IS_TRUE(actual.SuppressDisplay());
VERIFY_IS_FALSE(actual.SuppressDisplay());
break;
case ExpectedTransientProperties::UNKNOWN:

2
test/AppNotificationTests/UnpackagedTests.cpp
Просмотреть файл

@ -110,7 +110,7 @@ void UnpackagedTests::VerifyGetAllAsyncWithZeroActiveToast()
void UnpackagedTests::VerifyGetAllAsyncWithOneActiveToast()
{
BaseTestSuite::VerifyGetAllAsyncWithZeroActiveToast();
BaseTestSuite::VerifyGetAllAsyncWithOneActiveToast();
}
void UnpackagedTests::VerifyGetAllAsyncWithMultipleActiveToasts()