api_huggingface 0.4.1

HuggingFace's API for accessing large language models (LLMs) and embeddings.
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
//! Integration tests for performance metrics

#![ allow( clippy::float_cmp ) ]
#![ allow( clippy::manual_range_contains ) ]
#![ allow( clippy::std_instead_of_core ) ]

use api_huggingface::performance::{ PerformanceMetrics, MetricsConfig };
use core::time::Duration;
use tokio::time::sleep;

#[ tokio::test ]
async fn test_basic_request_recording()
{
  let metrics = PerformanceMetrics::new( MetricsConfig::default() );

  metrics.record_request( Duration::from_millis( 100 ), true, 1024 ).await;
  metrics.record_request( Duration::from_millis( 200 ), true, 2048 ).await;

  let snapshot = metrics.snapshot().await;
  assert_eq!( snapshot.total_requests, 2 );
  assert_eq!( snapshot.successful_requests, 2 );
  assert_eq!( snapshot.failed_requests, 0 );
  assert_eq!( snapshot.total_bytes, 3072 );
}

#[ tokio::test ]
async fn test_error_tracking()
{
  let metrics = PerformanceMetrics::new( MetricsConfig::default() );

  metrics.record_request( Duration::from_millis( 100 ), true, 100 ).await;
  metrics.record_request( Duration::from_millis( 100 ), false, 0 ).await;
  metrics.record_request( Duration::from_millis( 100 ), false, 0 ).await;

  let snapshot = metrics.snapshot().await;
  assert_eq!( snapshot.total_requests, 3 );
  assert_eq!( snapshot.successful_requests, 1 );
  assert_eq!( snapshot.failed_requests, 2 );
  assert!( ( snapshot.error_rate() - 0.666 ).abs() < 0.01 );
  assert!( ( snapshot.success_rate() - 0.333 ).abs() < 0.01 );
}

#[ tokio::test ]
async fn test_latency_min_max()
{
  let metrics = PerformanceMetrics::new( MetricsConfig::default() );

  metrics.record_request( Duration::from_millis( 50 ), true, 0 ).await;
  metrics.record_request( Duration::from_millis( 300 ), true, 0 ).await;
  metrics.record_request( Duration::from_millis( 150 ), true, 0 ).await;

  let snapshot = metrics.snapshot().await;
  assert_eq!( snapshot.min_latency(), Duration::from_millis( 50 ) );
  assert_eq!( snapshot.max_latency(), Duration::from_millis( 300 ) );
}

#[ tokio::test ]
async fn test_latency_mean()
{
  let metrics = PerformanceMetrics::new( MetricsConfig::default() );

  metrics.record_request( Duration::from_millis( 100 ), true, 0 ).await;
  metrics.record_request( Duration::from_millis( 200 ), true, 0 ).await;
  metrics.record_request( Duration::from_millis( 300 ), true, 0 ).await;

  let snapshot = metrics.snapshot().await;
  assert_eq!( snapshot.mean_latency(), Duration::from_millis( 200 ) );
}

#[ tokio::test ]
async fn test_latency_median()
{
  let metrics = PerformanceMetrics::new( MetricsConfig::default() );

  metrics.record_request( Duration::from_millis( 100 ), true, 0 ).await;
  metrics.record_request( Duration::from_millis( 200 ), true, 0 ).await;
  metrics.record_request( Duration::from_millis( 300 ), true, 0 ).await;
  metrics.record_request( Duration::from_millis( 400 ), true, 0 ).await;
  metrics.record_request( Duration::from_millis( 500 ), true, 0 ).await;

  let snapshot = metrics.snapshot().await;
  assert_eq!( snapshot.median_latency(), Duration::from_millis( 300 ) );
}

#[ tokio::test ]
async fn test_percentile_p95()
{
  let metrics = PerformanceMetrics::new( MetricsConfig::default() );

  // Add 100 measurements from 1ms to 100ms
  for i in 1..=100
  {
  metrics.record_request( Duration::from_millis( i ), true, 0 ).await;
  }

  let snapshot = metrics.snapshot().await;

  // p95 should be around 95ms
  let p95_ms = snapshot.p95_latency().as_millis();
  assert!( p95_ms >= 90 && p95_ms <= 100 );
}

#[ tokio::test ]
async fn test_percentile_p99()
{
  let metrics = PerformanceMetrics::new( MetricsConfig::default() );

  // Add 100 measurements from 1ms to 100ms
  for i in 1..=100
  {
  metrics.record_request( Duration::from_millis( i ), true, 0 ).await;
  }

  let snapshot = metrics.snapshot().await;

  // p99 should be around 99ms
  let p99_ms = snapshot.p99_latency().as_millis();
  assert!( p99_ms >= 95 && p99_ms <= 100 );
}

