Integration testing on Zotero's Firefox ESR

.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    ignore:
+      - dependency-name: "*"
+    schedule:
+      interval: "monthly"

.github/workflows/build-wasm.yml

@@ -10,10 +10,10 @@ jobs:
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v2
-      - name: Install Rust 1.43.1
+      - name: Install Rust 1.51.0
         uses: actions-rs/toolchain@v1
         with:
-          toolchain: 1.43.1
+          toolchain: 1.51.0
           override: true
       - name: Cache cargo directories
         uses: actions/cache@v2
@@ -52,10 +52,10 @@ jobs:
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v2
-      - name: Install Rust 1.43.1
+      - name: Install Rust 1.51.0
         uses: actions-rs/toolchain@v1
         with:
-            toolchain: 1.43.1
+            toolchain: 1.51.0
             override: true
       - name: Cache cargo directories
         uses: actions/cache@v2

.github/workflows/ci.yml

@@ -121,11 +121,12 @@ jobs:
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v2
-      - name: Install Rust 1.43.1
+      - name: Install Rust 1.51.0
         uses: actions-rs/toolchain@v1
         with:
-          toolchain: 1.43.1
+          toolchain: 1.51.0
           override: true
+
       - name: Cache cargo directories
         uses: actions/cache@v2
         with:
@@ -141,10 +142,6 @@ jobs:
       - name: Install wasm-pack
         run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh -s -- -f
 
-      - name: Build WASM
-        working-directory: crates/wasm/js-tests
-        run: yarn build
-
       - name: Get yarn cache directory path
         id: yarn-cache-dir-path
         run: echo "::set-output name=dir::$(yarn cache dir)"
@@ -161,14 +158,23 @@ jobs:
         working-directory: crates/wasm/js-tests
         run: yarn install
 
-      - name: Run tests
+      - name: Build WASM
         working-directory: crates/wasm/js-tests
-        run: yarn test
+        run: yarn build
 
-      # otherwise, the yarn cache will contain a different @citeproc-rs/wasm
-      # entry every time.
-      - name: Clean yarn cache dir of wasm output
-        run: |
-          cd "$(yarn cache dir)"
-          ls | grep citeproc-rs-wasm | xargs rm -rf
+      - name: Download Firefox ESR from zotero-standalone-build
+        working-directory: crates/wasm/js-tests
+        run: ./install_firefox.sh
+
+      - name: Run tests, including in Firefox ESR
+        working-directory: crates/wasm/js-tests
+        run: MUST_RUN_FIREFOX_TESTS=1 yarn test
+
+      # not necessary because we install @citeproc-rs/wasm without yarn knowing now
+      # # otherwise, the yarn cache will contain a different @citeproc-rs/wasm
+      # # entry every time.
+      # - name: Clean yarn cache dir of wasm output
+      #   run: |
+      #     cd "$(yarn cache dir)"
+      #     ls | grep citeproc-rs-wasm | xargs rm -rf
 

Cargo.toml

@@ -16,6 +16,10 @@ default-members = [
   "crates/citeproc",
 ]
 
+[profile.dev]
+# rust 1.51 release notes -- replaces dsymutil on macOS, faster dev builds
+split-debuginfo = "unpacked"
+
 [profile.bench]
 lto = "thin"
 # flamegraph with cargo test --release

crates/wasm/Cargo.toml

@@ -17,12 +17,8 @@ description = "citeproc-rs, compiled to WebAssembly"
 # TODO: Set the opt level on new wasm-pack 0.6.0 config
 # when it's released, so as not to interfere with the
 # other native binary targets (cargo only lets you set it
-# on the workspace root)
-
-# https://github.com/rustwasm/wasm-pack/issues/886#issuecomment-667669802
 [package.metadata.wasm-pack.profile.release]
-# wasm-opt = ["-O3", "--enable-mutable-globals", "-g"]
-wasm-opt = false
+wasm-opt = ["-O4", "-g"]
 
 [lib]
 crate-type = ["cdylib", "rlib"]
@@ -56,6 +52,7 @@ serde = "1.0.116"
 serde_derive = "1.0.116"
 serde_json = "1.0.57"
 thiserror = "1.0.22"
+wasm-bindgen-test = "0.3.23"
 
 [dependencies.rand]
 version = "0.7.3"
@@ -64,7 +61,7 @@ features = ["wasm-bindgen"]
 # getrandom = { version = "0.1.0", features = ["js"] }
 
 [dependencies.wasm-bindgen]
-version = "=0.2.62"
+version = "0.2.70"
 features = ["serde-serialize"]
 
 [dependencies.log]

crates/wasm/js-tests/.gitignore

@@ -1 +1,2 @@
 node_modules
+zotero-standalone-build

crates/wasm/js-tests/README.md

@@ -0,0 +1,23 @@
+## Running tests
+
+Requires bash. Sorry Windows.
+
+```sh
+yarn
+yarn build
+./install_firefox.sh
+yarn test
+```
+
+Running `yarn`/`yarn install` will delete the `node_modules/@citeproc-rs/wasm`
+folder, so run `yarn build` again.
+
+## Disabling the Firefox ESR integration test
+
+```sh
+yarn
+yarn build
+yarn test-node-only # this force-disables.
+yarn jest # runs it if FIREFOX_BINARY_PATH is set to a firefox binary
+```
+

crates/wasm/js-tests/browser/browser.test.ts

@@ -0,0 +1,24 @@
+// selenium-webdriver tests
+
+if (process.env.MUST_RUN_FIREFOX_TESTS == "1" && !global.browser) {
+    throw new Error(`cannot run firefox tests, probably because no FIREFOX_BINARY_PATH provided`)
+}
+
+var suite = describe.skip;
+if (global.browser) {
+    suite = describe;
+}
+suite("Integration tests for Firefox ESR 60.9", () => {
+    test("no-modules build works end to end", async () => {
+        // firefox could be first-booting itself. Give it time.
+        jest.setTimeout(60000);
+        await browser.get("file://" + __dirname + '/index.html');
+        let fail = browser.wait(until.elementLocated(By.id('failure')), 10000);
+        let succ = browser.wait(until.elementLocated(By.id('success')), 10000);
+        let el = await Promise.race([fail, succ]);
+        let id = await el.getAttribute("id");
+        let text = await el.getText();
+        expect(text).toBe("success");
+        expect(id).toBe("success");
+    })
+})

crates/wasm/js-tests/browser/index.html

@@ -0,0 +1,14 @@
+<html>
+  <head>
+    <title>eyah</title>
+    <meta charset="utf-8"/>
+  </head>
+  <body>
+    <script type="text/javascript"> console.log('seen before'); </script>
+    <script type="text/javascript" src="./pkg-nomod/_no_modules/citeproc_rs_wasm_include.js"></script>
+    <script type="text/javascript" src="./pkg-nomod/_no_modules/citeproc_rs_wasm.js"></script>
+    <script type="text/javascript"> console.log('seen after entry'); </script>
+    <script type="text/javascript" src="script.js"></script>
+    <script type="text/javascript"> console.log('seen after script.js'); </script>
+  </body>
+</html>