Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement API Gateway skeleton and unit tests #3

Merged
merged 1 commit into from
Mar 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,13 @@ unused = "deny"

[workspace.lints.clippy]
as_conversions = "deny"

[workspace.dependencies]
hyper = "0.13.9"
tokio = { version = "0.2", features = ["macros"] }
thiserror = "1.0"
starknet_api = "0.8.0"
serde = { version = "1.0.193", features = ["derive"] }
serde_json = "1.0"
assert_matches = "1.5.0"

7 changes: 7 additions & 0 deletions crates/gateway/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ repository.workspace = true
license.workspace = true

[dependencies]
hyper.workspace = true
tokio.workspace = true
thiserror.workspace = true
serde.workspace = true
serde_json.workspace = true
starknet_api.workspace = true
assert_matches.workspace = true

[lints]
workspace = true
19 changes: 19 additions & 0 deletions crates/gateway/src/errors.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
use thiserror::Error;

#[derive(Debug, Error)]
pub enum GatewayError {
#[error(transparent)]
ConfigError(#[from] GatewayConfigError),
#[error(transparent)]
HTTPError(#[from] hyper::http::Error),
#[error("Internal server error")]
InternalServerError,
#[error("Error while starting the server")]
ServerStartError(#[from] hyper::Error),
}

#[derive(Debug, Error)]
pub enum GatewayConfigError {
#[error("Server address is not an bind IP address: {0}")]
InvalidServerBindAddress(String),
}
57 changes: 57 additions & 0 deletions crates/gateway/src/gateway.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
use crate::errors::{GatewayConfigError, GatewayError};
use hyper::service::{make_service_fn, service_fn};
use hyper::{Body, Method, Request, Response, Server, StatusCode};
use std::convert::Infallible;
use std::net::SocketAddr;
use std::str::FromStr;

#[cfg(test)]
#[path = "gateway_test.rs"]
pub mod gateway_test;

const NOT_FOUND_RESPONSE: &str = "Not found.";
type RequestBody = Request<Body>;
type ResponseBody = Response<Body>;
pub type GatewayResult = Result<(), GatewayError>;

pub struct Gateway {
pub gateway_config: GatewayConfig,
}

impl Gateway {
pub async fn build_server(&self) -> GatewayResult {
let addr = SocketAddr::from_str(&self.gateway_config.bind_address).map_err(|_| {
GatewayConfigError::InvalidServerBindAddress(self.gateway_config.bind_address.clone())
})?;

let make_service =
make_service_fn(|_conn| async { Ok::<_, Infallible>(service_fn(handle_request)) });

Server::bind(&addr).serve(make_service).await?;

Ok(())
}
}

pub struct GatewayConfig {
pub bind_address: String,
}

async fn handle_request(request: RequestBody) -> Result<Response<Body>, GatewayError> {
let (parts, _body) = request.into_parts();
let response = match (parts.method, parts.uri.path()) {
(Method::GET, "/is_alive") => is_alive(),
_ => response(StatusCode::NOT_FOUND, NOT_FOUND_RESPONSE.to_string()),
};
response
}

fn is_alive() -> Result<ResponseBody, GatewayError> {
unimplemented!("Future handling should be implemented here.");
}

fn response(status: StatusCode, body_content: String) -> Result<Response<Body>, GatewayError> {
Ok(Response::builder()
.status(status)
.body(Body::from(body_content))?)
}
17 changes: 17 additions & 0 deletions crates/gateway/src/gateway_test.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
use crate::gateway::handle_request;
use hyper::{Body, Request};

#[tokio::test]
async fn test_invalid_request() {
// Create a sample GET request for an invalid path
let request = Request::get("/some_invalid_path")
.body(Body::empty())
.unwrap();
let response = handle_request(request).await.unwrap();

assert_eq!(response.status(), 404);
assert_eq!(
String::from_utf8_lossy(&hyper::body::to_bytes(response.into_body()).await.unwrap()),
"Not found."
);
}
3 changes: 2 additions & 1 deletion crates/gateway/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@

pub mod errors;
pub mod gateway;
Loading