View source for TPE DOM/Pointer events

== Introduction ==
This project is to support events and related interfaces for handling hardware pointer input from various devices including a mouse, pen, touchscreen, etc. There's implementation prefed-off on Nightly due to lack of stability. We will start from enabling the feature for Desktop again on Nightly then on Fennec.

References:
*[https://www.w3.org/TR/pointerevents/ Pointer events spec]
*[https://groups.google.com/a/chromium.org/forum/#!topic/blink-dev/ODWmcKNQl0I dev-blink intent-to-implement]
*[https://groups.google.com/d/msg/mozilla.dev.platform/l45DAXyLCAM/LI8rrVoWFs8J Mozilla discussion thread]

== Main Members ==
Engineers: Stone Shih (main contact), Ben Hsu

QA contact: Alexandru Simonca (:asimonca)

== Meeting Minutes & Project Status ==
[https://docs.google.com/a/mozilla.com/document/d/1VbLr9U8L0ByzhXd6RfJDRGr8QQpEjgQRavqgnSTw0QE/edit?usp=sharing Sync-up meeting gdoc] or
[https://public.etherpad-mozilla.org/p/pointerevents-qa-weekly etherpad]

== Test plan and test cases ==
*[https://wiki.mozilla.org/QA/Pointer_events QA Test plan wiki page]
*[https://docs.google.com/spreadsheets/u/1/d/1bxR4be2wEKnTHjTDatpzqtgAbF5F4NOrLOvaIxROFQM/edit?ts=5805986f List of websites using PointerEvents]
*[https://docs.google.com/spreadsheets/d/1Xo_ye5UEqSfwc3BFy0k9T6A2DNaq6g8yWbRZ83WfbOU/edit#gid=0 Test cases]

== Roadmap ==
=== Current Status Overview <We are here> ===
We're at Milestone 5 - ride to train and expecting to let Pointer Events default on in 59.

=== Details ===
* Milestone 1 - support major Pointer events behaviors on Windows Desktop with Pref-off on Nightly 52 <DONE>
** Tasks
*** Fix crashes and critical issues breaking existing mouse and touch experiences
*** [https://bugzilla.mozilla.org/show_bug.cgi?id=1299024 Automation test enhancement]
** Schedule
*** 2016 Q3
*** Checking point: 2016 8E
* Milestone 2 - To enable PE on Windows on Nightly 53 <DONE, enabled on Nightly 54>
** Acceptance criteria
*** Web-platform-tests all pass
*** No regression on existing mouse, touch and pen experiences
*** To work with QA
** Tasks
*** QA perform manual tests upon [https://docs.google.com/spreadsheets/d/1bxR4be2wEKnTHjTDatpzqtgAbF5F4NOrLOvaIxROFQM/edit?ts=5805986f#gid=0 major websites] on Windows Desktop
*** Fix blocking issues
**** High-level click events
**** Compatibility mouse events
**** [https://bugzilla.mozilla.org/show_bug.cgi?id=1292437 Implement pointer capture behaviors]
**** [https://bugzilla.mozilla.org/show_bug.cgi?id=1292079 Fire boundary events]
**** [https://bugzilla.mozilla.org/show_bug.cgi?id=1293129 Add PEv2 stylus attributes]
**** After fixing blocking issues reported by QA, we plan to invite community members to test the feature widely.
** Schedule - Target riding Firefox 53 Nightly (on track)

* Milestone 3 - To enable PE on Linux on Nightly 55 <DONE>
** Acceptance criteria
*** Web-platform-tests all pass
*** No regression on existing mouse, touch and pen experiences
*** To work with QA
** Tasks
*** WidgetPointer arch proposal discussion - Investigate Linux, Fennec, Windows (confirmed with reviewer)
*** https://bugzilla.mozilla.org/show_bug.cgi?id=1324956
* Milestone 4 - MAC: target on FF 55 <DONE>
** https://bugzilla.mozilla.org/show_bug.cgi?id=1304904
* Milestone 5 - Ride the train to release <WE'RE HERE>
** Target release: 59

== PHASE 2 - Enabling PE on Fennec Nightly ==
* TBD

== Project Dashboard ==
=== Meta Bugs ===
<bugzilla>
    {
        "id":["822898","1166347"]
    }
</bugzilla>

=== Milestone_1 Bugs & Progress ===
Implementation part: Miscelleous & Crashes fixing - DONE
<bugzilla>
    {
        "blocks":["1166347"],
        "status":["RESOLVED","VERIFIED","CLOSED"],
        "assigned_to":["bhsu@mozilla.com","sshih@mozilla.com"],
        "include_fields": "id, summary, status, target_milestone, resolution, assigned_to, depends_on, blocks"
    }
</bugzilla>

Testing refinement:
<bugzilla>
    {
        "blocks":["1299024"],
        "status":["NEW","REOPENED","UNCONFIRMED","ASSIGNED","RESOLVED","VERIFIED","CLOSED"],
        "include_fields": "id, summary, status, target_milestone, resolution, assigned_to, depends_on, blocks"
    }
</bugzilla>

=== Milestone_2 Bugs & Progress ===
<bugzilla>
    {
        "blocks":["1292437","1292079","1292077","1293173", "1315189"],    
        "status":["NEW","REOPENED","UNCONFIRMED","ASSIGNED","RESOLVED","VERIFIED","CLOSED"],
        "include_fields": "id, summary, status, target_milestone, resolution, assigned_to, whiteboard"
    }
</bugzilla>

== Archive & History ==
{| class="wikitable"
! style="font-weight: bold;" | Milestone 2
| colspan="4" | To enable PE on Windows on Nightly 53 
|-
! style="font-weight: bold;" | Target schedule
| colspan="4" | Riding Firefox 53 Nightly (on track) (Due to Chinese new year, we are considering pref-on right after the holidays, i.e. 54)
|-
!style="font-weight: bold;" | Status
| colspan="4" | DONE
|-
! style="font-weight: bold;" | Details
| colspan="4" | 
# Enabled on Nightly 54
|-
! Issue !! Description !! Status !! Comments/Corresponding Action 
|-
| Ship to Windows only first 
|| QA suggested we could consider to '''ship only to Windows first''' if PE is going to be better than the current touch events 
|| Closed 
|| 
* Wait for QA P1 & P2 report first, then ask Reviewer to see if any concerns
* If suggestion accepted, we will merge two phases into one.
* [Reviewers' feedback] It's not suggested we ship this feature to a single OS first. We should ship it to Desktop on all OSes together, then Fennec.
|-
|}

{| class="wikitable"
! style="font-weight: bold;" | Milestone 3
| colspan="4" | To enable PE on Linux on Nightly 55
|-
! style="font-weight: bold;" | Target schedule
| colspan="4" | Riding Firefox 55 Nightly (on track)  - turn out to be enabled on 56 Nightly due to Quantum resource allocation and Fingerprinting sec review
|-
!style="font-weight: bold;" | Status
| colspan="4" | DONE
|-
! style="font-weight: bold;" | Details
| colspan="4" | 
# SV delivered 55 mid-nightly report (YELLOW) and pre-beta report (GREEN, recommend to ship)
|-
! Issue !! Description !! Status !! Comments/Corresponding Action 
|-
|Linux testing support on SV side
|| Need to confirm SV's resource and testing equipment
|| Closed
||
* SV will keep testing this feature for a sign off report.
* SV doesn't plan to buy a specific linux device, we will send one to them once Taipei QA finishes the 1st round testing for us.
|-
| Pending review on https://bugzilla.mozilla.org/show_bug.cgi?id=1324956 
|| Reviewer doesn't think we should do this now, and it's not in his priority
|| Closed 
|| 
* After discussion and QA testing, we agreed that it's not within the scope of MVP as current firefox doesn't support linux touch by default.
|-
|  Fingerprinting
|| Need to have security peers feedback on fingerprinting exposure
|| Closed
|| 
Get conclusion on [Bug 1363508 - Consider how to do Anti-fingerprinting for Pointer Events]. Bug 1363508 isn't a blocker to ship PE but we need to get it fixed in FF 59 considering the plan for the anti-fingerprinting project.
|}


{| class="wikitable"
! style="font-weight: bold;" | Milestone 4
| colspan="4" | To enable PE on MAC on Nightly 55
|-
! style="font-weight: bold;" | Target schedule
| colspan="4" | Riding Firefox 55 Nightly (on track)  - turn out to be enabled on 56 Nightly due to Quantum resource allocation and Fingerprinting sec review
|-
!style="font-weight: bold;" | Status
| colspan="4" | DONE
|-
! style="font-weight: bold;" | Details
| colspan="4" | 
# SV delivered 55 mid-nightly report (YELLOW) and pre-beta report (GREEN, recommend to ship)
|-
! Issue !! Description !! Status !! Comments/Corresponding Action 
|-
|Linux testing support on SV side
|| Need to confirm SV's resource and testing equipment
|| Closed
||
* SV will keep testing this feature for a sign off report.
* SV doesn't plan to buy a specific Mac device, we will send one to them once Taipei QA finishes the 1st round testing for us.
|-
|  Fingerprinting
|| Need to have security peers feedback on fingerprinting exposure
|| Closed
|| 
Get conclusion on [Bug 1363508 - Consider how to do Anti-fingerprinting for Pointer Events]. Bug 1363508 isn't a blocker to ship PE but we need to get it fixed in FF 59 considering the plan for the anti-fingerprinting project.
|}