// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "extensions/browser/api/storage/storage_frontend.h"

#include <memory>

#include "base/files/file_util.h"
#include "base/files/scoped_temp_dir.h"
#include "base/functional/bind.h"
#include "base/run_loop.h"
#include "base/strings/string_number_conversions.h"
#include "base/test/metrics/histogram_tester.h"
#include "components/value_store/value_store.h"
#include "components/value_store/value_store_factory_impl.h"
#include "content/public/browser/browser_context.h"
#include "content/public/test/test_browser_context.h"
#include "content/public/test/test_utils.h"
#include "extensions/browser/api/extensions_api_client.h"
#include "extensions/browser/api/storage/settings_namespace.h"
#include "extensions/browser/api/storage/settings_test_util.h"
#include "extensions/browser/api/storage/storage_area_namespace.h"
#include "extensions/browser/api/storage/storage_frontend.h"
#include "extensions/browser/event_listener_map.h"
#include "extensions/browser/event_router.h"
#include "extensions/browser/extensions_test.h"
#include "extensions/common/mojom/context_type.mojom.h"
#include "testing/gtest/include/gtest/gtest.h"

using value_store::ValueStore;

namespace extensions {

namespace settings = settings_namespace;

namespace {

// To save typing ValueStore::DEFAULTS everywhere.
const ValueStore::WriteOptions DEFAULTS = ValueStore::DEFAULTS;

}  // namespace

// A better name for this would be StorageFrontendTest, but the historical name
// has been ExtensionSettingsFrontendTest. In order to preserve crash/failure
// history, the test names are unchanged.
class ExtensionSettingsFrontendTest : public ExtensionsTest {
 public:
  void SetUp() override {
    ExtensionsTest::SetUp();
    ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
    storage_factory_ =
        new value_store::ValueStoreFactoryImpl(temp_dir_.GetPath());
    ResetFrontend();
  }

  void TearDown() override {
    frontend_.reset();
    // Execute any pending deletion tasks.
    content::RunAllTasksUntilIdle();
    ExtensionsTest::TearDown();
  }

 protected:
  void ResetFrontend() {
    frontend_ =
        StorageFrontend::CreateForTesting(storage_factory_, browser_context());
  }

  base::ScopedTempDir temp_dir_;
  std::unique_ptr<StorageFrontend> frontend_;
  scoped_refptr<value_store::ValueStoreFactoryImpl> storage_factory_;

 private:
  ExtensionsAPIClient extensions_api_client_;
};

// Get a semblance of coverage for both extension and app settings by
// alternating in each test.
// TODO(kalman): explicitly test the two interact correctly.

// Tests that the frontend is set up correctly.
TEST_F(ExtensionSettingsFrontendTest, Basics) {
  // Local storage is always enabled.
  EXPECT_TRUE(frontend_->IsStorageEnabled(settings::LOCAL));
  EXPECT_TRUE(frontend_->GetValueStoreCache(settings::LOCAL));

  // Invalid storage areas are not available.
  EXPECT_FALSE(frontend_->IsStorageEnabled(settings::INVALID));
  EXPECT_FALSE(frontend_->GetValueStoreCache(settings::INVALID));
}

namespace {

class EventRestrictionObserver : public EventRouter::TestObserver {
 public:
  struct DispatchedEvent {
    std::string name;
    std::optional<mojom::ContextType> restrict_to_context_type;
  };

  void OnWillDispatchEvent(const Event& event) override {
    dispatched_events_.push_back(
        {event.event_name, event.restrict_to_context_type});
  }

  void OnDidDispatchEventToProcess(const Event& event,
                                   int process_id) override {}

  const std::vector<DispatchedEvent>& events() const {
    return dispatched_events_;
  }

  void Clear() { dispatched_events_.clear(); }

