summaryrefslogtreecommitdiffstats
path: root/devtools/client/performance-new/test/browser/browser_devtools-onboarding.js
blob: ac253b9562962cdb349ba9339dc27d58b3bdeba5 (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
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

"use strict";

const ONBOARDING_PREF = "devtools.performance.new-panel-onboarding";

add_task(async function testWithOnboardingPreferenceFalse() {
  info("Test that the onboarding message is displayed as expected.");

  info("Test the onboarding message when the preference is false");
  await SpecialPowers.pushPrefEnv({
    set: [[ONBOARDING_PREF, false]],
  });
  await withDevToolsPanel(async document => {
    {
      // Wait for another UI element to be rendered before asserting the
      // onboarding message.
      await getActiveButtonFromText(document, "Start recording");
      ok(
        !isOnboardingDisplayed(document),
        "Onboarding message is not displayed"
      );
    }
  });
});

add_task(async function testWithOnboardingPreferenceTrue() {
  info("Test the onboarding message when the preference is true");
  await SpecialPowers.pushPrefEnv({
    set: [[ONBOARDING_PREF, true]],
  });

  await withDevToolsPanel(async document => {
    await waitUntil(
      () => isOnboardingDisplayed(document),
      "Waiting for the onboarding message to be displayed"
    );
    ok(true, "Onboarding message is displayed");
    await closeOnboardingMessage(document);
  });

  is(
    Services.prefs.getBoolPref(ONBOARDING_PREF),
    false,
    "onboarding preference should be false after closing the message"
  );
});

add_task(async function testWithOnboardingPreferenceNotSet() {
  info("Test the onboarding message when the preference is not set");
  await SpecialPowers.pushPrefEnv({
    clear: [[ONBOARDING_PREF]],
  });

  await withDevToolsPanel(async document => {
    await waitUntil(
      () => isOnboardingDisplayed(document),
      "Waiting for the onboarding message to be displayed"
    );
    ok(true, "Onboarding message is displayed");
    await closeOnboardingMessage(document);
  });

  is(
    Services.prefs.getBoolPref(ONBOARDING_PREF),
    false,
    "onboarding preference should be false after closing the message"
  );
});

/**
 * Helper to close the onboarding message by clicking on the close button.
 */
async function closeOnboardingMessage(document) {
  const closeButton = await getActiveButtonFromText(
    document,
    "Close the onboarding message"
  );
  info("Click the close button to hide the onboarding message.");
  closeButton.click();

  await waitUntil(
    () => !isOnboardingDisplayed(document),
    "Waiting for the onboarding message to disappear"
  );
}

function isOnboardingDisplayed(document) {
  return maybeGetElementFromDocumentByText(
    document,
    "Firefox Profiler is now integrated into Developer Tools"
  );
}