-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
timers.ts
187 lines (155 loc) · 4.16 KB
/
timers.ts
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
/**
* Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of https://github.com/facebook/jest.
*/
import type {
FakeTimerInstallOpts,
FakeTimerWithContext,
InstalledClock,
} from '@sinonjs/fake-timers'
import {
withGlobal,
} from '@sinonjs/fake-timers'
import { RealDate, mockDate, resetDate } from './date'
export class FakeTimers {
private _clock!: InstalledClock
private _fakingTime: boolean
private _fakingDate: boolean
private _fakeTimers: FakeTimerWithContext
private _userConfig?: FakeTimerInstallOpts
private _now = RealDate.now
constructor({
global,
config,
}: {
global: typeof globalThis
config: FakeTimerInstallOpts
}) {
this._userConfig = config
this._fakingDate = false
this._fakingTime = false
this._fakeTimers = withGlobal(global)
}
clearAllTimers(): void {
if (this._fakingTime)
this._clock.reset()
}
dispose(): void {
this.useRealTimers()
}
runAllTimers(): void {
if (this._checkFakeTimers())
this._clock.runAll()
}
async runAllTimersAsync(): Promise<void> {
if (this._checkFakeTimers())
await this._clock.runAllAsync()
}
runOnlyPendingTimers(): void {
if (this._checkFakeTimers())
this._clock.runToLast()
}
async runOnlyPendingTimersAsync(): Promise<void> {
if (this._checkFakeTimers())
await this._clock.runToLastAsync()
}
advanceTimersToNextTimer(steps = 1): void {
if (this._checkFakeTimers()) {
for (let i = steps; i > 0; i--) {
this._clock.next()
// Fire all timers at this point: https://github.com/sinonjs/fake-timers/issues/250
this._clock.tick(0)
if (this._clock.countTimers() === 0)
break
}
}
}
async advanceTimersToNextTimerAsync(steps = 1): Promise<void> {
if (this._checkFakeTimers()) {
for (let i = steps; i > 0; i--) {
await this._clock.nextAsync()
// Fire all timers at this point: https://github.com/sinonjs/fake-timers/issues/250
this._clock.tick(0)
if (this._clock.countTimers() === 0)
break
}
}
}
advanceTimersByTime(msToRun: number): void {
if (this._checkFakeTimers())
this._clock.tick(msToRun)
}
async advanceTimersByTimeAsync(msToRun: number): Promise<void> {
if (this._checkFakeTimers())
await this._clock.tickAsync(msToRun)
}
runAllTicks(): void {
if (this._checkFakeTimers()) {
// @ts-expect-error method not exposed
this._clock.runMicrotasks()
}
}
useRealTimers(): void {
if (this._fakingDate) {
resetDate()
this._fakingDate = false
}
if (this._fakingTime) {
this._clock.uninstall()
this._fakingTime = false
}
}
useFakeTimers(): void {
if (this._fakingDate) {
throw new Error(
'"setSystemTime" was called already and date was mocked. Reset timers using `vi.useRealTimers()` if you want to use fake timers again.',
)
}
if (!this._fakingTime) {
const toFake = Object.keys(this._fakeTimers.timers) as Array<keyof FakeTimerWithContext['timers']>
this._clock = this._fakeTimers.install({
now: Date.now(),
toFake,
...this._userConfig,
})
this._fakingTime = true
}
}
reset(): void {
if (this._checkFakeTimers()) {
const { now } = this._clock
this._clock.reset()
this._clock.setSystemTime(now)
}
}
setSystemTime(now?: number | Date): void {
if (this._fakingTime) {
this._clock.setSystemTime(now)
}
else {
mockDate(now ?? this.getRealSystemTime())
this._fakingDate = true
}
}
getRealSystemTime(): number {
return this._now()
}
getTimerCount(): number {
if (this._checkFakeTimers())
return this._clock.countTimers()
return 0
}
configure(config: FakeTimerInstallOpts): void {
this._userConfig = config
}
private _checkFakeTimers() {
if (!this._fakingTime) {
throw new Error(
'Timers are not mocked. Try calling "vi.useFakeTimers()" first.',
)
}
return this._fakingTime
}
}