tradier 0.1.1

This project involves the development of a Rust library for managing trades and market data using the Tradier broker API. The main objective is to provide an efficient and secure interface for executing trades, retrieving real-time quotes, managing portfolios, and accessing historical market data. The library focuses on leveraging Rust's performance and concurrency advantages, enabling integration into high-frequency trading applications and data-intensive financial processing.
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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
use crate::constants::TRADIER_SESSION_TIMEOUT;
use crate::error::Result;
use crate::{config::Config, error::Error};
use chrono::{DateTime, Duration, Utc};
use reqwest::Client as HttpClient;
use serde::{Deserialize, Serialize};
use std::fmt::Display;
use tracing::debug;

use super::session_manager::SessionManager;

/// Represents a Tradier API session, handling WebSocket streaming configuration for either
/// account or market data.
#[allow(dead_code)]
#[derive(Debug, Clone)]
pub(crate) struct Session<'a> {
    /// The type of session, either `Account` or `Market`.
    pub session_type: SessionType,
    /// Contains information about the WebSocket stream, including URL and session ID.
    pub stream_info: StreamInfo,
    created_at: DateTime<Utc>,
    session_manager: &'a SessionManager,
}

/// Response structure for the Tradier API session request. Holds the stream information.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SessionResponse {
    /// Contains the WebSocket stream information such as URL and session ID.
    pub stream: StreamInfo,
}

/// Holds information about the WebSocket stream, including the URL and session ID.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct StreamInfo {
    /// WebSocket URL for the stream.
    pub url: String,
    /// Unique identifier for the session, used to maintain connection context.
    #[serde(rename = "sessionid")]
    pub session_id: String,
}

/// Specifies the type of Tradier API session, either `Market` for market data
/// or `Account` for account-related data.
#[derive(Debug, Clone, PartialEq)]
pub enum SessionType {
    Market,
    Account,
}

impl Display for SessionType {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            SessionType::Market => write!(f, "Market"),
            SessionType::Account => write!(f, "Account"),
        }
    }
}

impl<'a> Session<'a> {
    /// Creates a new `Session` instance using the specified session type and configuration,
    /// managed by the provided `SessionManager`.
    ///
    /// This method handles the creation of a Tradier WebSocket session for either market or
    /// account events. It ensures that only one session is active at any given time by leveraging
    /// the `SessionManager` for singleton enforcement.
    ///
    /// # Parameters
    /// - **`session_manager`**: A reference to the `SessionManager` that manages session state and ensures
    ///   only one active session exists at a time.
    /// - **`session_type`**: Specifies the type of session to create:
    ///   - `SessionType::Market`: For streaming market data.
    ///   - `SessionType::Account`: For streaming account-related events.
    /// - **`config`**: A reference to the `Config` object, which provides necessary information like
    ///   the API base URL and access tokens.
    ///
    /// # Returns
    /// - **`Ok(Session)`**: A new `Session` instance if the session is created successfully.
    /// - **`Err(Error)`**: An error if session creation fails.
    ///
    /// # Behavior
    /// - Acquires a lock from the `SessionManager` to ensure a singleton session.
    /// - Constructs the appropriate URL based on the session type.
    /// - Sends a POST request to the Tradier API to initialize the session.
    /// - Parses the response to extract the session stream information.
    ///
    /// # Errors
    /// This method will return an error if:
    /// - **Singleton Restriction**: Another session is already active (`SessionManager` prevents new sessions).
    /// - **Missing Access Token**: The `access_token` field in the provided `Config` is `None`.
    /// - **Network or API Issues**: The HTTP request to create the session fails due to:
    ///   - Network errors.
    ///   - Server errors (non-2xx HTTP responses).
    /// - **Malformed Response**: The API returns an invalid or unexpected response format.
    ///
    /// # Example for developers
    /// ```ignore
    /// use tradier::config::Config;
    /// use tradier::wssession::session::{Session, SessionManager, SessionType};
    /// #[tokio::main]
    /// async fn main() {
    ///     let config = Config::new();
    ///     let session_manager = SessionManager::new();
    ///
    ///     match Session::new_with_session_manager(&session_manager, SessionType::Account, &config).await {
    ///         Ok(session) => {
    ///             println!("Session created successfully!");
    ///         }
    ///         Err(e) => {
    ///             eprintln!("Failed to create session: {:?}", e);
    ///         }
    ///     }
    /// }
    /// ```
    ///
    /// # Debugging Information
    /// The method logs various debug messages, including:
    /// - The URL used to request the session.
    /// - Response headers, status code, and body.
    ///
    /// This can help diagnose issues with API connectivity or authentication.
    ///
    /// # Note
    /// The session must be explicitly released by the `SessionManager` when no longer needed to allow
    /// creation of new sessions.
    pub(crate) async fn new_with_session_manager(
        session_manager: &'a SessionManager,
        session_type: SessionType,
        config: &Config,
    ) -> Result<Self> {
        match session_manager.acquire_session() {
            Ok(_) => {
                let client = HttpClient::new();
                let url = match session_type {
                    SessionType::Market => {
                        format!("{}/v1/markets/events/session", config.rest_api.base_url)
                    }
                    SessionType::Account => {
                        format!("{}/v1/accounts/events/session", config.rest_api.base_url)
                    }
                };
                debug!("Url to use to get the Session ID: {}", url);

                let access_token = config
                    .credentials
                    .access_token
                    .as_ref()
                    .ok_or(Error::MissingAccessToken)?;

                let response = client
                    .post(&url)
                    .header("Authorization", format!("Bearer {}", access_token))
                    .header("Accept", "application/json")
                    .header("Content-Length", "0")
                    .body("")
                    .send()
                    .await?;

                let status = response.status();
                let headers = response.headers().clone();
                debug!("Response status: {}", status);
                debug!("Response headers: {:?}", headers);

                let body = response.text().await?;
                debug!("Response body: {}", body);

                if status.is_success() {
                    let session_response: SessionResponse = serde_json::from_str(&body)?;
                    Ok(Session {
                        session_type,
                        stream_info: session_response.stream,
                        created_at: Utc::now(),
                        session_manager,
                    })
                } else {
                    session_manager.release_session();
                    Err(Error::CreateSessionError(session_type, status, body))
                }
            }
            Err(e) => Err(e),
        }
    }

