Skip to content

refactor: rename cleanup — CheckpointAdvance, sink names, OutputType variants, FormatDecoder, ZeroCopyScanner#952

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

refactor: rename cleanup — CheckpointAdvance, sink names, OutputType variants, FormatDecoder, ZeroCopyScanner#952
strawgate merged 1 commit into
masterfrom
rename-cleanup

Conversation

@strawgate
Copy link
Copy Markdown
Owner

@strawgate strawgate commented Apr 4, 2026

Summary

Mechanical renames across the codebase for clarity and consistency:

Closes #925, #926, #927, #928, #929

Test plan

  • cargo check passes
  • cargo clippy -- -D warnings passes
  • cargo test --no-run compiles
  • cargo fmt clean
  • CI passes

🤖 Generated with Claude Code

Note

Rename scanner, sink, format, and config types across the codebase

  • Renames SimdScannerCopyScanner and StreamingSimdScannerZeroCopyScanner in logfwd-arrow/src/scanner.rs and all call sites.
  • Renames ElasticsearchAsyncSinkElasticsearchSink, LokiAsyncSinkLokiSink, FanOut/FanOutErrorFanoutSink/FanoutSinkError, and FormatProcessorFormatDecoder in their respective modules.
  • Renames CriAggregatorCriReassembler in logfwd-core/src/aggregator.rs and CommitAdvanceCheckpointAdvance in logfwd-core/src/pipeline/lifecycle.rs.
  • Renames OutputType variants FileOut/TcpOut/UdpOutFile/Tcp/Udp in logfwd-config/src/lib.rs; the deserializer accepts both old and new names as aliases.
  • Behavioral Change: OutputType::Display now emits "file", "tcp", "udp" instead of "file_out", "tcp_out", "udp_out", and error messages from build_output_sink now reference the shorter names.

Macroscope summarized 99260b8.

…variants, FormatDecoder, ZeroCopyScanner (#925, #926, #927, #928, #929)

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: 97659c5c-aae9-414d-95ad-b5f19e34a017

📥 Commits

Reviewing files that changed from the base of the PR and between e25c5bf and 99260b8.

📒 Files selected for processing (51)
  • bench/scenarios/tcp-sender.yaml
  • bench/scenarios/udp-sender.yaml
  • book/src/architecture/scanner.md
  • book/src/config/reference.md
  • crates/logfwd-arrow/README.md
  • crates/logfwd-arrow/src/lib.rs
  • crates/logfwd-arrow/src/materialize.rs
  • crates/logfwd-arrow/src/scanner.rs
  • crates/logfwd-arrow/tests/allocation_regression.rs
  • crates/logfwd-bench/benches/builder_compare.rs
  • crates/logfwd-bench/benches/pipeline.rs
  • crates/logfwd-bench/src/e2e_profile.rs
  • crates/logfwd-bench/src/es_throughput.rs
  • crates/logfwd-bench/src/explore.rs
  • crates/logfwd-bench/src/rss.rs
  • crates/logfwd-bench/src/sizes.rs
  • crates/logfwd-config/src/lib.rs
  • crates/logfwd-core/README.md
  • crates/logfwd-core/benches/scanner.rs
  • crates/logfwd-core/fuzz/fuzz_targets/scanner.rs
  • crates/logfwd-core/fuzz/fuzz_targets/scanner_consistency.rs
  • crates/logfwd-core/fuzz/fuzz_targets/scanner_sink.rs
  • crates/logfwd-core/fuzz/fuzz_targets/scanner_transform.rs
  • crates/logfwd-core/fuzz/fuzz_targets/streaming_scanner.rs
  • crates/logfwd-core/fuzz/fuzz_targets/structural_index.rs
  • crates/logfwd-core/src/aggregator.rs
  • crates/logfwd-core/src/pipeline/lifecycle.rs
  • crates/logfwd-core/src/pipeline/mod.rs
  • crates/logfwd-core/src/scan_config.rs
  • crates/logfwd-core/src/scanner.rs
  • crates/logfwd-core/tests/it/compliance_data.rs
  • crates/logfwd-core/tests/it/scanner_conformance.rs
  • crates/logfwd-io/src/format.rs
  • crates/logfwd-io/src/framed.rs
  • crates/logfwd-io/tests/allocation_churn.rs
  • crates/logfwd-output/src/elasticsearch.rs
  • crates/logfwd-output/src/fanout.rs
  • crates/logfwd-output/src/lib.rs
  • crates/logfwd-output/src/loki.rs
  • crates/logfwd-transform/src/udf/json_extract.rs
  • crates/logfwd-transform/tests/it/raw_first_bench.rs
  • crates/logfwd/src/main.rs
  • crates/logfwd/src/pipeline.rs
  • crates/logfwd/tests/it/integration.rs
  • dev-docs/ARCHITECTURE.md
  • dev-docs/DESIGN.md
  • dev-docs/PR_PROCESS.md
  • dev-docs/SCANNER_CONTRACT.md
  • dev-docs/VERIFICATION.md
  • dev-docs/research/checkpoint-snapshot-design.md
  • examples/elasticsearch/ARROW_IPC.md

Walkthrough

This pull request performs a systematic nomenclature update across the codebase, renaming multiple public types and configuration values to improve terminology consistency. The changes include: renaming scanner implementations from SimdScanner/StreamingSimdScanner to CopyScanner/ZeroCopyScanner; renaming output configuration types from FileOut/TcpOut/UdpOut to File/Tcp/Udp; renaming CriAggregator to CriReassembler; updating pipeline types from CommitAdvance to CheckpointAdvance; renaming format abstractions from FormatProcessor to FormatDecoder; and renaming sink types including ElasticsearchAsyncSink to ElasticsearchSink, LokiAsyncSink to LokiSink, and FanOut to FanoutSink. All usages across tests, benchmarks, documentation, and configuration files are updated consistently.

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.

Rename CommitAdvance → CheckpointAdvance

1 participant