- Working sqlcipher factory with tests

mugikhan · mugikhan · commit b75cfb9793bc · 2024-10-16T21:43:37.000+02:00
- Package refactoring and cleanup
diff --git a/packages/powersync/lib/powersync.dart b/packages/powersync/lib/powersync.dart
@@ -1,4 +1,4 @@
-/// PowerSync Dart SDK.
+/// PowerSync Flutter SDK.
 ///
 /// Use [PowerSyncDatabase] to open a database.
 library;
diff --git a/packages/powersync/lib/sqlite3_open.dart b/packages/powersync/lib/sqlite3_open.dart
@@ -0,0 +1,5 @@
+/// Re-exports [sqlite3_open](https://pub.dev/packages/sqlite3) to expose sqlite3_open without
+/// adding it as a direct dependency.
+library;
+
+export 'package:powersync_core/sqlite3_open.dart';
diff --git a/packages/powersync/pubspec.yaml b/packages/powersync/pubspec.yaml
@@ -14,6 +14,7 @@ dependencies:
   powersync_core: ^1.0.0
 dev_dependencies:
   lints: ^3.0.0
+  path: ^1.8.3
   path_provider: ^2.0.13
 
 platforms:
diff --git a/packages/powersync_attachments_helper/README.md b/packages/powersync_attachments_helper/README.md
@@ -4,14 +4,14 @@
 
 ## Features
 
