Add the basics of TextTrack #22392

dlrobertson · 2018-12-09T00:38:56Z

Summary

Implement the basics of the TextTrack elements:

TextTrack
TextTrackCue
TextTrackCueList
TextTrackList
./mach build -d does not report any errors
./mach test-tidy does not report any errors
These changes is related to #22311
There are tests for these changes

This change is

highfive · 2018-12-09T00:39:00Z

Heads up! This PR modifies the following files:

@asajeffrey: components/script/dom/webidls/TextTrackCueList.webidl, components/script/dom/htmlmediaelement.rs, components/script/dom/mod.rs, components/script/dom/texttrack.rs, components/script/dom/texttracklist.rs and 6 more
@KiChjang: components/script/dom/webidls/TextTrackCueList.webidl, components/script/dom/htmlmediaelement.rs, components/script/dom/mod.rs, components/script/dom/texttrack.rs, components/script/dom/texttracklist.rs and 6 more

dlrobertson

I can remove the TextTrackCue and TextTrackCueList implementation from this PR and submit it in a follow up if it helps.

dlrobertson · 2018-12-09T00:55:09Z

components/script/dom/htmlmediaelement.rs

+        // Step 3
+        self.text_tracks().add(&track);
+        // Step 4: FIXME We need to queue a event here, but the
+        // addtrack atom does not exist


How can I create addtrack as an Atom?

Modify https://github.com/servo/servo/blob/master/components/atoms/static_atoms.txt.

Awesome! Thanks.

dlrobertson · 2018-12-09T00:55:09Z

components/script/dom/texttrackcuelist.rs

