feat(ic-http-certification): add request method enum

dfinity · Nov 28, 2024 · cea276c · cea276c
1 parent 7e3f70d
commit cea276c
Show file tree

Hide file tree

Showing 7 changed files with 165 additions and 98 deletions.
diff --git a/examples/http-certification/custom-assets/README.md b/examples/http-certification/custom-assets/README.md
@@ -173,7 +173,7 @@ fn create_asset_response(
     let headers = get_asset_headers(additional_headers, body.len(), cel_expr);
 
     HttpResponse::builder()
-        .with_status_code(200)
+        .with_status_code(StatusCode::OK)
         .with_headers(headers)
         .with_body(body)
         .build()
@@ -569,7 +569,7 @@ fn create_uncertified_response() -> HttpResponse<'static> {
     );
 
     HttpResponse::builder()
-        .with_status_code(200)
+        .with_status_code(StatusCode::OK)
         .with_headers(headers)
         .with_body(body)
         .build()

diff --git a/examples/http-certification/json-api/README.md b/examples/http-certification/json-api/README.md
@@ -142,7 +142,7 @@ Some headers from this project have not been included:
 To facilitate the consistent usage of these headers, there is a reusable `create_response` function used when creating responses:
 
 ```rust
-fn create_response(status_code: u16, body: Vec<u8>) -> HttpResponse<'static> {
+fn create_response(status_code: StatusCode, body: Vec<u8>) -> HttpResponse<'static> {
     HttpResponse::builder()
         .with_status_code(status_code)
         .with_headers(vec![
@@ -270,25 +270,32 @@ fn certify_list_todos_response() {
         )
         .encode()
     });
-    let mut response = create_response(200, body);
+    let mut response = create_response(StatusCode::OK, body);
 
     certify_response(request, &mut response, &TODOS_TREE_PATH);
 }
 
 fn certify_not_allowed_todo_responses() {
-    ["HEAD", "PUT", "PATCH", "OPTIONS", "TRACE", "CONNECT"]
-        .into_iter()
-        .for_each(|method| {
-            let request = HttpRequest::builder()
-                .with_method(method)
-                .with_url(TODOS_PATH)
-                .build();
-
-            let body = ErrorResponse::not_allowed().encode();
-            let mut response = create_response(405, body);
-
-            certify_response(request, &mut response, &TODOS_TREE_PATH);
-        });
+    [
+        Method::HEAD,
+        Method::PUT,
+        Method::PATCH,
+        Method::OPTIONS,
+        Method::TRACE,
+        Method::CONNECT,
+    ]
+    .into_iter()
+    .for_each(|method| {
+        let request = HttpRequest::builder()
+            .with_method(method)
+            .with_url(TODOS_PATH)
+            .build();
+
+        let body = ErrorResponse::not_allowed().encode();
+        let mut response = create_response(StatusCode::METHOD_NOT_ALLOWED, body);
+
+        certify_response(request, &mut response, &TODOS_TREE_PATH);
+    });
 }
 ```
 
@@ -301,7 +308,7 @@ Certifying the "Not found" response requires a slightly different procedure. Thi
 ```rust
 fn certify_not_found_response() {
     let body = ErrorResponse::not_found().encode();
-    let mut response = create_response(404, body);
+    let mut response = create_response(StatusCode::NOT_FOUND, body);
 
     let tree_path = HttpCertificationPath::wildcard(NOT_FOUND_PATH);
 
@@ -401,7 +408,7 @@ When update calls are made to endpoints that do not update state, return an erro
 
 ```rust
 fn no_update_call_handler(_http_request: &HttpRequest, _params: &Params) -> HttpResponse<'static> {
-    create_response(405, vec![])
+    create_response(StatusCode::BAD_REQUEST, vec![])
 }
 ```
 
@@ -447,7 +454,7 @@ fn create_todo_item_handler(req: &HttpRequest, _params: &Params) -> HttpResponse
     certify_list_todos_response();
 
     let body = CreateTodoItemResponse::ok(&todo_item).encode();
-    create_response(201, body)
+    create_response(StatusCode::CREATED, body)
 }
 ```
 
@@ -473,7 +480,7 @@ fn update_todo_item_handler(req: &HttpRequest, params: &Params) -> HttpResponse<
     certify_list_todos_response();
 
     let body = UpdateTodoItemResponse::ok(&()).encode();
