Unlock 30% off on Manual Testing Annual Plans this Holiday Season.

Copied to Clipboard!

How to use FastHeaderParse method of Microsoft.VisualStudio.TestPlatform.CommunicationUtilities.JsonDataSerializer class

Best Vstest code snippet using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities.JsonDataSerializer.FastHeaderParse

JsonDataSerializer.cs

Source:JsonDataSerializer.cs

...82            return Deserialize<VersionedMessage>(rawMessage)!;83        }84        // PERF: Try grabbing the version and message type from the string directly, we are pretty certain how the message is serialized85        // when the format does not match all we do is that we check if 6th character in the message is 'V'86        if (!FastHeaderParse(rawMessage, out int version, out string? messageType))87        {88            // PERF: If the fast path fails, deserialize into header object that does not have any Payload. When the message type info89            // is at the start of the message, this is also pretty fast. Again, this won't touch the payload.90            MessageHeader header = JsonConvert.DeserializeObject<MessageHeader>(rawMessage, JsonSettings)!;91            version = header.Version;92            messageType = header.MessageType;93        }94        var message = new VersionedMessageWithRawMessage95        {96            Version = version,97            MessageType = messageType,98            RawMessage = rawMessage,99        };100        return message;101    }102    /// <summary>103    /// Deserialize the <see cref="Message.Payload"/> for a message.104    /// </summary>105    /// <param name="message">A <see cref="Message"/> object.</param>106    /// <typeparam name="T">Payload type.</typeparam>107    /// <returns>The deserialized payload.</returns>108    public T? DeserializePayload<T>(Message? message)109    {110        if (message is null)111        {112            return default;113        }114        if (message.GetType() == typeof(Message))115        {116            // Message is specifically a Message, and not any of it's child types like VersionedMessage.117            // Get the default serializer and deserialize. This would be used for any message from very old test host.118            //119            // Unit tests also provide a Message in places where using the deserializer would actually120            // produce a VersionedMessage or VersionedMessageWithRawMessage.121            var serializerV1 = GetPayloadSerializer(null);122            TPDebug.Assert(message.Payload is not null, "Payload should not be null");123            return Deserialize<T>(serializerV1, message.Payload);124        }125        var versionedMessage = (VersionedMessage)message;126        var payloadSerializer = GetPayloadSerializer(versionedMessage.Version);127        if (DisableFastJson)128        {129            // When fast json is disabled, then the message is a VersionedMessage130            // with JToken payload.131            TPDebug.Assert(message.Payload is not null, "Payload should not be null");132            return Deserialize<T>(payloadSerializer, message.Payload);133        }134        // When fast json is enabled then the message is also a subtype of VersionedMessage, but135        // the Payload is not populated, and instead the rawMessage string it passed as is.136        var messageWithRawMessage = (VersionedMessageWithRawMessage)message;137        var rawMessage = messageWithRawMessage.RawMessage;138        if (rawMessage == null)139        {140            return default;141        }142        // The deserialized message can still have a version (0 or 1), that should use the old deserializer143        if (payloadSerializer == PayloadSerializerV2)144        {145            // PERF: Fast path is compatibile only with protocol versions that use serializer_2,146            // and this is faster than deserializing via deserializer_2.147            var messageWithPayload = JsonConvert.DeserializeObject<PayloadedMessage<T>>(rawMessage, FastJsonSettings);148            return messageWithPayload == null ? default : messageWithPayload.Payload;149        }150        else151        {152            // PERF: When payloadSerializer1 was resolved we need to deserialize JToken, and then deserialize that.153            // This is still better than deserializing the JToken in DeserializeMessage because here we know that the payload154            // will actually be used.155            TPDebug.Assert(rawMessage is not null, "rawMessage should not be null");156            var rawMessagePayload = Deserialize<Message>(rawMessage)?.Payload;157            TPDebug.Assert(rawMessagePayload is not null, "rawMessagePayload should not be null");158            return Deserialize<T>(payloadSerializer, rawMessagePayload);159        }160    }161    private static bool FastHeaderParse(string rawMessage, out int version, out string? messageType)162    {163        // PERF: This can be also done slightly better using ReadOnlySpan<char> but we don't have that available by default in .NET Framework164        // and the speed improvement does not warrant additional dependency. This is already taking just few ms for 10k messages.165        version = 0;166        messageType = null;167        try168        {169            // The incoming messages look like this, or like this:170            // {"Version":6,"MessageType":"TestExecution.GetTestRunnerProcessStartInfoForRunAll","Payload":{171            // {"MessageType":"TestExecution.GetTestRunnerProcessStartInfoForRunAll","Payload":{172            if (rawMessage.Length < 31)173            {174                // {"MessageType":"T","Payload":1} with length 31 is the smallest valid message we should be able to parse..175                return false;...

