Add SQL connectivity health checks for all database providers #558
Conversation
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
- Add SqlJournalConnectivityCheck class for proactive database connectivity verification - Add SqlSnapshotStoreConnectivityCheck class for snapshot store connectivity verification - Add WithConnectivityCheck() extension methods for journal and snapshot store builders - Implement lightweight SELECT 1 probes using Linq2Db DataConnection - Comprehensive test coverage for connectivity checks in both healthy and unhealthy states - Parameter validation tests for all required configuration - Tests verify checks return Healthy when database connected, Unhealthy when disconnected Closes #678 (partial - SQL implementation)
- Remove unnecessary parameterization complexity - Use SqliteContainer directly as test fixture - Keep tests focused and clean with straightforward Fact tests - All 10 tests pass: 4 happy path, 4 unhappy path, 2 parameter validation - Follows Akka.NET pattern of simple concrete test classes per provider - Future: Add separate test classes for PostgreSQL, SQL Server, MySQL if needed
- PostgreSQL connectivity checks (4 tests) - MySQL connectivity checks (4 tests) - SQL Server connectivity checks (4 tests) - Tests verify healthy status on valid connection, unhealthy on invalid connection - All tests support both journal and snapshot store connectivity probes - Total: 22 tests passing across all 4 SQL database types (SQLite, PostgreSQL, MySQL, SQL Server) Closes #678 (SQL implementation complete)
Aaronontheweb
force-pushed
the
feature/sql-connectivity-health-checks
branch
from
ab0eab2 to
03e69cc
Compare
Windows CI environment doesn't support Docker, causing test failures when attempting to initialize SqlServerContainer, PostgreSqlContainer, and MySqlContainer. Added [SkipWindows] attribute to these test classes to skip them on Windows while allowing Linux CI to run the full test suite. - Added [SkipWindows] attribute to SqlServerConnectivityCheckSpec - Added [SkipWindows] attribute to PostgreSqlConnectivityCheckSpec - Added [SkipWindows] attribute to MySqlConnectivityCheckSpec - Added required using statement for Akka.Persistence.Sql.Tests.Common.Internal.Xunit
The SqlFrameworkDiscoverer.IsValidTestClass() method had inverted logic that prevented [SkipWindows] and [SkipLinux] attributes from working correctly. The method was returning true when tests should be skipped instead of false. Changed the return statement from: return !type.IsAbstract || type.IsSealed || skipLinux || skipWindows; To: return (!type.IsAbstract || type.IsSealed) && !skipLinux && !skipWindows; This ensures Docker-based connectivity check tests are properly skipped on Windows CI where Docker is not available, fixing test failures in PostgreSqlConnectivityCheckSpec, SqlServerConnectivityCheckSpec, and MySqlConnectivityCheckSpec.
The Akka.Persistence.Sql.Hosting.Tests project was missing the TestFramework attribute registration that enables the custom SqlTestFramework, which provides platform-specific test skipping via [SkipWindows] and [SkipLinux] attributes. Created Properties/AssemblyInfo.cs with the TestFramework attribute to register the SqlTestFramework. This enables the Docker-based connectivity check tests to be properly skipped on Windows CI where Docker is unavailable.
Replace Environment.OSVersion.Platform with RuntimeInformation.IsOSPlatform for more reliable platform detection across all .NET versions. This ensures the test skipping mechanism works correctly on all platforms, particularly for Windows CI environments where Docker containers are not available.
The changes to SqlFrameworkDiscoverer were causing test execution issues. The AssemblyInfo.cs registration alone is sufficient to enable the [SkipWindows] attribute functionality for the connectivity check tests.
- Upgraded Akka.Hosting from 1.5.53 to 1.5.55-beta1 - Upgraded Akka.NET from 1.5.53 to 1.5.55 - Updated SqlConnectivityCheckExtensions to use the new WithCustomHealthCheck() method - Removed reflection-based approach in favor of the new public API - All 22 connectivity health check tests pass successfully
Aaronontheweb
commented
Oct 26, 2025
There was a problem hiding this comment.
Needed this to ensure that we use the SqlFrameworkDiscoverer and skip Docker-based integration tests on Windows CI/CD
| /// </summary> | ||
| public static class SqlConnectivityCheckExtensions | ||
| { | ||
| private static readonly System.Reflection.PropertyInfo? JournalBuilderProperty = |
There was a problem hiding this comment.
Need to get rid of that - should be able to just access the journal builder directly
| new[] { "akka", "persistence", "sql", "snapshot-store", "connectivity" }); | ||
|
|
||
| // Use reflection to access the internal Builder property | ||
| if (SnapshotBuilderProperty?.GetValue(builder) is AkkaConfigurationBuilder akkaBuilder) |
There was a problem hiding this comment.
Need to extend Akka.Persistence.Hosting to make it possible to register custom health checks for the JournalBuilder and SnapshotStoreBuilder
| /// <param name="unHealthyStatus">The status to return when check fails. Defaults to Unhealthy.</param> | ||
| /// <param name="name">Optional name for the health check. Defaults to "Akka.Persistence.Sql.Journal.{id}.Connectivity"</param> | ||
| /// <returns>The journal builder for chaining</returns> | ||
| public static AkkaPersistenceJournalBuilder WithConnectivityCheck( |
There was a problem hiding this comment.
Need to pass in tags and have some default tags in case there are none
This was referenced Oct 27, 2025
Closed
Open
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.
Summary
Implements proactive connectivity health checks for Akka.Persistence.Sql across all supported database providers (SQLite, PostgreSQL, MySQL, SQL Server). These checks complement existing CircuitBreaker-based readiness checks by providing continuous liveness verification.
.WithConnectivityCheck()for fluent builder configurationImplementation Details
Design
DataConnectionwith lightweightSELECT 1probesHealthStatus.Healthywhen connected,Unhealthywhen disconnectedClasses
SqlJournalConnectivityCheck- Public, sealedSqlSnapshotStoreConnectivityCheck- Public, sealedSqlConnectivityCheckExtensions- Builder extension methods with reflection-based property accessTesting
✅ SQLite: 10 tests (healthy, unhealthy, parameter validation)
✅ PostgreSQL: 4 tests (healthy/unhealthy for journal & snapshot)
✅ MySQL: 4 tests (healthy/unhealthy for journal & snapshot)
✅ SQL Server: 4 tests (healthy/unhealthy for journal & snapshot)
All tests verify:
Related Issues
Test Plan
Run all connectivity check tests:
Expected: All 22 tests pass (requires Docker for PostgreSQL, MySQL, SQL Server)