summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/web-animations/interfaces/Animation/commitStyles.html
blob: 9a7dbea8b8649bb4580e60fef1e1530a84f2b13f (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
<!doctype html>
<meta charset=utf-8>
<title>Animation.commitStyles</title>
<link rel="help" href="https://drafts.csswg.org/web-animations/#dom-animation-commitstyles">
<script src="/resources/testharness.js"></script>
<script src="/resources/testharnessreport.js"></script>
<script src="../../testcommon.js"></script>
<style>
.pseudo::before {content: '';}
.pseudo::after {content: '';}
.pseudo::marker {content: '';}
</style>
<body>
<div id="log"></div>
<script>
'use strict';

function assert_numeric_style_equals(opacity, expected, description) {
  return assert_approx_equals(
    parseFloat(opacity),
    expected,
    0.0001,
    description
  );
}

test(t => {
  const div = createDiv(t);
  div.style.opacity = '0.1';

  const animation = div.animate(
    { opacity: 0.2 },
    { duration: 1, fill: 'forwards' }
  );
  animation.finish();

  animation.commitStyles();

  // Cancel the animation so we can inspect the underlying style
  animation.cancel();

  assert_numeric_style_equals(getComputedStyle(div).opacity, 0.2);
}, 'Commits styles');

test(t => {
  const div = createDiv(t);
  div.style.translate = '100px';
  div.style.rotate = '45deg';
  div.style.scale = '2';

  const animation = div.animate(
    { translate: '200px',
      rotate: '90deg',
      scale: 3 },
    { duration: 1, fill: 'forwards' }
  );
  animation.finish();

  animation.commitStyles();

  // Cancel the animation so we can inspect the underlying style
  animation.cancel();

  assert_equals(getComputedStyle(div).translate, '200px');
  assert_equals(getComputedStyle(div).rotate, '90deg');
  assert_numeric_style_equals(getComputedStyle(div).scale, 3);
}, 'Commits styles for individual transform properties');

promise_test(async t => {
  const div = createDiv(t);
  div.style.opacity = '0.1';

  const animA = div.animate(
    { opacity: 0.2 },
    { duration: 1, fill: 'forwards' }
  );
  const animB = div.animate(
    { opacity: 0.3 },
    { duration: 1, fill: 'forwards' }
  );

  await animA.finished;

  animB.cancel();

  animA.commitStyles();

  assert_numeric_style_equals(getComputedStyle(div).opacity, 0.2);
}, 'Commits styles for an animation that has been removed');

test(t => {
  const div = createDiv(t);
  div.style.margin = '10px';

  const animation = div.animate(
    { margin: '20px' },
    { duration: 1, fill: 'forwards' }
  );
  animation.finish();

  animation.commitStyles();

  animation.cancel();

  assert_equals(div.style.marginLeft, '20px');
}, 'Commits shorthand styles');

test(t => {
  const div = createDiv(t);
  div.style.marginLeft = '10px';

  const animation = div.animate(
    { marginInlineStart: '20px' },
    { duration: 1, fill: 'forwards' }
  );
  animation.finish();

  animation.commitStyles();

  animation.cancel();

  assert_equals(getComputedStyle(div).marginLeft, '20px');
}, 'Commits logical properties');

test(t => {
  const div = createDiv(t);
  div.style.marginLeft = '10px';

  const animation = div.animate(
    { marginInlineStart: '20px' },
    { duration: 1, fill: 'forwards' }
  );
  animation.finish();

  animation.commitStyles();

  animation.cancel();

  assert_equals(div.style.marginLeft, '20px');
}, 'Commits logical properties as physical properties');

test(t => {
  const div = createDiv(t);
  div.style.marginLeft = '10px';

  const animation = div.animate({ opacity: [0.2, 0.7] }, 1000);
  animation.currentTime = 500;
  animation.commitStyles();
  animation.cancel();

  assert_numeric_style_equals(getComputedStyle(div).opacity, 0.45);
}, 'Commits values calculated mid-interval');

test(t => {
  const div = createDiv(t);
  div.style.setProperty('--target', '0.5');

  const animation = div.animate(
    { opacity: 'var(--target)' },
    { duration: 1, fill: 'forwards' }
  );
  animation.finish();
  animation.commitStyles();
  animation.cancel();

  assert_numeric_style_equals(getComputedStyle(div).opacity, 0.5);

  // Changes to the variable should have no effect
  div.style.setProperty('--target', '1');

  assert_numeric_style_equals(getComputedStyle(div).opacity, 0.5);
}, 'Commits variable references as their computed values');


test(t => {
  const div = createDiv(t);
  div.style.setProperty('--target', '0.5');
  div.style.opacity = 'var(--target)';
  const animation = div.animate(
    { '--target': 0.8 },
    { duration: 1, fill: 'forwards' }
  );
  animation.finish();
  animation.commitStyles();
  animation.cancel();

  assert_numeric_style_equals(getComputedStyle(div).opacity, 0.8);
}, 'Commits custom variables');

test(t => {
  const div = createDiv(t);
  div.style.fontSize = '10px';

  const animation = div.animate(
    { width: '10em' },
    { duration: 1, fill: 'forwards' }
  );
  animation.finish();
  animation.commitStyles();
  animation.cancel();

  assert_numeric_style_equals(getComputedStyle(div).width, 100);

  div.style.fontSize = '20px';
  assert_numeric_style_equals(getComputedStyle(div).width, 100,
      "Changes to the font-size should have no effect");
}, 'Commits em units as pixel values');

test(t => {
  const div = createDiv(t);
  div.style.fontSize = '10px';

  const animation = div.animate(
    { lineHeight: '1.5' },
    { duration: 1, fill: 'forwards' }
  );
  animation.finish();
  animation.commitStyles();
  animation.cancel();

  assert_numeric_style_equals(getComputedStyle(div).lineHeight, 15);
  assert_equals(div.style.lineHeight, "1.5", "line-height is committed as a relative value");

  div.style.fontSize = '20px';
  assert_numeric_style_equals(getComputedStyle(div).lineHeight, 30,
      "Changes to the font-size should affect the committed line-height");

}, 'Commits relative line-height');

test(t => {
  const div = createDiv(t);
  const animation = div.animate(
    { transform: 'translate(20px, 20px)' },
    { duration: 1, fill: 'forwards' }
  );
  animation.finish();
  animation.commitStyles();
  animation.cancel();
  assert_equals(getComputedStyle(div).transform, 'matrix(1, 0, 0, 1, 20, 20)');
}, 'Commits transforms');

test(t => {
  const div = createDiv(t);
  const animation = div.animate(
    { transform: 'translate(20px, 20px)' },
    { duration: 1, fill: 'forwards' }
  );
  animation.finish();
  animation.commitStyles();
  animation.cancel();
  assert_equals(div.style.transform, 'translate(20px, 20px)');
}, 'Commits transforms as a transform list');

test(t => {
  const div = createDiv(t);
  div.style.width = '200px';
  div.style.height = '200px';

  const animation = div.animate({ transform: ["translate(100%, 0%)", "scale(3)"] }, 1000);
  animation.currentTime = 500;
  animation.commitStyles();
  animation.cancel();

  // TODO(https://github.com/w3c/csswg-drafts/issues/2854):
  // We can't check the committed value directly since it is not specced yet in this case,
  // but it should still produce the correct resolved value.
  assert_equals(getComputedStyle(div).transform, "matrix(2, 0, 0, 2, 100, 0)",
      "Resolved transform is correct after commit.");
}, 'Commits matrix-interpolated relative transforms');

test(t => {
  const div = createDiv(t);
  div.style.width = '200px';
  div.style.height = '200px';

  const animation = div.animate({ transform: ["none", "none"] }, 1000);
  animation.currentTime = 500;
  animation.commitStyles();
  animation.cancel();

  assert_equals(div.style.transform, "none",
      "Resolved transform is correct after commit.");
}, 'Commits "none" transform');

promise_test(async t => {
  const div = createDiv(t);
  div.style.opacity = '0.1';

  const animA = div.animate(
    { opacity: '0.2' },
    { duration: 1, fill: 'forwards' }
  );
  const animB = div.animate(
    { opacity: '0.2', composite: 'add' },
    { duration: 1, fill: 'forwards' }
  );
  const animC = div.animate(
    { opacity: '0.3', composite: 'add' },
    { duration: 1, fill: 'forwards' }
  );

  animA.persist();
  animB.persist();

  await animB.finished;

  // The values above have been chosen such that various error conditions
  // produce results that all differ from the desired result:
  //
  //  Expected result:
  //
  //    animA + animB = 0.4
  //
  //  Likely error results:
  //
  //    <underlying> = 0.1
  //    (Commit didn't work at all)
  //
  //    animB = 0.2
  //    (Didn't add at all when resolving)
  //
  //    <underlying> + animB = 0.3
  //    (Added to the underlying value instead of lower-priority animations when
  //    resolving)
  //
  //    <underlying> + animA + animB = 0.5
  //    (Didn't respect the composite mode of lower-priority animations)
  //
  //    animA + animB + animC = 0.7
  //    (Resolved the whole stack, not just up to the target effect)
  //

  animB.commitStyles();

  animA.cancel();
  animB.cancel();
  animC.cancel();

  assert_numeric_style_equals(getComputedStyle(div).opacity, 0.4);
}, 'Commits the intermediate value of an animation in the middle of stack');

promise_test(async t => {
  const div = createDiv(t);
  div.style.opacity = '0.1';

  const animA = div.animate(
    { opacity: '0.2', composite: 'add' },
    { duration: 1, fill: 'forwards' }
  );
  const animB = div.animate(
    { opacity: '0.2', composite: 'add' },
    { duration: 1, fill: 'forwards' }
  );
  const animC = div.animate(
    { opacity: '0.3', composite: 'add' },
    { duration: 1, fill: 'forwards' }
  );

  animA.persist();
  animB.persist();
  await animB.finished;

  // The error cases are similar to the above test with one additional case;
  // verifying that the animations composite on top of the correct underlying
  // base style.
  //
  //  Expected result:
  //
  //  <underlying> + animA + animB = 0.5
  //
  //  Additional error results:
  //
  //    <underlying> + animA + animB + animC + animA + animB = 1.0 (saturates)
  //    (Added to the computed value instead of underlying value when
  //    resolving)
  //
  //    animA + animB = 0.4
  //    Failed to composite on top of underlying value.
  //

  animB.commitStyles();

  animA.cancel();
  animB.cancel();
  animC.cancel();

  assert_numeric_style_equals(getComputedStyle(div).opacity, 0.5);
}, 'Commit composites on top of the underlying value');

promise_test(async t => {
  const div = createDiv(t);
  div.style.opacity = '0.1';

  // Setup animation
  const animation = div.animate(
    { opacity: 0.2 },
    { duration: 1, fill: 'forwards' }
  );
  animation.finish();

  // Setup observer
  const mutationRecords = [];
  const observer = new MutationObserver(mutations => {
    mutationRecords.push(...mutations);
  });
  observer.observe(div, { attributes: true, attributeOldValue: true });

  animation.commitStyles();

  // Wait for mutation records to be dispatched
  await Promise.resolve();

  assert_equals(mutationRecords.length, 1, 'Should have one mutation record');

  const mutation = mutationRecords[0];
  assert_equals(mutation.type, 'attributes');
  assert_equals(mutation.oldValue, 'opacity: 0.1;');

  observer.disconnect();
}, 'Triggers mutation observers when updating style');

promise_test(async t => {
  const div = createDiv(t);
  div.style.opacity = '0.2';

  // Setup animation
  const animation = div.animate(
    { opacity: 0.2 },
    { duration: 1, fill: 'forwards' }
  );
  animation.finish();

  // Setup observer
  const mutationRecords = [];
  const observer = new MutationObserver(mutations => {
    mutationRecords.push(...mutations);
  });
  observer.observe(div, { attributes: true });

  animation.commitStyles();

  // Wait for mutation records to be dispatched
  await Promise.resolve();

  assert_equals(mutationRecords.length, 0, 'Should have no mutation records');

  observer.disconnect();
}, 'Does NOT trigger mutation observers when the change to style is redundant');

test(t => {

  const div = createDiv(t);
  div.classList.add('pseudo');
  const animation = div.animate(
    { opacity: 0 },
    { duration: 1, fill: 'forwards', pseudoElement: '::before' }
  );

  assert_throws_dom('NoModificationAllowedError', () => {
    animation.commitStyles();
  });
}, 'Throws if the target element is a pseudo element');

test(t => {
  const animation = createDiv(t).animate(
    { opacity: 0 },
    { duration: 1, fill: 'forwards' }
  );

  const nonStyleElement
    = document.createElementNS('http://example.org/test', 'test');
  document.body.appendChild(nonStyleElement);
  animation.effect.target = nonStyleElement;

  assert_throws_dom('NoModificationAllowedError', () => {
    animation.commitStyles();
  });

  nonStyleElement.remove();
}, 'Throws if the target element is not something with a style attribute');

test(t => {
  const div = createDiv(t);
  const animation = div.animate(
    { opacity: 0 },
    { duration: 1, fill: 'forwards' }
  );

  div.style.display = 'none';

  assert_throws_dom('InvalidStateError', () => {
    animation.commitStyles();
  });
}, 'Throws if the target effect is display:none');

test(t => {
  const container = createDiv(t);
  const div = createDiv(t);
  container.append(div);

  const animation = div.animate(
    { opacity: 0 },
    { duration: 1, fill: 'forwards' }
  );

  container.style.display = 'none';

  assert_throws_dom('InvalidStateError', () => {
    animation.commitStyles();
  });
}, "Throws if the target effect's ancestor is display:none");

test(t => {
  const container = createDiv(t);
  const div = createDiv(t);
  container.append(div);

  const animation = div.animate(
    { opacity: 0 },
    { duration: 1, fill: 'forwards' }
  );

  container.style.display = 'contents';

  // Should NOT throw
  animation.commitStyles();
}, 'Treats display:contents as rendered');

test(t => {
  const container = createDiv(t);
  const div = createDiv(t);
  container.append(div);

  const animation = div.animate(
    { opacity: 0 },
    { duration: 1, fill: 'forwards' }
  );

  div.style.display = 'contents';
  container.style.display = 'none';

  assert_throws_dom('InvalidStateError', () => {
    animation.commitStyles();
  });
}, 'Treats display:contents in a display:none subtree as not rendered');

test(t => {
  const div = createDiv(t);
  const animation = div.animate(
    { opacity: 0 },
    { duration: 1, fill: 'forwards' }
  );

  div.remove();

  assert_throws_dom('InvalidStateError', () => {
    animation.commitStyles();
  });
}, 'Throws if the target effect is disconnected');

test(t => {
  const div = createDiv(t);
  div.classList.add('pseudo');
  const animation = div.animate(
    { opacity: 0 },
    { duration: 1, fill: 'forwards', pseudoElement: '::before' }
  );

  div.remove();

  assert_throws_dom('NoModificationAllowedError', () => {
    animation.commitStyles();
  });
}, 'Checks the pseudo element condition before the not rendered condition');

</script>
</body>