File: show_notification_action_performer.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (333 lines) | stat: -rw-r--r-- 12,508 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/browser/ash/growth/show_notification_action_performer.h"

#include <memory>
#include <string>
#include <vector>

#include "ash/constants/notifier_catalogs.h"
#include "ash/public/cpp/notification_utils.h"
#include "ash/system/notification_center/message_view_factory.h"
#include "base/functional/bind.h"
#include "base/logging.h"
#include "base/strings/stringprintf.h"
#include "base/strings/utf_string_conversions.h"
#include "base/values.h"
#include "chrome/browser/ash/growth/metrics.h"
#include "chromeos/ash/components/growth/action_performer.h"
#include "chromeos/ash/components/growth/campaigns_logger.h"
#include "chromeos/ash/components/growth/campaigns_manager.h"
#include "chromeos/ash/components/growth/campaigns_model.h"
#include "chromeos/ash/components/growth/growth_metrics.h"
#include "chromeos/ash/grit/ash_resources.h"
#include "ui/base/resource/resource_bundle.h"
#include "ui/gfx/image/image.h"
#include "ui/gfx/vector_icon_utils.h"
#include "ui/message_center/message_center.h"
#include "ui/message_center/public/cpp/notification.h"
#include "ui/message_center/public/cpp/notification_delegate.h"
#include "url/gurl.h"

namespace {

constexpr char kTitlePath[] = "title";
constexpr char kMessagePath[] = "message";
constexpr char kIconPath[] = "sourceIcon";
constexpr char kButtonsPath[] = "buttons";
constexpr char kLabelPath[] = "label";
constexpr char kMarkDismissedPath[] = "shouldMarkDismissed";
constexpr char kActionPath[] = "action";
constexpr char kMarkDismissedOnClosePath[] = "shouldMarkDismissOnClose";
constexpr char kLogCrOSEventsPath[] = "shouldLogCrOSEvents";
constexpr char kImagePath[] = "image";
constexpr char kNotificationIdTemplate[] = "growth_campaign_%d";

struct ShowNotificationParams {
  std::string title;
  std::string message;
  bool should_mark_dismissed_on_close = false;
  bool should_log_cros_events = false;
  raw_ptr<const gfx::VectorIcon> icon = nullptr;
  raw_ptr<const gfx::Image> image = nullptr;

  std::vector<message_center::ButtonInfo> buttons_info;
};

std::unique_ptr<ShowNotificationParams>
ParseShowNotificationActionPerformerParams(const base::Value::Dict* params) {
  if (!params) {
    CAMPAIGNS_LOG(ERROR)
        << "Empty parameter to ShowNotificationActionPerformer.";
    return nullptr;
  }

  auto show_notification_params = std::make_unique<ShowNotificationParams>();

  const auto* title = params->FindString(kTitlePath);
  const auto* message = params->FindString(kMessagePath);
  show_notification_params->title = title ? *title : std::string();
  show_notification_params->message = message ? *message : std::string();

  show_notification_params->should_mark_dismissed_on_close =
      params->FindBool(kMarkDismissedOnClosePath).value_or(false);

  show_notification_params->should_log_cros_events =
      params->FindBool(kLogCrOSEventsPath).value_or(false);

  // Set icons if available.
  const auto* icon_value = params->FindDict(kIconPath);
  if (!icon_value) {
    // TODO: b/331633771 - Consider adding default icon for notification.
    growth::RecordCampaignsManagerError(
        growth::CampaignsManagerError::kNotificationPayloadMissingIcon);
    CAMPAIGNS_LOG(ERROR) << "icon is required for notification.";
    return nullptr;
  }

  const auto* icon = growth::VectorIcon(icon_value).GetVectorIcon();
  if (!icon) {
    growth::RecordCampaignsManagerError(
        growth::CampaignsManagerError::kNotificationPayloadInvalidIcon);
    return nullptr;
  }
  show_notification_params->icon = icon;

  const auto* image_dict = params->FindDict(kImagePath);
  if (image_dict) {
    // TODO: b/341368196 - consider skip showing the notification if the image
    // type is not recognized. The payload is invalid in this case.
    show_notification_params->image = growth::Image(image_dict).GetImage();
  }

  // Set buttons info.
  const auto* buttons = params->FindList(kButtonsPath);
  if (buttons) {
    for (auto button_it = buttons->begin(); button_it != buttons->end();
         button_it++) {
      if (!button_it->is_dict()) {
        growth::RecordCampaignsManagerError(
            growth::CampaignsManagerError::kNotificationPayloadInvalidButton);
        continue;
      }

      auto* const label = button_it->GetDict().FindString(kLabelPath);
      if (!label) {
        growth::RecordCampaignsManagerError(
            growth::CampaignsManagerError::
                kNotificationPayloadMissingButtonLabel);
        continue;
      }

      show_notification_params->buttons_info.emplace_back(
          base::UTF8ToUTF16(*label));
    }
  }

  return show_notification_params;
}

std::string GetNotificationId(int campaign_id) {
  return base::StringPrintf(kNotificationIdTemplate, campaign_id);
}

}  // namespace

