Merge pull request #113 from make-software/sse-client-https

Modified SSE client to allow https connections

Author: davidatwhiletrue

Casper.Network.SDK.Test/ServerEventsClientTest.cs

@@ -18,6 +18,7 @@ public class ServerEventsClientTest
         private KeyPair _faucetKey;
         private string nodeIpSSE;
         private int nodePortSSE;
+        private string nodeUriSSE;
 
         [SetUp]
         public void Setup()
@@ -41,6 +42,10 @@ public void Setup()
             Assert.IsNotNull(port,
                 "Please, set environment variable CASPERNETSDK_NODE_SSE_PORT with a valid node ip.");
             Assert.IsTrue(int.TryParse(port, out nodePortSSE));
+            
+            nodeUriSSE = Environment.GetEnvironmentVariable("CASPERNETSDK_NODE_SSE_URI");
+            Assert.IsNotNull(nodeUriSSE,
+                "Please, set environment variable CASPERNETSDK_NODE_SSE_URI with a valid node sse uri.");
         }
 
         [Test]
@@ -117,7 +122,7 @@ public async Task SSEListen()
             int nDeployAccepted = 0;
             int nDeployProcessed = 0;
 
-            var sse = new ServerEventsClient(nodeIpSSE, nodePortSSE);
+            var sse = new ServerEventsClient(nodeUriSSE);
 
             sse.AddEventCallback(EventType.All, "catch-all-cb",
                 (SSEvent evt) =>

Casper.Network.SDK.Test/test.runsettings

@@ -7,6 +7,7 @@
             <CASPERNETSDK_NODE_METRICS_PORT>14101</CASPERNETSDK_NODE_METRICS_PORT>
             <CASPERNETSDK_NODE_SSE_IP>127.0.0.1</CASPERNETSDK_NODE_SSE_IP>
             <CASPERNETSDK_NODE_SSE_PORT>18101</CASPERNETSDK_NODE_SSE_PORT>
+            <CASPERNETSDK_NODE_SSE_URI>http://127.0.0.1:18101/events</CASPERNETSDK_NODE_SSE_URI>
         </EnvironmentVariables>
     </RunConfiguration>
 </RunSettings>

Casper.Network.SDK/SSE/ServerEventsClient.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Net.Http;
+using System.Text;
 using System.Text.Json;
 using System.Threading;
 using System.Threading.Tasks;
@@ -115,6 +116,7 @@ public class ServerEventsClient : ISSEClient
 
         protected string _host;
         protected int _port;
+        protected Uri _sseUri;
         protected int _nodeVersion = 1;
 
         public ServerEventsClient()
@@ -150,6 +152,31 @@ public ServerEventsClient(string host, int port, int nodeVersion = 2) : this()
             _nodeVersion = nodeVersion;
         }
 
+        /// <summary>
+        /// Instantiate the class indicating the full SSE stream URL of a node.
+        /// Example: https://node.testnet.casper.network/events
+        /// </summary>
+        /// <param name="sseUrl">Full URL of the SSE stream.</param>
+        /// <remarks>Use this constructor when the node is running version 2.x of the Casper protocol.</remarks>
+        public ServerEventsClient(string sseUrl) : this()
+        {
+            if (string.IsNullOrWhiteSpace(sseUrl))
+                throw new ArgumentException("SSE URL cannot be null or empty.", nameof(sseUrl));
+
+            if (!Uri.TryCreate(sseUrl, UriKind.Absolute, out var uri))
+                throw new ArgumentException("SSE URL is not a valid absolute URI.", nameof(sseUrl));
+
+            if (uri.Scheme != Uri.UriSchemeHttp && uri.Scheme != Uri.UriSchemeHttps)
+                throw new ArgumentException("SSE URL must use the HTTP or HTTPS scheme.", nameof(sseUrl));
+
+            _sseUri = uri;
+            _host = uri.Host;
+            _port = uri.IsDefaultPort
+                ? (uri.Scheme == Uri.UriSchemeHttps ? 443 : 80)
+                : uri.Port;
+            _nodeVersion = 2;
+        }
+
         public int NodeVersion
         {
             get { return _nodeVersion; }
@@ -300,10 +327,44 @@ public bool IsRunning()
         protected virtual HttpClient _getHttpClient()
         {
             var client = new HttpClient();
-            client.BaseAddress = new Uri($"http://{_host}:{_port}");
+            client.BaseAddress = _sseUri != null
+                ? new Uri(_sseUri.GetLeftPart(UriPartial.Authority))
+                : new Uri($"http://{_host}:{_port}");
             return client;
         }
 
+        private Uri BuildStreamUri(HttpClient client, ChannelType channelType, int? startFrom)
+        {
+            UriBuilder uriBuilder;
+            if (_sseUri != null)
+            {
+                uriBuilder = new UriBuilder(_sseUri);
+            }
+            else
+            {
+                uriBuilder = new UriBuilder(new Uri(client.BaseAddress +
+                    $"events" +
+                    (_nodeVersion == 1 ? $"/{channelType.ToString().ToLowerInvariant()}" : "")));
+            }
+
+            var queryBuilder = new StringBuilder();
+            var existingQuery = uriBuilder.Query;
+            if (!string.IsNullOrWhiteSpace(existingQuery))
+            {
+                queryBuilder.Append(existingQuery.TrimStart('?'));
+                if (queryBuilder.Length > 0)
+                    queryBuilder.Append('&');
+            }
+
+            if (startFrom != null && startFrom != int.MaxValue)
+                queryBuilder.Append($"start_from={startFrom}");
+            else
+                queryBuilder.Append("start_from=0");
+
+            uriBuilder.Query = queryBuilder.ToString();
+            return uriBuilder.Uri;
+        }
+
         private Task ListenChannelAsync(ChannelType channelType, int? startFrom, CancellationToken cancelToken)
         {
             var task = Task.Run(async () =>
@@ -317,17 +378,10 @@ private Task ListenChannelAsync(ChannelType channelType, int? startFrom, Cancell
                 {
                     try
                     {
-                        var uriBuilder = new UriBuilder(new Uri(client.BaseAddress +
-                            $"events" +
-                            (_nodeVersion == 1 ? $"/{channelType.ToString().ToLowerInvariant()}" : "")));
-                        
-                        if (startFrom != null && startFrom != int.MaxValue)
-                            uriBuilder.Query = $"start_from={startFrom}";
-                        else
-                            uriBuilder.Query = $"start_from={0}";
-                            
+                        var streamUri = BuildStreamUri(client, channelType, startFrom);
+                             
                         using (var streamReader =
-                            new StreamReader(await client.GetStreamAsync(uriBuilder.Uri, cancelToken)))
+                            new StreamReader(await client.GetStreamAsync(streamUri, cancelToken)))
                         {
                             while (!streamReader.EndOfStream && !cancelToken.IsCancellationRequested)
                             {
@@ -426,4 +480,4 @@ private void EmitEvent(EventData eventData)
             }
         }
     }
-}
+}