FastHeaderParse

Using AI Code Generation

1using System;2using System.Collections.Generic;3using System.Linq;4using System.Text;5using System.Threading.Tasks;6using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities;7{8    {9        static void Main(string[] args)10        {11            string json = "{\"MessageType\":\"TestRunStatsChange\",\"Payload\":{\"NewStats\":{\"ExecutedTests\":1,\"PassedTests\":1,\"FailedTests\":0,\"SkippedTests\":0,\"PendingTests\":0,\"TotalTests\":1}}}";12            var result = JsonDataSerializer.FastHeaderParse(json);13            Console.WriteLine("MessageType: {0}", result.Item1);14            Console.WriteLine("Payload: {0}", result.Item2);15            Console.ReadLine();16        }17    }18}19Payload: {"NewStats":{"ExecutedTests":1,"PassedTests":1,"FailedTests":0,"SkippedTests":0,"PendingTests":0,"TotalTests":1}}

FastHeaderParse

Using AI Code Generation

1using System;2using System.Collections.Generic;3using System.Linq;4using System.Text;5using System.Threading.Tasks;6using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities;7{8    {9        static void Main(string[] args)10        {11            byte[] bytes = new byte[100];12            JsonDataSerializer serializer = new JsonDataSerializer();13            serializer.FastHeaderParse(bytes);14        }15    }16}

FastHeaderParse

Using AI Code Generation