+
+    // https://html.spec.whatwg.org/multipage/#dom-texttrackcuelist-getcuebyid
+    fn GetCueById(&self, id: DOMString) -> Option<DomRoot<TextTrackCue>> {
+        if String::from(id.clone()).is_empty() {


Is there a better way to determine that the DOMString is empty?

id.is_empty()?

😧 don't know how I missed that.

dlrobertson · 2018-12-09T00:55:09Z

components/script/dom/texttracklist.rs

+            .borrow()
+            .iter()
+            .enumerate()
+            .filter(|(_, t)| t.id() == track.id())


Again, not correct.

Updated to use == which after looking at gecko I think is the right thing to do.

dlrobertson · 2018-12-09T00:55:09Z

components/script/dom/texttrackcuelist.rs

+            .borrow()
+            .iter()
+            .enumerate()
+            .filter(|(_, c)| c.id() == cue.id())


This is not correct, and is not what gecko does.

dlrobertson · 2018-12-09T00:55:09Z

components/script/dom/webidls/TextTrack.webidl

+  readonly attribute TextTrackCueList? cues;
+  // readonly attribute TextTrackCueList? activeCues;
+
+  [Throws]


Note the IDL does not include Throws, but addCue can throw a "InvalidStateError" in step 2 and removeCue can throw a "NotFoundError" in step 1.

Yeah, [Throws] is a Gecko/Servo-specific extension.

👍 Thanks

jdm · 2018-12-09T03:56:47Z

r? @ferjm

jdm · 2018-12-09T21:13:22Z

components/script/dom/texttracklist.rs

+    event_handler!(onchange, GetOnaddtrack, SetOnaddtrack);
+
+    // https://html.spec.whatwg.org/multipage/#handler-texttracklist-onremovetrack
+    event_handler!(onchange, GetOnremovetrack, SetOnremovetrack);


These are using onchange, which probably explains why a few test failures remain in the event handling tests.

Good catch. TrackEvent hasn't been implemented yet, so we'll likely have to implement that in order to get these to work correctly right? I haven't looked into the internals of events yet, so I'm very likely wrong 😄

ferjm · 2018-12-11T11:25:41Z

@bors-servo try=wpt

bors-servo · 2018-12-11T11:25:47Z

⌛ Trying commit 4e36f33 with merge 7f400d1...


        Auto merge of #22392 - dlrobertson:add_text_track, r=<try>

Add the basics of TextTrack ## Summary Implement the basics of the TextTrack elements: - TextTrack - TextTrackCue - TextTrackCueList - TextTrackList - [x] `./mach build -d` does not report any errors - [x] `./mach test-tidy` does not report any errors - [x] These changes is related to #22311 - [x] There are tests for these changes  --- This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/22392)

bors-servo · 2018-12-11T11:50:43Z

💔 Test failed - linux-rel-css

ferjm

Wonderfull work!

I left some comments for minor stuff.

I believe the only thing left is to update the test expectations for tests/wpt/mozilla/tests/mozilla/interfaces.html. And getting @jdm's approval for the new exposed interfaces.

ferjm · 2018-12-11T12:26:24Z

components/script/dom/htmlmediaelement.rs

+    /// associated [textTracks].
+    ///
+    /// [textTracks]: https://html.spec.whatwg.org/multipage/#dom-media-texttracks
+    pub fn text_tracks(&self) -> DomRoot<TextTrackList> {


This does not need to be pubic.

ferjm · 2018-12-11T12:26:24Z

components/script/dom/htmlmediaelement.rs

+
+    // https://html.spec.whatwg.org/multipage/#dom-media-texttracks
+    fn TextTracks(&self) -> DomRoot<TextTrackList> {
+        self.text_tracks()


nit: could we inline the content of the text_tracks function here and get rid of that function? We can call self.TextTracks() from AddTextTrack

ferjm · 2018-12-11T12:26:24Z

components/script/dom/htmlmediaelement.rs

+        // FIXME set the ready state to Loaded
+        let track = TextTrack::new(&window, kind, label, language, TextTrackMode::Hidden);
+        // Step 3 & 4
+        text_tracks.add(&track);


nit: self.TextTracks().add(&track)

ferjm · 2018-12-11T12:26:24Z

components/script/dom/texttrack.rs

+            kind: kind,
+            label: label.into(),
+            language: language.into(),
+            id: "".to_owned(),


I suspect that we need to get the id property as an argument of new and new_inherited as well, so we can assign the proper id when creating a TextTrack associated to a HTMLTrackElement.

I wasn't sure what to do here. The spec states.

the track's identifier, if it has one, or the empty string otherwise

But in gecko the TextTrack class does not have an id member. For now I've added id to new and new_inherited

ferjm · 2018-12-11T12:26:24Z

components/script/dom/texttrack.rs

+    // https://html.spec.whatwg.org/multipage/#dom-texttrack-cues
+    fn GetCues(&self) -> Option<DomRoot<TextTrackCueList>> {
+        // FIXME if text track mode is disabled, return None
+        Some(self.get_cues())


match self.Mode() { TextTrackMode::Disabled => None, _ => Some(self.get_cues()), }

ferjm · 2018-12-11T12:26:24Z

components/script/dom/htmlmediaelement.rs

+        let window = window_from_node(self);
+        let text_tracks = self.text_tracks();
+        // Step 1 & 2
+        // FIXME set the ready state to Loaded


Until we have a more specific issue, reference issue #22314 here, please.

ferjm · 2018-12-11T12:26:24Z

components/script/dom/texttrack.rs

+
+    // https://html.spec.whatwg.org/multipage/#dom-texttrack-addcue
+    fn AddCue(&self, cue: &TextTrackCue) -> ErrorResult {
+        // FIXME add Step 1 & 2


Until we have a more specific issue, reference issue #22314 here, please.

ferjm · 2018-12-11T12:26:24Z

components/script/dom/texttrack.rs

+            // gecko calls RemoveCue when the given cue
+            // has an associated track, but doesn't return
+            // the error from it, so we wont either.
+            let _ = old_track.RemoveCue(cue);


The spec says nothing about returning an error if removing the cue fails, so I think this behavior is fine. However, if removing the cue fails, that means that our implementation is buggy, so we should either add a warn! message or a debug_assert here.

dlrobertson · 2018-12-11T14:45:54Z

@ferjm updated

ferjm · 2018-12-11T17:16:21Z

Thanks! r=me

@jdm r? for the new exposed interfaces.

jdm · 2018-12-11T17:36:13Z

@bors-servo r=ferjm

bors-servo · 2018-12-11T17:36:14Z

📌 Commit 94eec96 has been approved by ferjm

bors-servo · 2018-12-11T17:36:20Z

⌛ Testing commit 94eec96 with merge aae005c...


        Auto merge of #22392 - dlrobertson:add_text_track, r=ferjm

Add the basics of TextTrack ## Summary Implement the basics of the TextTrack elements: - TextTrack - TextTrackCue - TextTrackCueList - TextTrackList - [x] `./mach build -d` does not report any errors - [x] `./mach test-tidy` does not report any errors - [x] These changes is related to #22311 - [x] There are tests for these changes  --- This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/22392)

bors-servo · 2018-12-11T18:03:49Z

💔 Test failed - linux-rel-wpt

bors-servo · 2018-12-11T19:37:41Z

⌛ Testing commit 86a9bfd with merge fe15978...


        Auto merge of #22392 - dlrobertson:add_text_track, r=ferjm

Add the basics of TextTrack ## Summary Implement the basics of the TextTrack elements: - TextTrack - TextTrackCue - TextTrackCueList - TextTrackList - [x] `./mach build -d` does not report any errors - [x] `./mach test-tidy` does not report any errors - [x] These changes is related to #22311 - [x] There are tests for these changes  --- This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/22392)

bors-servo · 2018-12-11T20:00:48Z

💔 Test failed - linux-rel-css


        script: Create structures for TextTrack API

Fill out the basics for the WebIDLs for the following: - TextTrack - TextTrackCue - TextTrackCueList - TextTrackList


        update-wpt: TextTrack tests

Update the expectations of TextTrack related tests.

dlrobertson · 2018-12-11T20:23:09Z

The tests don't fail on my setup. Is it an intermittent? I also just rebased on the current master

ferjm · 2018-12-11T21:50:01Z

They indeed look like intermittents. Filed #22422 and #22423.

@bors-servo r+

bors-servo · 2018-12-11T21:50:02Z

📌 Commit eb531f6 has been approved by ferjm

bors-servo · 2018-12-11T21:50:09Z

⌛ Testing commit eb531f6 with merge 90fc9e2...


        Auto merge of #22392 - dlrobertson:add_text_track, r=ferjm

Add the basics of TextTrack ## Summary Implement the basics of the TextTrack elements: - TextTrack - TextTrackCue - TextTrackCueList - TextTrackList - [x] `./mach build -d` does not report any errors - [x] `./mach test-tidy` does not report any errors - [x] These changes is related to #22311 - [x] There are tests for these changes  --- This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/22392)

bors-servo · 2018-12-11T22:36:40Z

💔 Test failed - mac-rel-css1

jdm · 2018-12-11T22:43:26Z

@bors-servo retry

#22425

bors-servo · 2018-12-11T22:43:30Z

⚡ Previous build results for android, android-mac, android-x86, arm32, arm64, linux-dev, linux-rel-css, linux-rel-wpt, mac-dev-unit, mac-rel-css2, mac-rel-wpt3, magicleap, status-taskcluster, windows-msvc-dev are reusable. Rebuilding only mac-rel-css1, mac-rel-wpt1, mac-rel-wpt2, mac-rel-wpt4...

bors-servo · 2018-12-11T23:28:11Z

☀️ Test successful - android, android-mac, android-x86, arm32, arm64, linux-dev, linux-rel-css, linux-rel-wpt, mac-dev-unit, mac-rel-css1, mac-rel-css2, mac-rel-wpt1, mac-rel-wpt2, mac-rel-wpt3, mac-rel-wpt4, magicleap, status-taskcluster, windows-msvc-dev
Approved by: ferjm
Pushing 90fc9e2 to master...

highfive assigned asajeffrey Dec 9, 2018

highfive added the S-awaiting-review label Dec 9, 2018

dlrobertson reviewed Dec 9, 2018

View changes

highfive assigned ferjm and unassigned asajeffrey Dec 9, 2018

dlrobertson force-pushed the dlrobertson:add_text_track branch from 8bddd93 to 64573d5 Dec 9, 2018

jdm reviewed Dec 9, 2018

View changes

dlrobertson force-pushed the dlrobertson:add_text_track branch from 64573d5 to 4e36f33 Dec 10, 2018

highfive added the S-tests-failed label Dec 11, 2018

ferjm approved these changes Dec 11, 2018

View changes

dlrobertson force-pushed the dlrobertson:add_text_track branch from 4e36f33 to 94eec96 Dec 11, 2018

highfive removed the S-tests-failed label Dec 11, 2018

highfive added S-awaiting-merge and removed S-awaiting-review labels Dec 11, 2018

highfive added S-tests-failed and removed S-awaiting-merge labels Dec 11, 2018

dlrobertson force-pushed the dlrobertson:add_text_track branch from 94eec96 to 86a9bfd Dec 11, 2018

highfive added S-awaiting-merge and removed S-awaiting-review labels Dec 11, 2018

highfive added S-tests-failed and removed S-awaiting-merge labels Dec 11, 2018

dlrobertson added 2 commits Dec 8, 2018

update-wpt: TextTrack tests

Verified

This commit was signed with a verified signature.

dlrobertson Dan Robertson

GPG key ID: 45C4A652C47E42A5 Learn about signing commits

Loading status checks…

eb531f6

Update the expectations of TextTrack related tests.

dlrobertson force-pushed the dlrobertson:add_text_track branch from 86a9bfd to eb531f6 Dec 11, 2018

highfive added S-awaiting-review and removed S-tests-failed labels Dec 11, 2018

highfive added S-awaiting-merge and removed S-awaiting-review labels Dec 11, 2018

highfive added S-tests-failed and removed S-awaiting-merge labels Dec 11, 2018

bors-servo merged commit eb531f6 into servo:master Dec 11, 2018
2 of 3 checks passed

2 of 3 checks passed

continuous-integration/appveyor/pr AppVeyor build failed
Details

continuous-integration/travis-ci/pr The Travis CI build passed
Details

homu Test successful
Details

This was referenced Dec 11, 2018

Implementing HTMLMediaElement.volume attribute #22324

Merged

Initial Steps OffscreenCanvas API #22379

Closed

dlrobertson deleted the dlrobertson:add_text_track branch Dec 12, 2018

ferjm mentioned this pull request Dec 12, 2018

Implement the Text track API #22311

Closed

servo / servo

Join GitHub today

Add the basics of TextTrack #22392

Add the basics of TextTrack #22392

Conversation

dlrobertson commented Dec 9, 2018 • edited by SimonSapin

Summary

highfive commented Dec 9, 2018

dlrobertson left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

jdm commented Dec 9, 2018

This comment has been minimized.

This comment has been minimized.

ferjm commented Dec 11, 2018

bors-servo commented Dec 11, 2018

bors-servo commented Dec 11, 2018

ferjm left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

dlrobertson commented Dec 11, 2018

ferjm commented Dec 11, 2018

jdm commented Dec 11, 2018

bors-servo commented Dec 11, 2018

bors-servo commented Dec 11, 2018

bors-servo commented Dec 11, 2018

bors-servo commented Dec 11, 2018

bors-servo commented Dec 11, 2018

dlrobertson commented Dec 11, 2018

ferjm commented Dec 11, 2018

bors-servo commented Dec 11, 2018

bors-servo commented Dec 11, 2018

bors-servo commented Dec 11, 2018

jdm commented Dec 11, 2018

bors-servo commented Dec 11, 2018

bors-servo commented Dec 11, 2018

dlrobertson commented Dec 9, 2018 •

edited by SimonSapin