wtx 0.28.0

A collection of different transport implementations and related tools focused primarily on web technologies.
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

use crate::{
  client_api_framework::misc::RequestLimit,
  misc::{GenericTime, sleep},
};
use core::time::Duration;

/// Tracks how many requests were performed in a time interval
#[derive(Clone, Copy, Debug)]
pub struct RequestCounter {
  counter: u16,
  instant: GenericTime,
}

impl RequestCounter {
  /// Instance with valid initial values
  #[inline]
  pub fn new() -> Self {
    Self { counter: 0, instant: GenericTime::now() }
  }

  /// How many requests within the current time-slot are still available for usage.
  #[inline]
  pub fn remaining_requests(&self, rl: &RequestLimit) -> u16 {
    rl.limit().wrapping_sub(self.counter)
  }

  /// If the values defined in [RequestLimit] are in agreement with the `current` values
  /// of [RequestCounter], then return `T`. Otherwise, awaits until [RequestCounter] is updated.
  #[inline]
  pub async fn update_params(&mut self, rl: &RequestLimit) -> crate::Result<()> {
    let now = GenericTime::now();
    let duration = *rl.duration();
    let elapsed = now.duration_since(self.instant)?;
    if elapsed > duration {
      _debug!("Elapsed is greater than duration. Re-initializing");
      self.counter = 1;
      self.instant = now;
    } else if self.counter == 0 {
      _debug!("First instance call");
      self.counter = 2;
    } else if self.counter > rl.limit() {
      _debug!("Counter exceeded its limit within max duration");
      self.manage_sleep(elapsed, duration).await?;
      self.counter = 1;
    } else if self.counter == 1 {
      _debug!("First recurrent call");
      self.manage_sleep(elapsed, duration).await?;
      self.counter = self.counter.wrapping_add(1);
    } else if self.counter == rl.limit() {
      _debug!("Counter equals its limit within max duration");
      self.counter = 1;
    } else {
      self.counter = self.counter.wrapping_add(1);
    }
    Ok(())
  }

  async fn manage_sleep(&mut self, elapsed: Duration, duration: Duration) -> crate::Result<()> {
    if let Some(diff) = duration.checked_sub(elapsed) {
      _debug!("Call needs to wait {}ms", diff.as_millis());
      sleep(diff).await?;
      self.instant = GenericTime::now();
    }
    Ok(())
  }
}

impl Default for RequestCounter {
  #[inline]
  fn default() -> Self {
    Self::new()
  }
}

#[cfg(all(feature = "_async-tests", test))]
mod tests {
  use crate::client_api_framework::misc::{RequestCounter, RequestLimit};
  use core::time::Duration;
  use std::time::Instant;
  use tokio::time::sleep;

  // Minus 1ms because awaiting is `duration - elapsed` instead of `duration`
  #[tokio::test]
  async fn awaits_when_called_with_counter_reinitialized() {
    const DURATION: Duration = Duration::from_millis(1000);

    let rl = RequestLimit::new(2, DURATION);
    let mut rc = RequestCounter::new();

    async fn test(first_ms: Duration, rc: &mut RequestCounter, rl: &RequestLimit) {
      let first = Instant::now();
      rc.update_params(rl).await.unwrap();
      assert!(first.elapsed() >= first_ms);

      let second = Instant::now();
      rc.update_params(rl).await.unwrap();
      assert!(second.elapsed() <= Duration::from_millis(2));
    }

    test(Duration::from_millis(0), &mut rc, &rl).await;
    test(DURATION - Duration::from_millis(1), &mut rc, &rl).await;
    test(DURATION - Duration::from_millis(1), &mut rc, &rl).await;
    test(DURATION - Duration::from_millis(1), &mut rc, &rl).await;
    test(DURATION - Duration::from_millis(1), &mut rc, &rl).await;
  }

