Bugs fixes so XEvent profiler isn't broken (#577)

* Fix a few issues with profiler method handlers

* Filter out profiler polling events

* Add a unit test for profiler events

* Add method comment headers

Author: kburtram

src/Microsoft.SqlTools.ServiceLayer/Profiler/Contracts/ProfilerEventsAvailableNotification.cs

@@ -11,7 +11,7 @@ namespace Microsoft.SqlTools.ServiceLayer.Profiler.Contracts
 {
     public class ProfilerEventsAvailableParams
     {
-        public string SessionId { get; set; }
+        public string OwnerUri { get; set; }
 
         public List<ProfilerEvent> Events { get; set; }
     }
@@ -23,5 +23,3 @@ public static readonly
             EventType<ProfilerEventsAvailableParams>.Create("profiler/eventsavailable");
     }
 }
-
-

src/Microsoft.SqlTools.ServiceLayer/Profiler/Contracts/StopProfilingRequest.cs

@@ -13,7 +13,7 @@ namespace Microsoft.SqlTools.ServiceLayer.Profiler.Contracts
     /// </summary>
     public class StopProfilingParams
     {
-        public string SessionId { get; set; }
+        public string OwnerUri { get; set; }
     }
 
     public class StopProfilingResult

src/Microsoft.SqlTools.ServiceLayer/Profiler/ProfilerService.cs

