Add deprecation message in chrome.pushMessaging API

chrome/browser/extensions/api/push_messaging/push_messaging_api.cc

 // Copyright (c) 2012 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.
 
 #include "chrome/browser/extensions/api/push_messaging/push_messaging_api.h"
 
 #include <set>
 
 #include "base/bind.h"
 #include "base/lazy_instance.h"
@@ skipping 30 matching lines @@
 namespace extensions {
 
 namespace {
 const char kChannelIdSeparator[] = "/";
 const char kUserNotSignedIn[] = "The user is not signed in.";
 const char kUserAccessTokenFailure[] =
     "Cannot obtain access token for the user.";
 const char kAPINotAvailableForUser[] =
     "The API is not available for this user.";
 const int kObfuscatedGaiaIdTimeoutInDays = 30;
-}
+const char kDeprecationMessage[] =
+    "The chrome.pushMessaging API is deprecated. Use chrome.gcm API instead.";
+}  // namespace
 
 namespace glue = api::push_messaging;
 
 PushMessagingEventRouter::PushMessagingEventRouter(
     content::BrowserContext* context)
     : browser_context_(context) {
 }
 
 PushMessagingEventRouter::~PushMessagingEventRouter() {}
 
@@ skipping 25 matching lines @@
 
 // GetChannelId class functions
 
 PushMessagingGetChannelIdFunction::PushMessagingGetChannelIdFunction()
     : OAuth2TokenService::Consumer("push_messaging"),
       interactive_(false) {}
 
 PushMessagingGetChannelIdFunction::~PushMessagingGetChannelIdFunction() {}
 
 bool PushMessagingGetChannelIdFunction::RunAsync() {
+  // Issue a deprecation message.
+  WriteToConsole(content::CONSOLE_MESSAGE_LEVEL_WARNING, kDeprecationMessage);

[not at google - send to devlin, 2014/08/14 22:16:08]

How often do apps call this method? Because if it's being called often - for
whatever reason - it could get really spammy.

[fgorski, 2014/08/20 22:46:47]

I am seeing it used very rarely (2 other APIs).
app_window_api.cc:184 is actual deprecation message
alarms_api.cc:114 Not sure for what reason.

+

[not at google - send to devlin, 2014/08/14 22:16:08]

Also: we should add an install warning for when the permission is requested. I
can't remember where this is all done, yoz?

[Yoyo Zhou, 2014/08/15 01:40:13]

chrome_api_permissions?

I'm not sure I follow "install warning"... "when requested"

[not at google - send to devlin, 2014/08/15 15:54:17]

I mean the same warning that shows up if you request a permission that doesn't
exist, or append to InstallWarnings from a ManifestHandler. Is there an
idiomatic way to append arbitrary data to that?

[Yoyo Zhou, 2014/08/15 19:25:31]

I dunno, I would just try calling extension->AddInstallWarning.

Given that we have the error console, though, I don't know if adding the install
warning will help much additionally.

[fgorski, 2014/08/20 22:46:46]

We could add a check for deprecated permissions in ParseHelper in
permissions_parser.cc
    Feature::Availability availability =
        feature->IsAvailableToExtension(extension);
149:
    if (!availability.is_available()) {
      //stuff here (issues warning and removes permission)
      continue;
    }

    if (!availability.is_deprecated()) {
      extension->AddInstallWarning(
          InstallWarning(availability.message(), feature->name()));
    }

Of course that would require extension to Feature::Availability and adding a bit
to the manifest.

Ben do you think it is reasonable to do it now? Or can we spent some time and do
it right? I am sure it would be useful if we want to deprecate stuff in future.

[not at google - send to devlin, 2014/08/21 00:36:33]

I've wanted this actually, a feature file annotation to say an entire API is
deprecated (would be useful for the socket API as well, for example). What you
suggest sounds perfect.

   // Fetch the function arguments.
   scoped_ptr<glue::GetChannelId::Params> params(
       glue::GetChannelId::Params::Create(*args_));
   EXTENSION_FUNCTION_VALIDATE(params.get());
 
   if (params && params->interactive) {
     interactive_ = *params->interactive;
   }
 
   // Balanced in ReportResult()
@@ skipping 275 matching lines @@
 
 template <>
 void
 BrowserContextKeyedAPIFactory<PushMessagingAPI>::DeclareFactoryDependencies() {
   DependsOn(ExtensionRegistryFactory::GetInstance());
   DependsOn(ExtensionsBrowserClient::Get()->GetExtensionSystemFactory());
   DependsOn(invalidation::ProfileInvalidationProviderFactory::GetInstance());
 }
 
 }  // namespace extensions