Error reporting improvements

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## v0.8.0-alpha
+* Added the following exceptions:
+  - `NotFoundException` thrown from `GetEngineAsync(string engine)`, `GetDatabaseAsync(string database)`, etc. when requested resource (Engine/Database/Model/User/Client) doesn't exist or got deleted.
+  - `ApiException` thrown when RAI API responds with 5xx status codes or contains unsupported content type.
+  - `EngineProvisionFailedException` thrown from `CreateEngineWaitAsync` when requested engine failed to provision.
+  - `CredentialsNotSupportedException` thrown from every method when credentials to access RAI API are not provided or provided credentials are unsupported (i.e. not for OAuth Client credentials method).
+  - `InvalidResponseException` thrown when RAI API response has unexpected format or content type.
+
 ## v0.7.0-alpha
 * Replaced String properties with Enums in the following models returned by corresponding API methods:
   - `Database`.`State` property is of `DatabaseState` type.

RelationalAI.Test/DatabaseTest.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Threading.Tasks;
+using RelationalAI.Errors;
 using RelationalAI.Models.Database;
 using Xunit;
 
@@ -10,13 +11,14 @@ public class DatabaseTests : UnitTest
         public static string Uuid = Guid.NewGuid().ToString();
         public static string Dbname = $"csharp-sdk-{Uuid}";
         public static string EngineName = $"csharp-sdk-{Uuid}";
+
         [Fact]
         public async Task DatabaseTest()
         {
             var client = CreateClient();
             await client.CreateEngineWaitAsync(EngineName);
 
-            await Assert.ThrowsAsync<SystemException>(async () => await client.DeleteDatabaseAsync(Dbname));
+            await Assert.ThrowsAsync<NotFoundException>(async () => await client.DeleteDatabaseAsync(Dbname));
 
             var createRsp = await client.CreateDatabaseAsync(Dbname, EngineName, false);
             Assert.Equal(Dbname, createRsp.Name);
@@ -62,7 +64,7 @@ await Assert.ThrowsAsync<ArgumentOutOfRangeException>(() =>
             var deleteRsp = await client.DeleteDatabaseAsync(Dbname);
             Assert.Equal(Dbname, deleteRsp.Name);
 
-            await Assert.ThrowsAsync<SystemException>(async () => await client.GetDatabaseAsync(Dbname));
+            await Assert.ThrowsAsync<NotFoundException>(async () => await client.GetDatabaseAsync(Dbname));
         }
 
         private const string TestModel = "def R = \"hello\", \"world\"";
@@ -79,7 +81,7 @@ public async Task DatabaseCloneTest()
             var client = CreateClient();
             await client.CreateEngineWaitAsync(EngineName);
 
-            await Assert.ThrowsAsync<SystemException>(async () => await client.DeleteDatabaseAsync(Dbname));
+            await Assert.ThrowsAsync<NotFoundException>(async () => await client.DeleteDatabaseAsync(Dbname));
 
             // create a fresh database
             var createRsp = await client.CreateDatabaseAsync(Dbname, EngineName);
@@ -151,8 +153,23 @@ public override async Task DisposeAsync()
         {
             var client = CreateClient();
 
-            try { await client.DeleteDatabaseAsync(Dbname); } catch { }
-            try { await client.DeleteEngineWaitAsync(EngineName); } catch { }
+            try
+            {
+                await client.DeleteDatabaseAsync(Dbname);
+            }
+            catch (Exception e)
+            {
+                await Console.Error.WriteLineAsync(e.ToString());
+            }
+
+            try
+            {
+                await client.DeleteEngineWaitAsync(EngineName);
+            }
+            catch (Exception e)
+            {
+                await Console.Error.WriteLineAsync(e.ToString());
+            }
         }
     }
 }

RelationalAI.Test/EngineTest.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Threading.Tasks;
+using RelationalAI.Errors;
 using RelationalAI.Models.Engine;
 using Xunit;
 
@@ -34,9 +35,9 @@ public async Task EngineTest()
             await Assert.ThrowsAsync<ArgumentOutOfRangeException>(() =>
                 client.ListEnginesAsync((EngineState)1500));
 
