Support including metadata for inserts

Author: simolus3

crates/core/src/diff.rs

@@ -24,10 +24,6 @@ fn powersync_diff_impl(
     diff_objects_with_options(data_old, data_new, ignore_removed)
 }
 
-fn diff_objects(data_old: &str, data_new: &str) -> Result<String, SQLiteError> {
-    diff_objects_with_options(data_old, data_new, false)
-}
-
 /// Returns a JSON object containing entries from [data_new] that are not present in [data_old].
 ///
 /// When [ignore_removed_columns] is set, columns that are present in [data_old] but not in
@@ -108,6 +104,10 @@ pub fn register(db: *mut sqlite::sqlite3) -> Result<(), ResultCode> {
 mod tests {
     use super::*;
 
+    fn diff_objects(data_old: &str, data_new: &str) -> Result<String, SQLiteError> {
+        diff_objects_with_options(data_old, data_new, false)
+    }
+
     #[test]
     fn basic_diff_test() {
         assert_eq!(diff_objects("{}", "{}").unwrap(), "{}");

crates/core/src/views.rs

@@ -175,43 +175,48 @@ fn powersync_trigger_insert_sql_impl(
     let mut columns = ColumnNameAndTypeStatement::new(local_db, table)?;
     let json_fragment = json_object_fragment("NEW", &mut columns.names_iter())?;
 
+    let metadata_fragment = if table_info.flags.include_metadata() {
+        ", 'metadata', NEW._metadata"
+    } else {
+        ""
+    };
+
     return if !local_only && !insert_only {
         let trigger = format!("\
-    CREATE TRIGGER {:}
-    INSTEAD OF INSERT ON {:}
+    CREATE TRIGGER {trigger_name}
+    INSTEAD OF INSERT ON {quoted_name}
     FOR EACH ROW
     BEGIN
       SELECT CASE
       WHEN (NEW.id IS NULL)
       THEN RAISE (FAIL, 'id is required')
       END;
-      INSERT INTO {:}
-      SELECT NEW.id, {:};
-      INSERT INTO powersync_crud_(data) VALUES(json_object('op', 'PUT', 'type', {:}, 'id', NEW.id, 'data', json(powersync_diff('{{}}', {:}))));
-      INSERT OR IGNORE INTO ps_updated_rows(row_type, row_id) VALUES({:}, NEW.id);
-      INSERT OR REPLACE INTO ps_buckets(name, last_op, target_op) VALUES('$local', 0, {:});
-    END", trigger_name, quoted_name, internal_name, json_fragment, type_string, json_fragment, type_string, MAX_OP_ID);
+      INSERT INTO {internal_name}
+      SELECT NEW.id, {json_fragment};
+      INSERT INTO powersync_crud_(data) VALUES(json_object('op', 'PUT', 'type', {:}, 'id', NEW.id, 'data', json(powersync_diff('{{}}', {:})) {metadata_fragment}));
+      INSERT OR IGNORE INTO ps_updated_rows(row_type, row_id) VALUES({type_string}, NEW.id);
+      INSERT OR REPLACE INTO ps_buckets(name, last_op, target_op) VALUES('$local', 0, {MAX_OP_ID});
+    END", type_string, json_fragment);
         Ok(trigger)
     } else if local_only {
         let trigger = format!(
             "\
-    CREATE TRIGGER {:}
-    INSTEAD OF INSERT ON {:}
+    CREATE TRIGGER {trigger_name}
+    INSTEAD OF INSERT ON {quoted_name}
     FOR EACH ROW
     BEGIN
-      INSERT INTO {:} SELECT NEW.id, {:};
+      INSERT INTO {internal_name} SELECT NEW.id, {json_fragment};
     END",
-            trigger_name, quoted_name, internal_name, json_fragment
         );
         Ok(trigger)
     } else if insert_only {
         let trigger = format!("\
-    CREATE TRIGGER {:}
-    INSTEAD OF INSERT ON {:}
+    CREATE TRIGGER {trigger_name}
+    INSTEAD OF INSERT ON {quoted_name}
     FOR EACH ROW
     BEGIN
       INSERT INTO powersync_crud_(data) VALUES(json_object('op', 'PUT', 'type', {}, 'id', NEW.id, 'data', json(powersync_diff('{{}}', {:}))));
-    END", trigger_name, quoted_name, type_string, json_fragment);
+    END", type_string, json_fragment);
         Ok(trigger)
     } else {
         Err(SQLiteError::from(ResultCode::MISUSE))

dart/test/crud_test.dart

@@ -369,5 +369,76 @@ void main() {
         });
       });
     });
+
+    group('including metadata', () {
+      void createTable([Map<String, Object?> options = const {}]) {
+        final tableSchema = {
+          'tables': [
+            {
+              'name': 'test',
+              'columns': [
+                {'name': 'name', 'type': 'text'},
+              ],
+              ...options,
+            }
+          ]
+        };
+
+        db.select('select powersync_init()');
+        db.select(
+            'select powersync_replace_schema(?)', [jsonEncode(tableSchema)]);
+      }
+
+      test('is disabled by default', () {
+        createTable();
+        expect(
+          () => db.execute(
+            'INSERT INTO test (id, name, _metadata) VALUES (?, ?, ?)',
+            ['id', 'name', 'test insert'],
+          ),
+          throwsA(isA<SqliteException>()),
+        );
+      });
+
+      test('can be disabled', () {
+        createTable({'include_metadata': false});
+        expect(
+          () => db.execute(
+            'INSERT INTO test (id, name, _metadata) VALUES (?, ?, ?)',
+            ['id', 'name', 'test insert'],
+          ),
+          throwsA(isA<SqliteException>()),
+        );
+      });
+
+      test('supports insert statements', () {
+        createTable({'include_metadata': true});
+        db.execute(
+          'INSERT INTO test (id, name, _metadata) VALUES (?, ?, ?)',
+          ['id', 'name', 'test insert'],
+        );
+
+        final [row] = db.select('select data from ps_crud');
+        final op = jsonDecode(row[0] as String);
+        expect(op['data'], {'name': 'name'});
+        expect(op['metadata'], 'test insert');
+      });
+
+      test('supports update statements', () {
+        createTable({'include_metadata': true});
+        db.execute(
+          'INSERT INTO test (id, name, _metadata) VALUES (?, ?, ?)',
+          ['id', 'name', 'test insert'],
+        );
+        db.execute('delete from ps_crud;');
+        db.execute(
+            'update test set name = name || ?, _metadata = ?', ['.', 'update']);
+
+        final [row] = db.select('select data from ps_crud');
+        final op = jsonDecode(row[0] as String);
+        expect(op['data'], {'name': 'name.'});
+        expect(op['metadata'], 'update');
+      });
+    });
   });
 }