Simplify class NotificationTemplateBuilder to a single public function

Bug: 888276
Change-Id: Ibd3e557ad55ff48daf1e3347ec27ff6fd235a47f
Reviewed-on: https://chromium-review.googlesource.com/c/1311837
Commit-Queue: Xi Cheng <chengx@chromium.org>
Reviewed-by: Greg Thompson <grt@chromium.org>
Cr-Commit-Position: refs/heads/master@{#605223}

chrome/browser/notifications/notification_platform_bridge_win.cc

@@ -146,13 +146,13 @@ class NotificationPlatformBridgeWinImpl
         image_retainer_->GetCleanupTask());
   }
 
-  // Obtain an IToastNotification interface from a given XML (provided by the
-  // NotificationTemplateBuilder). This function is only used when displaying
-  // notification in production code, which explains why the UMA metrics record
-  // within are classified with the display path.
+  // Obtain an IToastNotification interface from a given XML as in
+  // |xml_template|. This function is only used when displaying notification in
+  // production code, which explains why the UMA metrics record within are
+  // classified with the display path.
   mswr::ComPtr<winui::Notifications::IToastNotification> GetToastNotification(
       const message_center::Notification& notification,
-      const NotificationTemplateBuilder& notification_template_builder,
+      const base::string16& xml_template,
       const std::string& profile_id,
       bool incognito) {
     ScopedHString ref_class_name =
@@ -176,9 +176,7 @@ class NotificationPlatformBridgeWinImpl
       return nullptr;
     }
 
