Merge pull request #723 from itowlson/deprecate-http-params

Stop using WASI HTTP params in preparation for deprecation

Author: itowlson

crates/http/src/spin.rs

@@ -4,7 +4,6 @@ use crate::{
 };
 use anyhow::Result;
 use async_trait::async_trait;
-use http::Uri;
 use hyper::{Body, Request, Response};
 use spin_engine::io::ModuleIoRedirects;
 use std::{net::SocketAddr, str, str::FromStr};
@@ -85,11 +84,10 @@ impl SpinHttpExecutor {
                 .map(|(k, v)| (k.as_str(), v.as_str()))
                 .collect();
 
-            let params = &Self::params(&parts.uri)?;
-            let params: Vec<(&str, &str)> = params
-                .iter()
-                .map(|(k, v)| (k.as_str(), v.as_str()))
-                .collect();
+            // Preparing to remove the params field. We are leaving it in place for now
+            // to avoid breaking the ABI, but no longer pass or accept values in it.
+            // https://github.com/fermyon/spin/issues/663
+            let params = vec![];
 
             let body = Some(&bytes[..]);
             let uri = match parts.uri.path_and_query() {
@@ -187,15 +185,6 @@ impl SpinHttpExecutor {
 
         Ok(())
     }
-
-    fn params(uri: &Uri) -> Result<Vec<(String, String)>> {
-        match uri.query() {
-            Some(q) => Ok(url::form_urlencoded::parse(q.as_bytes())
-                .into_owned()
-                .collect::<Vec<_>>()),
-            None => Ok(vec![]),
-        }
-    }
 }
 
 fn contextualise_err(e: anyhow::Error) -> anyhow::Error {

crates/http/tests/rust-http-test/src/lib.rs

@@ -6,7 +6,8 @@ struct SpinHttp {}
 
 impl spin_http::SpinHttp for SpinHttp {
     fn handle_http_request(req: Request) -> Response {
-        assert!(req.params.contains(&("abc".to_string(), "def".to_string())));
+        assert!(req.params.is_empty());
+        assert!(req.uri.contains("?abc=def"));
 
         assert!(req
             .headers

crates/outbound-http/src/lib.rs

@@ -70,6 +70,10 @@ impl wasi_outbound_http::WasiOutboundHttp for OutboundHttp {
         let headers = request_headers(req.headers)?;
         let body = req.body.unwrap_or_default().to_vec();
 
+        if !req.params.is_empty() {
+            tracing::log::warn!("HTTP params field is deprecated");
+        }
+
         match Handle::try_current() {
             // If running in a Tokio runtime, spawn a new blocking executor
             // that will send the HTTP request, and block on its execution.

sdk/rust/src/outbound_http.rs

@@ -1,4 +1,4 @@
-use http::{header::HeaderName, HeaderValue, Uri};
+use http::{header::HeaderName, HeaderValue};
 
 use super::http::{Request, Response};
 
@@ -16,12 +16,9 @@ pub fn send_request(req: Request) -> Result<Response> {
 
     let method = req.method.try_into()?;
 
-    let (uri, params) = split_uri(req.uri)?;
+    let uri = req.uri.to_string();
 
-    let params = &params
-        .iter()
-        .map(|(k, v)| (k.as_str(), v.as_str()))
-        .collect::<Vec<_>>();
+    let params = vec![];
 
     let headers = &req
         .headers
@@ -34,7 +31,7 @@ pub fn send_request(req: Request) -> Result<Response> {
     let out_req = OutboundRequest {
         method,
         uri: &uri,
-        params,
+        params: &params,
         headers,
         body,
     };
@@ -55,23 +52,6 @@ pub fn send_request(req: Request) -> Result<Response> {
         .map_err(|_| OutboundHttpError::RuntimeError)
 }
 
-fn split_uri(uri: Uri) -> Result<(String, Vec<(String, String)>)> {
-    let params = form_urlencoded::parse(uri.query().unwrap_or_default().as_bytes())
-        .into_owned()
-        .collect();
-    let uri_without_params = {
-        let mut parts = uri.into_parts();
-        if let Some(paq) = parts.path_and_query.as_mut() {
-            // Rebuild PathAndQuery from just path
-            *paq = paq.path().try_into().unwrap();
-        }
-        Uri::from_parts(parts)
-            .map_err(|_| OutboundHttpError::InvalidUrl)?
-            .to_string()
-    };
-    Ok((uri_without_params, params))
-}
-
 fn try_header_to_strs<'k, 'v>(
     header: (&'k HeaderName, &'v HeaderValue),
 ) -> Result<(&'k str, &'v str)> {