aboutsummaryrefslogtreecommitdiff
path: root/node_modules/selenium-webdriver/test/lib/promise_generator_test.js
blob: b3388da78f937af627321e3ed797047c7466ac1e (plain)
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

'use strict';

const assert = require('assert');
const promise = require('../../lib/promise');
const {enablePromiseManager, promiseManagerSuite} = require('../../lib/test/promise');

describe('promise.consume()', function() {
  promiseManagerSuite(() => {
    it('requires inputs to be generator functions', function() {
      assert.throws(function() {
        promise.consume(function() {});
      });
    });

    it('handles a basic generator with no yielded promises', function() {
      var values = [];
      return promise.consume(function* () {
        var i = 0;
        while (i < 4) {
          i = yield i + 1;
          values.push(i);
        }
      }).then(function() {
        assert.deepEqual([1, 2, 3, 4], values);
      });
    });

    it('handles a promise yielding generator', function() {
      var values = [];
      return promise.consume(function* () {
        var i = 0;
        while (i < 4) {
          // Test that things are actually async here.
          setTimeout(function() {
            values.push(i * 2);
          }, 10);

          yield promise.delayed(10).then(function() {
            values.push(i++);
          });
        }
      }).then(function() {
        assert.deepEqual([0, 0, 2, 1, 4, 2, 6, 3], values);
      });
    });

    it('assignments to yielded promises get fulfilled value', function() {
      return promise.consume(function* () {
        let x = yield Promise.resolve(2);
        assert.equal(2, x);
      });
    });

    it('uses final return value as fulfillment value', function() {
      return promise.consume(function* () {
        yield 1;
        yield 2;
        return 3;
      }).then(function(value) {
        assert.equal(3, value);
      });
    });

    it('throws rejected promise errors within the generator', function() {
      var values = [];
      return promise.consume(function* () {
        values.push('a');
        var e = Error('stub error');
        try {
          yield Promise.reject(e);
          values.push('b');
        } catch (ex) {
          assert.equal(e, ex);
          values.push('c');
        }
        values.push('d');
      }).then(function() {
        assert.deepEqual(['a', 'c', 'd'], values);
      });
    });

    it('aborts the generator if there is an unhandled rejection', function() {
      var values = [];
      var e = Error('stub error');
      return promise.consume(function* () {
        values.push(1);
        yield promise.rejected(e);
        values.push(2);
      }).catch(function() {
        assert.deepEqual([1], values);
      });
    });

    it('yield waits for promises', function() {
      let values = [];
      let blocker = promise.delayed(100).then(() => {
        assert.deepEqual([1], values);
        return 2;
      });

      return promise.consume(function* () {
        values.push(1);
        values.push(yield blocker, 3);
      }).then(function() {
        assert.deepEqual([1, 2, 3], values);
      });
    });

    it('accepts custom scopes', function() {
      return promise.consume(function* () {
        return this.name;
      }, {name: 'Bob'}).then(function(value) {
        assert.equal('Bob', value);
      });
    });

    it('accepts initial generator arguments', function() {
      return promise.consume(function* (a, b) {
        assert.equal('red', a);
        assert.equal('apples', b);
      }, null, 'red', 'apples');
    });
  });

  enablePromiseManager(() =>  {
    it('is possible to cancel promise generators', function() {
      var values = [];
      var p = promise.consume(function* () {
        var i = 0;
        while (i < 3) {
          yield promise.delayed(100).then(function() {
            values.push(i++);
          });
        }
      });
      return promise.delayed(75).then(function() {
        p.cancel();
        return p.catch(function() {
          return promise.delayed(300);
        });
      }).then(function() {
        assert.deepEqual([0], values);
      });
    });

    it('executes generator within the control flow', function() {
      var promises = [
          promise.defer(),
          promise.defer()
      ];
      var values = [];

      setTimeout(function() {
        assert.deepEqual([], values);
        promises[0].fulfill(1);
      }, 100);

      setTimeout(function() {
        assert.deepEqual([1], values);
        promises[1].fulfill(2);
      }, 200);

      return promise.controlFlow().execute(function* () {
        values.push(yield promises[0].promise);
        values.push(yield promises[1].promise);
        values.push('fin');
      }).then(function() {
        assert.deepEqual([1, 2, 'fin'], values);
      });
    });

    it('handles tasks scheduled in generator', function() {
      var flow = promise.controlFlow();
      return flow.execute(function* () {
        var x = yield flow.execute(function() {
          return promise.delayed(10).then(function() {
            return 1;
          });
        });

        var y = yield flow.execute(function() {
          return 2;
        });

        return x + y;
      }).then(function(value) {
        assert.equal(3, value);
      });
    });

    it('blocks the control flow while processing generator', function() {
      var values = [];
      return promise.controlFlow().wait(function* () {
        yield values.push(1);
        values.push(yield promise.delayed(10).then(function() {
          return 2;
        }));
        yield values.push(3);
        return values.length === 6;
      }, 250).then(function() {
        assert.deepEqual([1, 2, 3, 1, 2, 3], values);
      });
    });

    it('ControlFlow.wait() will timeout on long generator', function() {
      var values = [];
      return promise.controlFlow().wait(function* () {
        var i = 0;
        while (i < 3) {
          yield promise.delayed(100).then(function() {
            values.push(i++);
          });
        }
      }, 75).catch(function() {
        assert.deepEqual(
            [0, 1, 2], values, 'Should complete one loop of wait condition');
      });
    });

    describe('generators in promise callbacks', function() {
      it('works with no initial value', function() {
        var promises = [
          promise.defer(),
          promise.defer()
        ];
        var values = [];

        setTimeout(function() {
          promises[0].fulfill(1);
        }, 50);

        setTimeout(function() {
          promises[1].fulfill(2);
        }, 100);

        return promise.fulfilled().then(function*() {
          values.push(yield promises[0].promise);
          values.push(yield promises[1].promise);
          values.push('fin');
        }).then(function() {
          assert.deepEqual([1, 2, 'fin'], values);
        });
      });

      it('starts the generator with promised value', function() {
        var promises = [
          promise.defer(),
          promise.defer()
        ];
        var values = [];

        setTimeout(function() {
          promises[0].fulfill(1);
        }, 50);

        setTimeout(function() {
          promises[1].fulfill(2);
        }, 100);

        return promise.fulfilled(3).then(function*(value) {
          var p1 = yield promises[0].promise;
          var p2 = yield promises[1].promise;
          values.push(value + p1);
          values.push(value + p2);
          values.push('fin');
        }).then(function() {
          assert.deepEqual([4, 5, 'fin'], values);
        });
      });

      it('throws yielded rejections within the generator callback', function() {
        var d = promise.defer();
        var e = Error('stub');

        setTimeout(function() {
          d.reject(e);
        }, 50);

        return promise.fulfilled().then(function*() {
          var threw = false;
          try {
            yield d.promise;
          } catch (ex) {
            threw = true;
            assert.equal(e, ex);
          }
          assert.ok(threw);
        });
      });
    });
  });
});