Update TrackEvent to stop using legacy [ConstructorTemplate=Event]

https://bugs.webkit.org/show_bug.cgi?id=163580

Reviewed by Sam Weinig.

LayoutTests/imported/w3c:

Incorporate web-platform-tests/wpt#3999 as the
test was incorrect. Rebaseline now that we are passing the test.

* web-platform-tests/html/semantics/embedded-content/media-elements/interfaces/TrackEvent/constructor-expected.txt:
* web-platform-tests/html/semantics/embedded-content/media-elements/interfaces/TrackEvent/constructor.html:

Source/WebCore:

Update TrackEvent to stop using legacy [ConstructorTemplate=Event]
and use a regular constructor as in the specification:
- https://html.spec.whatwg.org/#the-trackevent-interface

No new tests, updated existing tests.

* html/track/TrackEvent.cpp:
(WebCore::TrackEvent::TrackEvent):
* html/track/TrackEvent.h:
* html/track/TrackEvent.idl:

LayoutTests:

Update existing test to reflect behavior change. We now correctly throw a TypeError
when passing an unexpected track object type to the TrackEvent constructor.

* fast/events/constructors/track-event-constructor-expected.txt:
* fast/events/constructors/track-event-constructor.html:


Canonical link: https://commits.webkit.org/181381@main
git-svn-id: https://svn.webkit.org/repository/webkit/trunk@207468 268f45cc-cd09-0410-ab3c-d52691b4dbfc

LayoutTests/ChangeLog

@@ -1,3 +1,16 @@
+2016-10-18  Chris Dumez  <cdumez@apple.com>
+
+        Update TrackEvent to stop using legacy [ConstructorTemplate=Event]
+        https://bugs.webkit.org/show_bug.cgi?id=163580
+
+        Reviewed by Sam Weinig.
+
+        Update existing test to reflect behavior change. We now correctly throw a TypeError
+        when passing an unexpected track object type to the TrackEvent constructor.
+
+        * fast/events/constructors/track-event-constructor-expected.txt:
+        * fast/events/constructors/track-event-constructor.html:
+
 2016-10-18  Nael Ouedraogo  <nael.ouedraogo@crf.canon.fr>
 
         Rebase test in fast/mediastream

LayoutTests/fast/events/constructors/track-event-constructor-expected.txt

@@ -14,20 +14,16 @@ PASS new TrackEvent('TrackEvent', { bubbles: true, cancelable: true }).bubbles i
 PASS new TrackEvent('TrackEvent', { bubbles: true, cancelable: true }).cancelable is true
 PASS new TrackEvent('TrackEvent', { bubbles: true, cancelable: true }).track is null
 
-*** Bubbles and cancelable true, invalid track ***
-PASS new TrackEvent('TrackEvent', { bubbles: true, cancelable: true, track: HTMLTrackElement }).bubbles is true
-PASS new TrackEvent('TrackEvent', { bubbles: true, cancelable: true, track: HTMLTrackElement }).cancelable is true
-PASS new TrackEvent('TrackEvent', { bubbles: true, cancelable: true, track: HTMLTrackElement }).track is null
-
-*** Initialize 'track' with a invalid values ***
-PASS new TrackEvent('TrackEvent', { track: 10 }).track is null
-PASS new TrackEvent('TrackEvent', { track: 'string' }).track is null
-PASS new TrackEvent('TrackEvent', { track: emptyObject }).track is null
-PASS new TrackEvent('TrackEvent', { track: document }).track is null
+*** Invalid track ***
+PASS new TrackEvent('TrackEvent', { track: HTMLTrackElement }) threw exception TypeError: Type error.
+PASS new TrackEvent('TrackEvent', { track: 10 }) threw exception TypeError: Type error.
+PASS new TrackEvent('TrackEvent', { track: 'string' }) threw exception TypeError: Type error.
+PASS new TrackEvent('TrackEvent', { track: emptyObject }) threw exception TypeError: Type error.
+PASS new TrackEvent('TrackEvent', { track: document }) threw exception TypeError: Type error.
 
 *** Bubbles and cancelable true, valid track ***
-PASS new TrackEvent('TrackEvent', { bubbles: true, cancelable: true, track: HTMLTrackElement }).bubbles is true
-PASS new TrackEvent('TrackEvent', { bubbles: true, cancelable: true, track: HTMLTrackElement }).cancelable is true
+PASS new TrackEvent('TrackEvent', { bubbles: true, cancelable: true, track: trackElement.track }).bubbles is true
+PASS new TrackEvent('TrackEvent', { bubbles: true, cancelable: true, track: trackElement.track }).cancelable is true
 PASS new TrackEvent('TrackEvent', { track: trackElement.track }).track is trackElement.track
 
 *** Initialize 'track' with valid track object ***

