Allow configuring timeout setting on sqlpage.fetch

 fixes #386

Author: lovasoa

CHANGELOG.md

@@ -13,6 +13,7 @@
  - **Empty Uploaded files**: when a form contains an optional file upload field, and the user does not upload a file, the field used to still be accessible to SQLPage file-related functions such as `sqlpage.uploaded_file_path` and `sqlpage.uploaded_file_mime_type`. This is now fixed, and these functions will return `NULL` when the user does not upload a file. `sqlpage.persist_uploaded_file` will not create an empty file in the target directory when the user does not upload a file, instead it will do nothing and return `NULL`.
  - In the [map](https://sql.ophir.dev/documentation.sql?component=map#component) component, when top-level latitude and longitude properties are omitted, the map will now center on its markers. This makes it easier to create zoomed maps with a single marker.
  - In the [button](https://sql.ophir.dev/documentation.sql?component=button#component) component, add a `download` property to make the button download a file when clicked, a `target` property to open the link in a new tab, and a `rel` property to prevent search engines from following the link.
+ - New `timeout` option in the [sqlpage.fetch](https://sql.ophir.dev/functions.sql?function=fetch#function) function to set a timeout for the request. This is useful when working with slow or unreliable APIs, large payloads, or when you want to avoid waiting too long for a response.
 
 ## 0.22.0 (2024-05-29)
  -  **Important Security Fix:** The behavior of `SET $x` has been modified to match `SELECT $x`.

examples/official-site/sqlpage/migrations/40_fetch.sql

@@ -56,6 +56,16 @@ select
     ''json'' as language,
     $api_results as contents;
 ```
+
+# JSON parameter format
+
+The fetch function accepts either a URL string, or a JSON object with the following parameters:
+ - `method`: The HTTP method to use. Defaults to `GET`.
+ - `url`: The URL to fetch.
+ - `headers`: A JSON object with the headers to send.
+ - `body`: The body of the request. If it is a JSON object, it will be sent as JSON. If it is a string, it will be sent as is.
+ - `timeout_ms`: The maximum time to wait for the request, in milliseconds. Defaults to 5000.
+
 '
     );
 INSERT INTO sqlpage_function_parameters (

src/webserver/database/sqlpage_functions/functions.rs

@@ -132,6 +132,9 @@ async fn fetch(
         Method::GET
     };
     let mut req = client.request(method, http_request.url.as_ref());
+    if let Some(timeout) = http_request.timeout_ms {
+        req = req.timeout(core::time::Duration::from_millis(timeout));
+    }
     for (k, v) in http_request.headers {
         req = req.insert_header((k.as_ref(), v.as_ref()));
     }

src/webserver/database/sqlpage_functions/http_fetch_request.rs

@@ -9,6 +9,7 @@ pub(super) struct HttpFetchRequest<'b> {
     pub url: Cow<'b, str>,
     #[serde(borrow)]
     pub method: Option<Cow<'b, str>>,
+    pub timeout_ms: Option<u64>,
     #[serde(borrow, deserialize_with = "deserialize_map_to_vec_pairs")]
     pub headers: HeaderVec<'b>,
     #[serde(borrow)]
@@ -50,6 +51,7 @@ impl<'a> BorrowFromStr<'a> for HttpFetchRequest<'a> {
                 method: None,
                 headers: Vec::new(),
                 body: None,
+                timeout_ms: None,
             }
         } else {
             match s {
@@ -72,6 +74,7 @@ impl<'a> HttpFetchRequest<'a> {
                 .map(|(k, v)| (Cow::Owned(k.into_owned()), Cow::Owned(v.into_owned())))
                 .collect(),
             body: self.body.map(Cow::into_owned).map(Cow::Owned),
+            timeout_ms: self.timeout_ms,
         }
     }
 }