Rename options

Author: simolus3

packages/powersync_core/lib/src/crud.dart

@@ -73,7 +73,7 @@ class CrudEntry {
   /// An optional metadata string attached to this entry at the time the write
   /// has been issued.
   ///
-  /// For tables where [Table.includeMetadata] is enabled, a hidden `_metadata`
+  /// For tables where [Table.trackMetadata] is enabled, a hidden `_metadata`
   /// column is added to this table that can be used during updates to attach
   /// a hint to the update thas is preserved here.
   final String? metadata;
@@ -90,7 +90,7 @@ class CrudEntry {
   /// Old values before an update.
   ///
   /// This is only tracked for tables for which this has been enabled by setting
-  /// the [Table.includeOld].
+  /// the [Table.trackPreviousValues].
   final Map<String, dynamic>? oldData;
 
   CrudEntry(

packages/powersync_core/lib/src/schema.dart

@@ -31,7 +31,7 @@ class Schema {
 ///
 /// These options are enabled by passing them to a non-local [Table]
 /// constructor.
-final class IncludeOldOptions {
+final class TrackPreviousValuesOptions {
   /// A filter of column names for which updates should be tracked.
   ///
   /// When set to a non-null value, columns not included in this list will not
@@ -42,7 +42,8 @@ final class IncludeOldOptions {
   /// instead of always including all old values.
   final bool onlyWhenChanged;
 
-  const IncludeOldOptions({this.columnFilter, this.onlyWhenChanged = false});
+  const TrackPreviousValuesOptions(
+      {this.columnFilter, this.onlyWhenChanged = false});
 }
 
 /// A single table in the schema.
@@ -61,12 +62,12 @@ class Table {
   /// Whether to add a hidden `_metadata` column that will be enabled for
   /// updates to attach custom information about writes that will be reported
   /// through [CrudEntry.metadata].
-  final bool includeMetadata;
+  final bool trackMetadata;
 
   /// Whether to track old values of columns for [CrudEntry.oldData].
   ///
-  /// See [IncludeOldOptions] for details.
-  final IncludeOldOptions? includeOld;
+  /// See [TrackPreviousValuesOptions] for details.
+  final TrackPreviousValuesOptions? trackPreviousValues;
 
   /// Whether the table only exists locally.
   final bool localOnly;
@@ -76,7 +77,7 @@ class Table {
 
   /// Whether an `UPDATE` statement that doesn't change any values should be
   /// ignored when creating CRUD entries.
-  final bool ignoreEmptyUpdate;
+  final bool ignoreEmptyUpdates;
 
   /// Override the name for the view
   final String? _viewNameOverride;
@@ -107,9 +108,9 @@ class Table {
     this.indexes = const [],
     String? viewName,
     this.localOnly = false,
-    this.ignoreEmptyUpdate = false,
-    this.includeMetadata = false,
-    this.includeOld,
+    this.ignoreEmptyUpdates = false,
+    this.trackMetadata = false,
+    this.trackPreviousValues,
   })  : insertOnly = false,
         _viewNameOverride = viewName;
 
@@ -120,9 +121,9 @@ class Table {
       {this.indexes = const [], String? viewName})
       : localOnly = true,
         insertOnly = false,
-        includeMetadata = false,
-        includeOld = null,
-        ignoreEmptyUpdate = false,
+        trackMetadata = false,
+        trackPreviousValues = null,
+        ignoreEmptyUpdates = false,
         _viewNameOverride = viewName;
 
   /// Create a table that only supports inserts.
@@ -137,9 +138,9 @@ class Table {
     this.name,
     this.columns, {
     String? viewName,
-    this.ignoreEmptyUpdate = false,
-    this.includeMetadata = false,
-    this.includeOld,
+    this.ignoreEmptyUpdates = false,
+    this.trackMetadata = false,
+    this.trackPreviousValues,
   })  : localOnly = false,
         insertOnly = true,
         indexes = const [],
@@ -172,11 +173,11 @@ class Table {
           "Invalid characters in view name: $_viewNameOverride");
     }
 
-    if (includeMetadata && localOnly) {
+    if (trackMetadata && localOnly) {
       throw AssertionError("Local-only tables can't track metadata");
     }
 
-    if (includeOld != null && localOnly) {
+    if (trackPreviousValues != null && localOnly) {
       throw AssertionError("Local-only tables can't track old values");
     }
 
@@ -228,11 +229,11 @@ class Table {
         'insert_only': insertOnly,
         'columns': columns,
         'indexes': indexes.map((e) => e.toJson(this)).toList(growable: false),
-        'ignore_empty_update': ignoreEmptyUpdate,
-        'include_metadata': includeMetadata,
-        if (includeOld case final includeOld?) ...{
-          'include_old': includeOld.columnFilter ?? true,
-          'include_old_only_when_changed': includeOld.onlyWhenChanged,
+        'ignore_empty_update': ignoreEmptyUpdates,
+        'include_metadata': trackMetadata,
+        if (trackPreviousValues case final trackPreviousValues?) ...{
+          'include_old': trackPreviousValues.columnFilter ?? true,
+          'include_old_only_when_changed': trackPreviousValues.onlyWhenChanged,
         },
       };
 }

packages/powersync_core/test/crud_test.dart

@@ -276,7 +276,7 @@ void main() {
         Table(
           'lists',
           [Column.text('name')],
-          includeMetadata: true,
+          trackMetadata: true,
         )
       ]));
 
@@ -293,7 +293,7 @@ void main() {
         Table(
           'lists',
           [Column.text('name'), Column.text('content')],
-          includeOld: IncludeOldOptions(),
+          trackPreviousValues: TrackPreviousValuesOptions(),
         )
       ]));
 
@@ -312,7 +312,8 @@ void main() {
         Table(
           'lists',
           [Column.text('name'), Column.text('content')],
-          includeOld: IncludeOldOptions(columnFilter: ['name']),
+          trackPreviousValues:
+              TrackPreviousValuesOptions(columnFilter: ['name']),
         )
       ]));
 
@@ -332,7 +333,8 @@ void main() {
         Table(
           'lists',
           [Column.text('name'), Column.text('content')],
-          includeOld: IncludeOldOptions(onlyWhenChanged: true),
+          trackPreviousValues:
+              TrackPreviousValuesOptions(onlyWhenChanged: true),
         )
       ]));
 
