ogcapi-services 0.3.0

Server implementation of several OGC API Standards.
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186

use std::{any::Any, net::SocketAddr};

use axum::{
    Router,
    body::Body,
    http::{
        Response, StatusCode,
        header::{AUTHORIZATION, CONTENT_TYPE, COOKIE, PROXY_AUTHORIZATION, SET_COOKIE},
    },
    response::IntoResponse,
    routing::get,
};
use tokio::net::TcpListener;
use tower::ServiceBuilder;
use tower_http::{
    ServiceBuilderExt,
    catch_panic::CatchPanicLayer,
    compression::CompressionLayer,
    cors::CorsLayer,
    request_id::MakeRequestUuid,
    sensitive_headers::SetSensitiveRequestHeadersLayer,
    trace::{DefaultMakeSpan, TraceLayer},
};

use ogcapi_types::common::Exception;

use crate::{AppState, Config, ConfigParser, Error, routes};

/// OGC API Services
pub struct Service {
    pub state: AppState,
    pub router: Router<AppState>,
    listener: TcpListener,
}

impl Service {
    pub async fn new() -> Self {
        // config
        let config = Config::parse();

        // state
        let state = AppState::new_from(&config).await;

        Service::new_with(&config, state).await
    }

    pub async fn new_with(config: &Config, state: AppState) -> Self {
        // router
        let router = Router::new()
            .route("/", get(routes::root))
            .route("/api", get(routes::api::api))
            .route("/redoc", get(routes::api::redoc))
            .route("/swagger", get(routes::api::swagger))
            .route("/conformance", get(routes::conformance));

        let router = router.merge(routes::collections::router(&state));

        #[cfg(feature = "stac")]
        let router = router.route(
            "/search",
            get(routes::stac::search_get).post(routes::stac::search_post),
        );

        #[cfg(feature = "features")]
        let router = router.merge(routes::features::router(&state));

        #[cfg(feature = "edr")]
        let router = router.merge(routes::edr::router(&state));

        #[cfg(feature = "styles")]
        let router = router.merge(routes::styles::router(&state));

        #[cfg(feature = "tiles")]
        let router = router.merge(routes::tiles::router(&state));

        #[cfg(feature = "processes")]
        let router = router.merge(routes::processes::router(&state));

        // add a fallback service for handling routes to unknown paths
        let router = router.fallback(handler_404);

        // middleware stack
        let router = router.layer(
            ServiceBuilder::new()
                .set_x_request_id(MakeRequestUuid)
                .layer(SetSensitiveRequestHeadersLayer::new([
                    AUTHORIZATION,
                    PROXY_AUTHORIZATION,
                    COOKIE,
                    SET_COOKIE,
                ]))
                .layer(TraceLayer::new_for_http().make_span_with(DefaultMakeSpan::new()))
                .layer(CompressionLayer::new())
                .layer(CorsLayer::permissive())
                .layer(CatchPanicLayer::custom(handle_panic))
                .propagate_x_request_id(),
        );

        let listener = TcpListener::bind((config.host.as_str(), config.port))
            .await
            .expect("create listener");

        Service {
            state,
            router,
            listener,
        }
    }

    /// Serve application
    pub async fn serve(self) {
        // add state
        let router = self.router.with_state(self.state);

        // serve
        tracing::info!(
            "listening on http://{}",
            self.listener.local_addr().unwrap()
        );

        axum::serve::serve(self.listener, router)
            .with_graceful_shutdown(shutdown_signal())
            .await
            .unwrap()
    }

    // helper function to get randomized port
    #[doc(hidden)]
    pub fn local_addr(&self) -> std::io::Result<SocketAddr> {
        self.listener.local_addr()
    }
}

/// Custom 404 handler
async fn handler_404() -> impl IntoResponse {
    Error::NotFound
}

/// Custom panic handler
fn handle_panic(err: Box<dyn Any + Send + 'static>) -> Response<Body> {
    let details = if let Some(s) = err.downcast_ref::<String>() {
        s.clone()
    } else if let Some(s) = err.downcast_ref::<&str>() {
        s.to_string()
    } else {
        "Unknown panic message".to_string()
    };

    let body =
        Exception::new_from_status(StatusCode::INTERNAL_SERVER_ERROR.as_u16()).detail(details);

    let body = serde_json::to_string(&body).unwrap();

    Response::builder()
        .status(StatusCode::INTERNAL_SERVER_ERROR)
        .header(CONTENT_TYPE, "application/json")
        .body(Body::from(body))
        .unwrap()
}

/// Handle shutdown signals
async fn shutdown_signal() {
    let ctrl_c = async {
        tokio::signal::ctrl_c()
            .await
            .expect("failed to install Ctrl+C handler");
    };

    #[cfg(unix)]
    let terminate = async {
        tokio::signal::unix::signal(tokio::signal::unix::SignalKind::terminate())
            .expect("failed to install signal handler")
            .recv()
            .await;
    };

    #[cfg(not(unix))]
    let terminate = std::future::pending::<()>();

    tokio::select! {
        _ = ctrl_c => {},
        _ = terminate => {},
    }

    tracing::debug!("signal received, starting graceful shutdown");
}