feat: migrate http request and response types from ic-response-verification to ic-http-certification

BREAKING CHANGE:

Author: nathanosdev

Cargo.lock

@@ -76,6 +76,7 @@ getrandom = { version = "0.2", features = ["js"] }
 
 
 ic-certification = { path = "./packages/ic-certification", default-features = false, version = "1.3.0" }
+ic-http-certification = { path = "./packages/ic-http-certification", version = "1.3.0" }
 ic-certification-testing = { path = "./packages/ic-certification-testing" }
 ic-representation-independent-hash = { path = "./packages/ic-representation-independent-hash", version = "1.3.0" }
 ic-certificate-verification = { path = "./packages/ic-certificate-verification", version = "1.3.0" }

Cargo.toml

@@ -70,10 +70,6 @@ try {
         console.log(`Error parsing cbor: ${error.message}`);
         break;
 
-      case ResponseVerificationErrorCode.MalformedUrl:
-        console.log(`Invalid URL provided: ${error.message}`);
-        break;
-
       case ResponseVerificationErrorCode.CertificateVerificationFailed:
         console.log(`Certificate verification failed: ${error.message}`);
         break;

examples/nodejs/src/index.ts

@@ -5,6 +5,7 @@ edition = "2021"
 
 [dependencies]
 ic-response-verification.workspace = true
+ic-http-certification.workspace = true
 candid.workspace = true
 hex.workspace = true
 serde.workspace = true

examples/rust/Cargo.toml

@@ -1,28 +1,13 @@
-use candid::{CandidType, Decode, Deserialize, Principal};
-use ic_response_verification::types::{Request, Response};
+use candid::{Decode, Principal};
+use ic_http_certification::{HttpRequest, HttpResponse};
 use ic_response_verification::{verify_request_response_pair, MIN_VERIFICATION_VERSION};
 
-#[derive(Debug, Clone, CandidType, Deserialize)]
-struct HttpRequest {
-    pub url: String,
-    pub headers: Vec<(String, String)>,
-    #[serde(with = "serde_bytes")]
-    pub body: Vec<u8>,
-}
-
-#[derive(Debug, Clone, CandidType, Deserialize)]
-pub struct HttpResponse {
-    pub headers: Vec<(String, String)>,
-    #[serde(with = "serde_bytes")]
-    pub body: Vec<u8>,
-}
-
 fn main() {
     let request_hex = "4449444C046D7B6C02007101716D016C04EFD6E40271E1EDEB4A71A2F5ED880400C6A4A19806020103012F03474554000704486F73742372646D78362D6A616161612D61616161612D61616164712D6361692E6963302E617070066163636570748701746578742F68746D6C2C6170706C69636174696F6E2F7868746D6C2B786D6C2C6170706C69636174696F6E2F786D6C3B713D302E392C696D6167652F617669662C696D6167652F776562702C696D6167652F61706E672C2A2F2A3B713D302E382C6170706C69636174696F6E2F7369676E65642D65786368616E67653B763D62333B713D302E39097365632D63682D756128224368726F6D69756D223B763D22313037222C20224E6F743D413F4272616E64223B763D22323422107365632D63682D75612D6D6F62696C65023F30127365632D63682D75612D706C6174666F726D092257696E646F77732219757067726164652D696E7365637572652D726571756573747301310A757365722D6167656E74744D6F7A696C6C612F352E30202857696E646F7773204E542031302E303B2057696E36343B2078363429204170706C655765624B69742F3533372E333620284B48544D4C2C206C696B65204765636B6F29204368726F6D652F3130372E302E353330342E313037205361666172692F3533372E3336";
     let request_candid = hex::decode(request_hex).expect("Could not decode request from hex");
     let http_request =
         Decode!(&request_candid, HttpRequest).expect("Could not decode request from candid");
-    let request = Request {
+    let request = HttpRequest {
         method: "GET".into(),
         url: http_request.url,
         headers: http_request.headers,
@@ -39,7 +24,7 @@ fn main() {
     let http_response =
         Decode!(&response_candid, HttpResponse).expect("Could not decode response from candid");
 
-    let response = Response {
+    let response = HttpResponse {
         status_code: 200,
         headers: http_response.headers,
         body: http_response.body,

examples/rust/src/main.rs

@@ -73,10 +73,6 @@ self.addEventListener('activate', async () => {
           console.log(`Error parsing cbor: ${error.message}`);
           break;
 
-        case ResponseVerificationErrorCode.MalformedUrl:
-          console.log(`Invalid URL provided: ${error.message}`);
-          break;
-
         case ResponseVerificationErrorCode.CertificateVerificationFailed:
           console.log(`Certificate verification failed: ${error.message}`);
           break;

examples/service-worker/src/sw.ts

@@ -73,10 +73,6 @@ window.addEventListener('load', async () => {
           console.log(`Error parsing cbor: ${error.message}`);
           break;
 
-        case ResponseVerificationErrorCode.MalformedUrl:
-          console.log(`Invalid URL provided: ${error.message}`);
-          break;
-
         case ResponseVerificationErrorCode.CertificateVerificationFailed:
           console.log(`Certificate verification failed: ${error.message}`);
           break;

examples/web/src/index.ts

@@ -14,5 +14,12 @@ repository.workspace = true
 license.workspace = true
 homepage.workspace = true
 
+[dependencies]
+candid.workspace = true
+serde.workspace = true
+http.workspace = true
+urlencoding.workspace = true
+thiserror.workspace = true
+
 [dev-dependencies]
 rstest.workspace = true

packages/ic-http-certification/Cargo.toml

@@ -1,5 +1,5 @@
-//! The CEL modules contains functions and builders for creating CEL expression
-//! definitions and conveting them into their `String` representation.
+//! The CEL module contains functions and builders for creating CEL expression
+//! definitions and converting them into their `String` representation.
 
 mod cel_builder;
 pub use cel_builder::*;

packages/ic-http-certification/src/cel/mod.rs

@@ -0,0 +1,17 @@
+//! The error module contains types for common errors that may be thrown
+//! by other modules in this crate.
+
+/// HTTP certification result type.
+pub type HttpCertificationResult<T = ()> = Result<T, HttpCertificationError>;
+
+/// HTTP certification error type.
+#[derive(thiserror::Error, Debug)]
+pub enum HttpCertificationError {
+    /// The URL was malformed and could not be parsed correctly.
+    #[error(r#"Failed to parse url: "{0}""#)]
+    MalformedUrl(String),
+
+    /// Error converting UTF-8 string.
+    #[error(r#"Error converting UTF8 string bytes: "{0}""#)]
+    Utf8ConversionError(#[from] std::string::FromUtf8Error),
+}