-            await Assert.ThrowsAsync<SystemException>(async () => await client.DeleteEngineWaitAsync(EngineName));
+            await Assert.ThrowsAsync<NotFoundException>(async () => await client.DeleteEngineWaitAsync(EngineName));
 
-            await Assert.ThrowsAsync<SystemException>(async () => await client.GetEngineAsync(EngineName));
+            await Assert.ThrowsAsync<NotFoundException>(async () => await client.GetEngineAsync(EngineName));
 
             engines = await client.ListEnginesAsync();
             engine = engines.Find(item => item.Name.Equals(EngineName));
@@ -47,7 +48,14 @@ public override async Task DisposeAsync()
         {
             var client = CreateClient();
 
-            try { await client.DeleteEngineWaitAsync(EngineName); } catch { }
+            try
+            {
+                await client.DeleteEngineWaitAsync(EngineName);
+            }
+            catch (Exception e)
+            {
+                await Console.Error.WriteLineAsync(e.ToString());
+            }
         }
     }
 }

RelationalAI.Test/ExecuteAsync.cs

@@ -45,8 +45,23 @@ public override async Task DisposeAsync()
         {
             var client = CreateClient();
 
-            try { await client.DeleteDatabaseAsync(Dbname); } catch { }
-            try { await client.DeleteEngineWaitAsync(EngineName); } catch { }
+            try
+            {
+                await client.DeleteDatabaseAsync(Dbname);
+            }
+            catch (Exception e)
+            {
+                await Console.Error.WriteLineAsync(e.ToString());
+            }
+
+            try
+            {
+                await client.DeleteEngineWaitAsync(EngineName);
+            }
+            catch (Exception e)
+            {
+                await Console.Error.WriteLineAsync(e.ToString());
+            }
         }
     }
 }

RelationalAI.Test/ExecuteV1Test.cs

@@ -45,8 +45,23 @@ public override async Task DisposeAsync()
         {
             var client = CreateClient();
 
-            try { await client.DeleteDatabaseAsync(Dbname); } catch { }
-            try { await client.DeleteEngineWaitAsync(EngineName); } catch { }
+            try
+            {
+                await client.DeleteDatabaseAsync(Dbname);
+            }
+            catch (Exception e)
+            {
+                await Console.Error.WriteLineAsync(e.ToString());
+            }
+
+            try
+            {
+                await client.DeleteEngineWaitAsync(EngineName);
+            }
+            catch (Exception e)
+            {
+                await Console.Error.WriteLineAsync(e.ToString());
+            }
         }
     }
 }

RelationalAI.Test/LoadCsvTest.cs

@@ -312,8 +312,23 @@ public override async Task DisposeAsync()
         {
             var client = CreateClient();
 
-            try { await client.DeleteDatabaseAsync(Dbname); } catch { }
-            try { await client.DeleteEngineWaitAsync(EngineName); } catch { }
+            try
+            {
+                await client.DeleteDatabaseAsync(Dbname);
+            }
+            catch (Exception e)
+            {
+                await Console.Error.WriteLineAsync(e.ToString());
+            }
+
+            try
+            {
+                await client.DeleteEngineWaitAsync(EngineName);
+            }
+            catch (Exception e)
+            {
+                await Console.Error.WriteLineAsync(e.ToString());
+            }
         }
     }
 }

RelationalAI.Test/LoadJsonTest.cs

@@ -56,8 +56,23 @@ public override async Task DisposeAsync()
         {
             var client = CreateClient();
 
-            try { await client.DeleteDatabaseAsync(Dbname); } catch { }
-            try { await client.DeleteEngineWaitAsync(EngineName); } catch { }
+            try
+            {
+                await client.DeleteDatabaseAsync(Dbname);
+            }
+            catch (Exception e)
+            {
+                await Console.Error.WriteLineAsync(e.ToString());
+            }
+
+            try
+            {
+                await client.DeleteEngineWaitAsync(EngineName);
+            }
+            catch (Exception e)
+            {
+                await Console.Error.WriteLineAsync(e.ToString());
+            }
         }
     }
 }

RelationalAI.Test/ModelsTest.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Threading.Tasks;
+using RelationalAI.Errors;
 using Xunit;
 
 namespace RelationalAI.Test
@@ -39,7 +40,7 @@ public async Task ModelsTest()
             Assert.Empty(deleteRsp.Output);
             Assert.Empty(deleteRsp.Problems);
 