LayoutTests/fast/events/constructors/track-event-constructor.html

@@ -26,21 +26,17 @@
             shouldBe("new TrackEvent('TrackEvent', { bubbles: true, cancelable: true }).cancelable", "true");
             shouldBeNull("new TrackEvent('TrackEvent', { bubbles: true, cancelable: true }).track");
 
-            debug("<br>*** Bubbles and cancelable true, invalid track ***");
-            shouldBe("new TrackEvent('TrackEvent', { bubbles: true, cancelable: true, track: HTMLTrackElement }).bubbles", "true");
-            shouldBe("new TrackEvent('TrackEvent', { bubbles: true, cancelable: true, track: HTMLTrackElement }).cancelable", "true");
-            shouldBeNull("new TrackEvent('TrackEvent', { bubbles: true, cancelable: true, track: HTMLTrackElement }).track");
-
-            debug("<br>*** Initialize 'track' with a invalid values ***");
-            shouldBeNull("new TrackEvent('TrackEvent', { track: 10 }).track");
-            shouldBeNull("new TrackEvent('TrackEvent', { track: \'string\' }).track");
+            debug("<br>*** Invalid track ***");
+            shouldThrowErrorName("new TrackEvent('TrackEvent', { track: HTMLTrackElement })", "TypeError");
+            shouldThrowErrorName("new TrackEvent('TrackEvent', { track: 10 })", "TypeError");
+            shouldThrowErrorName("new TrackEvent('TrackEvent', { track: \'string\' })", "TypeError");
             emptyObject = { };
-            shouldBeNull("new TrackEvent('TrackEvent', { track: emptyObject }).track");
-            shouldBeNull("new TrackEvent('TrackEvent', { track: document }).track");
+            shouldThrowErrorName("new TrackEvent('TrackEvent', { track: emptyObject })", "TypeError");
+            shouldThrowErrorName("new TrackEvent('TrackEvent', { track: document })", "TypeError");
 
             debug("<br>*** Bubbles and cancelable true, valid track ***");
-            shouldBe("new TrackEvent('TrackEvent', { bubbles: true, cancelable: true, track: HTMLTrackElement }).bubbles", "true");
-            shouldBe("new TrackEvent('TrackEvent', { bubbles: true, cancelable: true, track: HTMLTrackElement }).cancelable", "true");
+            shouldBe("new TrackEvent('TrackEvent', { bubbles: true, cancelable: true, track: trackElement.track }).bubbles", "true");
+            shouldBe("new TrackEvent('TrackEvent', { bubbles: true, cancelable: true, track: trackElement.track }).cancelable", "true");
             shouldBe("new TrackEvent('TrackEvent', { track: trackElement.track }).track", "trackElement.track");
 
             debug("<br>*** Initialize 'track' with valid track object ***");

LayoutTests/imported/w3c/ChangeLog

@@ -1,3 +1,16 @@
+2016-10-18  Chris Dumez  <cdumez@apple.com>
+
+        Update TrackEvent to stop using legacy [ConstructorTemplate=Event]
+        https://bugs.webkit.org/show_bug.cgi?id=163580
+
+        Reviewed by Sam Weinig.
+
+        Incorporate https://github.com/w3c/web-platform-tests/pull/3999 as the
+        test was incorrect. Rebaseline now that we are passing the test.
+
+        * web-platform-tests/html/semantics/embedded-content/media-elements/interfaces/TrackEvent/constructor-expected.txt:
+        * web-platform-tests/html/semantics/embedded-content/media-elements/interfaces/TrackEvent/constructor.html:
+
 2016-10-15  Chris Dumez  <cdumez@apple.com>
 
         Add support for reportValidity() on form and form control elements

LayoutTests/imported/w3c/web-platform-tests/html/semantics/embedded-content/media-elements/interfaces/TrackEvent/constructor-expected.txt

@@ -1,4 +1,4 @@
 
 PASS TrackEvent constructor, one arg 
-FAIL TrackEvent constructor, two args assert_equals: ev.track expected object "[object Object]" but got null
+PASS TrackEvent constructor, two args 
 

LayoutTests/imported/w3c/web-platform-tests/html/semantics/embedded-content/media-elements/interfaces/TrackEvent/constructor.html