@@ -351,7 +353,7 @@ void main() {
         Table(
           'lists',
           [Column.text('name')],
-          ignoreEmptyUpdate: true,
+          ignoreEmptyUpdates: true,
         )
       ]));
 

packages/powersync_core/test/schema_test.dart

@@ -320,17 +320,17 @@ void main() {
 
     test('local-only with metadata', () {
       final table = Table('foo', [Column.text('bar')],
-          localOnly: true, includeMetadata: true);
+          localOnly: true, trackMetadata: true);
 
       expect(
           table.validate,
           throwsA(isA<AssertionError>().having((e) => e.message, 'emssage',
               "Local-only tables can't track metadata")));
     });
 
-    test('local-only with includeOld', () {
+    test('local-only with trackPreviousValues', () {
       final table = Table('foo', [Column.text('bar')],
-          localOnly: true, includeOld: IncludeOldOptions());
+          localOnly: true, trackPreviousValues: TrackPreviousValuesOptions());
 
       expect(
           table.validate,
@@ -395,14 +395,15 @@ void main() {
     });
 
     test('handles options', () {
-      expect(Table('foo', [], includeMetadata: true).toJson(),
+      expect(Table('foo', [], trackMetadata: true).toJson(),
           containsPair('include_metadata', isTrue));
 
-      expect(Table('foo', [], ignoreEmptyUpdate: true).toJson(),
+      expect(Table('foo', [], ignoreEmptyUpdates: true).toJson(),
           containsPair('ignore_empty_update', isTrue));
 
       expect(
-        Table('foo', [], includeOld: IncludeOldOptions()).toJson(),
+        Table('foo', [], trackPreviousValues: TrackPreviousValuesOptions())
+            .toJson(),
         allOf(
           containsPair('include_old', isTrue),
           containsPair('include_old_only_when_changed', isFalse),
@@ -411,7 +412,8 @@ void main() {
 
       expect(
         Table('foo', [],
-                includeOld: IncludeOldOptions(columnFilter: ['foo', 'bar']))
+                trackPreviousValues:
+                    TrackPreviousValuesOptions(columnFilter: ['foo', 'bar']))
             .toJson(),
         allOf(
           containsPair('include_old', ['foo', 'bar']),
@@ -420,7 +422,9 @@ void main() {
       );
 
       expect(
-        Table('foo', [], includeOld: IncludeOldOptions(onlyWhenChanged: true))
+        Table('foo', [],
+                trackPreviousValues:
+                    TrackPreviousValuesOptions(onlyWhenChanged: true))
             .toJson(),
         allOf(
           containsPair('include_old', isTrue),