docs(router): product update for Router plugin system (#7784)

2026-04-21 14:37:17 +00:00 · 2026-03-05 18:34:07 +02:00 · 2026-03-05 18:34:07 +02:00 · 5eb8dee3ce
commit 5eb8dee3ce
parent f3fb3c3575
1 changed files with 109 additions and 0 deletions
--- a/packages/web/docs/src/app/product-updates/(posts)/2026-03-05-hive-router-plugin-system/page.mdx
+++ b/packages/web/docs/src/app/product-updates/(posts)/2026-03-05-hive-router-plugin-system/page.mdx
@ -0,0 +1,109 @@
+---
+title: Hive Router Plugin System
+description:
+  Hive Router v0.0.40 introduces a plugin system that lets you extend and customize the router using
+  native Rust plugins.
+date: 2026-03-05
+authors: [arda, dotan]
+---
+
+**TL;DR**: Hive Router `v0.0.40` ships a native plugin system. Write custom Rust plugins that hook
+into any stage of the request lifecycle, from the HTTP layer all the way to subgraph execution.
+
+---
+
+[Hive Router](/docs/router) v0.0.40 introduces a **plugin system** that lets you extend and
+customize the router's behavior using native Rust code. Plugins can add authentication,
+observability, caching, error masking, or any other custom logic you need!
+
+## How it works
+
+The plugin system is built around the `RouterPlugin` trait, exposed through the
+[`hive-router` crate](https://crates.io/crates/hive-router). Implement the trait on your struct,
+attach hooks for the lifecycle stages you care about, and register your plugin at startup.
+
+### 1. Add the dependency
+
+```toml filename="Cargo.toml"
+[dependencies]
+hive-router = "0.0.40"
+```
+
+### 2. Implement a plugin
+
+```rust filename="src/plugin.rs"
+use hive_router::plugins::plugin_trait::RouterPlugin;
+
+// Declare and implement a simple plugin with no configuration and no hooks.
+struct MyPlugin;
+
+#[async_trait]
+impl RouterPlugin for MyPlugin {
+    // You can override this and add a custom config to your plugin
+    type Config = ();
+
+    fn plugin_name() -> &'static str {
+        "my_plugin"
+    }
+
+    // Your hooks implementation goes here...
+}
+```
+
+### 3. Register the plugin
+
+```rust filename="src/main.rs"
+use hive_router::{
+    configure_global_allocator, error::RouterInitError, init_rustls_crypto_provider,
+    router_entrypoint, PluginRegistry, RouterGlobalAllocator,
+};
+
+configure_global_allocator!();
+
+// This is the main entrypoint of the Router
+#[hive_router::main]
+async fn main() -> Result<(), RouterInitError> {
+    // Configure Hive Router to use the OS's default certificate store
+    init_rustls_crypto_provider();
+
+    // Start and run the router entrypoint with your plugin
+    router_entrypoint(
+        PluginRegistry::new().register::<MyPlugin>(),
+    )
+    .await
+}
+```
+
+### 4. Enable in configuration
+
+```yaml filename="router.config.yaml"
+plugins:
+  my_plugin:
+    enabled: true
+```
+
+## Available hooks
+
+Plugins can intercept any stage of the request and router lifecycle:
+
+| Hook                       | When it fires                                                         |
+| -------------------------- | --------------------------------------------------------------------- |
+| `on_plugin_init`           | Router startup: initialize state, register background tasks           |
+| `on_http_request`          | Incoming HTTP request: auth, header inspection                        |
+| `on_graphql_params`        | GraphQL params extracted: modify query/variables                      |
+| `on_graphql_parse`         | Before AST parsing                                                    |
+| `on_graphql_validation`    | Schema validation: add custom rules                                   |
+| `on_query_plan`            | Federation query planning                                             |
+| `on_execute`               | Query execution: caching, result inspection                           |
+| `on_subgraph_execute`      | Subgraph request preparation                                          |
+| `on_subgraph_http_request` | HTTP call to a subgraph: modify headers, track responses              |
+| `on_graphql_error`         | Per-error hook before sending to client: error masking/transformation |
+| `on_supergraph_load`       | Supergraph load/reload: cache invalidation, schema inspection         |
+| `on_shutdown`              | Router shutdown: cleanup, flush data                                  |
+
+## Learn more
+
+- [Plugin System documentation](/docs/router/plugin-system)
+- [Available hooks reference](/docs/router/plugin-system/hooks)
+- [Extending the Router guide](/docs/router/guides/extending-the-router)
+- [`hive-router` on Crates.io](https://crates.io/crates/hive-router)