File: task_environment.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (69 lines) | stat: -rw-r--r-- 2,534 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef THIRD_PARTY_BLINK_RENDERER_PLATFORM_TESTING_TASK_ENVIRONMENT_H_
#define THIRD_PARTY_BLINK_RENDERER_PLATFORM_TESTING_TASK_ENVIRONMENT_H_

#include <optional>

#include "base/test/task_environment.h"
#include "third_party/blink/renderer/platform/scheduler/common/task_priority.h"
#include "third_party/blink/renderer/platform/testing/main_thread_isolate.h"
#include "third_party/blink/renderer/platform/testing/scoped_main_thread_overrider.h"
#include "v8/include/v8-forward.h"

namespace blink::scheduler {
class MainThreadSchedulerImpl;
}

namespace blink::test {

// TaskEnvironment is a convenience class which allows usage of these
// APIs within its scope:
// - Same APIs as base::test::TaskEnvironment.
// - Blink Main Thread isolate.
// - blink::scheduler::WebThreadScheduler.
//
// Only tests that need blink APIs should instantiate a
// blink::test::TaskEnvironment. Use base::test::SingleThreadTaskEnvironment or
// base::test::TaskEnvironment otherwise.
//
// Tests that render <video> may also need CSSDefaultStyleSheets::TestingScope
// (see comments on that class).
class TaskEnvironment : public base::test::TaskEnvironment {
 public:
  using ValidTraits = base::test::TaskEnvironment::ValidTraits;

  template <typename... Traits>
    requires base::trait_helpers::AreValidTraits<ValidTraits, Traits...>
  explicit TaskEnvironment(Traits... traits)
      : TaskEnvironment(CreateTaskEnvironmentWithPriorities(
            blink::scheduler::CreatePrioritySettings(),
            SubclassCreatesDefaultTaskRunner{},
            traits...)) {}

  ~TaskEnvironment() override;

  scheduler::MainThreadSchedulerImpl* main_thread_scheduler() {
    return scheduler_.get();
  }
  v8::Isolate* isolate() { return main_thread_isolate_->isolate(); }
  void ResetIsolate() { main_thread_isolate_.reset(); }

  static bool IsSupported();

 private:
  // When |real_main_thread_scheduler|, instantiate a full featured
  // blink::MainThreadScheduler as opposed to a simple Thread scheduler.
  explicit TaskEnvironment(
      base::test::TaskEnvironment&& scoped_task_environment);

  std::unique_ptr<scheduler::MainThreadSchedulerImpl> scheduler_;
  std::optional<MainThreadIsolate> main_thread_isolate_;
  std::optional<ScopedMainThreadOverrider> main_thread_overrider_;
};

}  // namespace blink::test

#endif  // THIRD_PARTY_BLINK_RENDERER_PLATFORM_TESTING_TASK_ENVIRONMENT_H_