Merge pull request #230 from EspressoSystems/jb/status-code

Change `StatusCode` to handle unknown status codes
EspressoSystems · Jun 5, 2024 · c99d61d · c99d61d
2 parents eeb345c + 859d6bd
commit c99d61d
Show file tree

Hide file tree

Showing 14 changed files with 175 additions and 543 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "tide-disco"
-version = "0.7.0"
+version = "0.8.0"
 edition = "2021"
 authors = ["Espresso Systems <hello@espressosys.com>"]
 description = "Discoverability for Tide"
@@ -41,8 +41,6 @@ lazy_static = "1.4"
 libc = "0.2"
 markdown = "0.3"
 maud = { version = "0.26", features = ["tide"] }
-num-derive = "0.4"
-num-traits = "0.2"
 parking_lot = "0.12"
 prometheus = "0.13"
 reqwest = { version = "0.12", features = ["json"] }

diff --git a/examples/hello-world/main.rs b/examples/hello-world/main.rs
@@ -37,7 +37,7 @@ impl tide_disco::Error for HelloError {
 
 impl From<RequestError> for HelloError {
     fn from(err: RequestError) -> Self {
-        Self::catch_all(StatusCode::BadRequest, err.to_string())
+        Self::catch_all(StatusCode::BAD_REQUEST, err.to_string())
     }
 }
 
@@ -116,14 +116,14 @@ mod test {
         let client = Client::new(url).await;
 
         let res = client.get("greeting/tester").send().await.unwrap();
-        assert_eq!(res.status(), StatusCode::Ok);
+        assert_eq!(res.status(), StatusCode::OK);
         assert_eq!(res.json::<String>().await.unwrap(), "Hello, tester");
 
         let res = client.post("greeting/Sup").send().await.unwrap();
-        assert_eq!(res.status(), StatusCode::Ok);
+        assert_eq!(res.status(), StatusCode::OK);
 
         let res = client.get("greeting/tester").send().await.unwrap();
-        assert_eq!(res.status(), StatusCode::Ok);
+        assert_eq!(res.status(), StatusCode::OK);
         assert_eq!(res.json::<String>().await.unwrap(), "Sup, tester");
     }
 
@@ -138,7 +138,7 @@ mod test {
 
         // Check the API version.
         let res = client.get("hello/version").send().await.unwrap();
-        assert_eq!(res.status(), StatusCode::Ok);
+        assert_eq!(res.status(), StatusCode::OK);
         let api_version = ApiVersion {
             api_version: Some(env!("CARGO_PKG_VERSION").parse().unwrap()),
             spec_version: "0.1.0".parse().unwrap(),
@@ -147,7 +147,7 @@ mod test {
 
         // Check the overall version.
         let res = client.get("version").send().await.unwrap();
-        assert_eq!(res.status(), StatusCode::Ok);
+        assert_eq!(res.status(), StatusCode::OK);
         assert_eq!(
             res.json::<AppVersion>().await.unwrap(),
             AppVersion {
@@ -169,7 +169,7 @@ mod test {
 
         // Check the API health.
         let res = client.get("hello/healthcheck").send().await.unwrap();
-        assert_eq!(res.status(), StatusCode::Ok);
+        assert_eq!(res.status(), StatusCode::OK);
         // The example API does not have a custom healthcheck, so we just get the default response.
         assert_eq!(
             res.json::<HealthStatus>().await.unwrap(),
@@ -178,12 +178,12 @@ mod test {
 
         // Check the overall health.
         let res = client.get("healthcheck").send().await.unwrap();
-        assert_eq!(res.status(), StatusCode::Ok);
+        assert_eq!(res.status(), StatusCode::OK);
         assert_eq!(
             res.json::<AppHealth>().await.unwrap(),
             AppHealth {
                 status: HealthStatus::Available,
-                modules: [("hello".to_string(), [(0, StatusCode::Ok)].into())].into(),
+                modules: [("hello".to_string(), [(0, StatusCode::OK)].into())].into(),
             }
         )
     }

diff --git a/examples/versions/main.rs b/examples/versions/main.rs
@@ -79,7 +79,7 @@ mod test {
                 .unwrap()
         );
         assert_eq!(
-            StatusCode::NotFound,
+            StatusCode::NOT_FOUND,
             client.get("v1/api/added").send().await.unwrap().status()
         );
 
@@ -95,7 +95,7 @@ mod test {
                 .unwrap()
         );
         assert_eq!(
-            StatusCode::NotFound,
+            StatusCode::NOT_FOUND,
             client.get("v2/api/deleted").send().await.unwrap().status()
         );
 
@@ -111,7 +111,7 @@ mod test {
                 .unwrap()
         );
         assert_eq!(
-            StatusCode::NotFound,
+            StatusCode::NOT_FOUND,
             client.get("api/deleted").send().await.unwrap().status()
         );
     }

diff --git a/src/api.rs b/src/api.rs
@@ -1545,7 +1545,7 @@ mod test {
                 |_req, _conn: Connection<(), (), _, StaticVer01>, _state| {
                     async move {
                         Err(ServerError::catch_all(
-                            StatusCode::InternalServerError,
+                            StatusCode::INTERNAL_SERVER_ERROR,
                             "an error message".to_string(),
                         ))
                     }
@@ -1669,7 +1669,7 @@ mod test {
                     // We intentionally return a stream that never terminates, to check that simply
                     // yielding an error causes the connection to terminate.
                     repeat(Err(ServerError::catch_all(
-                        StatusCode::InternalServerError,
+                        StatusCode::INTERNAL_SERVER_ERROR,
                         "an error message".to_string(),
                     )))
                     .boxed()
@@ -1737,7 +1737,7 @@ mod test {
         let client = Client::new(url).await;
 
         let res = client.get("/mod/healthcheck").send().await.unwrap();
-        assert_eq!(res.status(), StatusCode::Ok);
+        assert_eq!(res.status(), StatusCode::OK);
         assert_eq!(
             res.json::<HealthStatus>().await.unwrap(),
             HealthStatus::Available
@@ -1793,7 +1793,7 @@ mod test {
             tracing::info!("making metrics request {i}");
             let expected = format!("# HELP counter count of how many times metrics have been exported\n# TYPE counter counter\ncounter {i}\n");
             let res = client.get("mod/metrics").send().await.unwrap();
-            assert_eq!(res.status(), StatusCode::Ok);
+            assert_eq!(res.status(), StatusCode::OK);
             assert_eq!(res.text().await.unwrap(), expected);
         }
     }