summaryrefslogtreecommitdiffstats
path: root/toolkit/components/pictureinpicture/tests/browser_keyboardShortcut.js
blob: a81d99e18c82b774d4bb85fc64d4fa3c26cc57a8 (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
/* Any copyright is dedicated to the Public Domain.
   http://creativecommons.org/publicdomain/zero/1.0/ */

"use strict";

const { TelemetryTestUtils } = ChromeUtils.importESModule(
  "resource://testing-common/TelemetryTestUtils.sys.mjs"
);

const PIP_SHORTCUT_OPEN_EVENTS = [
  {
    category: "pictureinpicture",
    method: "opened_method",
    object: "shortcut",
  },
];

const PIP_SHORTCUT_CLOSE_EVENTS = [
  {
    category: "pictureinpicture",
    method: "closed_method",
    object: "shortcut",
  },
];

/**
 * Tests that if the user keys in the keyboard shortcut for
 * Picture-in-Picture, then the first video on the currently
 * focused page will be opened in the player window.
 */
add_task(async function test_pip_keyboard_shortcut() {
  await BrowserTestUtils.withNewTab(
    {
      url: TEST_PAGE,
      gBrowser,
    },
    async browser => {
      Services.telemetry.clearEvents();
      await ensureVideosReady(browser);

      // In test-page.html, the "with-controls" video is the first one that
      // appears in the DOM, so this is what we expect to open via the keyboard
      // shortcut.
      const VIDEO_ID = "with-controls";

      let domWindowOpened = BrowserTestUtils.domWindowOpenedAndLoaded(null);
      let videoReady = SpecialPowers.spawn(
        browser,
        [VIDEO_ID],
        async videoID => {
          let video = content.document.getElementById(videoID);
          await ContentTaskUtils.waitForCondition(() => {
            return video.isCloningElementVisually;
          }, "Video is being cloned visually.");
        }
      );

      if (AppConstants.platform == "macosx") {
        EventUtils.synthesizeKey("]", {
          accelKey: true,
          shiftKey: true,
          altKey: true,
        });
      } else {
        EventUtils.synthesizeKey("]", { accelKey: true, shiftKey: true });
      }

      let pipWin = await domWindowOpened;
      await videoReady;

      ok(pipWin, "Got Picture-in-Picture window.");

      await ensureMessageAndClosePiP(browser, VIDEO_ID, pipWin, false);

      let openFilter = {
        category: "pictureinpicture",
        method: "opened_method",
        object: "shortcut",
      };
      await waitForTelemeryEvents(
        openFilter,
        PIP_SHORTCUT_OPEN_EVENTS.length,
        "content"
      );
      TelemetryTestUtils.assertEvents(PIP_SHORTCUT_OPEN_EVENTS, openFilter, {
        clear: true,
        process: "content",
      });

      // Reopen PiP Window
      pipWin = await triggerPictureInPicture(browser, VIDEO_ID);
      await videoReady;

      ok(pipWin, "Got Picture-in-Picture window.");

      if (AppConstants.platform == "macosx") {
        EventUtils.synthesizeKey(
          "]",
          {
            accelKey: true,
            shiftKey: true,
            altKey: true,
          },
          pipWin
        );
      } else {
        EventUtils.synthesizeKey(
          "]",
          { accelKey: true, shiftKey: true },
          pipWin
        );
      }

      await BrowserTestUtils.windowClosed(pipWin);

      ok(pipWin.closed, "Picture-in-Picture window closed.");

      let closeFilter = {
        category: "pictureinpicture",
        method: "closed_method",
        object: "shortcut",
      };
      await waitForTelemeryEvents(
        closeFilter,
        PIP_SHORTCUT_CLOSE_EVENTS.length,
        "parent"
      );
      TelemetryTestUtils.assertEvents(PIP_SHORTCUT_CLOSE_EVENTS, closeFilter, {
        clear: true,
        process: "parent",
      });
    }
  );
});