content/public/test/browsing_data_remover_test_util.h

// 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.

#ifndef CONTENT_PUBLIC_TEST_BROWSING_DATA_REMOVER_TEST_UTIL_H_
#define CONTENT_PUBLIC_TEST_BROWSING_DATA_REMOVER_TEST_UTIL_H_

#include <memory>

#include "base/memory/raw_ptr.h"
#include "base/run_loop.h"
#include "base/scoped_observation.h"
#include "base/task/sequenced_task_runner.h"
#include "content/public/browser/browsing_data_remover.h"

namespace content {

// This class can be used to wait for a BrowsingDataRemover to complete
// operation. It is not suitable for repeated use.
class BrowsingDataRemoverCompletionObserver
    : public BrowsingDataRemover::Observer {
 public:
  explicit BrowsingDataRemoverCompletionObserver(BrowsingDataRemover* remover);

  BrowsingDataRemoverCompletionObserver(
      const BrowsingDataRemoverCompletionObserver&) = delete;
  BrowsingDataRemoverCompletionObserver& operator=(
      const BrowsingDataRemoverCompletionObserver&) = delete;

  ~BrowsingDataRemoverCompletionObserver() override;

  void BlockUntilCompletion();

  bool browsing_data_remover_done() { return browsing_data_remover_done_; }

  uint64_t failed_data_types() { return failed_data_types_; }

 protected:
  // BrowsingDataRemover::Observer:
  void OnBrowsingDataRemoverDone(uint64_t failed_data_types) override;

 private:
  void FlushForTestingComplete();
  void QuitRunLoopWhenTasksComplete();

  // Tracks when the Task Scheduler task flushing is done.
  bool flush_for_testing_complete_ = false;

  // Tracks when BrowsingDataRemover::Observer::OnBrowsingDataRemoverDone() is
  // called.
  bool browsing_data_remover_done_ = false;

  // Stores the |failed_data_types| mask passed into
  // OnBrowsingDataRemoverDone().
  uint64_t failed_data_types_ = 0;

  base::RunLoop run_loop_;
  base::ScopedObservation<BrowsingDataRemover, BrowsingDataRemover::Observer>
      observation_{this};
  scoped_refptr<base::SequencedTaskRunner> origin_task_runner_;
};

// The completion inhibitor can artificially delay completion of the browsing
// data removal process. It is used during testing to simulate scenarios in
// which the deletion stalls or takes a very long time.
//
// This class will detach itself from |remover| upon its destruction.
// If |remover| is destroyed during a test (e.g. in profile shutdown tests),
// users must call Reset() to detach it in advance.
class BrowsingDataRemoverCompletionInhibitor {
 public:
  explicit BrowsingDataRemoverCompletionInhibitor(BrowsingDataRemover* remover);

  BrowsingDataRemoverCompletionInhibitor(
      const BrowsingDataRemoverCompletionInhibitor&) = delete;
  BrowsingDataRemoverCompletionInhibitor& operator=(
      const BrowsingDataRemoverCompletionInhibitor&) = delete;

  virtual ~BrowsingDataRemoverCompletionInhibitor();

  void Reset();

  void BlockUntilNearCompletion();
  void ContinueToCompletion();

 protected:
  virtual void OnBrowsingDataRemoverWouldComplete(
      base::OnceClosure continue_to_completion);

 private:
  void FlushForTestingComplete();
  void QuitRunLoopWhenTasksComplete();

  // Tracks when the Task Scheduler task flushing is done.
  bool flush_for_testing_complete_ = false;

  // Tracks when OnBrowsingDataRemoverWouldComplete() is called.
  bool browsing_data_remover_would_complete_done_ = false;

  // Not owned by this class. If the pointer becomes invalid, the owner of
  // this class is responsible for calling Reset().
  raw_ptr<BrowsingDataRemover> remover_;

  std::unique_ptr<base::RunLoop> run_loop_;
  base::OnceClosure continue_to_completion_callback_;
  scoped_refptr<base::SequencedTaskRunner> origin_task_runner_;
};

}  // namespace content

#endif  // CONTENT_PUBLIC_TEST_BROWSING_DATA_REMOVER_TEST_UTIL_H_