@@ -129,7 +129,7 @@ internal async Task HandleStartProfilingRequest(StartProfilingParams parameters,
 
                 if (connInfo != null)
                 {
-                    ProfilerSession session = StartSession(connInfo);
+                    ProfilerSession session = StartSession(parameters.OwnerUri, connInfo);
                     result.SessionId = session.SessionId;
                     result.Succeeded = true;
                 }
@@ -154,7 +154,7 @@ internal async Task HandleStopProfilingRequest(StopProfilingParams parameters, R
         {
             try
             {
-                monitor.StopMonitoringSession(parameters.SessionId);
+                monitor.StopMonitoringSession(parameters.OwnerUri);
                 await requestContext.SendResult(new StopProfilingResult
                 {
                     Succeeded = true
@@ -169,13 +169,13 @@ await requestContext.SendResult(new StopProfilingResult
         /// <summary>
         /// Starts a new profiler session for the provided connection
         /// </summary>
-        internal ProfilerSession StartSession(ConnectionInfo connInfo)
+        internal ProfilerSession StartSession(string sessionId, ConnectionInfo connInfo)
         {
             // create a new XEvent session and Profiler session
             var xeSession = this.XEventSessionFactory.CreateXEventSession(connInfo);
             var profilerSession = new ProfilerSession()
             {
-                SessionId = Guid.NewGuid().ToString(),
+                SessionId = sessionId,
                 XEventSession = xeSession
             };
 
@@ -208,15 +208,52 @@ public IXEventSession CreateXEventSession(ConnectionInfo connInfo)
         private static Session GetOrCreateSession(SqlStoreConnection connection, string sessionName)
         {
             XEStore store = new XEStore(connection);
-            Session session = store.Sessions["Profiler"];
+            Session session = store.Sessions[sessionName];
             // start the session if it isn't already running
+            if (session == null)
+            {
+                session = CreateSession(connection, sessionName);
+            }
+
             if (session != null && !session.IsRunning)
             {
                 session.Start();
             }
             return session;
         }
 
+        private static Session CreateSession(SqlStoreConnection connection, string sessionName)
+        {
+            string createSessionSql = 
+                @"
+                CREATE EVENT SESSION [Profiler] ON SERVER 
+                ADD EVENT sqlserver.attention(
+                    ACTION(package0.event_sequence,sqlserver.client_app_name,sqlserver.client_pid,sqlserver.database_id,sqlserver.nt_username,sqlserver.query_hash,sqlserver.server_principal_name,sqlserver.session_id)
+                    WHERE ([package0].[equal_boolean]([sqlserver].[is_system],(0)))),
+                ADD EVENT sqlserver.existing_connection(SET collect_options_text=(1)
+                    ACTION(package0.event_sequence,sqlserver.client_app_name,sqlserver.client_pid,sqlserver.nt_username,sqlserver.server_principal_name,sqlserver.session_id)),
+                ADD EVENT sqlserver.login(SET collect_options_text=(1)
+                    ACTION(package0.event_sequence,sqlserver.client_app_name,sqlserver.client_pid,sqlserver.nt_username,sqlserver.server_principal_name,sqlserver.session_id)),
+                ADD EVENT sqlserver.logout(
+                    ACTION(package0.event_sequence,sqlserver.client_app_name,sqlserver.client_pid,sqlserver.nt_username,sqlserver.server_principal_name,sqlserver.session_id)),
+                ADD EVENT sqlserver.rpc_completed(
+                    ACTION(package0.event_sequence,sqlserver.client_app_name,sqlserver.client_pid,sqlserver.database_id,sqlserver.nt_username,sqlserver.query_hash,sqlserver.server_principal_name,sqlserver.session_id)
+                    WHERE ([package0].[equal_boolean]([sqlserver].[is_system],(0)))),
+                ADD EVENT sqlserver.sql_batch_completed(
+                    ACTION(package0.event_sequence,sqlserver.client_app_name,sqlserver.client_pid,sqlserver.database_id,sqlserver.nt_username,sqlserver.query_hash,sqlserver.server_principal_name,sqlserver.session_id)
+                    WHERE ([package0].[equal_boolean]([sqlserver].[is_system],(0)))),
+                ADD EVENT sqlserver.sql_batch_starting(
+                    ACTION(package0.event_sequence,sqlserver.client_app_name,sqlserver.client_pid,sqlserver.database_id,sqlserver.nt_username,sqlserver.query_hash,sqlserver.server_principal_name,sqlserver.session_id)
+                    WHERE ([package0].[equal_boolean]([sqlserver].[is_system],(0))))
+                ADD TARGET package0.ring_buffer(SET max_events_limit=(1000),max_memory=(51200))
+                WITH (MAX_MEMORY=8192 KB,EVENT_RETENTION_MODE=ALLOW_SINGLE_EVENT_LOSS,MAX_DISPATCH_LATENCY=5 SECONDS,MAX_EVENT_SIZE=0 KB,MEMORY_PARTITION_MODE=PER_CPU,TRACK_CAUSALITY=ON,STARTUP_STATE=OFF)";
+
+            connection.ServerConnection.ExecuteNonQuery(createSessionSql);
+
+            XEStore store = new XEStore(connection);
+            return store.Sessions[sessionName];            
+        }
+
         /// <summary>
         /// Callback when profiler events are available
         /// </summary>
@@ -227,7 +264,7 @@ public void EventsAvailable(string sessionId, List<ProfilerEvent> events)
                 ProfilerEventsAvailableNotification.Type,
                 new ProfilerEventsAvailableParams()
                 {
-                    SessionId = sessionId,
+                    OwnerUri = sessionId,
                     Events = events
                 });
         }

src/Microsoft.SqlTools.ServiceLayer/Profiler/ProfilerSession.cs

@@ -89,6 +89,42 @@ public TimeSpan PollingDelay
             }
         }
 
+        /// <summary>
+        /// Determine if an event was caused by the XEvent polling queries
+        /// </summary>
+        private bool IsProfilerEvent(ProfilerEvent currentEvent)
+        {
+            if (string.IsNullOrWhiteSpace(currentEvent.Name) ||  currentEvent.Values == null)
+            {
+                return false;
+            }
+
+            if ((currentEvent.Name.Equals("sql_batch_completed")
+                || currentEvent.Name.Equals("sql_batch_starting"))
+                && currentEvent.Values.ContainsKey("batch_text"))
+            {
+                return currentEvent.Values["batch_text"].Contains("SELECT target_data FROM sys.dm_xe_session_targets");
+            }
+
+            return false;
+        }
+        
+        /// <summary>
+        /// Removed profiler polling events from event list
+        /// </summary>        
+        public List<ProfilerEvent> FilterProfilerEvents(List<ProfilerEvent> events)
+        {
+            int idx = events.Count;
+            while (--idx >= 0)
+            {               
+                if (IsProfilerEvent(events[idx]))
+                {
+                    events.RemoveAt(idx);
+                }
+            }
+            return events;
+        }
+
         /// <summary>
         /// Filter the event list to not include previously seen events
         /// </summary>

src/Microsoft.SqlTools.ServiceLayer/Profiler/ProfilerSessionMonitor.cs

@@ -160,7 +160,9 @@ private List<ProfilerEvent> PollSession(ProfilerSession session)
                 session.IsPolling = false;
             }
 
-            return session.FilterOldEvents(events);
+            return session.FilterProfilerEvents(
+                session.FilterOldEvents(events)
+            );
         }
 
         /// <summary>

src/Microsoft.SqlTools.ServiceLayer/Workspace/Workspace.cs

@@ -104,7 +104,8 @@ public virtual ScriptFile GetFile(string filePath)
             if (!this.workspaceFiles.TryGetValue(keyName, out scriptFile))
             {
                 if (IsUntitled(resolvedFile.FilePath)
-                    || !resolvedFile.CanReadFromDisk)
+                    || !resolvedFile.CanReadFromDisk
+                    || !File.Exists(resolvedFile.FilePath))
                 {
                     // It's either not a registered untitled file, or not a valid file on disk
                     // so any attempt to read from disk will fail.

test/Microsoft.SqlTools.ServiceLayer.UnitTests/Profiler/ProfilerSessionTests.cs

@@ -48,6 +48,30 @@ public void TestFilterOldEvents()
             Assert.Equal(newProfilerEvents.Count, 0);
         }
 
+
+        /// <summary>
+        /// Test the FilterProfilerEvents method
+        /// </summary>
+        [Fact]
+        public void TestFilterProfilerEvents()
+        {
+            // create a profiler session and get some test events
+            var profilerSession = new ProfilerSession();
+            var profilerEvents = ProfilerTestObjects.TestProfilerEvents;
+                        
+            int expectedEventCount = profilerEvents.Count;
+                        
+            // add a new "Profiler Polling" event
+            var newEvent = new ProfilerEvent("sql_batch_completed", "1/1/2017");
+            newEvent.Values.Add("batch_text", "SELECT target_data FROM sys.dm_xe_session_targets");
+            profilerEvents.Add(newEvent);
+
+            // verify that the polling event is removed
+            Assert.Equal(profilerEvents.Count, expectedEventCount + 1);
+            var newProfilerEvents = profilerSession.FilterProfilerEvents(profilerEvents);
+            Assert.Equal(newProfilerEvents.Count, expectedEventCount);           
+        }
+
         /// <summary>
         /// Test the TryEnterPolling method
         /// </summary>