-            await Assert.ThrowsAsync<SystemException>(async () => await client.GetModelAsync(Dbname, EngineName, "test_model"));
+            await Assert.ThrowsAsync<NotFoundException>(async () => await client.GetModelAsync(Dbname, EngineName, "test_model"));
 
             modelNames = await client.ListModelNamesAsync(Dbname, EngineName);
             modelName = modelNames.Find(item => item.Equals("test_model"));
@@ -54,8 +55,23 @@ public override async Task DisposeAsync()
         {
             var client = CreateClient();
 
-            try { await client.DeleteDatabaseAsync(Dbname); } catch { }
-            try { await client.DeleteEngineWaitAsync(EngineName); } catch { }
+            try
+            {
+                await client.DeleteDatabaseAsync(Dbname);
+            }
+            catch (Exception e)
+            {
+                await Console.Error.WriteLineAsync(e.ToString());
+            }
+
+            try
+            {
+                await client.DeleteEngineWaitAsync(EngineName);
+            }
+            catch (Exception e)
+            {
+                await Console.Error.WriteLineAsync(e.ToString());
+            }
         }
     }
 }

RelationalAI.Test/OAuthClientTest.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Threading.Tasks;
+using RelationalAI.Errors;
 using Xunit;
 
 namespace RelationalAI.Test
@@ -13,7 +14,7 @@ public async Task OAuthClientTest()
         {
             var client = CreateClient();
 
-            await Assert.ThrowsAsync<SystemException>(async () => await client.FindOAuthClientAsync(OAuthClientName));
+            await Assert.ThrowsAsync<NotFoundException>(async () => await client.FindOAuthClientAsync(OAuthClientName));
 
             var rsp = await client.CreateOAuthClientAsync(OAuthClientName);
             Assert.Equal(OAuthClientName, rsp.Name);
@@ -37,7 +38,7 @@ public async Task OAuthClientTest()
             var deleteRsp = await client.DeleteOAuthClientAsync(clientId);
             Assert.Equal(clientId, deleteRsp.Id);
 
-            await Assert.ThrowsAsync<SystemException>(async () => await client.FindOAuthClientAsync(OAuthClientName));
+            await Assert.ThrowsAsync<NotFoundException>(async () => await client.FindOAuthClientAsync(OAuthClientName));
         }
 
         public override async Task DisposeAsync()
@@ -49,7 +50,10 @@ public override async Task DisposeAsync()
                 var oauthClient = await client.FindOAuthClientAsync(OAuthClientName);
                 await client.DeleteOAuthClientAsync(oauthClient.Id);
             }
-            catch { }
+            catch (Exception e)
+            {
+                await Console.Error.WriteLineAsync(e.ToString());
+            }
         }
     }
 }

RelationalAI.Test/UserTest.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
+using RelationalAI.Errors;
 using RelationalAI.Models.User;
 using Xunit;
 
@@ -17,7 +18,7 @@ public async Task TestUser()
         {
             var client = CreateClient();
 
-            await Assert.ThrowsAsync<SystemException>(async () => await client.FindUserAsync(UserEmail));
+            await Assert.ThrowsAsync<NotFoundException>(async () => await client.FindUserAsync(UserEmail));
 
             var rsp = await client.CreateUserAsync(UserEmail);
             Assert.Equal(UserEmail, rsp.Email);
@@ -72,7 +73,10 @@ public override async Task DisposeAsync()
                 var oauthClient = await client.FindUserAsync(UserEmail);
                 await client.DeleteUserAsync(oauthClient.Id);
             }
-            catch { }
+            catch (Exception e)
+            {
+                await Console.Error.WriteLineAsync(e.ToString());
+            }
         }
     }
 }

RelationalAI/Credentials/ClientCredentials.cs

@@ -23,7 +23,7 @@ public class ClientCredentials : ICredentials
         private const string DefaultClientCredentialsUrl = "https://login.relationalai.com/oauth/token";
         private string _clientId;
         private string _clientSecret;
-        private string _clientCredentialsUrl;
+        private string _clientCredentialsUrl = DefaultClientCredentialsUrl;
 
         public ClientCredentials(string clientId, string clientSecret)
         {