Rate limit programmatic update checks for extensions

chrome/browser/extensions/api/runtime/chrome_runtime_api_delegate_unittest.cc

+// Copyright 2016 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 <deque>
+#include <memory>
+#include <set>
+#include <utility>
+#include <vector>
+
+#include "base/callback.h"
+#include "base/files/file_path.h"
+#include "base/memory/ptr_util.h"
+#include "base/memory/ref_counted.h"
+#include "base/test/simple_test_tick_clock.h"
+#include "chrome/browser/extensions/api/runtime/chrome_runtime_api_delegate.h"
+#include "chrome/browser/extensions/extension_service.h"
+#include "chrome/browser/extensions/extension_service_test_with_install.h"
+#include "extensions/browser/event_router.h"
+#include "extensions/browser/event_router_factory.h"
+#include "extensions/browser/extension_prefs.h"
+#include "extensions/browser/extension_registry.h"
+#include "extensions/browser/updater/extension_downloader.h"
+#include "extensions/browser/updater/extension_downloader_test_delegate.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+namespace extensions {
+
+namespace {
+
+// A fake EventRouter that lets us pretend an extension has a listener
+// registered for named events.
+class TestEventRouter : public EventRouter {
+ public:
+  explicit TestEventRouter(content::BrowserContext* context)
+      : EventRouter(context, ExtensionPrefs::Get(context)) {}
+  ~TestEventRouter() override {}
+
+  // An entry in our fake event registry.
+  using Entry = std::pair<std::string, std::string>;
+
+  bool ExtensionHasEventListener(const std::string& extension_id,
+                                 const std::string& event_name) override {
+    return fake_registry_.find(Entry(extension_id, event_name)) !=
+           fake_registry_.end();
+  }
+
+  // Pretend that |extension_id| is listening for |event_name|.
+  void AddFakeListener(const std::string& extension_id,
+                       const std::string& event_name) {
+    fake_registry_.insert(Entry(extension_id, event_name));
+  }
+
+ private:
+  std::set<Entry> fake_registry_;
+
+  DISALLOW_COPY_AND_ASSIGN(TestEventRouter);
+};
+
+std::unique_ptr<KeyedService> TestEventRouterFactoryFunction(
+    content::BrowserContext* context) {
+  return base::WrapUnique(new TestEventRouter(context));
+}
+
+// This class lets us intercept extension update checks and respond as if
+// either no update was found, or one was (and it was downloaded).
+class DownloaderTestDelegate : public ExtensionDownloaderTestDelegate {
+ public:
+  DownloaderTestDelegate() {}
+
+  // On the next update check for extension |id|, we'll respond that no update
+  // is available.
+  void AddNoUpdateResponse(const std::string& id) {
+    no_updates_.insert(id);
+    if (updates_.find(id) != updates_.end())
+      updates_.erase(id);
+  }
+
+  // On the next update check for extension |id|, pretend that an update to
+  // version |version| has been downloaded to |path|.
+  void AddUpdateResponse(const std::string& id,
+                         const base::FilePath& path,
+                         const std::string& version) {
+    if (no_updates_.find(id) != no_updates_.end())
+      no_updates_.erase(id);
+    DownloadFinishedArgs args;
+    args.path = path;
+    args.version = version;
+    updates_[id] = std::move(args);
+  }
+
+  void StartUpdateCheck(ExtensionDownloader* downloader,
+                        ExtensionDownloaderDelegate* delegate,
+                        scoped_ptr<ManifestFetchData> fetch_data) override {

[Devlin, 2016/04/15 17:57:38]

std::unique_ptr

[asargent_no_longer_on_chrome, 2016/04/19 17:56:53]

Fixed (here and in extension_downloader_delegate.h which declares the interface)

+    // Instead of immediately firing callbacks to the delegate in matching
+    // cases below, we instead post a task since the delegate typically isn't
+    // expecting a synchronous reply (the real code has to go do at least one
+    // network request before getting a response, so this is is a reasonable
+    // expectation by delegates).
+    for (const std::string& id : fetch_data->extension_ids()) {
+      auto no_update = no_updates_.find(id);
+      if (no_update != no_updates_.end()) {
+        no_updates_.erase(no_update);
+        base::MessageLoop::current()->task_runner()->PostTask(
+            FROM_HERE,
+            base::Bind(&ExtensionDownloaderDelegate::OnExtensionDownloadFailed,
+                       base::Unretained(delegate), id,
+                       ExtensionDownloaderDelegate::NO_UPDATE_AVAILABLE,
+                       ExtensionDownloaderDelegate::PingResult(),
+                       fetch_data->request_ids()));
+        continue;
+      }
+      auto update = updates_.find(id);
+      if (update != updates_.end()) {
+        CRXFileInfo info(id, update->second.path, "" /* no hash */);
+        std::string version = update->second.version;
+        updates_.erase(update);
+        base::MessageLoop::current()->task_runner()->PostTask(
+            FROM_HERE,
+            base::Bind(
+                &ExtensionDownloaderDelegate::OnExtensionDownloadFinished,
+                base::Unretained(delegate), info,
+                false /* file_ownership_passed */, GURL(), version,
+                ExtensionDownloaderDelegate::PingResult(),
+                fetch_data->request_ids(),
+                ExtensionDownloaderDelegate::InstallCallback()));
+        continue;
+      }
+      ADD_FAILURE() << "Unexpected extension id " << id;
+    }
+  }
+
+ private:
+  // Simple holder for the data passed in AddUpdateResponse calls.
+  struct DownloadFinishedArgs {
+    base::FilePath path;
+    std::string version;
+  };
+
+  // These keep track of what response we should give for update checks, keyed
+  // by extension id. A given extension id should only appear in one or the
+  // other.
+  std::set<std::string> no_updates_;
+  std::map<std::string, DownloadFinishedArgs> updates_;
+
+  DISALLOW_COPY_AND_ASSIGN(DownloaderTestDelegate);
+};
+
+// Helper to let test code wait for and return an update check result.
+class UpdateCheckResultCatcher {
+ public:
+  UpdateCheckResultCatcher() {}
+
+  void OnResult(const RuntimeAPIDelegate::UpdateCheckResult& result) {
+    EXPECT_EQ(nullptr, result_.get());
+    result_.reset(new RuntimeAPIDelegate::UpdateCheckResult(
+        result.success, result.response, result.version));
+    if (run_loop_)
+      run_loop_->Quit();
+  }
+
+  std::unique_ptr<RuntimeAPIDelegate::UpdateCheckResult> WaitForResult() {
+    if (!result_) {
+      run_loop_.reset(new base::RunLoop);
+      run_loop_->Run();
+    }
+    return std::move(result_);
+  }
+
+ private:
+  std::unique_ptr<RuntimeAPIDelegate::UpdateCheckResult> result_;
+  std::unique_ptr<base::RunLoop> run_loop_;
+
+  DISALLOW_COPY_AND_ASSIGN(UpdateCheckResultCatcher);
+};
+
+class ChromeRuntimeAPIDelegateTest : public ExtensionServiceTestWithInstall {
+ public:
+  ChromeRuntimeAPIDelegateTest() {}
+
+  void SetUp() override {
+    ExtensionServiceTestWithInstall::SetUp();
+    ExtensionDownloader::set_test_delegate(&downloader_test_delegate_);
+    ChromeRuntimeAPIDelegate::set_tick_clock_for_tests(&clock_);
+
+    InitializeExtensionServiceWithUpdater();
+    runtime_delegate_.reset(new ChromeRuntimeAPIDelegate(browser_context()));
+    service()->set_install_updates_when_idle_for_test(true);
+
+    EventRouterFactory::GetInstance()->SetTestingFactory(
+        browser_context(), &TestEventRouterFactoryFunction);
+  }
+
+  void TearDown() override {
+    ExtensionDownloader::set_test_delegate(nullptr);
+    ChromeRuntimeAPIDelegate::set_tick_clock_for_tests(nullptr);
+    ExtensionServiceTestWithInstall::TearDown();
+  }
+
+  // Uses runtime_delegate_ to runs an update check for |id|, expecting

[Devlin, 2016/04/15 17:57:37]

nit: to run

[asargent_no_longer_on_chrome, 2016/04/19 17:56:53]

Done.

+  // |expected_response| and (if an update was available) |expected_version|.
+  // The |expected_response| should be one of 'throttled', 'no_update', or
+  // 'update_available'.
+  void DoUpdateCheck(const std::string& id,
+                     const std::string& expected_response,
+                     const std::string& expected_version) {
+    UpdateCheckResultCatcher catcher;
+    EXPECT_TRUE(runtime_delegate_->CheckForUpdates(
+        id, base::Bind(&UpdateCheckResultCatcher::OnResult,
+                       base::Unretained(&catcher))));
+    std::unique_ptr<RuntimeAPIDelegate::UpdateCheckResult> result =
+        catcher.WaitForResult();
+    ASSERT_NE(nullptr, result.get());
+    EXPECT_TRUE(result->success);
+    EXPECT_EQ(expected_response, result->response);
+    EXPECT_EQ(expected_version, result->version);
+  }
+
+ protected:
+  // A clock we pass to the code used for throttling, so that we can manually
+  // increment time to test various throttling scenarios.
+  base::SimpleTestTickClock clock_;
+
+  // Used for intercepting update check requests and possibly returning fake
+  // download results.
+  DownloaderTestDelegate downloader_test_delegate_;
+
+  // The object whose behavior we're testing.
+  scoped_ptr<RuntimeAPIDelegate> runtime_delegate_;

[Devlin, 2016/04/15 17:57:37]

unique_ptr

[asargent_no_longer_on_chrome, 2016/04/19 17:56:53]

Done.

+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(ChromeRuntimeAPIDelegateTest);
+};
+
+TEST_F(ChromeRuntimeAPIDelegateTest, RequestUpdateCheck) {
+  base::FilePath v1_path = data_dir().AppendASCII("autoupdate/v1.crx");
+  base::FilePath v2_path = data_dir().AppendASCII("autoupdate/v2.crx");
+
+  // Start by installing version 1.
+  scoped_refptr<const Extension> v1(InstallCRX(v1_path, INSTALL_NEW));
+  std::string id = v1->id();
+
+  // Make it look like our test extension listens for the
+  // runtime.onUpdateAvailable event, so that it won't be updated immediately
+  // when the ExtensionUpdater hands the new version to the ExtensionService.

[Devlin, 2016/04/15 17:57:37]

For my own edification, where's this logic?

[asargent_no_longer_on_chrome, 2016/04/19 17:56:53]

It's in ExtensionService::ShouldDelayExtensionUpdate

+  TestEventRouter* event_router =
+      static_cast<TestEventRouter*>(EventRouter::Get(browser_context()));
+  event_router->AddFakeListener(id, "runtime.onUpdateAvailable");
+
+  // Run an update check that should get a "no_update" response.
+  downloader_test_delegate_.AddNoUpdateResponse(id);
+  DoUpdateCheck(id, "no_update", "");
+
+  // Check again after a short delay - we should be throttled because
+  // not enough time has passed.
+  clock_.Advance(base::TimeDelta::FromMinutes(15));
+  downloader_test_delegate_.AddNoUpdateResponse(id);
+  DoUpdateCheck(id, "throttled", "");
+
+  // Now simulate checking a few times at a 6 hour interval - none of these
+  // should be throttled.
+  for (int i = 0; i < 5; i++) {
+    clock_.Advance(base::TimeDelta::FromHours(6));
+    downloader_test_delegate_.AddNoUpdateResponse(id);
+    DoUpdateCheck(id, "no_update", "");
+  }
+
+  // Run an update check that should get an "update_available" response. This
+  // actually causes the new version to be downloaded/unpacked, but the install
+  // will not complete until we reload the extension.
+  clock_.Advance(base::TimeDelta::FromDays(1));
+  downloader_test_delegate_.AddUpdateResponse(id, v2_path, "2.0");
+  DoUpdateCheck(id, "update_available", "2.0");
+
+  // Call again after short delay - it should be throttled instead of getting
+  // another "update_available" response.
+  clock_.Advance(base::TimeDelta::FromMinutes(30));
+  downloader_test_delegate_.AddUpdateResponse(id, v2_path, "2.0");
+  DoUpdateCheck(id, "throttled", "");
+
+  // Reload the extension, causing the delayed update to v2 to happen, then do
+  // another update check - we should get a no_update instead of throttled.
+  service()->ReloadExtension(id);
+  const Extension* current =
+      ExtensionRegistry::Get(browser_context())->GetInstalledExtension(id);
+  ASSERT_NE(nullptr, current);
+  EXPECT_EQ("2.0", current->VersionString());
+  clock_.Advance(base::TimeDelta::FromSeconds(10));
+  downloader_test_delegate_.AddNoUpdateResponse(id);
+  DoUpdateCheck(id, "no_update", "");
+
+  // Check again after short delay; we should be throttled.
+  clock_.Advance(base::TimeDelta::FromMinutes(5));
+  DoUpdateCheck(id, "throttled", "");
+
+  // Call again after a longer delay, we should should be unthrottled.
+  clock_.Advance(base::TimeDelta::FromHours(8));
+  downloader_test_delegate_.AddNoUpdateResponse(id);
+  DoUpdateCheck(id, "no_update", "");
+}
+
+}  // namespace
+
+}  // namespace extensions