Skip to content

fix: rename followup — stale TLA+, book, module names, doc comments, bench labels#956

Merged
strawgate merged 1 commit into
masterfrom
rename-followup
Apr 4, 2026
Merged

fix: rename followup — stale TLA+, book, module names, doc comments, bench labels#956
strawgate merged 1 commit into
masterfrom
rename-followup

Conversation

@strawgate
Copy link
Copy Markdown
Owner

@strawgate strawgate commented Apr 4, 2026

Summary

Followup to #952 (rename cleanup) fixing stale references found by thorough diff review:

  • TLA+ CommitAdvancesCheckpointAdvances (3 files)
  • Book "SIMD Scanner" → "Scanner" / "Zero-Copy Scanner" (7 files)
  • aggregator.rsreassembler.rs module rename + backward-compat re-export (keeps logfwd_core::aggregator::* working)
  • 8 Kani proofs + 3 proptests renamed aggregator_*reassembler_*
  • Rust doc comments: remove stale "SIMD scanner" references (4 files)
  • bench/scenarios/README.md + justfile: tcp_out/udp_outtcp/udp
  • Benchmark label: "SIMD scanner""CopyScanner"
  • VERIFICATION.md: fix proof count 5 → 8, update module name
  • Fuzz target: streaming_scanner.rszero_copy_scanner.rs
  • GitHub Actions workflow: remove stale "SIMD" reference

Test plan

  • cargo check passes
  • cargo fmt clean
  • CI passes

🤖 Generated with Claude Code

Note

Rename stale identifiers across TLA+ specs, docs, bench labels, and module names

  • Renames the CommitAdvances invariant to CheckpointAdvances in PipelineMachine.tla, its coverage config, and README.
  • Renames the aggregator module to reassembler in logfwd-core, adding a pub use reassembler as aggregator re-export for backward compatibility.
  • Replaces 'SIMD scanner' with 'Scanner' or 'Zero-Copy Scanner' across book docs, doc comments, and test comments.
  • Renames the fuzz_streaming_scanner fuzz target to fuzz_zero_copy_scanner and updates benchmark labels to match current component names.

Macroscope summarized 326880a.

…nts, bench labels

1. TLA+: CommitAdvances → CheckpointAdvances (operator, coverage cfg, README)
2. Book: "SIMD Scanner" → "Scanner" / "Zero-Copy Scanner" in titles, nav, links
3. aggregator.rs → reassembler.rs with backward-compat re-export
4. Kani proofs: verify_aggregator_* → verify_reassembler_*; proptest: aggregator_* → reassembler_*
5. Doc comments: "SIMD scanner" → "scanner" / "zero-copy scanner"
6. bench/scenarios + justfile: tcp_out/udp_out → tcp/udp
7. Benchmark label: "SIMD scanner" → "CopyScanner"
8. VERIFICATION.md: aggregator.rs → reassembler.rs, 5 proofs → 8 proofs
9. Fuzz target: streaming_scanner → zero_copy_scanner
10. GitHub Actions: remove "SIMD" from scanner reference

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 4, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Pro

Run ID: cd1e96cf-451e-4173-9e2b-ed05b4954bbd

📥 Commits

Reviewing files that changed from the base of the PR and between 4a4d4cc and 326880a.

📒 Files selected for processing (23)
  • .github/workflows/ai-explore-correctness.yml
  • bench/scenarios/README.md
  • book/src/README.md
  • book/src/SUMMARY.md
  • book/src/architecture/pipeline.md
  • book/src/architecture/scanner.md
  • book/src/development/building.md
  • book/src/getting-started/first-pipeline.md
  • book/src/troubleshooting.md
  • crates/logfwd-arrow/src/scanner.rs
  • crates/logfwd-core/benches/scanner.rs
  • crates/logfwd-core/fuzz/Cargo.toml
  • crates/logfwd-core/fuzz/fuzz_targets/zero_copy_scanner.rs
  • crates/logfwd-core/src/lib.rs
  • crates/logfwd-core/src/reassembler.rs
  • crates/logfwd-core/tests/it/scanner_conformance.rs
  • crates/logfwd-transform/src/udf/json_extract.rs
  • crates/logfwd-transform/tests/it/raw_first_bench.rs
  • dev-docs/VERIFICATION.md
  • justfile
  • tla/PipelineMachine.coverage.cfg
  • tla/PipelineMachine.tla
  • tla/README.md

Walkthrough

This pull request performs systematic terminology and naming updates across the codebase. It removes "SIMD" references from documentation and comments, replacing them with more general or accurate descriptions like "scanner" or "zero-copy scanner." The PR renames the aggregator module to reassembler with a backward-compatible re-export to maintain downstream compatibility. It updates test function names and identifiers from "aggregator" to "reassembler" terminology, renames a fuzz test binary from fuzz_streaming_scanner to fuzz_zero_copy_scanner, updates TLA\+ specifications by renaming the CommitAdvances predicate to CheckpointAdvances, and modifies benchmark labels and endpoint identifiers in documentation and configuration files.

Possibly related PRs


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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant