How to use SerializedError class of Microsoft.Playwright.Transport.Channels package

1/*
2 * MIT License
3 *
4 * Copyright (c) Microsoft Corporation.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in all
14 * copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 */
24
25using System;
26using System.Collections.Generic;
27using System.Text.Json;
28using System.Threading.Tasks;
29using Microsoft.Playwright.Core;
30using Microsoft.Playwright.Helpers;
31
32namespace Microsoft.Playwright.Transport.Channels
33{
34    internal class JsonPipeChannel : Channel<JsonPipe>
35    {
36        public JsonPipeChannel(string guid, Connection connection, JsonPipe owner) : base(guid, connection, owner)
37        {
38        }
39
40        public event EventHandler<PlaywrightServerMessage> Message;
41
42        public event EventHandler<SerializedError> Closed;
43
44        internal override void OnMessage(string method, JsonElement? serverParams)
45        {
46            switch (method)
47            {
48                case "closed":
49                    if (serverParams.Value.TryGetProperty("error", out var error))
50                    {
51                        Closed?.Invoke(this, error.ToObject<SerializedError>(Connection.DefaultJsonSerializerOptions));
52                    }
53                    else
54                    {
55                        Closed?.Invoke(this, null);
56                    }
57                    break;
58                case "message":
59                    Message?.Invoke(this, serverParams?.GetProperty("message").ToObject<PlaywrightServerMessage>(Connection.DefaultJsonSerializerOptions));
60                    break;
61            }
62        }
63
64        internal Task SendAsync(object message) =>
65            Connection.SendMessageToServerAsync(Guid, "send", new Dictionary<string, object>
66            {
67                { "message", message },
68            });
69
70        internal Task CloseAsync() =>
71            Connection.SendMessageToServerAsync(Guid, "close");
72    }
73}
74

Source: JsonPipeChannel.cs

/*
 * MIT License
 *
 * Copyright (c) Microsoft Corporation.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

using System;
using System.Collections.Generic;
using System.Text.Json;
using System.Threading.Tasks;
using Microsoft.Playwright.Core;
using Microsoft.Playwright.Helpers;

namespace Microsoft.Playwright.Transport.Channels
{
    internal class JsonPipeChannel : Channel<JsonPipe>
    {
        public JsonPipeChannel(string guid, Connection connection, JsonPipe owner) : base(guid, connection, owner)
        {
        }

        public event EventHandler<PlaywrightServerMessage> Message;

        public event EventHandler<SerializedError> Closed;

        internal override void OnMessage(string method, JsonElement? serverParams)
        {
            switch (method)
            {
                case "closed":
                    if (serverParams.Value.TryGetProperty("error", out var error))
                    {
                        Closed?.Invoke(this, error.ToObject<SerializedError>(Connection.DefaultJsonSerializerOptions));
                    }
                    else
                    {
                        Closed?.Invoke(this, null);
                    }
                    break;
                case "message":
                    Message?.Invoke(this, serverParams?.GetProperty("message").ToObject<PlaywrightServerMessage>(Connection.DefaultJsonSerializerOptions));
                    break;
            }
        }

        internal Task SendAsync(object message) =>
            Connection.SendMessageToServerAsync(Guid, "send", new Dictionary<string, object>
            {
                { "message", message },
            });

        internal Task CloseAsync() =>
            Connection.SendMessageToServerAsync(Guid, "close");
    }
}

1/*
2 * MIT License
3 *
4 * Copyright (c) Microsoft Corporation.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in all
14 * copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 */
24
25using System;
26using System.Threading.Tasks;
27using Microsoft.Playwright.Transport;
28using Microsoft.Playwright.Transport.Channels;
29using Microsoft.Playwright.Transport.Protocol;
30
31namespace Microsoft.Playwright.Core
32{
33    internal class JsonPipe : ChannelOwnerBase, IChannelOwner<JsonPipe>
34    {
35        private readonly JsonPipeChannel _channel;
36        private readonly JsonPipeInitializer _initializer;
37
38        public JsonPipe(IChannelOwner parent, string guid, JsonPipeInitializer initializer) : base(parent, guid)
39        {
40            _channel = new(guid, parent.Connection, this);
41            _initializer = initializer;
42            _channel.Closed += (_, e) => Closed.Invoke(this, e);
43            _channel.Message += (_, e) => Message.Invoke(this, e);
44        }
45
46        public event EventHandler<PlaywrightServerMessage> Message;
47
48        public event EventHandler<SerializedError> Closed;
49
50        ChannelBase IChannelOwner.Channel => _channel;
51
52        IChannel<JsonPipe> IChannelOwner<JsonPipe>.Channel => _channel;
53
54        public Task CloseAsync() => _channel.CloseAsync();
55
56        public Task SendAsync(object message) => _channel.SendAsync(message);
57    }
58}
59

