WIP prototype migrations

This commit is contained in:
Dennis Kobert
2026-07-14 13:54:41 +02:00
parent 97f8113fe4
commit 6c084fb954
17 changed files with 827 additions and 3 deletions
+34 -1
View File
@@ -10,7 +10,7 @@
use std::collections::HashMap;
use crate::{AttributesWrite, CrdtError, Delta, Rev, TimeStamp};
use crate::{AttributesWrite, CrdtError, Delta, RegistryDelta, Rev, TimeStamp};
#[derive(Clone, Debug, Default)]
pub struct History {
@@ -178,3 +178,36 @@ impl History {
Ok(())
}
}
/// Recompute every delta's content-addressed `Rev` after delta payloads were rewritten, walking in
/// topological order and remapping parent links (including `Merge` extra parents) along the way.
/// Returns the old → new mapping for remapping cursors (`head`, redo stack, broadcast tip).
pub fn rehash_deltas(deltas: &mut [Delta]) -> HashMap<Rev, Rev> {
fn remap_merge_parents(kind: &mut RegistryDelta, mapping: &HashMap<Rev, Rev>) {
if let RegistryDelta::Merge { extra_parents } = kind {
for parent in extra_parents.iter_mut() {
if let Some(new) = mapping.get(parent) {
*parent = *new;
}
}
}
}
let mut mapping: HashMap<Rev, Rev> = HashMap::new();
for delta in deltas.iter_mut() {
if let Some(parent) = delta.parent.as_mut()
&& let Some(new) = mapping.get(parent)
{
*parent = *new;
}
remap_merge_parents(&mut delta.kind, &mapping);
remap_merge_parents(&mut delta.reverse, &mapping);
let new_id = delta.recomputed_id();
mapping.insert(delta.id, new_id);
delta.id = new_id;
}
mapping
}
+1 -1
View File
@@ -21,7 +21,7 @@ pub mod to_runtime;
pub use attributes::*;
pub use crdt::*;
pub use document::*;
pub use history::History;
pub use history::{History, rehash_deltas};
pub use ids::*;
pub use model::*;
pub use registry::*;
+24
View File
@@ -11,6 +11,15 @@ pub struct Node {
}
impl Node {
pub fn new(implementation: Implementation, inputs: Vec<InputSlot>, attributes: Attributes, network: NetworkId) -> Self {
Self {
implementation,
inputs,
attributes,
network,
}
}
pub fn implementation(&self) -> &Implementation {
&self.implementation
}
@@ -24,6 +33,21 @@ impl Node {
self.network
}
// Mutable access for edits on a registry clone that is diffed back into deltas;
// live-session edits go through the delta paths instead.
pub fn implementation_mut(&mut self) -> &mut Implementation {
&mut self.implementation
}
pub fn inputs_mut(&mut self) -> &mut Vec<InputSlot> {
&mut self.inputs
}
pub fn attributes_mut(&mut self) -> &mut Attributes {
&mut self.attributes
}
pub fn set_network(&mut self, network: NetworkId) {
self.network = network;
}
/// True if both nodes agree on every value-bearing field, ignoring slot/attribute timestamps.
pub fn value_equal(&self, other: &Self) -> bool {
if self.implementation != other.implementation || self.network != other.network {
+1 -1
View File
@@ -45,7 +45,7 @@ impl<'de> Deserialize<'de> for ResourceEntry {
}
let Raw { mut sources, hash, hash_timestamp } = Raw::deserialize(deserializer)?;
sources.sort_by(|(a, _), (b, _)| a.cmp(b));
sources.sort_by_key(|(key, _)| *key);
sources.dedup_by(|(later_key, later_value), (kept_key, kept_value)| {
// `dedup_by` keeps the first of each run; sorting is stable, so resolve duplicates by LWW.
if later_key != kept_key {
+21
View File
@@ -92,6 +92,27 @@ impl Session {
Ok(conversion.network_ids)
}
/// Diff the working registry against `target` and stage the difference as hot ops, so bulk
/// registry mutations commit through the ordinary hot-op path without hand-built deltas.
pub fn stage_registry_replace(&mut self, target: &Registry) -> Result<Vec<HotOp>, CrdtError> {
let ops = crate::delta::compute_deltas(&self.document.working_registry, target);
self.stage_ops(ops)
}
/// Retire every pending hot op as one gesture. Convenience over [`Session::retire`] for callers
/// that don't track hot-op timestamps themselves.
pub fn retire_all(&mut self) -> Result<Vec<Rev>, CrdtError> {
match self.document.hot_log.iter().map(|hot_op| hot_op.timestamp).max() {
Some(up_to) => self.retire(up_to),
None => Ok(Vec::new()),
}
}
/// Mint a fresh peer-scoped `NodeId`. Forwards to [`Document::next_node_id`].
pub fn next_node_id(&mut self) -> NodeId {
self.document.next_node_id()
}
/// Register a content-addressed resource as a single `DataSource::Embedded` source resolved to
/// `hash`, staged as one `AddResource` hot op. The caller owns `id` allocation, persists the
/// returned hot frame, retires, and persists the bytes into its byte store separately.
+21
View File
@@ -0,0 +1,21 @@
[package]
name = "migration-core"
description = "Trait definitions and selectors for Graphite document migrations"
edition.workspace = true
version.workspace = true
license.workspace = true
authors.workspace = true
[features]
default = ["typed"]
# Content-tier migrations over the typed registry. Format-tier-only migration crates
# (historic version steps, wasm builds) disable this to drop the graph-storage dependency.
typed = ["dep:graph-storage"]
[dependencies]
graph-storage = { workspace = true, optional = true }
serde = { workspace = true }
serde_json = { workspace = true }
rmp-serde = { workspace = true }
thiserror = { workspace = true }
+82
View File
@@ -0,0 +1,82 @@
use crate::{MigrationError, MigrationId};
use graph_storage::{Node, NodeId, Registry, ResourceId};
/// Identity of a proto-node declaration, as read from the declaration resource body.
#[derive(Clone, Debug)]
pub struct DeclarationInfo {
pub identifier: String,
/// Explicit behavioral version; 0 for declarations predating versioning.
pub version: u32,
}
/// Which registry entities a content migration applies to.
#[derive(Clone, Debug)]
pub enum Selector {
/// Every node whose proto-node declaration matches.
Node(NodeSelector),
/// Every node carrying this `ui::reference` attribute value (how legacy wrapper networks
/// like "Brush" are identified).
Reference(&'static str),
/// Once per document, gated by the [`crate::APPLIED_ATTRIBUTE`] provenance list.
Document,
}
/// Matches nodes by declaration identifier (with historic aliases) and version range.
#[derive(Clone, Debug)]
pub struct NodeSelector {
/// Current declaration identifier plus historic aliases.
pub names: &'static [&'static str],
/// Upgrade target: nodes with a declaration version strictly below this match.
pub below_version: u32,
}
impl NodeSelector {
/// Whether a node with this declaration identity is matched.
pub fn matches(&self, declaration: &DeclarationInfo) -> bool {
// TODO(Dennis): Matching semantics to decide here:
// - Legacy identifiers can carry generic type arguments (`...MemoNode<T>`); the old system
// compared with `identifier.split('<').next()`. Strip them, or require exact matches?
// - Should `below_version` also gate name-alias matches, or do aliases (which only appear in
// pre-versioning documents, version 0) always match regardless?
let _ = declaration;
todo!("decide and implement declaration matching")
}
}
/// One matched entity, produced by scanning a [`Selector`] over the registry.
#[derive(Copy, Clone, Debug)]
pub enum Target {
Node(NodeId),
Document,
}
/// Byte-store and catalog services only the host (editor or CLI) can provide.
pub trait MigrationHost {
/// Read a declaration resource's identity (identifier and version).
fn declaration_info(&self, id: ResourceId) -> Option<DeclarationInfo>;
/// The decoded declaration body, for inspection beyond the identity.
fn declaration(&self, id: ResourceId) -> Option<serde_json::Value>;
/// Instantiate the current catalog default node for a declaration identifier.
fn resolve_definition(&mut self, identifier: &str) -> Option<Node>;
}
/// Everything a content migration can reach beyond the registry: host services plus ID minting.
pub trait MigrationContext: MigrationHost {
/// Mint a fresh peer-scoped node ID for inserted nodes.
fn mint_node_id(&mut self) -> NodeId;
}
/// One node-usage upgrade within the current format version.
///
/// `migrate` mutates a registry clone in place; the mutation is diffed into deltas and committed to
/// history as one retired gesture, so implementations never construct deltas by hand. Timestamps
/// written into the clone are placeholders the commit path re-stamps. Implementations must be
/// idempotent: a document can round-trip through an editor build that lacks a later migration.
pub trait ContentMigration {
/// Stable identifier recorded in provenance.
fn id(&self) -> MigrationId;
/// Which registry entities to run on.
fn selector(&self) -> Selector;
/// Upgrade one matched target in place.
fn migrate(&self, target: Target, registry: &mut Registry, context: &mut dyn MigrationContext) -> Result<(), MigrationError>;
}
+11
View File
@@ -0,0 +1,11 @@
use thiserror::Error;
#[derive(Debug, Error)]
pub enum MigrationError {
#[error("failed to decode payload: {0}")]
Decode(String),
#[error("failed to encode payload: {0}")]
Encode(String),
#[error("migration invariant violated: {0}")]
Invariant(String),
}
+44
View File
@@ -0,0 +1,44 @@
use crate::{MigrationError, MigrationId, Payload};
/// How stored history survives a format step.
///
/// Under `Rewrite`, the migration transforms each record's payload via
/// [`FormatMigration::migrate_delta`]; the runner then recomputes `Rev`s in topological order and
/// remaps parent links and session cursors. Because the rewrite is a pure function of content and
/// `Rev`s are content-addressed, peers applying the same migration converge on identical rewritten
/// history without coordination.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum HistoryPolicy {
/// The shape change does not affect stored deltas.
Untouched,
/// Each history record is rewritten via `migrate_delta`.
Rewrite,
/// No faithful rewrite exists; the document becomes a state-only snapshot.
Truncate,
}
/// One whole-document format step, migrating version `migrates_from()` to `migrates_from() + 1`.
///
/// Implementations freeze whatever old struct shapes they need locally (deserialized from
/// [`Payload`]s); the active codebase never carries them. Migrations only transform payload
/// content, never identity fields (`id`, `parent`) — Merkle bookkeeping belongs to the runner.
pub trait FormatMigration {
/// Stable identifier recorded in provenance.
fn id(&self) -> MigrationId;
/// The format version this step upgrades from.
fn migrates_from(&self) -> u32;
/// Transform the serialized registry payload.
fn migrate_registry(&self, registry: &Payload) -> Result<Payload, MigrationError>;
/// How stored history survives this step.
fn history_policy(&self) -> HistoryPolicy {
HistoryPolicy::Untouched
}
/// Transform one history record. Called only under [`HistoryPolicy::Rewrite`].
fn migrate_delta(&self, delta: &Payload) -> Result<Payload, MigrationError> {
Ok(delta.clone())
}
/// Transform the per-peer session payload.
fn migrate_session(&self, session: &Payload) -> Result<Payload, MigrationError> {
Ok(session.clone())
}
}
+41
View File
@@ -0,0 +1,41 @@
//! Trait definitions for `.gdd` document migrations.
//!
//! Two tiers: a [`FormatMigration`] steps a document's serialized payloads from one format version
//! to the next, and a [`ContentMigration`] (feature `typed`) upgrades node usages on the typed
//! `Registry` within the current version. Migration crates export a [`MigrationSet`] via a plain
//! constructor function; the `migration-runner` crate aggregates and dispatches them. Design
//! rationale lives in `node-graph/rfcs/document-format-migrations.md`.
#[cfg(feature = "typed")]
pub mod content;
pub mod error;
pub mod format;
pub mod payload;
#[cfg(feature = "typed")]
pub use content::{ContentMigration, DeclarationInfo, MigrationContext, MigrationHost, NodeSelector, Selector, Target};
pub use error::MigrationError;
pub use format::{FormatMigration, HistoryPolicy};
pub use payload::{Payload, PayloadCodec};
/// Document attribute holding the list of applied `Document`-selector migration IDs.
pub const APPLIED_ATTRIBUTE: &str = "migrations::applied";
/// Stable identifier for one migration, recorded in provenance and used for skip checks.
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub struct MigrationId(pub &'static str);
impl std::fmt::Display for MigrationId {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.write_str(self.0)
}
}
/// What one migration crate exports: its migrations, in application order.
/// Staged node upgrades must be registered in ascending target-version order.
#[derive(Default)]
pub struct MigrationSet {
pub format: Vec<Box<dyn FormatMigration>>,
#[cfg(feature = "typed")]
pub content: Vec<Box<dyn ContentMigration>>,
}
+47
View File
@@ -0,0 +1,47 @@
use crate::MigrationError;
use serde::Serialize;
use serde::de::DeserializeOwned;
/// Codec of a serialized payload. Mirrors the `document-format` codec table entries relevant to
/// migrations so migration crates don't depend on `document-format`; the runner maps between the two.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum PayloadCodec {
Json,
MessagePack,
}
/// One serialized document payload (the registry, a single history record, the session) plus its
/// codec. History framing is the runner's concern; migrations always see one record per payload.
#[derive(Clone, Debug)]
pub struct Payload {
pub bytes: Vec<u8>,
pub codec: PayloadCodec,
}
impl Payload {
pub fn new(bytes: Vec<u8>, codec: PayloadCodec) -> Self {
Self { bytes, codec }
}
/// Decode into a typed shape, usually a frozen mirror struct owned by the migration crate.
pub fn decode<T: DeserializeOwned>(&self) -> Result<T, MigrationError> {
match self.codec {
PayloadCodec::Json => serde_json::from_slice(&self.bytes).map_err(|e| MigrationError::Decode(e.to_string())),
PayloadCodec::MessagePack => rmp_serde::from_slice(&self.bytes).map_err(|e| MigrationError::Decode(e.to_string())),
}
}
/// Encode a typed shape with the given codec.
pub fn encode<T: Serialize>(value: &T, codec: PayloadCodec) -> Result<Self, MigrationError> {
let bytes = match codec {
PayloadCodec::Json => serde_json::to_vec(value).map_err(|e| MigrationError::Encode(e.to_string()))?,
PayloadCodec::MessagePack => rmp_serde::to_vec(value).map_err(|e| MigrationError::Encode(e.to_string()))?,
};
Ok(Self { bytes, codec })
}
/// Encode a typed shape, keeping this payload's codec.
pub fn encode_as<T: Serialize>(&self, value: &T) -> Result<Self, MigrationError> {
Self::encode(value, self.codec)
}
}
+15
View File
@@ -0,0 +1,15 @@
[package]
name = "migration-runner"
description = "Dispatches Graphite document migrations across the format and content tiers"
edition.workspace = true
version.workspace = true
license.workspace = true
authors.workspace = true
[dependencies]
migration-core = { workspace = true }
graph-storage = { workspace = true }
serde_json = { workspace = true }
thiserror = { workspace = true }
log = { workspace = true }
+221
View File
@@ -0,0 +1,221 @@
//! Dispatches document migrations: format-version chaining over serialized payloads, then
//! delta-expressed content migrations over the typed registry. See
//! `node-graph/rfcs/document-format-migrations.md` for the pipeline design.
use graph_storage::{AttributesRead, AttributesWrite, CrdtError, Implementation, NodeId, Registry, ResourceId, Rev, Session, TimeStamp, attr};
use migration_core::{APPLIED_ATTRIBUTE, DeclarationInfo, FormatMigration, HistoryPolicy, MigrationContext, MigrationError, MigrationHost, MigrationSet, Payload, Selector, Target};
pub use graph_storage::rehash_deltas;
#[derive(Debug, thiserror::Error)]
pub enum RunnerError {
#[error("no format migration registered for version {at_version}")]
MissingFormatStep { at_version: u32 },
#[error("format migration {id} failed: {source}")]
Format { id: &'static str, source: MigrationError },
#[error("failed to commit migration deltas: {0}")]
Crdt(#[from] CrdtError),
}
/// The serialized payloads of one document, as handed over by the load path before typed
/// deserialization. History records are unframed: one [`Payload`] per retired delta, in stored
/// (topological) order.
pub struct DocumentPayloads {
pub format_version: u32,
pub registry: Payload,
pub history: Vec<Payload>,
pub session: Option<Payload>,
}
/// What the format tier did to history, so the load path knows whether a `Rev` rehash pass
/// (with session-cursor remap) is required after typed deserialization. Ordered by severity so
/// chained steps combine via `max`.
#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
pub enum HistoryOutcome {
Untouched,
/// At least one step rewrote records: rehash `Rev`s with [`rehash_deltas`] and remap cursors.
Rewritten,
/// At least one step truncated history: reset cursors, the document is a state-only snapshot.
Truncated,
}
/// Aggregates registered [`MigrationSet`]s and dispatches them over a document.
pub struct MigrationRunner {
sets: Vec<MigrationSet>,
}
impl MigrationRunner {
pub fn new(sets: Vec<MigrationSet>) -> Self {
Self { sets }
}
fn format_step(&self, version: u32) -> Option<&dyn FormatMigration> {
self.sets
.iter()
.flat_map(|set| &set.format)
.find(|migration| migration.migrates_from() == version)
.map(|migration| migration.as_ref())
}
/// Chain format steps from `payloads.format_version` up to `target_version`, bumping the
/// version once per applied step. A missing step in the chain is a hard error.
pub fn run_format_migrations(&self, payloads: &mut DocumentPayloads, target_version: u32) -> Result<HistoryOutcome, RunnerError> {
let mut outcome = HistoryOutcome::Untouched;
while payloads.format_version < target_version {
let version = payloads.format_version;
let step = self.format_step(version).ok_or(RunnerError::MissingFormatStep { at_version: version })?;
let fail = |source| RunnerError::Format { id: step.id().0, source };
payloads.registry = step.migrate_registry(&payloads.registry).map_err(fail)?;
match step.history_policy() {
HistoryPolicy::Untouched => {}
HistoryPolicy::Rewrite => {
for record in &mut payloads.history {
*record = step.migrate_delta(record).map_err(fail)?;
}
outcome = outcome.max(HistoryOutcome::Rewritten);
}
HistoryPolicy::Truncate => {
payloads.history.clear();
outcome = HistoryOutcome::Truncated;
}
}
if let Some(session) = &payloads.session {
payloads.session = Some(step.migrate_session(session).map_err(fail)?);
}
payloads.format_version += 1;
}
Ok(outcome)
}
/// Run content migrations over an open session, committing each migration's changes as one
/// retired gesture. A target that errors has its changes reverted and logged, so one bad node
/// doesn't block the rest of the document or the remaining migrations. Returns the retired revs.
pub fn run_content_migrations(&self, session: &mut Session, host: &mut dyn MigrationHost) -> Result<Vec<Rev>, RunnerError> {
let mut all_revs = Vec::new();
for migration in self.sets.iter().flat_map(|set| &set.content) {
let selector = migration.selector();
// `Document`-selector migrations have no self-gating selector, so provenance gates reruns
if matches!(selector, Selector::Document) && applied_migrations(session.registry()).iter().any(|applied| applied == migration.id().0) {
continue;
}
let targets = collect_targets(&selector, session.registry(), host);
if targets.is_empty() {
continue;
}
// Apply per target on a shared clone, restoring the pre-target state on error
let mut target_registry = session.registry().clone();
let mut applied = false;
for target in targets {
let backup = target_registry.clone();
let mut context = SessionContext {
session: &mut *session,
host: &mut *host,
};
match migration.migrate(target, &mut target_registry, &mut context) {
Ok(()) => applied = true,
Err(error) => {
log::error!("Content migration {} failed on {target:?}: {error}", migration.id());
target_registry = backup;
}
}
}
if !applied {
continue;
}
if matches!(selector, Selector::Document) {
record_applied(&mut target_registry, migration.id().0);
}
// Commit the mutation as deltas and retire them as one undoable gesture
if !session.registry().value_equal(&target_registry) {
session.stage_registry_replace(&target_registry)?;
let revs = session.retire_all()?;
if let Some(last) = revs.last() {
session.mark_interaction_end(*last);
}
all_revs.extend(revs);
}
}
Ok(all_revs)
}
}
fn applied_migrations(registry: &Registry) -> Vec<String> {
registry.attributes.get_typed::<Vec<String>>(APPLIED_ATTRIBUTE).unwrap_or_default()
}
fn record_applied(registry: &mut Registry, id: &str) {
let mut applied = applied_migrations(registry);
if !applied.iter().any(|existing| existing == id) {
applied.push(id.to_string());
// The placeholder timestamp is re-stamped by the commit path
let _ = registry.attributes.set_serialized(APPLIED_ATTRIBUTE, &applied, TimeStamp::default());
}
}
/// Scan the registry for the entities a selector matches, in deterministic (sorted) order.
fn collect_targets(selector: &Selector, registry: &Registry, host: &dyn MigrationHost) -> Vec<Target> {
let node_targets = |mut nodes: Vec<NodeId>| {
nodes.sort_unstable();
nodes.into_iter().map(Target::Node).collect()
};
match selector {
Selector::Document => vec![Target::Document],
Selector::Reference(name) => node_targets(
registry
.node_instances
.iter()
.filter(|(_, node)| node.attributes().get(attr::node::ui::REFERENCE).is_some_and(|value| value.value.as_str() == Some(name)))
.map(|(id, _)| *id)
.collect(),
),
Selector::Node(node_selector) => node_targets(
registry
.node_instances
.iter()
.filter(|(_, node)| {
let Implementation::ProtoNode(resource_id) = node.implementation() else { return false };
host.declaration_info(*resource_id).is_some_and(|info| node_selector.matches(&info))
})
.map(|(id, _)| *id)
.collect(),
),
}
}
/// Combines the open session (ID minting) with host services into the context migrations see.
struct SessionContext<'a> {
session: &'a mut Session,
host: &'a mut dyn MigrationHost,
}
impl MigrationHost for SessionContext<'_> {
fn declaration_info(&self, id: ResourceId) -> Option<DeclarationInfo> {
self.host.declaration_info(id)
}
fn declaration(&self, id: ResourceId) -> Option<serde_json::Value> {
self.host.declaration(id)
}
fn resolve_definition(&mut self, identifier: &str) -> Option<graph_storage::Node> {
self.host.resolve_definition(identifier)
}
}
impl MigrationContext for SessionContext<'_> {
fn mint_node_id(&mut self) -> NodeId {
self.session.next_node_id()
}
}
+145
View File
@@ -0,0 +1,145 @@
use graph_storage::{Attributes, AttributesRead, AttributesWrite, Implementation, Network, Node, PeerId, ROOT_NETWORK, Registry, ResourceId, Session, TimeStamp};
use migration_core::{
ContentMigration, DeclarationInfo, FormatMigration, HistoryPolicy, MigrationContext, MigrationError, MigrationHost, MigrationId, MigrationSet, Payload, PayloadCodec, Selector, Target,
};
use migration_runner::{DocumentPayloads, HistoryOutcome, MigrationRunner, RunnerError};
struct NoHost;
impl MigrationHost for NoHost {
fn declaration_info(&self, _id: ResourceId) -> Option<DeclarationInfo> {
None
}
fn declaration(&self, _id: ResourceId) -> Option<serde_json::Value> {
None
}
fn resolve_definition(&mut self, _identifier: &str) -> Option<Node> {
None
}
}
/// A v1 → v2 format step that renames a top-level registry key, exercising the frozen-shape
/// decode/encode round trip.
struct RenameKey;
impl FormatMigration for RenameKey {
fn id(&self) -> MigrationId {
MigrationId("test-rename-key")
}
fn migrates_from(&self) -> u32 {
1
}
fn migrate_registry(&self, registry: &Payload) -> Result<Payload, MigrationError> {
let mut value: serde_json::Value = registry.decode()?;
if let Some(object) = value.as_object_mut()
&& let Some(old) = object.remove("old_key")
{
object.insert("new_key".to_string(), old);
}
registry.encode_as(&value)
}
fn history_policy(&self) -> HistoryPolicy {
HistoryPolicy::Truncate
}
}
fn format_set() -> MigrationSet {
MigrationSet {
format: vec![Box::new(RenameKey)],
..Default::default()
}
}
#[test]
fn format_tier_chains_and_bumps_version() {
let runner = MigrationRunner::new(vec![format_set()]);
let mut payloads = DocumentPayloads {
format_version: 1,
registry: Payload::encode(&serde_json::json!({ "old_key": 42 }), PayloadCodec::Json).unwrap(),
history: vec![Payload::new(vec![1, 2, 3], PayloadCodec::MessagePack)],
session: None,
};
let outcome = runner.run_format_migrations(&mut payloads, 2).unwrap();
assert_eq!(payloads.format_version, 2);
assert_eq!(outcome, HistoryOutcome::Truncated);
assert!(payloads.history.is_empty());
let registry: serde_json::Value = payloads.registry.decode().unwrap();
assert_eq!(registry, serde_json::json!({ "new_key": 42 }));
}
#[test]
fn format_tier_errors_on_missing_step() {
let runner = MigrationRunner::new(vec![format_set()]);
let mut payloads = DocumentPayloads {
format_version: 0,
registry: Payload::encode(&serde_json::json!({}), PayloadCodec::Json).unwrap(),
history: Vec::new(),
session: None,
};
let error = runner.run_format_migrations(&mut payloads, 2).unwrap_err();
assert!(matches!(error, RunnerError::MissingFormatStep { at_version: 0 }));
}
/// Flags every "Brush"-referenced node with a marker attribute, exercising the delta-expressed
/// clone-mutate-diff-commit path.
struct FlagBrushNodes;
impl ContentMigration for FlagBrushNodes {
fn id(&self) -> MigrationId {
MigrationId("test-flag-brush")
}
fn selector(&self) -> Selector {
Selector::Reference("Brush")
}
fn migrate(&self, target: Target, registry: &mut Registry, _context: &mut dyn MigrationContext) -> Result<(), MigrationError> {
let Target::Node(node_id) = target else { return Ok(()) };
let node = registry.node_instances.get_mut(&node_id).ok_or(MigrationError::Invariant("matched node missing".to_string()))?;
node.attributes_mut().set("migrated", serde_json::Value::Bool(true), TimeStamp::default());
Ok(())
}
}
fn seeded_session() -> (Session, graph_storage::NodeId) {
let mut session = Session::with_peer(PeerId(7));
let node_id = graph_storage::NodeId(99);
let mut registry = Registry::default();
registry.networks.insert(ROOT_NETWORK, Network::default());
let mut attributes = Attributes::new();
attributes.set(graph_storage::attr::node::ui::REFERENCE, serde_json::Value::String("Brush".to_string()), TimeStamp::default());
registry
.node_instances
.insert(node_id, Node::new(Implementation::ProtoNode(ResourceId::new()), Vec::new(), attributes, ROOT_NETWORK));
session.stage_registry_replace(&registry).unwrap();
session.retire_all().unwrap();
(session, node_id)
}
#[test]
fn content_tier_commits_migration_as_history_deltas() {
let runner = MigrationRunner::new(vec![MigrationSet {
content: vec![Box::new(FlagBrushNodes)],
..Default::default()
}]);
let (mut session, node_id) = seeded_session();
let history_before = session.history().count();
let revs = runner.run_content_migrations(&mut session, &mut NoHost).unwrap();
assert!(!revs.is_empty());
assert!(session.history().count() > history_before);
let node = &session.registry().node_instances[&node_id];
assert_eq!(node.attributes().get_typed::<bool>("migrated"), Some(true));
// Idempotency: a second run matches the same selector but changes nothing, so no new deltas
let history_after_first = session.history().count();
let revs = runner.run_content_migrations(&mut session, &mut NoHost).unwrap();
assert!(revs.is_empty());
assert_eq!(session.history().count(), history_after_first);
}