Merge pull request #3169 from spinframework/separate-routes-crate

Move router to its own separate crate

Author: rylev

Cargo.lock

@@ -15,6 +15,7 @@ routefinder = "0.5.4"
 serde = { workspace = true }
 spin-app = { path = "../app", optional = true }
 spin-factor-outbound-http = { path = "../factor-outbound-http" }
+spin-http-routes = { path = "../routes" }
 tracing = { workspace = true }
 wasmtime = { workspace = true }
 wasmtime-wasi = { workspace = true }

crates/http/Cargo.toml

@@ -1,4 +1,5 @@
 use serde::{Deserialize, Serialize};
+use spin_http_routes::HttpTriggerRouteConfig;
 
 /// Configuration for the HTTP trigger
 #[derive(Clone, Debug, Default, Deserialize, Serialize)]
@@ -13,34 +14,6 @@ pub struct HttpTriggerConfig {
     pub executor: Option<HttpExecutorType>,
 }
 
-/// An HTTP trigger route
-#[derive(Clone, Debug, Deserialize, Serialize)]
-#[serde(untagged)]
-pub enum HttpTriggerRouteConfig {
-    Route(String),
-    Private(HttpPrivateEndpoint),
-}
-
-/// Indicates that a trigger is a private endpoint (not routable).
-#[derive(Clone, Debug, Default, Deserialize, Serialize)]
-#[serde(deny_unknown_fields)]
-pub struct HttpPrivateEndpoint {
-    /// Whether the private endpoint is private. This must be true.
-    pub private: bool,
-}
-
-impl Default for HttpTriggerRouteConfig {
-    fn default() -> Self {
-        Self::Route(Default::default())
-    }
-}
-
-impl<T: Into<String>> From<T> for HttpTriggerRouteConfig {
-    fn from(value: T) -> Self {
-        Self::Route(value.into())
-    }
-}
-
 /// The executor for the HTTP component.
 /// The component can either implement the Spin HTTP interface,
 /// the `wasi-http` interface, or the Wagi CGI interface.

crates/http/src/config.rs

@@ -3,12 +3,12 @@ pub use wasmtime_wasi_http::body::HyperIncomingBody as Body;
 
 pub mod app_info;
 pub mod config;
-pub mod routes;
 pub mod trigger;
 #[cfg(feature = "runtime")]
 pub mod wagi;
 
-pub const WELL_KNOWN_PREFIX: &str = "/.well-known/spin/";
+pub use spin_http_routes as routes;
+pub use spin_http_routes::WELL_KNOWN_PREFIX;
 
 #[cfg(feature = "runtime")]
 pub mod body {

crates/http/src/lib.rs

@@ -0,0 +1,20 @@
+[package]
+name = "spin-http-routes"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+license.workspace = true
+homepage.workspace = true
+repository.workspace = true
+rust-version.workspace = true
+
+[dependencies]
+anyhow = { workspace = true }
+indexmap = { workspace = true }
+percent-encoding = "2"
+routefinder = "0.5.4"
+serde = { workspace = true }
+tracing = { workspace = true }
+
+[lints]
+workspace = true

crates/routes/Cargo.toml

@@ -4,9 +4,11 @@
 
 use anyhow::{anyhow, Result};
 use indexmap::IndexMap;
+use serde::{Deserialize, Serialize};
 use std::{borrow::Cow, collections::HashMap, fmt};
 
-use crate::config::HttpTriggerRouteConfig;
+/// The prefix for well-known routes.
+pub const WELL_KNOWN_PREFIX: &str = "/.well-known/spin/";
 
 /// Router for the HTTP trigger.
 #[derive(Clone, Debug)]
@@ -383,10 +385,38 @@ fn sanitize<S: Into<String>>(s: S) -> String {
     }
 }
 
+/// An HTTP trigger route
+#[derive(Clone, Debug, Deserialize, Serialize)]
+#[serde(untagged)]
+pub enum HttpTriggerRouteConfig {
+    /// A route that is routable.
+    Route(String),
+    /// A route that is not routable, but indicates a private endpoint.
+    Private(HttpPrivateEndpoint),
+}
+
+/// Indicates that a trigger is a private endpoint (not routable).
+#[derive(Clone, Debug, Default, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct HttpPrivateEndpoint {
+    /// Whether the private endpoint is private. This must be true.
+    pub private: bool,
+}
+
+impl Default for HttpTriggerRouteConfig {
+    fn default() -> Self {
+        Self::Route(Default::default())
+    }
+}
+
+impl<T: Into<String>> From<T> for HttpTriggerRouteConfig {
+    fn from(value: T) -> Self {
+        Self::Route(value.into())
+    }
+}
+
 #[cfg(test)]
 mod route_tests {
-    use crate::config::HttpPrivateEndpoint;
-
     use super::*;
 
     #[test]