Skip to content

armgit / macro

Public Imported from GitHub
0

Macro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — @-linked together with shared AI memory.

chore(agents): version persisted database audit-log payloads (#7399)

Wolf Mermelstein21bb473d583b
diff --git a/.sqlx/query-4cd05c8e71e48252a5f0600ea66c8198d41179ca751c49976a8b6606b5e8f52b.json b/.sqlx/query-3be9ce3de1997682fc34534f301129a542094a2836d4519d1e04c47547099874.json
similarity index 79%
rename from .sqlx/query-4cd05c8e71e48252a5f0600ea66c8198d41179ca751c49976a8b6606b5e8f52b.json
rename to .sqlx/query-3be9ce3de1997682fc34534f301129a542094a2836d4519d1e04c47547099874.json
index 030b398890..e579333566 100644
--- a/.sqlx/query-4cd05c8e71e48252a5f0600ea66c8198d41179ca751c49976a8b6606b5e8f52b.json
+++ b/.sqlx/query-3be9ce3de1997682fc34534f301129a542094a2836d4519d1e04c47547099874.json
@@ -1,6 +1,6 @@
{
"db_name": "PostgreSQL",
- "query": "SELECT id, database_id, table_id, version, actor, acting_bot, ops, inverse\n FROM database_changes ORDER BY id",
+ "query": "SELECT id, database_id, table_id, version, actor, acting_bot, ops, inverse, payload_version\n FROM database_changes ORDER BY id",
"describe": {
"columns": [
{
@@ -42,6 +42,11 @@
"ordinal": 7,
"name": "inverse",
"type_info": "Jsonb"
+ },
+ {
+ "ordinal": 8,
+ "name": "payload_version",
+ "type_info": "Int4"
}
],
"parameters": {
@@ -55,8 +60,9 @@
true,
true,
false,
+ false,
false
]
},
- "hash": "4cd05c8e71e48252a5f0600ea66c8198d41179ca751c49976a8b6606b5e8f52b"
+ "hash": "3be9ce3de1997682fc34534f301129a542094a2836d4519d1e04c47547099874"
}
diff --git a/.sqlx/query-84779e83e75d31df37cd88a86fe050bc21dad7f257288628461bae42c3a1632c.json b/.sqlx/query-73ae4230781668c2fa7acbefd80908179b2a7437eeee8a2cd1d214c873522bfb.json
similarity index 61%
rename from .sqlx/query-84779e83e75d31df37cd88a86fe050bc21dad7f257288628461bae42c3a1632c.json
rename to .sqlx/query-73ae4230781668c2fa7acbefd80908179b2a7437eeee8a2cd1d214c873522bfb.json
index 5921df3f05..dface49610 100644
--- a/.sqlx/query-84779e83e75d31df37cd88a86fe050bc21dad7f257288628461bae42c3a1632c.json
+++ b/.sqlx/query-73ae4230781668c2fa7acbefd80908179b2a7437eeee8a2cd1d214c873522bfb.json
@@ -1,6 +1,6 @@
{
"db_name": "PostgreSQL",
- "query": "INSERT INTO database_changes (database_id, table_id, version, actor, acting_bot, ops, inverse)\n VALUES ($1, $2, $3, $4, $5, $6, $7)\n RETURNING id",
+ "query": "INSERT INTO database_changes (database_id, table_id, version, actor, acting_bot, ops, inverse, payload_version)\n VALUES ($1, $2, $3, $4, $5, $6, $7, $8)\n RETURNING id",
"describe": {
"columns": [
{
@@ -17,12 +17,13 @@
"Text",
"Text",
"Jsonb",
- "Jsonb"
+ "Jsonb",
+ "Int4"
]
},
"nullable": [
false
]
},
- "hash": "84779e83e75d31df37cd88a86fe050bc21dad7f257288628461bae42c3a1632c"
+ "hash": "73ae4230781668c2fa7acbefd80908179b2a7437eeee8a2cd1d214c873522bfb"
}
diff --git a/.sqlx/query-4b5524c8d188fe657222a6d6d54f2b2f808310b8a47759abb9f8e523b6e8f5f5.json b/.sqlx/query-a7dda27f9a9637a336b7030522d252f5046fe26a9bc4d544676903b6e18aa35c.json
similarity index 78%
rename from .sqlx/query-4b5524c8d188fe657222a6d6d54f2b2f808310b8a47759abb9f8e523b6e8f5f5.json
rename to .sqlx/query-a7dda27f9a9637a336b7030522d252f5046fe26a9bc4d544676903b6e18aa35c.json
index c3fa08dbc8..346b5b6cfb 100644
--- a/.sqlx/query-4b5524c8d188fe657222a6d6d54f2b2f808310b8a47759abb9f8e523b6e8f5f5.json
+++ b/.sqlx/query-a7dda27f9a9637a336b7030522d252f5046fe26a9bc4d544676903b6e18aa35c.json
@@ -1,6 +1,6 @@
{
"db_name": "PostgreSQL",
- "query": "SELECT id, table_id, version, actor, acting_bot, at, ops, inverse\n FROM database_changes WHERE id = $1 AND database_id = $2",
+ "query": "SELECT id, table_id, version, actor, acting_bot, at, ops, inverse, payload_version\n FROM database_changes WHERE id = $1 AND database_id = $2",
"describe": {
"columns": [
{
@@ -42,6 +42,11 @@
"ordinal": 7,
"name": "inverse",
"type_info": "Jsonb"
+ },
+ {
+ "ordinal": 8,
+ "name": "payload_version",
+ "type_info": "Int4"
}
],
"parameters": {
@@ -58,8 +63,9 @@
true,
false,
false,
+ false,
false
]
},
- "hash": "4b5524c8d188fe657222a6d6d54f2b2f808310b8a47759abb9f8e523b6e8f5f5"
+ "hash": "a7dda27f9a9637a336b7030522d252f5046fe26a9bc4d544676903b6e18aa35c"
}
diff --git a/.sqlx/query-0838bdbc334b945ec4851499f4d6627cd22ee68f348f52583ed0dbb3161c6623.json b/.sqlx/query-acad0f0e71a6258ca77208aa5149d66f188ceba1c4728036dadf84b02e3ebf10.json
similarity index 72%
rename from .sqlx/query-0838bdbc334b945ec4851499f4d6627cd22ee68f348f52583ed0dbb3161c6623.json
rename to .sqlx/query-acad0f0e71a6258ca77208aa5149d66f188ceba1c4728036dadf84b02e3ebf10.json
index e29ac85014..54d552cec1 100644
--- a/.sqlx/query-0838bdbc334b945ec4851499f4d6627cd22ee68f348f52583ed0dbb3161c6623.json
+++ b/.sqlx/query-acad0f0e71a6258ca77208aa5149d66f188ceba1c4728036dadf84b02e3ebf10.json
@@ -1,6 +1,6 @@
{
"db_name": "PostgreSQL",
- "query": "SELECT c.id, c.table_id, c.version, c.actor, c.acting_bot, c.at, c.ops, c.inverse,\n r.kind, r.columns\n FROM database_change_rows r\n JOIN database_changes c ON c.id = r.change_id\n WHERE r.row_id = $1 AND c.table_id = $2 AND c.database_id = $3\n ORDER BY r.change_id DESC",
+ "query": "SELECT c.id, c.table_id, c.version, c.actor, c.acting_bot, c.at, c.ops, c.inverse, c.payload_version,\n r.kind, r.columns\n FROM database_change_rows r\n JOIN database_changes c ON c.id = r.change_id\n WHERE r.row_id = $1 AND c.table_id = $2 AND c.database_id = $3\n ORDER BY r.change_id DESC",
"describe": {
"columns": [
{
@@ -45,11 +45,16 @@
},
{
"ordinal": 8,
+ "name": "payload_version",
+ "type_info": "Int4"
+ },
+ {
+ "ordinal": 9,
"name": "kind",
"type_info": "Text"
},
{
- "ordinal": 9,
+ "ordinal": 10,
"name": "columns",
"type_info": "UuidArray"
}
@@ -71,8 +76,9 @@
false,
false,
false,
+ false,
false
]
},
- "hash": "0838bdbc334b945ec4851499f4d6627cd22ee68f348f52583ed0dbb3161c6623"
+ "hash": "acad0f0e71a6258ca77208aa5149d66f188ceba1c4728036dadf84b02e3ebf10"
}
diff --git a/.sqlx/query-348cd1e39a77870cf9cce42d6d25f6a2634515ca35c2e14b9a0e4f225d14d670.json b/.sqlx/query-b87379d1d8af9ab91d8265706c310bdf95be8d5f29484807b37bec313438b01d.json
similarity index 77%
rename from .sqlx/query-348cd1e39a77870cf9cce42d6d25f6a2634515ca35c2e14b9a0e4f225d14d670.json
rename to .sqlx/query-b87379d1d8af9ab91d8265706c310bdf95be8d5f29484807b37bec313438b01d.json
index 8fc9178ef2..22ef0e667a 100644
--- a/.sqlx/query-348cd1e39a77870cf9cce42d6d25f6a2634515ca35c2e14b9a0e4f225d14d670.json
+++ b/.sqlx/query-b87379d1d8af9ab91d8265706c310bdf95be8d5f29484807b37bec313438b01d.json
@@ -1,6 +1,6 @@
{
"db_name": "PostgreSQL",
- "query": "SELECT id, table_id, version, actor, acting_bot, at, ops, inverse\n FROM database_changes WHERE table_id = $1 AND version > $2\n ORDER BY version",
+ "query": "SELECT id, table_id, version, actor, acting_bot, at, ops, inverse, payload_version\n FROM database_changes WHERE table_id = $1 AND version > $2\n ORDER BY version",
"describe": {
"columns": [
{
@@ -42,6 +42,11 @@
"ordinal": 7,
"name": "inverse",
"type_info": "Jsonb"
+ },
+ {
+ "ordinal": 8,
+ "name": "payload_version",
+ "type_info": "Int4"
}
],
"parameters": {
@@ -58,8 +63,9 @@
true,
false,
false,
+ false,
false
]
},
- "hash": "348cd1e39a77870cf9cce42d6d25f6a2634515ca35c2e14b9a0e4f225d14d670"
+ "hash": "b87379d1d8af9ab91d8265706c310bdf95be8d5f29484807b37bec313438b01d"
}
diff --git a/.sqlx/query-c7a846fd129481937e0fd7a2b8aa64bd26b7812faba88f3f623f6396ccdb699d.json b/.sqlx/query-c7a846fd129481937e0fd7a2b8aa64bd26b7812faba88f3f623f6396ccdb699d.json
new file mode 100644
index 0000000000..8f2ed6124c
--- /dev/null
+++ b/.sqlx/query-c7a846fd129481937e0fd7a2b8aa64bd26b7812faba88f3f623f6396ccdb699d.json
@@ -0,0 +1,14 @@
+{
+ "db_name": "PostgreSQL",
+ "query": "UPDATE database_changes SET payload_version = 2 WHERE id = $1",
+ "describe": {
+ "columns": [],
+ "parameters": {
+ "Left": [
+ "Int8"
+ ]
+ },
+ "nullable": []
+ },
+ "hash": "c7a846fd129481937e0fd7a2b8aa64bd26b7812faba88f3f623f6396ccdb699d"
+}
diff --git a/crates/databases/src/outbound/pg_databases_repo.rs b/crates/databases/src/outbound/pg_databases_repo.rs
index 871c1ddad0..46cc794e38 100644
--- a/crates/databases/src/outbound/pg_databases_repo.rs
+++ b/crates/databases/src/outbound/pg_databases_repo.rs
@@ -63,6 +63,9 @@ pub enum PgDatabasesRepoError {
/// A stored journal row's kind is not one the journal writes.
#[error("stored change kind `{0}` is not a row change kind")]
CorruptChangeKind(String),
+ /// This build cannot interpret the persisted journal payload format.
+ #[error("unsupported database journal payload version {0}")]
+ UnsupportedJournalPayloadVersion(i32),
}
/// The UUIDs of typed ids, for a statement's `ANY($n)`.
diff --git a/crates/databases/src/outbound/pg_databases_repo/journal.rs b/crates/databases/src/outbound/pg_databases_repo/journal.rs
index e3a0cb9eec..c950f947be 100644
--- a/crates/databases/src/outbound/pg_databases_repo/journal.rs
+++ b/crates/databases/src/outbound/pg_databases_repo/journal.rs
@@ -27,8 +27,8 @@ pub(crate) async fn record(
let mut committed = Vec::with_capacity(entries.len());
for entry in entries {
let id = sqlx::query_scalar!(
- r#"INSERT INTO database_changes (database_id, table_id, version, actor, acting_bot, ops, inverse)
- VALUES ($1, $2, $3, $4, $5, $6, $7)
+ r#"INSERT INTO database_changes (database_id, table_id, version, actor, acting_bot, ops, inverse, payload_version)
+ VALUES ($1, $2, $3, $4, $5, $6, $7, $8)
RETURNING id"#,
entry.database_id.into_uuid(),
entry.table.into_uuid(),
@@ -37,6 +37,7 @@ pub(crate) async fn record(
acting_bot,
serde_json::to_value(&entry.ops)?,
serde_json::to_value(&entry.inverse)?,
+ stored::JOURNAL_PAYLOAD_VERSION,
)
.fetch_one(&mut *connection)
.await?;
@@ -190,7 +191,7 @@ pub(crate) async fn row_history(
row: RowId,
) -> Result<Vec<JournaledRowChange>, PgDatabasesRepoError> {
let records = sqlx::query!(
- r#"SELECT c.id, c.table_id, c.version, c.actor, c.acting_bot, c.at, c.ops, c.inverse,
+ r#"SELECT c.id, c.table_id, c.version, c.actor, c.acting_bot, c.at, c.ops, c.inverse, c.payload_version,
r.kind, r.columns
FROM database_change_rows r
JOIN database_changes c ON c.id = r.change_id
@@ -213,8 +214,8 @@ pub(crate) async fn row_history(
actor: record.actor,
acting_bot: record.acting_bot,
at: record.at,
- ops: stored::ops(record.ops)?,
- inverse: stored::inverse(record.inverse)?,
+ ops: stored::ops(record.payload_version, record.ops)?,
+ inverse: stored::inverse(record.payload_version, record.inverse)?,
},
kind: record
.kind
@@ -256,7 +257,7 @@ pub(crate) async fn change(
change: ChangeId,
) -> Result<Option<ChangeRecord>, PgDatabasesRepoError> {
let records = sqlx::query!(
- r#"SELECT id, table_id, version, actor, acting_bot, at, ops, inverse
+ r#"SELECT id, table_id, version, actor, acting_bot, at, ops, inverse, payload_version
FROM database_changes WHERE id = $1 AND database_id = $2"#,
change.0,
database_id.into_uuid(),
@@ -273,8 +274,8 @@ pub(crate) async fn change(
actor: record.actor,
acting_bot: record.acting_bot,
at: record.at,
- ops: stored::ops(record.ops)?,
- inverse: stored::inverse(record.inverse)?,
+ ops: stored::ops(record.payload_version, record.ops)?,
+ inverse: stored::inverse(record.payload_version, record.inverse)?,
})
})
.collect::<Result<Vec<_>, PgDatabasesRepoError>>()?;
@@ -288,7 +289,7 @@ pub(crate) async fn changes_after(
version: TableVersion,
) -> Result<Vec<ChangeRecord>, PgDatabasesRepoError> {
let records = sqlx::query!(
- r#"SELECT id, table_id, version, actor, acting_bot, at, ops, inverse
+ r#"SELECT id, table_id, version, actor, acting_bot, at, ops, inverse, payload_version
FROM database_changes WHERE table_id = $1 AND version > $2
ORDER BY version"#,
table.into_uuid(),
@@ -306,8 +307,8 @@ pub(crate) async fn changes_after(
actor: record.actor,
acting_bot: record.acting_bot,
at: record.at,
- ops: stored::ops(record.ops)?,
- inverse: stored::inverse(record.inverse)?,
+ ops: stored::ops(record.payload_version, record.ops)?,
+ inverse: stored::inverse(record.payload_version, record.inverse)?,
})
})
.collect::<Result<Vec<_>, PgDatabasesRepoError>>()?;
diff --git a/crates/databases/src/outbound/pg_databases_repo/stored.rs b/crates/databases/src/outbound/pg_databases_repo/stored.rs
index bfc6dc3a36..1b98992292 100644
--- a/crates/databases/src/outbound/pg_databases_repo/stored.rs
+++ b/crates/databases/src/outbound/pg_databases_repo/stored.rs
@@ -107,14 +107,35 @@ pub(super) fn layout(
})
}
+/// Persisted ops and inverse JSON format, independent of table revisions and
+/// the inverse's restoration-safety version. Legacy rows also use this format.
+pub(super) const JOURNAL_PAYLOAD_VERSION: i32 = 1;
+
+fn require_journal_version(version: i32) -> Result<(), PgDatabasesRepoError> {
+ match version {
+ JOURNAL_PAYLOAD_VERSION => Ok(()),
+ other => Err(PgDatabasesRepoError::UnsupportedJournalPayloadVersion(
+ other,
+ )),
+ }
+}
+
/// A journaled change's ops.
-pub(super) fn ops(mut stored: Value) -> Result<Vec<DatabaseOp>, PgDatabasesRepoError> {
+pub(super) fn ops(
+ version: i32,
+ mut stored: Value,
+) -> Result<Vec<DatabaseOp>, PgDatabasesRepoError> {
+ require_journal_version(version)?;
upgrade_lanes(&mut stored)?;
Ok(serde_json::from_value(stored)?)
}
/// What undoes a journaled change.
-pub(super) fn inverse(mut stored: Value) -> Result<ChangeInverse, PgDatabasesRepoError> {
+pub(super) fn inverse(
+ version: i32,
+ mut stored: Value,
+) -> Result<ChangeInverse, PgDatabasesRepoError> {
+ require_journal_version(version)?;
upgrade_lanes(&mut stored)?;
Ok(serde_json::from_value(stored)?)
}
diff --git a/crates/databases/src/outbound/pg_databases_repo/stored/test.rs b/crates/databases/src/outbound/pg_databases_repo/stored/test.rs
index e9e665fa82..abe2098ce1 100644
--- a/crates/databases/src/outbound/pg_databases_repo/stored/test.rs
+++ b/crates/databases/src/outbound/pg_databases_repo/stored/test.rs
@@ -100,7 +100,7 @@ fn a_journaled_card_move_and_board_from_before_people_read_in_todays_shape() {
]);
assert_eq!(
- ops(stored).unwrap(),
+ ops(1, stored).unwrap(),
vec![
DatabaseOp::View {
table: TABLE,
@@ -145,3 +145,29 @@ fn a_journaled_card_move_and_board_from_before_people_read_in_todays_shape() {
]
);
}
+
+#[test]
+fn journal_payload_version_is_checked_before_interpreting_json() {
+ for version in [0, 2, i32::MAX] {
+ assert!(matches!(
+ ops(version, json!([])),
+ Err(super::PgDatabasesRepoError::UnsupportedJournalPayloadVersion(found)) if found == version
+ ));
+ assert!(matches!(
+ super::inverse(version, json!(null)),
+ Err(super::PgDatabasesRepoError::UnsupportedJournalPayloadVersion(found)) if found == version
+ ));
+ }
+}
+
+#[test]
+fn version_one_preserves_the_existing_inverse_json_contract() {
+ let inverse = crate::domain::journal::ChangeInverse::default();
+ assert_eq!(
+ super::inverse(1, serde_json::to_value(&inverse).unwrap()).unwrap(),
+ inverse
+ );
+ let mut legacy = serde_json::to_value(&inverse).unwrap();
+ legacy.as_object_mut().unwrap().remove("formatVersion");
+ assert_eq!(super::inverse(1, legacy).unwrap().format_version, 0);
+}
diff --git a/crates/databases/src/outbound/pg_databases_repo/test/journal.rs b/crates/databases/src/outbound/pg_databases_repo/test/journal.rs
index 36d00c5b28..122170a7e0 100644
--- a/crates/databases/src/outbound/pg_databases_repo/test/journal.rs
+++ b/crates/databases/src/outbound/pg_databases_repo/test/journal.rs
@@ -305,7 +305,7 @@ async fn every_committed_batch_of_the_guest_list_is_journaled_with_its_inverse(p
wolf_deletes_plus_ones(&pool, &wedding).await;
let changes = sqlx::query!(
- r#"SELECT id, database_id, table_id, version, actor, acting_bot, ops, inverse
+ r#"SELECT id, database_id, table_id, version, actor, acting_bot, ops, inverse, payload_version
FROM database_changes ORDER BY id"#
)
.fetch_all(&pool)
@@ -314,6 +314,7 @@ async fn every_committed_batch_of_the_guest_list_is_journaled_with_its_inverse(p
let changes: Vec<_> = changes
.into_iter()
.map(|change| {
+ assert_eq!(change.payload_version, 1);
(
change.id,
change.database_id,
@@ -775,3 +776,43 @@ async fn applying_each_inverse_newest_first_puts_the_table_back_as_it_was(pool:
assert_eq!(restored, vec![without_omar, maybe, inserted, empty]);
}
+
+#[sqlx::test(migrator = "MACRO_DB_MIGRATIONS")]
+async fn unknown_journal_payload_versions_are_refused_by_every_history_reader(pool: PgPool) {
+ let wedding = wedding(&pool).await;
+ let (maria, _) = insert_guests(&pool, &wedding).await;
+ let repo = PgDatabasesRepo::new(pool.clone(), PropertiesPgRepo::new(pool.clone()));
+ let changes = repo
+ .changes_after(wedding.table_id, TableVersion(0))
+ .await
+ .unwrap();
+ let change = changes.last().unwrap().change.id;
+ assert!(
+ !repo
+ .row_history(wedding.database_id, wedding.table_id, maria)
+ .await
+ .unwrap()
+ .is_empty()
+ );
+
+ sqlx::query!(
+ "UPDATE database_changes SET payload_version = 2 WHERE id = $1",
+ change.0
+ )
+ .execute(&pool)
+ .await
+ .unwrap();
+
+ let errors = [
+ repo.change(wedding.database_id, change).await.unwrap_err(),
+ repo.changes_after(wedding.table_id, TableVersion(0))
+ .await
+ .unwrap_err(),
+ repo.row_history(wedding.database_id, wedding.table_id, maria)
+ .await
+ .unwrap_err(),
+ ];
+ for error in errors {
+ assert!(matches!(error, crate::outbound::pg_databases_repo::PgDatabasesRepoError::UnsupportedJournalPayloadVersion(2)));
+ }
+}
diff --git a/crates/macro_db_client/migrations/20261002202416_database_journal_payload_version.down.sql b/crates/macro_db_client/migrations/20261002202416_database_journal_payload_version.down.sql
new file mode 100644
index 0000000000..1505803d63
--- /dev/null
+++ b/crates/macro_db_client/migrations/20261002202416_database_journal_payload_version.down.sql
@@ -0,0 +1 @@
+ALTER TABLE database_changes DROP COLUMN payload_version;
diff --git a/crates/macro_db_client/migrations/20261002202416_database_journal_payload_version.up.sql b/crates/macro_db_client/migrations/20261002202416_database_journal_payload_version.up.sql
new file mode 100644
index 0000000000..321fe9384a
--- /dev/null
+++ b/crates/macro_db_client/migrations/20261002202416_database_journal_payload_version.up.sql
@@ -0,0 +1,6 @@
+-- Format of the ops and inverse JSON payloads; independent of table version.
+-- Existing rows and older writers use the original format (1). Its JSON shape
+-- is unchanged, so older readers remain compatible during rolling deployment.
+ALTER TABLE database_changes
+ ADD COLUMN payload_version INTEGER NOT NULL DEFAULT 1
+ CHECK (payload_version > 0);