Skip to content

C
coopwire-hypothesis
Switch branch/tag
  1. 27 Jul, 2021 1 commit
    • Robert Knight's avatar
      Add type information for API call methods. · 12042882
      Robert Knight authored 
      Add `/** @type {APICall<...>} */` annotations to methods in `APIService`
to specify parameter, body and return types for methods that make API calls.
The existing `APICallFunction` type was renamed to `APICall` for
brevity.

This required adding a few additional casts in other modules to assert
that certain uses of possibly-undefined fields (eg. `annotation.id`) are
safe in a particular context.
      12042882
  3. 26 Jul, 2021 12 commits
  5. 25 Jul, 2021 3 commits
    • Robert Knight's avatar
      Replace `sidebarWindow` property with `sidebar.iframe.contentWindow` · 4305f258
      Robert Knight authored 
      Rather than use a dedicated getter to expose the sidebar frame, it
seemed better on a second look to use the existing `sidebar.iframe`
property that exposes the `<iframe>` element, but document and test that
property.
      4305f258
    • Robert Knight's avatar
      Add additional comments and revise logic slightly in annotator/index.js · 36fe2c08
      Robert Knight authored 
      Add comments to clarify various aspects of the way the host/guest frames
are set up and interact.
      36fe2c08
    • Robert Knight's avatar
      Explicitly specify guest/sidebar frames to ping in `startDiscovery` · 3dd8144a
      Robert Knight authored 
      The logic used by guest/host and sidebar frames to find each other in
`Discovery#startDiscovery` relied on traversing the frame tree starting
from `window.top` using `window.frames`. Since `window.frames` doesn't
include frames in shadow roots, this did not work if _both_ the guest and
sidebar are contained within a shadow root. The sidebar is always
contained in a shadow root created by the `<hypothesis-sidebar>`
element, so this simplifies to only working if the guest/host is not
contained in a shadow root.

For current use cases it is possible for guest frames to get a direct
reference to the sidebar frame they should be communicating with and for
the sidebar to get direct a reference to the host frame (its parent).
This avoids the need for `window.frames` traversal.

This commit leverages that by changing `startDiscovery` to take an
explicit array of frames to ping. Guest frames invoke `startDiscovery`
passing a reference to the sidebar frame and sidebar frames invoke
`startDiscovery` passing a reference to the parent (host) frame.

This fixes the following scenarios:

 - Hypothesis not completing loading if host frame is contained within a
   shadow root. eg. In the VitalSource book reader.

 - Same-origin guest frames loading Hypothesis after the sidebar has
   already loaded. See http://localhost:3000/document/parent-frame test
   case in client dev server.

 - Multiple sidebars attempting to connect to the same guest frame, if
   Hypothesis is loaded multiple times in different parts of the frame
   tree. See http://localhost:3000/document/multi-frames test case in
   client dev server.

This approach has some limitations:

 - Child guest frames which are not same-origin with the parent host frame
   are not supported.
 - Child guest frames which attempt to connect to the sidebar before it
   has loaded will fail to connect. This could be remedied by making the
   guest wait for confirmation of the sidebar having loaded before
   calling `connectToSidebar`. This doesn't affect the host frame since
   the sidebar pings that frame directly.

These limitations are acceptable in the short term but will be remedied
by a larger overhaul of inter-frame communication that is currently
being worked on.
      3dd8144a
  7. 22 Jul, 2021 2 commits
    • Robert Knight's avatar
      Add test case for loading Hypothesis into a Shadow DOM-ed iframe · 5ca9d398
      Robert Knight authored 
      Add a test case that reproduces the scenario encountered in the new
VitalSource book reader [1] where Hypothesis is loaded into an iframe
whose `<iframe>` element is contained within a shadow root and is thus
not accessible via `window.frames`. This scenario currently prevents the
Hypothesis sidebar from discovering and connecting to the frame.
      5ca9d398
    • Robert Knight's avatar
      Split test documents into general and specific-scenario tests · fd5a1307
      Robert Knight authored 
      Split the test HTML and PDF documents into two groups: those that test
general usage of Hypothesis with a particular document type using the
default configuration and those that test specific scenarios, edge cases
or non-standard configuration.

The link descriptions for the scenario tests have been changed to focus
on the scenario, since that is what is important, rather than the
document title.
      fd5a1307
  9. 21 Jul, 2021 6 commits
  11. 19 Jul, 2021 7 commits
  13. 16 Jul, 2021 7 commits
  15. 15 Jul, 2021 2 commits