rageagainstthepixel/com.utilities.rest

RESTful utilities for the Unity (UPM)

com.utilities.rest's Issues

PostAsync has a signature conflict

Overview

From the example given in the ReadMe, this highlights a signature conflict for the PostAsync call between:

        public static async Task<Response> PostAsync(
            string query,
            string jsonData,
            Action<string> serverSentEventCallback,
            RestParameters parameters = null,
            CancellationToken cancellationToken = default)

And

        public static async Task<Response> PostAsync(
            string query,
            string jsonData,
            Action<Response> dataReceivedEventCallback,
            int? eventChunkSize = null,
            RestParameters parameters = null,
            CancellationToken cancellationToken = default)

Likely due to the defaults applied to the second method.

To Reproduce

Steps to reproduce the behavior:

1. Create a new script
2. Copy the Rest example from the readme

      var jsonData = "{\"data\":\"content\"}";
      var response = await Rest.PostAsync("www.your.api/endpoint", jsonData, eventData =>
      {
          Debug.Log(eventData);
      });

3. Observe conflict error

Expected behavior

Examples should work out of the box, as should all method overloads.

Download handlers are not properly disposed

This Unity error is thrown when I use this plugin. It appears to be because webrequest upload/download handlers aren't disposed.
The reason for this is apparently because PostAsync calls UnityWebRequest.Post, which creates uploadHandler/downloadHandler. Those handlers are then overwritten but never disposed.

Additionally, you may need to add webRequest.disposeUploadHandlerOnDispose/webRequest.disposeDownloadHandlerOnDispose?

More info on that here: https://forum.unity.com/threads/a-native-collection-has-not-been-disposed-resulting-in-a-memory-leak.1136068/

Add text return value to DownloadHandlerBuffer reponse

When using the Post functions, DownloadHandlerBuffer is used for the downloadHandler. This results in text not being returned.
I'm not sure if this is by design or not?

Can't install!

Bug Report

Seeing this error when installing via Github URL:

[Package Manager Window] Cannot perform upm operation: Unable to add package [https://github.com/RageAgainstThePixel/com.utilities.rest.git#upm]:
  Package com.utilities.rest@https://github.com/RageAgainstThePixel/com.utilities.rest.git#upm has invalid dependencies or related test packages:
    com.utilities.async (dependency): Package [[email protected]] cannot be found [NotFound].

Ensure Cache works properly on WebGL Builds

Some plugins seem to have problems loading resources from cache location.

Need to double check that webgl supports writing files to a local cache before attempting to load the resource.

PATCH

Feature Request

currently missing PATCH operations

Please update the examples on the root ReadMe with latest implementations and examples

With all the recent changes, the main ReadMe has not been kept up to date, as such, none of the examples provided are functional and require additional parameters.