sousa-gecko/devtools/client/storage/test/browser_storage_values.js

/* 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/. */

// Test to verify that the values shown in sidebar are correct

// Format: [
//   <id of the table item to click> or <id array for tree item to select> or
//     null do click nothing,
//   null to skip checking value in variables view or a key value pair object
//     which will be asserted to exist in the storage sidebar,
//   true if the check is to be made in the parsed value section
// ]

"use strict";

const LONG_WORD = "a".repeat(1000);

const testCases = [
  [
    getCookieId("cs2", "." + MAIN_DOMAIN, "/"),
    [
      { name: "cs2", value: "sessionCookie" },
      { name: "cs2.Path", value: "/" },
      { name: "cs2.HostOnly", value: "false" },
      { name: "cs2.HttpOnly", value: "false" },
      { name: "cs2.Domain", value: "." + MAIN_DOMAIN },
      { name: "cs2.Expires / Max-Age", value: "Session" },
      { name: "cs2.Secure", value: "false" },
    ],
  ],
  [
    getCookieId("c1", MAIN_HOST, "/browser"),
    [
      { name: "c1", value: JSON.stringify(["foo", "Bar", { foo: "Bar" }]) },
      { name: "c1.Path", value: "/browser" },
      { name: "c1.HostOnly", value: "true" },
      { name: "c1.HttpOnly", value: "false" },
      { name: "c1.Domain", value: MAIN_HOST },
      {
        name: "c1.Expires / Max-Age",
        value: new Date(2000000000000).toUTCString(),
      },
      { name: "c1.Secure", value: "false" },
    ],
  ],
  [
    null,
    [
      { name: "c1", value: "Array" },
      { name: "c1.0", value: "foo" },
      { name: "c1.1", value: "Bar" },
      { name: "c1.2", value: "Object" },
      { name: "c1.2.foo", value: "Bar" },
    ],
    true,
  ],
  [
    getCookieId(
      "c_encoded",
      MAIN_HOST,
      "/browser/devtools/client/storage/test"
    ),
    [
      {
        name: "c_encoded",
        value: encodeURIComponent(JSON.stringify({ foo: { foo1: "bar" } })),
      },
    ],
  ],
  [
    null,
    [
      { name: "c_encoded", value: "Object" },
      { name: "c_encoded.foo", value: "Object" },
      { name: "c_encoded.foo.foo1", value: "bar" },
    ],
    true,
  ],
  [["localStorage", MAIN_ORIGIN_SECURED]],
  ["ls2", [{ name: "ls2", value: "foobar-2" }]],
  [
    "ls1",
    [
      {
        name: "ls1",
        value: JSON.stringify({
          es6: "for",
          the: "win",
          baz: [
            0,
            2,
            3,
            {
              deep: "down",
              nobody: "cares",
            },
          ],
        }),
      },
    ],
  ],
  [
    null,
    [
      { name: "ls1", value: "Object" },
      { name: "ls1.es6", value: "for" },
      { name: "ls1.the", value: "win" },
      { name: "ls1.baz", value: "Array" },
      { name: "ls1.baz.0", value: "0" },
      { name: "ls1.baz.1", value: "2" },
      { name: "ls1.baz.2", value: "3" },
      { name: "ls1.baz.3", value: "Object" },
      { name: "ls1.baz.3.deep", value: "down" },
      { name: "ls1.baz.3.nobody", value: "cares" },
    ],
    true,
  ],
  ["ls3", [{ name: "ls3", value: "http://foobar.com/baz.php" }]],
  [
    null,
    [{ name: "ls3", value: "http://foobar.com/baz.php", dontMatch: true }],
    true,
  ],
  ["ls4", [{ name: "ls4", value: "0x1" }], false],
  // Test case from bug 1173701, test coverage for bug 1260382:
  [
    "ls5",
    [
      { name: "ls5", value: "Object" },
      { name: "ls5.a", value: 1 },
      { name: "ls5.b", value: 2 },
      { name: "ls5.c", value: 3 },
    ],
    true,
  ],
  [["sessionStorage", MAIN_ORIGIN_SECURED]],
  ["ss1", [{ name: "ss1", value: "This#is#an#array" }]],
  [
    null,
    [
      { name: "ss1", value: "Array" },
      { name: "ss1.0", value: "This" },
      { name: "ss1.1", value: "is" },
      { name: "ss1.2", value: "an" },
      { name: "ss1.3", value: "array" },
    ],
    true,
  ],
  [
    "ss2",
    [
      { name: "ss2", value: "Array" },
      { name: "ss2.0", value: "This" },
      { name: "ss2.1", value: "is" },
      { name: "ss2.2", value: "another" },
      { name: "ss2.3", value: "array" },
    ],
    true,
  ],
  [
    "ss3",
    [
      { name: "ss3", value: "Object" },
      { name: "ss3.this", value: "is" },
      { name: "ss3.an", value: "object" },
      { name: "ss3.foo", value: "bar" },
    ],
    true,
  ],
  [
    "ss4",
    [
      { name: "ss4", value: "Array" },
      { name: "ss4.0", value: "" },
      { name: "ss4.1", value: "array" },
      { name: "ss4.2", value: "" },
      { name: "ss4.3", value: "with" },
      { name: "ss4.4", value: "empty" },
      { name: "ss4.5", value: "items" },
    ],
    true,
  ],
  [
    "ss5",
    [
      { name: "ss5", value: "Array" },
      { name: "ss5.0", value: LONG_WORD },
      { name: "ss5.1", value: LONG_WORD },
      { name: "ss5.2", value: LONG_WORD },
      { name: "ss5.3", value: `${LONG_WORD}&${LONG_WORD}` },
      { name: "ss5.4", value: `${LONG_WORD}&${LONG_WORD}` },
    ],
    true,
  ],
  [["indexedDB", MAIN_ORIGIN_SECURED, "idb1 (default)", "obj1"]],
  [
    1,
    [
      {
        name: 1,
        value: JSON.stringify({ id: 1, name: "foo", email: "foo@bar.com" }),
      },
    ],
  ],
  [
    null,
    [
      { name: "1.id", value: "1" },
      { name: "1.name", value: "foo" },
      { name: "1.email", value: "foo@bar.com" },
    ],
    true,
  ],
  [["indexedDB", MAIN_ORIGIN_SECURED, "idb1 (default)", "obj2"]],
  [
    1,
    [
      {
        name: 1,
        value: JSON.stringify({
          id2: 1,
          name: "foo",
          email: "foo@bar.com",
          extra: "baz".repeat(10000),
        }),
      },
    ],
  ],
  [
    null,
    [
      { name: "1.id2", value: "1" },
      { name: "1.name", value: "foo" },
      { name: "1.email", value: "foo@bar.com" },
      { name: "1.extra", value: "baz".repeat(10000) },
    ],
    true,
  ],
];

