Line data Source code
1 : //! Routers for our serverless APIs
2 : //!
3 : //! Handles both SQL over HTTP and SQL over Websockets.
4 :
5 : mod backend;
6 : mod conn_pool;
7 : mod json;
8 : mod sql_over_http;
9 : mod websocket;
10 :
11 : pub use conn_pool::GlobalConnPoolOptions;
12 :
13 : use anyhow::bail;
14 : use hyper::StatusCode;
15 : use metrics::IntCounterPairGuard;
16 : use rand::rngs::StdRng;
17 : use rand::SeedableRng;
18 : pub use reqwest_middleware::{ClientWithMiddleware, Error};
19 : pub use reqwest_retry::{policies::ExponentialBackoff, RetryTransientMiddleware};
20 : use tokio_util::task::TaskTracker;
21 :
22 : use crate::context::RequestMonitoring;
23 : use crate::metrics::NUM_CLIENT_CONNECTION_GAUGE;
24 : use crate::protocol2::{ProxyProtocolAccept, WithClientIp};
25 : use crate::rate_limiter::EndpointRateLimiter;
26 : use crate::serverless::backend::PoolingBackend;
27 : use crate::{cancellation::CancellationHandler, config::ProxyConfig};
28 : use futures::StreamExt;
29 : use hyper::{
30 : server::{
31 : accept,
32 : conn::{AddrIncoming, AddrStream},
33 : },
34 : Body, Method, Request, Response,
35 : };
36 :
37 : use std::net::IpAddr;
38 : use std::task::Poll;
39 : use std::{future::ready, sync::Arc};
40 : use tls_listener::TlsListener;
41 : use tokio::net::TcpListener;
42 : use tokio_util::sync::CancellationToken;
43 : use tracing::{error, info, info_span, warn, Instrument};
44 : use utils::http::{error::ApiError, json::json_response};
45 :
46 : pub const SERVERLESS_DRIVER_SNI: &str = "api";
47 :
48 0 : pub async fn task_main(
49 0 : config: &'static ProxyConfig,
50 0 : ws_listener: TcpListener,
51 0 : cancellation_token: CancellationToken,
52 0 : endpoint_rate_limiter: Arc<EndpointRateLimiter>,
53 0 : cancellation_handler: Arc<CancellationHandler>,
54 0 : ) -> anyhow::Result<()> {
55 0 : scopeguard::defer! {
56 0 : info!("websocket server has shut down");
57 : }
58 :
59 0 : let conn_pool = conn_pool::GlobalConnPool::new(&config.http_config);
60 0 : {
61 0 : let conn_pool = Arc::clone(&conn_pool);
62 0 : tokio::spawn(async move {
63 0 : conn_pool.gc_worker(StdRng::from_entropy()).await;
64 0 : });
65 0 : }
66 0 :
67 0 : // shutdown the connection pool
68 0 : tokio::spawn({
69 0 : let cancellation_token = cancellation_token.clone();
70 0 : let conn_pool = conn_pool.clone();
71 0 : async move {
72 0 : cancellation_token.cancelled().await;
73 0 : tokio::task::spawn_blocking(move || conn_pool.shutdown())
74 0 : .await
75 0 : .unwrap();
76 0 : }
77 0 : });
78 0 :
79 0 : let backend = Arc::new(PoolingBackend {
80 0 : pool: Arc::clone(&conn_pool),
81 0 : config,
82 0 : });
83 :
84 0 : let tls_config = match config.tls_config.as_ref() {
85 0 : Some(config) => config,
86 : None => {
87 0 : warn!("TLS config is missing, WebSocket Secure server will not be started");
88 0 : return Ok(());
89 : }
90 : };
91 0 : let mut tls_server_config = rustls::ServerConfig::clone(&tls_config.to_server_config());
92 0 : // prefer http2, but support http/1.1
93 0 : tls_server_config.alpn_protocols = vec![b"h2".to_vec(), b"http/1.1".to_vec()];
94 0 : let tls_acceptor: tokio_rustls::TlsAcceptor = Arc::new(tls_server_config).into();
95 :
96 0 : let mut addr_incoming = AddrIncoming::from_listener(ws_listener)?;
97 0 : let _ = addr_incoming.set_nodelay(true);
98 0 : let addr_incoming = ProxyProtocolAccept {
99 0 : incoming: addr_incoming,
100 0 : };
101 0 :
102 0 : let ws_connections = tokio_util::task::task_tracker::TaskTracker::new();
103 0 : ws_connections.close(); // allows `ws_connections.wait to complete`
104 0 :
105 0 : let tls_listener = TlsListener::new(tls_acceptor, addr_incoming).filter(|conn| {
106 0 : if let Err(err) = conn {
107 0 : error!("failed to accept TLS connection for websockets: {err:?}");
108 0 : ready(false)
109 : } else {
110 0 : ready(true)
111 : }
112 0 : });
113 0 :
114 0 : let make_svc = hyper::service::make_service_fn(
115 0 : |stream: &tokio_rustls::server::TlsStream<WithClientIp<AddrStream>>| {
116 0 : let (io, _) = stream.get_ref();
117 0 : let client_addr = io.client_addr();
118 0 : let remote_addr = io.inner.remote_addr();
119 0 : let backend = backend.clone();
120 0 : let ws_connections = ws_connections.clone();
121 0 : let endpoint_rate_limiter = endpoint_rate_limiter.clone();
122 0 : let cancellation_handler = cancellation_handler.clone();
123 0 : async move {
124 0 : let peer_addr = match client_addr {
125 0 : Some(addr) => addr,
126 0 : None if config.require_client_ip => bail!("missing required client ip"),
127 0 : None => remote_addr,
128 : };
129 0 : Ok(MetricService::new(hyper::service::service_fn(
130 0 : move |req: Request<Body>| {
131 0 : let backend = backend.clone();
132 0 : let ws_connections = ws_connections.clone();
133 0 : let endpoint_rate_limiter = endpoint_rate_limiter.clone();
134 0 : let cancellation_handler = cancellation_handler.clone();
135 :
136 0 : async move {
137 0 : let session_id = uuid::Uuid::new_v4();
138 0 :
139 0 : request_handler(
140 0 : req,
141 0 : config,
142 0 : backend,
143 0 : ws_connections,
144 0 : cancellation_handler,
145 0 : session_id,
146 0 : peer_addr.ip(),
147 0 : endpoint_rate_limiter,
148 0 : )
149 0 : .instrument(info_span!(
150 0 : "serverless",
151 0 : session = %session_id,
152 0 : %peer_addr,
153 0 : ))
154 0 : .await
155 0 : }
156 0 : },
157 0 : )))
158 0 : }
159 0 : },
160 0 : );
161 0 :
162 0 : hyper::Server::builder(accept::from_stream(tls_listener))
163 0 : .serve(make_svc)
164 0 : .with_graceful_shutdown(cancellation_token.cancelled())
165 0 : .await?;
166 :
167 : // await websocket connections
168 0 : ws_connections.wait().await;
169 :
170 0 : Ok(())
171 0 : }
172 :
173 : struct MetricService<S> {
174 : inner: S,
175 : _gauge: IntCounterPairGuard,
176 : }
177 :
178 : impl<S> MetricService<S> {
179 0 : fn new(inner: S) -> MetricService<S> {
180 0 : MetricService {
181 0 : inner,
182 0 : _gauge: NUM_CLIENT_CONNECTION_GAUGE
183 0 : .with_label_values(&["http"])
184 0 : .guard(),
185 0 : }
186 0 : }
187 : }
188 :
189 : impl<S, ReqBody> hyper::service::Service<Request<ReqBody>> for MetricService<S>
190 : where
191 : S: hyper::service::Service<Request<ReqBody>>,
192 : {
193 : type Response = S::Response;
194 : type Error = S::Error;
195 : type Future = S::Future;
196 :
197 0 : fn poll_ready(&mut self, cx: &mut std::task::Context<'_>) -> Poll<Result<(), Self::Error>> {
198 0 : self.inner.poll_ready(cx)
199 0 : }
200 :
201 0 : fn call(&mut self, req: Request<ReqBody>) -> Self::Future {
202 0 : self.inner.call(req)
203 0 : }
204 : }
205 :
206 : #[allow(clippy::too_many_arguments)]
207 0 : async fn request_handler(
208 0 : mut request: Request<Body>,
209 0 : config: &'static ProxyConfig,
210 0 : backend: Arc<PoolingBackend>,
211 0 : ws_connections: TaskTracker,
212 0 : cancellation_handler: Arc<CancellationHandler>,
213 0 : session_id: uuid::Uuid,
214 0 : peer_addr: IpAddr,
215 0 : endpoint_rate_limiter: Arc<EndpointRateLimiter>,
216 0 : ) -> Result<Response<Body>, ApiError> {
217 0 : let host = request
218 0 : .headers()
219 0 : .get("host")
220 0 : .and_then(|h| h.to_str().ok())
221 0 : .and_then(|h| h.split(':').next())
222 0 : .map(|s| s.to_string());
223 0 :
224 0 : // Check if the request is a websocket upgrade request.
225 0 : if hyper_tungstenite::is_upgrade_request(&request) {
226 0 : info!(session_id = ?session_id, "performing websocket upgrade");
227 :
228 0 : let (response, websocket) = hyper_tungstenite::upgrade(&mut request, None)
229 0 : .map_err(|e| ApiError::BadRequest(e.into()))?;
230 :
231 0 : ws_connections.spawn(
232 0 : async move {
233 0 : let ctx = RequestMonitoring::new(session_id, peer_addr, "ws", &config.region);
234 :
235 0 : if let Err(e) = websocket::serve_websocket(
236 0 : config,
237 0 : ctx,
238 0 : websocket,
239 0 : cancellation_handler,
240 0 : host,
241 0 : endpoint_rate_limiter,
242 0 : )
243 0 : .await
244 : {
245 0 : error!(session_id = ?session_id, "error in websocket connection: {e:#}");
246 0 : }
247 0 : }
248 0 : .in_current_span(),
249 0 : );
250 0 :
251 0 : // Return the response so the spawned future can continue.
252 0 : Ok(response)
253 0 : } else if request.uri().path() == "/sql" && request.method() == Method::POST {
254 0 : let ctx = RequestMonitoring::new(session_id, peer_addr, "http", &config.region);
255 0 :
256 0 : sql_over_http::handle(config, ctx, request, backend).await
257 0 : } else if request.uri().path() == "/sql" && request.method() == Method::OPTIONS {
258 0 : Response::builder()
259 0 : .header("Allow", "OPTIONS, POST")
260 0 : .header("Access-Control-Allow-Origin", "*")
261 0 : .header(
262 0 : "Access-Control-Allow-Headers",
263 0 : "Neon-Connection-String, Neon-Raw-Text-Output, Neon-Array-Mode, Neon-Pool-Opt-In, Neon-Batch-Read-Only, Neon-Batch-Isolation-Level",
264 0 : )
265 0 : .header("Access-Control-Max-Age", "86400" /* 24 hours */)
266 0 : .status(StatusCode::OK) // 204 is also valid, but see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS#status_code
267 0 : .body(Body::empty())
268 0 : .map_err(|e| ApiError::InternalServerError(e.into()))
269 : } else {
270 0 : json_response(StatusCode::BAD_REQUEST, "query is not supported")
271 : }
272 0 : }
|
