docs: add documentation to auth middleware

Signed-off-by: Gustavo Inacio <[email protected]>

Author: gusinacio

crates/service/src/middleware/auth/or.rs

@@ -12,6 +12,7 @@ use axum::http::{Request, Response};
 use pin_project::pin_project;
 use tower_http::{auth::AsyncAuthorizeRequest, validate_request::ValidateRequest};
 
+/// Extension that allows using a simple .or() function and return an Or struct
 pub trait OrExt<T, B, Resp>: Sized {
     fn or(self, other: T) -> Or<Self, T, B, Resp>;
 }
@@ -32,6 +33,11 @@ where
     }
 }
 
+/// Or struct capable of implementing a ValidateRequest or an AsyncAuthorizeRequest
+///
+/// Uses the first parameter to validate the request sync.
+/// if it passes the check return the request to pass to the next middleware
+/// if it doesn't pass, check the async future returning the result
 pub struct Or<T, E, B, Resp>(T, E, PhantomData<fn(B) -> Resp>);
 
 impl<T, E, B, Resp> Clone for Or<T, E, B, Resp>

crates/service/src/middleware/auth/tap.rs

@@ -21,8 +21,13 @@ use tap_core::{
 };
 use tower_http::auth::AsyncAuthorizeRequest;
 
-use crate::{error::IndexerServiceError, middleware::metrics::MetricLabels};
+use crate::{error::IndexerServiceError, middleware::prometheus_metrics::MetricLabels};
 
+/// Middleware to verify and store TAP receipts
+///
+/// It also optionally updates a failed receipt metric if Labels are provided
+///
+/// Requires SignedReceipt, MetricLabels and Arc<Context> extensions
 pub fn tap_receipt_authorize<T, B>(
     tap_manager: &'static Manager<T>,
     failed_receipt_metric: &'static prometheus::CounterVec,
@@ -93,7 +98,7 @@ mod tests {
     use crate::{
         middleware::{
             auth::tap_receipt_authorize,
-            metrics::{MetricLabelProvider, MetricLabels},
+            prometheus_metrics::{MetricLabelProvider, MetricLabels},
         },
         tap::IndexerTapContext,
     };

crates/service/src/middleware/inject_context.rs

@@ -20,12 +20,14 @@ use thegraph_core::DeploymentId;
 
 use crate::{error::IndexerServiceError, tap::AgoraQuery};
 
+/// Graphql query body to be decoded and passed to agora context
 #[derive(Debug, serde::Deserialize, serde::Serialize)]
 struct QueryBody {
     query: String,
     variables: Option<Box<RawValue>>,
 }
 
+/// Injects tap context in the extensions to be used by tap_receipt_authorize
 pub async fn context_middleware(
     mut request: Request,
     next: Next,