Merge pull request #32 from bdukes/async-client

Use async/await in Deploy Client

Author: Martin Kennish

DeployClient/API.cs

@@ -16,22 +16,23 @@ class API
 
         private static HttpClient BuildClient()
         {
-            HttpClient client = new HttpClient();
+            HttpClient client = new HttpClient()
+            {
+                BaseAddress = new Uri(new Uri(Program.Options.TargetUri), "DesktopModules/PolyDeploy/API/")
+            };
 
-            client.BaseAddress = new Uri(new Uri(Program.Options.TargetUri), "DesktopModules/PolyDeploy/API/");
             client.DefaultRequestHeaders.Add("x-api-key", APIKey);
-            client.Timeout = TimeSpan.FromSeconds(25);
 
             return client;
         }
 
-        public static string CreateSession()
+        public static async Task<string> CreateSessionAsync()
         {
             string endpoint = "Remote/CreateSession";
 
             using (HttpClient client = BuildClient())
             {
-                string json = client.GetStringAsync(endpoint).Result;
+                string json = await client.GetStringAsync(endpoint);
 
                 JavaScriptSerializer jsonSer = new JavaScriptSerializer();
 
@@ -48,36 +49,31 @@ public static string CreateSession()
             }
         }
 
-        public static bool GetSession(string sessionGuid, out Dictionary<string, dynamic> results)
+        public static async Task<(bool success, Dictionary<string, dynamic> results)> GetSessionAsync(string sessionGuid)
         {
             string endpoint = string.Format("Remote/GetSession?sessionGuid={0}", sessionGuid);
 
             JavaScriptSerializer jsonSer = new JavaScriptSerializer();
 
             using (HttpClient client = BuildClient())
             {
-                bool success;
-                var httpResponse = client.GetAsync(endpoint).Result;
+                var httpResponse = await client.GetAsync(endpoint);
                 if (httpResponse.StatusCode == HttpStatusCode.OK)
                 {
                     string json = httpResponse.Content.ReadAsStringAsync().Result;
-                    results = jsonSer.Deserialize<Dictionary<string, dynamic>>(json);
-                    success = true;
-                }
-                else if (httpResponse.StatusCode == HttpStatusCode.NotFound)
-                {
-                    results = new Dictionary<string, dynamic>();
-                    success = false;
+                    return (true, jsonSer.Deserialize<Dictionary<string, dynamic>>(json));
                 }
-                else
+
+                if (httpResponse.StatusCode == HttpStatusCode.NotFound)
                 {
-                    throw new HttpException($"Invalid status code returned from remote api: {httpResponse.StatusCode}");
+                    return (false, new Dictionary<string, dynamic>(0));
                 }
-                return success;
+
+                throw new HttpException($"Invalid status code returned from remote api: {httpResponse.StatusCode}");
             }
         }
 
-        public static void AddPackages(string sessionGuid, List<KeyValuePair<string, Stream>> streams)
+        public static async Task AddPackagesAsync(string sessionGuid, List<KeyValuePair<string, Stream>> streams)
         {
             string endpoint = string.Format("Remote/AddPackages?sessionGuid={0}", sessionGuid);
 
@@ -90,11 +86,11 @@ public static void AddPackages(string sessionGuid, List<KeyValuePair<string, Str
                     form.Add(new StreamContent(keyValuePair.Value), "none", keyValuePair.Key);
                 }
 
-                HttpResponseMessage response = client.PostAsync(endpoint, form).Result;
+                await client.PostAsync(endpoint, form);
             }
         }
 
-        public static void AddPackageAsync(string sessionGuid, Stream stream, string filename)
+        public static async Task AddPackageAsync(string sessionGuid, Stream stream, string filename)
         {
             string endpoint = string.Format("Remote/AddPackages?sessionGuid={0}", sessionGuid);
 
@@ -104,31 +100,26 @@ public static void AddPackageAsync(string sessionGuid, Stream stream, string fil
 
                 form.Add(new StreamContent(stream), "none", filename);
 
-                HttpResponseMessage response = client.PostAsync(endpoint, form).Result;
+                await client.PostAsync(endpoint, form);
             }
         }
 
