Add graph-storage crate (#4198)

* Add graph-storage crate

* Split graph-storage lib.rs into smaller modules

* Make graph_craft/core_types dependency optional

* Fix CRDT correctness issues flagged in graph-storage PR review

* Treat trailing empty export slots as value-equal in Network::value_equal

* Address graph-storage review: parameterize CrdtError, reject hot-log corruption, drop LamportClock Default

* Address graph-storage review: fix root-delta history walk, validate cross-network refs, make compute_deltas deterministic, harden Priority, index nodes by network

* Address graph-storage review: sort sources on deserialize, treat inputs_attributes length as structural, dedupe demo-artwork loader

* Add opt-in Delta rev validation, dedup resource sources on deserialize, fix doc grammar

* Persist scope injections through storage; harden gesture-end and embedded-source checks

* Review

* Review

* Review

* Use new types for NodeId and NetworkId

* Adress minor review comments

---------

Co-authored-by: Timon <me@timon.zip>
This commit is contained in:
Dennis Kobert
2026-06-13 16:47:04 +00:00
committed by GitHub
co-authored by Timon
parent cde8dd78e6
commit b56af15e5e
20 changed files with 5261 additions and 0 deletions
+793
View File
@@ -0,0 +1,793 @@
use core_types::uuid::NodeId as RuntimeNodeId;
use graph_craft::ProtoNodeIdentifier;
use graph_craft::concrete;
use graph_craft::document::{DocumentNode, DocumentNodeImplementation, NodeInput, NodeNetwork};
use crate::InputSlot;
use crate::{Delta, Document, HotOp, Network, NetworkId, NoMetadata, Node, NodeId, PeerId, ROOT_NETWORK, RegistryDelta, RegistryTarget, Session, TimeStamp};
fn fresh_document(peer: PeerId) -> Document {
Session::with_peer(peer).document
}
fn remove_node_op(node_id: NodeId) -> RegistryDelta {
// The snapshot only matters for reverse computation; this op is used to test a no-op removal on an
// absent node, so a placeholder node is fine.
let snapshot = Node::dummy();
RegistryDelta::RemoveNode { id: node_id, snapshot }
}
/// Commit a single op to a document as a retired delta. Mints a fresh timestamp, links to
/// current head, applies, records in history, advances head.
fn commit_op(document: &mut Document, op: RegistryDelta) {
let reverse = document.compute_reverse_delta(RegistryTarget::Working, &op).expect("compute_reverse_delta failed");
let timestamp = document.clock.tick();
let parents = if document.head == 0 { Vec::new() } else { vec![document.head] };
let delta = Delta::new(parents, document.peer, timestamp, op, reverse);
let rev = delta.id;
document.apply_delta(delta).expect("apply_retired_delta failed");
document.head = rev;
}
/// Every applied op must advance the local clock past the op's timestamp, so any subsequent
/// local tick is causally later than what we just observed. Locks in the invariant that
/// `apply_op` calls `clock.observe`, regardless of which apply entry point was used.
#[test]
fn apply_hot_op_advances_clock_past_observed_timestamp() {
let mut document = fresh_document(PeerId(1));
assert_eq!(document.clock.counter, 0);
let observed = TimeStamp { counter: 42, peer: PeerId(2) };
let hot_op = HotOp {
op: remove_node_op(NodeId(99)),
timestamp: observed,
};
document.apply_hot_op(hot_op).expect("RemoveNode on absent node is a no-op, not an error");
assert!(
document.clock.counter >= observed.counter,
"clock counter {} did not advance past observed counter {}",
document.clock.counter,
observed.counter
);
let next = document.clock.tick();
assert!(
next.counter > observed.counter,
"next tick {} must be strictly later than the observed timestamp {}",
next.counter,
observed.counter
);
}
/// `next_node_id` must never repeat across successive calls on the same document. The blake3 output
/// space is enormous, so any collision in a small loop is a counter-bumping bug, not a hash
/// collision.
#[test]
fn next_node_id_is_unique_within_a_document() {
let mut document = fresh_document(PeerId(1));
let mut seen = std::collections::HashSet::new();
for _ in 0..1000 {
let id = document.next_node_id();
assert!(seen.insert(id), "next_node_id repeated after {} calls", seen.len());
}
}
/// Two peers reading the same shared counter must produce different `NodeId`s. This is the whole
/// reason the counter can be shared across peers instead of being per-peer.
#[test]
fn next_node_id_differs_across_peers_at_same_counter() {
let mut document_a = fresh_document(PeerId(1));
let mut document_b = fresh_document(PeerId(2));
let id_a = document_a.next_node_id();
let id_b = document_b.next_node_id();
assert_ne!(id_a, id_b, "peer-scoping is broken: two peers minted the same NodeId at counter 1");
}
fn tiny_network() -> NodeNetwork {
NodeNetwork {
exports: vec![NodeInput::node(RuntimeNodeId(0), 0)],
nodes: [(
RuntimeNodeId(0),
DocumentNode {
inputs: vec![NodeInput::import(concrete!(u32), 0)],
implementation: DocumentNodeImplementation::ProtoNode(ProtoNodeIdentifier::new("graphene_core::ops::identity::IdentityNode")),
..Default::default()
},
)]
.into_iter()
.collect(),
..Default::default()
}
}
/// `verify_history` passes on a normally built history and flags a delta whose content-addressed
/// `id` no longer matches its identity fields (corrupt or crafted history).
#[test]
fn verify_history_detects_rev_mismatch() {
let resources = graphene_resource::ResourceRegistry::new();
let mut session = Session::with_peer(PeerId(1));
session.stage_from_runtime(&tiny_network(), &NoMetadata, &resources).expect("stage failed");
let last_timestamp = session.hot_log().last().expect("staged a hot op").timestamp;
session.retire(last_timestamp).expect("retire failed");
session.verify_history().expect("a freshly built history must validate");
// Tamper one delta's stored id (the field, not its key) so it no longer matches its content hash.
let some_rev = *session.document.history.keys().next().expect("history is non-empty");
session.document.history.get_mut(&some_rev).expect("delta exists").id = 0xdead_beef;
assert!(matches!(session.verify_history(), Err(crate::CrdtError::RevMismatch { .. })), "a tampered delta id must be flagged");
}
/// `history_topological` emits parents before children and is a pure function of the delta set:
/// two sessions independently built from the same network produce byte-identical history order.
#[test]
fn history_topological_is_causal_and_deterministic() {
let resources = graphene_resource::ResourceRegistry::new();
let build = || {
let mut session = Session::with_peer(PeerId(1));
session.stage_from_runtime(&tiny_network(), &NoMetadata, &resources).expect("stage failed");
let last_timestamp = session.hot_log().last().expect("staged at least one hot op").timestamp;
session.retire(last_timestamp).expect("retire failed");
session
};
let session_a = build();
let session_b = build();
let order_a: Vec<crate::Rev> = session_a.history_topological().iter().map(|delta| delta.id).collect();
let order_b: Vec<crate::Rev> = session_b.history_topological().iter().map(|delta| delta.id).collect();
assert!(order_a.len() > 1, "expected a multi-delta history to make ordering meaningful");
assert_eq!(order_a, order_b, "same delta set must serialize in the same topological order");
// Every parent that's part of this history precedes its child.
let position: std::collections::HashMap<crate::Rev, usize> = order_a.iter().enumerate().map(|(i, rev)| (*rev, i)).collect();
for delta in session_a.history_topological() {
for parent in &delta.parents {
if let Some(parent_pos) = position.get(parent) {
assert!(*parent_pos < position[&delta.id], "parent {parent} must precede child {} in topological order", delta.id);
}
}
}
}
/// Committing the same NodeNetwork twice must produce zero history entries on the second commit.
/// Without value-only diffing in compute_deltas, the second commit would emit spurious
/// ChangeNodeInput / ChangeNodeAttribute ops because self.registry has real timestamps while the
/// freshly-built `to` registry has TimeStamp::ORIGIN.
#[test]
fn stage_from_runtime_is_idempotent_for_unchanged_network() {
let mut session = Session::with_peer(PeerId(1));
let network = tiny_network();
let resources = graphene_resource::ResourceRegistry::new();
let (first, _) = session.stage_from_runtime(&network, &NoMetadata, &resources).expect("first stage failed");
assert!(!first.is_empty(), "first stage should produce at least one hot op for the initial network");
let (second, _) = session.stage_from_runtime(&network, &NoMetadata, &resources).expect("second stage failed");
assert_eq!(second.len(), 0, "second stage of unchanged network produced {} spurious hot ops: {:?}", second.len(), second);
}
/// The peer's first contribution prepends a `RegisterPeer` op (establishing its `UserId` mapping);
/// later contributions don't re-register, and a no-op batch registers nothing.
#[test]
fn first_contribution_registers_the_peer() {
let mut session = Session::with_peer(PeerId(7));
let resources = graphene_resource::ResourceRegistry::new();
assert!(session.registry().peer_users.is_empty(), "no registration before any contribution");
let (first, _) = session.stage_from_runtime(&tiny_network(), &NoMetadata, &resources).expect("first stage failed");
let registrations = first.iter().filter(|hot_op| matches!(hot_op.op, RegistryDelta::RegisterPeer { .. })).count();
assert_eq!(registrations, 1, "exactly one RegisterPeer on first contribution");
assert!(matches!(first[0].op, RegistryDelta::RegisterPeer { .. }), "RegisterPeer must precede the edit ops");
assert_eq!(session.registry().peer_users.get(&PeerId(7)), Some(&crate::UserId(7)), "peer mapped to its UserId");
// A second, distinct contribution must not re-register.
let mut other_network = tiny_network();
other_network.exports.clear();
let (second, _) = session.stage_from_runtime(&other_network, &NoMetadata, &resources).expect("second stage failed");
assert!(
!second.iter().any(|hot_op| matches!(hot_op.op, RegistryDelta::RegisterPeer { .. })),
"already-registered peer must not re-register"
);
// A no-op batch (re-staging an already-converged network) registers nothing on a fresh peer:
// registration rides a real edit, never a lone op.
let mut fresh = Session::with_peer(PeerId(8));
fresh.stage_from_runtime(&tiny_network(), &NoMetadata, &resources).expect("seed stage failed");
let peers_before = fresh.registry().peer_users.clone();
let (empty, _) = fresh.stage_from_runtime(&tiny_network(), &NoMetadata, &resources).expect("no-op stage failed");
assert!(empty.is_empty(), "an unchanged re-stage must produce no hot ops");
assert_eq!(fresh.registry().peer_users, peers_before, "a no-op batch must not add a registration");
}
/// A SetExport against a removed network must restore the network from history rather than error.
#[test]
fn set_export_resurrects_absent_network() {
let mut document = fresh_document(PeerId(1));
let network_id = NetworkId(7);
commit_op(
&mut document,
RegistryDelta::AddNetwork {
id: network_id,
network: Network::default(),
},
);
commit_op(
&mut document,
RegistryDelta::RemoveNetwork {
id: network_id,
snapshot: Network::default(),
},
);
assert!(!document.working_registry.networks.contains_key(&network_id), "network should be removed before the resurrection test");
commit_op(
&mut document,
RegistryDelta::SetNetworkExport {
id: network_id,
index: 0,
export: None,
},
);
assert!(document.working_registry.networks.contains_key(&network_id), "SetExport should have resurrected the network");
}
/// Cascading resurrection: bringing a node back must also restore its owning network when absent.
#[test]
fn add_node_resurrects_owning_network() {
use crate::Node;
let mut document = fresh_document(PeerId(1));
let network_id = NetworkId(7);
let node_id = NodeId(42);
commit_op(
&mut document,
RegistryDelta::AddNetwork {
id: network_id,
network: Network::default(),
},
);
commit_op(
&mut document,
RegistryDelta::RemoveNetwork {
id: network_id,
snapshot: Network::default(),
},
);
let node = Node { network: network_id, ..Node::dummy() };
commit_op(&mut document, RegistryDelta::AddNode { id: node_id, node });
assert!(
document.working_registry.networks.contains_key(&network_id),
"AddNode should have cascaded a resurrection of the owning network"
);
assert!(document.working_registry.node_instances.contains_key(&node_id), "the node itself should also be present");
}
/// Reverting the same removal twice (the moral equivalent of two peers concurrently resurrecting
/// the same node) must not error on the second apply. Today the second revert hits
/// `apply_op(AddNode, false)` against a present node and returns `NodeAlreadyExists`.
#[test]
fn concurrent_resurrection_via_revert_is_idempotent() {
use crate::Node;
let mut document = fresh_document(PeerId(1));
let network_id = NetworkId(7);
let node_id = NodeId(42);
commit_op(
&mut document,
RegistryDelta::AddNetwork {
id: network_id,
network: Network::default(),
},
);
let node = Node { network: network_id, ..Node::dummy() };
commit_op(&mut document, RegistryDelta::AddNode { id: node_id, node: node.clone() });
commit_op(&mut document, RegistryDelta::RemoveNode { id: node_id, snapshot: node });
assert!(!document.working_registry.node_instances.contains_key(&node_id), "node should be removed before the resurrection test");
document.restore_node_from_history(RegistryTarget::Working, node_id).expect("first resurrection should succeed");
assert!(document.working_registry.node_instances.contains_key(&node_id), "first resurrection should bring the node back");
let second = document.restore_node_from_history(RegistryTarget::Working, node_id);
assert!(second.is_ok(), "second resurrection of an already-present node should be a no-op, got {second:?}");
}
/// History-based resurrection must work when the matching delta is the *root* commit. The history
/// walk used to drop the root (its empty parent list short-circuited the iterator before yielding
/// it), so a node removed by the very first commit could not be restored.
#[test]
fn restore_node_from_root_commit() {
use crate::Node;
let mut document = fresh_document(PeerId(1));
let node_id = NodeId(42);
let node = Node::dummy();
// Seed the working state so the root commit can remove the node (its reverse is the `AddNode` the
// resurrection looks for). This `RemoveNode` is the only commit, so the match sits at the root.
document.working_registry.networks.insert(ROOT_NETWORK, Network::default());
document.retired_snapshot.networks.insert(ROOT_NETWORK, Network::default());
document.working_registry.node_instances.insert(node_id, node.clone());
document.retired_snapshot.node_instances.insert(node_id, node.clone());
commit_op(&mut document, RegistryDelta::RemoveNode { id: node_id, snapshot: node });
assert!(!document.working_registry.node_instances.contains_key(&node_id), "node should be removed by the root commit");
document
.restore_node_from_history(RegistryTarget::Working, node_id)
.expect("resurrection from the root commit should succeed");
assert!(document.working_registry.node_instances.contains_key(&node_id), "node must be restored from the root commit");
}
/// Erroring ops still bump the clock: we observed the timestamp on the wire, the fact that the
/// op was rejected locally doesn't unobserve it.
#[test]
fn apply_op_advances_clock_even_when_op_errors() {
let mut document = fresh_document(PeerId(1));
let observed = TimeStamp { counter: 17, peer: PeerId(2) };
let failing_op = RegistryDelta::ChangeNodeInput {
id: NodeId(7),
index: 0,
new_input: crate::NodeInput::Import { index: 0 },
};
let result = document.apply_op(failing_op, observed);
assert!(result.is_err(), "op targeting a nonexistent node should be rejected");
assert!(document.clock.counter >= observed.counter, "clock should advance on observation even when the op errors");
}
// --- Resource CRDT semantics ---
use crate::{Priority, RegistryDelta as RD, ResourceHash, ResourceId, SourceKey};
fn source_key(priority: f64, peer: u64) -> SourceKey {
SourceKey {
priority: Priority::new(priority).expect("test priorities are finite"),
peer: PeerId(peer),
}
}
fn ts(counter: u64, peer: u64) -> TimeStamp {
TimeStamp { counter, peer: PeerId(peer) }
}
/// Two peers concurrently add a source to the same resource at distinct priorities. Both survive
/// (add-wins union), ordered by priority.
#[test]
fn concurrent_source_adds_at_distinct_priorities_both_survive() {
let mut document = fresh_document(PeerId(1));
let id = ResourceId::new();
document
.apply_op(
RD::AddSource {
id,
key: source_key(0.5, 1),
source: serde_json::json!("embedded"),
},
ts(1, 1),
)
.unwrap();
document
.apply_op(
RD::AddSource {
id,
key: source_key(0.75, 2),
source: serde_json::json!("url"),
},
ts(1, 2),
)
.unwrap();
let entry = document.working_registry.resources.get(&id).expect("resource entry exists");
assert_eq!(entry.sources.len(), 2, "both concurrent additions survive");
// The chain iterates in priority order.
let bodies: Vec<_> = entry.sources.iter().map(|(_, v)| v.source.clone()).collect();
assert_eq!(bodies, vec![serde_json::json!("embedded"), serde_json::json!("url")]);
}
/// Re-adding the same source key is LWW on its timestamp: a later write wins, an earlier one is ignored.
#[test]
fn same_source_key_is_last_writer_wins() {
let mut document = fresh_document(PeerId(1));
let id = ResourceId::new();
let key = source_key(0.5, 1);
document
.apply_op(
RD::AddSource {
id,
key,
source: serde_json::json!("old"),
},
ts(5, 1),
)
.unwrap();
// Earlier timestamp: ignored.
document
.apply_op(
RD::AddSource {
id,
key,
source: serde_json::json!("stale"),
},
ts(2, 1),
)
.unwrap();
// Later timestamp: wins.
document
.apply_op(
RD::AddSource {
id,
key,
source: serde_json::json!("new"),
},
ts(9, 1),
)
.unwrap();
let entry = document.working_registry.resources.get(&id).unwrap();
assert_eq!(entry.source(&key).unwrap().source, serde_json::json!("new"));
}
/// SetResourceHash is LWW on the hash; a later resolve wins, an earlier one is ignored.
#[test]
fn register_resource_hash_is_last_writer_wins() {
let mut document = fresh_document(PeerId(1));
let id = ResourceId::new();
let hash_a = ResourceHash::from(&b"alpha"[..]);
let hash_b = ResourceHash::from(&b"beta"[..]);
document.apply_op(RD::SetResourceHash { id, hash: Some(hash_a) }, ts(5, 1)).unwrap();
document.apply_op(RD::SetResourceHash { id, hash: Some(hash_b) }, ts(2, 1)).unwrap();
assert_eq!(document.working_registry.resources.get(&id).unwrap().hash, Some(hash_a), "earlier resolve must not clobber later one");
document.apply_op(RD::SetResourceHash { id, hash: Some(hash_b) }, ts(9, 1)).unwrap();
assert_eq!(document.working_registry.resources.get(&id).unwrap().hash, Some(hash_b), "later resolve wins");
}
/// The reverse delta of a RemoveSource restores the prior source body, and applying op-then-reverse
/// round-trips the source chain.
#[test]
fn remove_source_reverse_restores_prior() {
let mut document = fresh_document(PeerId(1));
let id = ResourceId::new();
let key = source_key(0.5, 1);
commit_op(
&mut document,
RD::AddSource {
id,
key,
source: serde_json::json!("kept"),
},
);
// Compute the reverse while the body is still present, then apply the removal.
let reverse = document.compute_reverse_delta(RegistryTarget::Working, &RD::RemoveSource { id, key }).unwrap();
match &reverse {
RD::AddSource { source, .. } => assert_eq!(*source, serde_json::json!("kept"), "reverse of removal re-adds the body"),
other => panic!("expected AddSource reverse, got {other:?}"),
}
document.apply_op(RD::RemoveSource { id, key }, ts(5, 1)).unwrap();
assert!(document.working_registry.resources.get(&id).unwrap().sources.is_empty(), "source removed");
// Applying the reverse restores the chain.
document.apply_op(reverse, ts(6, 1)).unwrap();
assert_eq!(document.working_registry.resources.get(&id).unwrap().source(&key).unwrap().source, serde_json::json!("kept"));
}
/// AddSource on a fresh slot reverses to a RemoveSource; on an occupied slot it restores the prior body.
#[test]
fn add_source_reverse_depends_on_prior_state() {
let mut document = fresh_document(PeerId(1));
let id = ResourceId::new();
let key = source_key(0.5, 1);
// Fresh slot: reverse removes.
let reverse_fresh = document
.compute_reverse_delta(
RegistryTarget::Working,
&RD::AddSource {
id,
key,
source: serde_json::json!("first"),
},
)
.unwrap();
assert!(matches!(reverse_fresh, RD::RemoveSource { .. }), "reverse of add-to-empty is remove, got {reverse_fresh:?}");
// Occupy the slot, then reverse of a new add restores the existing body.
document
.apply_op(
RD::AddSource {
id,
key,
source: serde_json::json!("existing"),
},
ts(1, 1),
)
.unwrap();
let reverse_overwrite = document
.compute_reverse_delta(
RegistryTarget::Working,
&RD::AddSource {
id,
key,
source: serde_json::json!("overwrite"),
},
)
.unwrap();
match reverse_overwrite {
RD::AddSource { source, .. } => assert_eq!(source, serde_json::json!("existing"), "reverse restores prior body"),
other => panic!("expected AddSource reverse, got {other:?}"),
}
}
// --- compute_deltas resource diffing ---
use crate::{ResourceEntry, ResourceStore, SourceValue};
fn entry_with_source(priority: f64, peer: u64, body: serde_json::Value, hash: Option<ResourceHash>) -> ResourceEntry {
ResourceEntry {
sources: vec![(source_key(priority, peer), SourceValue { source: body, timestamp: ts(1, peer) })],
hash,
hash_timestamp: ts(1, peer),
}
}
fn registry_with_resources(resources: ResourceStore) -> crate::Registry {
crate::Registry { resources, ..Default::default() }
}
/// An unchanged resource store produces zero deltas, even when timestamps differ (value-only diff).
#[test]
fn compute_deltas_ignores_unchanged_resources() {
let id = ResourceId::new();
let hash = ResourceHash::from(&b"img"[..]);
let mut from = ResourceStore::new();
from.insert(id, entry_with_source(0.0, 1, serde_json::json!("embedded"), Some(hash)));
// Same value, different timestamps: must not count as a change.
let mut to = ResourceStore::new();
let mut to_entry = entry_with_source(0.0, 1, serde_json::json!("embedded"), Some(hash));
to_entry.hash_timestamp = ts(99, 2);
to_entry.sources.iter_mut().for_each(|(_, v)| v.timestamp = ts(99, 2));
to.insert(id, to_entry);
let deltas = crate::delta::compute_deltas(&registry_with_resources(from), &registry_with_resources(to));
assert!(deltas.is_empty(), "unchanged resource (value-equal) produced deltas: {deltas:?}");
}
/// Adding, changing, and removing resources each produce the matching delta, and applying the diff
/// transforms `from` into a registry value-equal to `to`.
#[test]
fn compute_deltas_diffs_resources_and_round_trips() {
let kept = ResourceId::new();
let removed = ResourceId::new();
let added = ResourceId::new();
let hash_old = ResourceHash::from(&b"old"[..]);
let hash_new = ResourceHash::from(&b"new"[..]);
let mut from = ResourceStore::new();
from.insert(kept, entry_with_source(0.0, 1, serde_json::json!("embedded"), Some(hash_old)));
from.insert(removed, entry_with_source(0.0, 1, serde_json::json!("gone"), None));
let mut to = ResourceStore::new();
// `kept`: hash changes and a second source is added.
let mut kept_entry = entry_with_source(0.0, 1, serde_json::json!("embedded"), Some(hash_new));
kept_entry.set_source(
source_key(1.0, 1),
SourceValue {
source: serde_json::json!("url"),
timestamp: ts(1, 1),
},
);
to.insert(kept, kept_entry);
// `added`: brand new resource.
to.insert(added, entry_with_source(0.0, 1, serde_json::json!("fresh"), None));
let deltas = crate::delta::compute_deltas(&registry_with_resources(from.clone()), &registry_with_resources(to.clone()));
// A brand-new resource is a single whole-entry AddResource, never a fan-out of per-source ops.
let added_deltas: Vec<_> = deltas.iter().filter(|d| matches!(d, RD::AddResource { id, .. } if *id == added)).collect();
assert_eq!(added_deltas.len(), 1, "adding a resource should produce exactly one AddResource delta, got {added_deltas:?}");
assert!(
!deltas.iter().any(|d| matches!(d, RD::AddSource { id, .. } | RD::SetResourceHash { id, .. } if *id == added)),
"a brand-new resource must not emit per-source or hash ops"
);
// The removed resource is a single whole-entry RemoveResource.
assert_eq!(
deltas.iter().filter(|d| matches!(d, RD::RemoveResource { id, .. } if *id == removed)).count(),
1,
"removing a resource should produce exactly one RemoveResource delta"
);
// Apply the diff to a document seeded with `from`, then check it matches `to` by value.
let mut document = fresh_document(PeerId(1));
document.working_registry = registry_with_resources(from);
for op in deltas {
let timestamp = document.clock.tick();
document.apply_op(op, timestamp).expect("apply resource delta");
}
assert!(
document.working_registry.value_equal(&registry_with_resources(to)),
"applying the resource diff did not reproduce the target registry"
);
}
/// Resource GC must keep an undone interaction's resources alive: undo removes a interaction's `AddResource`
/// from the working registry, but redo still needs those bytes. `all_referenced_resource_hashes` must
/// therefore report history-referenced resources even after they leave the current registry, so the
/// editor's GC "used" set doesn't evict them between an undo and a redo.
#[test]
fn all_referenced_resource_hashes_survives_undo() {
use crate::ResourceId;
let mut session = Session::with_peer(PeerId(1));
let resources = graphene_resource::ResourceRegistry::new();
// Base interaction: the first interaction is intentionally not undoable (the mount-base floor), so commit a
// network first. Undoing the later resource interaction then lands on this base rather than the root.
session.stage_from_runtime(&tiny_network(), &NoMetadata, &resources).expect("stage base");
let base_up_to = session.hot_log().last().expect("staged base").timestamp;
let base_revs = session.retire(base_up_to).expect("retire base");
session.mark_interaction_end(*base_revs.last().expect("one base delta"));
// Second interaction: add a resource and mark the retired delta as a interaction boundary.
let hash = ResourceHash::from(&b"declaration-bytes"[..]);
let id = ResourceId::new();
let hot_ops = session.stage_embedded_resource(id, hash).expect("stage resource");
let up_to = hot_ops.last().expect("staged one op").timestamp;
let revs = session.retire(up_to).expect("retire");
session.mark_interaction_end(*revs.last().expect("one retired delta"));
assert!(session.registry().resources.contains_key(&id), "resource is present after the interaction");
assert!(session.all_referenced_resource_hashes().contains(&hash));
// Undo the interaction: the resource leaves the working registry but stays in history.
session.undo().expect("undo");
assert!(!session.registry().resources.contains_key(&id), "undo drops the resource from the working registry");
assert!(
session.all_referenced_resource_hashes().contains(&hash),
"the undone interaction's resource must still be reported so GC keeps its bytes for redo"
);
}
/// A commit that produces no deltas must not touch the redo stack. Redo is only abandoned by a real
/// new edit; a no-op commit (here `embed_resource_sources` over an empty id set) leaving it cleared
/// would silently disable redo after an undo.
#[test]
fn no_op_commit_preserves_redo_stack() {
let mut session = Session::with_peer(PeerId(1));
let resources = graphene_resource::ResourceRegistry::new();
// Base interaction (the non-undoable mount floor), then a second interaction to undo onto it.
session.stage_from_runtime(&tiny_network(), &NoMetadata, &resources).expect("stage base");
let base_up_to = session.hot_log().last().expect("staged base").timestamp;
let base_revs = session.retire(base_up_to).expect("retire base");
session.mark_interaction_end(*base_revs.last().expect("one base delta"));
let hash = ResourceHash::from(&b"declaration-bytes"[..]);
let id = ResourceId::new();
let hot_ops = session.stage_embedded_resource(id, hash).expect("stage resource");
let up_to = hot_ops.last().expect("staged one op").timestamp;
let revs = session.retire(up_to).expect("retire");
session.mark_interaction_end(*revs.last().expect("one retired delta"));
session.undo().expect("undo");
assert!(session.can_redo(), "undo must populate the redo stack");
// A commit over no resources produces no deltas; redo must survive it.
session.embed_resource_sources(std::iter::empty::<ResourceId>()).expect("no-op embed");
assert!(session.can_redo(), "a no-op commit must not clear the redo stack");
}
/// `embed_resource_sources` overwrites the working registry with the snapshot, valid only when no
/// unretired hot ops are present. Called with a non-empty hot log it must error rather than silently
/// drop the hot-zone edits.
#[test]
fn embed_resource_sources_rejects_unretired_hot_ops() {
let mut session = Session::with_peer(PeerId(1));
let resources = graphene_resource::ResourceRegistry::new();
// Stage without retiring, leaving hot ops in the log.
session.stage_from_runtime(&tiny_network(), &NoMetadata, &resources).expect("stage");
assert!(!session.hot_log().is_empty(), "staging should leave unretired hot ops");
let result = session.embed_resource_sources(std::iter::empty::<ResourceId>());
assert!(matches!(result, Err(crate::CrdtError::HotLogNotEmpty)), "expected HotLogNotEmpty, got {result:?}");
}
/// A delta's `Rev` is content-addressed, so two byte-equal deltas must hash identically regardless
/// of the order their attributes were inserted. This guards the `Attributes` map staying canonically
/// ordered (`BTreeMap`): a hash-randomized map would give the same logical delta different `Rev`s.
#[test]
fn add_node_rev_is_independent_of_attribute_insertion_order() {
use crate::{AttributesWrite, Implementation, Value};
let keys = ["ui::position", "ui::display_name", "ui::locked", "ui::pinned", "call_argument", "context_features"];
// Fixed implementation so the two nodes differ only in attribute insertion order.
let implementation = Implementation::ProtoNode(ResourceId::new());
let make_node = |insertion_order: &[&str]| {
let mut attributes = crate::Attributes::new();
for &key in insertion_order {
attributes.set(key, serde_json::json!(key), TimeStamp::ORIGIN);
}
let mut input_attributes = crate::Attributes::new();
for &key in insertion_order {
input_attributes.insert(key.to_string(), Value::new(serde_json::json!(key), TimeStamp::ORIGIN));
}
let inputs = vec![InputSlot {
input: crate::NodeInput::Import { index: 0 },
timestamp: TimeStamp::ORIGIN,
attributes: input_attributes,
}];
Node {
implementation: implementation.clone(),
inputs,
attributes,
network: ROOT_NETWORK,
}
};
let forward: Vec<&str> = keys.to_vec();
let reversed: Vec<&str> = keys.iter().rev().copied().collect();
let parents = vec![1, 2];
let author = PeerId(7);
let timestamp = TimeStamp { counter: 42, peer: PeerId(7) };
let delta_forward = Delta::new(
parents.clone(),
author,
timestamp,
RegistryDelta::AddNode {
id: NodeId(9),
node: make_node(&forward),
},
RegistryDelta::AddNode {
id: NodeId(9),
node: make_node(&forward),
},
);
let delta_reversed = Delta::new(
parents,
author,
timestamp,
RegistryDelta::AddNode {
id: NodeId(9),
node: make_node(&reversed),
},
RegistryDelta::AddNode {
id: NodeId(9),
node: make_node(&reversed),
},
);
assert_eq!(delta_forward.id, delta_reversed.id, "Rev must not depend on attribute insertion order");
}
@@ -0,0 +1,781 @@
use std::borrow::Cow;
use std::collections::HashMap;
use core_types::context::ContextDependencies;
use core_types::uuid::NodeId;
use graph_craft::document::{DocumentNode, DocumentNodeImplementation, NodeInput, NodeNetwork};
use graph_craft::graphene_compiler::Compiler;
use graph_craft::{ProtoNodeIdentifier, Type, concrete};
use crate::{NetworkId, NodeMetadataSource, PeerId, Position, Registry};
/// Helper function to verify a NodeNetwork can be compiled successfully.
/// Note: This only works for complete networks with all inputs resolved.
/// Test networks with Import inputs will fail compilation (which is expected).
fn verify_network_compiles(network: &NodeNetwork) -> Result<(), String> {
let compiler = Compiler {};
compiler.compile_single(network.clone()).map_err(|e| format!("Compilation failed: {:?}", e))?;
Ok(())
}
/// Convert a runtime network to a storage `Registry`, returning the declarations alongside it.
/// Proto-node declaration content is no longer stored in the registry (it lives in a byte store);
/// these tests have no byte store, so they keep the extracted bytes in hand and rebuild a
/// `Declarations` map for the back-conversion.
fn to_registry(network: &NodeNetwork) -> (Registry, crate::Declarations) {
let conversion = Registry::convert_from_runtime(network, &crate::NoMetadata, &Default::default(), PeerId(0)).expect("Failed to convert NodeNetwork to Registry");
let declarations = conversion.declarations().expect("rebuild declarations");
(conversion.registry, declarations)
}
/// A one-node network whose single node references `id` via a `TaggedValue::Resource` input, so
/// `convert_resources` (which only snapshots network-referenced resources) carries the resource.
fn network_referencing_resource(id: graphene_resource::ResourceId) -> NodeNetwork {
network_referencing_resources(&[id])
}
/// A network with one node per resource, each referencing its resource via a `TaggedValue::Resource`
/// input, so all listed resources are network-referenced and survive conversion.
fn network_referencing_resources(ids: &[graphene_resource::ResourceId]) -> NodeNetwork {
use graph_craft::document::value::TaggedValue;
let nodes = ids
.iter()
.enumerate()
.map(|(i, id)| {
(
NodeId(i as u64),
DocumentNode {
inputs: vec![NodeInput::value(TaggedValue::Resource(*id), false)],
implementation: DocumentNodeImplementation::ProtoNode(ProtoNodeIdentifier::new("graphene_core::ops::identity::IdentityNode")),
..Default::default()
},
)
})
.collect();
NodeNetwork { nodes, ..Default::default() }
}
fn create_simple_network() -> NodeNetwork {
NodeNetwork {
exports: vec![NodeInput::node(NodeId(1), 0)],
nodes: [
(
NodeId(0),
DocumentNode {
inputs: vec![NodeInput::import(concrete!(u32), 0), NodeInput::import(concrete!(u32), 1)],
implementation: DocumentNodeImplementation::ProtoNode(ProtoNodeIdentifier::new("graphene_core::structural::ConsNode")),
..Default::default()
},
),
(
NodeId(1),
DocumentNode {
inputs: vec![NodeInput::node(NodeId(0), 0)],
implementation: DocumentNodeImplementation::ProtoNode(ProtoNodeIdentifier::new("graphene_core::ops::AddPairNode")),
..Default::default()
},
),
]
.into_iter()
.collect(),
..Default::default()
}
}
/// Creates a network with a nested sub-network
fn create_nested_network() -> NodeNetwork {
// Create a simple inner network
let inner_network = NodeNetwork {
exports: vec![NodeInput::node(NodeId(10), 0)],
nodes: [(
NodeId(10),
DocumentNode {
inputs: vec![NodeInput::import(concrete!(u32), 0)],
implementation: DocumentNodeImplementation::ProtoNode(ProtoNodeIdentifier::new("graphene_core::ops::identity::IdentityNode")),
..Default::default()
},
)]
.into_iter()
.collect(),
..Default::default()
};
// Create outer network that uses the inner network
NodeNetwork {
exports: vec![NodeInput::node(NodeId(1), 0)],
nodes: [
(
NodeId(0),
DocumentNode {
inputs: vec![NodeInput::import(concrete!(u32), 0)],
implementation: DocumentNodeImplementation::Network(inner_network),
..Default::default()
},
),
(
NodeId(1),
DocumentNode {
inputs: vec![NodeInput::node(NodeId(0), 0)],
implementation: DocumentNodeImplementation::ProtoNode(ProtoNodeIdentifier::new("graphene_core::ops::identity::IdentityNode")),
..Default::default()
},
),
]
.into_iter()
.collect(),
..Default::default()
}
}
#[test]
fn test_simple_round_trip() {
let original_network = create_simple_network();
// Convert to Registry
let (registry, declarations) = to_registry(&original_network);
// Convert back to NodeNetwork
let (converted_network, _) = registry.to_runtime_with_metadata(&declarations).expect("Failed to convert Registry back to NodeNetwork");
// Verify structure is preserved
assert_eq!(converted_network.nodes.len(), original_network.nodes.len(), "Node count should be preserved");
assert_eq!(converted_network.exports.len(), original_network.exports.len(), "Export count should be preserved");
// Verify exports reference the correct nodes
match (&original_network.exports[0], &converted_network.exports[0]) {
(
NodeInput::Node {
node_id: orig_id,
output_index: orig_idx,
},
NodeInput::Node {
node_id: conv_id,
output_index: conv_idx,
},
) => {
assert_eq!(orig_id, conv_id, "Export should reference the same node");
assert_eq!(orig_idx, conv_idx, "Export output index should match");
}
_ => panic!("Exports should both be Node inputs"),
}
// Verify node implementations are preserved
for (node_id, orig_node) in &original_network.nodes {
let conv_node = converted_network.nodes.get(node_id).expect("Node should exist after round-trip");
match (&orig_node.implementation, &conv_node.implementation) {
(DocumentNodeImplementation::ProtoNode(orig_ident), DocumentNodeImplementation::ProtoNode(conv_ident)) => {
assert_eq!(orig_ident.as_str(), conv_ident.as_str(), "ProtoNode identifier should be preserved");
}
_ => panic!("Implementation type should be preserved"),
}
// Verify input count is preserved
assert_eq!(conv_node.inputs.len(), orig_node.inputs.len(), "Input count should be preserved");
}
}
#[test]
fn test_nested_network_round_trip() {
let original_network = create_nested_network();
// Convert to Registry
let (registry, declarations) = to_registry(&original_network);
// Convert back to NodeNetwork
let (converted_network, _) = registry.to_runtime_with_metadata(&declarations).expect("Failed to convert Registry back to NodeNetwork");
// Verify structure is preserved
assert_eq!(converted_network.nodes.len(), original_network.nodes.len(), "Node count should be preserved");
// Find the node with nested network
let orig_nested_node = original_network.nodes.get(&NodeId(0)).expect("Node 0 should exist");
let conv_nested_node = converted_network.nodes.get(&NodeId(0)).expect("Node 0 should exist after round-trip");
// Verify nested network is preserved
match (&orig_nested_node.implementation, &conv_nested_node.implementation) {
(DocumentNodeImplementation::Network(orig_inner), DocumentNodeImplementation::Network(conv_inner)) => {
assert_eq!(orig_inner.nodes.len(), conv_inner.nodes.len(), "Inner network node count should be preserved");
assert_eq!(orig_inner.exports.len(), conv_inner.exports.len(), "Inner network export count should be preserved");
}
_ => panic!("Nested network should be preserved"),
}
}
#[test]
fn test_registry_structure() {
let network = create_simple_network();
let (registry, _declarations) = to_registry(&network);
assert!(registry.resources.len() >= 2, "Should have proto-node declaration resources");
assert!(!registry.networks.is_empty(), "Should have at least one network");
let root_network = registry.networks.get(&crate::ROOT_NETWORK).expect("Root network should exist");
assert_eq!(root_network.exports.len(), network.exports.len(), "Export count should match");
// Exports are first-class slots, no synthetic identity nodes in node_instances.
for slot in &root_network.exports {
assert!(slot.target.is_some(), "Round-tripped exports should have a target");
}
}
#[test]
fn test_nested_network_flattening() {
let network = create_nested_network();
let registry = Registry::try_from(&network).expect("Failed to convert to Registry");
// Outer network has 2 nodes, one of which contains a nested network with 1 node.
// No more identity-node padding, so node_instances has exactly the real nodes.
let expected_nodes = 3;
assert_eq!(
registry.node_instances.len(),
expected_nodes,
"Registry should have exactly {} nodes, found {}",
expected_nodes,
registry.node_instances.len()
);
// Two networks: root (ROOT_NETWORK) and nested (1).
assert!(registry.networks.len() >= 2, "Should have at least 2 networks (root + nested)");
}
#[test]
fn test_metadata_preservation() {
// Create a network with nodes that have non-default metadata
let context_features = ContextDependencies {
extract: core_types::context::ContextFeatures::FOOTPRINT | core_types::context::ContextFeatures::REAL_TIME,
..Default::default()
};
let network = NodeNetwork {
exports: vec![NodeInput::node(NodeId(1), 0)],
nodes: [
(
NodeId(0),
DocumentNode {
inputs: vec![NodeInput::import(concrete!(f64), 0), NodeInput::import(Type::Generic(Cow::Borrowed("T")), 1)],
implementation: DocumentNodeImplementation::ProtoNode(ProtoNodeIdentifier::new("test::NodeWithMetadata")),
call_argument: concrete!(String),
context_features,
visible: false, // Non-default value
skip_deduplication: true, // Non-default value
..Default::default()
},
),
(
NodeId(1),
DocumentNode {
inputs: vec![NodeInput::node(NodeId(0), 0)],
implementation: DocumentNodeImplementation::ProtoNode(ProtoNodeIdentifier::new("test::OutputNode")),
call_argument: concrete!((u32, u32)),
..Default::default()
},
),
]
.into_iter()
.collect(),
..Default::default()
};
// Convert to Registry and back
let (registry, declarations) = to_registry(&network);
let (converted, _) = registry.to_runtime_with_metadata(&declarations).expect("Failed to convert back to NodeNetwork");
// Verify call_argument is preserved
let orig_node_0 = network.nodes.get(&NodeId(0)).unwrap();
let conv_node_0 = converted.nodes.get(&NodeId(0)).unwrap();
assert_eq!(orig_node_0.call_argument, conv_node_0.call_argument, "call_argument for node 0 should be preserved");
let orig_node_1 = network.nodes.get(&NodeId(1)).unwrap();
let conv_node_1 = converted.nodes.get(&NodeId(1)).unwrap();
assert_eq!(orig_node_1.call_argument, conv_node_1.call_argument, "call_argument for node 1 should be preserved");
// Verify context_features is preserved
assert_eq!(orig_node_0.context_features, conv_node_0.context_features, "context_features should be preserved");
// Verify visible is preserved
assert_eq!(orig_node_0.visible, conv_node_0.visible, "visible should be preserved");
// Verify skip_deduplication is preserved
assert_eq!(orig_node_0.skip_deduplication, conv_node_0.skip_deduplication, "skip_deduplication should be preserved");
// Verify import_type is preserved for Import inputs
match (&orig_node_0.inputs[0], &conv_node_0.inputs[0]) {
(NodeInput::Import { import_type: orig_type, .. }, NodeInput::Import { import_type: conv_type, .. }) => {
assert_eq!(orig_type, conv_type, "import_type for first import should be preserved (f64)");
}
_ => panic!("First input should be Import"),
}
match (&orig_node_0.inputs[1], &conv_node_0.inputs[1]) {
(NodeInput::Import { import_type: orig_type, .. }, NodeInput::Import { import_type: conv_type, .. }) => {
assert_eq!(orig_type, conv_type, "import_type for second import should be preserved (generic T)");
}
_ => panic!("Second input should be Import"),
}
}
#[test]
fn test_demo_artwork_round_trip() {
use graph_craft::util::{DEMO_ART, load_from_name};
// Test each demo artwork
for artwork_name in DEMO_ART {
println!("Testing artwork: {}", artwork_name);
let original_network = load_from_name(artwork_name);
// Convert to Registry
let (registry, declarations) = to_registry(&original_network);
// Convert back to NodeNetwork
let (converted_network, _) = registry
.to_runtime_with_metadata(&declarations)
.unwrap_or_else(|e| panic!("Failed to convert {} back to NodeNetwork: {:?}", artwork_name, e));
// Basic structural checks
assert_eq!(original_network.nodes.len(), converted_network.nodes.len(), "{}: Node count should be preserved", artwork_name);
assert_eq!(original_network.exports.len(), converted_network.exports.len(), "{}: Export count should be preserved", artwork_name);
// Verify each node's metadata is preserved
for (node_id, orig_node) in &original_network.nodes {
let conv_node = converted_network
.nodes
.get(node_id)
.unwrap_or_else(|| panic!("{}: Node {:?} should exist after round-trip", artwork_name, node_id));
// Check metadata fields
assert_eq!(
orig_node.call_argument, conv_node.call_argument,
"{}: call_argument should be preserved for node {:?}",
artwork_name, node_id
);
assert_eq!(
orig_node.context_features, conv_node.context_features,
"{}: context_features should be preserved for node {:?}",
artwork_name, node_id
);
assert_eq!(orig_node.visible, conv_node.visible, "{}: visible should be preserved for node {:?}", artwork_name, node_id);
assert_eq!(
orig_node.skip_deduplication, conv_node.skip_deduplication,
"{}: skip_deduplication should be preserved for node {:?}",
artwork_name, node_id
);
// Check input count
assert_eq!(
orig_node.inputs.len(),
conv_node.inputs.len(),
"{}: Input count should be preserved for node {:?}",
artwork_name,
node_id
);
}
// Verify the converted demo artwork can be compiled (demo artworks are complete networks)
verify_network_compiles(&converted_network).unwrap_or_else(|e| panic!("{}: Converted artwork should compile successfully: {}", artwork_name, e));
println!("{} passed", artwork_name);
}
}
/// Per-node UI state used by the in-test metadata source. Keyed by `(network_path, local_id)`.
#[derive(Clone, Debug, Default, PartialEq)]
struct UiState {
position: Option<Position>,
is_layer: bool,
display_name: Option<String>,
locked: bool,
pinned: bool,
}
/// In-test `NodeMetadataSource` backed by a `HashMap` keyed on the full `(network_path, local_id)`
/// addressing the editor would use.
struct TestMetadata {
entries: HashMap<(Vec<NodeId>, NodeId), UiState>,
}
impl TestMetadata {
fn new() -> Self {
Self { entries: HashMap::new() }
}
fn insert(&mut self, network_path: &[NodeId], local_id: NodeId, state: UiState) {
self.entries.insert((network_path.to_vec(), local_id), state);
}
fn get(&self, network_path: &[NodeId], local_id: NodeId) -> Option<&UiState> {
self.entries.get(&(network_path.to_vec(), local_id))
}
}
impl NodeMetadataSource for TestMetadata {
fn position(&self, network_path: &[NodeId], local_id: NodeId) -> Option<Position> {
self.get(network_path, local_id).and_then(|s| s.position)
}
fn is_layer(&self, network_path: &[NodeId], local_id: NodeId) -> bool {
self.get(network_path, local_id).is_some_and(|s| s.is_layer)
}
fn display_name(&self, network_path: &[NodeId], local_id: NodeId) -> Option<&str> {
self.get(network_path, local_id).and_then(|s| s.display_name.as_deref())
}
fn locked(&self, network_path: &[NodeId], local_id: NodeId) -> bool {
self.get(network_path, local_id).is_some_and(|s| s.locked)
}
fn pinned(&self, network_path: &[NodeId], local_id: NodeId) -> bool {
self.get(network_path, local_id).is_some_and(|s| s.pinned)
}
}
/// Round-trips a nested network with editor metadata: layer + absolute position on one node,
/// node-in-chain on another, layer-in-stack inside a nested network. Asserts every entry comes
/// back unchanged and addressed by the correct `(network_path, local_id)`.
#[test]
fn test_ui_metadata_round_trip() {
let network = create_nested_network();
let mut metadata = TestMetadata::new();
// Root-network node 0 (the one with a nested network): a layer at an absolute position with
// a display name. Editor `network_path` for root-network nodes is empty.
metadata.insert(
&[],
NodeId(0),
UiState {
position: Some(Position::Absolute([3, 5])),
is_layer: true,
display_name: Some("Outer layer".into()),
locked: true,
pinned: false,
},
);
// Root-network node 1: a plain node in a chain.
metadata.insert(
&[],
NodeId(1),
UiState {
position: Some(Position::Chain),
..Default::default()
},
);
// Nested-network node 10 (lives under node 0): a layer in a stack.
metadata.insert(
&[NodeId(0)],
NodeId(10),
UiState {
position: Some(Position::Stack(7)),
is_layer: true,
..Default::default()
},
);
let conversion = Registry::convert_from_runtime(&network, &metadata, &Default::default(), PeerId(0)).expect("Failed to convert to Registry with metadata");
let declarations = conversion.declarations().expect("rebuild declarations");
let registry = conversion.registry;
let (converted, entries) = registry.to_runtime_with_metadata(&declarations).expect("Failed to convert Registry back with metadata");
// Graph structure still round-trips.
assert_eq!(converted.nodes.len(), network.nodes.len());
// Three entries — one per node we attached metadata to.
assert_eq!(entries.len(), 3, "expected 3 metadata entries, got {}: {entries:#?}", entries.len());
// Look entries back up by their address so we don't rely on emission order.
let lookup: HashMap<(Vec<NodeId>, NodeId), &crate::NodeMetadataEntry> = entries.iter().map(|e| ((e.network_path.clone(), e.local_id), e)).collect();
let root_layer = lookup.get(&(vec![], NodeId(0))).expect("entry for root-network layer node missing");
assert_eq!(root_layer.position, Some(Position::Absolute([3, 5])));
assert!(root_layer.is_layer);
assert_eq!(root_layer.display_name.as_deref(), Some("Outer layer"));
assert!(root_layer.locked);
assert!(!root_layer.pinned);
let root_node = lookup.get(&(vec![], NodeId(1))).expect("entry for root-network chain node missing");
assert_eq!(root_node.position, Some(Position::Chain));
assert!(!root_node.is_layer);
let nested_layer = lookup.get(&(vec![NodeId(0)], NodeId(10))).expect("entry for nested layer-in-stack missing");
assert_eq!(nested_layer.position, Some(Position::Stack(7)));
assert!(nested_layer.is_layer);
}
/// A runtime `ResourceRegistry` (source chain + resolved hash) survives conversion into the storage
/// `Registry`: source bodies are preserved in priority order and the hash carries through.
#[test]
fn resources_round_trip_through_from_runtime() {
use graphene_resource::{DataSource, ResourceHash, ResourceId, ResourceRegistry};
let mut resources = ResourceRegistry::new();
let id = ResourceId::new();
// Two sources in chain order: an embedded fallback then a URL.
resources.push_source_back(&id, DataSource::Embedded);
resources.push_source_back(&id, DataSource::Url("https://example.com/img.png".parse().unwrap()));
let hash = ResourceHash::from(&b"image bytes"[..]);
resources.resolve(&id, hash);
// The resource must be referenced by a node to be snapshotted: `convert_resources` only carries
// resources the network uses (orphans in the runtime cache, e.g. retained across undo, are dropped).
let network = network_referencing_resource(id);
let registry = Registry::from_runtime_with_metadata(&network, &crate::NoMetadata, &resources, PeerId(7)).expect("from_runtime failed");
let entry = registry.resources.get(&id).expect("resource entry present in storage registry");
assert_eq!(entry.hash, Some(hash), "resolved hash carried through");
assert_eq!(entry.sources.len(), 2, "both sources carried through");
// The chain iterates in priority order; decode bodies back to DataSource to compare.
let decoded: Vec<DataSource> = entry.sources.iter().map(|(_, v)| serde_json::from_value(v.source.clone()).expect("source body decodes")).collect();
assert_eq!(decoded, vec![DataSource::Embedded, DataSource::Url("https://example.com/img.png".parse().unwrap())]);
// All source keys carry the document peer.
assert!(entry.sources.iter().all(|(key, _)| key.peer == PeerId(7)), "source keys scoped to the document peer");
}
/// Full resource round-trip: a runtime `ResourceRegistry` converted into storage and back is equal
/// to the original (source chains in order, resolved hashes preserved).
#[test]
fn resource_registry_round_trips_runtime_to_storage_to_runtime() {
use graphene_resource::{DataSource, ResourceHash, ResourceId, ResourceRegistry};
let mut original = ResourceRegistry::new();
// A resolved resource with a two-entry fallback chain.
let image = ResourceId::new();
original.push_source_back(&image, DataSource::Embedded);
original.push_source_back(&image, DataSource::Url("https://example.com/img.png".parse().unwrap()));
original.resolve(&image, ResourceHash::from(&b"image bytes"[..]));
// An unresolved resource (sources but no hash yet).
let font = ResourceId::new();
original.push_source_back(
&font,
DataSource::Font {
family: "Inter".into(),
style: Some("Bold".into()),
},
);
// Both resources must be referenced by a node to be snapshotted (see `convert_resources`).
let network = network_referencing_resources(&[image, font]);
let registry = Registry::from_runtime_with_metadata(&network, &crate::NoMetadata, &original, PeerId(3)).expect("from_runtime failed");
let restored = registry.to_resource_registry().expect("to_resource_registry failed");
// Compare the two document resources specifically; the referencing nodes' proto-node declarations
// also become resources in the registry, so the restored set is a superset of `original`.
for id in [image, font] {
assert_eq!(
restored.info(&id).map(|info| info.sources),
original.info(&id).map(|info| info.sources),
"sources for {id:?} did not survive the round-trip"
);
assert_eq!(
restored.info(&id).and_then(|info| info.hash.copied()),
original.info(&id).and_then(|info| info.hash.copied()),
"resolved hash for {id:?} did not survive the round-trip"
);
}
}
/// A resource present in the runtime cache but not referenced by any node is *not* snapshotted into the
/// storage registry. This is the orphan case: undoing an image paste removes the node but the runtime
/// keeps the resource alive for redo, so a later diff must not see the orphan as a new `AddResource`
/// (which would resurface the undone paste as a phantom interaction). Regression guard for that divergence.
#[test]
fn unreferenced_runtime_resource_is_not_snapshotted() {
use graphene_resource::{DataSource, ResourceHash, ResourceId, ResourceRegistry};
let referenced = ResourceId::new();
let orphan = ResourceId::new();
let mut resources = ResourceRegistry::new();
for id in [referenced, orphan] {
resources.push_source_back(&id, DataSource::Embedded);
resources.resolve(&id, ResourceHash::from(&b"bytes"[..]));
}
// Only `referenced` is wired to a node; `orphan` lingers in the cache (as it would after an undo).
let network = network_referencing_resource(referenced);
let registry = Registry::from_runtime_with_metadata(&network, &crate::NoMetadata, &resources, PeerId(1)).expect("from_runtime failed");
assert!(registry.resources.contains_key(&referenced), "the network-referenced resource must be snapshotted");
assert!(!registry.resources.contains_key(&orphan), "the unreferenced (orphan) resource must not be snapshotted");
}
/// A node-input `TaggedValue::F64` must survive the storage round-trip bit-exact. Inputs are stored as a
/// self-describing `serde_json::Value` (encoded with the registry's MessagePack codec), so this guards
/// against any precision loss in the f64 -> serde_json::Number -> f64 path for a value with a full
/// 17-significant-digit mantissa.
#[test]
fn node_input_f64_round_trips_bit_exact() {
use graph_craft::document::value::TaggedValue;
// A value whose exact f64 bits matter: 1/3-ish with a non-terminating binary expansion.
let precise = 107.33334350585939_f64;
let network = NodeNetwork {
nodes: [(
NodeId(0),
DocumentNode {
inputs: vec![NodeInput::value(TaggedValue::F64(precise), false)],
implementation: DocumentNodeImplementation::ProtoNode(ProtoNodeIdentifier::new("graphene_core::ops::identity::IdentityNode")),
..Default::default()
},
)]
.into_iter()
.collect(),
..Default::default()
};
let (registry, declarations) = to_registry(&network);
let (converted, _) = registry.to_runtime_with_metadata(&declarations).expect("to_runtime");
let input = &converted.nodes.get(&NodeId(0)).expect("node 0").inputs[0];
let NodeInput::Value { tagged_value, .. } = input else {
panic!("expected a value input, got {input:?}")
};
let TaggedValue::F64(actual) = &**tagged_value else {
panic!("expected F64, got {:?}", tagged_value)
};
assert_eq!(actual.to_bits(), precise.to_bits(), "f64 node input drifted: {actual} != {precise}");
}
/// Two storage nodes in one network carrying the same `ORIGINAL_NODE_ID` both map to one runtime ID.
/// Conversion must reject this rather than silently collapse them and drop a node.
#[test]
fn duplicate_runtime_node_id_is_rejected() {
use crate::AttributesWrite;
use crate::TimeStamp;
use crate::to_runtime::ConversionError;
let (mut registry, declarations) = to_registry(&create_simple_network());
// Force both root-network nodes onto the same runtime ID.
for node in registry.node_instances.values_mut() {
node.attributes.set(crate::attr::node::ORIGINAL_NODE_ID, serde_json::json!(7), TimeStamp::ORIGIN);
}
let error = registry.to_runtime_with_metadata(&declarations).expect_err("duplicate runtime ID must error");
assert!(
matches!(error, ConversionError::DuplicateRuntimeNodeId { runtime_id: 7, .. }),
"expected DuplicateRuntimeNodeId, got {error:?}"
);
}
/// A node input referencing a node in a different network can't be remapped to a valid local runtime
/// ID, so conversion must reject it rather than emit a dangling reference.
#[test]
fn cross_network_reference_is_rejected() {
use crate::to_runtime::ConversionError;
use crate::{Network, NodeInput};
let (mut registry, declarations) = to_registry(&create_simple_network());
// `create_simple_network` wires one node's input to another, both in the root network. Find the
// referenced storage ID, then move that node into a fresh second network so the reference crosses
// a network boundary.
let referenced_storage_id = registry
.node_instances
.values()
.flat_map(|node| node.inputs())
.find_map(|slot| match slot.input {
NodeInput::Node { id: node_id, .. } => Some(node_id),
_ => None,
})
.expect("simple network has a node-to-node reference");
let other_network = NetworkId(999);
registry.networks.insert(other_network, Network::default());
registry.node_instances.get_mut(&referenced_storage_id).expect("referenced node exists").network = other_network;
let error = registry.to_runtime_with_metadata(&declarations).expect_err("cross-network reference must error");
assert!(matches!(error, ConversionError::CrossNetworkReference { .. }), "expected CrossNetworkReference, got {error:?}");
}
/// A network's `scope_injections` (key -> (NodeId, Type)) must survive a storage round trip, with the
/// node reference resolved back to the same runtime-local ID it pointed at originally.
#[test]
fn scope_injections_round_trip() {
let mut network = create_simple_network();
network.scope_injections.insert("editor-api".to_string(), (NodeId(0), concrete!(u32)));
let (registry, declarations) = to_registry(&network);
let (converted, _) = registry.to_runtime_with_metadata(&declarations).expect("to_runtime");
let (node_id, ty) = converted.scope_injections.get("editor-api").expect("scope injection must survive the round trip");
assert_eq!(*node_id, NodeId(0), "the injection's node reference must resolve back to its original runtime ID");
assert_eq!(*ty, concrete!(u32), "the injection's type must be preserved");
}
/// A stored scope injection whose node reference no longer resolves (node removed, or moved to another
/// network) must error rather than emit an injection pointing at a nonexistent runtime node.
#[test]
fn dangling_scope_injection_is_rejected() {
use crate::AttributesWrite;
use crate::TimeStamp;
use crate::to_runtime::ConversionError;
let (mut registry, declarations) = to_registry(&create_simple_network());
// Store an injection pointing at a storage ID that no node carries, leaving the reference dangling
// while the rest of the graph stays valid. The root network is whichever one holds the nodes.
let root_network_id = registry.node_instances.values().next().expect("simple network has nodes").network();
let injections: HashMap<String, (crate::NodeId, Type)> = [("editor-api".to_string(), (crate::NodeId(u64::MAX), concrete!(u32)))].into_iter().collect();
registry
.networks
.get_mut(&root_network_id)
.expect("root network exists")
.attributes
.set_serialized(crate::attr::network::SCOPE_INJECTIONS, &injections, TimeStamp::ORIGIN)
.expect("serialize injections");
let error = registry.to_runtime_with_metadata(&declarations).expect_err("dangling scope injection must error");
assert!(matches!(error, ConversionError::DanglingScopeInjection { .. }), "expected DanglingScopeInjection, got {error:?}");
}
#[test]
fn cyclic_network_reference_is_rejected() {
use crate::to_runtime::ConversionError;
use crate::{Implementation, Network, Node};
// A runtime `NodeNetwork` embeds children by value and so can't be cyclic; the cycle only exists
// in the storage form, where networks reference each other by `NetworkId`. Build it directly:
// the root network holds a node whose implementation is the child network, whose own node points
// back at the root, closing the loop.
let child_network_id = NetworkId(1);
let mut registry = Registry::default();
registry.networks.insert(crate::ROOT_NETWORK, Network::default());
registry.networks.insert(child_network_id, Network::default());
registry.node_instances.insert(
crate::NodeId(0),
Node {
implementation: Implementation::Network(child_network_id),
inputs: Vec::new(),
attributes: crate::Attributes::default(),
network: crate::ROOT_NETWORK,
},
);
registry.node_instances.insert(
crate::NodeId(1),
Node {
implementation: Implementation::Network(crate::ROOT_NETWORK),
inputs: Vec::new(),
attributes: crate::Attributes::default(),
network: child_network_id,
},
);
let error = registry.to_runtime_with_metadata(&crate::Declarations::new()).expect_err("cyclic network reference must error");
assert!(matches!(error, ConversionError::CyclicNetwork(_)), "expected CyclicNetwork, got {error:?}");
}