Skip to content

C
coopwire-hypothesis
Switch branch/tag
  1. 19 Oct, 2021 14 commits
  3. 18 Oct, 2021 5 commits
  5. 15 Oct, 2021 14 commits
    • Robert Knight's avatar
      Convert test bundle to be an ES module · 53da4038
      Robert Knight authored 
      This should make it easier to speed up test runs in future by
pre-building npm dependencies into a separate bundle which the main test
bundle can import from.
      53da4038
    • Robert Knight's avatar
      Limit CommonJS processing to npm dependencies · f72de5b5
      Robert Knight authored 
      The CommonJS plugin is the second most expensive transform after Babel.
Since all of our own code uses ES modules, limit it to npm dependencies
to speed up the build.

In tests the Babel transform has also been moved last so that additional
code it generates is not unnecessarily processed by subsequent plugins.

Combined these changes speed up a build of the full test bundle by ~4s.
      f72de5b5
    • Robert Knight's avatar
      Use an Error-like object rather than an actual Error in a test · f16678ec
      Robert Knight authored 
      This fixes a slow test on this branch, which appears to be caused by an
interaction between using `postMessage` to serialize native Error
objects and the `source-map-support` Karma plugin that we use.

Sending native Errors via `PortRPC` currently doesn't work in all
browsers so I expect we'll want to implement our own serialization of
errors in `PortRPC` to work around that. That can also work around the
`source-map-support`/`postMessage` issue in Chrome in future.

To move the Browserify => Rollup conversion forwards, this commit just
changes the test to use an Error-like rather than actual Error object.
      f16678ec
    • Robert Knight's avatar
      Remove unnecessary sinon import · f83ad4af
      Robert Knight authored 
      `sinon` is exposed as a global in the test environment so it doesn't
need to be imported. Additionally some of the dependencies of Sinon
(samsam, nise) cause warnings about circular dependencies and use of
`eval` when bundled by Rollup.
      f83ad4af
    • Robert Knight's avatar
      Add some clarifying comments · fd99644f
      Robert Knight authored 
      Add comments to clarify a few things about the way the tests are built
and run.
      fd99644f
    • Robert Knight's avatar
      Build boot script as classic rather than module script · 8c92b413
      Robert Knight authored 
      Due to pre-existing `<script>` tags on third-party websites that load
the client's boot script, via https://hypothes.is/embed.js, we need to
keep generating it as a classic rather than ES module script for now.
      8c92b413
    • Robert Knight's avatar
      Move launch error rendering into a function · 3185bf1b
      Robert Knight authored 
      This prevents a warning from Rollup about use of `this` outside a class
or (non-arrow) function in development builds, due to the way Babel
compiles JSX expressions [1]. Moving top-level code into a function is
also useful in case we ever want to write tests for it.

[1] https://github.com/babel/babel/issues/9149
      3185bf1b
    • Robert Knight's avatar
      Ensure warnings during build are displayed in console · d65b65b3
      Robert Knight authored
      d65b65b3
    • Robert Knight's avatar
      Add note about `preact/debug` exclusion in prod builds · a6e071d7
      Robert Knight authored 
      Since the exclusion is no longer triggered by logic in the source code,
add a note about where this happens.
      a6e071d7
    • Robert Knight's avatar
      Use @rollup/plugin-virtual to exclude modules in production · 8743910d
      Robert Knight authored 
      Make conditional exclusion of modules work the same way in the app
bundle as in the tests bundle.
      8743910d
    • Robert Knight's avatar
      Fix boot script error when running `make dev` after `make clean` · e40f8438
      Robert Knight authored 
      Fix an occasional error from Gulp about a missing `boot.bundle.js` file
when running `make dev` for the first time after `make clean`. This can
happen if `updateManifest` runs before Rollup has generated
`boot.bundle.js`. The error can be safely ignored as `updateManifest`
will be re-run after `boot.bundle.js` is generated.
      e40f8438
    • Robert Knight's avatar
      Enable source-mapped error stacktraces in tests · 34fc79e0
      Robert Knight authored 
      See https://github.com/hypothesis/browser-extension/pull/681
      34fc79e0
    • Robert Knight's avatar
      Create `build/scripts` dir if necessary before writing to it · 7de19607
      Robert Knight authored
      7de19607
    • Robert Knight's avatar
      Replace Browserify with Rollup · bcf7ef0a
      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.
      bcf7ef0a
  7. 11 Oct, 2021 7 commits