Deprecate JournalOptions.Adapters property in favor of callback API #669
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.
Fixes #665
Summary
The
Adapters
property onJournalOptions
created confusion by providing two competing patterns for configuring event adapters. This PR deprecates the property in favor of the unified callback pattern introduced in PR #662.Problem
Having two ways to configure event adapters was:
Solution
[Obsolete]
with clear migration guidance pointing to issue Deprecate JournalOptions.Adapters property in favor of unified callback API #665JournalOptions.Build()
Changes
JournalOptions.cs:78
- Added[Obsolete]
attribute toAdapters
propertyJournalOptions.cs:105
- RemovedAdapters.AppendAdapters(sb)
callEventAdapterSpecs.cs:134-207
- AddedDeprecatedAdaptersPropertySpec
regression testBenefits
✅ Single, consistent pattern for configuring adapters and health checks
✅ Cleaner API surface - options contain only configuration data
✅ Clear migration path with deprecation warning
✅ No silent failures - deprecated property is truly ignored
Migration Example
Before (deprecated):
After (recommended):
Testing
All 17 persistence hosting tests pass, including new regression test that verifies:
#pragma warning disable
to test deprecated API without warningsNote
This is Phase 1 of the deprecation plan. The property will be removed entirely in v1.6.0.