1using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities;2using Microsoft.VisualStudio.TestPlatform.ObjectModel;3using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;4using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;5using System;6using System.Collections.Generic;7using System.Linq;8using System.Text;9using System.Threading.Tasks;10{11    {12        public void Initialize(TestLoggerEvents events, string testRunDirectory)13        {14            events.TestRunMessage += Events_TestRunMessage;15        }16        private void Events_TestRunMessage(object sender, TestRunMessageEventArgs e)17        {18            if (e.Level == TestMessageLevel.Informational)19            {20                var json = JsonDataSerializer.Instance.FastHeaderParse(e.Message);21                if (json != null)22                {23                    Console.WriteLine("Message: {0}", json["Message"]);24                }25            }26        }27    }28}29using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities;30using Microsoft.VisualStudio.TestPlatform.ObjectModel;31using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;32using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;33using System;34using System.Collections.Generic;35using System.Linq;36using System.Text;37using System.Threading.Tasks;38{39    {40        public void Initialize(TestLoggerEvents events, string testRunDirectory)41        {42            events.TestRunMessage += Events_TestRunMessage;43        }44        private void Events_TestRunMessage(object sender, TestRunMessageEventArgs e)45        {46            if (e.Level == TestMessageLevel.Informational)47            {48                var json = JsonDataSerializer.Instance.FastHeaderParse(e.Message);49                if (json != null)50                {51                    Console.WriteLine("Message: {0}", json["Message"]);52                }53            }54        }55    }56}57using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities;58using Microsoft.VisualStudio.TestPlatform.ObjectModel;59using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;60using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;61using System;62using System.Collections.Generic;63using System.Linq;64using System.Text;65using System.Threading.Tasks;66{67    {68        public void Initialize(TestLoggerEvents events, string testRunDirectory)

FastHeaderParse

Using AI Code Generation

1using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities;2using Microsoft.VisualStudio.TestPlatform.ObjectModel;3using System;4using System.Collections.Generic;5using System.Linq;6using System.Text;7using System.Threading.Tasks;8{9    {10        static void Main(string[] args)11        {12            string json = @"{13                ""Payload"": {14                }15            }";16            var data = JsonDataSerializer.Instance.FastHeaderParse(json);17            Console.WriteLine(data.Version);18            Console.WriteLine(data.MessageType);19            Console.WriteLine(data.Payload);20            Console.ReadLine();21        }22    }23}24{25}

FastHeaderParse

Using AI Code Generation

1using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities;2using Microsoft.VisualStudio.TestPlatform.ObjectModel;3using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;4using System;5using System.IO;6using System.Text;7{8    {9        static void Main(string[] args)10        {11            string json = @"{""MessageType"":""TestRunMessage"",""Payload"":{""MessageLevel"":""Informational"",""Message"":""Starting test execution, please wait..."",""Version"":""

FastHeaderParse

Using AI Code Generation

1using System;2using System.Collections.Generic;3using System.Linq;4using System.Text;5using System.Threading.Tasks;6using Microsoft.VisualStudio.TestPlatform.CommunicationUtilities;7using Microsoft.VisualStudio.TestPlatform.ObjectModel;8using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;9using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;10{11    {12        static void Main(string[] args)13        {14            var serializer = new JsonDataSerializer();15            var data = new Dictionary<string, object>();16            data.Add("TestRunCompletePayload", new TestRunCompletePayload());17            data.Add("TestRunStatistics", new TestRunStatistics());18            data.Add("TestRunChangedEventArgs", new TestRunChangedEventArgs());19            data.Add("TestRunMessagePayload", new TestRunMessagePayload());20            data.Add("DiscoveryCompleteEventArgs", new DiscoveryCompleteEventArgs());21            data.Add("TestRunCompleteEventArgs", new TestRunCompleteEventArgs());22            data.Add("TestRunChangedEventArgs", new TestRunChangedEventArgs());23            data.Add("TestRunMessageEventArgs", new TestRunMessageEventArgs());24            data.Add("TestRunStartEventArgs", new TestRunStartEventArgs());25            data.Add("TestSessionMessageEventArgs", new TestSessionMessageEventArgs());26            data.Add("DiscoveryCompletePayload", new DiscoveryCompletePayload());27            data.Add("DiscoveryMessagePayload", new DiscoveryMessagePayload());28            data.Add("DiscoveryRequestPayload", new DiscoveryRequestPayload());29            data.Add("DiscoveryResultPayload", new DiscoveryResultPayload());30            data.Add("TestRunCompletePayload", new TestRunCompletePayload());31            data.Add("TestRunMessagePayload", new TestRunMessagePayload());32            data.Add("TestRunRequestPayload", new TestRunRequestPayload());33            data.Add("TestRunStartPayload", new TestRunStartPayload());34            data.Add("TestRunStatisticsPayload", new TestRunStatisticsPayload());35            data.Add("TestSessionMessagePayload", new TestSessionMessagePayload());36            data.Add("TestSessionStartPayload", new TestSessionStartPayload());37            data.Add("TestSessionMessageEventArgs", new TestSessionMessageEventArgs());38            data.Add("TestSessionStartEventArgs", new TestSessionStartEventArgs());39            data.Add("TestRunStartEventArgs", new TestRunStartEventArgs());40            data.Add("TestRunCompleteEventArgs", new TestRunCompleteEventArgs());41            data.Add("TestRunChangedEventArgs", new TestRunChangedEventArgs());42            data.Add("TestRunMessageEventArgs", new TestRunMessageEventArgs());43            data.Add("DiscoveryCompleteEventArgs", new Discovery

FastHeaderParse

Using AI Code Generation

1var jsonSerializer = new JsonDataSerializer();2var header = jsonSerializer.FastHeaderParse(message);3var jsonSerializer = new JsonDataSerializer();4var payload = jsonSerializer.FastPayloadParse<T>(message);5var jsonSerializer = new JsonDataSerializer();6var payload = jsonSerializer.FastPayloadParse(message);7var jsonSerializer = new JsonDataSerializer();8var payload = jsonSerializer.FastPayloadParse<T>(message);9var jsonSerializer = new JsonDataSerializer();10var payload = jsonSerializer.FastPayloadParse(message);11var jsonSerializer = new JsonDataSerializer();12var payload = jsonSerializer.FastPayloadParse<T>(message);13var jsonSerializer = new JsonDataSerializer();14var payload = jsonSerializer.FastPayloadParse(message);15var jsonSerializer = new JsonDataSerializer();

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.