switchy_http 0.4.0

Switchy HTTP Networking package
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
//! Simulator HTTP client backend implementation.
//!
//! This module provides a no-op HTTP client backend that returns empty responses without making
//! any network requests. It is useful for testing and development environments where you want to
//! avoid real network calls.
//!
//! All requests succeed immediately and return empty/default responses:
//!
//! * Status: 200 OK
//! * Headers: Empty
//! * Body: Empty
//!
//! This module is only available when the `simulator` feature is enabled.
//!
//! # Usage
//!
//! Use the exported types from the parent crate (`switchy_http::Client`, etc.) rather than
//! accessing this module directly. The parent crate automatically selects the appropriate
//! backend based on enabled features.

use std::{collections::BTreeMap, marker::PhantomData};

use async_trait::async_trait;
use bytes::Bytes;

use crate::{
    Error, GenericClient, GenericClientBuilder, GenericRequestBuilder, GenericResponse, Method,
    StatusCode,
};

/// Simulator HTTP client.
///
/// This client provides a no-op implementation that doesn't make any real network requests.
/// All requests succeed immediately and return empty responses with a 200 OK status.
#[derive(Default)]
pub struct Client;

impl Client {
    /// Create a new simulator HTTP client.
    #[must_use]
    pub const fn new() -> Self {
        Self
    }
}

impl GenericClient<crate::SimulatorRequestBuilder> for Client {
    fn request(&self, _method: Method, _url: &str) -> crate::SimulatorRequestBuilder {
        crate::RequestBuilderWrapper(RequestBuilder, PhantomData)
    }
}

/// Builder for constructing a simulator HTTP client.
///
/// This builder always succeeds when building a client since the simulator
/// requires no configuration or initialization.
pub struct ClientBuilder;

impl crate::SimulatorClientBuilder {
    /// Create a new client builder for the simulator HTTP client.
    #[must_use]
    pub const fn new() -> Self {
        Self(ClientBuilder, PhantomData, PhantomData)
    }
}

impl GenericClientBuilder<crate::SimulatorRequestBuilder, crate::SimulatorClient>
    for ClientBuilder
{
    fn build(self) -> Result<crate::SimulatorClient, Error> {
        Ok(crate::ClientWrapper(Client, PhantomData))
    }
}

/// Request builder for simulator HTTP client.
///
/// This builder ignores all configuration (headers, query parameters, body) and
/// always returns an empty successful response when sent.
pub struct RequestBuilder;

#[async_trait]
impl GenericRequestBuilder<crate::SimulatorResponse> for RequestBuilder {
    fn header(&mut self, _name: &str, _value: &str) {}

    fn query_param(&mut self, _name: &str, _value: &str) {}

    fn query_param_opt(&mut self, _name: &str, _value: Option<&str>) {}

    fn query_params(&mut self, _params: &[(&str, &str)]) {}

    fn body(&mut self, _body: Bytes) {}

    #[cfg(feature = "json")]
    fn form(&mut self, _form: &serde_json::Value) {}

    async fn send(&mut self) -> Result<crate::SimulatorResponse, Error> {
        Ok(crate::ResponseWrapper(Response::default()))
    }
}

/// HTTP response from simulator client.
///
/// This response always returns a 200 OK status with empty headers and body.
#[derive(Default)]
pub struct Response {
    headers: BTreeMap<String, String>,
}

#[async_trait]
impl GenericResponse for Response {
    fn status(&self) -> StatusCode {
        StatusCode::Ok
    }

    fn headers(&mut self) -> &BTreeMap<String, String> {
        &self.headers
    }

    async fn text(&mut self) -> Result<String, Error> {
        Ok(String::new())
    }

    async fn bytes(&mut self) -> Result<Bytes, Error> {
        Ok(Bytes::new())
    }

    #[cfg(feature = "stream")]
    fn bytes_stream(
        &mut self,
    ) -> std::pin::Pin<Box<dyn futures_core::Stream<Item = Result<Bytes, Error>> + Send>> {
        Box::pin(futures_util::stream::empty())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test_log::test]
    fn test_simulator_client_builder_succeeds() {
        let builder = ClientBuilder;
        let result =
            GenericClientBuilder::<crate::SimulatorRequestBuilder, crate::SimulatorClient>::build(
                builder,
            );
        assert!(result.is_ok());
    }

