warp-core: EdgeRecord derives Eq

[flyingrobots]

Closes #154

• Derive PartialEq, Eq for EdgeRecord.
• Replace edge_record_eq(a, b) usage with idiomatic a == b / a != b.
• Remove the now-unused helper from tick_patch.rs.

Validation:

• cargo test --workspace
• cargo clippy --workspace --all-targets -- -D warnings -D missing_docs

[coderabbitai]

Summary by CodeRabbit

Release Notes

• Refactor

  • Enhanced edge record equality comparisons with standard Rust semantics for improved code reliability and maintainability.

• Documentation

  • Updated decision and execution plan documentation to reflect equality comparison improvements.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Walkthrough

EdgeRecord now derives PartialEq and Eq to enable idiomatic equality comparisons. The custom edge_record_eq helper function is removed, and all comparisons in tick_patch.rs now use the standard != operator directly.

Changes

Cohort / File(s)	Summary
Core Equality Implementation crates/warp-core/src/record.rs	Added PartialEq, Eq derives to EdgeRecord; enables idiomatic == and != operations on edge records.
Diffing Logic Simplification crates/warp-core/src/tick_patch.rs	Replaced edge_record_eq(...) calls with direct rec_before != rec_after inequality check; deleted the now-unused edge_record_eq helper function. Minor whitespace cleanup.
Documentation docs/decision-log.md, docs/execution-plan.md	Added decision log entry documenting the equality semantics change; added planned follow-up entries for EdgeRecord equality and policy_id improvements in execution plan.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

EdgeRecord sheds its helper chains,
PartialEq and Eq now reign,
No custom functions left behind,
Just idiomatic ops by design,
Pure Rust semantics, crystalline and clean! 🎯✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	Title accurately and concisely describes the main change: deriving Eq for EdgeRecord, which is the primary objective of the changeset.
Description check	✅ Passed	Description clearly maps to the changeset, detailing the three core changes: deriving PartialEq/Eq, replacing edge_record_eq usage, and removing the helper function.
Linked Issues check	✅ Passed	All requirements from issue #154 are met: EdgeRecord derives PartialEq and Eq, edge_record_eq usage replaced with direct == comparisons, and the helper function is removed.
Out of Scope Changes check	✅ Passed	All changes are tightly scoped to issue #154 requirements; documentation updates in decision-log.md and execution-plan.md are appropriately related to the implementation.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch echo/warp-core-edge-record-eq

---

📜 Recent review details

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between feaee63 and 218c401.

📒 Files selected for processing (4)

• crates/warp-core/src/record.rs
• crates/warp-core/src/tick_patch.rs
• docs/decision-log.md
• docs/execution-plan.md

🧰 Additional context used

📓 Path-based instructions (1)

**/*.rs

📄 CodeRabbit inference engine (AGENTS.md)

**/*.rs: Every public API across crates (warp-core, warp-ffi, warp-wasm, etc.) must carry rustdoc comments that explain intent, invariants, and usage. Treat missing docs as a failing test.
Run cargo clippy --all-targets -- -D missing_docs before every PR; CI will expect a zero-warning, fully documented surface.
Every source file must start with exactly: // SPDX-License-Identifier: Apache-2.0 and // © James Ross Ω FLYING•ROBOTS <https://github.com/flyingrobots>

Files:

• crates/warp-core/src/record.rs
• crates/warp-core/src/tick_patch.rs

🧠 Learnings (2)

📚 Learning: 2025-12-28T23:14:28.083Z

Learnt from: CR
Repo: flyingrobots/echo PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-28T23:14:28.083Z
Learning: When a PR touches non-doc code, update `docs/execution-plan.md` and `docs/decision-log.md` in the same PR.

Applied to files:

• docs/execution-plan.md

📚 Learning: 2025-12-28T23:14:28.083Z

Learnt from: CR
Repo: flyingrobots/echo PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-28T23:14:28.083Z
Learning: Start each session by updating *Today's Intent* in `docs/execution-plan.md` and capture milestones, blockers, and decisions in the Decision Log.

Applied to files:

• docs/execution-plan.md

🔇 Additional comments (4)

crates/warp-core/src/record.rs (1)

32-32: LGTM: Clean addition of equality traits.

The derive correctly adds PartialEq and Eq to EdgeRecord. All component types (EdgeId, NodeId, TypeId, and Bytes) properly implement these traits, and structural equality over all fields is the correct semantics for edge diffing in tick patches. This eliminates the now-redundant helper function and makes equality single-source-of-truth at the type level.

docs/decision-log.md (1)

12-12: Well-documented decision.

