fix(core): resolve HTTP API on non-ok status code, fix binary response, closes #2046 (#2053)

Author: lucasfernog

.changes/fix-http-binary-response.md

@@ -0,0 +1,5 @@
+---
+"tauri": patch
+---
+
+Fixes the HTTP API binary response serialization.

.changes/fix-http-resolve-error.md

@@ -0,0 +1,6 @@
+---
+"tauri": patch
+"api": patch
+---
+
+The `http` APIs now resolve the returned promise when the API call finishes with an error status code.

.changes/http-error-message.md

@@ -32,9 +32,6 @@ pub enum Error {
   #[cfg(feature = "reqwest-client")]
   #[error("Network Error: {0}")]
   Network(#[from] reqwest::Error),
-  /// HTTP request error. First parameter is the response status code, and the second is the response text.
-  #[error("HTTP Error: status code {0} and response `{1}`")]
-  Http(u16, String),
   /// HTTP method error.
   #[error("{0}")]
   HttpMethod(#[from] http::method::InvalidMethod),

core/tauri/scripts/bundle.js

@@ -118,18 +118,11 @@ impl Client {
       request_builder.send()?
     };
 
-    if response.is_success() {
-      Ok(Response(
-        request.response_type.unwrap_or(ResponseType::Json),
-        response,
-        request.url,
-      ))
-    } else {
-      Err(super::Error::Http(
-        response.status().as_u16(),
-        response.text()?,
-      ))
-    }
+    Ok(Response(
+      request.response_type.unwrap_or(ResponseType::Json),
+      response,
+      request.url,
+    ))
   }
 }
 
@@ -183,17 +176,10 @@ impl Client {
 
     let response = self.0.execute(http_request).await?;
 
-    if response.status().is_success() {
-      Ok(Response(
-        request.response_type.unwrap_or(ResponseType::Json),
-        response,
-      ))
-    } else {
-      Err(super::Error::Http(
-        response.status().as_u16(),
-        response.text().await?,
-      ))
-    }
+    Ok(Response(
+      request.response_type.unwrap_or(ResponseType::Json),
+      response,
+    ))
   }
 }
 
@@ -368,14 +354,14 @@ impl Response {
     let data = match self.0 {
       ResponseType::Json => self.1.json().await?,
       ResponseType::Text => Value::String(self.1.text().await?),
-      ResponseType::Binary => Value::String(serde_json::to_string(&self.1.bytes().await?)?),
+      ResponseType::Binary => serde_json::to_value(&self.1.bytes().await?)?,
     };
 
     #[cfg(not(feature = "reqwest-client"))]
     let data = match self.0 {
       ResponseType::Json => self.1.json()?,
       ResponseType::Text => Value::String(self.1.text()?),
-      ResponseType::Binary => Value::String(serde_json::to_string(&self.1.bytes()?)?),
+      ResponseType::Binary => serde_json::to_value(&self.1.bytes()?)?,
     };
 
     Ok(ResponseData {

core/tauri/src/api/error.rs

@@ -123,16 +123,35 @@ type RequestOptions = Omit<HttpOptions, 'method' | 'url'>
 /** Options for the `fetch` API. */
 type FetchOptions = Omit<HttpOptions, 'url'>
 
+/** @ignore */
+interface IResponse<T> {
+  url: string
+  status: number
+  headers: Record<string, string>
+  data: T
+}
+
 /** Response object. */
-interface Response<T> {
+class Response<T> {
   /** The request URL. */
   url: string
   /** The response status code. */
   status: number
+  /** A boolean indicating whether the response was successful (status in the range 200–299) or not. */
+  ok: boolean
   /** The response headers. */
   headers: Record<string, string>
   /** The response data. */
   data: T
+
+  /** @ignore */
+  constructor(response: IResponse<T>) {
+    this.url = response.url
+    this.status = response.status
+    this.ok = this.status >= 200 && this.status < 300
+    this.headers = response.headers
+    this.data = response.data
+  }
 }
 
 class Client {
@@ -164,13 +183,37 @@ class Client {
    * @returns A promise resolving to the response.
    */
   async request<T>(options: HttpOptions): Promise<Response<T>> {
-    return invokeTauriCommand({
+    const jsonResponse =
+      !options.responseType || options.responseType === ResponseType.JSON
+    if (jsonResponse) {
+      options.responseType = ResponseType.Text
+    }
+    return invokeTauriCommand<IResponse<T>>({
       __tauriModule: 'Http',
       message: {
         cmd: 'httpRequest',
         client: this.id,
         options
       }
+    }).then((res) => {
+      const response = new Response(res)
+      if (jsonResponse) {
+        /* eslint-disable */
+        try {
+          // @ts-expect-error
+          response.data = JSON.parse(response.data as string)
+        } catch (e) {
+          if (response.ok) {
+            throw Error(
+              `Failed to parse response \`${response.data}\` as JSON: ${e};
+              try setting the \`responseType\` option to \`ResponseType.Text\` or \`ResponseType.Binary\` if the API does not return a JSON response.`
+            )
+          }
+        }
+        /* eslint-enable */
+        return response
+      }
+      return response
     })
   }