Commits · 9e4a4717d709ca6c50f3dcfeab405cfd331dd016 · 孙灵跃 Leon Sun / coopwire-hypothesis

16 Sep, 2021 3 commits

Minor improvements following PR feedback · 9e4a4717

Eduardo authored Sep 08, 2021

* check that the iframe's `src` element is not 'about:blank'.
* use EventTarget class and fake DOM element for tests
* fix typos

9e4a4717

Complete testing of the onDocumentReady function · 8575eb96
Eduardo Sanz García authored Aug 19, 2021
```
I removed the `/* istanbul ignore test */` and created a facade to
emulate and iframe for testing.
```
8575eb96

Improve the logic that checks for iframe's document ready · 919e5bf1

Eduardo Sanz García authored Aug 16, 2021

In certain situations, the logic to check when the iframe's document is
ready didn't work as expected. The reason for that is that browsers
create an initial blank document before the actual document loads.
This blank document has a `readyState` of 'complete' in Safari and
Chrome and of 'uninitialized' in Firefox. This blank document can be
mistaken by the final document. I was able to reproduce a situation
where the Hypothesis client was injected into the blank document. Then,
the blank document was replaced by the actual document and the
Hypothesis client was not not longer embedded.

In addition, this commit:

* renames `frame` to `iframe` (only in the test)
* renames `_handledFrames` to _annotatableFrames`
* removes `isAccessible` (no longer neede)

919e5bf1

15 Sep, 2021 5 commits

Tweak comment · f7f8e24f

Robert Knight authored Sep 15, 2021

Add commas for readability
Co-authored-by: Lyza Gardner <439947+lyzadanger@users.noreply.github.com>

f7f8e24f

Prevent sidebar controls overlapping scrollbar in PDFs · 32cea8cc

Robert Knight authored Sep 15, 2021

When the sidebar is closed or there is not enough room to show the
sidebar alongside the PDF content, reserve space for the sidebar's
toolbar and bucket bar. This fixes an issue where the sidebar's controls
would overlap the document's scrollbar, making scrolling the PDF less
convenient, especially in long documents.

This also removes the need for some CSS overrides that reposition
elements in PDF.js's toolbar. By ensuring that the `<body>` does not
overlap the sidebar controls, the PDF.js toolbar which is contained
within the body doesn't either.

Fixes #3759

32cea8cc

Remove vestigial `undefined` from map value type · 4ecde083
Robert Knight authored Sep 15, 2021
```
This is no longer needed after the `Record<K, V>` => `Map<K, V>` change.
```
4ecde083

Fix map lookup · e822a31c

Robert Knight authored Sep 15, 2021

I expected TypeScript to generate an error for this obvious mistake, but
it seems that this only happens if `noImplicitAny` is enabled.

e822a31c

Use maps for PDF text and anchoring caches · ecb9b47c

Robert Knight authored Sep 13, 2021

Using maps is a little faster and avoids the need for `hasOwnProperty`
checks. The quote position cache has been converted to a single level
map as this is more ergonomic to work with and the second level maps
almost always had exactly one entry in them.

ecb9b47c

14 Sep, 2021 10 commits

Improve visibility of focused PDF highlights · 4458b415

Robert Knight authored Sep 13, 2021

When the same text is highlighted multiple times in a PDF, it could be hard to
distinguish focused highlights as the `<rect>`s for focused highlights
could be obscured by `<rect>`s for overlapping unfocused highlights.

SVG elements are painted in the order they appear in the document and don't
yet support a z-index property [1], so this commit fixes the issue by moving
`<rect>`s to be last amongst siblings when focused.

[1] The SVG 2 spec does support a z-index attribute, but none of the major
    browsers support it yet. See https://bugs.webkit.org/show_bug.cgi?id=90738,
    https://bugs.chromium.org/p/chromium/issues/detail?id=670177 and
    https://bugzilla.mozilla.org/show_bug.cgi?id=360148.

4458b415

Remove unused forms SASS · b000b180
Lyza Danger Gardner authored Sep 10, 2021

b000b180

Replace .InputButton custom pattern with TextInputWithButton · 97e7d67a

Lyza Danger Gardner authored Sep 09, 2021

The general pattern for an input next to an icon-only button has been
added to the pattern library in the frontend-shared package and is
implemented by the TextInputWithButton component. We don't need custom
treatment in this project anymore.

97e7d67a

Simplify .PaginationPageButton · 81df42f9

Lyza Danger Gardner authored Sep 09, 2021

Use `classes` to extend, not obliterate, component styles, obviating
the need to use complex mixins.

81df42f9

Simplify .NonResponsiveIconButton · a81a51ac

Lyza Danger Gardner authored Sep 09, 2021

Use `classes` to extend, not obliterate, component styles and obviate
the need for complex mixins.

a81a51ac

Simplify PublishControlButton styling · 35a6fb4a

Lyza Danger Gardner authored Sep 09, 2021

Use `classes` to extend, not obliterate, components styles and obviate
the need to use complex mixins.

35a6fb4a

Simplify .InlineLinkButton · dc99cb1e

Lyza Danger Gardner authored Sep 09, 2021

Use `classes` to extend, not obliterate, component styles, and obviate
the need to use complex mixins.

dc99cb1e

Remove obsolete `@ts-ignore` · 51155eda
Robert Knight authored Sep 14, 2021

51155eda
Use `classList.add` to add tokens to the class list · 0d4b5367
Robert Knight authored Sep 14, 2021
```
This is functionally the same, just a little cleaner.
```
0d4b5367

Reduce forced reflows when drawing PDF highlights · c8307923

Robert Knight authored Sep 08, 2021

The rendering of SVG highlights in PDFs triggered an excessive number of
style recalculations and forced reflows due to interleaving DOM changes
with DOM API calls that require current layout information.

This commit makes several changes to reduce reflows:

 1. Create all the `<hypothesis-highlight>` elements in the text layer
    before creating any of the associated SVG elements.

    This avoids interleaving creating `<hypothesis-highlight>` elements
    with measuring them in order to position the associated SVG
    `<rect>`.

 2. Change `drawHighlightsAbovePdfCanvas` to accept a list of highlight
    elements instead of a single element. By assuming all highlights for
    a single annotation are on the same page, we can avoid some repeated
    work and add all the `<rect>` elements to the parent `<svg>` in one
    batch.

These changes only reduce the thrash when creating highlights for a
single annotation. To eliminate the remaining thrash we'd need to use a
combination of optimizing DOM updates across multiple `highlightRange`
calls and/or reducing the work for PDF pages which are rendered but not
visible on-screen.

c8307923

13 Sep, 2021 17 commits

Refactor `strippedHint` initialization · 904810bd
Robert Knight authored Sep 13, 2021
```
Combine two separate if blocks into one.
```
904810bd
Don't treat an empty prefix/suffix like a missing prefix/suffix · 7f4de8c4
Robert Knight authored Sep 13, 2021

7f4de8c4
Add a note about performance considerations of `stripSpaces` · 019045a0
Robert Knight authored Sep 13, 2021
```
See https://esbench.com/bench/613f1ca06c89f600a570114b for some related
benchmarks.
```
019045a0

Check for context match before stopping search early · 0d193d1f

Robert Knight authored Sep 10, 2021

To reduce the chances of mis-anchoring quotes, check for a context match
before stopping early. This helps when the quote is a word or phrase
that is common in the document and the position hint is wrong, which can
occur if the quote selector was created when using a different PDF
viewer or version of PDF.js, which exacts text differently.

For quotes captured at the start or end of a page we expect a mismatch
in the prefix and suffix respectively because quote selectors can currently
capture parts of the surrounding pages / DOM in `describe`, but when
anchoring we only search for matches in one page of text at a time.

0d193d1f

Add a detailed test of PDF anchoring's use of `matchQuote` · a8c3e38e

Robert Knight authored Sep 08, 2021

We have a basic test of quote matching from the perspective of the
`anchor` caller, but we really need to check the data passed to the
quote matching logic in more detail.

a8c3e38e

Find best match for quote selectors across all pages ignoring whitespace · 96ecd3b3

Robert Knight authored Aug 24, 2021

As described in #3705, stopping a quote search as soon as we find an
approximate match could result in quotes anchoring to suboptimal matches
if the position selector is no longer accurate.

We want to balance finding the best match against making the search
efficient in long documents. The approach taken in this commit is to
continue to search pages in priority order, but instead of returning the
first "good enough" match (below `matchQuote`'s error threshold), return
the first exact match ignoring whitespace differences, or the nearest
match in the whole document otherwise.

We ignore whitespace differences because this is the main change between
the current version of PDF.js that we include in Hypothesis products, and
newer versions that we are trying to migrate to (see #3687). It is also
likely to be the main source of text differences between PDF.js and
other viewers.

 - Change `anchorQuote` to ignore whitespace differences when searching
   for approximate matches
 - Change `anchorQuote` to keep searching for the best match if it does
   not find a whitespace-insensitive exact match in the current page
 - Add tests for whitespace changes

Fixes https://github.com/hypothesis/client/issues/3705

96ecd3b3

Improve tests for invalid position selectors · bd223ffc

Robert Knight authored Sep 06, 2021

Add tests to cover the cases where the position is on a page before the
quote and where the position is negative.

bd223ffc

Refactor and optimize quote anchoring in PDFs · d061e027

Robert Knight authored Aug 24, 2021

Refactor quote anchoring logic to use async/await instead of Promise
chains to make control flow easier to follow and change.

 - Convert `getPageOffset` and `findPage` helper functions to use
   async/await rather than Promise chains.

 - Combine the `prioritizePages` and `findInPages` functions into a
   single `anchorQuote` function.

   Combining the two functions allows some redundant work to be
   eliminated. `findInPages` used to call `getPageOffset` for the
   current page on each iteration which would in turn fetch the text of
   every page until it reached the given offset. `prioritizePages` would
   do a very similar loop in order to enumerate pages close to the given
   offset.

 - Replace use of `TextQuoteAnchor.fromSelector` with direct use of
   `matchQuote`. `fromSelector` wasn't providing any value over just
   calling `matchQuote` directly, and it required a dummy DOM element to
   be created and have its text populated.

d061e027

Run `make format` for the latest prettier version (2.4.0) · 1ec83a57
Eduardo Sanz García authored Sep 13, 2021
```
In scss files, `@use "..."` has been replaced by `@use '...'" (single
quotes instead of double).
```
1ec83a57

