refactor: adjust http proxy plugin handle

Author: vicanso

Cargo.lock

@@ -48,6 +48,7 @@ reqwest = { version = "0.11.27", features = ["json"] }
 rust-embed = { version = "8.3.0", features = ["mime-guess", "compression"] }
 serde = "1.0.197"
 serde_json = "1.0.115"
+serde_repr = "0.1.19"
 snafu = "0.8.2"
 substring = "1.4.5"
 tempfile = "3.10.1"

Cargo.toml

@@ -40,21 +40,25 @@ All toml configurations are as follows [pingap.toml](./conf/pingap.toml).
 
 ```mermaid
 graph TD;
-    start("new request")-->server;
+    start("New Request")-->server("HTTP Server");
 
-    server -- "host:HostA, Path:/api/*" --> locationA
+    server -- "host:HostA, Path:/api/*" --> locationA("Location A")
 
-    server -- "Path:/rest/*"--> locationB
+    server -- "Path:/rest/*"--> locationB("Location B")
 
-    locationA -- "10.0.0.1:8001" --> upstreamA1 --> response
+    locationA -- "Exec Plugins" --> locationPluginListA("Plugin List A")
 
-    locationA -- "10.0.0.2:8001" --> upstreamA2 --> response
+    locationB -- "Exec Plugins" --> locationPluginListB("Plugin List B")
 
-    locationB -- "10.0.0.1:8002" --> upstreamB1 --> response
+    locationPluginListA -- "10.0.0.1:8001" --> upstreamA1("Upstream A1") --> response
 
-    locationB -- "10.0.0.2:8002" --> upstreamB2 --> response
+    locationPluginListA -- "10.0.0.2:8001" --> upstreamA2("Upstream A2") --> response
 
-    response --> stop("logging");
+    locationPluginListB -- "10.0.0.1:8002" --> upstreamB1("Upstream B1") --> response
+
+    locationPluginListB -- "10.0.0.2:8002" --> upstreamB2("Upstream B2") --> response
+
+    response("HTTP Response") --> stop("Logging");
 ```
 
 ## Performance

README.md

