WebAssembly API implementation (#4815)

Author: mewim

.github/workflows/ci-workflow.yml

@@ -287,14 +287,31 @@ jobs:
         with:
           name: binary-demo
           path: dataset/binary-demo
+      
+      - name: Install dependencies
+        working-directory: tools/wasm
+        run: npm i
 
-      - name: Build & test
+      - name: Build WebAssembly package
+        working-directory: tools/wasm
+        run: |
+          source /home/runner/emsdk/emsdk_env.sh
+          npm run build
+      
+      - name: API test
+        working-directory: tools/wasm
+        run: npm run test
+
+      - name: Clean up
+        run: make clean
+        
+      - name: Kernel build & test
         run: |
           ln -s /home/runner/ldbc-1-csv dataset/ldbc-1/csv
           source /home/runner/emsdk/emsdk_env.sh
           make wasmtest
 
-      - name: Build & test (single-thread mode)
+      - name: Kernel build & test (single-threaded)
         env:
           SINGLE_THREADED: true
         run: |

.github/workflows/gen-docs.yml

@@ -78,6 +78,33 @@ jobs:
         with:
           name: kuzu-nodejs-docs
           path: ./docs
+  
+  generate-wasm-docs:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Install Node.js packages
+        run: |
+          npm install -g jsdoc
+
+      - name: Generate Node.js docs
+        shell: bash
+        run: |
+          mkdir docs
+          jsdoc ./tools/wasm/src_js/sync/*.js ./tools/wasm/src_js/sync/README.md --destination ./docs/sync
+          jsdoc ./tools/wasm/src_js/*.js ./tools/wasm/src_js/README.md --destination ./docs/async
+
+      - name: Upload Node.js docs
+        uses: actions/upload-artifact@v4
+        with:
+          name: kuzu-wasm-docs
+          path: ./docs
 
   generate-java-docs:
     runs-on: ubuntu-latest
@@ -127,7 +154,13 @@ jobs:
 
   update-docs:
     runs-on: ubuntu-22.04
-    needs: [generate-python-docs, generate-nodejs-docs, generate-java-docs, generate-cpp-docs]
+    needs: [
+      generate-python-docs,
+      generate-nodejs-docs,
+      generate-wasm-docs,
+      generate-java-docs,
+      generate-cpp-docs
+    ]
     steps:
       - uses: actions/checkout@v4
         with:
@@ -149,6 +182,12 @@ jobs:
         with:
           name: kuzu-nodejs-docs
           path: kuzudb.github.io/api-docs/nodejs
+
+      - name: Download WASM docs
+        uses: actions/download-artifact@v4
+        with:
+          name: kuzu-wasm-docs
+          path: kuzudb.github.io/api-docs/wasm
 
       - name: Download Java docs
         uses: actions/download-artifact@v4

.github/workflows/wasm-workflow.yml

@@ -0,0 +1,36 @@
+name: Build WebAssembly module
+
+on:
+  workflow_dispatch:
+  workflow_call:
+    inputs:
+      isNightly:
+        type: boolean
+        required: true
+        default: false
+
+jobs:
+  build-wasm:
+    runs-on: kuzu-self-hosted-testing
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Update nightly version
+        if: ${{ inputs.isNightly == true }}
+        env:
+          PIP_BREAK_SYSTEM_PACKAGES: 1
+        run: |
+          python3 -m pip install packaging
+          python3 update-nightly-build-version.py
+        working-directory: scripts
+      
+      - name: Build WebAssembly package
+        working-directory: tools/wasm
+        run: |
+          source /home/runner/emsdk/emsdk_env.sh
+          npm run build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: kuzu-deploy-wasm
+          path: tools/wasm/kuzu-wasm.tar.gz

.gitignore

@@ -46,6 +46,14 @@ tools/nodejs_api/cmake_install.cmake
 tools/nodejs_api/package-lock.json
 tools/nodejs_api/prebuilt/
 
+### WASM
+tools/wasm/node_modules/
+tools/wasm/examples/browser/node_modules/
+tools/wasm/examples/browser/public/index.js
+tools/wasm/examples/browser/public/kuzu_wasm_worker.js
+tools/wasm/examples/nodejs/node_modules/
+tools/wasm/package/
+
 # Archive files
 *.zip
 *.tar.gz

CMakeLists.txt

@@ -158,21 +158,35 @@ else()
     add_compile_options(-Wno-unknown-pragmas)
 endif()
 
-if(BUILD_WASM)
+if(${BUILD_WASM})
     if(NOT __SINGLE_THREADED__)
         add_compile_options(-pthread)
         add_link_options(-pthread)
         add_link_options(-sPTHREAD_POOL_SIZE=8)
     endif()
     add_compile_options(-s DISABLE_EXCEPTION_CATCHING=0)
     add_link_options(-sSTACK_SIZE=4MB)
+    add_link_options(-sASSERTIONS=1)
+    add_link_options(-lembind)
+    add_link_options(-sWASM_BIGINT)
+
     if(BUILD_TESTS OR BUILD_EXTENSION_TESTS)
-        add_link_options(-sINITIAL_MEMORY=3892MB) # 3.8GB
+        add_link_options(-sINITIAL_MEMORY=3892MB)
+        add_link_options(-sNODERAWFS=1)
+    elseif(WASM_NODEFS)
         add_link_options(-sNODERAWFS=1)
-        add_link_options(-sASSERTIONS=1)
+        add_link_options(-sALLOW_MEMORY_GROWTH=1)
+        add_link_options(-sMODULARIZE=1)
+        add_link_options(-sEXPORTED_RUNTIME_METHODS=FS,wasmMemory)
+        add_link_options(-sEXPORT_NAME=kuzu)
+        add_link_options(-sMAXIMUM_MEMORY=4GB)
     else()
-        add_link_options(-sINITIAL_MEMORY=2GB)
+        add_link_options(-sSINGLE_FILE=1)
         add_link_options(-sALLOW_MEMORY_GROWTH=1)
+        add_link_options(-sMODULARIZE=1)
+        add_link_options(-sEXPORTED_RUNTIME_METHODS=FS,wasmMemory)
+        add_link_options(-sEXPORT_NAME=kuzu)
+        add_link_options(-sMAXIMUM_MEMORY=4GB)
     endif()
     set(__WASM__ TRUE)
     add_compile_options(-fexceptions)

Makefile

@@ -73,6 +73,10 @@ ifdef SINGLE_THREADED
 	CMAKE_FLAGS += -DSINGLE_THREADED=$(SINGLE_THREADED)
 endif
 
+ifdef WASM_NODEFS
+	CMAKE_FLAGS += -DWASM_NODEFS=$(WASM_NODEFS)
+endif
+
 # Must be first in the Makefile so that it is the default target.
 release:
 	$(call run-cmake-release,)
@@ -139,6 +143,11 @@ python:
 python-debug:
 	$(call run-cmake-debug, -DBUILD_PYTHON=TRUE)
 
+wasm:
+	mkdir -p build/wasm && cd build/wasm &&\
+	emcmake cmake $(CMAKE_FLAGS) -DCMAKE_BUILD_TYPE=Release -DBUILD_WASM=TRUE -DBUILD_BENCHMARK=FALSE -DBUILD_TESTS=FALSE -DBUILD_SHELL=FALSE  ../.. && \
+	cmake --build . --config Release -j $(NUM_THREADS)
+
 # Language API tests
 javatest:
 ifeq ($(OS),Windows_NT)

src/main/database.cpp

@@ -59,7 +59,7 @@ SystemConfig::SystemConfig(uint64_t bufferPoolSize_, uint64_t maxNumThreads, boo
 #else
     // In single-threaded mode, even if the user specifies a number of threads,
     // it will be ignored and set to 0.
-    this->maxNumThreads = 0;
+    this->maxNumThreads = 1;
 #endif
     if (maxDBSize == -1u) {
         maxDBSize = BufferPoolConstants::DEFAULT_VM_REGION_MAX_SIZE;

tools/CMakeLists.txt

@@ -13,3 +13,6 @@ endif()
 if(${BUILD_BENCHMARK})
     add_subdirectory(benchmark)
 endif()
+if(${BUILD_WASM})
+    add_subdirectory(wasm)
+endif()

tools/nodejs_api/src_js/database.js

@@ -1,7 +1,6 @@
 "use strict";
 
 const KuzuNative = require("./kuzu_native.js");
-const LoggingLevel = require("./logging_level.js");
 
 class Database {
   /**
@@ -38,7 +37,7 @@ class Database {
       throw new Error("Buffer manager size must be a positive integer.");
     }
     if (typeof maxDBSize !== "number" || maxDBSize < 0) {
-      throw new Error("Max DB size must be a positive integer.");
+    throw new Error("Max DB size must be a positive integer.");
     }
     if (typeof checkpointThreshold !== "number" || maxDBSize < -1) {
       throw new Error("Checkpoint threshold must be a positive integer.");
@@ -90,10 +89,6 @@ class Database {
             } else {
               try {
                 this._isInitialized = true;
-                if (this._loggingLevel) {
-                  this.setLoggingLevel(this._loggingLevel);
-                  delete this._loggingLevel;
-                }
               } catch (e) {
                 return reject(e);
               }

tools/nodejs_api/src_js/index.js

@@ -2,14 +2,12 @@
 
 const Connection = require("./connection.js");
 const Database = require("./database.js");
-const LoggingLevel = require("./logging_level.js");
 const PreparedStatement = require("./prepared_statement.js");
 const QueryResult = require("./query_result.js");
 
 module.exports = {
   Connection,
   Database,
-  LoggingLevel,
   PreparedStatement,
   QueryResult,
   get VERSION() {