    /// Checks if the session has expired based on the configured session timeout.
    ///
    /// # Returns
    /// - `true` if the session duration exceeds `TRADIER_SESSION_TIMEOUT`, otherwise `false`.
    #[allow(dead_code)]
    pub fn is_expired(&self) -> bool {
        Utc::now() - self.created_at > Duration::minutes(TRADIER_SESSION_TIMEOUT)
    }

    /// Retrieves the WebSocket URL associated with the session.
    ///
    /// # Returns
    /// - `&str`: The WebSocket URL.
    pub fn get_websocket_url(&self) -> &str {
        &self.stream_info.url
    }

    /// Retrieves the session ID associated with the session.
    ///
    /// # Returns
    /// - `&str`: The session ID.
    pub fn get_session_id(&self) -> &str {
        &self.stream_info.session_id
    }
}

#[cfg(test)]
mod tests_session {
    use super::*;
    use crate::{
        config::{Credentials, RestApiConfig, StreamingConfig},
        utils::tests::create_test_config,
    };
    use mockito::Server;
    use pretty_assertions::{assert_eq, assert_matches};

    #[tokio::test]
    async fn test_account_session_creation() {
        let mut server = Server::new_async().await;
        let json_data = r#"
        {
            "stream": {
                "url": "wss://ws.tradier.com/v1/accounts/events",
                "sessionid": "c8638963-a6d4-4fb9-9bc6-e25fbd8c60c3"
            }
        }
        "#;
        let mock = server
            .mock("POST", "/v1/accounts/events/session")
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(json_data)
            .create_async()
            .await;

        let config = create_test_config().server_url(&server.url()).finish();
        let session_manager = SessionManager::default();
        {
            let session =
                Session::new_with_session_manager(&session_manager, SessionType::Account, &config)
                    .await
                    .unwrap();

            assert_eq!(session.session_type, SessionType::Account);
            assert_eq!(
                session.get_websocket_url(),
                "wss://ws.tradier.com/v1/accounts/events"
            );
            assert_eq!(
                session.get_session_id(),
                "c8638963-a6d4-4fb9-9bc6-e25fbd8c60c3"
            );
        }
        mock.assert_async().await;
    }

    #[tokio::test]
    async fn test_market_session_creation() {
        let mut server = Server::new_async().await;
        let json_data = r#"
        {
            "stream": {
                "url": "https://stream.tradier.com/v1/markets/events",
                "sessionid": "c8638963-a6d4-4fb9-9bc6-e25fbd8c60c3"
            }
        }
        "#;
        let mock = server
            .mock("POST", "/v1/markets/events/session")
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(json_data)
            .create_async()
            .await;

        let config = create_test_config().server_url(&server.url()).finish();
        let session_manager = SessionManager::default();
        let session =
            Session::new_with_session_manager(&session_manager, SessionType::Market, &config)
                .await
                .unwrap();

        assert_eq!(session.session_type, SessionType::Market);
        assert_eq!(
            session.get_websocket_url(),
            "https://stream.tradier.com/v1/markets/events"
        );
        assert_eq!(
            session.get_session_id(),
            "c8638963-a6d4-4fb9-9bc6-e25fbd8c60c3"
        );

        mock.assert_async().await;
    }