Bump prettier from 2.3.2 to 2.4.0 · b73e7efb

dependabot[bot] authored Sep 13, 2021

Bumps [prettier](https://github.com/prettier/prettier) from 2.3.2 to 2.4.0.
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md)
- [Commits](https://github.com/prettier/prettier/compare/2.3.2...2.4.0)

---
updated-dependencies:
- dependency-name: prettier
  dependency-type: direct:development
  update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>

b73e7efb

Bump typescript from 4.4.2 to 4.4.3 · 2d036046

dependabot[bot] authored Sep 13, 2021

Bumps [typescript](https://github.com/Microsoft/TypeScript) from 4.4.2 to 4.4.3.
- [Release notes](https://github.com/Microsoft/TypeScript/releases)
- [Commits](https://github.com/Microsoft/TypeScript/compare/v4.4.2...v4.4.3)

---
updated-dependencies:
- dependency-name: typescript
  dependency-type: direct:development
  update-type: version-update:semver-patch
...
Signed-off-by: dependabot[bot] <support@github.com>

2d036046

Bump @babel/preset-env from 7.15.4 to 7.15.6 · 91af718a

dependabot[bot] authored Sep 13, 2021

Bumps [@babel/preset-env](https://github.com/babel/babel/tree/HEAD/packages/babel-preset-env) from 7.15.4 to 7.15.6.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
- [Commits](https://github.com/babel/babel/commits/v7.15.6/packages/babel-preset-env)

---
updated-dependencies:
- dependency-name: "@babel/preset-env"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...
Signed-off-by: dependabot[bot] <support@github.com>

91af718a

Bump sass from 1.39.0 to 1.39.2 · 1a8951fb

dependabot[bot] authored Sep 13, 2021

Bumps [sass](https://github.com/sass/dart-sass) from 1.39.0 to 1.39.2.
- [Release notes](https://github.com/sass/dart-sass/releases)
- [Changelog](https://github.com/sass/dart-sass/blob/main/CHANGELOG.md)
- [Commits](https://github.com/sass/dart-sass/compare/1.39.0...1.39.2)

---
updated-dependencies:
- dependency-name: sass
  dependency-type: direct:development
  update-type: version-update:semver-patch
...
Signed-off-by: dependabot[bot] <support@github.com>

1a8951fb

Bump aws-sdk from 2.983.0 to 2.987.0 · 0949588e

dependabot[bot] authored Sep 13, 2021

Bumps [aws-sdk](https://github.com/aws/aws-sdk-js) from 2.983.0 to 2.987.0.
- [Release notes](https://github.com/aws/aws-sdk-js/releases)
- [Changelog](https://github.com/aws/aws-sdk-js/blob/master/CHANGELOG.md)
- [Commits](https://github.com/aws/aws-sdk-js/compare/v2.983.0...v2.987.0)

---
updated-dependencies:
- dependency-name: aws-sdk
  dependency-type: direct:development
  update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>

0949588e

Bump core-js from 3.17.2 to 3.17.3 · f32fcaf2

dependabot[bot] authored Sep 13, 2021

Bumps [core-js](https://github.com/zloirock/core-js) from 3.17.2 to 3.17.3.
- [Release notes](https://github.com/zloirock/core-js/releases)
- [Changelog](https://github.com/zloirock/core-js/blob/master/CHANGELOG.md)
- [Commits](https://github.com/zloirock/core-js/compare/v3.17.2...v3.17.3)

---
updated-dependencies:
- dependency-name: core-js
  dependency-type: direct:development
  update-type: version-update:semver-patch
...
Signed-off-by: dependabot[bot] <support@github.com>

f32fcaf2

Bump commander from 8.1.0 to 8.2.0 · 606107bf

dependabot[bot] authored Sep 13, 2021

Bumps [commander](https://github.com/tj/commander.js) from 8.1.0 to 8.2.0.
- [Release notes](https://github.com/tj/commander.js/releases)
- [Changelog](https://github.com/tj/commander.js/blob/master/CHANGELOG.md)
- [Commits](https://github.com/tj/commander.js/compare/v8.1.0...v8.2.0)

---
updated-dependencies:
- dependency-name: commander
  dependency-type: direct:development
  update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>

606107bf

Bump @hypothesis/frontend-shared from 3.8.1 to 3.9.0 · e82e8243

dependabot[bot] authored Sep 13, 2021

Bumps [@hypothesis/frontend-shared](https://github.com/hypothesis/frontend-shared) from 3.8.1 to 3.9.0.
- [Release notes](https://github.com/hypothesis/frontend-shared/releases)
- [Changelog](https://github.com/hypothesis/frontend-shared/blob/main/CHANGELOG.md)
- [Commits](https://github.com/hypothesis/frontend-shared/compare/v3.8.1...v3.9.0)

---
updated-dependencies:
- dependency-name: "@hypothesis/frontend-shared"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>

e82e8243

09 Sep, 2021 2 commits

Support new PDF.js fingerprint API · aade0062

Robert Knight authored Sep 07, 2021

In https://github.com/mozilla/pdf.js/pull/13661 the API for retrieving
PDF fingerprints (aka. File Identifiers) changed. In generic builds of
PDF.js the old API remains available, but not in the non-generic one
that Firefox's built-in viewer uses.

This commit makes Hypothesis use the new API if available or the old API
otherwise. The fingerprint value should be the same in both cases.

Fixes #3673

aade0062

Update PDF.js to the latest release (v2.11.213) · f2512324
Robert Knight authored Aug 17, 2021
```
This is the result of running scripts/update-pdfjs.
```
f2512324

08 Sep, 2021 3 commits
- Simplification of a test · 38a6c5d7
  Eduardo Sanz García authored Aug 17, 2021
```
Use async/await to simplify a test.
```
  38a6c5d7
- Renamed `frame` for `iframe` · 9552346c
  Eduardo Sanz García authored Aug 17, 2021
  
  9552346c
- Cleanup `injectHypothesis` · b638aa7e
  Eduardo authored Aug 17, 2021
```
* rename `embedElement` to `bootScript`
* remove unused class
```
  b638aa7e