Support extension precedences in declarative WebRequest API

chrome/browser/extensions/api/declarative_webrequest/webrequest_rules_registry_unittest.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/declarative_webrequest/webrequest_rules_registry.h"
 
 #include <vector>
 
 #include "base/memory/linked_ptr.h"
 #include "base/message_loop.h"
 #include "base/values.h"
 #include "chrome/common/extensions/matcher/url_matcher_constants.h"
 #include "chrome/browser/extensions/api/declarative_webrequest/webrequest_constants.h"
+#include "chrome/browser/extensions/api/web_request/web_request_api_helpers.h"
 #include "content/test/test_browser_thread.h"
 #include "net/url_request/url_request_test_util.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace {
 const char kExtensionId[] = "ext1";
 const char kExtensionId2[] = "ext2";
 const char kRuleId1[] = "rule1";
 const char kRuleId2[] = "rule2";
+const char kRuleId3[] = "rule3";
 }  // namespace
 
 namespace extensions {
 
+namespace helpers = extension_web_request_api_helpers;
 namespace keys = declarative_webrequest_constants;
 namespace keys2 = url_matcher_constants;
 
+class TestWebRequestRulesRegistry : public WebRequestRulesRegistry {
+ public:
+  TestWebRequestRulesRegistry() : WebRequestRulesRegistry(NULL) {}
+  virtual ~TestWebRequestRulesRegistry() {}
+
+ protected:
+  virtual base::Time GetExtensionInstallationTime(
+      const std::string& extension_id) const {
+    if (extension_id == kExtensionId)
+      return base::Time() + base::TimeDelta::FromDays(1);
+    else if (extension_id == kExtensionId2)
+      return base::Time() + base::TimeDelta::FromDays(2);
+    else
+      return base::Time();
+  }
+};
+
 class WebRequestRulesRegistryTest : public testing::Test {
  public:
  public:
   WebRequestRulesRegistryTest()
       : message_loop(MessageLoop::TYPE_IO),
         ui(content::BrowserThread::UI, &message_loop),
         io(content::BrowserThread::IO, &message_loop) {}
 
   virtual ~WebRequestRulesRegistryTest() {}
 
@@ skipping 69 matching lines @@
 
     linked_ptr<RulesRegistry::Rule> rule =
         make_linked_ptr(new RulesRegistry::Rule);
     rule->id.reset(new std::string(kRuleId2));
     rule->priority.reset(new int(100));
     rule->actions.push_back(action);
     rule->conditions.push_back(condition);
     return rule;
   }
 
+  linked_ptr<RulesRegistry::Rule> CreateRedirectRule(
+      const std::string& destination) {
+    DictionaryValue condition_dict;
+    condition_dict.SetString(keys::kInstanceTypeKey, keys::kRequestMatcherType);
+
+    linked_ptr<json_schema_compiler::any::Any> condition = make_linked_ptr(
+        new json_schema_compiler::any::Any);
+    condition->Init(condition_dict);
+
+    DictionaryValue action_dict;
+    action_dict.SetString(keys::kInstanceTypeKey, keys::kRedirectRequestType);
+    action_dict.SetString(keys::kRedirectUrlKey, destination);
+
+    linked_ptr<json_schema_compiler::any::Any> action = make_linked_ptr(
+        new json_schema_compiler::any::Any);
+    action->Init(action_dict);
+
+    linked_ptr<RulesRegistry::Rule> rule =
+        make_linked_ptr(new RulesRegistry::Rule);
+    rule->id.reset(new std::string(kRuleId3));
+    rule->priority.reset(new int(100));
+    rule->actions.push_back(action);
+    rule->conditions.push_back(condition);
+    return rule;
+  }
+
  protected:
   MessageLoop message_loop;
   content::TestBrowserThread ui;
   content::TestBrowserThread io;
 };
 
 TEST_F(WebRequestRulesRegistryTest, AddRulesImpl) {
-  scoped_refptr<WebRequestRulesRegistry> registry(new WebRequestRulesRegistry);
+  scoped_refptr<WebRequestRulesRegistry> registry(
+      new WebRequestRulesRegistry(NULL));

[Matt Perry, 2012/05/17 00:42:17]

could you make these all TestWebRequestRulesRegistry? that would allow you to
remove the special case where it's valid for profile/extension_info_map to be
NULL.

[battre, 2012/05/18 16:21:40]

Done.

   std::string error;
 
   std::vector<linked_ptr<RulesRegistry::Rule> > rules;
   rules.push_back(CreateRule1());
   rules.push_back(CreateRule2());
 
   error = registry->AddRules(kExtensionId, rules);
   EXPECT_EQ("", error);
 
   std::set<WebRequestRule::GlobalRuleId> matches;
 
   GURL http_url("http://www.example.com");
   TestURLRequest http_request(http_url, NULL);
   matches = registry->GetMatches(&http_request, ON_BEFORE_REQUEST);
   EXPECT_EQ(2u, matches.size());
   EXPECT_TRUE(matches.find(std::make_pair(kExtensionId, kRuleId1)) !=
       matches.end());
   EXPECT_TRUE(matches.find(std::make_pair(kExtensionId, kRuleId2)) !=
       matches.end());
 
   GURL foobar_url("http://www.foobar.com");
   TestURLRequest foobar_request(foobar_url, NULL);
   matches = registry->GetMatches(&foobar_request, ON_BEFORE_REQUEST);
   EXPECT_EQ(1u, matches.size());
   EXPECT_TRUE(matches.find(std::make_pair(kExtensionId, kRuleId2)) !=
       matches.end());
 }
 
 TEST_F(WebRequestRulesRegistryTest, RemoveRulesImpl) {
-  scoped_refptr<WebRequestRulesRegistry> registry(new WebRequestRulesRegistry);
+  scoped_refptr<WebRequestRulesRegistry> registry(
+      new WebRequestRulesRegistry(NULL));
   std::string error;
 
   // Setup RulesRegistry to contain two rules.
   std::vector<linked_ptr<RulesRegistry::Rule> > rules_to_add;
   rules_to_add.push_back(CreateRule1());
   rules_to_add.push_back(CreateRule2());
   error = registry->AddRules(kExtensionId, rules_to_add);
   EXPECT_EQ("", error);
 
   // Verify initial state.
@@ skipping 20 matching lines @@
 
   // Verify that everything is gone.
   registered_rules.clear();
   registry->GetAllRules(kExtensionId, &registered_rules);
   EXPECT_EQ(0u, registered_rules.size());
 
   EXPECT_TRUE(registry->IsEmpty());
 }
 
 TEST_F(WebRequestRulesRegistryTest, RemoveAllRulesImpl) {
-  scoped_refptr<WebRequestRulesRegistry> registry(new WebRequestRulesRegistry);
+  scoped_refptr<WebRequestRulesRegistry> registry(
+      new WebRequestRulesRegistry(NULL));
   std::string error;
 
   // Setup RulesRegistry to contain two rules, one for each extension.
   std::vector<linked_ptr<RulesRegistry::Rule> > rules_to_add(1);
   rules_to_add[0] = CreateRule1();
   error = registry->AddRules(kExtensionId, rules_to_add);
   EXPECT_EQ("", error);
 
   rules_to_add[0] = CreateRule2();
   error = registry->AddRules(kExtensionId2, rules_to_add);
@@ skipping 23 matching lines @@
   error = registry->RemoveAllRules(kExtensionId);
   EXPECT_EQ("", error);
 
   // Remove rule from second extension.
   error = registry->RemoveAllRules(kExtensionId2);
   EXPECT_EQ("", error);
 
   EXPECT_TRUE(registry->IsEmpty());
 }
 
