Wasm-git ======== (Wasm should be pronounced like `awesome` starting with a `W` ).
npm install wasm-gitWasm-git
========
(Wasm should be pronounced like awesome starting with a W ).
GIT for nodejs and the browser using libgit2 compiled to WebAssembly with Emscripten.
The main purpose of bringing git to the browser, is to enable storage of web application data locally in the users web browser, with the option to synchronize with a remote server.
A simple demo in the browser can be found at:
https://wasm-git.petersalomonsen.com/
Please do not abuse, this is open for you to test and see the proof of concept
The sources for the demo can be found in the githttpserver project. It shows basic operations like cloning, edit files, add and commit, push and pull.
Videos showing example applications using wasm-git can bee seen in this playlist. Wasm-git is used for local and offline storage of web application data, and for syncing with a remote server.
Wasm-git packages are built in two variants: Synchronuous and Asynchronuous. To run the sync version in the browser, a webworker is needed. This is because of the use of synchronous http requests and long running operations that would block if running on the main thread. The sync version has the smallest binary, but need extra client code to communicate with the web worker. When using the sync version in nodejs worker_threads are used, with Atomics to exchange data between threads.
The async version use Emscripten Asyncify, which allows calling the Wasm-git functions with async / await. It can also run from the main thread in the browser. Asyncify increase the binary size because of instrumentation to unwind and rewind WebAssembly state, but makes it possible to have simple client code without exchanging data with worker threads like in the sync version.
Examples of using Wasm-git can be found in the tests:
- test for NodeJS
- test-browser for the sync version in the browser with a web worker
- test-browser-async] for the async version in the browser
The examples shows importing the lg2.js / lg2-async.js modules from the local build, but you may also access these from releases available at public CDNs.
The Github actions test pipeline shows all the commands needed to install dependencies, build the packages and run the tests.
Another option is loading the repository into a github codespace, where the configuration in .devcontainer folder will be used to install dependencies and set up a full development environment.
As part of being able to compile libgit2 to WebAssembly and run it in a Javascript environment, some fixes to Emscripten were needed.
Here are the Pull Requests that resolved the issues identified when the first version was developed:
- https://github.com/emscripten-core/emscripten/pull/10095
- https://github.com/emscripten-core/emscripten/pull/10526
- https://github.com/emscripten-core/emscripten/pull/10782
for using with NODEFS you'll also need https://github.com/emscripten-core/emscripten/pull/10669
All of these pull requests are merged to emscripten master as of 2020-03-29.