summaryrefslogtreecommitdiffstats
path: root/browser/components/extensions/test/browser/browser_ext_devtools_inspectedWindow_eval_bindings.js
blob: f85660c813d0dfc6bb73a198c608867047d7cd62 (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
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
"use strict";

loadTestSubscript("head_devtools.js");

const BASE_URL =
  "http://mochi.test:8888/browser/browser/components/extensions/test/browser/";

/**
 * this test file ensures that:
 *
 * - devtools.inspectedWindow.eval provides the expected $0 and inspect bindings
 */
add_task(async function test_devtools_inspectedWindow_eval_bindings() {
  const TEST_TARGET_URL = `${BASE_URL}/file_inspectedwindow_eval.html`;

  let tab = await BrowserTestUtils.openNewForegroundTab(
    gBrowser,
    TEST_TARGET_URL
  );

  function devtools_page() {
    browser.test.onMessage.addListener(async (msg, ...args) => {
      if (msg !== "inspectedWindow-eval-request") {
        browser.test.fail(`Unexpected test message received: ${msg}`);
        return;
      }

      try {
        const [evalResult, errorResult] =
          await browser.devtools.inspectedWindow.eval(...args);
        browser.test.sendMessage("inspectedWindow-eval-result", {
          evalResult,
          errorResult,
        });
      } catch (err) {
        browser.test.sendMessage("inspectedWindow-eval-result");
        browser.test.fail(`Error: ${err} :: ${err.stack}`);
      }
    });
    browser.test.sendMessage("devtools-page-loaded");
  }

  let extension = ExtensionTestUtils.loadExtension({
    manifest: {
      devtools_page: "devtools_page.html",
    },
    files: {
      "devtools_page.html": `<!DOCTYPE html>
      <html>
       <head>
         <meta charset="utf-8">
         <script text="text/javascript" src="devtools_page.js"></script>
       </head>
       <body>
       </body>
      </html>`,
      "devtools_page.js": devtools_page,
    },
  });

  await extension.startup();

  const toolbox = await openToolboxForTab(tab);
  await extension.awaitMessage("devtools-page-loaded");

  // Test $0 binding with no selected node
  info("Test inspectedWindow.eval $0 binding with no selected node");

  const evalNoSelectedNodePromise = extension.awaitMessage(
    `inspectedWindow-eval-result`
  );
  extension.sendMessage(`inspectedWindow-eval-request`, "$0");
  const evalNoSelectedNodeResult = await evalNoSelectedNodePromise;

  Assert.deepEqual(
    evalNoSelectedNodeResult,
    { evalResult: undefined, errorResult: undefined },
    "Got the expected eval result"
  );

  // Test $0 binding with a selected node in the inspector.

  await openToolboxForTab(tab, "inspector");

  info(
    "Test inspectedWindow.eval $0 binding with a selected node in the inspector"
  );

  const evalSelectedNodePromise = extension.awaitMessage(
    `inspectedWindow-eval-result`
  );
  extension.sendMessage(`inspectedWindow-eval-request`, "$0 && $0.tagName");
  const evalSelectedNodeResult = await evalSelectedNodePromise;

  Assert.deepEqual(
    evalSelectedNodeResult,
    { evalResult: "BODY", errorResult: undefined },
    "Got the expected eval result"
  );

  // Test that inspect($0) switch the developer toolbox to the inspector.

  await openToolboxForTab(tab, TOOLBOX_BLANK_PANEL_ID);

  const inspectorPanelSelectedPromise = (async () => {
    const toolId = await toolbox.once("select");

    if (toolId === "inspector") {
      info("Toolbox has been switched to the inspector as expected");
      const selectedNodeName =
        toolbox.selection.nodeFront &&
        toolbox.selection.nodeFront._form.nodeName;
      is(
        selectedNodeName,
        "A",
        "The expected DOM node has been selected in the inspector"
      );
    } else {
      throw new Error(
        `inspector panel expected, ${toolId} has been selected instead`
      );
    }
  })();

  info("Test inspectedWindow.eval inspect() binding called for a DOM element");
  extension.sendMessage(
    `inspectedWindow-eval-request`,
    "inspect(document.querySelector('a#link-to-inspect'))"
  );
  await extension.awaitMessage(`inspectedWindow-eval-result`);

  info(
    "Wait for the toolbox to switch to the inspector and the expected node has been selected"
  );
  await inspectorPanelSelectedPromise;

  function expectedSourceSelected(sourceFilename, sourceLine) {
    return () => {
      const dbg = toolbox.getPanel("jsdebugger");
      const selectedLocation = dbg._selectors.getSelectedLocation(
        dbg._getState()
      );

      if (!selectedLocation) {
        return false;
      }

      return (
        selectedLocation.sourceId.includes(sourceFilename) &&
        selectedLocation.line == sourceLine
      );
    };
  }

  info("Test inspectedWindow.eval inspect() binding called for a function");

  const debuggerPanelSelectedPromise = (async () => {
    const toolId = await toolbox.once("select");

    if (toolId === "jsdebugger") {
      info("Toolbox has been switched to the jsdebugger as expected");
    } else {
      throw new Error(
        `jsdebugger panel expected, ${toolId} has been selected instead`
      );
    }
  })();

  extension.sendMessage(
    `inspectedWindow-eval-request`,
    "inspect(test_inspect_function)"
  );
  await extension.awaitMessage(`inspectedWindow-eval-result`);
  await debuggerPanelSelectedPromise;

  await BrowserTestUtils.waitForCondition(
    expectedSourceSelected("file_inspectedwindow_eval.html", 9),
    "Wait the expected function to be selected in the jsdebugger panel"
  );

  info("Test inspectedWindow.eval inspect() bound function");

  extension.sendMessage(
    `inspectedWindow-eval-request`,
    "inspect(test_bound_function)"
  );
  await extension.awaitMessage(`inspectedWindow-eval-result`);

  await BrowserTestUtils.waitForCondition(
    expectedSourceSelected("file_inspectedwindow_eval.html", 15),
    "Wait the expected function to be selected in the jsdebugger panel"
  );

  info("Test inspectedWindow.eval inspect() binding called for a JS object");

  const splitPanelOpenedPromise = (async () => {
    await toolbox.once("split-console");
    const { hud } = toolbox.getPanel("webconsole");

    // Wait for the message to appear on the console.
    const messageNode = await new Promise(resolve => {
      hud.ui.on("new-messages", function onThisMessage(messages) {
        for (let m of messages) {
          resolve(m.node);
          hud.ui.off("new-messages", onThisMessage);
          return;
        }
      });
    });
    let objectInspectors = [...messageNode.querySelectorAll(".tree")];
    is(
      objectInspectors.length,
      1,
      "There is the expected number of object inspectors"
    );

    // We need to wait for the object to be expanded so we don't call the server on a closed connection.
    const [oi] = objectInspectors;
    let nodes = oi.querySelectorAll(".node");

    ok(nodes.length >= 1, "The object preview is rendered as expected");

    // The tree can still be collapsed since the properties are fetched asynchronously.
    if (nodes.length === 1) {
      info("Waiting for the object properties to be displayed");
      // If this is the case, we wait for the properties to be fetched and displayed.
      await new Promise(resolve => {
        const observer = new MutationObserver(mutations => {
          resolve();
          observer.disconnect();
        });
        observer.observe(oi, { childList: true });
      });

      // Retrieve the new nodes.
      nodes = oi.querySelectorAll(".node");
    }

    // We should have 3 nodes :
    //   ▼ Object { testkey: "testvalue" }
    //   |  testkey: "testvalue"
    //   |  ▶︎ __proto__: Object { … }
    is(nodes.length, 3, "The object preview has the expected number of nodes");
  })();

  const inspectJSObjectPromise = extension.awaitMessage(
    `inspectedWindow-eval-result`
  );
  extension.sendMessage(
    `inspectedWindow-eval-request`,
    "inspect({testkey: 'testvalue'})"
  );
  await inspectJSObjectPromise;

  info("Wait for the split console to be opened and the JS object inspected");
  await splitPanelOpenedPromise;
  info("Split console has been opened as expected");

  await closeToolboxForTab(tab);

  await extension.unload();

  BrowserTestUtils.removeTab(tab);
});