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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "mozilla/StopGapEventTarget.h"
#include "mozilla/RefPtr.h"
#include "mozilla/gtest/MozAssertions.h"
#include "nsIRunnable.h"
#include "nsThreadUtils.h"
#include "Helpers.h"
using mozilla::CancelableRunnable;
using mozilla::MakeRefPtr;
using mozilla::StopGapEventTarget;
namespace TestStopGapEventTarget {
static void Enqueue(nsIEventTarget* target, std::function<void()>&& aCallable) {
nsresult rv = target->Dispatch(
NS_NewRunnableFunction("SGQ GTest", std::move(aCallable)));
MOZ_ALWAYS_TRUE(NS_SUCCEEDED(rv));
}
class TestCancelable final : public CancelableRunnable {
public:
explicit TestCancelable() : CancelableRunnable("TestCancelable") {}
NS_IMETHOD Run() override {
mHasRun = true;
return NS_OK;
}
nsresult Cancel() override {
mHasCanceled = true;
return NS_OK;
}
bool mHasRun = false;
bool mHasCanceled = false;
private:
virtual ~TestCancelable() = default;
};
} // namespace TestStopGapEventTarget
using namespace TestStopGapEventTarget;
using testing::RunnableQueue;
TEST(StopGapEventTarget, SimpleDispatch)
{
std::string log;
RefPtr<StopGapEventTarget> stopgap = MakeRefPtr<StopGapEventTarget>();
Enqueue(stopgap, [&]() { log += 'a'; });
ASSERT_EQ(log, "");
auto base = MakeRefPtr<RunnableQueue>();
stopgap->SetRealEventTarget(base);
ASSERT_NS_SUCCEEDED(base->Run());
ASSERT_EQ(log, "a");
ASSERT_TRUE(base->IsEmpty());
}
TEST(StopGapEventTarget, RunnableNeverRun)
{
std::string log;
RefPtr<StopGapEventTarget> stopgap = MakeRefPtr<StopGapEventTarget>();
Enqueue(stopgap, [&]() { log += 'a'; });
ASSERT_EQ(log, "");
stopgap = nullptr;
ASSERT_EQ(log, "");
}
TEST(StopGapEventTarget, CancelableIsRun)
{
RefPtr<StopGapEventTarget> stopgap = MakeRefPtr<StopGapEventTarget>();
RefPtr<TestCancelable> cancelable(new TestCancelable);
stopgap->Dispatch(do_AddRef(cancelable));
ASSERT_FALSE(cancelable->mHasRun);
ASSERT_FALSE(cancelable->mHasCanceled);
auto base = MakeRefPtr<RunnableQueue>();
stopgap->SetRealEventTarget(base);
ASSERT_NS_SUCCEEDED(base->Run());
stopgap = nullptr;
ASSERT_TRUE(cancelable->mHasRun);
ASSERT_FALSE(cancelable->mHasCanceled);
}
TEST(StopGapEventTarget, CancelableNeverRun)
{
RefPtr<StopGapEventTarget> stopgap = MakeRefPtr<StopGapEventTarget>();
RefPtr<TestCancelable> cancelable(new TestCancelable);
stopgap->Dispatch(do_AddRef(cancelable));
ASSERT_FALSE(cancelable->mHasRun);
ASSERT_FALSE(cancelable->mHasCanceled);
stopgap = nullptr;
ASSERT_FALSE(cancelable->mHasRun);
ASSERT_TRUE(cancelable->mHasCanceled);
}
TEST(StopGapEventTarget, EnqueueFromRun)
{
std::string log;
auto base = MakeRefPtr<RunnableQueue>();
RefPtr<StopGapEventTarget> stopgap = MakeRefPtr<StopGapEventTarget>();
Enqueue(base, [&]() { log += 'a'; });
Enqueue(stopgap, [&]() {
log += 'b';
Enqueue(stopgap, [&]() { log += 'c'; });
Enqueue(base, [&]() { log += 'd'; });
});
Enqueue(stopgap, [&]() { log += 'e'; });
ASSERT_NS_SUCCEEDED(base->Run());
ASSERT_EQ(log, "a");
ASSERT_TRUE(base->IsEmpty());
stopgap->SetRealEventTarget(base);
ASSERT_EQ(base->Length(), 2U);
ASSERT_NS_SUCCEEDED(base->Run());
ASSERT_EQ(log, "abecd");
ASSERT_TRUE(base->IsEmpty());
}
TEST(StopGapEventTarget, RunFromRun)
{
std::string log;
auto base = MakeRefPtr<RunnableQueue>();
RefPtr<StopGapEventTarget> stopgap = MakeRefPtr<StopGapEventTarget>();
Enqueue(base, [&]() { log += 'a'; });
// Running the event queue from within an event (i.e., a nested event loop)
// does not stall the StopGapEventTarget.
Enqueue(stopgap, [&]() {
log += '(';
Enqueue(stopgap, [&]() { log += 'b'; });
// This should run subsequent events from stopgap.
ASSERT_NS_SUCCEEDED(base->Run());
log += ')';
});
Enqueue(stopgap, [&]() { log += 'c'; });
ASSERT_EQ(log, "");
stopgap->SetRealEventTarget(base);
ASSERT_NS_SUCCEEDED(base->Run());
ASSERT_EQ(log, "a(cb)");
ASSERT_TRUE(base->IsEmpty());
}
TEST(StopGapEventTarget, SetEventTargetFromRun)
{
std::string log;
auto base = MakeRefPtr<RunnableQueue>();
RefPtr<StopGapEventTarget> stopgap = MakeRefPtr<StopGapEventTarget>();
Enqueue(stopgap, [&]() {
// This is running during the first Run() call, and enqueueing these will
// result in them being run too during this call
log += 'd';
Enqueue(stopgap, [&]() { log += 'e'; });
Enqueue(stopgap, [&]() { log += 'f'; });
});
Enqueue(base, [&]() {
log += 'a';
// This will enqueue the d task from above; Run() is currently running...
stopgap->SetRealEventTarget(base);
log += 'b';
// ...but we call Run inside Run; *this* call to Run will take over, running
// d, then e and f
ASSERT_NS_SUCCEEDED(base->Run());
log += 'c';
});
ASSERT_EQ(log, "");
ASSERT_NS_SUCCEEDED(base->Run());
ASSERT_EQ(log, "abdefc");
ASSERT_TRUE(base->IsEmpty());
}
TEST(StopGapEventTarget, DropWhileRunning)
{
std::string log;
auto base = MakeRefPtr<RunnableQueue>();
// If we drop the event queue while it still has events, they still run.
{
RefPtr<StopGapEventTarget> stopgap = MakeRefPtr<StopGapEventTarget>();
Enqueue(stopgap, [&]() { log += 'a'; });
stopgap->SetRealEventTarget(base);
}
ASSERT_EQ(log, "");
ASSERT_NS_SUCCEEDED(base->Run());
ASSERT_EQ(log, "a");
}
|