@@ -5,12 +5,11 @@ description: Pingap 简述
 Pingap是基于[pingora](https://github.com/cloudflare/pingora)开发的，pingora提供了各类模块便于rust开发者使用，但并不方便非rust开发者使用，因此pingap提供了以toml的形式配置简单易用的反向代理，实现支持多location代理转发。特性如下：
 
 - 支持多location配置，可通过请求的路径与域名筛选
-- 支持静态文件目录处理，简单方便的chunk的形式响应静态文件
-- 支持mock的响应配置，方便测试或应急使用
 - 支持HTTP1与HTTP2两种协议
 - 无中断请求的配置更新，方便实时更新应用配置
 - 模板式的请求日志输出，可按模板指定各种输出
 - 提供Web界面式的配置，简化操作
+- 支持各种插件形式，根据需要灵活配置各种特性：如静态文件目录、服务性能指标、WEB后台配置应用等
 
 [Pingap处理流程](./phase_chart_zh.md)
 

build.sh

@@ -17,6 +17,7 @@ use base64::{engine::general_purpose::STANDARD, Engine};
 use glob::glob;
 use http::HeaderValue;
 use serde::{Deserialize, Serialize};
+use serde_repr::{Deserialize_repr, Serialize_repr};
 use snafu::{ensure, ResultExt, Snafu};
 use std::collections::HashMap;
 use std::path::Path;
@@ -64,7 +65,8 @@ pub enum Error {
 }
 type Result<T, E = Error> = std::result::Result<T, E>;
 
-#[derive(PartialEq, Debug, Default, Deserialize, Clone, Serialize)]
+#[derive(PartialEq, Debug, Default, Deserialize_repr, Clone, Serialize_repr)]
+#[repr(u8)]
 pub enum ProxyPluginCategory {
     #[default]
     Stats,
@@ -75,10 +77,19 @@ pub enum ProxyPluginCategory {
     Mock,
 }
 
+#[derive(PartialEq, Debug, Default, Deserialize_repr, Clone, Copy, Serialize_repr)]
+#[repr(u8)]
+pub enum ProxyPluginStep {
+    #[default]
+    RequestFilter,
+    ProxyUpstreamFilter,
+}
+
 #[derive(Debug, Default, Deserialize, Clone, Serialize)]
 pub struct ProxyPluginConf {
     pub value: String,
     pub category: ProxyPluginCategory,
+    pub step: Option<ProxyPluginStep>,
     pub remark: Option<String>,
 }
 

docs/introduction_zh.md

@@ -18,8 +18,8 @@ mod load;
 
 pub use load::{
     load_config, save_config, LocationConf, PingapConf, ProxyPluginCategory, ProxyPluginConf,
-    ServerConf, UpstreamConf, CATEGORY_LOCATION, CATEGORY_PROXY_PLUGIN, CATEGORY_SERVER,
-    CATEGORY_UPSTREAM,
+    ProxyPluginStep, ServerConf, UpstreamConf, CATEGORY_LOCATION, CATEGORY_PROXY_PLUGIN,
+    CATEGORY_SERVER, CATEGORY_UPSTREAM,
 };
 
 static CONFIG_PATH: OnceCell<String> = OnceCell::new();

src/config/load.rs

@@ -200,6 +200,7 @@ fn run() -> Result<(), Box<dyn Error>> {
                 value: format!("/ {authorization}"),
                 category: ProxyPluginCategory::Admin,
                 remark: Some("Admin serve".to_string()),
+                step: None,
             },
         ));
         server_conf_list.push(ServerConf {

src/config/mod.rs

@@ -13,7 +13,10 @@
 // limitations under the License.
 
 use super::{ProxyPlugin, Result};
-use crate::config::{self, save_config, LocationConf, ProxyPluginConf, ServerConf, UpstreamConf};
+use crate::config::{
+    self, save_config, LocationConf, ProxyPluginCategory, ProxyPluginConf, ProxyPluginStep,
+    ServerConf, UpstreamConf,
+};
 use crate::config::{
     PingapConf, CATEGORY_LOCATION, CATEGORY_PROXY_PLUGIN, CATEGORY_SERVER, CATEGORY_UPSTREAM,
 };
@@ -86,16 +89,18 @@ impl From<EmbeddedStaticFile> for HttpResponse {
 pub struct AdminServe {
     pub path: String,
     pub authorization: String,
+    pub proxy_step: ProxyPluginStep,
 }
 impl AdminServe {
-    pub fn new(value: &str) -> Result<Self> {
+    pub fn new(value: &str, proxy_step: ProxyPluginStep) -> Result<Self> {
         let arr: Vec<&str> = value.split(' ').collect();
         let mut authorization = "".to_string();
         if arr.len() >= 2 {
             authorization = arr[1].trim().to_string();
         }
         Ok(Self {
             path: arr[0].trim().to_string(),
+            proxy_step,
             authorization,
         })
     }
@@ -278,6 +283,14 @@ fn get_method_path(session: &Session) -> (Method, String) {
 
 #[async_trait]
 impl ProxyPlugin for AdminServe {
+    #[inline]
+    fn step(&self) -> ProxyPluginStep {
+        self.proxy_step
+    }
+    #[inline]
+    fn category(&self) -> ProxyPluginCategory {
+        ProxyPluginCategory::Admin
+    }
     async fn handle(&self, session: &mut Session, ctx: &mut State) -> pingora::Result<bool> {
         if !session.req_header().uri.path().starts_with(&self.path) {
             return Ok(false);

src/main.rs

@@ -14,6 +14,7 @@
 
 use super::ProxyPlugin;
 use super::{Error, Result};
+use crate::config::{ProxyPluginCategory, ProxyPluginStep};
 use crate::state::State;
 use async_trait::async_trait;
 use http::HeaderValue;
@@ -29,10 +30,11 @@ pub struct Compression {
     br_level: u32,
     zstd_level: u32,
     support_compression: bool,
+    proxy_step: ProxyPluginStep,
 }
 
 impl Compression {
-    pub fn new(value: &str) -> Result<Self> {
+    pub fn new(value: &str, proxy_step: ProxyPluginStep) -> Result<Self> {
         let mut levels: [u32; 3] = [0, 0, 0];
         let mut support_compression = false;
         for (index, item) in value.split(' ').enumerate() {
@@ -48,6 +50,7 @@ impl Compression {
             }
         }
         Ok(Self {
+            proxy_step,
             gzip_level: levels[0],
             br_level: levels[1],
             zstd_level: levels[2],
@@ -58,6 +61,14 @@ impl Compression {
 
 #[async_trait]
 impl ProxyPlugin for Compression {
+    #[inline]
+    fn step(&self) -> ProxyPluginStep {
+        self.proxy_step
+    }
+    #[inline]
+    fn category(&self) -> ProxyPluginCategory {
+        ProxyPluginCategory::Compression
+    }
     #[inline]
     async fn handle(&self, session: &mut Session, _ctx: &mut State) -> pingora::Result<bool> {
         if !self.support_compression {