Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Unit tests
  • Loading branch information
jamescrosswell committed Jul 7, 2025
commit df5cf45c514d0a80bb94b2fc4bc60bdc5b87dd54
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

namespace Sentry.Integrations;

internal class AppDomainProcessExitIntegration : ISdkIntegration, ISdkIntegrationCleanup
internal class AppDomainProcessExitIntegration : ITidySdkIntegration
{
private readonly IAppDomain _appDomain;
private IHub? _hub;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ namespace Sentry.Integrations;
/// allows us to add some cleanup logic as an internal interface. We can move this to <see cref="ISdkIntegration"/>
/// in the next major release.
/// </summary>
internal interface ISdkIntegrationCleanup
internal interface ITidySdkIntegration: ISdkIntegration
{
/// <summary>
/// Performs any necessary cleanup for the integration
Expand Down
6 changes: 3 additions & 3 deletions src/Sentry/Internal/Hub.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ internal class Hub : IHub, IDisposable
private readonly SentryOptions _options;
private readonly RandomValuesFactory _randomValuesFactory;
private readonly IReplaySession _replaySession;
private readonly List<ISdkIntegrationCleanup> _integrationsToCleanup = new();
private readonly List<ITidySdkIntegration> _integrationsToCleanup = new();

#if MEMORY_DUMP_SUPPORTED
private readonly MemoryMonitor? _memoryMonitor;
Expand Down Expand Up @@ -86,9 +86,9 @@ internal Hub(
{
options.LogDebug("Registering integration: '{0}'.", integration.GetType().Name);
integration.Register(this, options);
if (integration is ISdkIntegrationCleanup cleanupIntegration)
if (integration is ITidySdkIntegration tidyIntegration)
{
_integrationsToCleanup.Add(cleanupIntegration);
_integrationsToCleanup.Add(tidyIntegration);
}
}
}
Expand Down
74 changes: 74 additions & 0 deletions test/Sentry.Tests/HubTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1988,6 +1988,80 @@ public void CaptureUserFeedback_InvalidEmail_FeedbackDropped(string email)
_fixture.Client.Received(1).CaptureUserFeedback(Arg.Is<UserFeedback>(f => f.Email.IsNull()));
#pragma warning restore CS0618 // Type or member is obsolete
}

[Fact]
public void Dispose_IntegrationsWithCleanup_CleanupCalled()
{
// Arrange
var cleaned = new List<ITidySdkIntegration>();
var integration1 = Substitute.For<ITidySdkIntegration>();
integration1.When(i => i.Cleanup()).Do(_ => cleaned.Add(integration1));
var integration2 = Substitute.For<ITidySdkIntegration>();
integration2.When(i => i.Cleanup()).Do(_ => cleaned.Add(integration2));
var integration3 = Substitute.For<ISdkIntegration>();
_fixture.Options.AddIntegration(integration1);
_fixture.Options.AddIntegration(integration2);
_fixture.Options.AddIntegration(integration3);
var hub = _fixture.GetSut();

// Act
hub.Dispose();

// Assert
cleaned.Should().Contain(integration1);
cleaned.Should().Contain(integration2);
}

[Fact]
public void Dispose_CleanupThrowsException_ExceptionHandledAndLogged()
{
// Arrange
var cleaned = new List<ITidySdkIntegration>();
var integration1 = Substitute.For<ITidySdkIntegration>();
integration1.When(i => i.Cleanup()).Do(_ => cleaned.Add(integration1));
var integration2 = Substitute.For<ITidySdkIntegration>();
integration2.When(i => i.Cleanup()).Do(_ => throw new InvalidOperationException("Cleanup failed"));
var integration3 = Substitute.For<ITidySdkIntegration>();
integration3.When(i => i.Cleanup()).Do(_ => cleaned.Add(integration3));
_fixture.Options.AddIntegration(integration1);
_fixture.Options.AddIntegration(integration2);
_fixture.Options.AddIntegration(integration3);
_fixture.Options.Debug = true;
_fixture.Options.DiagnosticLogger = Substitute.For<IDiagnosticLogger>();
_fixture.Options.DiagnosticLogger!.IsEnabled(Arg.Any<SentryLevel>()).Returns(true);
var hub = _fixture.GetSut();

// Act
hub.Dispose();

// Assert
cleaned.Should().Contain(integration1);
cleaned.Should().NotContain(integration2);
cleaned.Should().Contain(integration3);
_fixture.Options.DiagnosticLogger.Received(1).Log(
SentryLevel.Error,
Arg.Is<string>(s => s.Contains("Failure to cleanup integration")),
Arg.Any<InvalidOperationException>(),
Arg.Any<object[]>());
}

[Fact]
public void Dispose_CalledMultipleTimes_CleanupCalledOnlyOnce()
{
// Arrange
var cleaned = 0;
var integration = Substitute.For<ITidySdkIntegration>();
integration.When(i => i.Cleanup()).Do(_ => cleaned++);
_fixture.Options.AddIntegration(integration);
var hub = _fixture.GetSut();

// Act
hub.Dispose();
hub.Dispose();

// Assert
cleaned.Should().Be(1);
}
}

#if NET6_0_OR_GREATER
Expand Down
Loading