@@ -13,12 +13,13 @@
     assert_equals(ev.track, null, 'ev.track after assignment');
 }, document.title+', one arg');
 test(function(){
-    var obj = {};
-    var ev = new TrackEvent('foo', {track:obj});
+    var video = document.createElement('video');
+    var testTrack = video.addTextTrack('subtitles', 'foo', 'foo');
+    var ev = new TrackEvent('foo', {track: testTrack});
     assert_true(ev instanceof TrackEvent, 'ev instanceof TrackEvent');
     assert_true(ev instanceof Event, 'ev instanceof Event');
-    assert_equals(ev.track, obj, 'ev.track');
+    assert_equals(ev.track, testTrack, 'ev.track');
     ev.track = {};
-    assert_equals(ev.track, obj, 'ev.track after assignment');
+    assert_equals(ev.track, testTrack, 'ev.track after assignment');
 }, document.title+', two args');
 </script>

Source/WebCore/ChangeLog

@@ -1,3 +1,21 @@
+2016-10-18  Chris Dumez  <cdumez@apple.com>
+
+        Update TrackEvent to stop using legacy [ConstructorTemplate=Event]
+        https://bugs.webkit.org/show_bug.cgi?id=163580
+
+        Reviewed by Sam Weinig.
+
+        Update TrackEvent to stop using legacy [ConstructorTemplate=Event]
+        and use a regular constructor as in the specification:
+        - https://html.spec.whatwg.org/#the-trackevent-interface
+
+        No new tests, updated existing tests.
+
+        * html/track/TrackEvent.cpp:
+        (WebCore::TrackEvent::TrackEvent):
+        * html/track/TrackEvent.h:
+        * html/track/TrackEvent.idl:
+
 2016-10-18  Commit Queue  <commit-queue@webkit.org>
 
         Unreviewed, rolling out r207409.

Source/WebCore/html/track/TrackEvent.cpp

@@ -39,10 +39,14 @@ TrackEvent::TrackEvent(const AtomicString& type, bool canBubble, bool cancelable
 {
 }
 
-TrackEvent::TrackEvent(const AtomicString& type, const TrackEventInit& initializer)
-    : Event(type, initializer)
-    , m_track(initializer.track)
+TrackEvent::TrackEvent(const AtomicString& type, const Init& initializer, IsTrusted isTrusted)
+    : Event(type, initializer, isTrusted)
 {
+    if (initializer.track) {
+        m_track = std::experimental::visit([](const auto& trackbase) -> TrackBase* {
+            return trackbase.get();
+        }, *initializer.track);
+    }
 }
 
 TrackEvent::~TrackEvent()

Source/WebCore/html/track/TrackEvent.h

@@ -28,15 +28,13 @@
 
 #if ENABLE(VIDEO_TRACK)
 
+#include "AudioTrack.h"
 #include "Event.h"
-#include "TrackBase.h"
+#include "TextTrack.h"
+#include "VideoTrack.h"
 
 namespace WebCore {
 
-struct TrackEventInit : public EventInit {
-    RefPtr<TrackBase> track;
-};
-
 class TrackEvent final : public Event {
 public:
     virtual ~TrackEvent();
@@ -46,9 +44,15 @@ class TrackEvent final : public Event {
         return adoptRef(*new TrackEvent(type, canBubble, cancelable, WTFMove(track)));
     }
 
-    static Ref<TrackEvent> createForBindings(const AtomicString& type, const TrackEventInit& initializer)
+    using TrackEventTrack = std::experimental::variant<RefPtr<VideoTrack>, RefPtr<AudioTrack>, RefPtr<TextTrack>>;
+
+    struct Init : public EventInit {
+        Optional<TrackEventTrack> track;
+    };
+
+    static Ref<TrackEvent> create(const AtomicString& type, const Init& initializer, IsTrusted isTrusted = IsTrusted::No)
     {
-        return adoptRef(*new TrackEvent(type, initializer));
+        return adoptRef(*new TrackEvent(type, initializer, isTrusted));
     }
 
     EventInterface eventInterface() const override;
@@ -57,7 +61,7 @@ class TrackEvent final : public Event {
 
 private:
     TrackEvent(const AtomicString& type, bool canBubble, bool cancelable, Ref<TrackBase>&&);
-    TrackEvent(const AtomicString& type, const TrackEventInit& initializer);
+    TrackEvent(const AtomicString& type, const Init& initializer, IsTrusted);
 
     RefPtr<TrackBase> m_track;
 };

Source/WebCore/html/track/TrackEvent.idl

@@ -25,8 +25,11 @@
 
 [
     Conditional=VIDEO_TRACK,
-    LegacyConstructorTemplate=Event
+    Constructor(DOMString type, optional TrackEventInit eventInitDict)
 ] interface TrackEvent : Event {
-    [LegacyInitializedByEventConstructor, CustomGetter] readonly attribute object track;
+    [CustomGetter] readonly attribute (VideoTrack or AudioTrack or TextTrack)? track;
 };
 
+dictionary TrackEventInit : EventInit {
+    (VideoTrack or AudioTrack or TextTrack)? track = null;
+};