summaryrefslogtreecommitdiffstats
path: root/browser/modules/test/browser/browser_HomePage_add_button.js
blob: 045fed870efe8e70903ba363475de358bcd71efb (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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/* Any copyright is dedicated to the Public Domain.
   http://creativecommons.org/publicdomain/zero/1.0/ */

"use strict";

ChromeUtils.defineModuleGetter(
  this,
  "HomePage",
  "resource:///modules/HomePage.jsm"
);

const kPrefHomePage = "browser.startup.homepage";
const kPrefExtensionControlled =
  "browser.startup.homepage_override.extensionControlled";
const kPrefHomeButtonRemoved = "browser.engagement.home-button.has-removed";
const kHomeButtonId = "home-button";
const kUrlbarWidgetId = "urlbar-container";

// eslint-disable-next-line no-empty-pattern
async function withTestSetup({} = {}, testFn) {
  CustomizableUI.removeWidgetFromArea(kHomeButtonId);

  await SpecialPowers.pushPrefEnv({
    set: [
      [kPrefHomeButtonRemoved, false],
      [kPrefHomePage, "about:home"],
      [kPrefExtensionControlled, false],
    ],
  });

  HomePage._addCustomizableUiListener();

  try {
    await testFn();
  } finally {
    await SpecialPowers.popPrefEnv();
    await CustomizableUI.reset();
  }
}

function assertHomeButtonInArea(area) {
  let placement = CustomizableUI.getPlacementOfWidget(kHomeButtonId);
  is(placement.area, area, "home button in area");
}

function assertHomeButtonNotPlaced() {
  ok(
    !CustomizableUI.getPlacementOfWidget(kHomeButtonId),
    "home button not placed"
  );
}

function assertHasRemovedPref(val) {
  is(
    Services.prefs.getBoolPref(kPrefHomeButtonRemoved),
    val,
    "Expected removed pref value"
  );
}

async function runAddButtonTest() {
  await withTestSetup({}, async () => {
    // Setting the homepage once should add to the toolbar.
    assertHasRemovedPref(false);
    assertHomeButtonNotPlaced();

    await HomePage.set("https://example.com/");

    assertHomeButtonInArea("nav-bar");
    assertHasRemovedPref(false);

    // After removing the home button, a new homepage shouldn't add it.
    CustomizableUI.removeWidgetFromArea(kHomeButtonId);

    await HomePage.set("https://mozilla.org/");
    assertHomeButtonNotPlaced();
  });
}

add_task(async function testAddHomeButtonOnSet() {
  await runAddButtonTest();
});

add_task(async function testHomeButtonDoesNotMove() {
  await withTestSetup({}, async () => {
    // Setting the homepage should not move the home button.
    CustomizableUI.addWidgetToArea(kHomeButtonId, "TabsToolbar");
    assertHasRemovedPref(false);
    assertHomeButtonInArea("TabsToolbar");

    await HomePage.set("https://example.com/");

    assertHasRemovedPref(false);
    assertHomeButtonInArea("TabsToolbar");
  });
});

add_task(async function testHomeButtonNotAddedBlank() {
  await withTestSetup({}, async () => {
    assertHomeButtonNotPlaced();
    assertHasRemovedPref(false);

    await HomePage.set("about:blank");

    assertHasRemovedPref(false);
    assertHomeButtonNotPlaced();

    await HomePage.set("about:home");

    assertHasRemovedPref(false);
    assertHomeButtonNotPlaced();
  });
});

add_task(async function testHomeButtonNotAddedExtensionControlled() {
  await withTestSetup({}, async () => {
    assertHomeButtonNotPlaced();
    assertHasRemovedPref(false);
    Services.prefs.setBoolPref(kPrefExtensionControlled, true);

    await HomePage.set("https://search.example.com/?q=%s");

    assertHomeButtonNotPlaced();
  });
});

add_task(async function testHomeButtonPlacement() {
  await withTestSetup({}, async () => {
    assertHomeButtonNotPlaced();
    HomePage._maybeAddHomeButtonToToolbar("https://example.com");
    let homePlacement = CustomizableUI.getPlacementOfWidget(kHomeButtonId);
    is(homePlacement.area, "nav-bar", "Home button is in the nav-bar");
    is(homePlacement.position, 3, "Home button is after stop/refresh");

    let addressBarPlacement =
      CustomizableUI.getPlacementOfWidget(kUrlbarWidgetId);
    is(
      addressBarPlacement.position,
      5,
      "There's a space between home and urlbar"
    );
    CustomizableUI.removeWidgetFromArea(kHomeButtonId);
    Services.prefs.setBoolPref(kPrefHomeButtonRemoved, false);

    try {
      CustomizableUI.addWidgetToArea(kUrlbarWidgetId, "nav-bar", 1);
      HomePage._maybeAddHomeButtonToToolbar("https://example.com");
      homePlacement = CustomizableUI.getPlacementOfWidget(kHomeButtonId);
      is(homePlacement.area, "nav-bar", "Home button is in the nav-bar");
      is(homePlacement.position, 1, "Home button is right before the urlbar");
    } finally {
      CustomizableUI.addWidgetToArea(
        kUrlbarWidgetId,
        addressBarPlacement.area,
        addressBarPlacement.position
      );
    }
  });
});