-        public static bool Install(string sessionGuid, out SortedList<string, dynamic> response)
+        public static async Task<(bool success, SortedList<string, dynamic> response)> InstallAsync(string sessionGuid)
         {
             string endpoint = string.Format("Remote/Install?sessionGuid={0}", sessionGuid);
 
-            bool success = false;
-
             JavaScriptSerializer jsonSer = new JavaScriptSerializer();
 
-            response = null;
-
             using (HttpClient client = BuildClient())
             {
                 try
                 {
-                    HttpResponseMessage httpResponse = client.GetAsync(endpoint).Result;
+                    HttpResponseMessage httpResponse = await client.GetAsync(endpoint);
 
                     if (httpResponse.StatusCode.Equals(HttpStatusCode.OK))
                     {
-                        success = true;
-                        string json = httpResponse.Content.ReadAsStringAsync().Result;
-                        response = jsonSer.Deserialize<SortedList<string, dynamic>>(json);
+                        string json = await httpResponse.Content.ReadAsStringAsync();
+                        return (true, jsonSer.Deserialize<SortedList<string, dynamic>>(json));
                     }
                 }
                 catch (Exception ex)
@@ -137,7 +128,7 @@ public static bool Install(string sessionGuid, out SortedList<string, dynamic> r
                 }
 
                 // Always fail.
-                return false;
+                return (false, null);
             }
         }
     }

DeployClient/DeployClient.csproj

@@ -22,6 +22,7 @@
     <DefineConstants>DEBUG;TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <LangVersion>latest</LangVersion>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <PlatformTarget>AnyCPU</PlatformTarget>
@@ -31,6 +32,7 @@
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <LangVersion>latest</LangVersion>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="CommandLine, Version=1.9.71.2, Culture=neutral, PublicKeyToken=de6f01bd326f8c32, processorArchitecture=MSIL">
@@ -39,6 +41,9 @@
     <Reference Include="System" />
     <Reference Include="System.Configuration" />
     <Reference Include="System.Core" />
+    <Reference Include="System.ValueTuple, Version=4.0.1.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51, processorArchitecture=MSIL">
+      <HintPath>..\packages\System.ValueTuple.4.3.0\lib\netstandard1.0\System.ValueTuple.dll</HintPath>
+    </Reference>
     <Reference Include="System.Web" />
     <Reference Include="System.Web.Extensions" />
     <Reference Include="System.Xml.Linq" />

DeployClient/Program.cs

@@ -1,9 +1,11 @@
-using Cantarus.Libraries.Encryption;
+using Cantarus.Libraries.Encryption;
 using System;
 using System.Collections;
 using System.Collections.Generic;
 using System.Configuration;
 using System.IO;
+using System.Linq;
+using System.Threading.Tasks;
 using System.Web;
 using System.Web.Script.Serialization;
 
@@ -22,7 +24,7 @@ enum ExitCode : int
             InstallFailure = 4
         }
 
