- 15 Oct, 2021 3 commits
-
-
-
Robert Knight authored
-
Robert Knight authored
Replace Browserify with Rollup as a module bundler. This brings several advantages: - It is a more modern bundler that has better support in the ecosystem, more active maintenence, fewer dependencies and is easier to write plugins for. The core team also maintain most of the plugins that we need. - It has native support for modern platform features like ES modules, including dynamic import for lazy-loading of functionality. - It generates smaller bundles due to its ability to do tree shaking and scope hoisting. The new bundles are generated as ES modules rather than UMD / IIFE bundles. Our target browsers now all support ES modules and this will enable us to use native static/dynamic imports for code splitting or lazy-loading of functionality in future. The initial Rollup build generates one bundle per application (boot script, annotator, sidebar). This simplifies the build process and minimizes production bundle size, at the cost of making incremental updates during development slightly slower. Build performance is currently similar to or a little slower than Browserify. We can optimize this by adding caching of transforms (mainly Babel) and pre-building of a vendor bundle containing large dependencies. As part of changing the bundler this also changes how the code is packaged for tests. We now do the bundling ourselves rather than using a Karma integration. This makes it much easier to inspect the processed code and fix problems. It also makes it easier to optimize the bundle building in future.
-
- 11 Oct, 2021 14 commits
-
-
Robert Knight authored
-
Robert Knight authored
-
Robert Knight authored
The CrossFrame class was a thin wrapper around the Bridge connection between guest and sidebar and wasn't really encapsulating any functionality. Simplify the code by removing this non-abstraction and moving the Bridge and AnnotationSync construction directly into the Guest class. Also reorganize the Guest constructor to better group together related logic. In the anchoring integration test the CrossFrame stub has simply been removed rather than replaced because it isn't necessary. As long as `Guest.connectToSidebar` is not called, all the Bridge method calls will have no effect.
-
dependabot[bot] authored
Bumps [@babel/preset-env](https://github.com/babel/babel/tree/HEAD/packages/babel-preset-env) from 7.15.6 to 7.15.8. - [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.8/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>
-
dependabot[bot] authored
Bumps [postcss](https://github.com/postcss/postcss) from 8.3.8 to 8.3.9. - [Release notes](https://github.com/postcss/postcss/releases) - [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md) - [Commits](https://github.com/postcss/postcss/compare/8.3.8...8.3.9) --- updated-dependencies: - dependency-name: postcss dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>
-
dependabot[bot] authored
Bumps [@sentry/browser](https://github.com/getsentry/sentry-javascript) from 6.13.2 to 6.13.3. - [Release notes](https://github.com/getsentry/sentry-javascript/releases) - [Changelog](https://github.com/getsentry/sentry-javascript/blob/master/CHANGELOG.md) - [Commits](https://github.com/getsentry/sentry-javascript/compare/6.13.2...6.13.3) --- updated-dependencies: - dependency-name: "@sentry/browser" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>
-
dependabot[bot] authored
Bumps [@babel/core](https://github.com/babel/babel/tree/HEAD/packages/babel-core) from 7.15.5 to 7.15.8. - [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.8/packages/babel-core) --- updated-dependencies: - dependency-name: "@babel/core" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>
-
dependabot[bot] authored
Bumps [autoprefixer](https://github.com/postcss/autoprefixer) from 10.3.6 to 10.3.7. - [Release notes](https://github.com/postcss/autoprefixer/releases) - [Changelog](https://github.com/postcss/autoprefixer/blob/main/CHANGELOG.md) - [Commits](https://github.com/postcss/autoprefixer/compare/10.3.6...10.3.7) --- updated-dependencies: - dependency-name: autoprefixer dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>
-
dependabot[bot] authored
Bumps [aws-sdk](https://github.com/aws/aws-sdk-js) from 2.999.0 to 2.1004.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.999.0...v2.1004.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>
-
dependabot[bot] authored
Bumps [core-js](https://github.com/zloirock/core-js) from 3.18.1 to 3.18.2. - [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.18.1...v3.18.2) --- updated-dependencies: - dependency-name: core-js dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>
-
dependabot[bot] authored
Bumps [@octokit/rest](https://github.com/octokit/rest.js) from 18.11.4 to 18.12.0. - [Release notes](https://github.com/octokit/rest.js/releases) - [Commits](https://github.com/octokit/rest.js/compare/v18.11.4...v18.12.0) --- updated-dependencies: - dependency-name: "@octokit/rest" dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>
-
dependabot[bot] authored
Bumps [@hypothesis/frontend-shared](https://github.com/hypothesis/frontend-shared) from 3.12.0 to 3.13.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.12.0...v3.13.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>
-
Eduardo Sanz García authored
Follow up of https://github.com/hypothesis/client/pull/3807 * reference to the `crossframe` service is inaccurate * changed default export to a named export, as per team conventions
-
Eduardo Sanz García authored
Follow up of https://github.com/hypothesis/client/pull/3807 * reference to the `crossframe` service is inaccurate * changed default export to a named export, as per team conventions
-
- 08 Oct, 2021 2 commits
-
-
Eduardo Sanz García authored
* add information about why to use `window.load` instead of `document.DOMContentLoaded` to check when a document is ready * use an invalid local URL (http://localhost:1) to speed DNS lookup in the test * include some comments about the use of `waitForFrameObserver` in the tests
-
Eduardo Sanz García authored
Instead of override the window.hypothesisConfig, I provide the `externalContainerSelector` through a JSON script tag. This allows a more incremental way to add configuration options.
-
- 07 Oct, 2021 12 commits
-
-
Robert Knight authored
-
Robert Knight authored
When injecting the client into a guest frame, proxy any custom asset locations specified via `.js-hypothesis-config` script tags in the host frame. These are used by the browser extension and needed for the VitalSource integration to work in that context. We could probably avoid copying the `sidebarAppUrl` and `notebookAppUrl` settings for guest-only frames. This will require changes to the boot script and possibly the annotator entry point.
-
Robert Knight authored
-
Robert Knight authored
-
Robert Knight authored
Implement the `injectClient` method of Guest that is used by integrations (eg. VitalSource) to inject the client into a chosen frame. In the process the `HypothesisInjector` class has been extracted out of the `CrossFrame` class, since it is unrelated to the rest of the functionality in that class and only lived their because of its dependence on the `Bridge` instance, which will soon be removed (see https://github.com/hypothesis/client/pull/3812). It is now constructed and used directly by the `Guest` class instead.
-
Robert Knight authored
Expose the existing logic for injecting the client into a target frame in HypothesisInjector as a public `injectClient` method and modify it to wait for the document to be loaded if necessary. This method will be used by the guest class to inject the client into specific frames when requested by the current integration. In the case where the frame is discovered by `FrameObserver` this means that `onDocumentReady(frame)` will be called twice. That's OK because the second call will just complete immediately if the frame is already ready.
-
Robert Knight authored
-
Robert Knight authored
Change how the sidebar is notified of guest frames being unloaded to support guest frames where the client has been loaded via means other than `HypothesisInjector` or where the guest is cross-origin. Instead of listening for the guest frame's 'unload' event from the parent frame in `HypothesisInjector`, the guest frame instead listens for this event itself and sends a `hypothesisGuestUnloaded` message to the host frame via `window.postMessage`, which in turn is handled in the `Sidebar` class to relay it to the sidebar app via a `destroyFrame` RPC call. This indirect route works around a bug in Safari (see code comments). As well as supporting future use cases, this also simplifies the `HypothesisInjector` class as it no longer needs access to the `Bridge`.
-
Robert Knight authored
This enables testing handling of the client's discovery of existing frames (on page load) as well as handling of dynamic addition and removal after the client has started.
-
Robert Knight authored
-
Robert Knight authored
Use separate channels for sending messages to guests vs the host in the sidebar, even for the common case when there is only one guest and it is the same frame as the host. This change makes it clear for readers which part of the annotator code is intended to handle a particular message from the sidebar. It is also a step towards supporting host frames that are not guests. This will be needed in ebook readers where the host frame provides the navigation UI and contains the frame displaying the book content, but should not be annotatble itself. - Remove the `bridge` service in the sidebar. The `frameSync` service now provides the entry point for other services/components to make RPC calls to the host or guest frames. Currently the only use case is sending notifications to the host via `FrameSyncService.notifyHost`. - Create separate `Bridge` instances in `FrameSyncService` for sidebar <-> guest and sidebar <-> host communication. The sidebar <-> guest bridge works the same as before. The sidebar <-> host bridge is established by having `FrameSyncService` create a MessageChannel when sending the `hypothesisSidebarReady` notification to the host. The sidebar / host frames then add respective ports of this channel to a Bridge instance. - Change the various existing RPC calls between frames to use either the guest <-> sidebar or host <-> sidebar communication channels as appropriate
-
Robert Knight authored
Show the URLs of all frames connected to the sidebar in the Version info tab of the Help panel. Previously only the URL of the main frame was shown. Initially this will mainly be useful for client developers to check that the expected set of frames are connected to the sidebar in different scenarios.
-
- 06 Oct, 2021 6 commits
-
-
Robert Knight authored
-
Robert Knight authored
-
Robert Knight authored
`Annotator` is not a great name for this interface, but at least make the link between it and Guest clearer by improving its documentation and marking Guest as explicitly implementing it.
-
Robert Knight authored
This adds a new integration for the VitalSource Bookshelf reader. It is comprised of two separate sub-integrations, one for the "container" frame into which the client is initially loaded, and a separate one for the "content" frame that displays the book content. The container frame integration is responsible for injecting the client into the content frame and re-injecting after a navigation. All the annotation-related functionality is a no-op in this frame. The logic for injecting the client depends on a stub method in the Guest class which will be implemented separately. The content frame integration mostly delegates to the HTML integration, but it customizes the document metadata saved with annotations and also prevents the VitalSource viewer's native selection controls from interfering with Hypothesis's ones.
-
Eduardo Sanz García authored
All frontend Hypothesis app are going to have the same base line as this: https://github.com/hypothesis/bouncer/pull/469/commits/6a01199bfc196a8932be271f61c07029dbf886c5
-
Robert Knight authored
-
- 04 Oct, 2021 3 commits
-
-
Robert Knight authored
-
Robert Knight authored
Add a `canAnnotate` method to the `Integration` interface to indicate whether a range is part of the annotatable content of the document. This allows integrations to signal whether the Annotate/Highlight toolbar should be shown for a given selection. Implement it for PDFs by returning `true` if the range is part of the text layer of a single page. Implement it for HTML documents by always returning true. Fixes #3790
-
dependabot[bot] authored
Bumps [@octokit/rest](https://github.com/octokit/rest.js) from 18.11.1 to 18.11.4. - [Release notes](https://github.com/octokit/rest.js/releases) - [Commits](https://github.com/octokit/rest.js/compare/v18.11.1...v18.11.4) --- updated-dependencies: - dependency-name: "@octokit/rest" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>
-