summaryrefslogtreecommitdiffstats
path: root/dom/media/mediacontrol/tests/browser/browser_media_control_supported_keys.js
blob: 6a7bc60933b3ccd1a2181e947680b31e8ef79a8f (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
const PAGE_NON_AUTOPLAY =
  "https://example.com/browser/dom/media/mediacontrol/tests/browser/file_non_autoplay.html";

const testVideoId = "video";
const sDefaultSupportedKeys = ["focus", "play", "pause", "playpause", "stop"];

add_task(async function setupTestingPref() {
  await SpecialPowers.pushPrefEnv({
    set: [["media.mediacontrol.testingevents.enabled", true]],
  });
});

/**
 * Supported media keys are used for indicating what UI button should be shown
 * on the virtual control interface. All supported media keys are listed in
 * `MediaKey` in `MediaController.webidl`. Some media keys are defined as
 * default media keys which are always supported. Otherwise, other media keys
 * have to have corresponding action handler on the active media session in
 * order to be added to the supported keys.
 */
add_task(async function testDefaultSupportedKeys() {
  info(`open media page`);
  const tab = await createLoadedTabWrapper(PAGE_NON_AUTOPLAY);

  info(`start media`);
  await playMedia(tab, testVideoId);

  info(`should use default supported keys`);
  await supportedKeysShouldEqualTo(tab, sDefaultSupportedKeys);

  info(`remove tab`);
  await tab.close();
});

add_task(async function testNoActionHandlerBeingSet() {
  info(`open media page`);
  const tab = await createLoadedTabWrapper(PAGE_NON_AUTOPLAY);

  info(`start media`);
  await playMedia(tab, testVideoId);

  info(`create media session but not set any action handler`);
  await setMediaSessionSupportedAction(tab, []);

  info(
    `should use default supported keys even if ` +
      `media session doesn't have any action handler`
  );
  await supportedKeysShouldEqualTo(tab, sDefaultSupportedKeys);

  info(`remove tab`);
  await tab.close();
});

add_task(async function testSettingActionsWhichAreAlreadyDefaultKeys() {
  info(`open media page`);
  const tab = await createLoadedTabWrapper(PAGE_NON_AUTOPLAY);

  info(`start media`);
  await playMedia(tab, testVideoId);

  info(`create media session but not set any action handler`);
  await setMediaSessionSupportedAction(tab, ["play", "pause", "stop"]);

  info(
    `those actions has already been included in default supported keys, so ` +
      `the result should still be default supported keys`
  );
  await supportedKeysShouldEqualTo(tab, sDefaultSupportedKeys);

  info(`remove tab`);
  await tab.close();
});

add_task(async function testSettingActionsWhichAreNotDefaultKeys() {
  info(`open media page`);
  const tab = await createLoadedTabWrapper(PAGE_NON_AUTOPLAY);

  info(`start media`);
  await playMedia(tab, testVideoId);

  info(`create media session but not set any action handler`);
  let nonDefaultActions = [
    "seekbackward",
    "seekforward",
    "previoustrack",
    "nexttrack",
  ];
  await setMediaSessionSupportedAction(tab, nonDefaultActions);

  info(
    `supported keys should include those actions which are not default supported keys`
  );
  let expectedKeys = sDefaultSupportedKeys.concat(nonDefaultActions);
  await supportedKeysShouldEqualTo(tab, expectedKeys);

  info(`remove tab`);
  await tab.close();
});

/**
 * The following are helper functions.
 */
async function supportedKeysShouldEqualTo(tab, expectedKeys) {
  const controller = tab.linkedBrowser.browsingContext.mediaController;
  const supportedKeys = controller.supportedKeys;
  while (JSON.stringify(expectedKeys) != JSON.stringify(supportedKeys)) {
    await new Promise(r => (controller.onsupportedkeyschange = r));
  }
  for (let idx = 0; idx < expectedKeys.length; idx++) {
    is(
      supportedKeys[idx],
      expectedKeys[idx],
      `'${supportedKeys[idx]}' should equal to '${expectedKeys[idx]}'`
    );
  }
}

function setMediaSessionSupportedAction(tab, actions) {
  return SpecialPowers.spawn(tab.linkedBrowser, [actions], actionArr => {
    for (let action of actionArr) {
      content.navigator.mediaSession.setActionHandler(action, () => {
        info(`set '${action}' action handler`);
      });
    }
  });
}