Merge pull request #433 from namada-net/headers

added cache headers

Author: Fraccaman

webserver/src/entity/governance.rs

@@ -193,6 +193,13 @@ impl Proposal {
                 .expect("Should be a number"),
         }
     }
+
+    pub fn activated(&self) -> bool {
+        matches!(
+            self.status,
+            ProposalStatus::ExecutedPassed | ProposalStatus::ExecutedRejected
+        )
+    }
 }
 
 impl From<GovernanceProposalVoteDb> for ProposalVote {

webserver/src/handler/block.rs

@@ -5,46 +5,50 @@ use axum_macros::debug_handler;
 
 use crate::error::api::ApiError;
 use crate::response::block::BlockResponse;
+use crate::response::headers;
 use crate::state::common::CommonState;
 
 #[debug_handler]
 pub async fn get_block_by_height(
     _headers: HeaderMap,
     Path(value): Path<i32>,
     State(state): State<CommonState>,
-) -> Result<Json<BlockResponse>, ApiError> {
+) -> Result<(HeaderMap, Json<BlockResponse>), ApiError> {
     let (block, prev_block, transactions) =
         state.block_service.get_block_by_height(value).await?;
 
     let response = BlockResponse::from(block, prev_block, transactions);
+    let headers = headers::with_cache();
 
-    Ok(Json(response))
+    Ok((headers, Json(response)))
 }
 
 #[debug_handler]
 pub async fn get_block_by_timestamp(
     _headers: HeaderMap,
     Path(value): Path<i64>,
     State(state): State<CommonState>,
-) -> Result<Json<BlockResponse>, ApiError> {
+) -> Result<(HeaderMap, Json<BlockResponse>), ApiError> {
     let (block, prev_block, transactions) =
         state.block_service.get_block_by_timestamp(value).await?;
 
     let response = BlockResponse::from(block, prev_block, transactions);
+    let headers = headers::with_cache();
 
-    Ok(Json(response))
+    Ok((headers, Json(response)))
 }
 
 #[debug_handler]
 pub async fn get_block_by_hash(
     _headers: HeaderMap,
     Path(value): Path<String>,
     State(state): State<CommonState>,
-) -> Result<Json<BlockResponse>, ApiError> {
+) -> Result<(HeaderMap, Json<BlockResponse>), ApiError> {
     let (block, prev_block, transactions) =
         state.block_service.get_block_by_hash(value).await?;
 
     let response = BlockResponse::from(block, prev_block, transactions);
+    let headers = headers::with_cache();
 
-    Ok(Json(response))
+    Ok((headers, Json(response)))
 }

webserver/src/handler/governance.rs

@@ -9,6 +9,7 @@ use crate::error::governance::GovernanceError;
 use crate::response::governance::{
     ProposalDataResponse, ProposalResponse, ProposalVoteResponse,
 };
+use crate::response::headers;
 use crate::response::utils::PaginatedResponse;
 use crate::state::common::CommonState;
 
@@ -47,14 +48,19 @@ pub async fn get_governance_proposal_by_id(
     _headers: HeaderMap,
     Path(proposal_id): Path<u64>,
     State(state): State<CommonState>,
-) -> Result<Json<ProposalResponse>, ApiError> {
+) -> Result<(HeaderMap, Json<ProposalResponse>), ApiError> {
     let proposal = state
         .gov_service
         .find_governance_proposal_by_id(proposal_id)
         .await?;
 
     if let Some(proposal) = proposal {
-        Ok(Json(ProposalResponse::from(proposal)))
+        let headers = if proposal.activated() {
+            headers::with_cache()
+        } else {
+            headers::without_cache()
+        };
+        Ok((headers, Json(ProposalResponse::from(proposal))))
     } else {
         Err(GovernanceError::NotFound(proposal_id).into())
     }
@@ -65,12 +71,13 @@ pub async fn get_proposal_data_by_proposal_id(
     _headers: HeaderMap,
     Path(proposal_id): Path<u64>,
     State(state): State<CommonState>,
-) -> Result<Json<ProposalDataResponse>, ApiError> {
+) -> Result<(HeaderMap, Json<ProposalDataResponse>), ApiError> {
     let proposal = state.gov_service.find_proposal_data(proposal_id).await?;
 
     let response = ProposalDataResponse::from(proposal);
+    let headers = headers::with_cache();
 
-    Ok(Json(response))
+    Ok((headers, Json(response)))
 }
 
 #[debug_handler]

webserver/src/handler/pk.rs

@@ -4,6 +4,7 @@ use axum::http::HeaderMap;
 use axum_macros::debug_handler;
 
 use crate::error::api::ApiError;
+use crate::response::headers;
 use crate::response::revealed_pk::RevealedPkResponse;
 use crate::state::common::CommonState;
 
@@ -12,15 +13,20 @@ pub async fn get_revealed_pk(
     _headers: HeaderMap,
     Path(address): Path<String>,
     State(state): State<CommonState>,
-) -> Result<Json<RevealedPkResponse>, ApiError> {
+) -> Result<(HeaderMap, Json<RevealedPkResponse>), ApiError> {
     let revealed_pk = state
         .revealed_pk_service
         .get_revealed_pk_by_address(&state.client, address)
         .await?;
 
     let response = RevealedPkResponse {
-        public_key: revealed_pk.public_key,
+        public_key: revealed_pk.public_key.clone(),
+    };
+    let headers = if revealed_pk.public_key.is_some() {
+        headers::with_cache()
+    } else {
+        headers::without_cache()
     };
 
-    Ok(Json(response))
+    Ok((headers, Json(response)))
 }

webserver/src/handler/transaction.rs

@@ -10,6 +10,7 @@ use crate::dto::transaction::{
 };
 use crate::error::api::ApiError;
 use crate::error::transaction::TransactionError;
+use crate::response::headers;
 use crate::response::transaction::{
     InnerTransactionResponse, TransactionHistoryResponse,
     WrapperTransactionResponse,
@@ -22,7 +23,7 @@ pub async fn get_wrapper_tx(
     _headers: HeaderMap,
     Path(tx_id): Path<TransactionIdParam>,
     State(state): State<CommonState>,
-) -> Result<Json<Option<WrapperTransactionResponse>>, ApiError> {
+) -> Result<(HeaderMap, Json<Option<WrapperTransactionResponse>>), ApiError> {
     tx_id.is_valid_hash()?;
 
     let tx_id = tx_id.get();
@@ -43,16 +44,17 @@ pub async fn get_wrapper_tx(
 
     let response = wrapper_tx
         .map(|wrapper| WrapperTransactionResponse::new(wrapper, inner_txs));
+    let headers = headers::with_cache();
 
-    Ok(Json(response))
+    Ok((headers, Json(response)))
 }
 
 #[debug_handler]
 pub async fn get_inner_tx(
     _headers: HeaderMap,
     Path(tx_id): Path<TransactionIdParam>,
     State(state): State<CommonState>,
-) -> Result<Json<Option<InnerTransactionResponse>>, ApiError> {
+) -> Result<(HeaderMap, Json<Option<InnerTransactionResponse>>), ApiError> {
     tx_id.is_valid_hash()?;
 
     let tx_id = tx_id.get();
@@ -63,8 +65,9 @@ pub async fn get_inner_tx(
         .await?;
 
     let response = inner_tx.map(InnerTransactionResponse::new);
+    let headers = headers::with_cache();
 
-    Ok(Json(response))
+    Ok((headers, Json(response)))
 }
 
 #[debug_handler]

webserver/src/response/headers.rs

@@ -0,0 +1,20 @@
+use axum::http::header::CACHE_CONTROL;
+use axum::http::{HeaderMap, HeaderValue};
+
+pub fn with_cache() -> HeaderMap {
+    let mut headers = HeaderMap::new();
+    headers.insert(
+        CACHE_CONTROL,
+        HeaderValue::from_static("public, max-age=31536000, immutable"),
+    );
+    headers
+}
+
+pub fn without_cache() -> HeaderMap {
+    let mut headers = HeaderMap::new();
+    headers.insert(
+        CACHE_CONTROL,
+        HeaderValue::from_static("no-cache, no-store, must-revalidate"),
+    );
+    headers
+}

webserver/src/response/mod.rs

@@ -5,6 +5,7 @@ pub mod chain;
 pub mod crawler_state;
 pub mod gas;
 pub mod governance;
+pub mod headers;
 pub mod ibc;
 pub mod masp;
 pub mod pgf;