Migrate extension notifications to the new NotificationDisplayService

chrome/browser/extensions/api/notifications/extension_notification_display_helper.h

+// Copyright 2017 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef CHROME_BROWSER_EXTENSIONS_API_NOTIFICATIONS_EXTENSION_NOTIFICATION_DISPLAY_HELPER_H_
+#define CHROME_BROWSER_EXTENSIONS_API_NOTIFICATIONS_EXTENSION_NOTIFICATION_DISPLAY_HELPER_H_
+
+#include <memory>
+#include <set>
+#include <string>
+#include <unordered_map>

[Devlin, 2017/04/10 21:23:55]

needed?

[Peter Beverloo, 2017/04/10 23:30:06]

Will remove.

[Peter Beverloo, 2017/04/11 14:19:24]

Done.

+#include <vector>
+
+#include "base/macros.h"
+#include "chrome/browser/notifications/notification.h"

[Devlin, 2017/04/10 21:23:55]

needed?  If so, remove the forward declaration.  If not, move to the .cc.

[Peter Beverloo, 2017/04/10 23:30:06]

Nope, I'm able to forward declare.

[Peter Beverloo, 2017/04/11 14:19:24]

Done.

+#include "components/keyed_service/core/keyed_service.h"
+
+class GURL;
+class Notification;
+class NotificationDisplayService;
+class Profile;
+
+namespace extensions {
+
+// Helper class for displaying notifications through the notification display
+// service. The NDS supports notifications that can outlive the browser process,
+// and therefore does not retain as much information as is necessary to support
+// the extensions API. (Notably the ability to partly update notifications.)
+class ExtensionNotificationDisplayHelper : public KeyedService {

[Devlin, 2017/04/11 01:51:56]

Forgot one comment - is there a reason this needs to be a KeyedService, rather
than being owned by the NotificationsAPI?

[Peter Beverloo, 2017/04/11 14:19:25]

It needs a holistic view of the notifications shown for extensions for a given
profile and thus be accessible from any of the functions. There's no such common
object in the /api/notifications/ code.

[Devlin, 2017/04/11 14:55:23]

Whoops!  Many APIs have a FooAPI object that's already a KeyedService, but it
looks like Notifications isn't one of those.  This is fine.

+ public:
+  using NotificationVector = std::vector<std::unique_ptr<Notification>>;
+
+  explicit ExtensionNotificationDisplayHelper(Profile* profile);
+  ~ExtensionNotificationDisplayHelper() override;
+
+  // Displays the |notification| using the notification display service.
+  void Display(const Notification& notification);
+
+  // Returns the notification identified by |notification_id| if it is currently
+  // visible. May return a nullptr.
+  Notification* GetByNotificationId(const std::string& notification_id);
+
+  // Returns a set with the IDs of all notifications that are currently being
+  // shown on behalf of the |extension_origin|.
+  std::set<std::string> GetNotificationIdsForExtension(
+      const GURL& extension_origin) const;
+
+  // Removes stored state for the notification identified by |notification_id|.
+  // Returns whether there was local state.
+  bool EraseDataForNotificationId(const std::string& notification_id);
+
+  // Closes the notification identified by |notification_id|. Returns whether a
+  // notification was closed in response to the call.
+  bool Close(const std::string& notification_id);
+
+  // KeyedService overrides:
+  void Shutdown() override;
+
+ private:
+  // Returns the notification display service instance to communicate with.
+  NotificationDisplayService* GetDisplayService();
+
+  // The Profile instance that owns this keyed service.
+  Profile* profile_;
+
+  // Vector of notifications that are being shown for extensions.
+  NotificationVector notifications_;
+
+  DISALLOW_COPY_AND_ASSIGN(ExtensionNotificationDisplayHelper);
+};
+
+}  // namespace extensions
+
+#endif  // CHROME_BROWSER_EXTENSIONS_API_NOTIFICATIONS_EXTENSION_NOTIFICATION_DISPLAY_HELPER_H_