Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Task/fix null response error #12

Merged
merged 2 commits into from
Oct 28, 2024
Merged

Task/fix null response error #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
793d609
bug: handle null response gracefully
nebHailemariam Oct 26, 2024
a8942ad
test: null response
nebHailemariam Oct 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions Gorse.NET.Tests/GorseTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,13 @@ public void TestRecommend()
Assert.That(items, Is.EqualTo(new string[] { "30", "20", "10" }));
}

[Test]
public void TestRecommend_Returns_Null()
{
var items = client.GetRecommend("40");
Assert.IsNull(items);
}

[Test]
public async Task TestRecommendAsync()
{
Expand All @@ -117,6 +124,14 @@ public async Task TestRecommendAsync()
Assert.That(items, Is.EqualTo(new string[] { "30", "20", "10" }));
}

[Test]
public async Task TestRecommendAsync_Returns_Null()
{

var items = await client.GetRecommendAsync("40");
Assert.IsNull(items);
}

[Test]
public void TestUserNeighbors()
{
Expand Down
118 changes: 64 additions & 54 deletions Gorse.NET/Gorse.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,12 @@ public class GorseException : Exception
{
public HttpStatusCode StatusCode { set; get; }
public new string? Message { set; get; }

public GorseException(string? message, HttpStatusCode statusCode) : base(message)
{
Message = message;
StatusCode = statusCode;
}
}

public class Gorse
Expand All @@ -68,133 +74,137 @@ public Gorse(string endpoint, string apiKey)

public Result InsertUser(User user)
{
return Request<Result, User>(Method.Post, "api/user", user);
return Request<Result, User>(Method.Post, "api/user", user)!;
}

public Task<Result> InsertUserAsync(User user)
{
return RequestAsync<Result, User>(Method.Post, "api/user", user);
return RequestAsync<Result, User>(Method.Post, "api/user", user)!;
}

public User GetUser(string userId)
{
return Request<User, Object>(Method.Get, "api/user/" + userId, null);
return Request<User, Object>(Method.Get, "api/user/" + userId, null)!;
}

public Task<User> GetUserAsync(string userId)
{
return RequestAsync<User, Object>(Method.Get, "api/user/" + userId, null);
return RequestAsync<User, Object>(Method.Get, "api/user/" + userId, null)!;
}

public Result DeleteUser(string userId)
{
return Request<Result, Object>(Method.Delete, "api/user/" + userId, null);
return Request<Result, Object>(Method.Delete, "api/user/" + userId, null)!;
}

public Task<Result> DeleteUserAsync(string userId)
{
return RequestAsync<Result, Object>(Method.Delete, "api/user/" + userId, null);
return RequestAsync<Result, Object>(Method.Delete, "api/user/" + userId, null)!;
}

public Result InsertFeedback(Feedback[] feedbacks)
{
return Request<Result, Feedback[]>(Method.Post, "api/feedback", feedbacks);
return Request<Result, Feedback[]>(Method.Post, "api/feedback", feedbacks)!;
}

public Task<Result> InsertFeedbackAsync(Feedback[] feedbacks)
{
return RequestAsync<Result, Feedback[]>(Method.Post, "api/feedback", feedbacks);
return RequestAsync<Result, Feedback[]>(Method.Post, "api/feedback", feedbacks)!;
}

public string[] GetRecommend(string userId)
public string[]? GetRecommend(string userId)
{
return Request<string[], Object>(Method.Get, "api/recommend/" + userId, null);
}

public Task<string[]> GetRecommendAsync(string userId)
public Task<string[]?> GetRecommendAsync(string userId)
{
return RequestAsync<string[], Object>(Method.Get, "api/recommend/" + userId, null);
}

public List<UserScore> GetUserNeighbors(string userId)
{
return Request<List<UserScore>, Object>(Method.Get, @"api/user/{userId}/neighbors", null);
return Request<List<UserScore>, Object>(Method.Get, @"api/user/{userId}/neighbors", null)!;
}

public Task<List<UserScore>> GetUserNeighborsAsync(string userId)
{
return RequestAsync<List<UserScore>, Object>(Method.Get, @"api/user/{userId}/neighbors", null);
return RequestAsync<List<UserScore>, Object>(Method.Get, @"api/user/{userId}/neighbors", null)!;
}

public RetType Request<RetType, ReqType>(Method method, string resource, ReqType? req) where ReqType : class
public RetType? Request<RetType, ReqType>(Method method, string resource, ReqType? req) where ReqType : class
{
var request = new RestRequest(resource, method);
if (req != null)
{
request.AddJsonBody(req);
}
var response = client.Execute(request);
if (response.StatusCode != HttpStatusCode.OK)
if (!response.IsSuccessStatusCode)
{
throw new GorseException
{
StatusCode = response.StatusCode,
Message = response.Content
};
throw new GorseException(message: response.Content, statusCode: response.StatusCode);
}
else if (response.Content == null)
// Handle case where response content is null
if (response.Content == null)
{
throw new GorseException
{
StatusCode = HttpStatusCode.InternalServerError,
Message = "unexcepted empty response"
};
return default;
}
RetType? ret = JsonSerializer.Deserialize<RetType>(response.Content);
if (ret == null)
// Deserialize response content to the expected type
try
{
throw new GorseException
{
StatusCode = HttpStatusCode.InternalServerError,
Message = "unexcepted null response"
};
return JsonSerializer.Deserialize<RetType>(response.Content);
}
catch (JsonException jsonEx) // Specific error handling for JSON deserialization
{
throw new GorseException(
message: $"Deserialization failed: {jsonEx}. \nResponse content: {response.Content}. \nStatus code: {response.StatusCode}",
statusCode: response.StatusCode
);
}
catch (Exception ex) // General error handling for any other exceptions
{
throw new GorseException(
message: $"An error occurred while processing the response: {ex}. \nResponse content: {response.Content}. \nStatus code: {response.StatusCode}",
statusCode: response.StatusCode
);
}
return ret;
}

public async Task<RetType> RequestAsync<RetType, ReqType>(Method method, string resource, ReqType? req) where ReqType : class
public async Task<RetType?> RequestAsync<RetType, ReqType>(Method method, string resource, ReqType? req) where ReqType : class
{
var request = new RestRequest(resource, method);
if (req != null)
{
request.AddJsonBody(req);
}
var response = await client.ExecuteAsync(request);
if (response.StatusCode != HttpStatusCode.OK)
if (!response.IsSuccessStatusCode)
{
throw new GorseException(message: response.Content, statusCode: response.StatusCode);
}
// Handle case where response content is null
if (response.Content == null)
{
return default;
}
// Deserialize response content to the expected type
try
{
throw new GorseException
{
StatusCode = response.StatusCode,
Message = response.Content
};
return JsonSerializer.Deserialize<RetType>(response.Content);
}
else if (response.Content == null)
catch (JsonException jsonEx) // Specific error handling for JSON deserialization
{
throw new GorseException
{
StatusCode = HttpStatusCode.InternalServerError,
Message = "unexcepted empty response"
};
throw new GorseException(
message: $"Deserialization failed: {jsonEx}. \nResponse content: {response.Content}. \nStatus code: {response.StatusCode}",
statusCode: response.StatusCode
);
}
RetType? ret = JsonSerializer.Deserialize<RetType>(response.Content);
if (ret == null)
catch (Exception ex) // General error handling for any other exceptions
{
throw new GorseException
{
StatusCode = HttpStatusCode.InternalServerError,
Message = "unexcepted null response"
};
throw new GorseException(
message: $"An error occurred while processing the response: {ex}. \nResponse content: {response.Content}. \nStatus code: {response.StatusCode}",
statusCode: response.StatusCode
);
}
return ret;
}
}
Loading