summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/web-animations/interfaces/KeyframeEffect/processing-a-keyframes-argument-001.html
blob: 271a47b3011fd623a302f70c9312e34fe2628f1b (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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
<!DOCTYPE html>
<meta charset=utf-8>
<title>Processing a keyframes argument (property access)</title>
<link rel="help" href="https://drafts.csswg.org/web-animations/#processing-a-keyframes-argument">
<script src="/resources/testharness.js"></script>
<script src="/resources/testharnessreport.js"></script>
<script src="../../testcommon.js"></script>
<script src="../../resources/keyframe-utils.js"></script>
<body>
<div id="log"></div>
<div id="target"></div>
<script>
'use strict';

// This file only tests the KeyframeEffect constructor since it is
// assumed that the implementation of the KeyframeEffect constructor,
// Animatable.animate() method, and KeyframeEffect.setKeyframes() method will
// all share common machinery and it is not necessary to test each method.

// Test that only animatable properties are accessed

const gNonAnimatableProps = [
  'animation', // Shorthands where all the longhand sub-properties are not
               // animatable, are also not animatable.
  'animationDelay',
  'animationDirection',
  'animationDuration',
  'animationFillMode',
  'animationIterationCount',
  'animationName',
  'animationPlayState',
  'animationTimingFunction',
  'transition',
  'transitionDelay',
  'transitionDuration',
  'transitionProperty',
  'transitionTimingFunction',
  'contain',
  'direction',
  'display',
  'textCombineUpright',
  'textOrientation',
  'unicodeBidi',
  'willChange',
  'writingMode',

  'unsupportedProperty',

  'float', // We use the string "cssFloat" to represent "float" property, and
           // so reject "float" in the keyframe-like object.
  'font-size', // Supported property that uses dashes
];

function TestKeyframe(testProp) {
  let _propAccessCount = 0;

  Object.defineProperty(this, testProp, {
    get: () => { _propAccessCount++; },
    enumerable: true,
  });

  Object.defineProperty(this, 'propAccessCount', {
    get: () => _propAccessCount
  });
}

function GetTestKeyframeSequence(testProp) {
  return [ new TestKeyframe(testProp) ]
}

for (const prop of gNonAnimatableProps) {
  test(() => {
    const testKeyframe = new TestKeyframe(prop);

    new KeyframeEffect(null, testKeyframe);

    assert_equals(testKeyframe.propAccessCount, 0, 'Accessor not called');
  }, `non-animatable property '${prop}' is not accessed when using`
     + ' a property-indexed keyframe object');
}

for (const prop of gNonAnimatableProps) {
  test(() => {
    const testKeyframes = GetTestKeyframeSequence(prop);

    new KeyframeEffect(null, testKeyframes);

    assert_equals(testKeyframes[0].propAccessCount, 0, 'Accessor not called');
  }, `non-animatable property '${prop}' is not accessed when using`
     + ' a keyframe sequence');
}

// Test equivalent forms of property-indexed and sequenced keyframe syntax

function assertEquivalentKeyframeSyntax(keyframesA, keyframesB) {
  const processedKeyframesA =
    new KeyframeEffect(null, keyframesA).getKeyframes();
  const processedKeyframesB =
    new KeyframeEffect(null, keyframesB).getKeyframes();
  assert_frame_lists_equal(processedKeyframesA, processedKeyframesB);
}

const gEquivalentSyntaxTests = [
  {
    description: 'two properties with one value',
    indexedKeyframes: {
      left: '100px',
      opacity: ['1'],
    },
    sequencedKeyframes: [
      { left: '100px', opacity: '1' },
    ],
  },
  {
    description: 'two properties with three values',
    indexedKeyframes: {
      left: ['10px', '100px', '150px'],
      opacity: ['1', '0', '1'],
    },
    sequencedKeyframes: [
      { left: '10px', opacity: '1' },
      { left: '100px', opacity: '0' },
      { left: '150px', opacity: '1' },
    ],
  },
  {
    description: 'two properties with different numbers of values',
    indexedKeyframes: {
      left: ['0px', '100px', '200px'],
      opacity: ['0', '1']
    },
    sequencedKeyframes: [
      { left: '0px', opacity: '0' },
      { left: '100px' },
      { left: '200px', opacity: '1' },
    ],
  },
  {
    description: 'same easing applied to all keyframes',
    indexedKeyframes: {
      left: ['10px', '100px', '150px'],
      opacity: ['1', '0', '1'],
      easing: 'ease',
    },
    sequencedKeyframes: [
      { left: '10px', opacity: '1', easing: 'ease' },
      { left: '100px', opacity: '0', easing: 'ease' },
      { left: '150px', opacity: '1', easing: 'ease' },
    ],
  },
  {
    description: 'same composite applied to all keyframes',
    indexedKeyframes: {
      left: ['0px', '100px'],
      composite: 'add',
    },
    sequencedKeyframes: [
      { left: '0px', composite: 'add' },
      { left: '100px', composite: 'add' },
    ],
  },
];

for (const {description, indexedKeyframes, sequencedKeyframes} of
     gEquivalentSyntaxTests) {
  test(() => {
    assertEquivalentKeyframeSyntax(indexedKeyframes, sequencedKeyframes);
  }, `Equivalent property-indexed and sequenced keyframes: ${description}`);
}

// Test handling of custom iterable objects.

function createIterable(iterations) {
  return {
    [Symbol.iterator]() {
      let i = 0;
      return {
        next() {
          return iterations[i++];
        },
      };
    },
  };
}

test(() => {
  const effect = new KeyframeEffect(null, createIterable([
    { done: false, value: { left: '100px' } },
    { done: false, value: { left: '300px' } },
    { done: false, value: { left: '200px' } },
    { done: true },
  ]));
  assert_frame_lists_equal(effect.getKeyframes(), [
    {
      offset: null,
      computedOffset: 0,
      easing: 'linear',
      left: '100px',
      composite: 'auto',
    },
    {
      offset: null,
      computedOffset: 0.5,
      easing: 'linear',
      left: '300px',
      composite: 'auto',
    },
    {
      offset: null,
      computedOffset: 1,
      easing: 'linear',
      left: '200px',
      composite: 'auto',
    },
  ]);
}, 'Keyframes are read from a custom iterator');

test(() => {
  const keyframes = createIterable([
    { done: false, value: { left: '100px' } },
    { done: false, value: { left: '300px' } },
    { done: false, value: { left: '200px' } },
    { done: true },
  ]);
  keyframes.easing = 'ease-in-out';
  keyframes.offset = '0.1';
  const effect = new KeyframeEffect(null, keyframes);
  assert_frame_lists_equal(effect.getKeyframes(), [
    {
      offset: null,
      computedOffset: 0,
      easing: 'linear',
      left: '100px',
      composite: 'auto',
    },
    {
      offset: null,
      computedOffset: 0.5,
      easing: 'linear',
      left: '300px',
      composite: 'auto',
    },
    {
      offset: null,
      computedOffset: 1,
      easing: 'linear',
      left: '200px',
      composite: 'auto',
    },
  ]);
}, '\'easing\' and \'offset\' are ignored on iterable objects');

test(() => {
  const effect = new KeyframeEffect(null, createIterable([
    { done: false, value: { left: '100px', top: '200px' } },
    { done: false, value: { left: '300px' } },
    { done: false, value: { left: '200px', top: '100px' } },
    { done: true },
  ]));
  assert_frame_lists_equal(effect.getKeyframes(), [
    {
      offset: null,
      computedOffset: 0,
      easing: 'linear',
      left: '100px',
      top: '200px',
      composite: 'auto',
    },
    {
      offset: null,
      computedOffset: 0.5,
      easing: 'linear',
      left: '300px',
      composite: 'auto',
    },
    {
      offset: null,
      computedOffset: 1,
      easing: 'linear',
      left: '200px',
      top: '100px',
      composite: 'auto',
    },
  ]);
}, 'Keyframes are read from a custom iterator with multiple properties'
   + ' specified');

test(() => {
  const effect = new KeyframeEffect(null, createIterable([
    { done: false, value: { left: '100px' } },
    { done: false, value: { left: '250px', offset: 0.75 } },
    { done: false, value: { left: '200px' } },
    { done: true },
  ]));
  assert_frame_lists_equal(effect.getKeyframes(), [
    {
      offset: null,
      computedOffset: 0,
      easing: 'linear',
      left: '100px',
      composite: 'auto',
    },
    {
      offset: 0.75,
      computedOffset: 0.75,
      easing: 'linear',
      left: '250px',
      composite: 'auto',
    },
    {
      offset: null,
      computedOffset: 1,
      easing: 'linear',
      left: '200px',
      composite: 'auto',
    },
  ]);
}, 'Keyframes are read from a custom iterator with where an offset is'
   + ' specified');

test(() => {
  const test_error = { name: 'test' };
  const bad_keyframe = { get left() { throw test_error; } };
  assert_throws_exactly(test_error, () => {
    new KeyframeEffect(null, createIterable([
      { done: false, value: { left: '100px' } },
      { done: false, value: bad_keyframe },
      { done: false, value: { left: '200px' } },
      { done: true },
    ]));
  });
}, 'If a keyframe throws for an animatable property, that exception should be'
    + ' propagated');

test(() => {
  assert_throws_js(TypeError, () => {
    new KeyframeEffect(null, createIterable([
      { done: false, value: { left: '100px' } },
      { done: false, value: 1234 },
      { done: false, value: { left: '200px' } },
      { done: true },
    ]));
  });
}, 'Reading from a custom iterator that returns a non-object keyframe'
   + ' should throw');

test(() => {
  assert_throws_js(TypeError, () => {
    new KeyframeEffect(null, createIterable([
      { done: false, value: { left: '100px', easing: '' } },
      { done: false, value: 1234 },
      { done: false, value: { left: '200px' } },
      { done: true },
    ]));
  });
}, 'Reading from a custom iterator that returns a non-object keyframe'
   + ' and an invalid easing should throw');

test(() => {
  assert_throws_js(TypeError, () => {
    new KeyframeEffect(null, createIterable([
      { done: false, value: { left: '100px' } },
      { done: false, value: { left: '150px', offset: 'o' } },
      { done: false, value: { left: '200px' } },
      { done: true },
    ]));
  });
}, 'Reading from a custom iterator that returns a keyframe with a non finite'
   + ' floating-point offset value should throw');

test(() => {
  assert_throws_js(TypeError, () => {
    new KeyframeEffect(null, createIterable([
      { done: false, value: { left: '100px', easing: '' } },
      { done: false, value: { left: '150px', offset: 'o' } },
      { done: false, value: { left: '200px' } },
      { done: true },
    ]));
  });
}, 'Reading from a custom iterator that returns a keyframe with a non finite'
   + ' floating-point offset value and an invalid easing should throw');

test(() => {
  const effect = new KeyframeEffect(null, createIterable([
    { done: false, value: { left: '100px' } },
    { done: false },  // No value member; keyframe is undefined.
    { done: false, value: { left: '200px' } },
    { done: true },
  ]));
  assert_frame_lists_equal(effect.getKeyframes(), [
    { left: '100px', offset: null, computedOffset: 0, easing: 'linear', composite: 'auto' },
    { offset: null, computedOffset: 0.5, easing: 'linear', composite: 'auto' },
    { left: '200px', offset: null, computedOffset: 1, easing: 'linear', composite: 'auto' },
  ]);
}, 'An undefined keyframe returned from a custom iterator should be treated as a'
    + ' default keyframe');

test(() => {
  const effect = new KeyframeEffect(null, createIterable([
    { done: false, value: { left: '100px' } },
    { done: false, value: null },
    { done: false, value: { left: '200px' } },
    { done: true },
  ]));
  assert_frame_lists_equal(effect.getKeyframes(), [
    { left: '100px', offset: null, computedOffset: 0, easing: 'linear', composite: 'auto' },
    { offset: null, computedOffset: 0.5, easing: 'linear', composite: 'auto' },
    { left: '200px', offset: null, computedOffset: 1, easing: 'linear', composite: 'auto' },
  ]);
}, 'A null keyframe returned from a custom iterator should be treated as a'
    + ' default keyframe');

test(() => {
  const effect = new KeyframeEffect(null, createIterable([
    { done: false, value: { left: ['100px', '200px'] } },
    { done: true },
  ]));
  assert_frame_lists_equal(effect.getKeyframes(), [
    { offset: null, computedOffset: 1, easing: 'linear', composite: 'auto' }
  ]);
}, 'A list of values returned from a custom iterator should be ignored');

test(() => {
  const test_error = { name: 'test' };
  const keyframe_obj = {
    [Symbol.iterator]() {
      return { next() { throw test_error; } };
    },
  };
  assert_throws_exactly(test_error, () => {
    new KeyframeEffect(null, keyframe_obj);
  });
}, 'If a custom iterator throws from next(), the exception should be rethrown');

// Test handling of invalid Symbol.iterator

test(() => {
  const test_error = { name: 'test' };
  const keyframe_obj = {
    [Symbol.iterator]() {
      throw test_error;
    },
  };
  assert_throws_exactly(test_error, () => {
    new KeyframeEffect(null, keyframe_obj);
  });
}, 'Accessing a Symbol.iterator property that throws should rethrow');

test(() => {
  const keyframe_obj = {
    [Symbol.iterator]() {
      return 42;  // Not an object.
    },
  };
  assert_throws_js(TypeError, () => {
    new KeyframeEffect(null, keyframe_obj);
  });
}, 'A non-object returned from the Symbol.iterator property should cause a'
    + ' TypeError to be thrown');

test(() => {
  const keyframe = {};
  Object.defineProperty(keyframe, 'width', { value: '200px' });
  Object.defineProperty(keyframe, 'height', {
    value: '100px',
    enumerable: true,
  });
  assert_equals(keyframe.width, '200px', 'width of keyframe is readable');
  assert_equals(keyframe.height, '100px', 'height of keyframe is readable');

  const effect = new KeyframeEffect(null, [keyframe, { height: '200px' }]);

  assert_frame_lists_equal(effect.getKeyframes(), [
    {
      offset: null,
      computedOffset: 0,
      easing: 'linear',
      height: '100px',
      composite: 'auto',
    },
    {
      offset: null,
      computedOffset: 1,
      easing: 'linear',
      height: '200px',
      composite: 'auto',
    },
  ]);
}, 'Only enumerable properties on keyframes are read');

test(() => {
  const KeyframeParent = function() { this.width = '100px'; };
  KeyframeParent.prototype = { height: '100px' };
  const Keyframe = function() { this.top = '100px'; };
  Keyframe.prototype = Object.create(KeyframeParent.prototype);
  Object.defineProperty(Keyframe.prototype, 'left', {
    value: '100px',
    enumerable: true,
  });
  const keyframe = new Keyframe();

  const effect = new KeyframeEffect(null, [keyframe, { top: '200px' }]);

  assert_frame_lists_equal(effect.getKeyframes(), [
    {
      offset: null,
      computedOffset: 0,
      easing: 'linear',
      top: '100px',
      composite: 'auto',
    },
    {
      offset: null,
      computedOffset: 1,
      easing: 'linear',
      top: '200px',
      composite: 'auto',
    },
  ]);
}, 'Only properties defined directly on keyframes are read');

test(() => {
  const keyframes = {};
  Object.defineProperty(keyframes, 'width', ['100px', '200px']);
  Object.defineProperty(keyframes, 'height', {
    value: ['100px', '200px'],
    enumerable: true,
  });

  const effect = new KeyframeEffect(null, keyframes);

  assert_frame_lists_equal(effect.getKeyframes(), [
    {
      offset: null,
      computedOffset: 0,
      easing: 'linear',
      height: '100px',
      composite: 'auto',
    },
    {
      offset: null,
      computedOffset: 1,
      easing: 'linear',
      height: '200px',
      composite: 'auto',
    },
  ]);
}, 'Only enumerable properties on property-indexed keyframes are read');

test(() => {
  const KeyframesParent = function() { this.width = '100px'; };
  KeyframesParent.prototype = { height: '100px' };
  const Keyframes = function() { this.top = ['100px', '200px']; };
  Keyframes.prototype = Object.create(KeyframesParent.prototype);
  Object.defineProperty(Keyframes.prototype, 'left', {
    value: ['100px', '200px'],
    enumerable: true,
  });
  const keyframes = new Keyframes();

  const effect = new KeyframeEffect(null, keyframes);

  assert_frame_lists_equal(effect.getKeyframes(), [
    {
      offset: null,
      computedOffset: 0,
      easing: 'linear',
      top: '100px',
      composite: 'auto',
    },
    {
      offset: null,
      computedOffset: 1,
      easing: 'linear',
      top: '200px',
      composite: 'auto',
    },
  ]);
}, 'Only properties defined directly on property-indexed keyframes are read');

test(() => {
  const expectedOrder = ['composite', 'easing', 'offset', 'left', 'marginLeft'];
  const actualOrder = [];
  const kf1 = {};
  for (const {prop, value} of [{ prop: 'marginLeft', value: '10px' },
                               { prop: 'left',       value: '20px' },
                               { prop: 'offset',     value: '0' },
                               { prop: 'easing',     value: 'linear' },
                               { prop: 'composite',  value: 'replace' }]) {
    Object.defineProperty(kf1, prop, {
      enumerable: true,
      get: () => { actualOrder.push(prop); return value; }
    });
  }
  const kf2 = { marginLeft: '10px', left: '20px', offset: 1 };

  new KeyframeEffect(target, [kf1, kf2]);

  assert_array_equals(actualOrder, expectedOrder, 'property access order');
}, 'Properties are read in ascending order by Unicode codepoint');

</script>