1 // Copyright 2013 The Chromium Authors
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #include "base/task/deferred_sequenced_task_runner.h"
6
7 #include "base/functional/bind.h"
8 #include "base/functional/callback_helpers.h"
9 #include "base/location.h"
10 #include "base/memory/raw_ptr.h"
11 #include "base/memory/ref_counted.h"
12 #include "base/run_loop.h"
13 #include "base/task/single_thread_task_runner.h"
14 #include "base/test/task_environment.h"
15 #include "base/threading/thread.h"
16 #include "testing/gmock/include/gmock/gmock.h"
17 #include "testing/gtest/include/gtest/gtest.h"
18
19 namespace base {
20 namespace {
21
22 class DeferredSequencedTaskRunnerTest : public testing::Test {
23 public:
24 class ExecuteTaskOnDestructor : public RefCounted<ExecuteTaskOnDestructor> {
25 public:
ExecuteTaskOnDestructor(DeferredSequencedTaskRunnerTest * executor,int task_id)26 ExecuteTaskOnDestructor(
27 DeferredSequencedTaskRunnerTest* executor,
28 int task_id)
29 : executor_(executor),
30 task_id_(task_id) {
31 }
32 private:
33 friend class RefCounted<ExecuteTaskOnDestructor>;
~ExecuteTaskOnDestructor()34 virtual ~ExecuteTaskOnDestructor() { executor_->ExecuteTask(task_id_); }
35 raw_ptr<DeferredSequencedTaskRunnerTest> executor_;
36 int task_id_;
37 };
38
ExecuteTask(int task_id)39 void ExecuteTask(int task_id) {
40 AutoLock lock(lock_);
41 executed_task_ids_.push_back(task_id);
42 }
43
PostExecuteTask(int task_id)44 void PostExecuteTask(int task_id) {
45 runner_->PostTask(FROM_HERE,
46 BindOnce(&DeferredSequencedTaskRunnerTest::ExecuteTask,
47 Unretained(this), task_id));
48 }
49
StartRunner()50 void StartRunner() {
51 runner_->Start();
52 }
53
DoNothing(ExecuteTaskOnDestructor * object)54 void DoNothing(ExecuteTaskOnDestructor* object) {
55 }
56
57 protected:
DeferredSequencedTaskRunnerTest()58 DeferredSequencedTaskRunnerTest()
59 : runner_(new DeferredSequencedTaskRunner(
60 SingleThreadTaskRunner::GetCurrentDefault())) {}
61
62 test::TaskEnvironment task_environment_;
63 scoped_refptr<DeferredSequencedTaskRunner> runner_;
64 mutable Lock lock_;
65 std::vector<int> executed_task_ids_;
66 };
67
TEST_F(DeferredSequencedTaskRunnerTest,Stopped)68 TEST_F(DeferredSequencedTaskRunnerTest, Stopped) {
69 PostExecuteTask(1);
70 RunLoop().RunUntilIdle();
71 EXPECT_THAT(executed_task_ids_, testing::ElementsAre());
72 EXPECT_FALSE(runner_->Started());
73 }
74
TEST_F(DeferredSequencedTaskRunnerTest,Start)75 TEST_F(DeferredSequencedTaskRunnerTest, Start) {
76 EXPECT_FALSE(runner_->Started());
77 StartRunner();
78 EXPECT_TRUE(runner_->Started());
79 PostExecuteTask(1);
80 RunLoop().RunUntilIdle();
81 EXPECT_THAT(executed_task_ids_, testing::ElementsAre(1));
82 }
83
TEST_F(DeferredSequencedTaskRunnerTest,StartWithMultipleElements)84 TEST_F(DeferredSequencedTaskRunnerTest, StartWithMultipleElements) {
85 EXPECT_FALSE(runner_->Started());
86 StartRunner();
87 EXPECT_TRUE(runner_->Started());
88 for (int i = 1; i < 5; ++i)
89 PostExecuteTask(i);
90
91 RunLoop().RunUntilIdle();
92 EXPECT_THAT(executed_task_ids_, testing::ElementsAre(1, 2, 3, 4));
93 }
94
TEST_F(DeferredSequencedTaskRunnerTest,DeferredStart)95 TEST_F(DeferredSequencedTaskRunnerTest, DeferredStart) {
96 EXPECT_FALSE(runner_->Started());
97 PostExecuteTask(1);
98 RunLoop().RunUntilIdle();
99 EXPECT_THAT(executed_task_ids_, testing::ElementsAre());
100 EXPECT_FALSE(runner_->Started());
101
102 StartRunner();
103 EXPECT_TRUE(runner_->Started());
104 RunLoop().RunUntilIdle();
105 EXPECT_THAT(executed_task_ids_, testing::ElementsAre(1));
106 EXPECT_TRUE(runner_->Started());
107
108 PostExecuteTask(2);
109 RunLoop().RunUntilIdle();
110 EXPECT_THAT(executed_task_ids_, testing::ElementsAre(1, 2));
111 EXPECT_TRUE(runner_->Started());
112 }
113
TEST_F(DeferredSequencedTaskRunnerTest,DeferredStartWithMultipleElements)114 TEST_F(DeferredSequencedTaskRunnerTest, DeferredStartWithMultipleElements) {
115 for (int i = 1; i < 5; ++i)
116 PostExecuteTask(i);
117 RunLoop().RunUntilIdle();
118 EXPECT_THAT(executed_task_ids_, testing::ElementsAre());
119 EXPECT_FALSE(runner_->Started());
120
121 StartRunner();
122 EXPECT_TRUE(runner_->Started());
123 for (int i = 5; i < 9; ++i)
124 PostExecuteTask(i);
125 RunLoop().RunUntilIdle();
126 EXPECT_THAT(executed_task_ids_, testing::ElementsAre(1, 2, 3, 4, 5, 6, 7, 8));
127 EXPECT_TRUE(runner_->Started());
128 }
129
TEST_F(DeferredSequencedTaskRunnerTest,DeferredStartWithMultipleThreads)130 TEST_F(DeferredSequencedTaskRunnerTest, DeferredStartWithMultipleThreads) {
131 {
132 Thread thread1("DeferredSequencedTaskRunnerTestThread1");
133 Thread thread2("DeferredSequencedTaskRunnerTestThread2");
134 thread1.Start();
135 thread2.Start();
136 for (int i = 0; i < 5; ++i) {
137 thread1.task_runner()->PostTask(
138 FROM_HERE, BindOnce(&DeferredSequencedTaskRunnerTest::PostExecuteTask,
139 Unretained(this), 2 * i));
140 thread2.task_runner()->PostTask(
141 FROM_HERE, BindOnce(&DeferredSequencedTaskRunnerTest::PostExecuteTask,
142 Unretained(this), 2 * i + 1));
143 if (i <= 2) {
144 EXPECT_FALSE(runner_->Started());
145 }
146 if (i == 2) {
147 thread1.task_runner()->PostTask(
148 FROM_HERE, BindOnce(&DeferredSequencedTaskRunnerTest::StartRunner,
149 Unretained(this)));
150 }
151 }
152 }
153
154 RunLoop().RunUntilIdle();
155 EXPECT_TRUE(runner_->Started());
156 EXPECT_THAT(executed_task_ids_,
157 testing::WhenSorted(testing::ElementsAre(0, 1, 2, 3, 4, 5, 6, 7, 8, 9)));
158 }
159
TEST_F(DeferredSequencedTaskRunnerTest,ObjectDestructionOrder)160 TEST_F(DeferredSequencedTaskRunnerTest, ObjectDestructionOrder) {
161 {
162 Thread thread("DeferredSequencedTaskRunnerTestThread");
163 thread.Start();
164 runner_ = new DeferredSequencedTaskRunner(thread.task_runner());
165 for (int i = 0; i < 5; ++i) {
166 {
167 // Use a block to ensure that no reference to |short_lived_object|
168 // is kept on the main thread after it is posted to |runner_|.
169 scoped_refptr<ExecuteTaskOnDestructor> short_lived_object =
170 new ExecuteTaskOnDestructor(this, 2 * i);
171 runner_->PostTask(
172 FROM_HERE,
173 BindOnce(&DeferredSequencedTaskRunnerTest::DoNothing,
174 Unretained(this), RetainedRef(short_lived_object)));
175 }
176 // |short_lived_object| with id |2 * i| should be destroyed before the
177 // task |2 * i + 1| is executed.
178 PostExecuteTask(2 * i + 1);
179 }
180 EXPECT_FALSE(runner_->Started());
181 StartRunner();
182 }
183
184 // All |short_lived_object| with id |2 * i| are destroyed before the task
185 // |2 * i + 1| is executed.
186 EXPECT_THAT(executed_task_ids_,
187 testing::ElementsAre(0, 1, 2, 3, 4, 5, 6, 7, 8, 9));
188 EXPECT_TRUE(runner_->Started());
189 }
190
GetRunsTasksInCurrentSequence(bool * result,scoped_refptr<SequencedTaskRunner> runner,OnceClosure quit)191 void GetRunsTasksInCurrentSequence(bool* result,
192 scoped_refptr<SequencedTaskRunner> runner,
193 OnceClosure quit) {
194 *result = runner->RunsTasksInCurrentSequence();
195 std::move(quit).Run();
196 }
197
TEST_F(DeferredSequencedTaskRunnerTest,RunsTasksInCurrentSequence)198 TEST_F(DeferredSequencedTaskRunnerTest, RunsTasksInCurrentSequence) {
199 scoped_refptr<DeferredSequencedTaskRunner> runner =
200 MakeRefCounted<DeferredSequencedTaskRunner>();
201 EXPECT_TRUE(runner->RunsTasksInCurrentSequence());
202
203 Thread thread1("DeferredSequencedTaskRunnerTestThread1");
204 thread1.Start();
205 bool runs_task_in_current_thread = true;
206 base::RunLoop run_loop;
207 thread1.task_runner()->PostTask(
208 FROM_HERE,
209 BindOnce(&GetRunsTasksInCurrentSequence, &runs_task_in_current_thread,
210 runner, run_loop.QuitClosure()));
211 run_loop.Run();
212 EXPECT_FALSE(runs_task_in_current_thread);
213 EXPECT_FALSE(runner->Started());
214 }
215
TEST_F(DeferredSequencedTaskRunnerTest,StartWithTaskRunner)216 TEST_F(DeferredSequencedTaskRunnerTest, StartWithTaskRunner) {
217 scoped_refptr<DeferredSequencedTaskRunner> runner =
218 MakeRefCounted<DeferredSequencedTaskRunner>();
219 bool run_called = false;
220 base::RunLoop run_loop;
221 runner->PostTask(FROM_HERE,
222 BindOnce(
223 [](bool* run_called, base::OnceClosure quit_closure) {
224 *run_called = true;
225 std::move(quit_closure).Run();
226 },
227 &run_called, run_loop.QuitClosure()));
228 EXPECT_FALSE(runner->Started());
229 runner->StartWithTaskRunner(SingleThreadTaskRunner::GetCurrentDefault());
230 EXPECT_TRUE(runner->Started());
231 run_loop.Run();
232 EXPECT_TRUE(run_called);
233 }
234
235 } // namespace
236 } // namespace base
237