The decision log entry clearly captures the rationale (preventing helper/type drift) and consequences (smaller, more portable diffing code) of deriving equality on EdgeRecord. This aligns perfectly with the implemented changes.

crates/warp-core/src/tick_patch.rs (1)

437-437: Excellent: Idiomatic equality check replaces helper.

The direct != operator leverages the derived PartialEq implementation on EdgeRecord, eliminating the need for a separate helper function. This is cleaner, more maintainable, and preserves the field-by-field comparison semantics of the removed edge_record_eq helper.

docs/execution-plan.md (1)

38-44: Completion tracking is thorough and accurate.

The execution plan correctly documents the scope, exit criteria, and evidence for the EdgeRecord equality improvement. The entry clearly states what was changed (derive traits, replace helper, remove function) and confirms validation (tests + clippy green), satisfying the Docs Guard requirement.

Based on learnings: when a PR touches non-doc code, docs/execution-plan.md must be updated in the same PR.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

crates/warp-core/src/record.rs (1)

17-23: Consider deriving PartialEq/Eq on NodeRecord for symmetry.

For consistency and future-proofing, consider deriving PartialEq and Eq on NodeRecord as well, mirroring the treatment of EdgeRecord. The diff logic in tick_patch.rs (lines 401-402) already performs field-by-field comparison, so the derive would formalize existing semantics and enable idiomatic equality checks if needed later.

🔎 Proposed consistency improvement

-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, PartialEq, Eq)]
 pub struct NodeRecord {

📜 Review details

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between feaee63 and 218c401.

📒 Files selected for processing (4)

• crates/warp-core/src/record.rs
• crates/warp-core/src/tick_patch.rs
• docs/decision-log.md
• docs/execution-plan.md

🧰 Additional context used

📓 Path-based instructions (1)

**/*.rs

📄 CodeRabbit inference engine (AGENTS.md)

**/*.rs: Every public API across crates (warp-core, warp-ffi, warp-wasm, etc.) must carry rustdoc comments that explain intent, invariants, and usage. Treat missing docs as a failing test.
Run cargo clippy --all-targets -- -D missing_docs before every PR; CI will expect a zero-warning, fully documented surface.
Every source file must start with exactly: // SPDX-License-Identifier: Apache-2.0 and // © James Ross Ω FLYING•ROBOTS <https://github.com/flyingrobots>

Files:

• crates/warp-core/src/record.rs
• crates/warp-core/src/tick_patch.rs

🧠 Learnings (2)

📚 Learning: 2025-12-28T23:14:28.083Z

Learnt from: CR
Repo: flyingrobots/echo PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-28T23:14:28.083Z
Learning: When a PR touches non-doc code, update `docs/execution-plan.md` and `docs/decision-log.md` in the same PR.

Applied to files:

• docs/execution-plan.md

📚 Learning: 2025-12-28T23:14:28.083Z

Learnt from: CR
Repo: flyingrobots/echo PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-28T23:14:28.083Z
Learning: Start each session by updating *Today's Intent* in `docs/execution-plan.md` and capture milestones, blockers, and decisions in the Decision Log.

Applied to files:

• docs/execution-plan.md

🔇 Additional comments (4)

crates/warp-core/src/record.rs (1)

32-32: LGTM: Clean addition of equality traits.

The derive correctly adds PartialEq and Eq to EdgeRecord. All component types (EdgeId, NodeId, TypeId, and Bytes) properly implement these traits, and structural equality over all fields is the correct semantics for edge diffing in tick patches. This eliminates the now-redundant helper function and makes equality single-source-of-truth at the type level.

docs/decision-log.md (1)

12-12: Well-documented decision.

The decision log entry clearly captures the rationale (preventing helper/type drift) and consequences (smaller, more portable diffing code) of deriving equality on EdgeRecord. This aligns perfectly with the implemented changes.

crates/warp-core/src/tick_patch.rs (1)

437-437: Excellent: Idiomatic equality check replaces helper.

The direct != operator leverages the derived PartialEq implementation on EdgeRecord, eliminating the need for a separate helper function. This is cleaner, more maintainable, and preserves the field-by-field comparison semantics of the removed edge_record_eq helper.

docs/execution-plan.md (1)

38-44: Completion tracking is thorough and accurate.

The execution plan correctly documents the scope, exit criteria, and evidence for the EdgeRecord equality improvement. The entry clearly states what was changed (derive traits, replace helper, remove function) and confirms validation (tests + clippy green), satisfying the Docs Guard requirement.

Based on learnings: when a PR touches non-doc code, docs/execution-plan.md must be updated in the same PR.