Tests | Account for MAX_DISPATCH_LATENCY in XEvents tests (#3456)

* Account for MAX_DISPATCH_LATENCY in XEvents tests

XEvents are asynchronous, and are written to the target within MAX_DISPATCH_LATENCY seconds. We therefore need to wait that long before querying the target.

* Filter XEvent session by client_connection_id

Author: edwardneal

src/Microsoft.Data.SqlClient/tests/ManualTests/DataCommon/DataTestUtility.cs

@@ -1092,6 +1092,8 @@ protected virtual void OnMatchingEventWritten(EventWrittenEventArgs eventData)
 
         public readonly ref struct XEventScope // : IDisposable
         {
+            private const int MaxXEventsLatencyS = 5;
+
             private readonly SqlConnection _connection;
             private readonly bool _useDatabaseSession;
 
@@ -1126,6 +1128,8 @@ INNER JOIN sys.dm_xe_sessions AS xe
 
                 using (SqlCommand command = new SqlCommand(xEventQuery, _connection))
                 {
+                    Thread.Sleep(MaxXEventsLatencyS * 1000);
+
                     if (_connection.State == ConnectionState.Closed)
                     {
                         _connection.Open();
@@ -1146,9 +1150,9 @@ private void SetupXEvent(string eventSpecification, string targetSpecification)
                         {eventSpecification}
                         {targetSpecification}
                         WITH (
-                            MAX_MEMORY=4096 KB,
+                            MAX_MEMORY=16 MB,
                             EVENT_RETENTION_MODE=ALLOW_SINGLE_EVENT_LOSS,
-                            MAX_DISPATCH_LATENCY=30 SECONDS,
+                            MAX_DISPATCH_LATENCY={MaxXEventsLatencyS} SECONDS,
                             MAX_EVENT_SIZE=0 KB,
                             MEMORY_PARTITION_MODE=NONE,
                             TRACK_CAUSALITY=ON,

src/Microsoft.Data.SqlClient/tests/ManualTests/TracingTests/XEventsTracingTest.cs

@@ -21,37 +21,35 @@ public void XEventActivityIDConsistentWithTracing(string query, System.Data.Comm
             // where it can be recorded in an XEvent session. This is documented at:
             // https://learn.microsoft.com/en-us/sql/relational-databases/native-client/features/accessing-diagnostic-information-in-the-extended-events-log
 
-            using (SqlConnection xEventManagementConnection = new SqlConnection(DataTestUtility.TCPConnectionString))
-            using (DataTestUtility.XEventScope xEventSession = new DataTestUtility.XEventScope(xEventManagementConnection,
-                @"ADD EVENT SQL_STATEMENT_STARTING (ACTION (client_connection_id)),
-                ADD EVENT RPC_STARTING (ACTION (client_connection_id))",
-                "ADD TARGET ring_buffer"))
-            {
-                Guid connectionId;
-                HashSet<string> ids;
+            using SqlConnection activityConnection = new(DataTestUtility.TCPConnectionString);
+            activityConnection.Open();
 
-                using (DataTestUtility.MDSEventListener TraceListener = new())
-                using (SqlConnection connection = new(DataTestUtility.TCPConnectionString))
-                {
-                    connection.Open();
-                    connectionId = connection.ClientConnectionId;
+            Guid connectionId = activityConnection.ClientConnectionId;
+            HashSet<string> ids;
 
-                    using SqlCommand command = new(query, connection) { CommandType = commandType };
-                    using SqlDataReader reader = command.ExecuteReader();
-                    while (reader.Read())
-                    {
-                        // Flush data
-                    }
+            using SqlConnection xEventManagementConnection = new(DataTestUtility.TCPConnectionString);
+            using DataTestUtility.XEventScope xEventSession = new(xEventManagementConnection,
+                $@"ADD EVENT SQL_STATEMENT_STARTING (ACTION (client_connection_id) WHERE (client_connection_id='{connectionId}')),
+                    ADD EVENT RPC_STARTING (ACTION (client_connection_id) WHERE (client_connection_id='{connectionId}'))",
+                    "ADD TARGET ring_buffer");
 
-                    ids = TraceListener.ActivityIDs;
+            using (DataTestUtility.MDSEventListener TraceListener = new())
+            {
+                using SqlCommand command = new(query, activityConnection) { CommandType = commandType };
+                using SqlDataReader reader = command.ExecuteReader();
+                while (reader.Read())
+                {
+                    // Flush data
                 }
 
-                XmlDocument eventList = xEventSession.GetEvents();
-                // Get the associated activity ID from the XEvent session. We expect to see the same ID in the trace as well.
-                string activityId = GetCommandActivityId(query, xEvent, connectionId, eventList);
-
-                Assert.Contains(activityId, ids);
+                ids = TraceListener.ActivityIDs;
             }
+
+            XmlDocument eventList = xEventSession.GetEvents();
+            // Get the associated activity ID from the XEvent session. We expect to see the same ID in the trace as well.
+            string activityId = GetCommandActivityId(query, xEvent, connectionId, eventList);
+
+            Assert.Contains(activityId, ids);
         }
 
         private static string GetCommandActivityId(string commandText, string eventName, Guid connectionId, XmlDocument xEvents)