cardinal-plugins 0.2.41

Middleware registry and execution engine for the Cardinal gateway
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

use crate::container::PluginContainer;
use crate::request_context::RequestContext;
use crate::runner::MiddlewareResult;
use cardinal_errors::CardinalError;
use pingora::prelude::Session;
use pingora::BError;
use std::sync::Arc;

#[async_trait::async_trait]
pub trait CardinalPluginExecutor: Send + Sync {
    async fn get_plugin_container(
        &self,
        _session: &mut Session,
        req_ctx: &mut RequestContext,
    ) -> pingora::Result<Arc<PluginContainer>, CardinalError>
    where
        Self: Send + Sync,
    {
        let filter_container = req_ctx.cardinal_context.get::<PluginContainer>().await?;
        Ok(filter_container)
    }

    async fn can_run_plugin(
        &self,
        _binding_id: &str,
        _session: &mut Session,
        _req_ctx: &mut RequestContext,
    ) -> Result<bool, BError>
    where
        Self: Send + Sync,
    {
        Ok(true)
    }

    async fn run_request_filter(
        &self,
        name: &str,
        session: &mut Session,
        req_ctx: &mut RequestContext,
    ) -> Result<MiddlewareResult, CardinalError> {
        let plugin_container = self.get_plugin_container(session, req_ctx).await?;
        plugin_container
            .run_request_filter(name, session, req_ctx)
            .await
    }

    async fn run_response_filter(
        &self,
        name: &str,
        session: &mut Session,
        req_ctx: &mut RequestContext,
        response: &mut pingora::http::ResponseHeader,
    ) -> Result<(), CardinalError> {
        let plugin_container = self.get_plugin_container(session, req_ctx).await?;

        plugin_container
            .run_response_filter(name, session, req_ctx, response)
            .await;

        Ok(())
    }
}