HandleNotificationClickAndCloseDelegate::
    HandleNotificationClickAndCloseDelegate(
        const base::Value::Dict* params,
        const ButtonClickCallback& click_callback,
        const CloseCallback& close_callback)
    :  // Copy ctor and assignment of Dict are not allowed. Need to use Clone()
       // explicitly.
       // `params` are currently owned by CampaignManager. When campaigns are
       // reloaded at session start (e.g: lock and unlock), the memory will
       // become invalid, so store the value in
       // HandleNotificationClickAndCloseDelegate.
       // HandleNotificationClickAndCloseDelegate is one instance per
       // notification.
      params_(params->Clone()),
      click_callback_(click_callback),
      close_callback_(close_callback) {}
HandleNotificationClickAndCloseDelegate::
    ~HandleNotificationClickAndCloseDelegate() = default;

void HandleNotificationClickAndCloseDelegate::Click(
    const std::optional<int>& button_index,
    const std::optional<std::u16string>& reply) {
  if (button_index) {
    button_clicked_ = true;
  }

  if (click_callback_.is_null()) {
    return;
  }

  // Need to make another clone here because the Dict value is passed to
  // multiple functions. If pass by reference, current test will fail due to
  // dangling pointer.
  click_callback_.Run(params_.Clone(), button_index);
}

void HandleNotificationClickAndCloseDelegate::Close(bool by_user) {
  // Click any button in the notification will also trigger `Close()`.
  // Return here because we only want to log the close metric with explicit
  // close actions, such as clicking the close button.
  if (button_clicked_) {
    return;
  }

  if (close_callback_.is_null()) {
    return;
  }
  close_callback_.Run(by_user);
}

DEFINE_CLASS_ELEMENT_IDENTIFIER_VALUE(ShowNotificationActionPerformer,
                                      kBubbleIdForTesting);

ShowNotificationActionPerformer::ShowNotificationActionPerformer() = default;
ShowNotificationActionPerformer::~ShowNotificationActionPerformer() = default;