    #[tokio::test]
    async fn test_multiple_session_creation() {
        let mut server = Server::new_async().await;
        let json_data = r#"
        {
            "stream": {
                "url": "https://stream.tradier.com/v1/markets/events",
                "sessionid": "test_session_id"
            }
        }
        "#;
        let mock = server
            .mock("POST", "/v1/markets/events/session")
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(json_data)
            .expect(1)
            .create_async()
            .await;

        let config = create_test_config().server_url(&server.url()).finish();
        let session_manager = SessionManager::default();

        // Create first session
        let session1 =
            Session::new_with_session_manager(&session_manager, SessionType::Market, &config)
                .await
                .unwrap();

        // Attempt to create second session immediately (should fail)
        let session2 =
            Session::new_with_session_manager(&session_manager, SessionType::Market, &config).await;
        assert!(
            session2.is_err(),
            "Should not be able to create a second session"
        );
        assert!(session2
            .unwrap_err()
            .to_string()
            .contains("Session already exists"));

        // Drop the first session to reset the state
        drop(session1);

        mock.assert_async().await;
    }

    #[tokio::test]
    async fn test_content_length_header() {
        let mut server = Server::new_async().await;
        let json_data = r#"
        {
            "stream": {
                "url": "https://stream.tradier.com/v1/markets/events",
                "sessionid": "test_session_id"
            }
        }
        "#;
        let mock = server
            .mock("POST", "/v1/markets/events/session")
            .match_header("Content-Length", "0")
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(json_data)
            .create_async()
            .await;

        let config = create_test_config().server_url(&server.url()).finish();
        let session_manager = SessionManager::default();
        let session =
            Session::new_with_session_manager(&session_manager, SessionType::Market, &config)
                .await
                .unwrap();

        assert_eq!(session.session_type, SessionType::Market);
        mock.assert_async().await;
    }

    #[tokio::test]
    async fn test_missing_access_token_error() {
        let server = Server::new_async().await;
        let config = Config {
            credentials: Credentials {
                client_id: "test_id".to_string(),
                client_secret: "test_secret".to_string(),
                access_token: None, // Missing access token
                refresh_token: None,
            },
            rest_api: RestApiConfig {
                base_url: server.url().to_string(),
                timeout: 30,
            },
            streaming: StreamingConfig {
                http_base_url: "".to_string(),
                ws_base_url: "".to_string(),
                events_path: "".to_string(),
                reconnect_interval: 5,
            },
        };

        let session_manager = SessionManager::default();
        let session_result =
            Session::new_with_session_manager(&session_manager, SessionType::Market, &config).await;
        assert!(session_result.is_err());
        assert_matches!(session_result.unwrap_err(), Error::MissingAccessToken);
    }

    #[tokio::test]
    async fn test_api_request_failure_error() {
        let mut server = Server::new_async().await;
        let mock = server
            .mock("POST", "/v1/markets/events/session")
            .with_status(500) // Simulate server error
            .with_header("content-type", "application/json")
            .with_body("Internal Server Error")
            .create_async()
            .await;

        let config = create_test_config().server_url(&server.url()).finish();
        let session_manager = SessionManager::default();
        let session_result =
            Session::new_with_session_manager(&session_manager, SessionType::Market, &config).await;
        assert!(session_result.is_err());
        if let Error::CreateSessionError(_, status, body) = session_result.unwrap_err() {
            assert_eq!(status.as_u16(), 500);
            assert_eq!(body, "Internal Server Error");
        }

        mock.assert_async().await;
    }

    #[tokio::test]
    async fn test_invalid_json_response_error() {
        let mut server = Server::new_async().await;
        let mock = server
            .mock("POST", "/v1/markets/events/session")
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body("{ invalid json") // Malformed JSON
            .create_async()
            .await;

        let config = create_test_config().server_url(&server.url()).finish();
        let session_manager = SessionManager::default();

        let session_result =
            Session::new_with_session_manager(&session_manager, SessionType::Market, &config).await;
        assert!(session_result.is_err());
        assert_matches!(session_result.unwrap_err(), Error::JsonParsingError(_));

        mock.assert_async().await;
    }
}