Skip to content

Commit 8e87ca9

Browse files
simolus3simolus3
committed
Compile sqlite wasm files
1 parent 51a6061 commit 8e87ca9

File tree

7 files changed

+177
-2
lines changed

7 files changed

+177
-2
lines changed

‎.github/workflows/release.yml‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88

99
jobs:
1010
build:
11-
runs-on: ubuntu-latest
11+
runs-on: macos-latest
1212
permissions:
1313
contents: write
1414

@@ -21,13 +21,23 @@ jobs:
2121
with:
2222
flutter-version: '3.x'
2323
channel: 'stable'
24+
- name: Setup Homebrew
25+
id: set-up-homebrew
26+
uses: Homebrew/actions/setup-homebrew@master
27+
- name: Setup macOS build dependencies
28+
run: brew install cmake llvm binaryen wasi-libc wasi-runtimes
2429

2530
- name: Install Melos
2631
run: flutter pub global activate melos
2732

2833
- name: Install Dependencies and Compile Assets
2934
run: melos prepare
3035

36+
- name: Compile sqlite3.wasm on macOS
37+
if: runner.os == 'macOS'
38+
working-directory: packages/sqlite3_wasm_build
39+
run: ./build.sh
40+
3141
- name: Create Draft Release
3242
env:
3343
GH_TOKEN: ${{ github.token }}
@@ -39,4 +49,4 @@ jobs:
3949
body="Release $tag
4050
$changes"
4151
gh release create "$tag" --title "$tag" --notes "$body"
42-
gh release upload "${{ github.ref_name }}" packages/powersync/assets/powersync_db.worker.js packages/powersync/assets/powersync_sync.worker.js
52+
gh release upload "${{ github.ref_name }}" packages/powersync/assets/powersync_db.worker.js packages/powersync/assets/powersync_sync.worker.js packages/sqlite3_wasm_build/dist/*.wasm

‎.github/workflows/test_wasm.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Build SQLite3 WASM
2+
3+
on:
4+
push:
5+
branches: ["**"]
6+
7+
jobs:
8+
compile_sqlite3_wasm:
9+
name: Compile sqlite3 wasm
10+
runs-on: macos-latest
11+
12+
steps:
13+
- uses: actions/checkout@v4
14+
- name: Setup Homebrew
15+
id: set-up-homebrew
16+
uses: Homebrew/actions/setup-homebrew@master
17+
- name: Install Dart SDK
18+
uses: dart-lang/setup-dart@v1
19+
- name: Setup macOS build dependencies
20+
run: brew install cmake llvm binaryen wasi-libc wasi-runtimes
21+
- name: Compile sqlite3.wasm on macOS
22+
if: runner.os == 'macOS'
23+
working-directory: packages/sqlite3_wasm_build
24+
run: ./build.sh

‎packages/sqlite3_wasm_build/.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
node_modules
2+
pnpm-lock.yaml
3+
sqlite3.dart
4+
dist

‎packages/sqlite3_wasm_build/README.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
This directory includes tools to build `sqlite3.wasm` files compatible with the
2+
PowerSync Dart SDK.
3+
4+
This build process is adapted from [`package:sqlite3`][upstream], with patches
5+
applied to link the [PowerSync SQLite extension][core] statically.
6+
7+
### Working on patches
8+
9+
To adapt the patches:
10+
11+
1. Clone `https://github.com/simolus3/sqlite3.dart.git` somewhere.
12+
2. Apply the existing patches to your clone: `git apply patches/*`.
13+
3. Rebase onto a new upstream release if necessary.
14+
4. Obtain a new patchset with `git format-patch upstreamref..HEAD`.
15+
16+
[upstream]: https://github.com/simolus3/sqlite3.dart/tree/main/sqlite3/assets/wasm
17+
[core]: https://github.com/powersync-ja/powersync-sqlite-core

‎packages/sqlite3_wasm_build/build.sh‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
#!/bin/sh
2+
set -e
3+
4+
SQLITE_VERSION="2.7.2"
5+
POWERSYNC_CORE_VERSION="0.3.9"
6+
SQLITE_PATH="sqlite3.dart"
7+
8+
if [ -d "$SQLITE_PATH" ]; then
9+
echo "Deleting existing clone"
10+
rm -rf $SQLITE_PATH
11+
fi
12+
13+
git clone --branch "sqlite3-$SQLITE_VERSION" --depth 1 https://github.com/simolus3/sqlite3.dart.git $SQLITE_PATH
14+
15+
cd $SQLITE_PATH
16+
git apply ../patches/*
17+
18+
cd "sqlite3/"
19+
dart pub get # We need the analyzer dependency resolved to extract required symbols
20+
21+
cmake -Dwasi_sysroot=/opt/homebrew/share/wasi-sysroot \
22+
-Dclang=/opt/homebrew/opt/llvm/bin/clang\
23+
-DPOWERSYNC_VERSION="$POWERSYNC_CORE_VERSION" \
24+
-S assets/wasm -B .dart_tool/sqlite3_build
25+
cmake --build .dart_tool/sqlite3_build/ -t output -j
26+
27+
cd ../../
28+
mkdir -p dist
29+
cp $SQLITE_PATH/sqlite3/example/web/*.wasm dist

‎packages/sqlite3_wasm_build/package.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"name": "dart_powersync_wasm",
3+
"version": "0.0.1",
4+
"description": "WebAssembly modules containing SQLite + PowerSync for Dart apps.",
5+
"repository": {
6+
"type": "git",
7+
"url": "git+https://github.com/powersync-ja/powersync.dart.git",
8+
"directory": "packages/sqlite3_wasm_build"
9+
}
10+
}

‎packages/sqlite3_wasm_build/patches/0001-Link-PowerSync-core-extension.patch‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
From 04fd5a3a01be7b42ec97c2d9865e4c7501b5b6a8 Mon Sep 17 00:00:00 2001
2+
From: Simon Binder <simon@journeyapps.com>
3+
Date: Mon, 27 Jan 2025 15:12:53 +0100
4+
Subject: [PATCH] Link PowerSync core extension
5+
6+
---
7+
sqlite3/assets/wasm/CMakeLists.txt | 7 ++++++-
8+
sqlite3/assets/wasm/os_web.c | 11 ++++++++++-
9+
sqlite3/assets/wasm/sqlite_cfg.h | 2 +-
10+
3 files changed, 17 insertions(+), 3 deletions(-)
11+
12+
diff --git a/sqlite3/assets/wasm/CMakeLists.txt b/sqlite3/assets/wasm/CMakeLists.txt
13+
index e4283b3..5c52593 100644
14+
--- a/sqlite3/assets/wasm/CMakeLists.txt
15+
+++ b/sqlite3/assets/wasm/CMakeLists.txt
16+
@@ -6,6 +6,7 @@ project(${PROJECT_NAME} LANGUAGES C)
17+
set(triple wasm32-unknown-wasi)
18+
set(wasi_sysroot "/usr/share/wasi-sysroot" CACHE PATH "Path to wasi sysroot")
19+
set(clang "clang" CACHE FILEPATH "Path to wasm-capable clang executable")
20+
+set(POWERSYNC_VERSION "0.3.9" CACHE STRING "PowerSync core version to use")
21+
22+
include(FetchContent)
23+
24+
@@ -27,6 +28,9 @@ FetchContent_MakeAvailable(sqlite3mc)
25+
26+
file(DOWNLOAD https://raw.githubusercontent.com/sqlite/sqlite/master/src/test_vfstrace.c "${CMAKE_BINARY_DIR}/vfstrace.c")
27+
28+
+set(POWERSYNC_A "${CMAKE_BINARY_DIR}/libpowersync-wasm.a")
29+
+file(DOWNLOAD "https://github.com/powersync-ja/powersync-sqlite-core/releases/download/v${POWERSYNC_VERSION}/libpowersync-wasm.a" "${POWERSYNC_A}")
30+
+
31+
# Generate symbols we need to export from the sqlite3.wasm build
32+
add_custom_command(
33+
OUTPUT required_symbols.txt
34+
@@ -88,8 +92,9 @@ macro(base_sqlite3_target name debug crypto)
35+
-Wl,--import-memory
36+
--sysroot ${wasi_sysroot}
37+
${sources}
38+
+ ${POWERSYNC_A}
39+
@${CMAKE_CURRENT_BINARY_DIR}/required_symbols.txt
40+
- DEPENDS ${sources} required_symbols
41+
+ DEPENDS ${sources} ${POWERSYNC_A} required_symbols
42+
VERBATIM
43+
)
44+
45+
diff --git a/sqlite3/assets/wasm/os_web.c b/sqlite3/assets/wasm/os_web.c
46+
index 04f2e97..666902d 100644
47+
--- a/sqlite3/assets/wasm/os_web.c
48+
+++ b/sqlite3/assets/wasm/os_web.c
49+
@@ -4,6 +4,15 @@
50+
51+
#include "sqlite3.h"
52+
53+
-int sqlite3_os_init(void) { return SQLITE_OK; }
54+
+extern int sqlite3_powersync_init(sqlite3 *db, char **pzErrMsg,
55+
+ const sqlite3_api_routines *pApi);
56+
+
57+
+int sqlite3_os_init(void) {
58+
+ int rc = sqlite3_auto_extension((void (*)(void)) & sqlite3_powersync_init);
59+
+ if (rc != SQLITE_OK) {
60+
+ return rc;
61+
+ }
62+
+ return SQLITE_OK;
63+
+}
64+
65+
int sqlite3_os_end(void) { return SQLITE_OK; }
66+
diff --git a/sqlite3/assets/wasm/sqlite_cfg.h b/sqlite3/assets/wasm/sqlite_cfg.h
67+
index 6f3e3c2..45847f8 100644
68+
--- a/sqlite3/assets/wasm/sqlite_cfg.h
69+
+++ b/sqlite3/assets/wasm/sqlite_cfg.h
70+
@@ -43,7 +43,7 @@
71+
// Disable things we don't need
72+
#define SQLITE_OMIT_DEPRECATED
73+
#define SQLITE_OMIT_PROGRESS_CALLBACK
74+
-#define SQLITE_OMIT_AUTHORIZATION
75+
+// #define SQLITE_OMIT_AUTHORIZATION // This breaks the powersync-core build
76+
#define SQLITE_UNTESTABLE
77+
#define SQLITE_OMIT_COMPILEOPTION_DIAGS
78+
#define SQLITE_OMIT_LOAD_EXTENSION
79+
--
80+
2.39.5 (Apple Git-154)
81+

0 commit comments

Comments
 (0)