fix(logs): remove Dispose from the public API surface area #4424
+12
−35
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.
Summary
Remove
Dispose()
fromSentryStructuredLogger
public API surface area.Remarks
In #4310, we added
SentryStructuredLogger.Dispose()
,where only one out of three derived types actually has
IDisposable
fields.This was necessary to enable cascading disposal (when
Hub.IsEnabled
andSentryOptions.(Experimental).EnableLogs
) out ofHub.Dispose()
, whose compile-time type is only theabstract SentryStructuredLogger
, but not the concreteDefaultSentryStructuredLogger
(because through theDisabledHub
, or whenEnableLogs is not true
, aDisabledSentryStructuredLogger
is created).However, this allows user code to call
Dispose()
on theabstract SentryStructuredLogger
, and thereforeDispose
the concreteDefaultSentryStructuredLogger
(when enabled) and itsIDisposable
members, without disposing any of the otherSentry
instances, leaving the SDK in an inconsistent half-disposed and no longer fully usable state.Use code can invoke:
The only path, where the concrete
DefaultSentryStructuredLogger
should be disposed, is when the CurrentHub, which creates and owns the instance ofSentryStructuredLogger
, is disposed.Therefore, I'd like to remove
Dispose()
from the public API surface area ofSentryStructuredLogger
.In order to still
Dispose
theDefaultSentryStructuredLogger
(when enabled) when the owningHub
instance is disposed, the concreteDefaultSentryStructuredLogger
still implementsIDisposable
and the owningHub
does a type-check on theLogger
instance.No (breaking) major release required, because
SentryStructuredLogger
is still[Experimental]
.Changes
IDisposable
fromabstract SentryStructuredLogger
IDisposable
explicitly toDefaultSentryStructuredLogger
, which owns disposable membersHub
performs a type-check before callingDispose()
on theLogger
instance that it owns