-    create_response(200, body)
+    create_response(StatusCode::OK, body)
 }
 ```
 
@@ -490,7 +497,7 @@ fn delete_todo_item_handler(_req: &HttpRequest, params: &Params) -> HttpResponse
     certify_list_todos_response();
 
     let body = DeleteTodoItemResponse::ok(&()).encode();
-    create_response(204, body)
+    create_response(StatusCode::NO_CONTENT, body)
 }
 ```
 

diff --git a/examples/http-certification/json-api/src/backend/src/lib.rs b/examples/http-certification/json-api/src/backend/src/lib.rs
@@ -6,7 +6,7 @@ use ic_http_certification::{
     utils::add_v2_certificate_header, DefaultCelBuilder, DefaultFullCelExpression,
     DefaultResponseCertification, DefaultResponseOnlyCelExpression, HttpCertification,
     HttpCertificationPath, HttpCertificationTree, HttpCertificationTreeEntry, HttpRequest,
-    HttpResponse, StatusCode, CERTIFICATE_EXPRESSION_HEADER_NAME,
+    HttpResponse, Method, StatusCode, CERTIFICATE_EXPRESSION_HEADER_NAME,
 };
 use lazy_static::lazy_static;
 use matchit::{Params, Router};
@@ -46,7 +46,9 @@ fn http_request(req: HttpRequest) -> HttpResponse<'static> {
     let req_path = req.get_path().expect("Failed to get req path");
 
     QUERY_ROUTER.with_borrow(|query_router| {
-        let method_router = query_router.get(&req.method().to_uppercase()).unwrap();
+        let method_router = query_router
+            .get(&req.method().as_str().to_uppercase())
+            .unwrap();
         let handler_match = method_router.at(&req_path).unwrap();
         let handler = handler_match.value;
 
@@ -59,7 +61,9 @@ fn http_request_update(req: HttpRequest) -> HttpResponse<'static> {
     let req_path = req.get_path().expect("Failed to get req path");
 
     UPDATE_ROUTER.with_borrow(|update_router| {
-        let method_router = update_router.get(&req.method().to_uppercase()).unwrap();
+        let method_router = update_router
+            .get(&req.method().as_str().to_uppercase())
+            .unwrap();
         let handler_match = method_router.at(&req_path).unwrap();
         let handler = handler_match.value;
 
@@ -182,19 +186,26 @@ fn certify_list_todos_response() {
 }
 
 fn certify_not_allowed_todo_responses() {
-    ["HEAD", "PUT", "PATCH", "OPTIONS", "TRACE", "CONNECT"]
-        .into_iter()
-        .for_each(|method| {
-            let request = HttpRequest::builder()
-                .with_method(method)
-                .with_url(TODOS_PATH)
-                .build();
-
-            let body = ErrorResponse::not_allowed().encode();
-            let mut response = create_response(StatusCode::METHOD_NOT_ALLOWED, body);
-
-            certify_response(request, &mut response, &TODOS_TREE_PATH);
-        });
+    [
+        Method::HEAD,
+        Method::PUT,
+        Method::PATCH,
+        Method::OPTIONS,
+        Method::TRACE,
+        Method::CONNECT,
+    ]
+    .into_iter()
+    .for_each(|method| {
+        let request = HttpRequest::builder()
+            .with_method(method)
+            .with_url(TODOS_PATH)
+            .build();
+
+        let body = ErrorResponse::not_allowed().encode();
+        let mut response = create_response(StatusCode::METHOD_NOT_ALLOWED, body);
+
+        certify_response(request, &mut response, &TODOS_TREE_PATH);
+    });
 }
 
 fn certify_not_found_response() {

diff --git a/examples/http-certification/upgrade-to-update-call/README.md b/examples/http-certification/upgrade-to-update-call/README.md
@@ -36,7 +36,7 @@ fn http_request() -> HttpResponse<'static> {
 #[update]
 fn http_request_update() -> HttpUpdateResponse<'static> {
     HttpResponse::builder()
-        .with_status_code(418)
+        .with_status_code(StatusCode::IM_A_TEAPOT)
         .with_body(b"I'm a teapot")
         .build_update()
 }