Skip to content

Commit

Permalink
com.utilities.rest 3.2.0 (#82)
Browse files Browse the repository at this point in the history 
- Refactor `serverSentEventHandler` from `Action<Response, ServerSentEvent>` to `Func<Response, ServerSentEvent, Task>`
- Fix `Validate(debug)` not capturing request body for json payloads
  • Loading branch information
@StephenHodgson
StephenHodgson authored Jun 20, 2024
1 parent 12293d1 commit 4b0cad9
Show file tree
Hide file tree
Showing 4 changed files with 107 additions and 38 deletions.
8 changes: 6 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Advanced features includes progress notifications, authentication and native mul
- [Rest Parameters](#rest-parameters)
- [Get](#get)
- [Post](#post)
- [Server Sent Events](#server-sent-events) :new:
- [Server Sent Events](#server-sent-events) :warning:
- [Data Received Callbacks](#data-received-callbacks)
- [Put](#put)
- [Patch](#patch)
Expand Down Expand Up @@ -115,10 +115,14 @@ response.Validate(debug: true);

#### Server Sent Events

> [!WARNING]
> This callback was recently refactored from `Action<Response, ServerSentEvent>` to `Func<Response, ServerSentEvent, Task>`. To update this callback without asynchronous calls, just add `await Task.CompletedTask;` at the end of your callback function.
```csharp
var jsonData = "{\"data\":\"content\"}";
var response = await Rest.PostAsync("www.your.api/endpoint", jsonData, (sseResponse, ssEvent) => {
var response = await Rest.PostAsync("www.your.api/endpoint", jsonData, async (sseResponse, ssEvent) => {
Debug.Log(ssEvent);
await Task.CompletedTask;
});
// Validates the response for you and will throw a RestException if the response is unsuccessful.
response.Validate(debug: true);
Expand Down
8 changes: 6 additions & 2 deletions Utilities.Rest/Packages/com.utilities.rest/Documentation~/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Advanced features includes progress notifications, authentication and native mul
- [Rest Parameters](#rest-parameters)
- [Get](#get)
- [Post](#post)
- [Server Sent Events](#server-sent-events) :new:
- [Server Sent Events](#server-sent-events) :warning:
- [Data Received Callbacks](#data-received-callbacks)
- [Put](#put)
- [Patch](#patch)
Expand Down Expand Up @@ -115,10 +115,14 @@ response.Validate(debug: true);

#### Server Sent Events

> [!WARNING]
> This callback was recently refactored from `Action<Response, ServerSentEvent>` to `Func<Response, ServerSentEvent, Task>`. To update this callback without asynchronous calls, just add `await Task.CompletedTask;` at the end of your callback function.
```csharp
var jsonData = "{\"data\":\"content\"}";
var response = await Rest.PostAsync("www.your.api/endpoint", jsonData, (sseResponse, ssEvent) => {
var response = await Rest.PostAsync("www.your.api/endpoint", jsonData, async (sseResponse, ssEvent) => {
Debug.Log(ssEvent);
await Task.CompletedTask;
});
// Validates the response for you and will throw a RestException if the response is unsuccessful.
response.Validate(debug: true);
Expand Down
127 changes: 94 additions & 33 deletions Utilities.Rest/Packages/com.utilities.rest/Runtime/Rest.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ public static class Rest
private const string content_type = "Content-Type";
private const string content_length = "Content-Length";
private const string application_json = "application/json";
private const string multipart_form_data = "multipart/form-data";
private const string application_octet_stream = "application/octet-stream";
private const string ssePattern = @"(?:(?:(?<type>[^:\n]*):)(?<value>(?:(?!\n\n|\ndata:).)*)(?:\ndata:(?<data>(?:(?!\n\n).)*))?\n\n)";

Expand Down Expand Up @@ -74,6 +75,18 @@ public static async Task<Response> GetAsync(
return await webRequest.SendAsync(parameters, cancellationToken);
}

[Obsolete("use new overload with serverSentEventHandler: Func<Response, ServerSentEvent, Task>")]
public static async Task<Response> GetAsync(
string query,
Action<Response, ServerSentEvent> serverSentEventHandler,
RestParameters parameters = null,
CancellationToken cancellationToken = default)
{
await Awaiters.UnityMainThread;
using var webRequest = UnityWebRequest.Get(query);
return await webRequest.SendAsync(parameters, serverSentEventHandler, cancellationToken);
}

/// <summary>
/// Rest GET.
/// </summary>
Expand All @@ -84,7 +97,7 @@ public static async Task<Response> GetAsync(
/// <returns>The response data.</returns>
public static async Task<Response> GetAsync(
string query,
Action<Response, ServerSentEvent> serverSentEventHandler,
Func<Response, ServerSentEvent, Task> serverSentEventHandler,
RestParameters parameters = null,
CancellationToken cancellationToken = default)
{
Expand Down Expand Up @@ -203,19 +216,38 @@ public static async Task<Response> PostAsync(
return await webRequest.SendAsync(parameters, cancellationToken);
}

[Obsolete("Use new overload with serverSentEventHandler: Func<Response, ServerSentEvent, Task>")]
public static async Task<Response> PostAsync(
string query,
string jsonData,
Action<Response, ServerSentEvent> serverSentEventHandler,
RestParameters parameters = null,
CancellationToken cancellationToken = default)
{
await Awaiters.UnityMainThread;
using var webRequest = new UnityWebRequest(query, UnityWebRequest.kHttpVerbPOST);
var data = new UTF8Encoding().GetBytes(jsonData);
using var uploadHandler = new UploadHandlerRaw(data);
webRequest.uploadHandler = uploadHandler;
using var downloadHandler = new DownloadHandlerBuffer();
webRequest.downloadHandler = downloadHandler;
webRequest.SetRequestHeader(content_type, application_json);
return await webRequest.SendAsync(parameters, serverSentEventHandler, cancellationToken);
}

/// <summary>
/// Rest POST.
/// </summary>
/// <param name="query">Finalized Endpoint Query with parameters.</param>
/// <param name="jsonData">JSON data for the request.</param>
/// <param name="serverSentEventHandler"><see cref="Action{Response, ServerSentEvent}"/> server sent event callback handler.</param>
/// <param name="serverSentEventHandler"><see cref="Func{Response, ServerSentEvent, Task}"/> server sent event callback handler.</param>
/// <param name="parameters">Optional, <see cref="RestParameters"/>.</param>
/// <param name="cancellationToken">Optional, <see cref="CancellationToken"/>.</param>
/// <returns>The response data.</returns>
public static async Task<Response> PostAsync(
string query,
string jsonData,
Action<Response, ServerSentEvent> serverSentEventHandler,
Func<Response, ServerSentEvent, Task> serverSentEventHandler,
RestParameters parameters = null,
CancellationToken cancellationToken = default)
{
Expand Down Expand Up @@ -1082,18 +1114,32 @@ public static async Task<Response> SendAsync(
return await SendAsync(webRequest, parameters, serverSentEventHandler, cancellationToken);
}

[Obsolete("use new .ctr with new serverSentEventHandler: Func<Response, ServerSentEvent, Task>")]
public static async Task<Response> SendAsync(
this UnityWebRequest webRequest,
RestParameters parameters = null,
Action<Response, ServerSentEvent> serverSentEventHandler = null,
CancellationToken cancellationToken = default)
{
return await SendAsync(webRequest, parameters, (response, @event) =>
{
serverSentEventHandler?.Invoke(response, @event);
return Task.CompletedTask;
}, cancellationToken);
}

/// <summary>
/// Process a <see cref="UnityWebRequest"/> asynchronously.
/// </summary>
/// <param name="webRequest">The <see cref="UnityWebRequest"/>.</param>
/// <param name="parameters">Optional, <see cref="RestParameters"/>.</param>
/// <param name="serverSentEventHandler">Optional, <see cref="Action{Response, ServerSentEvent}"/> server sent event callback handler.</param>
/// <param name="serverSentEventHandler">Optional, <see cref="Func{Response, ServerSentEvent, Task}"/> server sent event callback handler.</param>
/// <param name="cancellationToken">Optional <see cref="CancellationToken"/>.</param>
/// <returns><see cref="Response"/></returns>
public static async Task<Response> SendAsync(
this UnityWebRequest webRequest,
RestParameters parameters = null,
Action<Response, ServerSentEvent> serverSentEventHandler = null,
Func<Response, ServerSentEvent, Task> serverSentEventHandler = null,
CancellationToken cancellationToken = default)
{
await Awaiters.UnityMainThread;
Expand Down Expand Up @@ -1138,41 +1184,47 @@ UnityWebRequest.kHttpVerbPUT or
if (hasUpload && webRequest.uploadHandler != null)
{
var contentType = webRequest.GetRequestHeader(content_type);
if (webRequest.uploadHandler.data is { Length: > 0 } &&
contentType.Contains("multipart/form-data"))

if (webRequest.uploadHandler.data is { Length: > 0 })
{
var boundary = contentType.Split(';')[1].Split('=')[1];
var encodedData = Encoding.UTF8.GetString(webRequest.uploadHandler.data);
var formData = encodedData.Split(new[] { $"\r\n--{boundary}\r\n", $"\r\n--{boundary}--\r\n" }, StringSplitOptions.RemoveEmptyEntries);
var formParts = new Dictionary<string, string>();

foreach (var form in formData)
if (contentType.Contains(multipart_form_data))
{
var formFields = form.Split(new[] { "\r\n\r\n" }, StringSplitOptions.RemoveEmptyEntries);
var fieldHeader = formFields[0];
var key = fieldHeader.Split(new[] { "name=\"" }, StringSplitOptions.RemoveEmptyEntries)[1].Split("\"")[0];
var boundary = contentType.Split(';')[1].Split('=')[1];
var formData = encodedData.Split(new[] { $"\r\n--{boundary}\r\n", $"\r\n--{boundary}--\r\n" }, StringSplitOptions.RemoveEmptyEntries);
var formParts = new Dictionary<string, string>();

if (fieldHeader.Contains("application/octet-stream"))
{
var fileName = fieldHeader.Split(new[] { "filename=\"" }, StringSplitOptions.RemoveEmptyEntries)[1].Split("\"")[0];
formParts.Add(key, fileName);
}
else
foreach (var form in formData)
{
var value = formFields[1];
formParts.Add(key, value);
const string eol = "\r\n\r\n";
var formFields = form.Split(new[] { eol }, StringSplitOptions.RemoveEmptyEntries);
var fieldHeader = formFields[0];
const string fieldName = "name=\"";
var key = fieldHeader.Split(new[] { fieldName }, StringSplitOptions.RemoveEmptyEntries)[1].Split('"')[0];

if (fieldHeader.Contains(application_octet_stream))
{
const string filename = "filename=\"";
var fileName = fieldHeader.Split(new[] { filename }, StringSplitOptions.RemoveEmptyEntries)[1].Split('"')[0];
formParts.Add(key, fileName);
}
else
{
var value = formFields[1];
formParts.Add(key, value);
}
}
}

requestBody = JsonConvert.SerializeObject(new { contentType, formParts });
}
else
{
requestBody = string.Empty;
requestBody = JsonConvert.SerializeObject(new { contentType, formParts });
}
else
{
requestBody = encodedData;
}
}
}


if (parameters is { Progress: not null } ||
serverSentEventHandler != null)
{
Expand All @@ -1194,7 +1246,7 @@ async void CallbackThread()
{
if (serverSentEventHandler != null)
{
SendServerEventCallback(false, requestBody);
await SendServerEventCallback(false, requestBody).ConfigureAwait(true);
}

if (parameters is { Progress: not null })
Expand Down Expand Up @@ -1276,12 +1328,12 @@ UnityWebRequest.Result.ConnectionError or

if (serverSentEventHandler != null)
{
SendServerEventCallback(true, requestBody);
await SendServerEventCallback(true, requestBody).ConfigureAwait(true);
}

return new Response(webRequest, requestBody, true, parameters);

void SendServerEventCallback(bool isEnd, string body)
async Task SendServerEventCallback(bool isEnd, string body)
{
var allEventMessages = webRequest.downloadHandler?.text;
if (string.IsNullOrWhiteSpace(allEventMessages)) { return; }
Expand Down Expand Up @@ -1337,7 +1389,16 @@ void SendServerEventCallback(bool isEnd, string body)
}

var sseResponse = new Response(webRequest, body, true, parameters, (@event.Data ?? @event.Value).ToString(Formatting.None));
serverSentEventHandler.Invoke(sseResponse, @event);

try
{
await serverSentEventHandler.Invoke(sseResponse, @event).ConfigureAwait(true);
}
catch (Exception e)
{
Debug.LogError(e);
}

parameters.ServerSentEventCount++;
parameters.ServerSentEvents.Add(@event);
}
Expand Down
2 changes: 1 addition & 1 deletion Utilities.Rest/Packages/com.utilities.rest/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"displayName": "Utilities.Rest",
"description": "This package contains useful RESTful utilities for the Unity Game Engine.",
"keywords": [],
"version": "3.1.2",
"version": "3.2.0",
"unity": "2021.3",
"documentationUrl": "https://github.com/RageAgainstThePixel/com.utilities.rest#documentation",
"changelogUrl": "https://github.com/RageAgainstThePixel/com.utilities.rest/releases",
Expand Down

0 comments on commit 4b0cad9

Please sign in to comment.