summaryrefslogtreecommitdiffstats
path: root/devtools/server/tests/mochitest/test_inspector-search.html
blob: 623d3018d448ccc6540ed6edb18d7f1d6b3bc069 (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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
<!DOCTYPE HTML>
<html>
<!--
https://bugzilla.mozilla.org/show_bug.cgi?id=835896
-->
<head>
  <meta charset="utf-8">
  <title>Test for Bug 835896</title>
  <script type="application/javascript" src="chrome://mochikit/content/tests/SimpleTest/SimpleTest.js"></script>
  <link rel="stylesheet" type="text/css" href="chrome://mochikit/content/tests/SimpleTest/test.css">
  <script type="application/javascript;version=1.8" src="inspector-helpers.js"></script>
  <script type="application/javascript;version=1.8">
window.onload = function() {
  const Cu = Components.utils;
  const {require} = Cu.import("resource://devtools/shared/Loader.jsm", {});
  const promise = require("promise");
  const {InspectorFront} = require("devtools/shared/fronts/inspector");
  const {WalkerSearch, WalkerIndex} =
    require("devtools/server/actors/utils/walker-search");
  const {console} = Cu.import("resource://gre/modules/Console.jsm", {});

  SimpleTest.waitForExplicitFinish();

  let walkerActor = null;
  let walkerSearch = null;
  let inspectee = null;
  let inspector = null;

  // WalkerSearch specific tests.  This is to make sure search results are
  // coming back as expected.
  // See also test_inspector-search-front.html.

  addAsyncTest(function* setup() {
    info ("Setting up inspector and walker actors.");

    let url = document.getElementById("inspectorContent").href;

    yield new promise(resolve => {
      attachURL(url, function(err, client, tab, doc) {
        inspectee = doc;
        inspector = InspectorFront(client, tab);
        resolve();
      });
    });

    let walkerFront = yield inspector.getWalker();
    ok(walkerFront, "getWalker() should return an actor.");

    walkerActor = DebuggerServer._searchAllConnectionsForActor(walkerFront.actorID);
    ok(walkerActor,
      "Got a reference to the walker actor (" + walkerFront.actorID + ")");

    walkerSearch = walkerActor.walkerSearch;

    runNextTest();
  });

  addAsyncTest(function* testIndexExists() {
    info ("Testing basic index APIs exist.");

    let index = new WalkerIndex(walkerActor);
    ok(index.data.size > 0, "public index is filled after getting");

    index.clearIndex();
    ok(!index._data, "private index is empty after clearing");
    ok(index.data.size > 0, "public index is filled after getting");

    index.destroy();
    runNextTest();
  });

  addAsyncTest(function* testSearchExists() {
    info ("Testing basic search APIs exist.");

    ok(walkerSearch, "walker search exists on the WalkerActor");
    ok(walkerSearch.search, "walker search has `search` method");
    ok(walkerSearch.index, "walker search has `index` property");
    is(walkerSearch.walker, walkerActor, "referencing the correct WalkerActor");

    let search = new WalkerSearch(walkerActor);
    ok(search, "a new search instance can be created");
    ok(search.search, "new search instance has `search` method");
    ok(search.index, "new search instance has `index` property");
    isnot(search, walkerSearch, "new search instance differs from the WalkerActor's");

    search.destroy();
    runNextTest();
  });

  addAsyncTest(function* testEmptySearch() {
    info ("Testing search with an empty query.");
    results = walkerSearch.search("");
    is(results.length, 0, "No results when searching for ''");

    results = walkerSearch.search(null);
    is(results.length, 0, "No results when searching for null");

    results = walkerSearch.search(undefined);
    is(results.length, 0, "No results when searching for undefined");

    results = walkerSearch.search(10);
    is(results.length, 0, "No results when searching for 10");

    runNextTest();
  });

  addAsyncTest(function* testBasicSearchData() {
    let testData = [
    {
      desc: "Search for tag with one result.",
      search: "body",
      expected: [
        {node: inspectee.body, type: "tag"}
      ]
    },
    {
      desc: "Search for tag with multiple results",
      search: "h2",
      expected: [
        {node: inspectee.querySelectorAll("h2")[0], type: "tag"},
        {node: inspectee.querySelectorAll("h2")[1], type: "tag"},
        {node: inspectee.querySelectorAll("h2")[2], type: "tag"},
      ]
    },
    {
      desc: "Search for selector with multiple results",
      search: "body > h2",
      expected: [
        {node: inspectee.querySelectorAll("h2")[0], type: "selector"},
        {node: inspectee.querySelectorAll("h2")[1], type: "selector"},
        {node: inspectee.querySelectorAll("h2")[2], type: "selector"},
      ]
    },
    {
      desc: "Search for selector with multiple results",
      search: ":root h2",
      expected: [
        {node: inspectee.querySelectorAll("h2")[0], type: "selector"},
        {node: inspectee.querySelectorAll("h2")[1], type: "selector"},
        {node: inspectee.querySelectorAll("h2")[2], type: "selector"},
      ]
    },
    {
      desc: "Search for selector with multiple results",
      search: "* h2",
      expected: [
        {node: inspectee.querySelectorAll("h2")[0], type: "selector"},
        {node: inspectee.querySelectorAll("h2")[1], type: "selector"},
        {node: inspectee.querySelectorAll("h2")[2], type: "selector"},
      ]
    },
    {
      desc: "Search with multiple matches in a single tag expecting a single result",
      search: "💩",
      expected: [
        {node: inspectee.getElementById("💩"), type: "attributeValue"}
      ]
    },
    {
      desc: "Search that has tag and text results",
      search: "h1",
      expected: [
        {node: inspectee.querySelector("h1"), type: "tag"},
        {node: inspectee.querySelector("h1 + p").childNodes[0], type: "text"},
        {node: inspectee.querySelector("h1 + p > strong").childNodes[0], type: "text"},
      ]
    },
    ]

    for (let {desc, search, expected} of testData) {
      info("Running test: " + desc);
      let results = walkerSearch.search(search);
      isDeeply(results, expected,
        "Search returns correct results with '" + search + "'");
    }

    runNextTest();
  });

  addAsyncTest(function* testPseudoElements() {
    info ("Testing ::before and ::after element matching");

    let beforeElt = new _documentWalker(inspectee.querySelector("#pseudo"),
                                        inspectee.defaultView).firstChild();
    let afterElt = new _documentWalker(inspectee.querySelector("#pseudo"),
                                       inspectee.defaultView).lastChild();
    let styleText = inspectee.querySelector("style").childNodes[0];

    // ::before
    let results = walkerSearch.search("::before");
    isDeeply(results, [ {node: beforeElt, type: "tag"} ],
             "Tag search works for pseudo element");

    results = walkerSearch.search("_moz_generated_content_before");
    is(results.length, 0, "No results for anon tag name");

    results = walkerSearch.search("before element");
    isDeeply(results, [
      {node: styleText, type: "text"},
      {node: beforeElt, type: "text"}
    ], "Text search works for pseudo element");

    // ::after
    results = walkerSearch.search("::after");
    isDeeply(results, [ {node: afterElt, type: "tag"} ],
             "Tag search works for pseudo element");

    results = walkerSearch.search("_moz_generated_content_after");
    is(results.length, 0, "No results for anon tag name");

    results = walkerSearch.search("after element");
    isDeeply(results, [
      {node: styleText, type: "text"},
      {node: afterElt, type: "text"}
    ], "Text search works for pseudo element");

    runNextTest();
  });

  addAsyncTest(function* testSearchMutationChangeResults() {
    info ("Testing search before and after a mutation.");
    let expected = [
      {node: inspectee.querySelectorAll("h3")[0], type: "tag"},
      {node: inspectee.querySelectorAll("h3")[1], type: "tag"},
      {node: inspectee.querySelectorAll("h3")[2], type: "tag"},
    ];

    let results = walkerSearch.search("h3");
    isDeeply(results, expected, "Search works with tag results");

    yield mutateDocumentAndWaitForMutation(() => {
      expected[0].node.remove();
    });

    results = walkerSearch.search("h3");
    isDeeply(results, [
      expected[1],
      expected[2]
    ], "Results are updated after removal");

    yield new promise(resolve => {
      info("Waiting for a mutation to happen");
      let observer = new inspectee.defaultView.MutationObserver(() => {
        resolve();
      });
      observer.observe(inspectee, {attributes: true, subtree: true});
      inspectee.body.setAttribute("h3", "true");
    });

    results = walkerSearch.search("h3");
    isDeeply(results, [
      {node: inspectee.body, type: "attributeName"},
      expected[1],
      expected[2]
    ], "Results are updated after addition");

    yield new promise(resolve => {
      info("Waiting for a mutation to happen");
      let observer = new inspectee.defaultView.MutationObserver(() => {
        resolve();
      });
      observer.observe(inspectee, {attributes: true, childList: true, subtree: true});
      inspectee.body.removeAttribute("h3");
      expected[1].node.remove();
      expected[2].node.remove();
    });

    results = walkerSearch.search("h3");
    is(results.length, 0, "Results are updated after removal");

    runNextTest();
  });

  runNextTest();

  function mutateDocumentAndWaitForMutation(mutationFn) {
    return new promise(resolve => {
      info("Listening to markup mutation on the inspectee");
      let observer = new inspectee.defaultView.MutationObserver(resolve);
      observer.observe(inspectee, {childList: true, subtree: true});
      mutationFn();
    });
  }
};
  </script>
</head>
<body>
<a id="inspectorContent" target="_blank" href="inspector-search-data.html">Test Document</a>
<p id="display"></p>
<div id="content" style="display: none">

</div>
<pre id="test">
</pre>
</body>
</html>