技術ブログ改め、Qiitaの下書き

Rust + wasm-bindgen + WebWorkerの環境構築

WebAssembly Advent Calendar 2018の20日目の記事。 ※ 2019/4/20: 修正

TL;DR

parcelのparcel-plugin-wasm.rsプラグインを使用しよう!

サンプルリポジトリはこちら iMasanari/wasm-bindgen-with-worker

やりたいこと

時間のかかる処理をWebAssemblyで高速に行いたい。そのためには、下記の条件が必要になる。

  • 引数や戻り値をJSON形式でやりとりできること
  • 非同期処理であること

今回は、Rustでwasm-bindgenを使用し、WebWorker内で動かす環境を作っていく。

1度、WebPackで構築するも……

まずは、WebAssemblyを使って乱数調整ツールをWebに移植した話を元に、WebPackで構築した。しかし、3つの気になる点が出てきた。

  • Worker用のエントリーファイルをもう1つ用意しなければならない
  • 中間ファイル生成(Rust→wasm)のせいで、ビルドタスクが煩雑になる
  • ライブリロード
    • ワンテンポ遅いタイミングでページ全体のリロードがされる
    • リロードの読み込み時間も長い

エントリーファイルの問題は、WebWorkerのファイル名にハッシュ(worker.2290ab9e.js2290ab9e部分)が付けられないことである。今回はスクリプトがView、WebWorker、WASMの3ファイルに分かれるので、キャッシュ対策のためにも必要度は高い。

parcelでの環境構築

Webpackで環境を作って数日後、ふと別のモジュールバンドラを使用すればよいのではと思い、parcelで試してみた。すると、上記のエントリーファイル問題、中間ファイル問題を解決することができた。 ライブリロードの件は一応差分更新を試みてくれるが、Rustの更新内容は反映されなかった。ただ、普段ライブリロードは使わず、またワンテンポ遅れの全リロードでないためそこまで問題は感じていない。

なぜ最初にparcelで試さなかったのかというと、情報がWebpackのものしかなかったからだ。なので今回、parcelでWebWorker + WebAssemblyを扱う方法を共有したい。(といっても、parcelがゼロコンフィグなモジュールバンドラのため、そこまで凝ったことはしていない)

各種インストール

Node.jsやRustはインストール済みとする。

parcelのインストール

parcel-plugin-wasm.rs v1.2.7はparcel-bundler v1.11.0に対応していないのかビルドエラーになったため、バージョンを指定してインストールしている。

※最新バージョンで治っていることを確認。

$ npm install -D parcel-bundler parcel-plugin-wasm.rs

parcel-plugin-wasm.rsはRustをwasm-packでコンパイルするためのparcelのプラグイン。wasm-packのインストールがまだの場合はインストールする。

$ cargo install wasm-pack

個人的にいつもTypeScriptを使うので、それ関連のインストール。 @types/webassembly-js-apiは、WebAssemblyの型定義。

$ npm install -D typescript @types/webassembly-js-api

フォルダ構成と設定ファイル

フォルダ構成(srcフォルダ)

各種フォルダとエントリーポイントのHTMLという構成で、個人的にすごくきれいな配置だと思う。 ちなみにこの出力をするためにMacへTreeコマンドを入れた。

$ tree src
src
├── app
│   └── index.ts
├── wasm
│   ├── lib.rs
│   └── lib.rs.d.ts
├── worker
│   └── index.ts
└── index.html

各種設定ファイル(必要最低限の箇所のみ)

// package.json
{
  "scripts": {
    "dev": "parcel src/index.html",
    "build": "parcel build src/index.html",
  },
  "devDependencies": {
    "@types/webassembly-js-api": "0.0.3",
    "parcel-bundler": "^1.12.3",
    "parcel-plugin-wasm.rs": "^1.2.8",
    "typescript": "^3.4.2"
  },
  "browserslist": [
    "last 2 chrome versions"
  ]
}
# Cargo.toml
[package]
name = "wasm"
version = "0.1.0"

[dependencies]
wasm-bindgen = "^0.2"

[lib]
crate-type = ["cdylib"]
path = "./src/wasm/lib.rs"
// tsconfig.json
{
  "compilerOptions": {
    "target": "es2015",
    "lib": [
      "es2015",
      "dom",
      "webworker"
    ],
    "strict": true,
    "esModuleInterop": true
  }
}

WebAssembly未対応のIEを切り捨て、TypeScriptのコンパイルはes2015で行っている。parcelのbabel側でes5に変換されないよう、package.jsonではbrowserslistの設定を行う。

各ファイル

全部書くのも面倒なので、各ファイルのインポート部分だけ書いていく。 書き足している場所もあるが、全体はサンプルリポジトリを参照。 iMasanari/wasm-bindgen-with-worker

<!-- src/index.html -->
<script src="app/index.ts"></script>
// src/app/index.ts
const worker = new Worker('../worker/index.ts')
// src/worker/index.ts
import * as wasm from '../wasm/lib.rs'

// WebAssemblyの実行
wasm.some_function('WebAssembly')

あとは、Rustの関数を作るだけ。 現在のWebAssemblyは数値しかやりとりができないが、wasm-bindgenを使うことで文字列やJSONもやりとりができるようになる。

// src/wasm/lib.rs
extern crate wasm_bindgen;
use wasm_bindgen::prelude::*;

#[wasm_bindgen]
pub fn some_function(input: &str) -> String {
    format!("Hello, {}!", input)
}

ビルドも下記コマンドだけでOK。 初回だけ、Rustのビルドに時間がかかる。

# デバッグ用ビルド + サーバー
$ npm run dev
# プロダクションビルド
$ npm run build

出力結果はこんな感じ。 なぜかlib.rsまで出力されているが、ちゃんとハッシュが付いているのが確認できる。

$ tree dist
dist
├── app.68414551.js
├── index.html
├── lib.3d22fd5b.rs
├── wasm_bg.ead9fc9c.wasm
└── worker.135e8d27.js

Webpackとの違い

RustからのJavaScriptコード呼び出しパス

Webpackでは、pkgフォルダ内のファイルをインポートするため、相対パスの基準はpkg/である。 parcel(parcel-plugin-wasm.rs)では、node_modules/parcel-plugin-wasm.rs/が基準である。parcelの絶対パス(/*)を使えば、エントリーファイルの場所(今回はsrc/)が基準になる。

// src/wasm/lib.rs
#[wasm_bindgen(module = "/worker/wasm-util")]
extern {
    fn console_log(s: &str);
}

WebWorker側でのRustインポート

Webpackでは、WASMをインポートするまでに必ずDynamic importを挟む必要がある。 parcelではその必要がなく、直接importする。(そもそもWebWroker内でのDynamic importがサポートされていない?)

つまり、parcelではWASMロード中のpostMessageを取りこぼしてしまう可能性がある。 そのためサンプルでは、ロードを待ってからメッセージを送るようにしている。

まとめ

parcelを使うことで、簡単にWebAssemblyが始められる。

ちなみにRustは、C言語並みの処理スピードを持ちながらモダンな文法と強力なコンパイル時チェックを備えている言語でおすすめ! 所有権、借用、ライフタイム? 学習コストが高い? 知らんな。一緒に借用チェッカと戦おうぜ! by Rust初心者