 private:
  std::vector<DispatchedEvent> dispatched_events_;
};

}  // namespace

TEST_F(ExtensionSettingsFrontendTest, OnSettingsChanged_RestrictToContextType) {
  EventRestrictionObserver observer;
  EventRouter* event_router = EventRouter::Get(browser_context());
  event_router->AddObserverForTesting(&observer);

  const std::string id = "ext";
  scoped_refptr<const Extension> extension =
      settings_test_util::AddExtensionWithId(browser_context(), id,
                                             Manifest::Type::kExtension);

  event_router->listeners().AddListener(EventListener::CreateLazyListener(
      "storage.session.onChanged", id, browser_context(), false, GURL(),
      std::nullopt));
  event_router->listeners().AddListener(EventListener::CreateLazyListener(
      "storage.sync.onChanged", id, browser_context(), false, GURL(),
      std::nullopt));
  event_router->listeners().AddListener(EventListener::CreateLazyListener(
      "storage.managed.onChanged", id, browser_context(), false, GURL(),
      std::nullopt));
  event_router->listeners().AddListener(EventListener::CreateLazyListener(
      "storage.onChanged", id, browser_context(), false, GURL(), std::nullopt));

  SettingsChangedCallback callback = frontend_->GetObserver();

  // Test with session storage. Default should be restricted to privileged
  // contexts.
  callback.Run(id, StorageAreaNamespace::kSession, std::nullopt,
               base::Value(true));

  ASSERT_EQ(observer.events().size(), 2u);
  EXPECT_EQ(observer.events()[0].name, "storage.session.onChanged");
  EXPECT_EQ(observer.events()[0].restrict_to_context_type,
            mojom::ContextType::kPrivilegedExtension);
  EXPECT_EQ(observer.events()[1].name, "storage.onChanged");
  EXPECT_EQ(observer.events()[1].restrict_to_context_type,
            mojom::ContextType::kPrivilegedExtension);

  observer.Clear();

  // Test with sync storage. Default should NOT be restricted.
  callback.Run(id, StorageAreaNamespace::kSync, std::nullopt,
               base::Value(true));

  ASSERT_EQ(observer.events().size(), 2u);
  EXPECT_EQ(observer.events()[0].name, "storage.sync.onChanged");
  EXPECT_EQ(observer.events()[0].restrict_to_context_type, std::nullopt);
  EXPECT_EQ(observer.events()[1].name, "storage.onChanged");
  EXPECT_EQ(observer.events()[1].restrict_to_context_type, std::nullopt);

  observer.Clear();

  // Test with managed storage. Default should NOT be restricted.
  callback.Run(id, StorageAreaNamespace::kManaged, std::nullopt,
               base::Value(true));

  ASSERT_EQ(observer.events().size(), 2u);
  EXPECT_EQ(observer.events()[0].name, "storage.managed.onChanged");
  EXPECT_EQ(observer.events()[0].restrict_to_context_type, std::nullopt);
  EXPECT_EQ(observer.events()[1].name, "storage.onChanged");
  EXPECT_EQ(observer.events()[1].restrict_to_context_type, std::nullopt);

  event_router->RemoveObserverForTesting(&observer);
}

TEST_F(ExtensionSettingsFrontendTest, SettingsPreservedAcrossReconstruction) {
  const std::string id = "ext";
  scoped_refptr<const Extension> extension =
      settings_test_util::AddExtensionWithId(browser_context(), id,
                                             Manifest::Type::kExtension);

  ValueStore* storage = settings_test_util::GetStorage(
      extension, settings::LOCAL, frontend_.get());

  // The correctness of Get/Set/Remove/Clear is tested elsewhere so no need to
  // be too rigorous.
  {
    base::Value bar("bar");
    ValueStore::WriteResult result = storage->Set(DEFAULTS, "foo", bar);
    ASSERT_TRUE(result.status().ok());
  }

  {
    ValueStore::ReadResult result = storage->Get();
    ASSERT_TRUE(result.status().ok());
    EXPECT_FALSE(result.settings().empty());
  }

  ResetFrontend();
  storage = settings_test_util::GetStorage(extension, settings::LOCAL,
                                           frontend_.get());

  {
    ValueStore::ReadResult result = storage->Get();
    ASSERT_TRUE(result.status().ok());
    EXPECT_FALSE(result.settings().empty());
  }
}

TEST_F(ExtensionSettingsFrontendTest, SettingsClearedOnUninstall) {
  const std::string id = "ext";
  scoped_refptr<const Extension> extension =
      settings_test_util::AddExtensionWithId(
          browser_context(), id, Manifest::Type::kLegacyPackagedApp);

  ValueStore* storage = settings_test_util::GetStorage(
      extension, settings::LOCAL, frontend_.get());

  {
    base::Value bar("bar");
    ValueStore::WriteResult result = storage->Set(DEFAULTS, "foo", bar);
    ASSERT_TRUE(result.status().ok());
  }

  // This would be triggered by extension uninstall via a DataDeleter.
  base::RunLoop run_loop;
  frontend_->DeleteStorageSoon(id, run_loop.QuitClosure());
  run_loop.Run();

  // The storage area may no longer be valid post-uninstall, so re-request.
  storage = settings_test_util::GetStorage(extension, settings::LOCAL,
                                           frontend_.get());
  {
    ValueStore::ReadResult result = storage->Get();
    ASSERT_TRUE(result.status().ok());
    EXPECT_TRUE(result.settings().empty());
  }
}

TEST_F(ExtensionSettingsFrontendTest, LeveldbDatabaseDeletedFromDiskOnClear) {
  const std::string id = "ext";
  scoped_refptr<const Extension> extension =
      settings_test_util::AddExtensionWithId(browser_context(), id,
                                             Manifest::Type::kExtension);

  ValueStore* storage = settings_test_util::GetStorage(
      extension, settings::LOCAL, frontend_.get());

  {
    base::Value bar("bar");
    ValueStore::WriteResult result = storage->Set(DEFAULTS, "foo", bar);
    ASSERT_TRUE(result.status().ok());
    EXPECT_TRUE(base::PathExists(temp_dir_.GetPath()));
  }

  // Should need to both clear the database and delete the frontend for the
  // leveldb database to be deleted from disk.
  {
    ValueStore::WriteResult result = storage->Clear();
    ASSERT_TRUE(result.status().ok());
    EXPECT_TRUE(base::PathExists(temp_dir_.GetPath()));
  }

  frontend_.reset();
  content::RunAllTasksUntilIdle();
  // TODO(kalman): Figure out why this fails, despite appearing to work.
  // Leaving this commented out rather than disabling the whole test so that the
  // deletion code paths are at least exercised.
  // EXPECT_FALSE(base::PathExists(temp_dir_.GetPath()));
}

// Disabled (slow), http://crbug.com/40342579 .
TEST_F(ExtensionSettingsFrontendTest,
       DISABLED_QuotaLimitsEnforcedCorrectlyForSyncAndLocal) {
  const std::string id = "ext";
  scoped_refptr<const Extension> extension =
      settings_test_util::AddExtensionWithId(browser_context(), id,
                                             Manifest::Type::kExtension);

  ValueStore* sync_storage = settings_test_util::GetStorage(
      extension, settings::SYNC, frontend_.get());
  ValueStore* local_storage = settings_test_util::GetStorage(
      extension, settings::LOCAL, frontend_.get());

  // Sync storage should run out after ~100K.
  base::Value kilobyte = settings_test_util::CreateKilobyte();
  for (int i = 0; i < 100; ++i) {
    sync_storage->Set(DEFAULTS, base::NumberToString(i), kilobyte);
  }

  EXPECT_FALSE(
      sync_storage->Set(DEFAULTS, "WillError", kilobyte).status().ok());

  // Local storage shouldn't run out after ~100K.
  for (int i = 0; i < 100; ++i) {
    local_storage->Set(DEFAULTS, base::NumberToString(i), kilobyte);
  }

  EXPECT_TRUE(
      local_storage->Set(DEFAULTS, "WontError", kilobyte).status().ok());

  // Local storage should run out after ~5MB.
  base::Value megabyte = settings_test_util::CreateMegabyte();
  for (int i = 0; i < 5; ++i) {
    local_storage->Set(DEFAULTS, base::NumberToString(i), megabyte);
  }

  EXPECT_FALSE(
      local_storage->Set(DEFAULTS, "WillError", megabyte).status().ok());
}

// Tests that a successful extension storage operation correctly emits success
// metrics for the underlying database status.
TEST_F(ExtensionSettingsFrontendTest, EmitUmaLevelDBMetrics) {
  base::HistogramTester histogram_tester;

  const std::string id = "ext";
  scoped_refptr<const Extension> extension =
      settings_test_util::AddExtensionWithId(browser_context(), id,
                                             Manifest::Type::kExtension);

  base::RunLoop run_loop;
  base::DictValue values;
  values.Set("foo", "bar");

  frontend_->Set(extension, StorageAreaNamespace::kLocal, std::move(values),
                 base::BindOnce(
                     [](base::OnceClosure quit_closure,
                        StorageFrontend::ResultStatus status) {
                       EXPECT_TRUE(status.success);
                       std::move(quit_closure).Run();
                     },
                     run_loop.QuitClosure()));
  run_loop.Run();

  // The Set operation should have succeeded and emitted LevelDB UMA.
  histogram_tester.ExpectUniqueSample(
      "Extensions.Database.Local.StatusCodeByOperation.set",
      /*sample=*/value_store::ValueStore::StatusCode::OK,
      /*expected_bucket_count=*/1);
}

// Tests that a failed extension storage operation (e.g., due to exceeding the
// quota limit) correctly emits an error metric for the high-level operation
// that failed.
TEST_F(ExtensionSettingsFrontendTest, SettingsQuotaExceededEmitsErrorMetric) {
  base::HistogramTester histogram_tester;

  const std::string id = "ext";
  scoped_refptr<const Extension> extension =
      settings_test_util::AddExtensionWithId(browser_context(), id,
                                             Manifest::Type::kExtension);

  base::RunLoop run_loop;
  base::DictValue values;
  // Local quota is 10MB. Setting 11MB should fail.
  base::ListValue megabytes;
  base::Value megabyte = settings_test_util::CreateMegabyte();
  for (int i = 0; i < 11; ++i) {
    megabytes.Append(megabyte.Clone());
  }
  values.Set("too_big", megabytes.Clone());

  frontend_->Set(extension, StorageAreaNamespace::kLocal, std::move(values),
                 base::BindOnce(
                     [](base::OnceClosure quit_closure,
                        StorageFrontend::ResultStatus status) {
                       EXPECT_FALSE(status.success);
                       std::move(quit_closure).Run();
                     },
                     run_loop.QuitClosure()));
  run_loop.Run();

  // The Set operation should have failed and emitted error metrics.
  histogram_tester.ExpectUniqueSample(
      "Extensions.Database.Local.ErrorByOperation",
      /*sample=*/StorageFrontend::ExtensionsDatabaseOperation::kSet,
      /*expected_bucket_count=*/1);
  histogram_tester.ExpectUniqueSample(
      "Extensions.Database.Local.StatusCodeByOperation.set",
      /*sample=*/value_store::ValueStore::StatusCode::QUOTA_EXCEEDED,
      /*expected_bucket_count=*/1);
}

// Tests that OnSettingsChanged emits the execution time histogram.
TEST_F(ExtensionSettingsFrontendTest,
       OnSettingsChangedEmitsExecutionTimeHistogram) {
  base::HistogramTester histogram_tester;

  const std::string id = "ext";
  scoped_refptr<const Extension> extension =
      settings_test_util::AddExtensionWithId(browser_context(), id,
                                             Manifest::Type::kExtension);

  EventRouter* event_router = EventRouter::Get(browser_context());
  event_router->listeners().AddListener(EventListener::CreateLazyListener(
      "storage.onChanged", id, browser_context(), false, GURL(), std::nullopt));

  SettingsChangedCallback callback = frontend_->GetObserver();
  callback.Run(id, StorageAreaNamespace::kLocal, std::nullopt,
               base::Value(true));

  histogram_tester.ExpectTotalCount("Extensions.Storage.OnSettingsChangedTime",
                                    1);
}

}  // namespace extensions