browser_net_ws-json-payload.js

Enable keyboard shortcuts

/* Any copyright is dedicated to the Public Domain.

   http://creativecommons.org/publicdomain/zero/1.0/ */

"use strict";

/**

 * Test that WebSocket payloads containing a basic JSON message is parsed

 * correctly and displayed in a user friendly way

*/

add_task(async function () {

  const { tab, monitor } = await initNetMonitor(WS_PAGE_URL, {

    requestCount: 1,

});

  info("Starting test... ");

  const { document, store, windowRequire } = monitor.panelWin;

  const Actions = windowRequire("devtools/client/netmonitor/src/actions/index");

  store.dispatch(Actions.batchEnable(false));

  // Wait for WS connections to be established + send messages

  const onNetworkEvents = waitForNetworkEvents(monitor, 1);

  await SpecialPowers.spawn(tab.linkedBrowser, [], async () => {

    await content.wrappedJSObject.openConnection(0);

    content.wrappedJSObject.sendData(

      `{\"foo\":{\"x\":1,\"y\":2}, \"bar\":{\"x\":1,\"y\":2}}`

);

});

  await onNetworkEvents;

  const requests = document.querySelectorAll(".request-list-item");

  is(requests.length, 1, "There should be one request");

  // Wait for all sent/received messages to be displayed in DevTools

  let wait = waitForDOM(

    document,

    "#messages-view .message-list-table .message-list-item",

);

  // Select the first request

  EventUtils.sendMouseEvent({ type: "mousedown" }, requests[0]);

  // Click on the "Response" panel

  await clickOnSidebarTab(document, "response");

  await wait;

  // Get all messages present in the "Response" panel

  const frames = document.querySelectorAll(

    "#messages-view .message-list-table .message-list-item"

);

  // Check expected results

  is(frames.length, 2, "There should be two frames");

  // Wait for next tick to do async stuff (The MessagePayload component uses the async function getMessagePayload)

  await waitForTick();

  const waitForData = waitForDOM(document, "#messages-view .properties-view");

  const [requestFrame] = frames;

  EventUtils.sendMouseEvent({ type: "mousedown" }, requestFrame);

  await waitForData;

is(

    document.querySelector("#messages-view .data-label").innerText,

    "JSON",

    "The JSON payload panel should be displayed"

);

ok(

    document.querySelector("#messages-view .treeTable"),

    "A tree table should be used to display the formatted payload"

);

  ok(document.getElementById("/foo"), "The 'foo' property should be displayed");

ok(

    document.getElementById("/foo/x"),

    "The 'x' property in the `foo` object should be displayed"

);

ok(

    document.getElementById("/bar/y"),

    "The 'y' property in the `bar` object should be displayed"

);

  // Toggle raw data display

  wait = waitForDOM(document, "#messages-view .message-rawData-payload");

  const rawDataToggle = document.querySelector(

    "#messages-view .devtools-checkbox-toggle"

);

  clickElement(rawDataToggle, monitor);

  await wait;

is(

    document.querySelector("#messages-view .data-label").innerText,

    "Raw Data (42 B)",

    "The raw data payload info should be displayed"

);

is(

    document.querySelector("#messages-view .message-rawData-payload").value,

    `{\"foo\":{\"x\":1,\"y\":2}, \"bar\":{\"x\":1,\"y\":2}}`,

    "The raw data must be shown correctly"

);

  // Close WS connection

  await SpecialPowers.spawn(tab.linkedBrowser, [], async () => {

    await content.wrappedJSObject.closeConnection();

});

  await teardown(monitor);

});