Struct WorkflowPlugin 

pub struct WorkflowPlugin {
    rules: Vec<Rule>,
}

Evaluates ordered rules; the first rule whose case matches applies its action. Rules without a case always match. No matching rule means passthrough.

Fields

rules: Vec<Rule>

Implementations

impl WorkflowPlugin

pub fn from_config( config: &HashMap<String, Value>, resources: &Arc<PluginResources>, ) -> Result<Self, String>

Builds the plugin from node config. All expressions and action parameters are validated here at config load.

Accepted keys:

• rules (array, required, non-empty): evaluated in order.
  • case (array, optional): APISIX triple-array condition, rules AND-ed (e.g. [["uri", "==", "/v1"], ["arg_debug", "==", "1"]]). Omit to match every request.
  • actions (array, required): [[name, params]]. Only the first action is applied (APISIX supports exactly one). Supported:
    • "return" — params {code} (integer 100-599, required). Rejects with that status and body {"error_msg":"rejected by workflow"}.
    • "limit-count" — params:
      • count (integer > 0, required): allowed requests per window.
      • time_window (number > 0, seconds, required).
      • key (string, default "$remote_addr"): $var template resolved per request into the counter key.
      • rejected_code (integer 200-599, default 503).
      • rejected_msg (string, optional): when set, the rejection body is {"error_msg": "<msg>"}; empty body otherwise.
      • policy (string, default "local"): counter backend name.

type: workflow
config:
  rules:
    - case:
        - ["uri", "~~", "^/admin"]
      actions:
        - ["return", { "code": 403 }]
    - actions:
        - ["limit-count", { "count": 100, "time_window": 60, "key": "$remote_addr" }]

fn reject( ctx: Context, status: u16, body: Bytes, code: &str, message: &str, ) -> Result<PluginOutput, PluginExecutionError>

Writes a JSON rejection onto the response and returns the error result so the graph engine routes through the error port.

Trait Implementations

impl Plugin for WorkflowPlugin

fn plugin_type(&self) -> &str

Unique identifier for the plugin type (e.g., “proxy-rewrite”, “upstream”).

fn execute<'life0, 'life1, 'async_trait>( &'life0 self, ctx: Context, _named_inputs: &'life1 HashMap<String, Value>, ) -> Pin<Box<dyn Future<Output = Result<PluginOutput, PluginExecutionError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Executes the plugin logic against the request/response context.