    #[test_log::test]
    fn test_simulator_response_returns_ok_status() {
        let response = Response::default();
        assert_eq!(response.status(), StatusCode::Ok);
    }

    #[test_log::test]
    fn test_simulator_response_returns_empty_headers() {
        let mut response = Response::default();
        let headers = response.headers();
        assert!(headers.is_empty());
    }

    #[test_log::test]
    fn test_simulator_client_creates_request_builder() {
        let client = Client::new();
        let _builder = client.request(Method::Get, "http://example.com");
        // If we get here without panic, the test passes
    }

    /// Test the complete request/response flow through the macro-generated HTTP client.
    /// This exercises the full integration: client creation, request builder configuration,
    /// sending requests, and consuming responses.
    #[test_log::test(switchy_async::test)]
    async fn test_simulator_full_request_response_flow() {
        let client = crate::SimulatorClient::new();

        // Build and send a request with multiple configurations
        let response = client
            .get("http://example.com/test")
            .header("Authorization", "Bearer token")
            .query_param("key", "value")
            .query_param_opt("optional", Some("present"))
            .query_param_opt("missing", None)
            .query_params(&[("page", "1"), ("limit", "10")])
            .send()
            .await
            .unwrap();

        // Verify response properties
        assert_eq!(response.status(), StatusCode::Ok);

        // Verify response body consumption works
        let text = response.text().await.unwrap();
        assert!(text.is_empty());
    }

    /// Test that all HTTP method convenience methods are correctly wired through the macro.
    #[test_log::test(switchy_async::test)]
    async fn test_simulator_all_http_methods() {
        let client = crate::SimulatorClient::new();

        // Test all HTTP method convenience methods work through the macro-generated client
        let get = client.get("http://example.com").send().await.unwrap();
        assert_eq!(get.status(), StatusCode::Ok);

        let post = client.post("http://example.com").send().await.unwrap();
        assert_eq!(post.status(), StatusCode::Ok);

        let put = client.put("http://example.com").send().await.unwrap();
        assert_eq!(put.status(), StatusCode::Ok);

        let patch = client.patch("http://example.com").send().await.unwrap();
        assert_eq!(patch.status(), StatusCode::Ok);

        let delete = client.delete("http://example.com").send().await.unwrap();
        assert_eq!(delete.status(), StatusCode::Ok);

        let head = client.head("http://example.com").send().await.unwrap();
        assert_eq!(head.status(), StatusCode::Ok);

        let options = client.options("http://example.com").send().await.unwrap();
        assert_eq!(options.status(), StatusCode::Ok);
    }

    /// Test that the JSON serialization path works correctly through the macro-generated client.
    /// This exercises the `json()` method which serializes via `serde_json`.
    #[cfg(feature = "json")]
    #[test_log::test(switchy_async::test)]
    async fn test_simulator_json_body_serialization() {
        {
            #[derive(serde::Serialize)]
            struct TestPayload {
                name: String,
                value: i32,
            }

            let client = crate::SimulatorClient::new();

            let payload = TestPayload {
                name: "test".to_string(),
                value: 42,
            };

            // Verify the JSON serialization path doesn't panic
            let response = client
                .post("http://example.com/api")
                .json(&payload)
                .send()
                .await
                .unwrap();

            assert_eq!(response.status(), StatusCode::Ok);
        }
    }

    /// Test that the form serialization path works correctly through the macro-generated client.
    /// This exercises the `form()` method which serializes via `serde_json::to_value`.
    #[cfg(feature = "json")]
    #[test_log::test(switchy_async::test)]
    async fn test_simulator_form_body_serialization() {
        {
            #[derive(serde::Serialize)]
            struct FormData {
                username: String,
                password: String,
            }

            let client = crate::SimulatorClient::new();

            let form = FormData {
                username: "user".to_string(),
                password: "pass".to_string(),
            };

            // Verify the form serialization path doesn't panic
            let response = client
                .post("http://example.com/login")
                .form(&form)
                .send()
                .await
                .unwrap();

            assert_eq!(response.status(), StatusCode::Ok);
        }
    }