-        static void Main(string[] args)
+        static async Task Main(string[] args)
         {
             try
             {
@@ -31,7 +33,7 @@ static void Main(string[] args)
                 // Output start.
                 WriteLine("*** PolyDeploy Client ***");
                 WriteLine();
-                
+
                 // Do we have a target uri.
                 if (Options.TargetUri.Equals(string.Empty))
                 {
@@ -91,16 +93,16 @@ static void Main(string[] args)
                     WriteLine();
                 }
 
-                // Inform user of encryption.
-                WriteLine("Starting encryption and upload...");
-
                 // Get a session.
-                string sessionGuid = API.CreateSession();
+                string sessionGuid = await API.CreateSessionAsync();
 
                 WriteLine(string.Format("Got session: {0}", sessionGuid));
 
                 DateTime startTime = DateTime.Now;
 
+                // Inform user of encryption.
+                WriteLine("Starting encryption and upload...");
+
                 foreach (string zipFile in zipFiles)
                 {
 
@@ -113,7 +115,7 @@ static void Main(string[] args)
                         {
                             Write("uploading...");
 
-                            API.AddPackageAsync(sessionGuid, es, Path.GetFileName(zipFile));
+                            await API.AddPackageAsync(sessionGuid, es, Path.GetFileName(zipFile));
                         }
 
                         WriteLine("done.");
@@ -129,22 +131,23 @@ static void Main(string[] args)
                 JavaScriptSerializer jsonSer = new JavaScriptSerializer();
 
                 // Start.
-                SortedList<string, dynamic> results = null;
-
-                if (!API.Install(sessionGuid, out results))
+                (bool installSuccess,  SortedList<string, dynamic> results) = await API.InstallAsync(sessionGuid);
+                if (!installSuccess)
                 {
-                    TimeSpan interval = new TimeSpan(0, 0, 0, 2);
+                    TimeSpan interval = TimeSpan.FromSeconds(2);
                     Dictionary<string, dynamic> response;
                     var successfullyReachedApi = false;
                     DateTime apiNotFoundAbortTime = DateTime.Now.AddSeconds(Options.InstallationStatusTimeout);
 
-                    // Attempt to get the status of the session from the remote api. 
+                    // Attempt to get the status of the session from the remote api.
                     // This can fail shortly after an installation as the api has not yet been initialised,
                     // so attempt to get it for the given timespan.
                     do
                     {
                         // Get whether we can reach the api
-                        successfullyReachedApi = API.GetSession(sessionGuid, out response);
+                        (bool getSessionSuccess, Dictionary<string, dynamic> getSessionResponse) = await API.GetSessionAsync(sessionGuid);
+                        successfullyReachedApi = getSessionSuccess;
+                        response = getSessionResponse;
 
                         if (!successfullyReachedApi)
                         {
@@ -161,7 +164,7 @@ static void Main(string[] args)
 
                     int status = -1;
                     string previousPrint = null;
-                    
+
                     DateTime abortTime = DateTime.Now.AddMinutes(10);
 
                     // Get the installation status from the API until it is complete or until the abort time is reached
@@ -202,15 +205,16 @@ static void Main(string[] args)
 
                         System.Threading.Thread.Sleep(interval);
 
-                        var success = API.GetSession(sessionGuid, out response);
+                        (bool success, Dictionary<string, dynamic> getSessionResponse) = await API.GetSessionAsync(sessionGuid);
+                        response = getSessionResponse;
 
                         // The api should not be returning a 404 status at this point
                         if (!success)
                         {
                             throw new HttpException("Remote API returned status 404");
                         }
                     } while (status < 2 && DateTime.Now < abortTime);
-                    
+
                 }
                 else
                 {
@@ -294,10 +298,23 @@ private static string BuildUpdateString(SortedList<string, dynamic> results)
 
         private static void WriteException(Exception ex, int maxDepth = 10, int depth = 0)
         {
-            WriteLine(ex.Message);
+            WriteLine($"{ex.GetType()} | {ex.Message}");
             WriteLine(ex.StackTrace);
 
-            if (depth < maxDepth && ex.InnerException != null)
+            if (depth >= maxDepth)
+            {
+                return;
+            }
+
+            if (ex is AggregateException aggregate && aggregate.InnerExceptions.Any())
+            {
+                depth++;
+                foreach (Exception inner in aggregate.InnerExceptions)
+                {
+                    WriteException(inner, maxDepth, depth);
+                }
+            }
+            else if (ex.InnerException != null)
             {
                 depth++;
                 WriteException(ex.InnerException, maxDepth, depth);

DeployClient/packages.config

@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
   <package id="CommandLineParser" version="1.9.71" targetFramework="net45" />
+  <package id="System.ValueTuple" version="4.3.0" targetFramework="net45" />
 </packages>