void ShowNotificationActionPerformer::Run(
    int campaign_id,
    std::optional<int> group_id,
    const base::Value::Dict* params,
    growth::ActionPerformer::Callback callback) {
  // Cache the campaign ID
  current_campaign_id_ = campaign_id;
  auto show_notification_params =
      ParseShowNotificationActionPerformerParams(params);
  if (!show_notification_params) {
    growth::RecordCampaignsManagerError(
        growth::CampaignsManagerError::kInvalidNotificationPayload);
    std::move(callback).Run(growth::ActionResult::kFailure,
                            growth::ActionResultReason::kParsingActionFailed);
    return;
  }

  message_center::RichNotificationData optional_fields;
  optional_fields.buttons = std::move(show_notification_params->buttons_info);
  if (show_notification_params->image) {
    optional_fields.image = *show_notification_params->image;
  }

  auto id = GetNotificationId(campaign_id);
  std::unique_ptr<message_center::Notification> notification =
      ash::CreateSystemNotificationPtr(
          message_center::NOTIFICATION_TYPE_SIMPLE, id,
          base::UTF8ToUTF16(show_notification_params->title),
          base::UTF8ToUTF16(show_notification_params->message),
          /*display_source=*/std::u16string(),
          /*origin_url=*/GURL(),
          message_center::NotifierId(
              message_center::NotifierType::SYSTEM_COMPONENT, id,
              ash::NotificationCatalogName::kGrowthFramework),
          optional_fields,
          base::MakeRefCounted<HandleNotificationClickAndCloseDelegate>(
              params,
              base::BindRepeating(
                  &ShowNotificationActionPerformer::HandleNotificationClicked,
                  weak_ptr_factory_.GetWeakPtr(), id, campaign_id, group_id,
                  show_notification_params->should_log_cros_events),
              base::BindRepeating(
                  &ShowNotificationActionPerformer::HandleNotificationClose,
                  weak_ptr_factory_.GetWeakPtr(), campaign_id, group_id,
                  show_notification_params->should_mark_dismissed_on_close,
                  show_notification_params->should_log_cros_events)),
          *show_notification_params->icon,
          message_center::SystemNotificationWarningLevel::NORMAL);
  notification->set_host_view_element_id(kBubbleIdForTesting);

  auto* message_center = message_center::MessageCenter::Get();
  CHECK(message_center);

  message_center->RemoveNotification(notification->id(),
                                     /*by_user=*/false);
  message_center->AddNotification(std::move(notification));

  NotifyReadyToLogImpression(campaign_id, group_id,
                             show_notification_params->should_log_cros_events);
  std::move(callback).Run(growth::ActionResult::kSuccess,
                          /*action_result_reason=*/std::nullopt);
}

growth::ActionType ShowNotificationActionPerformer::ActionType() const {
  return growth::ActionType::kShowNotification;
}

void ShowNotificationActionPerformer::HandleNotificationClose(
    int campaign_id,
    std::optional<int> group_id,
    bool should_mark_dismissed,
    bool should_log_cros_events,
    bool by_user) {
  if (!by_user) {
    return;
  }

  // Dismiss and marked the notification dismissed as it is by user action.
  NotifyButtonPressed(campaign_id, group_id, CampaignButtonId::kClose,
                      should_mark_dismissed, should_log_cros_events);
}

void ShowNotificationActionPerformer::HandleNotificationClicked(
    const std::string& notification_id,
    int campaign_id,
    std::optional<int> group_id,
    bool should_log_cros_events,
    base::Value::Dict params,
    std::optional<int> button_index) {
  if (!button_index) {
    // Notification message body clicked.
    return;
  }

  auto button_index_value = button_index.value();
  auto button_id = CampaignButtonId::kOthers;
  if (button_index_value == 0) {
    button_id = CampaignButtonId::kPrimary;
  } else if (button_index_value == 1) {
    button_id = CampaignButtonId::kSecondary;
  }

  const auto* buttons_value = params.FindList(kButtonsPath);
  CHECK(buttons_value);

  const auto& button_value = (*buttons_value)[button_index_value];
  if (!button_value.is_dict()) {
    CAMPAIGNS_LOG(ERROR) << "Invalid button payload.";
    return;
  }

  const auto should_mark_dismissed =
      button_value.GetDict().FindBool(kMarkDismissedPath).value_or(false);
  NotifyButtonPressed(campaign_id, group_id, button_id, should_mark_dismissed,
                      should_log_cros_events);

  const auto* action_value = button_value.GetDict().FindDict(kActionPath);
  if (!action_value) {
    growth::RecordCampaignsManagerError(
        growth::CampaignsManagerError::kNotificationPayloadMissingButtonAction);
    CAMPAIGNS_LOG(ERROR) << "Missing action.";
    return;
  }
  auto action = growth::Action(action_value);
  if (action.GetActionType() == growth::ActionType::kDismiss) {
    message_center::MessageCenter::Get()->RemoveNotification(notification_id,
                                                             /* by_user=*/true);
    return;
  }

  auto* campaigns_manager = growth::CampaignsManager::Get();
  CHECK(campaigns_manager);

  campaigns_manager->PerformAction(campaign_id, group_id, &action);

  // Explicitly remove the notification as the notification framework doesn't
  // automatically close at buttons click.
  message_center::MessageCenter::Get()->RemoveNotification(notification_id,
                                                           /* by_user=*/true);
}