CSHARP-1481: Raise Cluster DescriptionChanged events in a predictable order and one at a time during Initialize.

rstam · rstam · commit 62ad0e24a5da · 2015-11-18T16:10:00.000-05:00
diff --git a/src/MongoDB.Driver.Core.Tests/Core/Clusters/MultiServerClusterTests.cs b/src/MongoDB.Driver.Core.Tests/Core/Clusters/MultiServerClusterTests.cs
@@ -87,8 +87,8 @@ public void Description_should_be_correct_after_initialization()
             _capturedEvents.Next().Should().BeOfType<ClusterOpeningEvent>();
             _capturedEvents.Next().Should().BeOfType<ClusterAddingServerEvent>();
             _capturedEvents.Next().Should().BeOfType<ClusterAddedServerEvent>();
-            _capturedEvents.Next().Should().BeOfType<ClusterOpenedEvent>();
             _capturedEvents.Next().Should().BeOfType<ClusterDescriptionChangedEvent>();
+            _capturedEvents.Next().Should().BeOfType<ClusterOpenedEvent>();
             _capturedEvents.Any().Should().BeFalse();
         }
 
@@ -536,8 +536,8 @@ public void Should_call_initialize_on_all_servers()
             _capturedEvents.Next().Should().BeOfType<ClusterAddedServerEvent>();
             _capturedEvents.Next().Should().BeOfType<ClusterAddingServerEvent>();
             _capturedEvents.Next().Should().BeOfType<ClusterAddedServerEvent>();
-            _capturedEvents.Next().Should().BeOfType<ClusterOpenedEvent>();
             _capturedEvents.Next().Should().BeOfType<ClusterDescriptionChangedEvent>();
+            _capturedEvents.Next().Should().BeOfType<ClusterOpenedEvent>();
             _capturedEvents.Next().Should().BeOfType<ClusterAddingServerEvent>();
             _capturedEvents.Next().Should().BeOfType<ClusterAddedServerEvent>();
             _capturedEvents.Next().Should().BeOfType<ClusterDescriptionChangedEvent>();
diff --git a/src/MongoDB.Driver.Core.Tests/Core/Clusters/SingleServerClusterTests.cs b/src/MongoDB.Driver.Core.Tests/Core/Clusters/SingleServerClusterTests.cs
@@ -74,8 +74,8 @@ public void Initialize_should_create_and_initialize_the_server()
             _capturedEvents.Next().Should().BeOfType<ClusterOpeningEvent>();
             _capturedEvents.Next().Should().BeOfType<ClusterAddingServerEvent>();
             _capturedEvents.Next().Should().BeOfType<ClusterAddedServerEvent>();
-            _capturedEvents.Next().Should().BeOfType<ClusterOpenedEvent>();
             _capturedEvents.Next().Should().BeOfType<ClusterDescriptionChangedEvent>();
+            _capturedEvents.Next().Should().BeOfType<ClusterOpenedEvent>();
             _capturedEvents.Any().Should().BeFalse();
         }
 
diff --git a/src/MongoDB.Driver.Core/Core/Clusters/MultiServerCluster.cs b/src/MongoDB.Driver.Core/Core/Clusters/MultiServerCluster.cs
@@ -135,22 +135,28 @@ public override void Initialize()
                 // but could prevent issues of conflicting reports
                 // from servers that are quick to respond.
                 var clusterDescription = Description;
+                var newServers = new List<IClusterableServer>();
                 lock (_serversLock)
                 {
                     foreach (var endPoint in Settings.EndPoints)
                     {
-                        clusterDescription = EnsureServer(clusterDescription, endPoint);
+                        clusterDescription = EnsureServer(clusterDescription, endPoint, newServers);
                     }
                 }
 
                 stopwatch.Stop();
 
+                UpdateClusterDescription(clusterDescription);
+
+                foreach (var server in newServers)
+                {
+                    server.Initialize();
+                }
+
                 if (_openedEventHandler != null)
                 {
                     _openedEventHandler(new ClusterOpenedEvent(ClusterId, Settings, stopwatch.Elapsed));
                 }
-
-                UpdateClusterDescription(clusterDescription);
             }
         }
 
@@ -240,6 +246,7 @@ private void ProcessServerDescriptionChanged(ServerDescriptionChangedEventArgs a
                 return;
             }
 
