-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #108 from VincentVrijburg/feature/http-improvements
Improve error message deserialization on value types other than string
- Loading branch information
Showing
3 changed files
with
82 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
using System.Linq; | ||
using System.Text.Json; | ||
|
||
namespace Moneybird.Net.Extensions | ||
{ | ||
internal static class JsonElementExtensions | ||
{ | ||
/// <summary> | ||
/// Get the error message from the error JsonElement. | ||
/// </summary> | ||
/// <param name="jsonElement">The JsonElement from the error response content.</param> | ||
/// <returns>The error message as a string.</returns> | ||
public static string GetErrorMessage(this JsonElement jsonElement) { | ||
var error = jsonElement.GetProperty("error"); | ||
var message = error.ValueKind switch | ||
{ | ||
JsonValueKind.Object => string.Join(", ", error.EnumerateObject().SelectMany(prop => prop.Value.EnumerateArray().Select(val => $"{prop.Name}: {val.GetString()}")).ToList()), | ||
_ => error.GetString(), | ||
}; | ||
|
||
return message; | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
48 changes: 48 additions & 0 deletions
48
tests/Moneybird.Net.Tests/Extensions/JsonElementExtensionsTests.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
using System.Text.Json; | ||
using Moneybird.Net.Extensions; | ||
using Xunit; | ||
|
||
namespace Moneybird.Net.Tests.Extensions; | ||
|
||
public class JsonElementExtensionsTests | ||
{ | ||
[Fact] | ||
public void GetErrorMessage_FromStringErrorJsonElement_Returns_CorrectString() | ||
{ | ||
const string json = "{\"error\":\"Contact is required\",\"symbolic\":{\"contact\":\"required\"}}"; | ||
var jsonElement = JsonDocument.Parse(json); | ||
var actualValue = jsonElement.RootElement.GetErrorMessage(); | ||
|
||
Assert.Equal("Contact is required", actualValue); | ||
} | ||
|
||
[Fact] | ||
public void GetErrorMessage_FromObjectErrorJsonElement_Returns_CorrectString() | ||
{ | ||
const string json = "{\"error\":{\"delivery_method\":[\"The sender address must contain an email address\"]}}"; | ||
var jsonElement = JsonDocument.Parse(json); | ||
var actualValue = jsonElement.RootElement.GetErrorMessage(); | ||
|
||
Assert.Equal("delivery_method: The sender address must contain an email address", actualValue); | ||
} | ||
|
||
[Fact] | ||
public void GetErrorMessage_FromObjectsErrorJsonElement_Returns_CorrectString() | ||
{ | ||
const string json = "{\"error\":{\"firstname\":[\"is required\"],\"lastname\":[\"is required\"],\"company_name\":[\"is required\"]}}"; | ||
var jsonElement = JsonDocument.Parse(json); | ||
var actualValue = jsonElement.RootElement.GetErrorMessage(); | ||
|
||
Assert.Equal("firstname: is required, lastname: is required, company_name: is required", actualValue); | ||
} | ||
|
||
[Fact] | ||
public void GetErrorMessage_FromObjectMultipleErrorsJsonElement_Returns_CorrectString() | ||
{ | ||
const string json = "{\"error\":{\"delivery_method\":[\"The delivery method is required\",\"The sender address must contain an email address\"]}}"; | ||
var jsonElement = JsonDocument.Parse(json); | ||
var actualValue = jsonElement.RootElement.GetErrorMessage(); | ||
|
||
Assert.Equal("delivery_method: The delivery method is required, delivery_method: The sender address must contain an email address", actualValue); | ||
} | ||
} |