Rust -> Wasm bidings
Adding bindings
TODO.
Development notes
The Garaga NPM package is a mixed package. It is implemented in TypeScript but also reuses Rust code targeted to WebAssembly (WASM) with the help of wasm-pack
.
The src
folder is organized into two subfolders: node
which contains the implementation in TypeScript; and wasm
which has the interoperabilty code produced by wasm-pack
.
Changes to the TypeScript library should only be made to files under the node
subfolder. Changes to the Rust implementation requires regenerating files under the wasm
subfolder.
Onces changes are in place they can be made permanent into the repository by committing the contents of both folders. Here is the bulk of the process:
Open your terminal or command prompt.
Use
git
to clone the repository:If you make TypeScript only changes, you can quickly rebuild the package using the
build:node
NPM script:If instead you make Rust changes, it is necessary to generate the WASM interoperability code using the
build
NPM script:However, before commiting changes, it is necessary to generate the WASM interoperability code in a reproducible manner using docker:
How wasm-pack
is used to achieve interoperability
wasm-pack
is used to achieve interoperabilityInternaly the build
NPM script uses wasm-pack
to produce the WASM interoperability code. This is achieved by running
Let's unpack it.
In the Rust source folder we run wasm-pack
in --target web
mode. This generates TypeScript code targeting web pages. The --release
option is required to minimize the size of the WASM module. And the --no-default-features
disables the need to build non WASM features of garaga_rs.
Once the wasm-pack
is done, the code is generated under the folder src/wasm/pkg
of garaga_ts that houses the TypeScript source code.
We then run a custom script patch.wasm.cjs
which makes minimal changes to the code generated by wasm-pack to facilitate seamless support of the WASM module in both the browser and Node.js. Basically it converts the WASM module to a Base64 string that can be loaded in a portable way in both environments, amongst other minor tweaks.
(It is important to note that the use of a custom script is only required so long wasm-pack
itself does not provide a more portable/universal target mode.)
Last updated