Merge remote-tracking branch 'origin/main' into update-core-lib

Author: rkistner

CHANGELOG.md

@@ -3,6 +3,35 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 2024-08-23
+
+### Changes
+
+---
+
+Packages with breaking changes:
+
+ - There are no breaking changes in this release.
+
+Packages with other changes:
+
+ - [`powersync` - `v1.7.0`](#powersync---v170)
+ - [`powersync_attachments_helper` - `v0.6.5+1`](#powersync_attachments_helper---v0651)
+
+Packages with dependency updates only:
+
+> Packages listed below depend on other packages in this workspace that have had changes. Their versions have been incremented to bump the minimum dependency versions of the packages they depend upon in this project.
+
+ - `powersync_attachments_helper` - `v0.6.5+1`
+
+---
+
+#### `powersync` - `v1.7.0`
+
+ - **FEAT**: Include schema validation check
+ - **FEAT**: Include new table check for maximum number of columns allowed
+
+
 ## 2024-08-21
 
 ### Changes

RELEASING.md

@@ -25,4 +25,6 @@ e.g powersync-v1.6.4, powersync_attachments_helper-v0.6.3+1, etc.
 git push --follow-tags
 ```
 
+**Note: This will launch the `release.yaml` and `publish.yaml` github actions in `.github/workflows`. So only run it when you are absolutely sure you want to release.**
+
 A version bump and tag push for `powersync` will also create a draft github release for the powersync web worker. The worker needs to be manually published in the GitHub [releases](https://github.com/powersync-ja/powersync.dart/releases).

melos.yaml

@@ -27,10 +27,9 @@ command:
 
 scripts:
   prepare:
-    description: Download SQLite3 WASM for demos
+    description: Download and prepare assets for demos
     run: |
-      melos bootstrap && melos prepare:assets && dart ./scripts/compile_webworker.dart && dart ./scripts/init_powersync_core_binary.dart
-      dart ./scripts/download_core_binary_demos.dart && melos prepare:demos
+      melos bootstrap && melos prepare:assets && dart ./scripts/compile_webworker.dart && dart ./scripts/init_powersync_core_binary.dart && dart ./scripts/download_core_binary_demos.dart && melos prepare:demos
 
   prepare:demos:
     description: Download SQLite3 wasm for demos

packages/powersync/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.7.0
+
+ - **FEAT**: Include schema validation check
+ - **FEAT**: Include new table check for maximum number of columns allowed
+
 ## 1.6.7
 
  - **CHORE**: Update dependency powersync_flutter_libs

packages/powersync/lib/src/database/native/native_powersync_database.dart

@@ -261,6 +261,7 @@ class PowerSyncDatabaseImpl
     if (disconnecter != null) {
       throw AssertionError('Cannot update schema while connected');
     }
+    schema.validate();
     this.schema = schema;
     return updateSchemaInIsolate(database, schema);
   }

packages/powersync/lib/src/database/web/web_powersync_database.dart

@@ -207,6 +207,7 @@ class PowerSyncDatabaseImpl
     if (disconnecter != null) {
       throw AssertionError('Cannot update schema while connected');
     }
+    schema.validate();
     this.schema = schema;
     return database.writeLock((tx) => schema_logic.updateSchema(tx, schema));
   }

packages/powersync/lib/src/schema.dart

@@ -11,6 +11,12 @@ class Schema {
   const Schema(this.tables);
 
   Map<String, dynamic> toJson() => {'tables': tables};
+
+  void validate() {
+    for (var table in tables) {
+      table.validate();
+    }
+  }
 }
 
 /// A single table in the schema.
@@ -33,6 +39,10 @@ class Table {
   /// Override the name for the view
   final String? _viewNameOverride;
 
+  /// There is maximum of 127 arguments for any function in SQLite. Currently we use json_object which uses 1 arg per key (column name)
+  /// and one per value, which limits it to 63 arguments.
+  final int maxNumberOfColumns = 63;
+
   /// Internal use only.
   ///
   /// Name of the table that stores the underlying data.
@@ -84,9 +94,16 @@ class Table {
 
   /// Check that there are no issues in the table definition.
   void validate() {
+    if (columns.length > maxNumberOfColumns) {
+      throw AssertionError(
+          "Table $name has more than $maxNumberOfColumns columns, which is not supported");
+    }
+
     if (invalidSqliteCharacters.hasMatch(name)) {
       throw AssertionError("Invalid characters in table name: $name");
-    } else if (_viewNameOverride != null &&
+    }
+
+    if (_viewNameOverride != null &&
         invalidSqliteCharacters.hasMatch(_viewNameOverride)) {
       throw AssertionError(
           "Invalid characters in view name: $_viewNameOverride");

packages/powersync/test/schema_test.dart

@@ -142,5 +142,201 @@ void main() {
 
       expect(results2[0]['detail'], contains('SCAN'));
     });
+
+    test('Validation runs on setup', () async {
+      final schema = Schema([
+        Table('#assets', [
+          Column.text('name'),
+        ]),
+      ]);
+
+      try {
+        await testUtils.setupPowerSync(path: path, schema: schema);
+      } catch (e) {
+        expect(
+            e,
+            isA<AssertionError>().having((e) => e.message, 'message',
+                'Invalid characters in table name: #assets'));
+      }
+    });
+
+    test('Validation runs on update', () async {
+      final schema = Schema([
+        Table('works', [
+          Column.text('name'),
+        ]),
+      ]);
+
+      final powersync =
+          await testUtils.setupPowerSync(path: path, schema: schema);
+
+      final schema2 = Schema([
+        Table('#notworking', [
+          Column.text('created_at'),
+        ]),
+      ]);
+
+      try {
+        powersync.updateSchema(schema2);
+      } catch (e) {
+        expect(
+            e,
+            isA<AssertionError>().having((e) => e.message, 'message',
+                'Invalid characters in table name: #notworking'));
+      }
+    });
+  });
+
+  group('Table', () {
+    test('Create a synced table', () {
+      final table = Table('users', [
+        Column('name', ColumnType.text),
+        Column('age', ColumnType.integer),
+      ]);
+
+      expect(table.name, equals('users'));
+      expect(table.columns.length, equals(2));
+      expect(table.localOnly, isFalse);
+      expect(table.insertOnly, isFalse);
+      expect(table.internalName, equals('ps_data__users'));
+      expect(table.viewName, equals('users'));
+    });
+
+    test('Create a local-only table', () {
+      final table = Table.localOnly(
+          'local_users',
+          [
+            Column('name', ColumnType.text),
+          ],
+          viewName: 'local_user_view');
+
+      expect(table.name, equals('local_users'));
+      expect(table.localOnly, isTrue);
+      expect(table.insertOnly, isFalse);
+      expect(table.internalName, equals('ps_data_local__local_users'));
+      expect(table.viewName, equals('local_user_view'));
+    });
+
+    test('Create an insert-only table', () {
+      final table = Table.insertOnly('logs', [
+        Column('message', ColumnType.text),
+        Column('timestamp', ColumnType.integer),
+      ]);
+
+      expect(table.name, equals('logs'));
+      expect(table.localOnly, isFalse);
+      expect(table.insertOnly, isTrue);
+      expect(table.internalName, equals('ps_data__logs'));
+      expect(table.indexes, isEmpty);
+    });
+
+    test('Access column by name', () {
+      final table = Table('products', [
+        Column('name', ColumnType.text),
+        Column('price', ColumnType.real),
+      ]);
+
+      expect(table['name'].type, equals(ColumnType.text));
+      expect(table['price'].type, equals(ColumnType.real));
+      expect(() => table['nonexistent'], throwsStateError);
+    });
+
+    test('Validate table name', () {
+      final invalidTableName =
+          Table('#invalid_table_name', [Column('name', ColumnType.text)]);
+
+      expect(
+        () => invalidTableName.validate(),
+        throwsA(
+          isA<AssertionError>().having(
+            (e) => e.message,
+            'message',
+            'Invalid characters in table name: #invalid_table_name',
+          ),
+        ),
+      );
+    });
+
+    test('Validate view name', () {
+      final invalidTableName = Table(
+          'valid_table_name', [Column('name', ColumnType.text)],
+          viewName: '#invalid_view_name');
+
+      expect(
+        () => invalidTableName.validate(),
+        throwsA(
+          isA<AssertionError>().having(
+            (e) => e.message,
+            'message',
+            'Invalid characters in view name: #invalid_view_name',
+          ),
+        ),
+      );
+    });
+
+    test('Validate table definition', () {
+      final validTable = Table('valid_table', [
+        Column('name', ColumnType.text),
+        Column('age', ColumnType.integer),
+      ]);
+
+      expect(() => validTable.validate(), returnsNormally);
+    });
+
+    test('Table with id column', () {
+      final invalidTable = Table('invalid_table', [
+        Column('id', ColumnType.integer), // Duplicate 'id' column
+        Column('name', ColumnType.text),
+      ]);
+
+      expect(
+        () => invalidTable.validate(),
+        throwsA(
+          isA<AssertionError>().having(
+            (e) => e.message,
+            'message',
+            'invalid_table: id column is automatically added, custom id columns are not supported',
+          ),
+        ),
+      );
+    });
+
+    test('Table with too many columns', () {
+      final List<Column> manyColumns = List.generate(
+        64, // Exceeds MAX_NUMBER_OF_COLUMNS
+        (index) => Column('col$index', ColumnType.text),
+      );
+
+      final tableTooManyColumns = Table('too_many_columns', manyColumns);
+
+      expect(
+        () => tableTooManyColumns.validate(),
+        throwsA(
+          isA<AssertionError>().having(
+            (e) => e.message,
+            'message',
+            'Table too_many_columns has more than 63 columns, which is not supported',
+          ),
+        ),
+      );
+    });
+
+    test('toJson method', () {
+      final table = Table('users', [
+        Column('name', ColumnType.text),
+        Column('age', ColumnType.integer),
+      ], indexes: [
+        Index('name_index', [IndexedColumn('name')])
+      ]);
+
+      final json = table.toJson();
+
+      expect(json['name'], equals('users'));
+      expect(json['view_name'], isNull);
+      expect(json['local_only'], isFalse);
+      expect(json['insert_only'], isFalse);
+      expect(json['columns'].length, equals(2));
+      expect(json['indexes'].length, equals(1));
+    });
   });
 }