Skip to main content

arrow_integration_testing/flight_client_scenarios/
middleware.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: See the NOTICE file distributed with this work for additional information regarding copyright ownership
3// SPDX-FileContributor: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements
4
5//! Scenario for testing middleware.
6
7use arrow_flight::{
8    FlightDescriptor, flight_descriptor::DescriptorType, flight_service_client::FlightServiceClient,
9};
10use prost::bytes::Bytes;
11use tonic::{Request, Status};
12
13type Error = Box<dyn std::error::Error + Send + Sync + 'static>;
14type Result<T = (), E = Error> = std::result::Result<T, E>;
15
16/// Run a scenario that tests middleware.
17pub async fn run_scenario(host: &str, port: u16) -> Result {
18    let url = format!("http://{host}:{port}");
19    let conn = tonic::transport::Endpoint::new(url)?.connect().await?;
20    let mut client = FlightServiceClient::with_interceptor(conn, middleware_interceptor);
21
22    let mut descriptor = FlightDescriptor::default();
23    descriptor.set_type(DescriptorType::Cmd);
24    descriptor.cmd = Bytes::from_static(b"");
25
26    // This call is expected to fail.
27    match client
28        .get_flight_info(Request::new(descriptor.clone()))
29        .await
30    {
31        Ok(_) => return Err(Box::new(Status::internal("Expected call to fail"))),
32        Err(e) => {
33            let headers = e.metadata();
34            let middleware_header = headers.get("x-middleware");
35            let value = middleware_header.map(|v| v.to_str().unwrap()).unwrap_or("");
36
37            if value != "expected value" {
38                let msg = format!(
39                    "On failing call: Expected to receive header 'x-middleware: expected value', \
40                     but instead got: '{value}'"
41                );
42                return Err(Box::new(Status::internal(msg)));
43            }
44        }
45    }
46
47    // This call should succeed
48    descriptor.cmd = Bytes::from_static(b"success");
49    let resp = client.get_flight_info(Request::new(descriptor)).await?;
50
51    let headers = resp.metadata();
52    let middleware_header = headers.get("x-middleware");
53    let value = middleware_header.map(|v| v.to_str().unwrap()).unwrap_or("");
54
55    if value != "expected value" {
56        let msg = format!(
57            "On success call: Expected to receive header 'x-middleware: expected value', \
58            but instead got: '{value}'"
59        );
60        return Err(Box::new(Status::internal(msg)));
61    }
62
63    Ok(())
64}
65
66fn middleware_interceptor(mut req: Request<()>) -> Result<Request<()>, Status> {
67    let metadata = req.metadata_mut();
68    metadata.insert("x-middleware", "expected value".parse().unwrap());
69    Ok(req)
70}