1886604 - Add MockDragService to allow DND testing in tabs and pages

Status: RESOLVED FIXED

(Core :: Widget, task)

Description

[David Parks [:handyman]]

This is spun off of bug 1871222, which uses this to test that DND respects content analysis. I've broken it off to simplify the bug history and review. I've also added a somewhat elementary test of basic DND behavior. In the future, we hope to migrate existing DND tests to this setup.

Comment 1

[David Parks [:handyman]]

Attachment: Bug 1886604: Part 1: Make nsIDragService Mockable r=rkraesig!,m_kato!

Removes builtinclass, notxpcom and nostdcall and updates clients.

Comment 2

[David Parks [:handyman]]

Attachment: Bug 1886604: Part 1: Add JS-scriptable MockDragService r=#win-reviewers!

Introduces MockDragService as a subclass/implementation of nsBaseDragService.
This class is based on the Windows implementation of nsBaseDragService. The
service is created with a MockDragServiceController that JS can use to
initiate drag events that would normally come from the system. Native
drag-and-drop is not permitted in automation because it puts the browser into
a state where, if anything goes wrong (e.g. a test failure), it cannot be
killed without manual intervention. This allows us to avoid that limitation
while still testing most of the browser's drag-and-drop behavior, including
the (substantial and complex) nsBaseDragService base-class that is common to
all platforms.

Depends on D205639

Comment 3

[David Parks [:handyman]]

Attachment: Bug 1886604: Part 2: Add synthesizeMockDragAndDrop r=edgar!

Add synthesizeMockDragAndDrop test function to test elements
drag-dropped inside of Firefox. This uses the new MockDragService to
avoid native DND. It is a more-complete variant of synthesizeDragAndDrop
and synthesizePlainDragAndDrop. It works by:

1. Creating the environment for the test.
2. Gathering coordinates of the source and target elements from their
   respective content processes.
3. Setting up event handlers on the elements to detect any relevant events
   they may receive. This allows us to detect not only events that aren't sent
   when they should be but also events that are sent that shouldn't be.
4. Synthesizing mouse events to initiate the drag-session. This and
   the remaining steps work by first telling the relevant content process(es)
   what events to expect (and which not to), then sending the event, and
   finally collecting the results and submitting them to mochitest.
5. Synthesizing drag events with the MockDragServiceController, to emulate
   the behavior of (Windows) native drag-and-drop. This is a coarse
   approximation of the Win32 API DoDragDrop.
6. Cleaning up the event handlers.

The test does not yet try to mock things like the drag cursor image, although
that should be possible without native DND behavior. The same is true for
some more minor aspects of the platform-specific behavior of our DND.

Depends on D205640

Comment 4

[David Parks [:handyman]]

Attachment: Bug 1886604: Part 3: Test drag and drop events between windows and iframes r=edgar!

Test of basic DND functionality between content pages, using the
MockDragService.

Depends on D205641

Comment 5

[David Parks [:handyman]]

https://treeherder.mozilla.org/jobs?repo=try&group_state=expanded&selectedTaskRun=SVceLmvRQJyheY7N9vWAdg.0&revision=348586e1bfd839b0800f530602a1bd326115bb14

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/da0dd76615c1
Part 1: Add JS-scriptable MockDragService r=win-reviewers,edgar,rkraesig
https://hg.mozilla.org/integration/autoland/rev/cb68ed9008a9
Part 2: Add synthesizeMockDragAndDrop r=edgar
https://hg.mozilla.org/integration/autoland/rev/7cdf4136ca78
Part 3: Test drag and drop events between windows and iframes r=edgar

Comment 7

[Cosmin Sabou [:CosminS]]

https://hg.mozilla.org/mozilla-central/rev/da0dd76615c1
https://hg.mozilla.org/mozilla-central/rev/cb68ed9008a9
https://hg.mozilla.org/mozilla-central/rev/7cdf4136ca78

Comment 8

[Greg Stoll :gstoll]

Attachment: Bug 1886604: Part 1: Add JS-scriptable MockDragService

Introduces MockDragService as a subclass/implementation of nsBaseDragService.
This class is based on the Windows implementation of nsBaseDragService. The
service is created with a MockDragServiceController that JS can use to
initiate drag events that would normally come from the system. Native
drag-and-drop is not permitted in automation because it puts the browser into
a state where, if anything goes wrong (e.g. a test failure), it cannot be
killed without manual intervention. This allows us to avoid that limitation
while still testing most of the browser's drag-and-drop behavior, including
the (substantial and complex) nsBaseDragService base-class that is common to
all platforms.

Original Revision: https://phabricator.services.mozilla.com/D205640

Comment 9

[Greg Stoll :gstoll]

Attachment: Bug 1886604: Part 2: Add synthesizeMockDragAndDrop

Add synthesizeMockDragAndDrop test function to test elements
drag-dropped inside of Firefox. This uses the new MockDragService to
avoid native DND. It is a more-complete variant of synthesizeDragAndDrop
and synthesizePlainDragAndDrop. It works by:

1. Creating the environment for the test.
2. Gathering coordinates of the source and target elements from their
   respective content processes.
3. Setting up event handlers on the elements to detect any relevant events
   they may receive. This allows us to detect not only events that aren't sent
   when they should be but also events that are sent that shouldn't be.
4. Synthesizing mouse events to initiate the drag-session. This and
   the remaining steps work by first telling the relevant content process(es)
   what events to expect (and which not to), then sending the event, and
   finally collecting the results and submitting them to mochitest.
5. Synthesizing drag events with the MockDragServiceController, to emulate
   the behavior of (Windows) native drag-and-drop. This is a coarse
   approximation of the Win32 API DoDragDrop.
6. Cleaning up the event handlers.

The test does not yet try to mock things like the drag cursor image, although
that should be possible without native DND behavior. The same is true for
some more minor aspects of the platform-specific behavior of our DND.

Original Revision: https://phabricator.services.mozilla.com/D205641

Comment 10

[Greg Stoll :gstoll]

Attachment: Bug 1886604: Part 3: Test drag and drop events between windows and iframes

Test of basic DND functionality between content pages of different domains,
using the MockDragService.

Original Revision: https://phabricator.services.mozilla.com/D205642

Comment 11

[Greg Stoll :gstoll]

esr128 Uplift Approval Request

• User impact if declined: Won't be able to test DLP drag and drop
• Code covered by automated testing: no
• Fix verified in Nightly: yes
• Needs manual QE test: no
• Steps to reproduce for manual QE testing: n/a
• Risk associated with taking this patch: medium
• Explanation of risk level: deals with drag and drop code, but has already made it to release and further patches add tests
• String changes made/needed: no
• Is Android affected?: no

Comment 12

[Pulsebot]

https://hg.mozilla.org/releases/mozilla-esr128/rev/6d39164c7299
https://hg.mozilla.org/releases/mozilla-esr128/rev/b88ba3de2602
https://hg.mozilla.org/releases/mozilla-esr128/rev/53733387f5cc