+            var newServers = new List<IClusterableServer>();
             if (newServerDescription.State == ServerState.Disconnected)
             {
                 newClusterDescription = newClusterDescription.WithServerDescription(newServerDescription);
@@ -256,7 +263,7 @@ private void ProcessServerDescriptionChanged(ServerDescriptionChangedEventArgs a
                     switch (newClusterDescription.Type)
                     {
                         case ClusterType.ReplicaSet:
-                            newClusterDescription = ProcessReplicaSetChange(newClusterDescription, args);
+                            newClusterDescription = ProcessReplicaSetChange(newClusterDescription, args, newServers);
                             break;
 
                         case ClusterType.Sharded:
@@ -274,9 +281,14 @@ private void ProcessServerDescriptionChanged(ServerDescriptionChangedEventArgs a
             }
 
             UpdateClusterDescription(newClusterDescription);
+
+            foreach (var server in newServers)
+            {
+                server.Initialize();
+            }
         }
 
-        private ClusterDescription ProcessReplicaSetChange(ClusterDescription clusterDescription, ServerDescriptionChangedEventArgs args)
+        private ClusterDescription ProcessReplicaSetChange(ClusterDescription clusterDescription, ServerDescriptionChangedEventArgs args, List<IClusterableServer> newServers)
         {
             if (!args.NewServerDescription.Type.IsReplicaSetMember())
             {
@@ -299,7 +311,7 @@ private ClusterDescription ProcessReplicaSetChange(ClusterDescription clusterDes
             }
 
             clusterDescription = clusterDescription.WithServerDescription(args.NewServerDescription);
-            clusterDescription = EnsureServers(clusterDescription, args.NewServerDescription);
+            clusterDescription = EnsureServers(clusterDescription, args.NewServerDescription, newServers);
 
             if (args.NewServerDescription.CanonicalEndPoint != null &&
                 !EndPointHelper.Equals(args.NewServerDescription.CanonicalEndPoint, args.NewServerDescription.EndPoint))
@@ -362,7 +374,7 @@ private ClusterDescription ProcessShardedChange(ClusterDescription clusterDescri
             return clusterDescription.WithServerDescription(args.NewServerDescription);
         }
 
-        private ClusterDescription EnsureServer(ClusterDescription clusterDescription, EndPoint endPoint)
+        private ClusterDescription EnsureServer(ClusterDescription clusterDescription, EndPoint endPoint, List<IClusterableServer> newServers)
         {
             if (_state.Value == State.Disposed)
             {
@@ -387,10 +399,10 @@ private ClusterDescription EnsureServer(ClusterDescription clusterDescription, E
                 server = CreateServer(endPoint);
                 server.DescriptionChanged += ServerDescriptionChangedHandler;
                 _servers.Add(server);
+                newServers.Add(server);
             }
 
             clusterDescription = clusterDescription.WithServerDescription(server.Description);
-            server.Initialize();
             stopwatch.Stop();
 
             if (_addedServerEventHandler != null)
@@ -401,14 +413,14 @@ private ClusterDescription EnsureServer(ClusterDescription clusterDescription, E
             return clusterDescription;
         }
 
-        private ClusterDescription EnsureServers(ClusterDescription clusterDescription, ServerDescription serverDescription)
+        private ClusterDescription EnsureServers(ClusterDescription clusterDescription, ServerDescription serverDescription, List<IClusterableServer> newServers)
         {
             if (serverDescription.Type == ServerType.ReplicaSetPrimary ||
                 !clusterDescription.Servers.Any(x => x.Type == ServerType.ReplicaSetPrimary))
             {
                 foreach (var endPoint in serverDescription.ReplicaSetConfig.Members)
                 {
-                    clusterDescription = EnsureServer(clusterDescription, endPoint);
+                    clusterDescription = EnsureServer(clusterDescription, endPoint, newServers);
                 }
             }
 
diff --git a/src/MongoDB.Driver.Core/Core/Clusters/SingleServerCluster.cs b/src/MongoDB.Driver.Core/Core/Clusters/SingleServerCluster.cs
@@ -118,19 +118,21 @@ public override void Initialize()
                     _addingServerEventHandler(new ClusterAddingServerEvent(ClusterId, _server.EndPoint));
                 }
                 _server.DescriptionChanged += ServerDescriptionChanged;
-                _server.Initialize();
                 stopwatch.Stop();
 
                 if (_addedServerEventHandler != null)
                 {
                     _addedServerEventHandler(new ClusterAddedServerEvent(_server.ServerId, stopwatch.Elapsed));
                 }
+
+                UpdateClusterDescription(newClusterDescription);
+
+                _server.Initialize();
+
                 if (_openedEventHandler != null)
                 {
                     _openedEventHandler(new ClusterOpenedEvent(ClusterId, Settings, stopwatch.Elapsed));
                 }
-
-                UpdateClusterDescription(newClusterDescription);
             }
         }
 

Original file line number	Diff line number	Diff line change
`@@ -74,8 +74,8 @@ public void Initialize_should_create_and_initialize_the_server()`
`74`	`74`	`_capturedEvents.Next().Should().BeOfType<ClusterOpeningEvent>();`
`75`	`75`	`_capturedEvents.Next().Should().BeOfType<ClusterAddingServerEvent>();`
`76`	`76`	`_capturedEvents.Next().Should().BeOfType<ClusterAddedServerEvent>();`
`77`		`- _capturedEvents.Next().Should().BeOfType<ClusterOpenedEvent>();`
`78`	`77`	`_capturedEvents.Next().Should().BeOfType<ClusterDescriptionChangedEvent>();`
	`78`	`+ _capturedEvents.Next().Should().BeOfType<ClusterOpenedEvent>();`
`79`	`79`	`_capturedEvents.Any().Should().BeFalse();`
`80`	`80`	`}`
`81`	`81`
Original file line number	Diff line number	Diff line change
`@@ -135,22 +135,28 @@ public override void Initialize()`
`135`	`135`	`// but could prevent issues of conflicting reports`
`136`	`136`	`// from servers that are quick to respond.`
`137`	`137`	`var clusterDescription = Description;`
	`138`	`+ var newServers = new List<IClusterableServer>();`
`138`	`139`	`lock (_serversLock)`
`139`	`140`	`{`
`140`	`141`	`foreach (var endPoint in Settings.EndPoints)`
`141`	`142`	`{`
`142`		`- clusterDescription = EnsureServer(clusterDescription, endPoint);`
	`143`	`+ clusterDescription = EnsureServer(clusterDescription, endPoint, newServers);`
`143`	`144`	`}`
`144`	`145`	`}`
`145`	`146`
`146`	`147`	`stopwatch.Stop();`
`147`	`148`
	`149`	`+ UpdateClusterDescription(clusterDescription);`
	`150`	`+`
	`151`	`+ foreach (var server in newServers)`
	`152`	`+ {`
	`153`	`+ server.Initialize();`
	`154`	`+ }`
	`155`	`+`
`148`	`156`	`if (_openedEventHandler != null)`
`149`	`157`	`{`
`150`	`158`	`_openedEventHandler(new ClusterOpenedEvent(ClusterId, Settings, stopwatch.Elapsed));`
`151`	`159`	`}`
`152`		`-`
`153`		`- UpdateClusterDescription(clusterDescription);`
`154`	`160`	`}`
`155`	`161`	`}`
`156`	`162`
`@@ -240,6 +246,7 @@ private void ProcessServerDescriptionChanged(ServerDescriptionChangedEventArgs a`
`240`	`246`	`return;`
`241`	`247`	`}`
`242`	`248`
	`249`	`+ var newServers = new List<IClusterableServer>();`
`243`	`250`	`if (newServerDescription.State == ServerState.Disconnected)`
`244`	`251`	`{`
`245`	`252`	`newClusterDescription = newClusterDescription.WithServerDescription(newServerDescription);`
`@@ -256,7 +263,7 @@ private void ProcessServerDescriptionChanged(ServerDescriptionChangedEventArgs a`
`256`	`263`	`switch (newClusterDescription.Type)`
`257`	`264`	`{`
`258`	`265`	`case ClusterType.ReplicaSet:`
`259`		`- newClusterDescription = ProcessReplicaSetChange(newClusterDescription, args);`
	`266`	`+ newClusterDescription = ProcessReplicaSetChange(newClusterDescription, args, newServers);`
`260`	`267`	`break;`
`261`	`268`
`262`	`269`	`case ClusterType.Sharded:`
`@@ -274,9 +281,14 @@ private void ProcessServerDescriptionChanged(ServerDescriptionChangedEventArgs a`
`274`	`281`	`}`
`275`	`282`
`276`	`283`	`UpdateClusterDescription(newClusterDescription);`
	`284`	`+`
	`285`	`+ foreach (var server in newServers)`
	`286`	`+ {`
	`287`	`+ server.Initialize();`
	`288`	`+ }`
`277`	`289`	`}`
`278`	`290`
`279`		`- private ClusterDescription ProcessReplicaSetChange(ClusterDescription clusterDescription, ServerDescriptionChangedEventArgs args)`
	`291`	`+ private ClusterDescription ProcessReplicaSetChange(ClusterDescription clusterDescription, ServerDescriptionChangedEventArgs args, List<IClusterableServer> newServers)`
`280`	`292`	`{`
`281`	`293`	`if (!args.NewServerDescription.Type.IsReplicaSetMember())`
`282`	`294`	`{`
`@@ -299,7 +311,7 @@ private ClusterDescription ProcessReplicaSetChange(ClusterDescription clusterDes`
`299`	`311`	`}`
`300`	`312`
`301`	`313`	`clusterDescription = clusterDescription.WithServerDescription(args.NewServerDescription);`
`302`		`- clusterDescription = EnsureServers(clusterDescription, args.NewServerDescription);`
	`314`	`+ clusterDescription = EnsureServers(clusterDescription, args.NewServerDescription, newServers);`
`303`	`315`
`304`	`316`	`if (args.NewServerDescription.CanonicalEndPoint != null &&`
`305`	`317`	`!EndPointHelper.Equals(args.NewServerDescription.CanonicalEndPoint, args.NewServerDescription.EndPoint))`
`@@ -362,7 +374,7 @@ private ClusterDescription ProcessShardedChange(ClusterDescription clusterDescri`
`362`	`374`	`return clusterDescription.WithServerDescription(args.NewServerDescription);`
`363`	`375`	`}`
`364`	`376`
`365`		`- private ClusterDescription EnsureServer(ClusterDescription clusterDescription, EndPoint endPoint)`
	`377`	`+ private ClusterDescription EnsureServer(ClusterDescription clusterDescription, EndPoint endPoint, List<IClusterableServer> newServers)`
`366`	`378`	`{`
`367`	`379`	`if (_state.Value == State.Disposed)`
`368`	`380`	`{`
`@@ -387,10 +399,10 @@ private ClusterDescription EnsureServer(ClusterDescription clusterDescription, E`
`387`	`399`	`server = CreateServer(endPoint);`
`388`	`400`	`server.DescriptionChanged += ServerDescriptionChangedHandler;`
`389`	`401`	`_servers.Add(server);`
	`402`	`+ newServers.Add(server);`
`390`	`403`	`}`
`391`	`404`
`392`	`405`	`clusterDescription = clusterDescription.WithServerDescription(server.Description);`
`393`		`- server.Initialize();`
`394`	`406`	`stopwatch.Stop();`
`395`	`407`
`396`	`408`	`if (_addedServerEventHandler != null)`
`@@ -401,14 +413,14 @@ private ClusterDescription EnsureServer(ClusterDescription clusterDescription, E`
`401`	`413`	`return clusterDescription;`
`402`	`414`	`}`
`403`	`415`
`404`		`- private ClusterDescription EnsureServers(ClusterDescription clusterDescription, ServerDescription serverDescription)`
	`416`	`+ private ClusterDescription EnsureServers(ClusterDescription clusterDescription, ServerDescription serverDescription, List<IClusterableServer> newServers)`
`405`	`417`	`{`
`406`	`418`	`if (serverDescription.Type == ServerType.ReplicaSetPrimary \|\|`
`407`	`419`	`!clusterDescription.Servers.Any(x => x.Type == ServerType.ReplicaSetPrimary))`
`408`	`420`	`{`
`409`	`421`	`foreach (var endPoint in serverDescription.ReplicaSetConfig.Members)`
`410`	`422`	`{`
`411`		`- clusterDescription = EnsureServer(clusterDescription, endPoint);`
	`423`	`+ clusterDescription = EnsureServer(clusterDescription, endPoint, newServers);`
`412`	`424`	`}`
`413`	`425`	`}`
`414`	`426`
Original file line number	Diff line number	Diff line change
`@@ -118,19 +118,21 @@ public override void Initialize()`
`118`	`118`	`_addingServerEventHandler(new ClusterAddingServerEvent(ClusterId, _server.EndPoint));`
`119`	`119`	`}`
`120`	`120`	`_server.DescriptionChanged += ServerDescriptionChanged;`
`121`		`- _server.Initialize();`
`122`	`121`	`stopwatch.Stop();`
`123`	`122`
`124`	`123`	`if (_addedServerEventHandler != null)`
`125`	`124`	`{`
`126`	`125`	`_addedServerEventHandler(new ClusterAddedServerEvent(_server.ServerId, stopwatch.Elapsed));`
`127`	`126`	`}`
	`127`	`+`
	`128`	`+ UpdateClusterDescription(newClusterDescription);`
	`129`	`+`
	`130`	`+ _server.Initialize();`
	`131`	`+`
`128`	`132`	`if (_openedEventHandler != null)`
`129`	`133`	`{`
`130`	`134`	`_openedEventHandler(new ClusterOpenedEvent(ClusterId, Settings, stopwatch.Elapsed));`
`131`	`135`	`}`
`132`		`-`
`133`		`- UpdateClusterDescription(newClusterDescription);`
`134`	`136`	`}`
`135`	`137`	`}`
`136`	`138`