refactor(api): ConsumerConfig — collapse the 5-site consumer-wide settings mirror - #293
Merged
Conversation
The ~12 consumer-wide settings (retry, backpressure, processing mode, key-ordered cap, metrics, error handler, dead-letter topic, poll timeout, tracer, circuit breaker) were mirrored across five sites: DefaultStream's record components + Mut + withers, its applyCommonConsumerConfig chain, MultiBuilder's fields + withers, MultiBuilder.start()'s re-implemented if-not-null chain, and rejectPerRouteConsumerWideSettings' ten hand-written checks. That drift class already bit once — the batch path silently dropped tracer and circuit breaker because one mirror lagged the others. ConsumerConfig (package-private, kpipe-api) now owns the list: - An immutable record with the 12 components and a Mut funnel, mirroring the DefaultStream mutate pattern. - applyTo(KPipeConsumerBuilder) is THE apply chain. DefaultSink, DefaultBatchSink, and MultiBuilder.start() all call it, so the three build paths cannot diverge. Folding processingMode/keyOrderedMaxKeys into the chain is behavior-preserving: builder setters are plain field writes (all cross-setting derivation happens in its build()), and the facade defaults equal the builder defaults. - CONSUMER_WIDE_SETTINGS descriptors (name + is-set predicate + rejection message) drive the per-route guard; the messages still point users at the MultiBuilder mirror method by name, and the reporting order is unchanged. DefaultStream keeps its public immutability contract — the consumer-wide withers now funnel through mutateConfig, still returning a new stream per call. MultiBuilder collapses twelve fields to one ConsumerConfig; its withers keep their exact validation messages. Adding a setting is now: one component on ConsumerConfig, one applyTo line, one descriptor, and the thin Stream/MultiBuilder delegates. Only KPipeFacadeBuildTest reached the old record accessors; it now reads through stream.consumerConfig().
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #293 +/- ##
============================================
+ Coverage 79.26% 79.56% +0.29%
- Complexity 1032 1061 +29
============================================
Files 83 84 +1
Lines 3560 3572 +12
Branches 457 441 -16
============================================
+ Hits 2822 2842 +20
Misses 546 546
+ Partials 192 184 -8 ☔ View full report in Codecov by Harness. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Architecture-pass item #6. The ~12 consumer-wide settings (retry, backpressure, mode, key cap, metrics, error handler, DLQ, poll timeout, tracer, circuit breaker) were mirrored across five sites between
DefaultStreamandMultiBuilder— a drift class that already caused one real bug (batch routes silently dropped tracer/CB).Now: one package-private
ConsumerConfigrecord owns the list —applyTo(builder)is THE apply chain (all three build paths call it), andCONSUMER_WIDE_SETTINGSdescriptors drive the per-route rejection guard (was 10 hand-written blocks), preserving the existing error-message shapes. Adding a setting is now: component + one applyTo line + one descriptor + the thin public delegates.No public API change;
Streamimmutability semantics intact (withers still return new records). Verified::lib:kpipe-api:test84/84 (incl. Docker integration suites),:lib:kpipe-consumer:test430/430, kpipe-test + demo compile. Equivalence spot-check: the unconditionalwithKeyOrderedMaxKeys(default)cannot trigger the builder's misconfig WARNING (value-based guard, default==default).