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
import { expect } from 'chai';import { SinonStub, stub } from 'sinon';import { promisify } from 'util';import { runInChild } from './common/util.test';import { TaskCancelledError } from './errors/TaskCancelledError';import { timeout } from './Policy';import { TimeoutPolicy, TimeoutStrategy } from './TimeoutPolicy';
const delay = promisify(setTimeout);
describe('TimeoutPolicy', () => {  it('works when no timeout happens', async () => {    const policy = timeout(1000, TimeoutStrategy.Cooperative);    expect(await policy.execute(() => 42)).to.equal(42);  });
  it('properly cooperatively cancels', async () => {    const policy = timeout(2, TimeoutStrategy.Cooperative);    expect(      await policy.execute(async ({ signal }) => {        expect(signal.aborted).to.be.false;        await delay(3);        expect(signal.aborted).to.be.true;        return 42;      }),    ).to.equal(42);  });
  it('properly aggressively cancels', async () => {    const policy = timeout(5, TimeoutStrategy.Aggressive);    let verified: Promise<void>;    await expect(      policy.execute(        async ({ signal }) =>          (verified = (async () => {            await delay(0);            expect(signal.aborted).to.be.false;            await delay(5);            expect(signal.aborted).to.be.true;          })()),      ),    ).to.eventually.be.rejectedWith(TaskCancelledError);
    await verified!;  });
  it('does not unref by default', async () => {    // this would timeout if the timers were referenced    const output = await runInChild(`      c.timeout(100, 'aggressive')        .execute(() => new Promise(() => {}));    `);
    expect(output).to.contain('Operation timed out');  });
  it('unrefs as requested', async () => {    // this would timeout if the timers were referenced    const output = await runInChild(`      c.timeout(60 * 1000, 'aggressive')        .dangerouslyUnref()        .execute(() => new Promise(() => {}));    `);
    expect(output).to.be.empty;  });
  it('links parent cancellation token', async () => {    const parent = new AbortController();    await timeout(1000, TimeoutStrategy.Cooperative).execute((_, signal) => {      expect(signal.aborted).to.be.false;      parent.abort();      expect(signal.aborted).to.be.true;    }, parent.signal);  });
  it('still has own timeout if given parent', async () => {    const parent = new AbortController();    await timeout(1, TimeoutStrategy.Cooperative).execute(async (_, signal) => {      expect(signal.aborted).to.be.false;      await delay(3);      expect(signal.aborted).to.be.true;    }, parent.signal);  });
  it('aborts on return by default', async () => {    let signal: AbortSignal;    await timeout(1, TimeoutStrategy.Cooperative).execute(async (_, s) => {      signal = s;    });    expect(signal!.aborted).to.be.true;  });
  it('does not aborts on return if requested', async () => {    let signal: AbortSignal;    await timeout(1, { strategy: TimeoutStrategy.Aggressive, abortOnReturn: false }).execute(      async (_, s) => {        signal = s;      },    );    expect(signal!.aborted).to.be.false;  });
  describe('events', () => {    let onSuccess: SinonStub;    let onFailure: SinonStub;    let onTimeout: SinonStub;    let agg: TimeoutPolicy;    let coop: TimeoutPolicy;
    beforeEach(() => {      onSuccess = stub();      onFailure = stub();      onTimeout = stub();      coop = timeout(2, TimeoutStrategy.Cooperative);      agg = timeout(2, TimeoutStrategy.Aggressive);      for (const p of [coop, agg]) {        p.onFailure(onFailure);        p.onSuccess(onSuccess);        p.onTimeout(onTimeout);      }    });
    it('emits a success event (cooperative)', async () => {      await coop.execute(() => 42);      await delay(3);      expect(onSuccess).to.have.been.called;      expect(onFailure).to.not.have.been.called;      expect(onTimeout).to.not.have.been.called;    });
    it('emits a success event (aggressive)', async () => {      await agg.execute(() => 42);      await delay(3);      expect(onSuccess).to.have.been.called;      expect(onFailure).to.not.have.been.called;      expect(onTimeout).to.not.have.been.called;    });
    it('emits a timeout event (cooperative)', async () => {      coop.onTimeout(onTimeout);      await coop.execute(() => delay(3));      expect(onSuccess).to.have.been.called; // still returned a good value      expect(onTimeout).to.have.been.called;      expect(onFailure).to.not.have.been.called;    });
    it('emits a timeout event (aggressive)', async () => {      await expect(agg.execute(() => delay(3))).to.be.rejectedWith(TaskCancelledError);      expect(onSuccess).to.not.have.been.called;      expect(onTimeout).to.have.been.called;      expect(onFailure).to.have.been.called;    });
    it('emits a failure event (cooperative)', async () => {      await expect(        coop.execute(() => {          throw new Error('oh no!');        }),      ).to.be.rejected;      await delay(3);
      expect(onSuccess).to.not.have.been.called;      expect(onTimeout).to.not.have.been.called;      expect(onFailure).to.have.been.called;    });
    it('emits a failure event (aggressive)', async () => {      await expect(        agg.execute(() => {          throw new Error('oh no!');        }),      ).to.be.rejected;      await delay(3);
      expect(onSuccess).to.not.have.been.called;      expect(onTimeout).to.not.have.been.called;      expect(onFailure).to.have.been.called;    });  });});