Make all quota-exceeding messages in the storage API explain what the failure

chrome/browser/extensions/extensions_quota_service_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 "base/message_loop.h"
 #include "base/process.h"
 #include "base/stl_util.h"
 #include "base/string_util.h"
 #include "chrome/browser/extensions/extension_function.h"
 #include "chrome/browser/extensions/extensions_quota_service.h"
 #include "content/public/test/test_browser_thread.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 using base::TimeDelta;
 using base::TimeTicks;
 using content::BrowserThread;
 
 typedef QuotaLimitHeuristic::Bucket Bucket;
 typedef QuotaLimitHeuristic::Config Config;
 typedef QuotaLimitHeuristic::BucketList BucketList;
 typedef ExtensionsQuotaService::TimedLimit TimedLimit;
 typedef ExtensionsQuotaService::SustainedLimit SustainedLimit;
 
-static const Config kFrozenConfig = { 0, TimeDelta::FromDays(0) };
-static const Config k2PerMinute = { 2, TimeDelta::FromMinutes(1) };
-static const Config k20PerHour = { 20, TimeDelta::FromHours(1) };
-static const TimeTicks kStartTime = TimeTicks();
-static const TimeTicks k1MinuteAfterStart =
-    kStartTime + TimeDelta::FromMinutes(1);
+namespace {
 
-namespace {
+const char kGenericName[] = "name";
+const Config kFrozenConfig = { 0, TimeDelta::FromDays(0) };
+const Config k2PerMinute = { 2, TimeDelta::FromMinutes(1) };
+const Config k20PerHour = { 20, TimeDelta::FromHours(1) };
+const TimeTicks kStartTime = TimeTicks();
+const TimeTicks k1MinuteAfterStart = kStartTime + TimeDelta::FromMinutes(1);
+
 class Mapper : public QuotaLimitHeuristic::BucketMapper {
  public:
   Mapper() {}
   virtual ~Mapper() { STLDeleteValues(&buckets_); }
   virtual void GetBucketsForArgs(const ListValue* args, BucketList* buckets) {
     for (size_t i = 0; i < args->GetSize(); i++) {
       int id;
       ASSERT_TRUE(args->GetInteger(i, &id));
       if (buckets_.find(id) == buckets_.end())
         buckets_[id] = new Bucket();
@@ skipping 26 matching lines @@
  protected:
   virtual ~MockFunction() {}
 };
 
 class TimedLimitMockFunction : public MockFunction {
  public:
   explicit TimedLimitMockFunction(const std::string& name)
       : MockFunction(name) {}
   virtual void GetQuotaLimitHeuristics(
       QuotaLimitHeuristics* heuristics) const {
-    heuristics->push_back(new TimedLimit(k2PerMinute, new Mapper()));
+    heuristics->push_back(
+        new TimedLimit(k2PerMinute, new Mapper(), kGenericName));
   }
 
  private:
   virtual ~TimedLimitMockFunction() {}
 };
 
 class ChainedLimitsMockFunction : public MockFunction {
  public:
   explicit ChainedLimitsMockFunction(const std::string& name)
       : MockFunction(name) {}
   virtual void GetQuotaLimitHeuristics(
       QuotaLimitHeuristics* heuristics) const {
     // No more than 2 per minute sustained over 5 minutes.
-    heuristics->push_back(new SustainedLimit(TimeDelta::FromMinutes(5),
-        k2PerMinute, new Mapper()));
+    heuristics->push_back(new SustainedLimit(
+        TimeDelta::FromMinutes(5), k2PerMinute, new Mapper(), kGenericName));
     // No more than 20 per hour.
-    heuristics->push_back(new TimedLimit(k20PerHour, new Mapper()));
+    heuristics->push_back(
+        new TimedLimit(k20PerHour, new Mapper(), kGenericName));
   }
 
  private:
   virtual ~ChainedLimitsMockFunction() {}
 };
 
 class FrozenMockFunction : public MockFunction {
  public:
   explicit FrozenMockFunction(const std::string& name) : MockFunction(name) {}
   virtual void GetQuotaLimitHeuristics(
       QuotaLimitHeuristics* heuristics) const {
-    heuristics->push_back(new TimedLimit(kFrozenConfig, new Mapper()));
+    heuristics->push_back(
+        new TimedLimit(kFrozenConfig, new Mapper(), kGenericName));
   }
 
  private:
   virtual ~FrozenMockFunction() {}
 };
 }  // namespace
 
 class ExtensionsQuotaServiceTest : public testing::Test {
  public:
   ExtensionsQuotaServiceTest()
@@ skipping 40 matching lines @@
       // These are OK because we haven't exhausted all buckets.
       EXPECT_TRUE(lim->Apply(b, start_time + TimeDelta::FromSeconds(20 + m)));
       EXPECT_FALSE(b->has_tokens());
       EXPECT_TRUE(lim->Apply(b, start_time + TimeDelta::FromSeconds(50 + m)));
       EXPECT_FALSE(b->has_tokens());
     }
   }
 };
 
 TEST_F(QuotaLimitHeuristicTest, Timed) {
-  TimedLimit lim(k2PerMinute, new MockMapper());
+  TimedLimit lim(k2PerMinute, new MockMapper(), kGenericName);
   Bucket b;
 
   b.Reset(k2PerMinute, kStartTime);
   EXPECT_TRUE(lim.Apply(&b, kStartTime));
   EXPECT_TRUE(b.has_tokens());
   EXPECT_TRUE(lim.Apply(&b, kStartTime + TimeDelta::FromSeconds(30)));
   EXPECT_FALSE(b.has_tokens());
   EXPECT_FALSE(lim.Apply(&b,  k1MinuteAfterStart));
 
   b.Reset(k2PerMinute, kStartTime);
   EXPECT_TRUE(lim.Apply(&b, k1MinuteAfterStart - TimeDelta::FromSeconds(1)));
   EXPECT_TRUE(lim.Apply(&b, k1MinuteAfterStart));
   EXPECT_TRUE(lim.Apply(&b, k1MinuteAfterStart + TimeDelta::FromSeconds(1)));
   EXPECT_TRUE(lim.Apply(&b, k1MinuteAfterStart + TimeDelta::FromSeconds(2)));
   EXPECT_FALSE(lim.Apply(&b, k1MinuteAfterStart + TimeDelta::FromSeconds(3)));
 }
 
 TEST_F(QuotaLimitHeuristicTest, Sustained) {
-  SustainedLimit lim(TimeDelta::FromMinutes(5), k2PerMinute, new MockMapper());
+  SustainedLimit lim(
+      TimeDelta::FromMinutes(5), k2PerMinute, new MockMapper(), kGenericName);
   Bucket bucket;
 
   bucket.Reset(k2PerMinute, kStartTime);
   DoMoreThan2PerMinuteFor5Minutes(kStartTime, &lim, &bucket, -1);
   // This straw breaks the camel's back.
   EXPECT_FALSE(lim.Apply(&bucket, kStartTime + TimeDelta::FromMinutes(6)));
 
   // The heuristic resets itself on a safe request.
   EXPECT_TRUE(lim.Apply(&bucket, kStartTime + TimeDelta::FromDays(1)));
 
   // Do the same as above except don't exhaust final bucket.
   bucket.Reset(k2PerMinute, kStartTime);
   DoMoreThan2PerMinuteFor5Minutes(kStartTime, &lim, &bucket, -1);
   EXPECT_TRUE(lim.Apply(&bucket, kStartTime + TimeDelta::FromMinutes(7)));
 
   // Do the same as above except don't exhaust the 3rd (w.l.o.g) bucket.
   bucket.Reset(k2PerMinute, kStartTime);
   DoMoreThan2PerMinuteFor5Minutes(kStartTime, &lim, &bucket, 3);
   // If the 3rd bucket were exhausted, this would fail (see first test).
   EXPECT_TRUE(lim.Apply(&bucket, kStartTime + TimeDelta::FromMinutes(6)));
 }
 
 TEST_F(ExtensionsQuotaServiceTest, NoHeuristic) {
   scoped_refptr<MockFunction> f(new MockFunction("foo"));
   ListValue args;
-  EXPECT_TRUE(service_->Assess(extension_a_, f, &args, kStartTime));
+  EXPECT_EQ("", service_->Assess(extension_a_, f, &args, kStartTime));
 }
 
 TEST_F(ExtensionsQuotaServiceTest, FrozenHeuristic) {
   scoped_refptr<MockFunction> f(new FrozenMockFunction("foo"));
   ListValue args;
   args.Append(new base::FundamentalValue(1));
-  EXPECT_FALSE(service_->Assess(extension_a_, f, &args, kStartTime));
+  EXPECT_NE("", service_->Assess(extension_a_, f, &args, kStartTime));
 }
 
 TEST_F(ExtensionsQuotaServiceTest, SingleHeuristic) {
   scoped_refptr<MockFunction> f(new TimedLimitMockFunction("foo"));
   ListValue args;
   args.Append(new base::FundamentalValue(1));
-  EXPECT_TRUE(service_->Assess(extension_a_, f, &args, kStartTime));
-  EXPECT_TRUE(service_->Assess(extension_a_, f, &args,
-              kStartTime + TimeDelta::FromSeconds(10)));
-  EXPECT_FALSE(service_->Assess(extension_a_, f, &args,
+  EXPECT_EQ("", service_->Assess(extension_a_, f, &args, kStartTime));
+  EXPECT_EQ("", service_->Assess(extension_a_, f, &args,
+                                 kStartTime + TimeDelta::FromSeconds(10)));
+  EXPECT_NE("", service_->Assess(extension_a_, f, &args,
               kStartTime + TimeDelta::FromSeconds(15)));
 
   ListValue args2;
   args2.Append(new base::FundamentalValue(1));
   args2.Append(new base::FundamentalValue(2));
-  EXPECT_TRUE(service_->Assess(extension_b_, f, &args2, kStartTime));
-  EXPECT_TRUE(service_->Assess(extension_b_, f, &args2,
-              kStartTime + TimeDelta::FromSeconds(10)));
+  EXPECT_EQ("", service_->Assess(extension_b_, f, &args2, kStartTime));
+  EXPECT_EQ("", service_->Assess(extension_b_, f, &args2,
+                                 kStartTime + TimeDelta::FromSeconds(10)));
 
   TimeDelta peace = TimeDelta::FromMinutes(30);
-  EXPECT_TRUE(service_->Assess(extension_b_, f, &args, kStartTime + peace));
-  EXPECT_TRUE(service_->Assess(extension_b_, f, &args,
-              kStartTime + peace + TimeDelta::FromSeconds(10)));
-  EXPECT_FALSE(service_->Assess(extension_b_, f, &args2,
+  EXPECT_EQ("", service_->Assess(extension_b_, f, &args, kStartTime + peace));
+  EXPECT_EQ("", service_->Assess(
+        extension_b_, f, &args,
+        kStartTime + peace + TimeDelta::FromSeconds(10)));
+  EXPECT_NE("", service_->Assess(extension_b_, f, &args2,
                kStartTime + peace + TimeDelta::FromSeconds(15)));
 
   // Test that items are independent.
   ListValue args3;
   args3.Append(new base::FundamentalValue(3));
-  EXPECT_TRUE(service_->Assess(extension_c_, f, &args, kStartTime));
-  EXPECT_TRUE(service_->Assess(extension_c_, f, &args3,
-              kStartTime + TimeDelta::FromSeconds(10)));
-  EXPECT_TRUE(service_->Assess(extension_c_, f, &args,
-              kStartTime + TimeDelta::FromSeconds(15)));
-  EXPECT_TRUE(service_->Assess(extension_c_, f, &args3,
-              kStartTime + TimeDelta::FromSeconds(20)));
-  EXPECT_FALSE(service_->Assess(extension_c_, f, &args,
-               kStartTime + TimeDelta::FromSeconds(25)));
-  EXPECT_FALSE(service_->Assess(extension_c_, f, &args3,
-               kStartTime + TimeDelta::FromSeconds(30)));
+  EXPECT_EQ("", service_->Assess(extension_c_, f, &args, kStartTime));
+  EXPECT_EQ("", service_->Assess(extension_c_, f, &args3,
+                                 kStartTime + TimeDelta::FromSeconds(10)));
+  EXPECT_EQ("", service_->Assess(extension_c_, f, &args,
+                                 kStartTime + TimeDelta::FromSeconds(15)));
+  EXPECT_EQ("", service_->Assess(extension_c_, f, &args3,
+                                 kStartTime + TimeDelta::FromSeconds(20)));
+  EXPECT_NE("", service_->Assess(extension_c_, f, &args,
+                                 kStartTime + TimeDelta::FromSeconds(25)));
+  EXPECT_NE("", service_->Assess(extension_c_, f, &args3,
+                                 kStartTime + TimeDelta::FromSeconds(30)));
 }
 
 TEST_F(ExtensionsQuotaServiceTest, ChainedHeuristics) {
   scoped_refptr<MockFunction> f(new ChainedLimitsMockFunction("foo"));
   ListValue args;
   args.Append(new base::FundamentalValue(1));
 
   // First, test that the low limit can be avoided but the higher one is hit.
   // One event per minute for 20 minutes comes in under the sustained limit,
   // but is equal to the timed limit.
   for (int i = 0; i < 20; i++) {
-    EXPECT_TRUE(service_->Assess(extension_a_, f, &args,
-                kStartTime + TimeDelta::FromSeconds(10 + i * 60)));
+    EXPECT_EQ("", service_->Assess(
+          extension_a_, f, &args,
+          kStartTime + TimeDelta::FromSeconds(10 + i * 60)));
   }
 
   // This will bring us to 21 events in an hour, which is a violation.
-  EXPECT_FALSE(service_->Assess(extension_a_, f, &args,
-               kStartTime + TimeDelta::FromMinutes(30)));
+  EXPECT_NE("", service_->Assess(extension_a_, f, &args,
+                                 kStartTime + TimeDelta::FromMinutes(30)));
 
   // Now, check that we can still hit the lower limit.
   for (int i = 0; i < 5; i++) {
-    EXPECT_TRUE(service_->Assess(extension_b_, f, &args,
-                kStartTime + TimeDelta::FromSeconds(10 + i * 60)));
-    EXPECT_TRUE(service_->Assess(extension_b_, f, &args,
-                kStartTime + TimeDelta::FromSeconds(15 + i * 60)));
-    EXPECT_TRUE(service_->Assess(extension_b_, f, &args,
-                kStartTime + TimeDelta::FromSeconds(20 + i * 60)));
+    EXPECT_EQ("", service_->Assess(
+          extension_b_, f, &args,
+          kStartTime + TimeDelta::FromSeconds(10 + i * 60)));
+    EXPECT_EQ("", service_->Assess(
+          extension_b_, f, &args,
+          kStartTime + TimeDelta::FromSeconds(15 + i * 60)));
+    EXPECT_EQ("", service_->Assess(
+          extension_b_, f, &args,
+          kStartTime + TimeDelta::FromSeconds(20 + i * 60)));
   }
 
-  EXPECT_FALSE(service_->Assess(extension_b_, f, &args,
+  EXPECT_NE("", service_->Assess(extension_b_, f, &args,
                kStartTime + TimeDelta::FromMinutes(6)));
 }
 
 TEST_F(ExtensionsQuotaServiceTest, MultipleFunctionsDontInterfere) {
   scoped_refptr<MockFunction> f(new TimedLimitMockFunction("foo"));
   scoped_refptr<MockFunction> g(new TimedLimitMockFunction("bar"));
 
   ListValue args_f;
   ListValue args_g;
   args_f.Append(new base::FundamentalValue(1));
   args_g.Append(new base::FundamentalValue(2));
 
-  EXPECT_TRUE(service_->Assess(extension_a_, f, &args_f, kStartTime));
-  EXPECT_TRUE(service_->Assess(extension_a_, g, &args_g, kStartTime));
-  EXPECT_TRUE(service_->Assess(extension_a_, f, &args_f,
-              kStartTime + TimeDelta::FromSeconds(10)));
-  EXPECT_TRUE(service_->Assess(extension_a_, g, &args_g,
-              kStartTime + TimeDelta::FromSeconds(10)));
-  EXPECT_FALSE(service_->Assess(extension_a_, f, &args_f,
-               kStartTime + TimeDelta::FromSeconds(15)));
-  EXPECT_FALSE(service_->Assess(extension_a_, g, &args_g,
-               kStartTime + TimeDelta::FromSeconds(15)));
+  EXPECT_EQ("", service_->Assess(extension_a_, f, &args_f, kStartTime));
+  EXPECT_EQ("", service_->Assess(extension_a_, g, &args_g, kStartTime));
+  EXPECT_EQ("", service_->Assess(extension_a_, f, &args_f,
+                                 kStartTime + TimeDelta::FromSeconds(10)));
+  EXPECT_EQ("", service_->Assess(extension_a_, g, &args_g,
+                                 kStartTime + TimeDelta::FromSeconds(10)));
+  EXPECT_NE("", service_->Assess(extension_a_, f, &args_f,
+                                 kStartTime + TimeDelta::FromSeconds(15)));
+  EXPECT_NE("", service_->Assess(extension_a_, g, &args_g,
+                                 kStartTime + TimeDelta::FromSeconds(15)));
 }
 
 TEST_F(ExtensionsQuotaServiceTest, ViolatorsWillBeViolators) {
   scoped_refptr<MockFunction> f(new TimedLimitMockFunction("foo"));
   scoped_refptr<MockFunction> g(new TimedLimitMockFunction("bar"));
   ListValue arg;
   arg.Append(new base::FundamentalValue(1));
-  EXPECT_TRUE(service_->Assess(extension_a_, f, &arg, kStartTime));
-  EXPECT_TRUE(service_->Assess(extension_a_, f, &arg,
-              kStartTime + TimeDelta::FromSeconds(10)));
-  EXPECT_FALSE(service_->Assess(extension_a_, f, &arg,
-               kStartTime + TimeDelta::FromSeconds(15)));
+  EXPECT_EQ("", service_->Assess(extension_a_, f, &arg, kStartTime));
+  EXPECT_EQ("", service_->Assess(extension_a_, f, &arg,
+                                 kStartTime + TimeDelta::FromSeconds(10)));
+  EXPECT_NE("", service_->Assess(extension_a_, f, &arg,
+                                 kStartTime + TimeDelta::FromSeconds(15)));
 
   // We don't allow this extension to use quota limited functions even if they
   // wait a while.
-  EXPECT_FALSE(service_->Assess(extension_a_, f, &arg,
-               kStartTime + TimeDelta::FromDays(1)));
-  EXPECT_FALSE(service_->Assess(extension_a_, g, &arg,
-               kStartTime + TimeDelta::FromDays(1)));
+  EXPECT_NE("", service_->Assess(extension_a_, f, &arg,
+                                 kStartTime + TimeDelta::FromDays(1)));
+  EXPECT_NE("", service_->Assess(extension_a_, g, &arg,
+                                 kStartTime + TimeDelta::FromDays(1)));
 }