Bug 1794974: Part 7: Add caching granularity tests, r=Jamie

This revision implements the caching granularity tests. To do this, first it
adds some infrastructure to the accessibleTask function that allows a user of
addAccessibleTask to specify cache domains for the test. If they don't specify
cache domains, all domains are enabled. This way, existing mochitests and browser
tests can keep working with no modifications.

This revision adds utility functions for verifying the absence and presence of a
cache key, with a query function that pokes an accessible like an AT would in
order to trigger caching some domain.

Finally, this revision adds tests for every cache key in every cache domain. The
structure of the tests are: verify the attribute isn't cached (if possible),
then poke the acc like an AT to trigger caching, then verify the attribute has
been cached.

Differential Revision: https://phabricator.services.mozilla.com/D220041

Author: Nathan LaPre

accessible/moz.build

@@ -37,6 +37,7 @@ BROWSER_CHROME_MANIFESTS += [
     "tests/browser/atk/browser.toml",
     "tests/browser/bounds/browser.toml",
     "tests/browser/browser.toml",
+    "tests/browser/caching_granularity/browser.toml",
     "tests/browser/e10s/browser.toml",
     "tests/browser/events/browser.toml",
     "tests/browser/fission/browser.toml",

accessible/tests/browser/caching_granularity/browser.toml

@@ -0,0 +1,47 @@
+[DEFAULT]
+subsuite = "a11y"
+support-files = [
+  "head.js",
+  "!/accessible/tests/browser/shared-head.js",
+  "!/accessible/tests/mochitest/*.js",
+  "!/accessible/tests/mochitest/letters.gif",
+]
+
+["browser_actions_domain.js"]
+
+["browser_aria_domain.js"]
+
+["browser_bounds_domain.js"]
+
+["browser_dom_node_id_and_class_domain.js"]
+
+["browser_initial_caching.js"]
+
+["browser_inner_html_caching.js"]
+skip-if = ["os != 'win'"]
+
+["browser_name_and_description_domain.js"]
+
+["browser_relations_domain_1.js"]
+
+["browser_relations_domain_2.js"]
+
+["browser_scroll_position_domain.js"]
+
+["browser_text_offset_attributes_domain.js"]
+
+["browser_state_domain.js"]
+
+["browser_style_domain.js"]
+
+["browser_table_domain.js"]
+
+["browser_text_bounds_domain.js"]
+
+["browser_text_domain.js"]
+
+["browser_transform_matrix_domain.js"]
+
+["browser_value_domain.js"]
+
+["browser_viewport_domain.js"]

accessible/tests/browser/caching_granularity/browser_actions_domain.js

@@ -0,0 +1,56 @@
+/* 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";
+
+// CacheKey::AccessKey, CacheDomain::Actions
+addAccessibleTask(
+  `<div id="test" accesskey="x">test</div>`,
+  async function (browser, docAcc) {
+    let acc = findAccessibleChildByID(docAcc, "test");
+    await testAttributeCachePresence(acc, "accesskey", () => {
+      acc.accessKey;
+    });
+  },
+  {
+    topLevel: true,
+    iframe: false, // AccessKey issues with iframe - See Bug 1796846
+    remoteIframe: true,
+    cacheDomains: CacheDomain.None,
+  }
+);
+
+// CacheKey::HasLongdesc, CacheDomain::Actions
+addAccessibleTask(
+  `<img id="test" src="http://example.com/a11y/accessible/tests/mochitest/moz.png" longdesc="http://example.com">`,
+  async function (browser, docAcc) {
+    let acc = findAccessibleChildByID(docAcc, "test");
+    await testAttributeCachePresence(acc, "longdesc", () => {
+      acc.actionCount;
+    });
+  },
+  {
+    topLevel: true,
+    iframe: true,
+    remoteIframe: true,
+    cacheDomains: CacheDomain.None,
+  }
+);
+
+// CacheKey::PrimaryAction, CacheDomain::Actions
+addAccessibleTask(
+  `<button id="test" onclick="console.log('test');">test</button>`,
+  async function (browser, docAcc) {
+    let acc = findAccessibleChildByID(docAcc, "test");
+    await testAttributeCachePresence(acc, "action", () => {
+      acc.actionCount;
+    });
+  },
+  {
+    topLevel: true,
+    iframe: true,
+    remoteIframe: true,
+    cacheDomains: CacheDomain.None,
+  }
+);

accessible/tests/browser/caching_granularity/browser_aria_domain.js

@@ -0,0 +1,22 @@
+/* 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";
+
+// CacheKey::ARIAAttributes, CacheDomain::ARIA
+addAccessibleTask(
+  `<div id="test" aria-live="polite">test</div>`,
+  async function (browser, docAcc) {
+    let acc = findAccessibleChildByID(docAcc, "test");
+    await testAttributeCachePresence(acc, "aria", () => {
+      acc.attributes;
+    });
+  },
+  {
+    topLevel: true,
+    iframe: true,
+    remoteIframe: true,
+    cacheDomains: CacheDomain.None,
+  }
+);

accessible/tests/browser/caching_granularity/browser_bounds_domain.js

@@ -0,0 +1,67 @@
+/* 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";
+
+// CacheDomain::Bounds, CacheKey::CrossDocOffset
+addAccessibleTask(
+  `<div id="test">test</div>`,
+  async function (browser, _, docAcc) {
+    // Translate the iframe, which should modify cross-process offset.
+    info("Setting the transform on the iframe");
+    await SpecialPowers.spawn(browser, [DEFAULT_IFRAME_ID], iframeID => {
+      let elm = content.document.getElementById(iframeID);
+      elm.style.transform = "translate(100px,100px)";
+    });
+    await waitForContentPaint(browser);
+
+    let acc = findAccessibleChildByID(docAcc, DEFAULT_IFRAME_ID);
+    await testAttributeCachePresence(acc, "crossorigin", () => {
+      // Querying bounds queries the CrossDocOffset info.
+      acc.getBounds({}, {}, {}, {});
+    });
+  },
+  {
+    topLevel: false,
+    iframe: true,
+    remoteIframe: true,
+    cacheDomains: CacheDomain.None,
+  }
+);
+
+// CacheKey::IsClipped, CacheDomain::Bounds
+addAccessibleTask(
+  `<div id="generic"><span aria-hidden="true" id="visible">Mozilla</span><span id="invisible" style="display: block !important;border: 0 !important;clip: rect(0 0 0 0) !important;height: 1px !important;margin: -1px !important;overflow: hidden !important;padding: 0 !important;position: absolute !important;white-space: nowrap !important;width: 1px !important;">Mozilla</span><br>I am some other text</div>`,
+  async function (browser, docAcc) {
+    let acc = findAccessibleChildByID(docAcc, "invisible");
+    await testAttributeCachePresence(acc, "clip-rule", () => {
+      // Querying bounds queries the IsClipped info.
+      acc.getBounds({}, {}, {}, {});
+    });
+  },
+  {
+    topLevel: true,
+    iframe: true,
+    remoteIframe: true,
+    cacheDomains: CacheDomain.None,
+  }
+);
+
+// CacheKey::ParentRelativeBounds, CacheDomain::Bounds
+addAccessibleTask(
+  `<br><div id="test">test</div>`,
+  async function (browser, docAcc) {
+    let acc = findAccessibleChildByID(docAcc, "test");
+    await testAttributeCachePresence(acc, "relative-bounds", () => {
+      // Querying bounds queries the ParentRelativeBounds info.
+      acc.getBounds({}, {}, {}, {});
+    });
+  },
+  {
+    topLevel: true,
+    iframe: true,
+    remoteIframe: true,
+    cacheDomains: CacheDomain.None,
+  }
+);

accessible/tests/browser/caching_granularity/browser_dom_node_id_and_class_domain.js

@@ -0,0 +1,39 @@
+/* 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";
+
+// NOTE: These aren't testable easily because the DOMNodeIDAndClass domain is
+// required in order to instantiate an accessible task. So, we test only that
+// the attributes are present in the cache as expected.
+
+// CacheKey::DOMNodeClass, CacheDomain::DOMNodeIDAndClass
+addAccessibleTask(
+  `<div id="test" class="test">test</div>`,
+  async function (browser, docAcc) {
+    let acc = findAccessibleChildByID(docAcc, "test");
+    verifyAttributeCachedNoRetry(acc, "class");
+  },
+  {
+    topLevel: true,
+    iframe: true,
+    remoteIframe: true,
+    cacheDomains: CacheDomain.DOMNodeIDAndClass,
+  }
+);
+
+// CacheKey::DOMNodeID, CacheDomain::DOMNodeIDAndClass
+addAccessibleTask(
+  `<div id="test" class="test">test</div>`,
+  async function (browser, docAcc) {
+    let acc = findAccessibleChildByID(docAcc, "test");
+    verifyAttributeCachedNoRetry(acc, "id");
+  },
+  {
+    topLevel: true,
+    iframe: true,
+    remoteIframe: true,
+    cacheDomains: CacheDomain.DOMNodeIDAndClass,
+  }
+);

accessible/tests/browser/caching_granularity/browser_initial_caching.js

@@ -0,0 +1,83 @@
+/* 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";
+
+// CacheKey::InputType, no cache domain
+addAccessibleTask(
+  `<input id="test" type="search"/>`,
+  async function (browser, docAcc) {
+    let acc = findAccessibleChildByID(docAcc, "test");
+    await verifyAttributeCachedNoRetry(acc, "text-input-type");
+  },
+  {
+    topLevel: true,
+    iframe: true,
+    remoteIframe: true,
+    cacheDomains: CacheDomain.None,
+  }
+);
+
+// CacheKey::MimeType, no cache domain
+addAccessibleTask(
+  ``,
+  async function (browser, docAcc) {
+    await verifyAttributeCachedNoRetry(docAcc, "content-type");
+  },
+  {
+    topLevel: true,
+    iframe: true,
+    remoteIframe: true,
+    cacheDomains: CacheDomain.None,
+  }
+);
+
+// CacheKey::PopupType, no cache domain
+addAccessibleTask(
+  `<div popover id="test">test</div>`,
+  async function (browser, _) {
+    info("Showing popover");
+    let shown = waitForEvent(EVENT_SHOW, "test");
+    await invokeContentTask(browser, [], () => {
+      content.document.getElementById("test").showPopover();
+    });
+    let popover = (await shown).accessible;
+    await verifyAttributeCachedNoRetry(popover, "ispopup");
+  },
+  {
+    topLevel: true,
+    iframe: true,
+    remoteIframe: true,
+    cacheDomains: CacheDomain.None,
+  }
+);
+
+// CacheKey::TagName, no cache domain
+addAccessibleTask(
+  ``,
+  async function (browser, docAcc) {
+    await verifyAttributeCachedNoRetry(docAcc, "tag");
+  },
+  {
+    topLevel: true,
+    iframe: true,
+    remoteIframe: true,
+    cacheDomains: CacheDomain.None,
+  }
+);
+
+// CacheKey::ARIARole, no cache domain
+addAccessibleTask(
+  `<div id="test" role="invalid-role">test</div>`,
+  async function (browser, docAcc) {
+    let acc = findAccessibleChildByID(docAcc, "test");
+    await verifyAttributeCachedNoRetry(acc, "role");
+  },
+  {
+    topLevel: true,
+    iframe: true,
+    remoteIframe: true,
+    cacheDomains: CacheDomain.None,
+  }
+);

accessible/tests/browser/caching_granularity/browser_inner_html_caching.js

@@ -0,0 +1,22 @@
+/* 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";
+
+// CacheKey::InnerHTML, CacheDomain::InnerHTML
+addAccessibleTask(
+  `<math id="test"><mfrac><mi>x</mi><mi>y</mi></mfrac></math>`,
+  async function (browser, docAcc) {
+    let acc = findAccessibleChildByID(docAcc, "test");
+    await verifyAttributeCachedNoRetry(acc, "html");
+  },
+  {
+    topLevel: true,
+    iframe: true,
+    remoteIframe: true,
+    // Entire test runs with domain already active because there's no XPC method
+    // to trigger caching of InnerHTML.
+    cacheDomains: CacheDomain.InnerHTML,
+  }
+);