Source: JsonPipe.cs

/*
 * MIT License
 *
 * Copyright (c) Microsoft Corporation.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

using System;
using System.Threading.Tasks;
using Microsoft.Playwright.Transport;
using Microsoft.Playwright.Transport.Channels;
using Microsoft.Playwright.Transport.Protocol;

namespace Microsoft.Playwright.Core
{
    internal class JsonPipe : ChannelOwnerBase, IChannelOwner<JsonPipe>
    {
        private readonly JsonPipeChannel _channel;
        private readonly JsonPipeInitializer _initializer;

        public JsonPipe(IChannelOwner parent, string guid, JsonPipeInitializer initializer) : base(parent, guid)
        {
            _channel = new(guid, parent.Connection, this);
            _initializer = initializer;
            _channel.Closed += (_, e) => Closed.Invoke(this, e);
            _channel.Message += (_, e) => Message.Invoke(this, e);
        }

        public event EventHandler<PlaywrightServerMessage> Message;

        public event EventHandler<SerializedError> Closed;

        ChannelBase IChannelOwner.Channel => _channel;

        IChannel<JsonPipe> IChannelOwner<JsonPipe>.Channel => _channel;

        public Task CloseAsync() => _channel.CloseAsync();

        public Task SendAsync(object message) => _channel.SendAsync(message);
    }
}

1/*
2 * MIT License
3 *
4 * Copyright (c) Microsoft Corporation.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in all
14 * copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 */
24
25namespace Microsoft.Playwright.Transport.Channels
26{
27    internal class SerializedError
28    {
29        private string _message;
30
31        /// <summary>
32        /// Error name.
33        /// </summary>
34        public string Name { get; set; }
35
36        /// <summary>
37        /// Error Message.
38        /// </summary>
39        public string Message
40        {
41            get => _message ?? Value;
42            set => _message = value;
43        }
44
45        /// <summary>
46        /// Error Value.
47        /// </summary>
48        public string Value { get; set; }
49
50        /// <summary>
51        /// Error stack.
52        /// </summary>
53        public string Stack { get; set; }
54
55        public override string ToString()
56        {
57            if (!string.IsNullOrEmpty(Stack))
58            {
59                return $"{Stack}";
60            }
61
62            return $"{Name}: {Message}";
63        }
64    }
65}
66

Source: SerializedError.cs

/*
 * MIT License
 *
 * Copyright (c) Microsoft Corporation.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

namespace Microsoft.Playwright.Transport.Channels
{
    internal class SerializedError
    {
        private string _message;

        /// <summary>
        /// Error name.
        /// </summary>
        public string Name { get; set; }

        /// <summary>
        /// Error Message.
        /// </summary>
        public string Message
        {
            get => _message ?? Value;
            set => _message = value;
        }

        /// <summary>
        /// Error Value.
        /// </summary>
        public string Value { get; set; }

        /// <summary>
        /// Error stack.
        /// </summary>
        public string Stack { get; set; }

        public override string ToString()
        {
            if (!string.IsNullOrEmpty(Stack))
            {
                return $"{Stack}";
            }

            return $"{Name}: {Message}";
        }
    }
}