add_task(async function () {
  await SpecialPowers.pushPrefEnv({
    set: [["network.cookie.maxageCap", 0]],
  });

  await openTabAndSetupStorage(
    MAIN_URL_SECURED + "storage-complex-values.html"
  );

  gUI.tree.expandAll();

  for (const item of testCases) {
    info("clicking for item " + item);
    const [path, ruleArray, parsed] = item;
    const start = performance.now();

    if (Array.isArray(path)) {
      await selectTreeItem(path);
      continue;
    } else if (path) {
      await selectTableItem(path);
    }

    // Parsing "0x1" used to be very slow and memory intensive.
    // Check that each test case completes in less than 15000ms.
    const time = performance.now() - start;
    Assert.less(
      time,
      15000,
      `item ${item} completed in less than 15000ms ${time}`
    );

    await findVariableViewProperties(ruleArray, parsed);
  }

  info(
    `Check that the "Copy" context menu entry in the VariableView works as expected`
  );
  await selectTreeItem(["cookies", MAIN_ORIGIN_SECURED]);
  await selectTableItem(getCookieId("cs2", "." + MAIN_DOMAIN, "/"));

  const contextMenu = gPanelWindow.document.querySelector(
    "#variable-view-popup"
  );
  const contextMenuCopyItem = contextMenu.querySelector(
    "#variable-view-popup-copy"
  );

  const variableViewRootNodeValueEl = await waitFor(() => {
    const el = gUI.sidebar.querySelector("label.value.token-string");
    if (!el || el.value !== `"sessionCookie"`) {
      return false;
    }

    return el;
  });

  // Focus the row so the context menu is enabled
  variableViewRootNodeValueEl.closest(".variable-or-property").focus();

  const onContextMenuShown = once(contextMenu, "popupshown");
  synthesizeContextMenuEvent(variableViewRootNodeValueEl);
  await onContextMenuShown;
  ok(true, "Context menu is shown");

  info("Click on the Copy entry");
  await waitForClipboardPromise(
    () => contextMenuCopyItem.click(),
    `cs2:"sessionCookie"`
  );

  info("Close context menu");
  const onContextMenuHidden = once(contextMenu, "popuphidden");
  DevToolsUtils.executeSoon(() => contextMenu.hidePopup());
  await onContextMenuHidden;
});