fune/netwerk/test/browser/browser_opaque_response_blocking_telemetry.js

/* vim:set ts=2 sw=2 sts=2 et: */
/* 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";

const DIRPATH = getRootDirectory(gTestPath).replace(
  "chrome://mochitests/content/",
  ""
);

const ORIGIN1 = "https://example.com";
const URL = `${ORIGIN1}/${DIRPATH}dummy.html`;

// Cross origin urls.
const ORIGIN2 = "https://example.org";
const SAFE_LISTED_URL = `${ORIGIN2}/${DIRPATH}res.css`;
const BLOCKED_LISTED_NEVER_SNIFFED_URL = `${ORIGIN2}/${DIRPATH}res.csv`;
const BLOCKED_LISTED_206_URL = `${ORIGIN2}/${DIRPATH}res_206.html`;
const BLOCKED_LISTED_NOSNIFF_URL = `${ORIGIN2}/${DIRPATH}res_nosniff.html`;
const IMAGE_URL = `${ORIGIN2}/${DIRPATH}res_img.png`;
const NOSNIFF_URL = `${ORIGIN2}/${DIRPATH}res_nosniff2.html`;
const NOT_OK_URL = `${ORIGIN2}/${DIRPATH}res_not_ok.html`;
const UNKNOWN_URL = `${ORIGIN2}/${DIRPATH}res.unknown`;
const IMAGE_UNKNOWN_URL = `${ORIGIN2}/${DIRPATH}res_img_unknown.png`;
const MEDIA_URL = `${ORIGIN2}/${DIRPATH}res.mp3`;
const MEDIA_206_URL = `${ORIGIN2}/${DIRPATH}res_206.mp3`;
const MEDIA_INVALID_PARTIAL_URL = `${ORIGIN2}/${DIRPATH}res_invalid_partial.mp3`;
const MEDIA_NOT_200OR206_URL = `${ORIGIN2}/${DIRPATH}res_not_200or206.mp3`;
const IMAGE_UNKNOWN_DECOEDER_URL = `${ORIGIN2}/${DIRPATH}res_img_for_unknown_decoder`;
const SUBDOCUMENT_URL = `${ORIGIN2}/${DIRPATH}/res_sub_document.html`;
const OBJECT_URL = `${ORIGIN2}/${DIRPATH}/res_object.html`;

add_task(async function() {
  await SpecialPowers.pushPrefEnv({
    set: [["browser.opaqueResponseBlocking", true]],
  });
  let histogram = Services.telemetry.getKeyedHistogramById(
    "OPAQUE_RESPONSE_BLOCKING"
  );
  const testcases = [
    {
      url: SAFE_LISTED_URL,
      key: "Allowed_SafeListed",
      shouldRecorded: true,
    },
    {
      url: BLOCKED_LISTED_NEVER_SNIFFED_URL,
      key: "Blocked_BlockListedNeverSniffed",
      shouldRecorded: true,
    },
    {
      url: BLOCKED_LISTED_206_URL,
      key: "Blocked_206AndBlockListed",
      shouldRecorded: true,
    },
    {
      url: BLOCKED_LISTED_NOSNIFF_URL,
      key: "Blocked_NosniffAndEitherBlockListedOrTextPlain",
      shouldRecorded: true,
    },
    {
      url: IMAGE_URL,
      key: "Allowed_SniffAsImageOrAudioOrVideo",
      shouldRecorded: true,
    },
    {
      url: NOSNIFF_URL,
      key: "Blocked_NoSniffHeaderAfterSniff",
      shouldRecorded: true,
    },
    {
      url: NOT_OK_URL,
      key: "Blocked_ResponseNotOk",
      shouldRecorded: true,
    },
    {
      url: UNKNOWN_URL,
      key: "Allowed_FailtoGetMIMEType",
      shouldRecorded: true,
    },
    {
      url: IMAGE_UNKNOWN_URL,
      key: "Blocked_ContentTypeBeginsWithImageOrVideoOrAudio",
      shouldRecorded: true,
    },
    {
      url: MEDIA_URL,
      key: "Allowed_SniffAsImageOrAudioOrVideo",
      shouldRecorded: true,
      loadType: "media",
    },
    {
      url: MEDIA_206_URL,
      key: "Allowed_SniffAsImageOrAudioOrVideo",
      shouldRecorded: true,
      loadType: "media",
    },
    {
      url: MEDIA_INVALID_PARTIAL_URL,
      key: "Blocked_InvaliidPartialResponse",
      shouldRecorded: true,
      loadType: "media",
    },
    {
      url: MEDIA_NOT_200OR206_URL,
      key: "Blocked_Not200Or206",
      shouldRecorded: true,
      loadType: "media",
    },
    {
      url: IMAGE_UNKNOWN_DECOEDER_URL,
      key: "Allowed_SniffAsImageOrAudioOrVideo",
      shouldRecorded: true,
    },
    {
      url: SUBDOCUMENT_URL,
      key: "Allowed_NotImplementOrPass",
      shouldRecorded: false,
      loadType: "iframe",
    },
    {
      url: IMAGE_URL,
      key: "Allowed_SniffAsImageOrAudioOrVideo",
      shouldRecorded: false,
      loadType: "object",
    },
    {
      url: OBJECT_URL,
      key: "Allowed_SniffAsImageOrAudioOrVideo",
      shouldRecorded: false,
      loadType: "object",
    },
    {
      url: IMAGE_URL,
      key: "Allowed_SniffAsImageOrAudioOrVideo",
      shouldRecorded: false,
      loadType: "embed",
    },
  ];

  for (let testcase of testcases) {
    histogram.clear();

    await BrowserTestUtils.withNewTab(URL, async function(browser) {
      BrowserTestUtils.loadURI(browser, URL);
      await BrowserTestUtils.browserLoaded(browser);

      info(`Fetching cross-origin url: ${testcase.url}.`);

      await SpecialPowers.spawn(
        browser,
        [testcase.url, testcase.loadType, testcase.iframe],
        async (url, loadType, iframe) => {
          try {
            if (loadType == "media") {
              const audio = content.document.createElement("audio");
              audio.src = url;
              content.document.body.appendChild(audio);
              audio.load();
              await new Promise(res => {
                audio.onloadedmetadata = () => {
                  audio.src = "";
                  audio.onloadedmetadata = undefined;
                  audio.load();
                  res();
                };
              });
              return;
            }
            if (loadType == "iframe") {
              const subframe = content.document.createElement("iframe");
              subframe.src = url;
              const onloadPromise = new Promise(res => {
                subframe.onload = res;
              });
              content.document.body.appendChild(subframe);
              await onloadPromise;
              content.document.body.removeChild(subframe);
              return;
            }
            if (loadType == "object") {
              const object = content.document.createElement("object");
              object.data = url;
              const onloadPromise = new Promise(res => {
                object.onload = res;
              });
              content.document.body.appendChild(object);
              await onloadPromise;
              content.document.body.removeChild(object);
              return;
            }
            if (loadType == "embed") {
              const embed = content.document.createElement("embed");
              embed.src = url;
              const onloadPromise = new Promise(res => {
                embed.onload = res;
              });
              content.document.body.appendChild(embed);
              await onloadPromise;
              content.document.body.removeChild(embed);
              return;
            }

            await content.window.fetch(url, { mode: "no-cors" });
          } catch (e) {
            /* Ignore result */
          }
        }
      );
    });

    info(`Validating if the telemetry probe has been reported.`);

    let snapshot = histogram.snapshot();
    let keys = testcase.keys;
    if (!keys) {
      keys = [testcase.key];
    }
    for (let key of keys) {
      if (testcase.shouldRecorded) {
        ok(snapshot.hasOwnProperty(key), `Should have recorded key ${key}`);
      } else {
        ok(
          !snapshot.hasOwnProperty(key),
          `Should not have recorded key ${key}`
        );
      }
    }
  }
});