-
Notifications
You must be signed in to change notification settings - Fork 54
Expand file tree
/
Copy pathserver_config.rs
More file actions
1153 lines (1020 loc) · 43.5 KB
/
server_config.rs
File metadata and controls
1153 lines (1020 loc) · 43.5 KB
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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/// Configuration for the server, including network and rate limiting settings.
use std::{env, str::FromStr};
use strum::Display;
use crate::{
constants::{
DEFAULT_PROVIDER_FAILURE_EXPIRATION_SECS, DEFAULT_PROVIDER_FAILURE_THRESHOLD,
DEFAULT_PROVIDER_PAUSE_DURATION_SECS, MINIMUM_SECRET_VALUE_LENGTH,
},
models::SecretString,
};
#[derive(Debug, Clone, PartialEq, Eq, Display)]
pub enum RepositoryStorageType {
InMemory,
Redis,
}
impl FromStr for RepositoryStorageType {
type Err = String;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s.to_lowercase().as_str() {
"inmemory" | "in_memory" => Ok(Self::InMemory),
"redis" => Ok(Self::Redis),
_ => Err(format!("Invalid repository storage type: {s}")),
}
}
}
#[derive(Debug, Clone)]
pub struct ServerConfig {
/// The host address the server will bind to.
pub host: String,
/// The port number the server will listen on.
pub port: u16,
/// The URL for the Redis instance.
pub redis_url: String,
/// The file path to the server's configuration file.
pub config_file_path: String,
/// The API key used for authentication.
pub api_key: SecretString,
/// The number of requests allowed per second.
pub rate_limit_requests_per_second: u64,
/// The maximum burst size for rate limiting.
pub rate_limit_burst_size: u32,
/// The port number for exposing metrics.
pub metrics_port: u16,
/// Enable Swagger UI.
pub enable_swagger: bool,
/// The number of seconds to wait for a Redis connection.
pub redis_connection_timeout_ms: u64,
/// The prefix for the Redis key.
pub redis_key_prefix: String,
/// Maximum number of connections in the Redis pool.
pub redis_pool_max_size: usize,
/// Timeout in milliseconds waiting to get a connection from the pool.
pub redis_pool_timeout_ms: u64,
/// The number of milliseconds to wait for an RPC response.
pub rpc_timeout_ms: u64,
/// Maximum number of retry attempts for provider operations.
pub provider_max_retries: u8,
/// Base delay between retry attempts (milliseconds).
pub provider_retry_base_delay_ms: u64,
/// Maximum delay between retry attempts (milliseconds).
pub provider_retry_max_delay_ms: u64,
/// Maximum number of failovers (switching to different providers).
pub provider_max_failovers: u8,
/// Number of consecutive failures before pausing a provider.
pub provider_failure_threshold: u32,
/// Duration in seconds to pause a provider after reaching failure threshold.
pub provider_pause_duration_secs: u64,
/// Duration in seconds after which failures are considered stale and reset.
pub provider_failure_expiration_secs: u64,
/// The type of repository storage to use.
pub repository_storage_type: RepositoryStorageType,
/// Flag to force config file processing.
pub reset_storage_on_start: bool,
/// The encryption key for the storage.
pub storage_encryption_key: Option<SecretString>,
/// Transaction expiration time in hours for transactions in final states.
pub transaction_expiration_hours: u64,
/// Comma-separated list of allowed RPC hosts (domains or IPs). If non-empty, only these hosts are permitted.
pub rpc_allowed_hosts: Vec<String>,
/// If true, block private IP addresses (RFC 1918, loopback, link-local). Cloud metadata endpoints are always blocked.
pub rpc_block_private_ips: bool,
}
impl ServerConfig {
/// Creates a new `ServerConfig` instance from environment variables.
///
/// # Panics
///
/// This function will panic if the `REDIS_URL` or `API_KEY` environment
/// variables are not set, as they are required for the server to function.
///
/// # Defaults
///
/// - `HOST` defaults to `"0.0.0.0"`.
/// - `APP_PORT` defaults to `8080`.
/// - `CONFIG_DIR` defaults to `"config/config.json"`.
/// - `RATE_LIMIT_REQUESTS_PER_SECOND` defaults to `100`.
/// - `RATE_LIMIT_BURST_SIZE` defaults to `300`.
/// - `METRICS_PORT` defaults to `8081`.
/// - `PROVIDER_MAX_RETRIES` defaults to `3`.
/// - `PROVIDER_RETRY_BASE_DELAY_MS` defaults to `100`.
/// - `PROVIDER_RETRY_MAX_DELAY_MS` defaults to `2000`.
/// - `PROVIDER_MAX_FAILOVERS` defaults to `3`.
/// - `PROVIDER_FAILURE_THRESHOLD` defaults to `3`.
/// - `PROVIDER_PAUSE_DURATION_SECS` defaults to `60` (1 minute).
/// - `PROVIDER_FAILURE_EXPIRATION_SECS` defaults to `60` (1 minute).
/// - `REPOSITORY_STORAGE_TYPE` defaults to `"in_memory"`.
/// - `TRANSACTION_EXPIRATION_HOURS` defaults to `4`.
pub fn from_env() -> Self {
Self {
host: Self::get_host(),
port: Self::get_port(),
redis_url: Self::get_redis_url(), // Uses panicking version as required
config_file_path: Self::get_config_file_path(),
api_key: Self::get_api_key(), // Uses panicking version as required
rate_limit_requests_per_second: Self::get_rate_limit_requests_per_second(),
rate_limit_burst_size: Self::get_rate_limit_burst_size(),
metrics_port: Self::get_metrics_port(),
enable_swagger: Self::get_enable_swagger(),
redis_connection_timeout_ms: Self::get_redis_connection_timeout_ms(),
redis_key_prefix: Self::get_redis_key_prefix(),
redis_pool_max_size: Self::get_redis_pool_max_size(),
redis_pool_timeout_ms: Self::get_redis_pool_timeout_ms(),
rpc_timeout_ms: Self::get_rpc_timeout_ms(),
provider_max_retries: Self::get_provider_max_retries(),
provider_retry_base_delay_ms: Self::get_provider_retry_base_delay_ms(),
provider_retry_max_delay_ms: Self::get_provider_retry_max_delay_ms(),
provider_max_failovers: Self::get_provider_max_failovers(),
provider_failure_threshold: Self::get_provider_failure_threshold(),
provider_pause_duration_secs: Self::get_provider_pause_duration_secs(),
provider_failure_expiration_secs: Self::get_provider_failure_expiration_secs(),
repository_storage_type: Self::get_repository_storage_type(),
reset_storage_on_start: Self::get_reset_storage_on_start(),
storage_encryption_key: Self::get_storage_encryption_key(),
transaction_expiration_hours: Self::get_transaction_expiration_hours(),
rpc_allowed_hosts: Self::get_rpc_allowed_hosts(),
rpc_block_private_ips: Self::get_rpc_block_private_ips(),
}
}
// Individual getter methods for each configuration field
/// Gets the host from environment variable or default
pub fn get_host() -> String {
env::var("HOST").unwrap_or_else(|_| "0.0.0.0".to_string())
}
/// Gets the port from environment variable or default
pub fn get_port() -> u16 {
env::var("APP_PORT")
.unwrap_or_else(|_| "8080".to_string())
.parse()
.unwrap_or(8080)
}
/// Gets the Redis URL from environment variable (panics if not set)
pub fn get_redis_url() -> String {
env::var("REDIS_URL").expect("REDIS_URL must be set")
}
/// Gets the Redis URL from environment variable or returns None if not set
pub fn get_redis_url_optional() -> Option<String> {
env::var("REDIS_URL").ok()
}
/// Gets the config file path from environment variables or default
pub fn get_config_file_path() -> String {
let conf_dir = if env::var("IN_DOCKER")
.map(|val| val == "true")
.unwrap_or(false)
{
"config/".to_string()
} else {
env::var("CONFIG_DIR").unwrap_or_else(|_| "./config".to_string())
};
let conf_dir = format!("{}/", conf_dir.trim_end_matches('/'));
let config_file_name =
env::var("CONFIG_FILE_NAME").unwrap_or_else(|_| "config.json".to_string());
format!("{conf_dir}{config_file_name}")
}
/// Gets the API key from environment variable (panics if not set or too short)
pub fn get_api_key() -> SecretString {
let api_key = SecretString::new(&env::var("API_KEY").expect("API_KEY must be set"));
if !api_key.has_minimum_length(MINIMUM_SECRET_VALUE_LENGTH) {
panic!(
"Security error: API_KEY must be at least {MINIMUM_SECRET_VALUE_LENGTH} characters long"
);
}
api_key
}
/// Gets the API key from environment variable or returns None if not set or invalid
pub fn get_api_key_optional() -> Option<SecretString> {
env::var("API_KEY")
.ok()
.map(|key| SecretString::new(&key))
.filter(|key| key.has_minimum_length(MINIMUM_SECRET_VALUE_LENGTH))
}
/// Gets the rate limit requests per second from environment variable or default
pub fn get_rate_limit_requests_per_second() -> u64 {
env::var("RATE_LIMIT_REQUESTS_PER_SECOND")
.unwrap_or_else(|_| "100".to_string())
.parse()
.unwrap_or(100)
}
/// Gets the rate limit burst size from environment variable or default
pub fn get_rate_limit_burst_size() -> u32 {
env::var("RATE_LIMIT_BURST_SIZE")
.unwrap_or_else(|_| "300".to_string())
.parse()
.unwrap_or(300)
}
/// Gets the metrics port from environment variable or default
pub fn get_metrics_port() -> u16 {
env::var("METRICS_PORT")
.unwrap_or_else(|_| "8081".to_string())
.parse()
.unwrap_or(8081)
}
/// Gets the enable swagger setting from environment variable or default
pub fn get_enable_swagger() -> bool {
env::var("ENABLE_SWAGGER")
.map(|v| v.to_lowercase() == "true")
.unwrap_or(false)
}
/// Gets the Redis connection timeout from environment variable or default
pub fn get_redis_connection_timeout_ms() -> u64 {
env::var("REDIS_CONNECTION_TIMEOUT_MS")
.unwrap_or_else(|_| "10000".to_string())
.parse()
.unwrap_or(10000)
}
/// Gets the Redis key prefix from environment variable or default
pub fn get_redis_key_prefix() -> String {
env::var("REDIS_KEY_PREFIX").unwrap_or_else(|_| "oz-relayer".to_string())
}
/// Gets the Redis pool max size from environment variable or default
pub fn get_redis_pool_max_size() -> usize {
env::var("REDIS_POOL_MAX_SIZE")
.unwrap_or_else(|_| "500".to_string())
.parse()
.unwrap_or(500)
}
/// Gets the Redis pool timeout from environment variable or default
pub fn get_redis_pool_timeout_ms() -> u64 {
env::var("REDIS_POOL_TIMEOUT_MS")
.unwrap_or_else(|_| "10000".to_string())
.parse()
.unwrap_or(10000)
}
/// Gets the RPC timeout from environment variable or default
pub fn get_rpc_timeout_ms() -> u64 {
env::var("RPC_TIMEOUT_MS")
.unwrap_or_else(|_| "10000".to_string())
.parse()
.unwrap_or(10000)
}
/// Gets the provider max retries from environment variable or default
pub fn get_provider_max_retries() -> u8 {
env::var("PROVIDER_MAX_RETRIES")
.unwrap_or_else(|_| "3".to_string())
.parse()
.unwrap_or(3)
}
/// Gets the provider retry base delay from environment variable or default
pub fn get_provider_retry_base_delay_ms() -> u64 {
env::var("PROVIDER_RETRY_BASE_DELAY_MS")
.unwrap_or_else(|_| "100".to_string())
.parse()
.unwrap_or(100)
}
/// Gets the provider retry max delay from environment variable or default
pub fn get_provider_retry_max_delay_ms() -> u64 {
env::var("PROVIDER_RETRY_MAX_DELAY_MS")
.unwrap_or_else(|_| "2000".to_string())
.parse()
.unwrap_or(2000)
}
/// Gets the provider max failovers from environment variable or default
pub fn get_provider_max_failovers() -> u8 {
env::var("PROVIDER_MAX_FAILOVERS")
.unwrap_or_else(|_| "3".to_string())
.parse()
.unwrap_or(3)
}
/// Gets the provider failure threshold from environment variable or default
pub fn get_provider_failure_threshold() -> u32 {
env::var("PROVIDER_FAILURE_THRESHOLD")
.or_else(|_| env::var("RPC_FAILURE_THRESHOLD")) // Support legacy env var
.unwrap_or_else(|_| DEFAULT_PROVIDER_FAILURE_THRESHOLD.to_string())
.parse()
.unwrap_or(DEFAULT_PROVIDER_FAILURE_THRESHOLD)
}
/// Gets the provider pause duration in seconds from environment variable or default
///
/// Defaults to 60 seconds (1 minute) for faster recovery while still providing
/// a reasonable cooldown period for failed providers.
pub fn get_provider_pause_duration_secs() -> u64 {
env::var("PROVIDER_PAUSE_DURATION_SECS")
.or_else(|_| env::var("RPC_PAUSE_DURATION_SECS")) // Support legacy env var
.unwrap_or_else(|_| DEFAULT_PROVIDER_PAUSE_DURATION_SECS.to_string())
.parse()
.unwrap_or(DEFAULT_PROVIDER_PAUSE_DURATION_SECS)
}
/// Gets the provider failure expiration duration in seconds from environment variable or default
///
/// Defaults to 60 seconds (1 minute). Failures older than this are considered stale
/// and reset, allowing providers to naturally recover over time.
pub fn get_provider_failure_expiration_secs() -> u64 {
env::var("PROVIDER_FAILURE_EXPIRATION_SECS")
.unwrap_or_else(|_| DEFAULT_PROVIDER_FAILURE_EXPIRATION_SECS.to_string())
.parse()
.unwrap_or(DEFAULT_PROVIDER_FAILURE_EXPIRATION_SECS)
}
/// Gets the repository storage type from environment variable or default
pub fn get_repository_storage_type() -> RepositoryStorageType {
env::var("REPOSITORY_STORAGE_TYPE")
.unwrap_or_else(|_| "in_memory".to_string())
.parse()
.unwrap_or(RepositoryStorageType::InMemory)
}
/// Gets the reset storage on start setting from environment variable or default
pub fn get_reset_storage_on_start() -> bool {
env::var("RESET_STORAGE_ON_START")
.map(|v| v.to_lowercase() == "true")
.unwrap_or(false)
}
/// Gets the storage encryption key from environment variable or None
pub fn get_storage_encryption_key() -> Option<SecretString> {
env::var("STORAGE_ENCRYPTION_KEY")
.map(|v| SecretString::new(&v))
.ok()
}
/// Gets the transaction expiration hours from environment variable or default
pub fn get_transaction_expiration_hours() -> u64 {
env::var("TRANSACTION_EXPIRATION_HOURS")
.unwrap_or_else(|_| "4".to_string())
.parse()
.unwrap_or(4)
}
/// Gets the allowed RPC hosts from environment variable or default (empty list)
pub fn get_rpc_allowed_hosts() -> Vec<String> {
env::var("RPC_ALLOWED_HOSTS")
.ok()
.map(|s| {
s.split(',')
.map(|host| host.trim().to_string())
.filter(|host| !host.is_empty())
.collect()
})
.unwrap_or_default()
}
/// Gets the block private IPs setting from environment variable or default (false)
pub fn get_rpc_block_private_ips() -> bool {
env::var("RPC_BLOCK_PRIVATE_IPS")
.map(|v| v.to_lowercase() == "true")
.unwrap_or(false)
}
/// Get worker concurrency from environment variable or use default
///
/// Environment variable format: `BACKGROUND_WORKER_{WORKER_NAME}_CONCURRENCY`
/// Example: `BACKGROUND_WORKER_TRANSACTION_REQUEST_CONCURRENCY=20`
pub fn get_worker_concurrency(worker_name: &str, default: usize) -> usize {
let env_var = format!(
"BACKGROUND_WORKER_{}_CONCURRENCY",
worker_name.to_uppercase()
);
env::var(&env_var)
.ok()
.and_then(|v| v.parse().ok())
.unwrap_or(default)
}
}
#[cfg(test)]
mod tests {
use super::*;
use lazy_static::lazy_static;
use std::env;
use std::sync::Mutex;
// Use a mutex to ensure tests don't run in parallel when modifying env vars
lazy_static! {
static ref ENV_MUTEX: Mutex<()> = Mutex::new(());
}
fn setup() {
// Clear all environment variables first
env::remove_var("HOST");
env::remove_var("APP_PORT");
env::remove_var("REDIS_URL");
env::remove_var("CONFIG_DIR");
env::remove_var("CONFIG_FILE_NAME");
env::remove_var("CONFIG_FILE_PATH");
env::remove_var("API_KEY");
env::remove_var("RATE_LIMIT_REQUESTS_PER_SECOND");
env::remove_var("RATE_LIMIT_BURST_SIZE");
env::remove_var("METRICS_PORT");
env::remove_var("REDIS_CONNECTION_TIMEOUT_MS");
env::remove_var("RPC_TIMEOUT_MS");
env::remove_var("PROVIDER_MAX_RETRIES");
env::remove_var("PROVIDER_RETRY_BASE_DELAY_MS");
env::remove_var("PROVIDER_RETRY_MAX_DELAY_MS");
env::remove_var("PROVIDER_MAX_FAILOVERS");
env::remove_var("REPOSITORY_STORAGE_TYPE");
env::remove_var("RESET_STORAGE_ON_START");
env::remove_var("TRANSACTION_EXPIRATION_HOURS");
// Set required variables for most tests
env::set_var("REDIS_URL", "redis://localhost:6379");
env::set_var("API_KEY", "7EF1CB7C-5003-4696-B384-C72AF8C3E15D");
env::set_var("REDIS_CONNECTION_TIMEOUT_MS", "5000");
}
#[test]
fn test_default_values() {
let _lock = match ENV_MUTEX.lock() {
Ok(guard) => guard,
Err(poisoned) => poisoned.into_inner(),
};
setup();
let config = ServerConfig::from_env();
assert_eq!(config.host, "0.0.0.0");
assert_eq!(config.port, 8080);
assert_eq!(config.redis_url, "redis://localhost:6379");
assert_eq!(config.config_file_path, "./config/config.json");
assert_eq!(
config.api_key,
SecretString::new("7EF1CB7C-5003-4696-B384-C72AF8C3E15D")
);
assert_eq!(config.rate_limit_requests_per_second, 100);
assert_eq!(config.rate_limit_burst_size, 300);
assert_eq!(config.metrics_port, 8081);
assert_eq!(config.redis_connection_timeout_ms, 5000);
assert_eq!(config.rpc_timeout_ms, 10000);
assert_eq!(config.provider_max_retries, 3);
assert_eq!(config.provider_retry_base_delay_ms, 100);
assert_eq!(config.provider_retry_max_delay_ms, 2000);
assert_eq!(config.provider_max_failovers, 3);
assert_eq!(config.provider_failure_threshold, 3);
assert_eq!(config.provider_pause_duration_secs, 60);
assert_eq!(
config.repository_storage_type,
RepositoryStorageType::InMemory
);
assert!(!config.reset_storage_on_start);
assert_eq!(config.transaction_expiration_hours, 4);
}
#[test]
fn test_invalid_port_values() {
let _lock = match ENV_MUTEX.lock() {
Ok(guard) => guard,
Err(poisoned) => poisoned.into_inner(),
};
setup();
env::set_var("REDIS_URL", "redis://localhost:6379");
env::set_var("API_KEY", "7EF1CB7C-5003-4696-B384-C72AF8C3E15D");
env::set_var("APP_PORT", "not_a_number");
env::set_var("METRICS_PORT", "also_not_a_number");
env::set_var("RATE_LIMIT_REQUESTS_PER_SECOND", "invalid");
env::set_var("RATE_LIMIT_BURST_SIZE", "invalid");
env::set_var("REDIS_CONNECTION_TIMEOUT_MS", "invalid");
env::set_var("RPC_TIMEOUT_MS", "invalid");
env::set_var("PROVIDER_MAX_RETRIES", "invalid");
env::set_var("PROVIDER_RETRY_BASE_DELAY_MS", "invalid");
env::set_var("PROVIDER_RETRY_MAX_DELAY_MS", "invalid");
env::set_var("PROVIDER_MAX_FAILOVERS", "invalid");
env::set_var("REPOSITORY_STORAGE_TYPE", "invalid");
env::set_var("RESET_STORAGE_ON_START", "invalid");
env::set_var("TRANSACTION_EXPIRATION_HOURS", "invalid");
let config = ServerConfig::from_env();
// Should fall back to defaults when parsing fails
assert_eq!(config.port, 8080);
assert_eq!(config.metrics_port, 8081);
assert_eq!(config.rate_limit_requests_per_second, 100);
assert_eq!(config.rate_limit_burst_size, 300);
assert_eq!(config.redis_connection_timeout_ms, 10000);
assert_eq!(config.rpc_timeout_ms, 10000);
assert_eq!(config.provider_max_retries, 3);
assert_eq!(config.provider_retry_base_delay_ms, 100);
assert_eq!(config.provider_retry_max_delay_ms, 2000);
assert_eq!(config.provider_max_failovers, 3);
assert_eq!(
config.repository_storage_type,
RepositoryStorageType::InMemory
);
assert!(!config.reset_storage_on_start);
assert_eq!(config.transaction_expiration_hours, 4);
}
#[test]
fn test_custom_values() {
let _lock = match ENV_MUTEX.lock() {
Ok(guard) => guard,
Err(poisoned) => poisoned.into_inner(),
};
setup();
env::set_var("HOST", "127.0.0.1");
env::set_var("APP_PORT", "9090");
env::set_var("REDIS_URL", "redis://custom:6379");
env::set_var("CONFIG_DIR", "custom");
env::set_var("CONFIG_FILE_NAME", "path.json");
env::set_var("API_KEY", "7EF1CB7C-5003-4696-B384-C72AF8C3E15D");
env::set_var("RATE_LIMIT_REQUESTS_PER_SECOND", "200");
env::set_var("RATE_LIMIT_BURST_SIZE", "500");
env::set_var("METRICS_PORT", "9091");
env::set_var("REDIS_CONNECTION_TIMEOUT_MS", "10000");
env::set_var("RPC_TIMEOUT_MS", "33333");
env::set_var("PROVIDER_MAX_RETRIES", "5");
env::set_var("PROVIDER_RETRY_BASE_DELAY_MS", "200");
env::set_var("PROVIDER_RETRY_MAX_DELAY_MS", "3000");
env::set_var("PROVIDER_MAX_FAILOVERS", "4");
env::set_var("REPOSITORY_STORAGE_TYPE", "in_memory");
env::set_var("RESET_STORAGE_ON_START", "true");
env::set_var("TRANSACTION_EXPIRATION_HOURS", "6");
let config = ServerConfig::from_env();
assert_eq!(config.host, "127.0.0.1");
assert_eq!(config.port, 9090);
assert_eq!(config.redis_url, "redis://custom:6379");
assert_eq!(config.config_file_path, "custom/path.json");
assert_eq!(
config.api_key,
SecretString::new("7EF1CB7C-5003-4696-B384-C72AF8C3E15D")
);
assert_eq!(config.rate_limit_requests_per_second, 200);
assert_eq!(config.rate_limit_burst_size, 500);
assert_eq!(config.metrics_port, 9091);
assert_eq!(config.redis_connection_timeout_ms, 10000);
assert_eq!(config.rpc_timeout_ms, 33333);
assert_eq!(config.provider_max_retries, 5);
assert_eq!(config.provider_retry_base_delay_ms, 200);
assert_eq!(config.provider_retry_max_delay_ms, 3000);
assert_eq!(config.provider_max_failovers, 4);
assert_eq!(
config.repository_storage_type,
RepositoryStorageType::InMemory
);
assert!(config.reset_storage_on_start);
assert_eq!(config.transaction_expiration_hours, 6);
}
#[test]
#[should_panic(expected = "Security error: API_KEY must be at least 32 characters long")]
fn test_invalid_api_key_length() {
let _lock = match ENV_MUTEX.lock() {
Ok(guard) => guard,
Err(poisoned) => poisoned.into_inner(),
};
setup();
env::set_var("REDIS_URL", "redis://localhost:6379");
env::set_var("API_KEY", "insufficient_length");
env::set_var("APP_PORT", "8080");
env::set_var("RATE_LIMIT_REQUESTS_PER_SECOND", "100");
env::set_var("RATE_LIMIT_BURST_SIZE", "300");
env::set_var("METRICS_PORT", "9091");
env::set_var("TRANSACTION_EXPIRATION_HOURS", "4");
let _ = ServerConfig::from_env();
panic!("Test should have panicked before reaching here");
}
// Tests for individual getter methods
#[test]
fn test_individual_getters_with_defaults() {
let _lock = match ENV_MUTEX.lock() {
Ok(guard) => guard,
Err(poisoned) => poisoned.into_inner(),
};
// Clear all environment variables to test defaults
env::remove_var("HOST");
env::remove_var("APP_PORT");
env::remove_var("REDIS_URL");
env::remove_var("CONFIG_DIR");
env::remove_var("CONFIG_FILE_NAME");
env::remove_var("API_KEY");
env::remove_var("RATE_LIMIT_REQUESTS_PER_SECOND");
env::remove_var("RATE_LIMIT_BURST_SIZE");
env::remove_var("METRICS_PORT");
env::remove_var("ENABLE_SWAGGER");
env::remove_var("REDIS_CONNECTION_TIMEOUT_MS");
env::remove_var("REDIS_KEY_PREFIX");
env::remove_var("RPC_TIMEOUT_MS");
env::remove_var("PROVIDER_MAX_RETRIES");
env::remove_var("PROVIDER_RETRY_BASE_DELAY_MS");
env::remove_var("PROVIDER_RETRY_MAX_DELAY_MS");
env::remove_var("PROVIDER_MAX_FAILOVERS");
env::remove_var("REPOSITORY_STORAGE_TYPE");
env::remove_var("RESET_STORAGE_ON_START");
env::remove_var("STORAGE_ENCRYPTION_KEY");
env::remove_var("TRANSACTION_EXPIRATION_HOURS");
env::remove_var("REDIS_POOL_MAX_SIZE");
env::remove_var("REDIS_POOL_TIMEOUT_MS");
// Test individual getters with defaults
assert_eq!(ServerConfig::get_host(), "0.0.0.0");
assert_eq!(ServerConfig::get_port(), 8080);
assert_eq!(ServerConfig::get_redis_url_optional(), None);
assert_eq!(ServerConfig::get_config_file_path(), "./config/config.json");
assert_eq!(ServerConfig::get_api_key_optional(), None);
assert_eq!(ServerConfig::get_rate_limit_requests_per_second(), 100);
assert_eq!(ServerConfig::get_rate_limit_burst_size(), 300);
assert_eq!(ServerConfig::get_metrics_port(), 8081);
assert!(!ServerConfig::get_enable_swagger());
assert_eq!(ServerConfig::get_redis_connection_timeout_ms(), 10000);
assert_eq!(ServerConfig::get_redis_key_prefix(), "oz-relayer");
assert_eq!(ServerConfig::get_rpc_timeout_ms(), 10000);
assert_eq!(ServerConfig::get_provider_max_retries(), 3);
assert_eq!(ServerConfig::get_provider_retry_base_delay_ms(), 100);
assert_eq!(ServerConfig::get_provider_retry_max_delay_ms(), 2000);
assert_eq!(ServerConfig::get_provider_max_failovers(), 3);
assert_eq!(
ServerConfig::get_repository_storage_type(),
RepositoryStorageType::InMemory
);
assert!(!ServerConfig::get_reset_storage_on_start());
assert!(ServerConfig::get_storage_encryption_key().is_none());
assert_eq!(ServerConfig::get_transaction_expiration_hours(), 4);
assert_eq!(ServerConfig::get_redis_pool_max_size(), 500);
assert_eq!(ServerConfig::get_redis_pool_timeout_ms(), 10000);
}
#[test]
fn test_individual_getters_with_custom_values() {
let _lock = match ENV_MUTEX.lock() {
Ok(guard) => guard,
Err(poisoned) => poisoned.into_inner(),
};
// Set custom values
env::set_var("HOST", "192.168.1.1");
env::set_var("APP_PORT", "9999");
env::set_var("REDIS_URL", "redis://custom:6379");
env::set_var("CONFIG_DIR", "/custom/config");
env::set_var("CONFIG_FILE_NAME", "custom.json");
env::set_var("API_KEY", "7EF1CB7C-5003-4696-B384-C72AF8C3E15D");
env::set_var("RATE_LIMIT_REQUESTS_PER_SECOND", "500");
env::set_var("RATE_LIMIT_BURST_SIZE", "1000");
env::set_var("METRICS_PORT", "9999");
env::set_var("ENABLE_SWAGGER", "true");
env::set_var("REDIS_CONNECTION_TIMEOUT_MS", "5000");
env::set_var("REDIS_KEY_PREFIX", "custom-prefix");
env::set_var("RPC_TIMEOUT_MS", "15000");
env::set_var("PROVIDER_MAX_RETRIES", "5");
env::set_var("PROVIDER_RETRY_BASE_DELAY_MS", "200");
env::set_var("PROVIDER_RETRY_MAX_DELAY_MS", "5000");
env::set_var("PROVIDER_MAX_FAILOVERS", "10");
env::set_var("REPOSITORY_STORAGE_TYPE", "redis");
env::set_var("RESET_STORAGE_ON_START", "true");
env::set_var("STORAGE_ENCRYPTION_KEY", "my-encryption-key");
env::set_var("TRANSACTION_EXPIRATION_HOURS", "12");
env::set_var("REDIS_POOL_MAX_SIZE", "200");
env::set_var("REDIS_POOL_TIMEOUT_MS", "20000");
// Test individual getters with custom values
assert_eq!(ServerConfig::get_host(), "192.168.1.1");
assert_eq!(ServerConfig::get_port(), 9999);
assert_eq!(
ServerConfig::get_redis_url_optional(),
Some("redis://custom:6379".to_string())
);
assert_eq!(
ServerConfig::get_config_file_path(),
"/custom/config/custom.json"
);
assert!(ServerConfig::get_api_key_optional().is_some());
assert_eq!(ServerConfig::get_rate_limit_requests_per_second(), 500);
assert_eq!(ServerConfig::get_rate_limit_burst_size(), 1000);
assert_eq!(ServerConfig::get_metrics_port(), 9999);
assert!(ServerConfig::get_enable_swagger());
assert_eq!(ServerConfig::get_redis_connection_timeout_ms(), 5000);
assert_eq!(ServerConfig::get_redis_key_prefix(), "custom-prefix");
assert_eq!(ServerConfig::get_rpc_timeout_ms(), 15000);
assert_eq!(ServerConfig::get_provider_max_retries(), 5);
assert_eq!(ServerConfig::get_provider_retry_base_delay_ms(), 200);
assert_eq!(ServerConfig::get_provider_retry_max_delay_ms(), 5000);
assert_eq!(ServerConfig::get_provider_max_failovers(), 10);
assert_eq!(
ServerConfig::get_repository_storage_type(),
RepositoryStorageType::Redis
);
assert!(ServerConfig::get_reset_storage_on_start());
assert!(ServerConfig::get_storage_encryption_key().is_some());
assert_eq!(ServerConfig::get_transaction_expiration_hours(), 12);
assert_eq!(ServerConfig::get_redis_pool_max_size(), 200);
assert_eq!(ServerConfig::get_redis_pool_timeout_ms(), 20000);
}
#[test]
fn test_get_redis_pool_max_size() {
let _lock = match ENV_MUTEX.lock() {
Ok(guard) => guard,
Err(poisoned) => poisoned.into_inner(),
};
// Test default value when env var is not set
env::remove_var("REDIS_POOL_MAX_SIZE");
assert_eq!(ServerConfig::get_redis_pool_max_size(), 500);
// Test custom value
env::set_var("REDIS_POOL_MAX_SIZE", "100");
assert_eq!(ServerConfig::get_redis_pool_max_size(), 100);
// Test invalid value returns default
env::set_var("REDIS_POOL_MAX_SIZE", "not_a_number");
assert_eq!(ServerConfig::get_redis_pool_max_size(), 500);
// Test zero value (should be accepted)
env::set_var("REDIS_POOL_MAX_SIZE", "0");
assert_eq!(ServerConfig::get_redis_pool_max_size(), 0);
// Test large value
env::set_var("REDIS_POOL_MAX_SIZE", "10000");
assert_eq!(ServerConfig::get_redis_pool_max_size(), 10000);
// Cleanup
env::remove_var("REDIS_POOL_MAX_SIZE");
}
#[test]
fn test_get_redis_pool_timeout_ms() {
let _lock = match ENV_MUTEX.lock() {
Ok(guard) => guard,
Err(poisoned) => poisoned.into_inner(),
};
// Test default value when env var is not set
env::remove_var("REDIS_POOL_TIMEOUT_MS");
assert_eq!(ServerConfig::get_redis_pool_timeout_ms(), 10000);
// Test custom value
env::set_var("REDIS_POOL_TIMEOUT_MS", "15000");
assert_eq!(ServerConfig::get_redis_pool_timeout_ms(), 15000);
// Test invalid value returns default
env::set_var("REDIS_POOL_TIMEOUT_MS", "not_a_number");
assert_eq!(ServerConfig::get_redis_pool_timeout_ms(), 10000);
// Test zero value (should be accepted)
env::set_var("REDIS_POOL_TIMEOUT_MS", "0");
assert_eq!(ServerConfig::get_redis_pool_timeout_ms(), 0);
// Test large value
env::set_var("REDIS_POOL_TIMEOUT_MS", "60000");
assert_eq!(ServerConfig::get_redis_pool_timeout_ms(), 60000);
// Cleanup
env::remove_var("REDIS_POOL_TIMEOUT_MS");
}
#[test]
#[should_panic(expected = "REDIS_URL must be set")]
fn test_get_redis_url_panics_when_not_set() {
let _lock = match ENV_MUTEX.lock() {
Ok(guard) => guard,
Err(poisoned) => poisoned.into_inner(),
};
env::remove_var("REDIS_URL");
let _ = ServerConfig::get_redis_url();
}
#[test]
#[should_panic(expected = "API_KEY must be set")]
fn test_get_api_key_panics_when_not_set() {
let _lock = match ENV_MUTEX.lock() {
Ok(guard) => guard,
Err(poisoned) => poisoned.into_inner(),
};
env::remove_var("API_KEY");
let _ = ServerConfig::get_api_key();
}
#[test]
fn test_optional_getters_return_none_safely() {
let _lock = match ENV_MUTEX.lock() {
Ok(guard) => guard,
Err(poisoned) => poisoned.into_inner(),
};
env::remove_var("REDIS_URL");
env::remove_var("API_KEY");
env::remove_var("STORAGE_ENCRYPTION_KEY");
assert!(ServerConfig::get_redis_url_optional().is_none());
assert!(ServerConfig::get_api_key_optional().is_none());
assert!(ServerConfig::get_storage_encryption_key().is_none());
}
#[test]
fn test_refactored_from_env_equivalence() {
let _lock = match ENV_MUTEX.lock() {
Ok(guard) => guard,
Err(poisoned) => poisoned.into_inner(),
};
setup();
// Set custom values to test both default and custom paths
env::set_var("HOST", "custom-host");
env::set_var("APP_PORT", "7777");
env::set_var("RATE_LIMIT_REQUESTS_PER_SECOND", "250");
env::set_var("METRICS_PORT", "7778");
env::set_var("ENABLE_SWAGGER", "true");
env::set_var("PROVIDER_MAX_RETRIES", "7");
env::set_var("TRANSACTION_EXPIRATION_HOURS", "8");
let config = ServerConfig::from_env();
// Verify the refactored from_env() produces the same results as individual getters
assert_eq!(config.host, ServerConfig::get_host());
assert_eq!(config.port, ServerConfig::get_port());
assert_eq!(config.redis_url, ServerConfig::get_redis_url());
assert_eq!(
config.config_file_path,
ServerConfig::get_config_file_path()
);
assert_eq!(config.api_key, ServerConfig::get_api_key());
assert_eq!(
config.rate_limit_requests_per_second,
ServerConfig::get_rate_limit_requests_per_second()
);
assert_eq!(
config.rate_limit_burst_size,
ServerConfig::get_rate_limit_burst_size()
);
assert_eq!(config.metrics_port, ServerConfig::get_metrics_port());
assert_eq!(config.enable_swagger, ServerConfig::get_enable_swagger());
assert_eq!(
config.redis_connection_timeout_ms,
ServerConfig::get_redis_connection_timeout_ms()
);
assert_eq!(
config.redis_key_prefix,
ServerConfig::get_redis_key_prefix()
);
assert_eq!(config.rpc_timeout_ms, ServerConfig::get_rpc_timeout_ms());
assert_eq!(
config.provider_max_retries,
ServerConfig::get_provider_max_retries()
);
assert_eq!(
config.provider_retry_base_delay_ms,
ServerConfig::get_provider_retry_base_delay_ms()
);
assert_eq!(
config.provider_retry_max_delay_ms,
ServerConfig::get_provider_retry_max_delay_ms()
);
assert_eq!(
config.provider_max_failovers,
ServerConfig::get_provider_max_failovers()
);
assert_eq!(
config.repository_storage_type,
ServerConfig::get_repository_storage_type()
);
assert_eq!(
config.reset_storage_on_start,
ServerConfig::get_reset_storage_on_start()
);
assert_eq!(
config.storage_encryption_key,
ServerConfig::get_storage_encryption_key()
);
assert_eq!(
config.transaction_expiration_hours,
ServerConfig::get_transaction_expiration_hours()
);
}
mod get_worker_concurrency_tests {
use super::*;
use serial_test::serial;
#[test]
#[serial]
fn test_returns_default_when_env_not_set() {
let worker_name = "test_worker";
let env_var = format!(
"BACKGROUND_WORKER_{}_CONCURRENCY",
worker_name.to_uppercase()
);
// Ensure env var is not set
env::remove_var(&env_var);
let default_value = 42;
let result = ServerConfig::get_worker_concurrency(worker_name, default_value);
assert_eq!(
result, default_value,
"Should return default value when env var is not set"
);
}
#[test]
#[serial]
fn test_returns_env_value_when_set() {
let worker_name = "status_checker";
let env_var = format!(
"BACKGROUND_WORKER_{}_CONCURRENCY",
worker_name.to_uppercase()
);
// Set env var to a specific value
env::set_var(&env_var, "100");
let default_value = 10;
let result = ServerConfig::get_worker_concurrency(worker_name, default_value);
assert_eq!(result, 100, "Should return env var value when set");
// Cleanup
env::remove_var(&env_var);
}
#[test]
#[serial]
fn test_returns_default_when_env_invalid() {
let worker_name = "invalid_worker";
let env_var = format!(
"BACKGROUND_WORKER_{}_CONCURRENCY",
worker_name.to_uppercase()
);
// Set env var to invalid value
env::set_var(&env_var, "not_a_number");
let default_value = 25;
let result = ServerConfig::get_worker_concurrency(worker_name, default_value);
assert_eq!(
result, default_value,
"Should return default value when env var is invalid"
);
// Cleanup
env::remove_var(&env_var);
}
#[test]
#[serial]
fn test_returns_default_when_env_empty() {
let worker_name = "empty_worker";
let env_var = format!(
"BACKGROUND_WORKER_{}_CONCURRENCY",
worker_name.to_uppercase()
);
// Set env var to empty string
env::set_var(&env_var, "");
let default_value = 15;
let result = ServerConfig::get_worker_concurrency(worker_name, default_value);
assert_eq!(
result, default_value,
"Should return default value when env var is empty"
);