summaryrefslogtreecommitdiffstats
path: root/devtools/client/inspector/test/browser_inspector_highlighter-autohide.js
blob: 4d658e77ad14de9ff8d1cf414a0d417cbd08c2bd (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
/* 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";

// Test that clicking on a node in the markup view or picking a node with the node picker
// shows a highlighter which is automatically hidden after a delay.
add_task(async function () {
  info("Loading the test document and opening the inspector");
  const { inspector, toolbox, highlighterTestFront } =
    await openInspectorForURL(
      "data:text/html;charset=utf-8,<p id='one'>TEST 1</p><p id='two'>TEST 2</p>"
    );
  const { waitForHighlighterTypeShown, waitForHighlighterTypeHidden } =
    getHighlighterTestHelpers(inspector);

  // While in test mode, the configuration to automatically hide Box Model Highlighters
  // after a delay is ignored to prevent intermittent test failures from race conditions.
  // Restore this behavior just for this test because it is explicitly checked.
  const HIGHLIGHTER_AUTOHIDE_TIMER = inspector.HIGHLIGHTER_AUTOHIDE_TIMER;
  inspector.HIGHLIGHTER_AUTOHIDE_TIMER = 1000;

  registerCleanupFunction(() => {
    // Restore the value to avoid impacting other tests.
    inspector.HIGHLIGHTER_AUTOHIDE_TIMER = HIGHLIGHTER_AUTOHIDE_TIMER;
  });

  info(
    "Check that selecting an element in the markup-view shows the highlighter and auto-hides it"
  );
  let onHighlighterShown = waitForHighlighterTypeShown(
    inspector.highlighters.TYPES.BOXMODEL
  );
  const onHighlighterHidden = waitForHighlighterTypeHidden(
    inspector.highlighters.TYPES.BOXMODEL
  );

  let delay;
  const start = Date.now();
  onHighlighterHidden.then(() => {
    delay = Date.now() - start;
  });

  await clickContainer("#one", inspector);

  info("Wait for Box Model Highlighter shown");
  await onHighlighterShown;
  info("Wait for Box Model Highlighter hidden");
  await onHighlighterHidden;

  ok(true, "Highlighter was shown and hidden");
  Assert.greaterOrEqual(
    delay,
    inspector.HIGHLIGHTER_AUTOHIDE_TIMER,
    `Highlighter was hidden after expected delay (${delay}ms)`
  );

  info("Check that picking a node hides the highlighter right away");
  onHighlighterShown = waitForHighlighterTypeShown(
    inspector.highlighters.TYPES.BOXMODEL
  );
  await startPicker(toolbox);
  await hoverElement(inspector, "#two", 0, 0);
  await onHighlighterShown;
  ok(
    await highlighterTestFront.isHighlighting(),
    "Highlighter was shown when hovering the node"
  );

  await pickElement(inspector, "#two", 0, 0);
  is(
    await highlighterTestFront.isHighlighting(),
    false,
    "Highlighter gets hidden without delay after picking a node"
  );
});