  #[tokio::test]
  async fn counter_is_reinitialized_when_time_expires() {
    let rl = RequestLimit::new(10, Duration::from_millis(1000));
    let mut rc = RequestCounter::new();
    assert_eq!(rc.counter, 0);
    rc.update_params(&rl).await.unwrap();
    assert_eq!(rc.counter, 2);
    rc.update_params(&rl).await.unwrap();
    assert_eq!(rc.counter, 3);
    rc.update_params(&rl).await.unwrap();
    sleep(Duration::from_millis(1110)).await;
    rc.update_params(&rl).await.unwrap();
    assert_eq!(rc.counter, 1);
  }

  #[tokio::test]
  async fn does_not_awaits_when_idle_is_greater_than_duration() {
    let rl = RequestLimit::new(2, Duration::from_millis(50));
    let mut rc = RequestCounter::new();

    async fn test(rc: &mut RequestCounter, rl: &RequestLimit) {
      let now = Instant::now();
      rc.update_params(rl).await.unwrap();
      assert!(now.elapsed() <= Duration::from_millis(2));
    }

    test(&mut rc, &rl).await;
    sleep(Duration::from_millis(200)).await;
    test(&mut rc, &rl).await;
    sleep(Duration::from_millis(200)).await;
    test(&mut rc, &rl).await;
    sleep(Duration::from_millis(200)).await;
    test(&mut rc, &rl).await;
    sleep(Duration::from_millis(200)).await;
    test(&mut rc, &rl).await;
    sleep(Duration::from_millis(200)).await;
    test(&mut rc, &rl).await;
    sleep(Duration::from_millis(200)).await;
    test(&mut rc, &rl).await;
    sleep(Duration::from_millis(200)).await;
  }

  #[tokio::test]
  async fn has_correct_counter_increment() {
    let rl = RequestLimit::new(2, Duration::from_millis(100));
    let mut rc = RequestCounter::new();
    assert_eq!(rc.counter, 0);
    rc.update_params(&rl).await.unwrap();
    assert_eq!(rc.counter, 2);
    rc.update_params(&rl).await.unwrap();
    assert_eq!(rc.counter, 1);
    rc.update_params(&rl).await.unwrap();
    assert_eq!(rc.counter, 2);
    rc.update_params(&rl).await.unwrap();
    assert_eq!(rc.counter, 1);
    rc.update_params(&rl).await.unwrap();
    assert_eq!(rc.counter, 2);
    rc.update_params(&rl).await.unwrap();
    assert_eq!(rc.counter, 1);
    rc.update_params(&rl).await.unwrap();
    assert_eq!(rc.counter, 2);
    rc.update_params(&rl).await.unwrap();
    assert_eq!(rc.counter, 1);
  }

  #[tokio::test]
  async fn one_value_limit_has_correct_behavior() {
    async fn test(rc: &mut RequestCounter, rl: &RequestLimit, duration: Duration) {
      let now = Instant::now();
      rc.update_params(rl).await.unwrap();
      assert!(now.elapsed() >= duration);
    }

    let _100 = Duration::from_millis(100);
    let rl = RequestLimit::new(1, _100);
    let mut rc = RequestCounter::new();
    assert_eq!(rc.counter, 0);
    test(&mut rc, &rl, Duration::default()).await;
    assert_eq!(rc.counter, 2);
    test(&mut rc, &rl, _100 - Duration::from_millis(1)).await;
    assert_eq!(rc.counter, 1);
    test(&mut rc, &rl, Duration::default()).await;
    assert_eq!(rc.counter, 2);
    test(&mut rc, &rl, _100 - Duration::from_millis(1)).await;
    assert_eq!(rc.counter, 1);
    test(&mut rc, &rl, Duration::default()).await;
    assert_eq!(rc.counter, 2);
    test(&mut rc, &rl, _100 - Duration::from_millis(1)).await;
    assert_eq!(rc.counter, 1);
    test(&mut rc, &rl, Duration::default()).await;
    assert_eq!(rc.counter, 2);
    test(&mut rc, &rl, _100 - Duration::from_millis(1)).await;
    assert_eq!(rc.counter, 1);
  }
}