    /// Test the `bytes_stream` response method works correctly through the macro-generated response.
    #[cfg(feature = "stream")]
    #[test_log::test(switchy_async::test)]
    async fn test_simulator_bytes_stream_consumption() {
        {
            use futures_util::StreamExt;

            let client = crate::SimulatorClient::new();
            let response = client.get("http://example.com").send().await.unwrap();

            // Test consuming the response as a stream
            let mut stream = response.bytes_stream();
            let chunks: Vec<_> = stream.by_ref().collect().await;
            assert!(chunks.is_empty());
        }
    }

    /// Test that `Response::bytes()` returns empty bytes for simulator.
    /// This verifies the `bytes()` code path in `GenericResponse` impl is working.
    #[test_log::test(switchy_async::test)]
    async fn test_simulator_response_bytes() {
        {
            use crate::GenericResponse;

            let mut response = Response::default();
            let bytes = response.bytes().await.unwrap();
            assert!(bytes.is_empty());
        }
    }

    /// Test that `Response::text()` returns empty string for simulator.
    /// This verifies the `text()` code path in `GenericResponse` impl is working.
    #[test_log::test(switchy_async::test)]
    async fn test_simulator_response_text() {
        {
            use crate::GenericResponse;

            let mut response = Response::default();
            let text = response.text().await.unwrap();
            assert!(text.is_empty());
        }
    }

    /// Test that the underlying `RequestBuilder::body()` method accepts raw bytes.
    /// This exercises the body path separately from the JSON serialization path.
    #[test_log::test(switchy_async::test)]
    async fn test_simulator_request_raw_body() {
        let client = crate::SimulatorClient::new();

        let body_bytes = Bytes::from_static(b"raw request body content");

        let response = client
            .post("http://example.com/upload")
            .body(body_bytes)
            .send()
            .await
            .unwrap();

        assert_eq!(response.status(), StatusCode::Ok);
    }

    /// Test that `SimulatorClient::default()` produces a working client.
    /// This exercises the Default impl generated by the macro.
    #[test_log::test(switchy_async::test)]
    async fn test_simulator_client_default() {
        let client = crate::SimulatorClient::default();

        let response = client.get("http://example.com").send().await.unwrap();
        assert_eq!(response.status(), StatusCode::Ok);
    }

    /// Test that headers can be retrieved through the macro-generated wrapper method.
    #[test_log::test(switchy_async::test)]
    async fn test_simulator_response_headers_through_wrapper() {
        let client = crate::SimulatorClient::new();

        let mut response = client.get("http://example.com").send().await.unwrap();

        // Access headers through the wrapper's headers() method
        let headers = response.headers();
        assert!(headers.is_empty());
    }

    /// Test the `bytes_stream` on the `GenericResponse` trait impl directly.
    #[cfg(feature = "stream")]
    #[test_log::test(switchy_async::test)]
    async fn test_simulator_response_bytes_stream_trait() {
        {
            use crate::GenericResponse;
            use futures_util::StreamExt;

            let mut response = Response::default();

            let mut stream = response.bytes_stream();
            let chunks: Vec<_> = stream.by_ref().collect().await;
            assert!(chunks.is_empty());
        }
    }

    /// Test the `Client::request()` method with various HTTP methods.
    /// This verifies the method parameter is correctly passed through.
    #[test_log::test(switchy_async::test)]
    async fn test_simulator_client_request_with_different_methods() {
        let client = Client::new();

        // Test that request() works with different method types
        let methods = [
            Method::Get,
            Method::Post,
            Method::Put,
            Method::Patch,
            Method::Delete,
            Method::Head,
            Method::Options,
        ];

        for method in methods {
            let _builder = client.request(method, "http://example.com");
            // If we reach here without panic, the test passes
        }
    }

    /// Test JSON deserialization of response body.
    /// This exercises the `json()` method on the Response wrapper.
    #[cfg(feature = "json")]
    #[test_log::test(switchy_async::test)]
    async fn test_simulator_response_json_deserialization_empty() {
        let client = crate::SimulatorClient::new();

        let response = client.get("http://example.com/api").send().await.unwrap();

        // The simulator returns empty bytes, so deserializing any non-empty type will fail.
        // But deserializing to an empty structure or Option should work with appropriate JSON.
        // Since simulator returns empty bytes (not valid JSON), this should fail.
        let result: Result<serde_json::Value, _> = response.json().await;
        assert!(result.is_err());
    }
}