From b0d58a41eabe5fabda53bcb59f663e1281d9be6e Mon Sep 17 00:00:00 2001 From: davidfowl <95136+davidfowl@users.noreply.github.com> Date: Fri, 30 Oct 2026 09:05:19 +0000 Subject: [PATCH] Wait for a writable MongoDB single-member primary A newly elected primary reports replSetGetStatus myState 1 while it is still in drain mode and rejects writes with NotWritablePrimary. Gate single-member initialization and health on hello.isWritablePrimary instead. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../MongoDBBuilderExtensions.cs | 6 ++-- .../MongoDBSingleMemberReplicaSet.cs | 15 +++++--- .../SingleMemberReplicaSetFunctionalTests.cs | 34 +++++++++++++++++++ .../SingleMemberReplicaSetTests.cs | 30 ++++++++++------ 4 files changed, 67 insertions(+), 18 deletions(-) diff --git a/src/Aspire.Hosting.MongoDB/MongoDBBuilderExtensions.cs b/src/Aspire.Hosting.MongoDB/MongoDBBuilderExtensions.cs index 3fc2cba88a4..50f9583ee59 100644 --- a/src/Aspire.Hosting.MongoDB/MongoDBBuilderExtensions.cs +++ b/src/Aspire.Hosting.MongoDB/MongoDBBuilderExtensions.cs @@ -935,11 +935,11 @@ public async Task CheckHealthAsync(HealthCheckContext context return HealthCheckResult.Unhealthy(error); } - var status = await _client.GetDatabase(MongoDBServerResource.DefaultAuthenticationDatabase) - .RunCommandAsync(new BsonDocument("replSetGetStatus", 1), ReadPreference.Nearest, cancellationToken) + var hello = await _client.GetDatabase(MongoDBServerResource.DefaultAuthenticationDatabase) + .RunCommandAsync(new BsonDocument("hello", 1), ReadPreference.Nearest, cancellationToken) .ConfigureAwait(false); - return MongoDBSingleMemberReplicaSet.IsPrimary(status, replicaSet.Name) + return MongoDBSingleMemberReplicaSet.IsWritablePrimary(hello, replicaSet.Name) ? HealthCheckResult.Healthy() : HealthCheckResult.Unhealthy($"MongoDB replica set '{replicaSet.Name}' is not a writable single-member primary."); } diff --git a/src/Aspire.Hosting.MongoDB/MongoDBSingleMemberReplicaSet.cs b/src/Aspire.Hosting.MongoDB/MongoDBSingleMemberReplicaSet.cs index 608a42d7825..17996baf984 100644 --- a/src/Aspire.Hosting.MongoDB/MongoDBSingleMemberReplicaSet.cs +++ b/src/Aspire.Hosting.MongoDB/MongoDBSingleMemberReplicaSet.cs @@ -118,9 +118,9 @@ await database.RunCommandAsync( } ValidateConfiguration(config, name, host); - var status = await database.RunCommandAsync( - new BsonDocument("replSetGetStatus", 1), ReadPreference.Nearest, cancellationToken).ConfigureAwait(false); - if (IsPrimary(status, name)) + var hello = await database.RunCommandAsync( + new BsonDocument("hello", 1), ReadPreference.Nearest, cancellationToken).ConfigureAwait(false); + if (IsWritablePrimary(hello, name)) { return; } @@ -150,6 +150,11 @@ internal static void ValidateConfiguration(BsonDocument config, string name, str } } - internal static bool IsPrimary(BsonDocument status, string name) => - status["set"].AsString == name && status["myState"].AsInt32 == 1 && status["members"].AsBsonArray.Count == 1; + // Use hello rather than replSetGetStatus: a newly elected primary reports PRIMARY (myState 1) while it is still + // draining and rejects writes with NotWritablePrimary until hello reports isWritablePrimary. + // https://www.mongodb.com/docs/manual/reference/command/hello/#mongodb-data-hello.isWritablePrimary + internal static bool IsWritablePrimary(BsonDocument hello, string name) => + hello.GetValue("setName", BsonNull.Value) is BsonString setName && setName.Value == name && + hello.GetValue("isWritablePrimary", false).ToBoolean() && + hello.GetValue("hosts", BsonNull.Value) is BsonArray { Count: 1 }; } diff --git a/tests/Aspire.Hosting.MongoDB.Tests/SingleMemberReplicaSetFunctionalTests.cs b/tests/Aspire.Hosting.MongoDB.Tests/SingleMemberReplicaSetFunctionalTests.cs index c513fbd3267..bdb28cf790f 100644 --- a/tests/Aspire.Hosting.MongoDB.Tests/SingleMemberReplicaSetFunctionalTests.cs +++ b/tests/Aspire.Hosting.MongoDB.Tests/SingleMemberReplicaSetFunctionalTests.cs @@ -59,6 +59,40 @@ private async Task VerifyFeaturesAsync(bool useTls) await app.StopAsync(); } + [Fact] + [RequiresFeature(TestFeature.ContainerRuntime)] + public async Task InitializationWaitsUntilThePrimaryAcceptsWrites() + { + using var builder = TestDistributedApplicationBuilder.CreateWithTestContainerRegistry(testOutputHelper); + builder.Services.AddSingleton(new TestDeveloperCertificateService( + [], supportsContainerTrust: true, trustCertificate: true, tlsTerminate: false)); + + // Configure the member without the resource's initializer so this test owns replSetInitiate and can write + // immediately after initialization reports the primary, before any health polling can hide the race. + var mongo = builder.AddMongoDB("mongo"); + MongoDBBuilderExtensions.ConfigureReplicaSetMember(mongo, "mongo") + .WithKeyFile(MongoDBBuilderExtensions.CreateReplicaSetKeyFile(builder, "mongo")) + .WithAnnotation(new MongoDBSingleMemberReplicaSetAnnotation("mongo")); + + using var app = builder.Build(); + using var cts = new CancellationTokenSource(TimeSpan.FromMinutes(3)); + await app.StartAsync(cts.Token); + await app.ResourceNotifications.WaitForResourceAsync(mongo.Resource.Name, KnownResourceStates.Running, cts.Token); + + var settings = MongoClientSettings.FromConnectionString(await mongo.Resource.ConnectionStringExpression.GetValueAsync(cts.Token)); + settings.ServerSelectionTimeout = TimeSpan.FromSeconds(2); + settings.ConnectTimeout = TimeSpan.FromSeconds(2); + using var client = new MongoClient(settings); + await MongoDBSingleMemberReplicaSet.InitializeAndWaitForPrimaryAsync( + client.GetDatabase(MongoDBServerResource.DefaultAuthenticationDatabase), "mongo", + $"localhost:{mongo.Resource.PrimaryEndpoint.TargetPort}", cts.Token); + + // A newly elected primary reports PRIMARY before it leaves drain mode and accepts writes. + await client.GetDatabase("writes").CreateCollectionAsync("items", cancellationToken: cts.Token); + + await app.StopAsync(); + } + [Fact] [RequiresFeature(TestFeature.ContainerRuntime)] public Task MongoExpressConnectsWithoutADeveloperCertificate() => VerifyMongoExpressAsync(useTls: false); diff --git a/tests/Aspire.Hosting.MongoDB.Tests/SingleMemberReplicaSetTests.cs b/tests/Aspire.Hosting.MongoDB.Tests/SingleMemberReplicaSetTests.cs index 0015628acbb..2b98fc1a052 100644 --- a/tests/Aspire.Hosting.MongoDB.Tests/SingleMemberReplicaSetTests.cs +++ b/tests/Aspire.Hosting.MongoDB.Tests/SingleMemberReplicaSetTests.cs @@ -189,20 +189,30 @@ public void IncompatibleDataIsRejectedWithoutReconfiguration(string json) } [Theory] - [InlineData("mongo", 1, 1, true)] - [InlineData("mongo", 2, 1, false)] - [InlineData("other", 1, 1, false)] - [InlineData("mongo", 1, 2, false)] - public void ReadinessRequiresTheSingleMemberPrimary(string name, int state, int memberCount, bool expected) + [InlineData("mongo", true, 1, true)] + // A newly elected primary is still draining: replSetGetStatus already reports PRIMARY, but writes are rejected. + [InlineData("mongo", false, 1, false)] + [InlineData("other", true, 1, false)] + [InlineData("mongo", true, 2, false)] + public void ReadinessRequiresTheSingleMemberWritablePrimary(string name, bool isWritablePrimary, int hostCount, bool expected) { - var status = new BsonDocument + var hello = new BsonDocument { - ["set"] = name, - ["myState"] = state, - ["members"] = new BsonArray(Enumerable.Range(0, memberCount).Select(id => new BsonDocument("_id", id))), + ["setName"] = name, + ["isWritablePrimary"] = isWritablePrimary, + ["hosts"] = new BsonArray(Enumerable.Range(0, hostCount).Select(id => $"localhost:{27017 + id}")), }; - Assert.Equal(expected, MongoDBSingleMemberReplicaSet.IsPrimary(status, "mongo")); + Assert.Equal(expected, MongoDBSingleMemberReplicaSet.IsWritablePrimary(hello, "mongo")); + } + + [Fact] + public void ReadinessRequiresAReplicaSetMember() + { + // A standalone mongod, or a member that has not been initiated yet, reports no setName or hosts. + var hello = new BsonDocument { ["isWritablePrimary"] = false }; + + Assert.False(MongoDBSingleMemberReplicaSet.IsWritablePrimary(hello, "mongo")); } [Fact]