#[ tokio::test ]
async fn test_requests_per_second()
{
  let metrics = PerformanceMetrics::new( MetricsConfig::default() );

  // Record 10 requests
  for _ in 0..10
  {
  metrics.record_request( Duration::from_millis( 10 ), true, 100 ).await;
  }

  // Wait a bit to ensure duration > 0
  sleep( Duration::from_millis( 20 ) ).await;

  let snapshot = metrics.snapshot().await;
  let rps = snapshot.requests_per_second();

  // Should have some positive RPS
  assert!( rps > 0.0 );
  // Should be less than 1000 RPS (since we only did 10 requests)
  assert!( rps < 1000.0 );
}

#[ tokio::test ]
async fn test_bytes_per_second()
{
  let metrics = PerformanceMetrics::new( MetricsConfig::default() );

  // Record requests with different byte counts
  for i in 1..=10
  {
  metrics.record_request( Duration::from_millis( 10 ), true, i * 1024 ).await;
  }

  // Wait to ensure duration > 0
  sleep( Duration::from_millis( 20 ) ).await;

  let snapshot = metrics.snapshot().await;
  let bps = snapshot.bytes_per_second();

  // Should have some positive bytes/sec
  assert!( bps > 0.0 );
  // Total bytes = 1024 + 2048 + ... + 10240 = 56320
  assert_eq!( snapshot.total_bytes, 56320 );
}

#[ tokio::test ]
async fn test_window_snapshot()
{
  let config = MetricsConfig
  {
  max_samples : 10000,
  window_duration : Duration::from_secs( 60 ),
  };
  let metrics = PerformanceMetrics::new( config );

  // Add a request
  metrics.record_request( Duration::from_millis( 100 ), true, 1024 ).await;

  // Wait 100ms
  sleep( Duration::from_millis( 100 ) ).await;

  // Add another request
  metrics.record_request( Duration::from_millis( 200 ), true, 2048 ).await;

  // Get snapshot of last 150ms (should include both)
  let snapshot = metrics.snapshot_window( Duration::from_millis( 150 ) ).await;
  assert_eq!( snapshot.total_requests, 2 );

  // Get snapshot of last 50ms (should include only second)
  let snapshot = metrics.snapshot_window( Duration::from_millis( 50 ) ).await;
  assert_eq!( snapshot.total_requests, 1 );
}

#[ tokio::test ]
async fn test_cleanup_old_measurements()
{
  let config = MetricsConfig
  {
  max_samples : 10,
  window_duration : Duration::from_millis( 50 ),
  };
  let metrics = PerformanceMetrics::new( config );

  // Add some measurements
  for _ in 0..5
  {
  metrics.record_request( Duration::from_millis( 10 ), true, 100 ).await;
  }

  assert_eq!( metrics.measurement_count().await, 5 );

  // Wait for measurements to become old
  sleep( Duration::from_millis( 100 ) ).await;

  // Cleanup should remove old measurements
  let removed = metrics.cleanup().await;
  assert_eq!( removed, 5 );
  assert_eq!( metrics.measurement_count().await, 0 );
}

#[ tokio::test ]
async fn test_max_samples_limit()
{
  let config = MetricsConfig
  {
  max_samples : 5,
  window_duration : Duration::from_secs( 60 ),
  };
  let metrics = PerformanceMetrics::new( config );

  // Add more than max_samples
  for _ in 0..10
  {
  metrics.record_request( Duration::from_millis( 10 ), true, 100 ).await;
  }

  // Trigger cleanup
  let _ = metrics.cleanup().await;

  // Should be limited to max_samples
  assert!( metrics.measurement_count().await <= 5 );
}

#[ tokio::test ]
async fn test_reset_metrics()
{
  let metrics = PerformanceMetrics::new( MetricsConfig::default() );

  // Add some measurements
  metrics.record_request( Duration::from_millis( 100 ), true, 1024 ).await;
  metrics.record_request( Duration::from_millis( 200 ), false, 2048 ).await;

  assert_eq!( metrics.measurement_count().await, 2 );

  // Reset
  metrics.reset().await;

  assert_eq!( metrics.measurement_count().await, 0 );

  let snapshot = metrics.snapshot().await;
  assert_eq!( snapshot.total_requests, 0 );
  assert_eq!( snapshot.total_bytes, 0 );
}

#[ tokio::test ]
async fn test_empty_metrics()
{
  let metrics = PerformanceMetrics::new( MetricsConfig::default() );

  let snapshot = metrics.snapshot().await;
  assert_eq!( snapshot.total_requests, 0 );
  assert_eq!( snapshot.successful_requests, 0 );
  assert_eq!( snapshot.failed_requests, 0 );
  assert_eq!( snapshot.total_bytes, 0 );
  assert_eq!( snapshot.error_rate(), 0.0 );
  assert_eq!( snapshot.success_rate(), 0.0 );
  assert_eq!( snapshot.requests_per_second(), 0.0 );
  assert_eq!( snapshot.bytes_per_second(), 0.0 );
}

