client: add default user agent

Author: Fishrock123

src/client/mod.rs

@@ -1,19 +1,29 @@
 //! Process HTTP connections on the client.
 
 use async_std::io::{self, Read, Write};
+use http_types::headers::USER_AGENT;
 use http_types::{Request, Response};
+use lazy_static::lazy_static;
 
 mod decode;
 mod encode;
 
 pub use decode::decode;
 pub use encode::Encoder;
 
+lazy_static! {
+    static ref DEFAULT_USER_AGENT: String = format!("http-rs-h1/{}", env!("CARGO_PKG_VERSION"));
+}
+
 /// Opens an HTTP/1.1 connection to a remote host.
-pub async fn connect<RW>(mut stream: RW, req: Request) -> http_types::Result<Response>
+pub async fn connect<RW>(mut stream: RW, mut req: Request) -> http_types::Result<Response>
 where
     RW: Read + Write + Send + Sync + Unpin + 'static,
 {
+    if let None = req.header(USER_AGENT) {
+        req.insert_header(USER_AGENT, DEFAULT_USER_AGENT.as_str());
+    }
+
     let mut req = Encoder::encode(req).await?;
     log::trace!("> {:?}", &req);
 

tests/client.rs

@@ -7,6 +7,23 @@ mod common;
 
 use common::TestCase;
 
+#[async_std::test]
+async fn test_default_user_agent() {
+    let case = TestCase::new_client(
+        "fixtures/request-user-agent.txt",
+        "fixtures/response-user-agent.txt",
+    )
+    .await;
+
+    let url = Url::parse("http://localhost:8080").unwrap();
+    let req = Request::new(Method::Get, url);
+
+    let res = client::connect(case.clone(), req).await.unwrap();
+    assert_eq!(res.status(), StatusCode::Ok);
+
+    case.assert().await;
+}
+
 #[async_std::test]
 async fn test_encode_request_add_date() {
     let case = TestCase::new_client(

tests/common/mod.rs

@@ -103,6 +103,7 @@ impl TestCase {
 
         // munge actual and expected so that we don't rely on dates matching exactly
         munge_date(&mut actual, &mut expected);
+        let expected = expected.replace("{VERSION}", env!("CARGO_PKG_VERSION"));
         pretty_assertions::assert_eq!(actual, expected);
     }
 }

tests/fixtures/request-add-date.txt

@@ -2,5 +2,6 @@ POST / HTTP/1.1
 host: localhost:8080
 content-length: 5
 content-type: text/plain;charset=utf-8
+user-agent: http-rs-h1/{VERSION}
 
 hello

tests/fixtures/request-chunked-echo.txt

@@ -3,6 +3,7 @@ host: example.com
 user-agent: curl/7.54.0
 content-type: text/plain
 transfer-encoding: chunked
+user-agent: http-rs-h1/{VERSION}
 
 7
 Mozilla

tests/fixtures/request-unexpected-eof.txt

@@ -2,5 +2,6 @@ POST / HTTP/1.1
 host: example.com
 content-type: text/plain
 content-length: 11
+user-agent: http-rs-h1/{VERSION}
 
 aaaaabbbbb

tests/fixtures/request-user-agent.txt

@@ -0,0 +1,5 @@
+GET / HTTP/1.1
+host: localhost:8080
+content-length: 0
+user-agent: http-rs-h1/{VERSION}
+

tests/fixtures/request-with-connect.txt

@@ -2,4 +2,5 @@ CONNECT example.com:443 HTTP/1.1
 host: example.com
 proxy-connection: keep-alive
 content-length: 0
+user-agent: http-rs-h1/{VERSION}
 

tests/fixtures/request-with-fragment.txt

@@ -1,4 +1,5 @@
 GET /path?query HTTP/1.1
 host: example.com
 content-length: 0
+user-agent: http-rs-h1/{VERSION}
 

tests/fixtures/request-with-host.txt

@@ -1,4 +1,5 @@
 GET /pub/WWW/TheProject.html HTTP/1.1
 Host: www.w3.org
 Content-Length: 0
+user-agent: http-rs-h1/{VERSION}
 

tests/fixtures/response-user-agent.txt

@@ -0,0 +1,5 @@
+HTTP/1.1 200 OK
+content-length: 0
+date: {DATE}
+content-type: text/plain;charset=utf-8
+