-    base::string16 notification_template =
-        notification_template_builder.GetNotificationTemplate();
-    ScopedHString ref_template = ScopedHString::Create(notification_template);
+    ScopedHString ref_template = ScopedHString::Create(xml_template);
     hr = document_io->LoadXml(ref_template.get());
     if (FAILED(hr)) {
       LogDisplayHistogram(DisplayStatus::LOAD_XML_FAILED);
@@ -350,11 +348,10 @@ class NotificationPlatformBridgeWinImpl
     NotificationLaunchId launch_id(notification_type, notification->id(),
                                    profile_id, incognito,
                                    notification->origin_url());
-    std::unique_ptr<NotificationTemplateBuilder> notification_template =
-        NotificationTemplateBuilder::Build(image_retainer_.get(), launch_id,
-                                           *notification);
+    base::string16 xml_template = BuildNotificationTemplate(
+        image_retainer_.get(), launch_id, *notification);
     mswr::ComPtr<winui::Notifications::IToastNotification> toast =
-        GetToastNotification(*notification, *notification_template, profile_id,
+        GetToastNotification(*notification, xml_template, profile_id,
                              incognito);
     if (!toast)
       return;
@@ -906,9 +903,9 @@ void NotificationPlatformBridgeWin::SetNotifierForTesting(
 mswr::ComPtr<winui::Notifications::IToastNotification>
 NotificationPlatformBridgeWin::GetToastNotificationForTesting(
     const message_center::Notification& notification,
-    const NotificationTemplateBuilder& notification_template_builder,
+    const base::string16& xml_template,
     const std::string& profile_id,
     bool incognito) {
-  return impl_->GetToastNotification(
-      notification, notification_template_builder, profile_id, incognito);
+  return impl_->GetToastNotification(notification, xml_template, profile_id,
+                                     incognito);
 }

chrome/browser/notifications/notification_platform_bridge_win.h

@@ -80,7 +80,7 @@ class NotificationPlatformBridgeWin : public NotificationPlatformBridge {
   Microsoft::WRL::ComPtr<ABI::Windows::UI::Notifications::IToastNotification>
   GetToastNotificationForTesting(
       const message_center::Notification& notification,
-      const NotificationTemplateBuilder& notification_template_builder,
+      const base::string16& xml_template,
       const std::string& profile_id,
       bool incognito);
 

chrome/browser/notifications/notification_platform_bridge_win_unittest.cc

@@ -73,12 +73,11 @@ class NotificationPlatformBridgeWinTest : public testing::Test {
         message_center::RichNotificationData(), nullptr /* delegate */);
     notification->set_renotify(renotify);
     MockNotificationImageRetainer image_retainer;
-    std::unique_ptr<NotificationTemplateBuilder> builder =
-        NotificationTemplateBuilder::Build(&image_retainer, launch_id,
-                                           *notification);
+    base::string16 xml_template =
+        BuildNotificationTemplate(&image_retainer, launch_id, *notification);
 
     mswr::ComPtr<winui::Notifications::IToastNotification> toast =
-        bridge->GetToastNotificationForTesting(*notification, *builder,
+        bridge->GetToastNotificationForTesting(*notification, xml_template,
                                                profile_id, incognito);
     if (!toast) {
       LOG(ERROR) << "GetToastNotificationForTesting failed";

chrome/browser/notifications/win/notification_template_builder.h

@@ -5,26 +5,12 @@
 #ifndef CHROME_BROWSER_NOTIFICATIONS_WIN_NOTIFICATION_TEMPLATE_BUILDER_H_
 #define CHROME_BROWSER_NOTIFICATIONS_WIN_NOTIFICATION_TEMPLATE_BUILDER_H_
 
-#include <memory>
-#include <string>
-#include <vector>
-
-#include "base/macros.h"
 #include "base/strings/string16.h"
-#include "chrome/browser/notifications/notification_common.h"
 
-class GURL;
 class NotificationLaunchId;
-class XmlWriter;
-
-namespace gfx {
-class Image;
-}
 
 namespace message_center {
-struct ButtonInfo;
 class Notification;
-struct NotificationItem;
 }  // namespace message_center
 
 class NotificationImageRetainer;
@@ -35,115 +21,16 @@ extern const char kNotificationToastElement[];
 // The Notification Launch attribute name in the toast XML.
 extern const char kNotificationLaunchAttribute[];
 
-// Builds XML-based notification templates for displaying a given notification
+// Builds XML-based notification template for displaying a given |notification|
 // in the Windows Action Center.
-//
 // https://docs.microsoft.com/en-us/windows/uwp/controls-and-patterns/tiles-and-notifications-adaptive-interactive-toasts
-//
-// libXml was preferred (over WinXml, which the samples tend to use) because it
-// is used frequently in Chrome, is nicer to use and has already been vetted.
-class NotificationTemplateBuilder {
- public:
-  // Builds the notification template for the given |notification|.
-  static std::unique_ptr<NotificationTemplateBuilder> Build(
-      NotificationImageRetainer* image_retainer,
-      const NotificationLaunchId& launch_id,
-      const message_center::Notification& notification);
-
-  // Set label for the context menu item in testing. The caller owns |label| and
-  // is responsible for resetting the override back to nullptr.
-  static void OverrideContextMenuLabelForTesting(const char* label);
-
-  ~NotificationTemplateBuilder();
-
-  // Gets the XML template that was created by this builder.
-  base::string16 GetNotificationTemplate() const;
-
- private:
-  // The different types of text nodes to output.
-  enum class TextType { NORMAL, ATTRIBUTION };
-
-  NotificationTemplateBuilder();
-
-  // Formats the |origin| for display in the notification template.
-  std::string FormatOrigin(const GURL& origin) const;
-
-  // Writes the <toast> element with a given |launch_attribute|.
-  // Also closes the |xml_writer_| for writing as the toast is now complete.
-  void StartToastElement(const NotificationLaunchId& launch_id,
-                         const message_center::Notification& notification);
-  void EndToastElement();
-
-  // Writes the <visual> element.
-  void StartVisualElement();
-  void EndVisualElement();
-
-  // Writes the <binding> element with the given |template_name|.
-  void StartBindingElement(const std::string& template_name);
-  void EndBindingElement();
-
-  // Writes the <text> element with the given |content|. If |text_type| is
-  // ATTRIBUTION then |content| is treated as the source that the notification
-  // is attributed to.
-  void WriteTextElement(const std::string& content, TextType text_type);
-
-  // Writes the <text> element containing the list entries.
-  void WriteItems(const std::vector<message_center::NotificationItem>& items);
-
-  // Writes the <image> element for the notification icon.
-  void WriteIconElement(NotificationImageRetainer* image_retainer,
-                        const message_center::Notification& notification);
-
-  // Writes the <image> element for showing a large image within the
-  // notification body.
-  void WriteLargeImageElement(NotificationImageRetainer* image_retainer,
-                              const message_center::Notification& notification);
-
-  // A helper for constructing image xml.
-  void WriteImageElement(NotificationImageRetainer* image_retainer,
-                         const gfx::Image& image,
-                         const std::string& placement,
-                         const std::string& hint_crop);
-
-  // Adds a progress bar to the notification XML.
-  void WriteProgressElement(const message_center::Notification& notification);
-
-  // Writes the <actions> element.
-  void StartActionsElement();
-  void EndActionsElement();
-
-  // Writes the <audio silent="true"> element.
-  void WriteAudioSilentElement();
-
-  // Fills in the details for the actions (the buttons the notification
-  // contains).
-  void AddActions(NotificationImageRetainer* image_retainer,
-                  const message_center::Notification& notification,
-                  const NotificationLaunchId& launch_id);
-  void WriteActionElement(NotificationImageRetainer* image_retainer,
-                          const message_center::ButtonInfo& button,
-                          int index,
-                          NotificationLaunchId copied_launch_id);
-
-  // Adds context menu actions to the notification sent by |origin|.
-  void AddContextMenu(NotificationLaunchId copied_launch_id);
-  void WriteContextMenuElement(const std::string& content,
-                               const std::string& arguments);
-
-  // Ensures that every reminder has at least one button, as the Action Center
-  // does not respect the Reminder setting on notifications with no buttons, so
-  // we must add a Dismiss button to the notification for those cases. For more
-  // details, see issue https://crbug.com/781792.
-  void EnsureReminderHasButton(const message_center::Notification& notification,
-                               NotificationLaunchId copied_launch_id);
-
-  // Label to override context menu items in tests.
-  static const char* context_menu_label_override_;
-
-  // The XML writer to which the template will be written.
-  std::unique_ptr<XmlWriter> xml_writer_;
-
-  DISALLOW_COPY_AND_ASSIGN(NotificationTemplateBuilder);
-};
+base::string16 BuildNotificationTemplate(
+    NotificationImageRetainer* image_retainer,
+    const NotificationLaunchId& launch_id,
+    const message_center::Notification& notification);
+
+// Sets the label of the context menu for testing. The caller owns |label| and
+// is responsible for resetting the override back to nullptr.
+void SetContextMenuLabelForTesting(const char* label);
 
 #endif  // CHROME_BROWSER_NOTIFICATIONS_WIN_NOTIFICATION_TEMPLATE_BUILDER_H_