Feat: PowerSync encryption with SQLCipher (#194)

* Setup powersync core

* Fix tests running in core

* Move setup web script to core

* Remove dependencies from powersync

* Add back lints dev dependency to powersync

* - Working sqlcipher factory with tests
- Package refactoring and cleanup

* Download dynamic library for sqlciper tests

* Remove sqlcipher tests

* Clean up versions

* Cleanup print statement

* Cleanup powersync export

* Update locked versions

* Add license and notice

* Update pubspec.lock

* Move setup_web script back to powersync

* Fix tests
quoteString for encryption key

* Update readme and dependencies

* Copy powersync_db_worker to powersync_core for tests

* Update READMEs

* Update readme

* Update readme

* Readme polish

* More polish

* Explainer of the 3 SDKs, MySQL updates

* Update readme and lower initial release versions

* Improve dart demo

* Fix changelog versions

* Fix sed command for build numbers

* Update packages/powersync/README.md

Co-authored-by: Ralf Kistner <ralf@journeyapps.com>

* Fix preCommit version script

* New user agent based on core package

* chore(release): publish packages
 - powersync@1.10.0
 - powersync_core@1.0.0
 - powersync_sqlcipher@0.1.0
 - powersync_attachments_helper@0.6.16

* Trigger publish on new packages

---------

Co-authored-by: benitav <benitav@users.noreply.github.com>
Co-authored-by: benitav <benita@journeyapps.com>
Co-authored-by: Ralf Kistner <ralf@journeyapps.com>

.github/workflows/publish.yml

@@ -5,6 +5,8 @@ on:
       - "powersync-v[0-9]+.[0-9]+.[0-9]+"
       - "powersync_attachments_helper-v[0-9]+.[0-9]+.[0-9]+*"
       - "powersync_flutter_libs-v[0-9]+.[0-9]+.[0-9]+*"
+      - "powersync_core-v[0-9]+.[0-9]+.[0-9]+*"
+      - "powersync_sqlcipher-v[0-9]+.[0-9]+.[0-9]+*"
   workflow_dispatch:
 
 jobs:
@@ -35,7 +37,7 @@ jobs:
         env:
           GITHUBREF: ${{ github.ref }}
         run: |
-          PACKAGE_NAME=$(sed -E 's/refs\/tags\/([a-z0-9_]+)-v([0-9]+\.[0-9]+\.[0-9]+)/\1/' <<< $GITHUBREF) && \
+          PACKAGE_NAME=$(sed -E 's/refs\/tags\/([a-z0-9_]+)-v([0-9]+\.[0-9]+\.[0-9]+(\+[0-9]+)?)/\1/' <<< $GITHUBREF) && \
           echo "PACKAGE_NAME=$PACKAGE_NAME" >> $GITHUB_ENV
           echo "Package name: $PACKAGE_NAME"
 

CHANGELOG.md

@@ -3,6 +3,34 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 2024-11-12
+
+### Changes
+
+---
+
+Packages with breaking changes:
+
+ - There are no breaking changes in this release.
+
+Packages with other changes:
+
+ - [`powersync` - `v1.10.0`](#powersync---v1100)
+ - [`powersync_attachments_helper` - `v0.6.16`](#powersync_attachments_helper---v0616)
+ - [`powersync_core` - `v1.0.0`](#powersync_core---v100)
+ - [`powersync_sqlcipher` - `v0.1.0`](#powersync_sqlcipher---v010)
+
+---
+
+#### `powersync` - `v1.10.0`
+
+#### `powersync_attachments_helper` - `v0.6.16`
+
+#### `powersync_core` - `v1.0.0`
+
+#### `powersync_sqlcipher` - `v0.1.0`
+
+
 ## 2024-11-11
 
 ### Changes

demos/benchmarks/ios/Flutter/Debug.xcconfig

@@ -1 +1,2 @@
+#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig"
 #include "Generated.xcconfig"

demos/benchmarks/ios/Flutter/Release.xcconfig

@@ -1 +1,2 @@
+#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig"
 #include "Generated.xcconfig"

demos/benchmarks/ios/Podfile

@@ -0,0 +1,44 @@
+# Uncomment this line to define a global platform for your project
+# platform :ios, '12.0'
+
+# CocoaPods analytics sends network stats synchronously affecting flutter build latency.
+ENV['COCOAPODS_DISABLE_STATS'] = 'true'
+
+project 'Runner', {
+  'Debug' => :debug,
+  'Profile' => :release,
+  'Release' => :release,
+}
+
+def flutter_root
+  generated_xcode_build_settings_path = File.expand_path(File.join('..', 'Flutter', 'Generated.xcconfig'), __FILE__)
+  unless File.exist?(generated_xcode_build_settings_path)
+    raise "#{generated_xcode_build_settings_path} must exist. If you're running pod install manually, make sure flutter pub get is executed first"
+  end
+
+  File.foreach(generated_xcode_build_settings_path) do |line|
+    matches = line.match(/FLUTTER_ROOT\=(.*)/)
+    return matches[1].strip if matches
+  end
+  raise "FLUTTER_ROOT not found in #{generated_xcode_build_settings_path}. Try deleting Generated.xcconfig, then run flutter pub get"
+end
+
+require File.expand_path(File.join('packages', 'flutter_tools', 'bin', 'podhelper'), flutter_root)
+
+flutter_ios_podfile_setup
+
+target 'Runner' do
+  use_frameworks!
+  use_modular_headers!
+
+  flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))
+  target 'RunnerTests' do
+    inherit! :search_paths
+  end
+end
+
+post_install do |installer|
+  installer.pods_project.targets.each do |target|
+    flutter_additional_ios_build_settings(target)
+  end
+end

demos/benchmarks/macos/Flutter/Flutter-Debug.xcconfig

@@ -1 +1,2 @@
+#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig"
 #include "ephemeral/Flutter-Generated.xcconfig"

demos/benchmarks/macos/Flutter/Flutter-Release.xcconfig

@@ -1 +1,2 @@
+#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig"
 #include "ephemeral/Flutter-Generated.xcconfig"

demos/benchmarks/macos/Podfile

@@ -0,0 +1,43 @@
+platform :osx, '10.14'
+
+# CocoaPods analytics sends network stats synchronously affecting flutter build latency.
+ENV['COCOAPODS_DISABLE_STATS'] = 'true'
+
+project 'Runner', {
+  'Debug' => :debug,
+  'Profile' => :release,
+  'Release' => :release,
+}
+
+def flutter_root
+  generated_xcode_build_settings_path = File.expand_path(File.join('..', 'Flutter', 'ephemeral', 'Flutter-Generated.xcconfig'), __FILE__)
+  unless File.exist?(generated_xcode_build_settings_path)
+    raise "#{generated_xcode_build_settings_path} must exist. If you're running pod install manually, make sure \"flutter pub get\" is executed first"
+  end
+
+  File.foreach(generated_xcode_build_settings_path) do |line|
+    matches = line.match(/FLUTTER_ROOT\=(.*)/)
+    return matches[1].strip if matches
+  end
+  raise "FLUTTER_ROOT not found in #{generated_xcode_build_settings_path}. Try deleting Flutter-Generated.xcconfig, then run \"flutter pub get\""
+end
+
+require File.expand_path(File.join('packages', 'flutter_tools', 'bin', 'podhelper'), flutter_root)
+
+flutter_macos_podfile_setup
+
+target 'Runner' do
+  use_frameworks!
+  use_modular_headers!
+
+  flutter_install_all_macos_pods File.dirname(File.realpath(__FILE__))
+  target 'RunnerTests' do
+    inherit! :search_paths
+  end
+end
+
+post_install do |installer|
+  installer.pods_project.targets.each do |target|
+    flutter_additional_macos_build_settings(target)
+  end
+end

demos/benchmarks/pubspec.lock

@@ -306,6 +306,13 @@ packages:
       relative: true
     source: path
     version: "1.9.2"
+  powersync_core:
+    dependency: "direct overridden"
+    description:
+      path: "../../packages/powersync_core"
+      relative: true
+    source: path
+    version: "0.0.1"
   powersync_flutter_libs:
     dependency: "direct overridden"
     description:

demos/benchmarks/pubspec.yaml

@@ -10,7 +10,7 @@ environment:
 dependencies:
   flutter:
     sdk: flutter
-  powersync: ^1.9.3
+  powersync: ^1.10.0
   path_provider: ^2.1.1
   path: ^1.8.3
   logging: ^1.2.0

demos/django-todolist/pubspec.lock

@@ -319,6 +319,13 @@ packages:
       relative: true
     source: path
     version: "1.9.2"
+  powersync_core:
+    dependency: "direct overridden"
+    description:
+      path: "../../packages/powersync_core"
+      relative: true
+    source: path
+    version: "0.0.1"
   powersync_flutter_libs:
     dependency: "direct overridden"
     description:

demos/django-todolist/pubspec.yaml

@@ -10,7 +10,7 @@ environment:
 dependencies:
   flutter:
     sdk: flutter
-  powersync: ^1.9.3
+  powersync: ^1.10.0
   path_provider: ^2.1.1
   path: ^1.8.3
   logging: ^1.2.0

demos/supabase-anonymous-auth/pubspec.lock

@@ -375,6 +375,13 @@ packages:
       relative: true
     source: path
     version: "1.9.2"
+  powersync_core:
+    dependency: "direct overridden"
+    description:
+      path: "../../packages/powersync_core"
+      relative: true
+    source: path
+    version: "0.0.1"
   powersync_flutter_libs:
     dependency: "direct overridden"
     description:

demos/supabase-anonymous-auth/pubspec.yaml

@@ -11,7 +11,7 @@ dependencies:
   flutter:
     sdk: flutter
 
-  powersync: ^1.9.3
+  powersync: ^1.10.0
   path_provider: ^2.1.1
   supabase_flutter: ^2.0.2
   path: ^1.8.3

demos/supabase-edge-function-auth/pubspec.lock

@@ -399,6 +399,13 @@ packages:
       relative: true
     source: path
     version: "1.9.2"
+  powersync_core:
+    dependency: "direct overridden"
+    description:
+      path: "../../packages/powersync_core"
+      relative: true
+    source: path
+    version: "0.0.1"
   powersync_flutter_libs:
     dependency: "direct overridden"
     description:

demos/supabase-edge-function-auth/pubspec.yaml

@@ -11,7 +11,7 @@ dependencies:
   flutter:
     sdk: flutter
 
-  powersync: ^1.9.3
+  powersync: ^1.10.0
   path_provider: ^2.1.1
   supabase_flutter: ^2.0.2
   path: ^1.8.3

demos/supabase-simple-chat/pubspec.lock

@@ -415,6 +415,13 @@ packages:
       relative: true
     source: path
     version: "1.9.2"
+  powersync_core:
+    dependency: "direct overridden"
+    description:
+      path: "../../packages/powersync_core"
+      relative: true
+    source: path
+    version: "0.0.1"
   powersync_flutter_libs:
     dependency: "direct overridden"
     description:

demos/supabase-simple-chat/pubspec.yaml

@@ -37,7 +37,7 @@ dependencies:
 
   supabase_flutter: ^2.0.2
   timeago: ^3.6.0
-  powersync: ^1.9.3
+  powersync: ^1.10.0
   path_provider: ^2.1.1
   path: ^1.8.3
   logging: ^1.2.0

demos/supabase-todolist-drift/pubspec.lock

@@ -694,6 +694,13 @@ packages:
       relative: true
     source: path
     version: "0.6.15+1"
+  powersync_core:
+    dependency: "direct overridden"
+    description:
+      path: "../../packages/powersync_core"
+      relative: true
+    source: path
+    version: "0.0.1"
   powersync_flutter_libs:
     dependency: "direct overridden"
     description:

demos/supabase-todolist-drift/pubspec.yaml

@@ -9,8 +9,8 @@ environment:
 dependencies:
   flutter:
     sdk: flutter
-  powersync_attachments_helper: ^0.6.15+2
-  powersync: ^1.9.3
+  powersync_attachments_helper: ^0.6.16
+  powersync: ^1.10.0
   path_provider: ^2.1.1
   supabase_flutter: ^2.0.1
   path: ^1.8.3

demos/supabase-todolist-optional-sync/pubspec.lock

@@ -479,6 +479,13 @@ packages:
       relative: true
     source: path
     version: "1.9.2"
+  powersync_core:
+    dependency: "direct overridden"
+    description:
+      path: "../../packages/powersync_core"
+      relative: true
+    source: path
+    version: "0.0.1"
   powersync_flutter_libs:
     dependency: "direct overridden"
     description:

demos/supabase-todolist-optional-sync/pubspec.yaml

@@ -10,7 +10,7 @@ environment:
 dependencies:
   flutter:
     sdk: flutter
-  powersync: ^1.9.3
+  powersync: ^1.10.0
   path_provider: ^2.1.1
   supabase_flutter: ^2.0.1
   path: ^1.8.3