+TEST_F(WebRequestRulesRegistryTest, Precedences) {
+  scoped_refptr<WebRequestRulesRegistry> registry(
+      new TestWebRequestRulesRegistry());
+  std::string error;
+
+  std::vector<linked_ptr<RulesRegistry::Rule> > rules_to_add_1(1);
+  rules_to_add_1[0] = CreateRedirectRule("http://www.foo.com");
+  error = registry->AddRules(kExtensionId, rules_to_add_1);
+  EXPECT_EQ("", error);
+
+  std::vector<linked_ptr<RulesRegistry::Rule> > rules_to_add_2(1);
+  rules_to_add_2[0] = CreateRedirectRule("http://www.bar.com");
+  error = registry->AddRules(kExtensionId2, rules_to_add_2);
+  EXPECT_EQ("", error);
+
+  GURL url("http://www.google.com");
+  TestURLRequest request(url, NULL);
+  std::list<LinkedPtrEventResponseDelta> deltas =
+      registry->CreateDeltas(&request, ON_BEFORE_REQUEST);
+
+  // The second extension is installed later and will win for this reason
+  // in conflict resolution.
+  ASSERT_EQ(2u, deltas.size());
+  deltas.sort(&helpers::InDecreasingExtensionInstallationTimeOrder);
+
+  std::list<LinkedPtrEventResponseDelta>::iterator i = deltas.begin();
+  LinkedPtrEventResponseDelta winner = *i;

[Matt Perry, 2012/05/17 00:42:17]

*i++ works too

[battre, 2012/05/18 16:21:40]

Done.

+  ++i;
+  LinkedPtrEventResponseDelta loser = *i;
+
+  EXPECT_EQ(kExtensionId2, winner->extension_id);
+  EXPECT_EQ(base::Time() + base::TimeDelta::FromDays(2),
+            winner->extension_install_time);
+  EXPECT_EQ(GURL("http://www.bar.com"), winner->new_url);
+
+  EXPECT_EQ(kExtensionId, loser->extension_id);
+  EXPECT_EQ(base::Time() + base::TimeDelta::FromDays(1),
+            loser->extension_install_time);
+  EXPECT_EQ(GURL("http://www.foo.com"), loser->new_url);
+}
+
 }  // namespace extensions