nominal_streaming/
client.rs

1use std::fmt::Debug;
2use std::io::Write;
3use std::sync::LazyLock;
4
5use conjure_error::Error;
6use conjure_http::client::AsyncClient;
7use conjure_http::client::AsyncRequestBody;
8use conjure_http::client::AsyncService;
9use conjure_http::private::header::CONTENT_ENCODING;
10use conjure_http::private::header::CONTENT_TYPE;
11use conjure_http::private::Request;
12use conjure_http::private::Response;
13use conjure_object::BearerToken;
14use conjure_object::ResourceIdentifier;
15use conjure_runtime_rustls_platform_verifier::conjure_runtime::Agent;
16use conjure_runtime_rustls_platform_verifier::conjure_runtime::BodyWriter;
17use conjure_runtime_rustls_platform_verifier::conjure_runtime::Client;
18use conjure_runtime_rustls_platform_verifier::conjure_runtime::Idempotency;
19use conjure_runtime_rustls_platform_verifier::conjure_runtime::UserAgent;
20use conjure_runtime_rustls_platform_verifier::PlatformVerifierClient;
21use conjure_runtime_rustls_platform_verifier::ResponseBody;
22use nominal_api::api::rids::NominalDataSourceOrDatasetRid;
23use nominal_api::api::rids::WorkspaceRid;
24use nominal_api::ingest::api::IngestServiceAsyncClient;
25use nominal_api::upload::api::UploadServiceAsyncClient;
26use snap::write::FrameEncoder;
27use url::Url;
28
29use crate::types::AuthProvider;
30
31pub mod conjure {
32    pub use conjure_error as error;
33    pub use conjure_http as http;
34    pub use conjure_object as object;
35    pub use conjure_runtime_rustls_platform_verifier::conjure_runtime as runtime;
36}
37
38/// The URL that points toward's Nominal's default production deployment.
39pub const PRODUCTION_API_URL: &str = "https://api.gov.nominal.io/api";
40
41const USER_AGENT: &str = "nominal-streaming";
42
43impl AuthProvider for BearerToken {
44    fn token(&self) -> Option<BearerToken> {
45        Some(self.clone())
46    }
47}
48
49#[derive(Debug, Clone)]
50pub struct TokenAndWorkspaceRid {
51    pub token: BearerToken,
52    pub workspace_rid: Option<WorkspaceRid>,
53}
54
55impl AuthProvider for TokenAndWorkspaceRid {
56    fn token(&self) -> Option<BearerToken> {
57        Some(self.token.clone())
58    }
59
60    fn workspace_rid(&self) -> Option<WorkspaceRid> {
61        self.workspace_rid.clone()
62    }
63}
64
65#[derive(Clone)]
66pub struct NominalApiClients {
67    pub streaming: PlatformVerifierClient,
68    pub upload: UploadServiceAsyncClient<PlatformVerifierClient>,
69    pub ingest: IngestServiceAsyncClient<PlatformVerifierClient>,
70}
71
72impl Debug for NominalApiClients {
73    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
74        f.debug_struct("NominalApiClients")
75            .field("streaming", &"Client")
76            .field("upload", &"UploadServiceAsyncClient<Client>")
77            .field("ingest", &"IngestServiceAsyncClient<Client>")
78            .finish()
79    }
80}
81
82impl NominalApiClients {
83    pub fn from_uri(base_uri: &str) -> NominalApiClients {
84        NominalApiClients {
85            streaming: async_conjure_streaming_client(base_uri.try_into().unwrap())
86                .expect("Failed to create streaming client"),
87            upload: UploadServiceAsyncClient::new(
88                async_conjure_client("upload", base_uri.try_into().unwrap())
89                    .expect("Failed to create upload client"),
90            ),
91            ingest: IngestServiceAsyncClient::new(
92                async_conjure_client("ingest", base_uri.try_into().unwrap())
93                    .expect("Failed to create ingest client"),
94            ),
95        }
96    }
97
98    pub async fn send(&self, req: WriteRequest<'_>) -> Result<Response<ResponseBody>, Error> {
99        self.streaming.send(req).await
100    }
101}
102
103pub static PRODUCTION_CLIENTS: LazyLock<NominalApiClients> =
104    LazyLock::new(|| NominalApiClients::from_uri(PRODUCTION_API_URL));
105
106fn async_conjure_streaming_client(uri: Url) -> Result<PlatformVerifierClient, Error> {
107    Client::builder()
108        .service("core-streaming-rs")
109        .user_agent(UserAgent::new(Agent::new(
110            USER_AGENT,
111            env!("CARGO_PKG_VERSION"),
112        )))
113        .uri(uri)
114        .connect_timeout(std::time::Duration::from_secs(1))
115        .read_timeout(std::time::Duration::from_secs(2))
116        .write_timeout(std::time::Duration::from_secs(2))
117        .backoff_slot_size(std::time::Duration::from_millis(10))
118        .max_num_retries(2)
119        // enables retries for POST endpoints like the streaming ingest one
120        .idempotency(Idempotency::Always)
121        .raw_client_builder(conjure_runtime_rustls_platform_verifier::RawClientBuilder)
122        .build()
123}
124
125fn async_conjure_client(service: &'static str, uri: Url) -> Result<PlatformVerifierClient, Error> {
126    Client::builder()
127        .service(service)
128        .user_agent(UserAgent::new(Agent::new(
129            USER_AGENT,
130            env!("CARGO_PKG_VERSION"),
131        )))
132        .uri(uri)
133        .raw_client_builder(conjure_runtime_rustls_platform_verifier::RawClientBuilder)
134        .build()
135}
136
137pub type WriteRequest<'a> = Request<AsyncRequestBody<'a, BodyWriter>>;
138
139pub fn encode_request<'a, 'b>(
140    write_request_bytes: Vec<u8>,
141    api_key: &'a BearerToken,
142    data_source_rid: &'a ResourceIdentifier,
143) -> std::io::Result<WriteRequest<'b>> {
144    let mut encoder = FrameEncoder::new(Vec::with_capacity(write_request_bytes.len()));
145
146    encoder.write_all(&write_request_bytes)?;
147
148    let mut request = Request::new(AsyncRequestBody::Fixed(
149        encoder.into_inner().unwrap().into(),
150    ));
151
152    let headers = request.headers_mut();
153    headers.insert(CONTENT_TYPE, "application/x-protobuf".parse().unwrap());
154    headers.insert(CONTENT_ENCODING, "x-snappy-framed".parse().unwrap());
155
156    *request.method_mut() = conjure_http::private::http::Method::POST;
157    let mut path = conjure_http::private::UriBuilder::new();
158    path.push_literal("/storage/writer/v1/nominal");
159
160    let nominal_data_source_or_dataset_rid = NominalDataSourceOrDatasetRid(data_source_rid.clone());
161    path.push_path_parameter(&nominal_data_source_or_dataset_rid);
162
163    *request.uri_mut() = path.build();
164    conjure_http::private::encode_header_auth(&mut request, api_key);
165    conjure_http::private::encode_empty_response_headers(&mut request);
166    request
167        .extensions_mut()
168        .insert(conjure_http::client::Endpoint::new(
169            "NominalChannelWriterService",
170            None,
171            "writeNominalBatches",
172            "/storage/writer/v1/nominal/{dataSourceRid}",
173        ));
174    Ok(request)
175}
nominal_streaming/client.rs

nominal_streaming/
client.rs