-* Handles syncing uploads, downloads and deletes between local and remote storage.
+- Handles syncing uploads, downloads and deletes between local and remote storage.
 
 ## Getting started
 
 ```dart
 import 'dart:async';
 import 'package:powersync_attachments_helper/powersync_attachments_helper.dart';
-import 'package:powersync/powersync.dart';
+import 'package:powersync_core/powersync_core.dart';
 
 // Set up schema with an id field that can be used in watchIds().
 // In this case it is photo_id
diff --git a/packages/powersync_attachments_helper/example/getting_started.dart b/packages/powersync_attachments_helper/example/getting_started.dart
@@ -1,7 +1,7 @@
 import 'dart:async';
 
 import 'package:powersync_attachments_helper/powersync_attachments_helper.dart';
-import 'package:powersync/powersync.dart';
+import 'package:powersync_core/powersync_core.dart';
 
 const schema = Schema([
   Table('users', [Column.text('name'), Column.text('photo_id')])
diff --git a/packages/powersync_attachments_helper/lib/src/attachments_queue.dart b/packages/powersync_attachments_helper/lib/src/attachments_queue.dart
@@ -6,7 +6,7 @@ import './local_storage_adapter.dart';
 import './remote_storage_adapter.dart';
 import './syncing_service.dart';
 import 'package:logging/logging.dart';
-import 'package:powersync/powersync.dart';
+import 'package:powersync_core/powersync_core.dart';
 
 /// Logger for the attachment queue
 final log = Logger('AttachmentQueue');
diff --git a/packages/powersync_attachments_helper/lib/src/attachments_queue_table.dart b/packages/powersync_attachments_helper/lib/src/attachments_queue_table.dart
@@ -1,5 +1,5 @@
-import 'package:powersync/powersync.dart';
-import 'package:powersync/sqlite3_common.dart' as sqlite;
+import 'package:powersync_core/powersync_core.dart';
+import 'package:powersync_core/sqlite3_common.dart' as sqlite;
 
 const defaultAttachmentsQueueTableName = 'attachments_queue';
 
diff --git a/packages/powersync_attachments_helper/lib/src/attachments_service.dart b/packages/powersync_attachments_helper/lib/src/attachments_service.dart
@@ -1,8 +1,8 @@
 import './attachments_queue.dart';
 import './attachments_queue_table.dart';
 import './local_storage_adapter.dart';
-import 'package:powersync/powersync.dart';
-import 'package:powersync/sqlite3_common.dart';
+import 'package:powersync_core/powersync_core.dart';
+import 'package:powersync_core/sqlite3_common.dart';
 
 /// Service for interacting with the attachment queue.
 class AttachmentsService {
diff --git a/packages/powersync_attachments_helper/lib/src/syncing_service.dart b/packages/powersync_attachments_helper/lib/src/syncing_service.dart
@@ -4,7 +4,7 @@ import 'dart:typed_data';
 import './attachments_queue.dart';
 import './local_storage_adapter.dart';
 import './remote_storage_adapter.dart';
-import 'package:powersync/powersync.dart';
+import 'package:powersync_core/powersync_core.dart';
 import 'attachments_queue_table.dart';
 import 'attachments_service.dart';
 
diff --git a/packages/powersync_attachments_helper/pubspec.yaml b/packages/powersync_attachments_helper/pubspec.yaml
@@ -10,7 +10,7 @@ dependencies:
   flutter:
     sdk: flutter
 
-  powersync: ^1.8.6
+  powersync_core: ^1.0.0
   logging: ^1.2.0
   sqlite_async: ^0.9.0
   path_provider: ^2.0.13
diff --git a/packages/powersync_core/lib/powersync_core.dart b/packages/powersync_core/lib/powersync_core.dart
@@ -1,6 +1,6 @@
-/// Support for doing something awesome.
+/// PowerSync Dart SDK.
 ///
-/// More dartdocs go here.
+/// Use [PowerSyncDatabase] to open a database.
 library;
 
 export 'src/connector.dart';
@@ -13,3 +13,4 @@ export 'src/powersync_database.dart';
 export 'src/schema.dart';
 export 'src/sync_status.dart';
 export 'src/uuid.dart';
+export 'src/open_factory/abstract_powersync_open_factory.dart';
diff --git a/packages/powersync_core/lib/sqlite3_open.dart b/packages/powersync_core/lib/sqlite3_open.dart
@@ -0,0 +1,5 @@
+/// Re-exports [sqlite3_open](https://pub.dev/packages/sqlite3) to expose sqlite3_open without
+/// adding it as a direct dependency.
+library;
+
+export 'package:sqlite_async/sqlite3_open.dart';
diff --git a/packages/powersync_sqlcipher/.gitignore b/packages/powersync_sqlcipher/.gitignore
@@ -0,0 +1,30 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+migrate_working_dir/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock.
+/pubspec.lock
+**/doc/api/
+.dart_tool/
+build/
+/test-db
diff --git a/packages/powersync_sqlcipher/.metadata b/packages/powersync_sqlcipher/.metadata
@@ -0,0 +1,10 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: "761747bfc538b5af34aa0d3fac380f1bc331ec49"
+  channel: "stable"
+
+project_type: package
diff --git a/packages/powersync_sqlcipher/CHANGELOG.md b/packages/powersync_sqlcipher/CHANGELOG.md
@@ -0,0 +1,3 @@
+## 0.0.1
+
+* TODO: Describe initial release.
diff --git a/packages/powersync_sqlcipher/LICENSE b/packages/powersync_sqlcipher/LICENSE
@@ -0,0 +1 @@
+TODO: Add your license here.
diff --git a/packages/powersync_sqlcipher/README.md b/packages/powersync_sqlcipher/README.md
@@ -0,0 +1,76 @@
+<p align="center">
+  <a href="https://www.powersync.com" target="_blank"><img src="https://github.com/powersync-ja/.github/assets/7372448/d2538c43-c1a0-4c47-9a76-41462dba484f"/></a>
+</p>
+
+# PowerSync with SQLCipher SDK for Dart/Flutter
+
+_[PowerSync](https://www.powersync.com) is a sync engine for building local-first apps with instantly-responsive UI/UX and simplified state transfer. Syncs between SQLite on the client-side and Postgres or MongoDB on the server-side (MySQL coming soon)._
+
+This package (`powersync_sqlcipher`) is the PowerSync client SDK for Dart/Flutter with encryption enabled using SQLCipher.
+
+# Installation
+
+```bash
+flutter pub add powersync_sqlcipher
+```
+
+# Getting Started
+
+Our [full SDK reference](https://docs.powersync.com/client-sdk-references/flutter) contains everything you need to know to get started implementing PowerSync in your project.
+
+### Demo app
+
+The easiest way to test out the alpha is to run the [Supabase Todo-List](./demos/supabase-todolist) demo app:
+
+1. Checkout [this repo's](https://github.com/powersync-ja/powersync.dart/tree/master) `master` branch.
+
+- Note: If you are an existing user updating to the latest code after a git pull, run `melos exec 'flutter pub upgrade'` in the repo's root and make sure it succeeds.
+
+2. Run `melos prepare` in the repo's root
+3. cd into the `demos/supabase-todolist` folder
+4. If you haven’t yet: `cp lib/app_config_template.dart lib/app_config.dart` (optionally update this config with your own Supabase and PowerSync project details).
+5. Run `flutter run -d chrome`
+
+### Installing PowerSync in your own project
+
+Install the latest version of the package, for example:
+
+```
+flutter pub add powersync_sqlcipher:'^0.1.0'
+```
+
+The latest version can be found [here](https://pub.dev/packages/powersync_sqlcipher/versions).
+
+### Usage
+
+```Dart
+import 'package/powersync_sqlcipher/powersync.dart';
+
+/// Global reference to the database
+late final PowerSyncDatabase db;
+
+final cipherFactory = PowerSyncSQLCipherOpenFactory(
+      path: await getDatabasePath(), key: "fkdjskjnfds");
+
+db = PowerSyncDatabase.withFactory(cipherFactory, schema: schema);
+```
+
+[comment]: # "The sections below need to be updated"
+
+# Changelog
+
+A changelog for this SDK is available [here](https://releases.powersync.com/announcements/flutter-client-sdk).
+
+# API Reference
+
+The full API reference for this SDK can be found [here](https://pub.dev/documentation/powersync/latest/powersync/powersync-library.html).
+
+# Examples
+
+For example projects built with PowerSync and Flutter, see our [Demo Apps / Example Projects](https://docs.powersync.com/resources/demo-apps-example-projects#flutter) gallery. Most of these projects can also be found in the [`demos/`](../demos/) directory.
+
+# Found a bug or need help?
+
+- Join our [Discord server](https://discord.gg/powersync) where you can browse topics from our community, ask questions, share feedback, or just say hello :)
+- Please open a [GitHub issue](https://github.com/powersync-ja/powersync.dart/issues) when you come across a bug.
+- Have feedback or an idea? [Submit an idea](https://roadmap.powersync.com/tabs/5-roadmap/submit-idea) via our public roadmap or [schedule a chat](https://calendly.com/powersync/powersync-chat) with someone from our product team.
diff --git a/packages/powersync_sqlcipher/analysis_options.yaml b/packages/powersync_sqlcipher/analysis_options.yaml
@@ -0,0 +1,4 @@
+include: package:flutter_lints/flutter.yaml
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options
diff --git a/packages/powersync_sqlcipher/lib/powersync.dart b/packages/powersync_sqlcipher/lib/powersync.dart
@@ -0,0 +1,7 @@
+/// PowerSync with Encryption for Flutter.
+///
+/// Use [PowerSyncSQLCipherOpenFactory] to open an encrypted database.
+library;
+
+export 'src/sqlcipher.dart';
+export 'package:powersync_core/powersync_core.dart';
diff --git a/packages/powersync_sqlcipher/lib/sqlite3.dart b/packages/powersync_sqlcipher/lib/sqlite3.dart
@@ -0,0 +1,5 @@
+/// Re-exports [sqlite3](https://pub.dev/packages/sqlite3) to expose sqlite3 without
+/// adding it as a direct dependency.
+library;
+
+export 'package:powersync_core/sqlite3.dart';
diff --git a/packages/powersync_sqlcipher/lib/sqlite3_common.dart b/packages/powersync_sqlcipher/lib/sqlite3_common.dart
@@ -0,0 +1,5 @@
+/// Re-exports [sqlite3_common](https://pub.dev/packages/sqlite3) to expose sqlite3_common without
+/// adding it as a direct dependency.
+library;
+
+export 'package:powersync_core/sqlite3_common.dart';
diff --git a/packages/powersync_sqlcipher/lib/sqlite3_open.dart b/packages/powersync_sqlcipher/lib/sqlite3_open.dart
@@ -0,0 +1,5 @@
+/// Re-exports [sqlite3_open](https://pub.dev/packages/sqlite3) to expose sqlite3_open without
+/// adding it as a direct dependency.
+library;
+
+export 'package:powersync_core/sqlite3_open.dart';
diff --git a/packages/powersync_sqlcipher/lib/sqlite_async.dart b/packages/powersync_sqlcipher/lib/sqlite_async.dart
@@ -0,0 +1,5 @@
+/// Re-exports [sqlite_async](https://pub.dev/packages/sqlite_async) to expose sqlite_async without
+/// adding it as a direct dependency.
+library;
+
+export 'package:powersync_core/sqlite_async.dart';
diff --git a/packages/powersync_sqlcipher/lib/src/sqlcipher.dart b/packages/powersync_sqlcipher/lib/src/sqlcipher.dart
@@ -0,0 +1,104 @@
+import 'dart:ffi';
+
+import 'package:powersync_core/powersync_core.dart';
+import 'package:powersync_core/sqlite3_common.dart';
+import 'package:powersync_core/sqlite3_open.dart' as sqlite3_open;
+import 'package:powersync_core/sqlite_async.dart';
+import 'package:powersync_core/sqlite3.dart' as sqlite;
+import 'package:sqlcipher_flutter_libs/sqlcipher_flutter_libs.dart';
+import 'package:universal_io/io.dart';
+
+/// A factory for opening a database with SQLCipher encryption.
+/// An encryption [key] is required
+class PowerSyncSQLCipherOpenFactory extends AbstractPowerSyncOpenFactory {
+  PowerSyncSQLCipherOpenFactory({
+    required super.path,
+    required this.key,
+    super.sqliteOptions = powerSyncDefaultSqliteOptions,
+  });
+
+  final String key;
+
+  @override
+  void enableExtension() {
+    var powersyncLib = _getDynamicLibraryForPlatform();
+    sqlite.sqlite3.ensureExtensionLoaded(sqlite.SqliteExtension.inLibrary(
+        powersyncLib, 'sqlite3_powersync_init'));
+  }
+
+  /// Returns the dynamic library for the current platform.
+  DynamicLibrary _getDynamicLibraryForPlatform() {
+    /// When running tests, we need to load the library for all platforms.
+    if (Platform.environment.containsKey('FLUTTER_TEST')) {
+      return DynamicLibrary.open(getLibraryForPlatform());
+    }
+    return (Platform.isIOS || Platform.isMacOS)
+        ? DynamicLibrary.process()
+        : DynamicLibrary.open(getLibraryForPlatform());
+  }
+
+  @override
+  List<String> pragmaStatements(SqliteOpenOptions options) {
+    final basePragmaStatements = super.pragmaStatements(options);
+    return [
+      // Set the encryption key as the first statement
+      "PRAGMA KEY = '$key'",
+      // Include the default statements afterwards
+      for (var statement in basePragmaStatements) statement
+    ];
+  }
+
+  @override
+  CommonDatabase open(SqliteOpenOptions options) {
+    sqlite3_open.open
+        .overrideFor(sqlite3_open.OperatingSystem.android, openCipherOnAndroid);
+
+    try {
+      enableExtension();
+    } on PowersyncNotReadyException catch (e) {
+      autoLogger.severe(e.message);
+      rethrow;
+    }
+
+    var db = super.open(options);
+    final versionRows = db.select('PRAGMA cipher_version');
+    if (versionRows.isEmpty) {
+      throw AssertionError(
+          "SQLCipher was not initialized correctly. 'PRAGMA cipher_version' returned no rows.");
+    } else {
+      //TODO: Remove before publishing
+      print("RUNNING with cipher ${versionRows.rows.first}");
+    }
+    return db;
+  }
+
+  @override
+  String getLibraryForPlatform({String? path}) {
+    switch (Abi.current()) {
+      case Abi.androidArm:
+      case Abi.androidArm64:
+      case Abi.androidX64:
+        return 'libpowersync.so';
+      case Abi.macosArm64:
+      case Abi.macosX64:
+        return 'libpowersync.dylib';
+      case Abi.linuxX64:
+        return 'libpowersync_x64.so';
+      case Abi.linuxArm64:
+        return 'libpowersync_aarch64.so';
+      case Abi.windowsX64:
+        return 'powersync_x64.dll';
+      case Abi.androidIA32:
+        throw PowersyncNotReadyException(
+          'Unsupported processor architecture. X86 Android emulators are not '
+          'supported. Please use an x86_64 emulator instead. All physical '
+          'Android devices are supported including 32bit ARM.',
+        );
+      default:
+        throw PowersyncNotReadyException(
+          'Unsupported processor architecture "${Abi.current()}". '
+          'Please open an issue on GitHub to request it.',
+        );
+    }
+  }
+}
diff --git a/packages/powersync_sqlcipher/pubspec.yaml b/packages/powersync_sqlcipher/pubspec.yaml
diff --git a/packages/powersync_sqlcipher/test/powersync_sqlcipher_factory_test.dart b/packages/powersync_sqlcipher/test/powersync_sqlcipher_factory_test.dart
diff --git a/packages/powersync_sqlcipher/test/utils/test_utils.dart b/packages/powersync_sqlcipher/test/utils/test_utils.dart

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/// PowerSync Dart SDK.`
	`1`	`+/// PowerSync Flutter SDK.`
`2`	`2`	`///`
`3`	`3`	`/// Use [PowerSyncDatabase] to open a database.`
`4`	`4`	`library;`