#[ tokio::test ]
async fn test_single_request()
{
  let metrics = PerformanceMetrics::new( MetricsConfig::default() );

  metrics.record_request( Duration::from_millis( 100 ), true, 1024 ).await;

  let snapshot = metrics.snapshot().await;
  assert_eq!( snapshot.total_requests, 1 );
  assert_eq!( snapshot.successful_requests, 1 );
  assert_eq!( snapshot.error_rate(), 0.0 );
  assert_eq!( snapshot.success_rate(), 1.0 );
  assert_eq!( snapshot.min_latency(), Duration::from_millis( 100 ) );
  assert_eq!( snapshot.max_latency(), Duration::from_millis( 100 ) );
  assert_eq!( snapshot.mean_latency(), Duration::from_millis( 100 ) );
}

#[ tokio::test ]
async fn test_concurrent_recording()
{
  let metrics = PerformanceMetrics::new( MetricsConfig::default() );

  // Spawn multiple tasks recording concurrently
  let mut handles = vec![];

  for i in 0..10
  {
  let m = metrics.clone();
  let handle = tokio::spawn( async move
  {
      for _ in 0..10
      {
  m.record_request( Duration::from_millis( i * 10 ), true, 100 ).await;
      }
  } );
  handles.push( handle );
  }

  // Wait for all tasks
  for handle in handles
  {
  handle.await.expect( "[test_concurrent_request_tracking] Tokio task should complete successfully - check tokio::spawn() and concurrent access patterns" );
  }

  let snapshot = metrics.snapshot().await;
  assert_eq!( snapshot.total_requests, 100 );
  assert_eq!( snapshot.successful_requests, 100 );
}

#[ tokio::test ]
async fn test_large_dataset()
{
  let metrics = PerformanceMetrics::new( MetricsConfig::default() );

  // Record 1000 requests
  for i in 1..=1000
  {
  let latency = Duration::from_millis( i % 500 );
  let success = i % 10 != 0; // 10% failure rate
  metrics.record_request( latency, success, 100 ).await;
  }

  let snapshot = metrics.snapshot().await;
  assert_eq!( snapshot.total_requests, 1000 );
  assert_eq!( snapshot.successful_requests, 900 );
  assert_eq!( snapshot.failed_requests, 100 );
  assert!( ( snapshot.error_rate() - 0.1 ).abs() < 0.01 );
}

#[ tokio::test ]
async fn test_extreme_latencies()
{
  let metrics = PerformanceMetrics::new( MetricsConfig::default() );

  // Very fast request
  metrics.record_request( Duration::from_micros( 1 ), true, 10 ).await;

  // Very slow request
  metrics.record_request( Duration::from_secs( 10 ), true, 10000 ).await;

  let snapshot = metrics.snapshot().await;
  assert_eq!( snapshot.min_latency(), Duration::from_micros( 1 ) );
  assert_eq!( snapshot.max_latency(), Duration::from_secs( 10 ) );
}

#[ tokio::test ]
async fn test_zero_duration_edge_case()
{
  let metrics = PerformanceMetrics::new( MetricsConfig::default() );

  metrics.record_request( Duration::ZERO, true, 100 ).await;

  let snapshot = metrics.snapshot().await;
  assert_eq!( snapshot.min_latency(), Duration::ZERO );
  assert_eq!( snapshot.mean_latency(), Duration::ZERO );
}

#[ tokio::test ]
async fn test_all_failed_requests()
{
  let metrics = PerformanceMetrics::new( MetricsConfig::default() );

  for _ in 0..10
  {
  metrics.record_request( Duration::from_millis( 100 ), false, 0 ).await;
  }

  let snapshot = metrics.snapshot().await;
  assert_eq!( snapshot.successful_requests, 0 );
  assert_eq!( snapshot.failed_requests, 10 );
  assert_eq!( snapshot.error_rate(), 1.0 );
  assert_eq!( snapshot.success_rate(), 0.0 );
}

#[ tokio::test ]
async fn test_config_retrieval()
{
  let config = MetricsConfig
  {
  max_samples : 1234,
  window_duration : Duration::from_secs( 42 ),
  };
  let metrics = PerformanceMetrics::new( config );

  let retrieved = metrics.config().await;
  assert_eq!( retrieved.max_samples, 1234 );
  assert_eq!( retrieved.window_duration, Duration::from_secs( 42 ) );
}

#[ tokio::test ]
async fn test_snapshot_timing()
{
  let metrics = PerformanceMetrics::new( MetricsConfig::default() );

  metrics.record_request( Duration::from_millis( 100 ), true, 100 ).await;

  let snapshot1 = metrics.snapshot().await;
  sleep( Duration::from_millis( 50 ) ).await;
  let snapshot2 = metrics.snapshot().await;

  // Duration should increase between snapshots
  assert!( snapshot2.duration >= snapshot1.duration );
}