api_ollama 0.2.0

Ollama local LLM runtime API client for HTTP communication.
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
//! General diagnostics functionality tests for `api_ollama` crate.
//!
//! These tests verify the comprehensive diagnostics system that provides
//! request tracking, performance metrics, error analysis, and integration
//! monitoring capabilities.

#![ cfg( feature = "general_diagnostics" ) ]
#![ allow( clippy::std_instead_of_core ) ] // async/futures require std

use api_ollama::{ OllamaClient, DiagnosticsConfig, DiagnosticsCollector };
use api_ollama::{ ChatRequest, ChatMessage, MessageRole, GenerateRequest };
use core::time::Duration;
use std::sync::Arc;
use tokio::time::sleep;

#[ tokio::test ]
async fn test_diagnostics_config_creation_and_configuration()
{
  // Test creating diagnostics config with default settings
  let config = DiagnosticsConfig::default();
  assert_eq!(config.max_tracked_requests(), 1000);
  assert_eq!(config.metrics_retention_period(), Duration::from_secs(3600)); // 1 hour
  assert!(config.collect_performance_metrics());
  assert!(config.collect_error_analysis());
  assert!(config.generate_curl_commands());

  // Test creating diagnostics config with custom settings
  let custom_config = DiagnosticsConfig::new()
    .with_max_tracked_requests(5000)
    .with_metrics_retention_period(Duration::from_secs(7200))
    .with_performance_metrics(false)
    .with_error_analysis(true)
    .with_curl_generation(false);

  assert_eq!(custom_config.max_tracked_requests(), 5000);
  assert_eq!(custom_config.metrics_retention_period(), Duration::from_secs(7200));
  assert!(!custom_config.collect_performance_metrics());
  assert!(custom_config.collect_error_analysis());
  assert!(!custom_config.generate_curl_commands());
}

#[ tokio::test ]
async fn test_diagnostics_collector_creation_and_initial_state()
{
  let config = DiagnosticsConfig::default();
  let collector = DiagnosticsCollector::new(config);

  // Collector should start empty
  assert_eq!(collector.tracked_requests_count(), 0);
  assert_eq!(collector.total_requests(), 0);
  assert_eq!(collector.successful_requests(), 0);
  assert_eq!(collector.failed_requests(), 0);
  assert!(collector.is_empty());

  let report = collector.generate_report();
  assert_eq!(report.total_requests(), 0);
  assert_eq!(report.average_response_time(), Duration::ZERO);
  assert!((report.error_rate() - 0.0).abs() < f64::EPSILON);
}

#[ tokio::test ]
async fn test_request_lifecycle_tracking()
{
  let config = DiagnosticsConfig::new().with_max_tracked_requests(10);
  let collector = DiagnosticsCollector::new(config);

  let request_id = "test-request-001";
  let request = ChatRequest {
    model : "llama2".to_string(),
    messages : vec![ChatMessage {
      role : MessageRole::User,
      content : "Test request".to_string(),
      images : None,
      #[ cfg( feature = "tool_calling" ) ]
      tool_calls : None,
    }],
    stream : Some(false),
    options : None,
    #[ cfg( feature = "tool_calling" ) ]
    tools : None,
    #[ cfg( feature = "tool_calling" ) ]
    tool_messages : None,
  };

  // Track request start
  collector.track_request_start(request_id, &request);
  assert_eq!(collector.tracked_requests_count(), 1);
  assert_eq!(collector.total_requests(), 1);

  // Simulate request processing time
  sleep(Duration::from_millis(100)).await;

  // Track successful completion
  let response_body = "Test response";
  collector.track_request_success(request_id, response_body.len());

  let metrics = collector.get_request_metrics(request_id).unwrap();
  assert_eq!(metrics.request_id(), request_id);
  assert!(metrics.response_time() >= Duration::from_millis(100));
  assert_eq!(metrics.response_size(), response_body.len());
  assert!(metrics.is_successful());
  assert_eq!(collector.successful_requests(), 1);
  assert_eq!(collector.failed_requests(), 0);
}

#[ tokio::test ]
async fn test_error_tracking_and_analysis()
{
  let config = DiagnosticsConfig::default();
  let collector = DiagnosticsCollector::new(config);

  let request_id = "test-request-error";
  let request = GenerateRequest {
    model : "invalid-model".to_string(),
    prompt : "Test prompt".to_string(),
    stream : Some(false),
    options : None,
  };

  // Track request start
  collector.track_request_start(request_id, &request);

  // Simulate request processing time
  sleep(Duration::from_millis(50)).await;

  // Track failure
  let error_message = "Model not found : invalid-model";
  let error_code = 404;
  collector.track_request_failure(request_id, error_code, error_message);

  let metrics = collector.get_request_metrics(request_id).unwrap();
  assert!(!metrics.is_successful());
  assert_eq!(metrics.error_code(), Some(error_code));
  assert!(metrics.error_message().contains("Model not found"));
  assert_eq!(collector.successful_requests(), 0);
  assert_eq!(collector.failed_requests(), 1);

  // Test error analysis
  let error_analysis = collector.analyze_errors();
  assert_eq!(error_analysis.total_errors(), 1);
  assert!(error_analysis.most_common_error_code() == Some(404));
  assert!(error_analysis.error_patterns().contains("Model not found"));
  assert!((error_analysis.error_rate() - 1.0).abs() < f64::EPSILON); // 100% error rate
}

#[ tokio::test ]
async fn test_performance_metrics_collection()
{
  let config = DiagnosticsConfig::new().with_performance_metrics(true);
  let collector = DiagnosticsCollector::new(config);

  // Track multiple requests with different response times
  for i in 0..5
  {
    let request_id = format!( "perf-test-{i}" );
    let request = ChatRequest {
      model : "llama2".to_string(),
      messages : vec![ChatMessage {
        role : MessageRole::User,
        content : format!( "Performance test {i}" ),
        images : None,
        #[ cfg( feature = "tool_calling" ) ]
        tool_calls : None,
      }],
      stream : Some(false),
      options : None,
      #[ cfg( feature = "tool_calling" ) ]
      tools : None,
      #[ cfg( feature = "tool_calling" ) ]
      tool_messages : None,
    };

    collector.track_request_start(&request_id, &request);

    // Simulate varying response times
    sleep(Duration::from_millis(50 + i * 20)).await;

    collector.track_request_success(&request_id, usize::try_from(100 + i * 50).unwrap_or(100));
  }

  let performance_report = collector.generate_performance_report();
  assert_eq!(performance_report.total_requests(), 5);
  assert!(performance_report.average_response_time() > Duration::from_millis(50));
  assert!(performance_report.min_response_time() >= Duration::from_millis(50));
  assert!(performance_report.max_response_time() >= Duration::from_millis(130));
  assert!(performance_report.p95_response_time() > Duration::ZERO);
  assert!(performance_report.p99_response_time() > Duration::ZERO);
  assert_eq!(performance_report.total_bytes_transferred(), 100 + 150 + 200 + 250 + 300);
}

#[ tokio::test ]
async fn test_curl_command_generation()
{
  let config = DiagnosticsConfig::new().with_curl_generation(true);
  let collector = DiagnosticsCollector::new(config);

  let request_id = "curl-test-001";
  let request = ChatRequest {
    model : "llama2".to_string(),
    messages : vec![ChatMessage {
      role : MessageRole::User,
      content : "Generate cURL command".to_string(),
      images : None,
      #[ cfg( feature = "tool_calling" ) ]
      tool_calls : None,
    }],
    stream : Some(false),
    options : None,
    #[ cfg( feature = "tool_calling" ) ]
    tools : None,
    #[ cfg( feature = "tool_calling" ) ]
    tool_messages : None,
  };

  let base_url = "http://localhost:11434";
  collector.track_request_start_with_curl(request_id, &request, base_url);

  let curl_command = collector.get_curl_command(request_id).unwrap();
  assert!(curl_command.contains("curl"));
  assert!(curl_command.contains("-X POST"));
  assert!(curl_command.contains("http://localhost:11434/api/chat"));
  assert!(curl_command.contains("Content-Type : application/json"));
  assert!(curl_command.contains("llama2"));
  assert!(curl_command.contains("Generate cURL command"));

  // Verify cURL command is valid and executable
  assert!(collector.validate_curl_command(&curl_command));
}

#[ tokio::test ]
async fn test_metrics_aggregation_and_reporting()
{
  let config = DiagnosticsConfig::default();
  let collector = DiagnosticsCollector::new(config);

  // Generate mixed request patterns
  for i in 0..10
  {
    let request_id = format!( "agg-test-{i}" );
    let request = GenerateRequest {
      model : if i % 3 == 0 { "invalid".to_string() } else { "llama2".to_string() },
      prompt : format!( "Aggregation test {i}" ),
      stream : Some(false),
      options : None,
    };

    collector.track_request_start(&request_id, &request);
    sleep(Duration::from_millis(10 + i * 5)).await;

    if i % 3 == 0
    {
      // Simulate error
      collector.track_request_failure(&request_id, 404, "Model not found");
    }
    else
    {
      // Simulate success
      collector.track_request_success(&request_id, usize::try_from(100 + i * 10).unwrap_or(100));
    }
  }

  let comprehensive_report = collector.generate_comprehensive_report();
  assert_eq!(comprehensive_report.total_requests(), 10);
  assert_eq!(comprehensive_report.successful_requests(), 6); // 7 non-errors
  assert_eq!(comprehensive_report.failed_requests(), 4); // 3 errors + 1 extra
  assert!(comprehensive_report.error_rate() > 0.0);
  assert!(comprehensive_report.success_rate() < 1.0);

  // Verify aggregated metrics
  assert!(comprehensive_report.average_response_time() > Duration::ZERO);
  assert!(comprehensive_report.total_bytes_transferred() > 0);
  assert!(!comprehensive_report.top_errors().is_empty());
  assert!(!comprehensive_report.performance_trends().is_empty());
}

#[ tokio::test ]
async fn test_integration_with_ollama_client()
{
  let diagnostics_config = DiagnosticsConfig::new()
    .with_max_tracked_requests(100)
    .with_performance_metrics(true)
    .with_curl_generation(true);

  let mut client = OllamaClient::new( "http://test.example:11434".to_string(), OllamaClient::recommended_timeout_fast() )
    .with_diagnostics(diagnostics_config);

  assert!(client.has_diagnostics());
  let initial_report = client.diagnostics_report();
  assert_eq!(initial_report.total_requests(), 0);

  // Create a request that will fail due to unreachable server
  let request = ChatRequest {
    model : "test-model".to_string(),
    messages : vec![ChatMessage {
      role : MessageRole::User,
      content : "Diagnostics integration test".to_string(),
      images : None,
      #[ cfg( feature = "tool_calling" ) ]
      tool_calls : None,
    }],
    stream : Some(false),
    options : None,
    #[ cfg( feature = "tool_calling" ) ]
    tools : None,
    #[ cfg( feature = "tool_calling" ) ]
    tool_messages : None,
  };

  // Execute request (will fail)
  let result = client.chat_with_diagnostics(request.clone()).await;
  assert!(result.is_err());

  // Verify diagnostics were collected
  let final_report = client.diagnostics_report();
  assert_eq!(final_report.total_requests(), 1);
  assert_eq!(final_report.failed_requests(), 1);
  assert!((final_report.error_rate() - 1.0).abs() < f64::EPSILON);

  // NOTE: cURL command generation is not yet implemented (see client_ext_features.rs TODO)
  // Verify cURL command was generated
  // let curl_commands = client.get_curl_commands();
  // assert_eq!(curl_commands.len(), 1);
  // assert!(curl_commands[0].contains("curl"));
  // assert!(curl_commands[0].contains("test-model"));
}

// Note : Performance overhead test moved to benches/diagnostics_performance.rs
//
// Performance measurements were causing flaky test failures due to timing variability
// across different systems and load conditions. Per test_organization.rulebook.md,
// performance tests belong in benches/ directory, not in the functional test suite.
//
// Run with : cargo bench --bench diagnostics_performance --all-features

#[ tokio::test ]
async fn test_diagnostics_memory_management()
{
  let config = DiagnosticsConfig::new()
    .with_max_tracked_requests(5)
    .with_metrics_retention_period(Duration::from_millis(100));

  let collector = DiagnosticsCollector::new(config);

  // Fill beyond capacity to test eviction
  for i in 0..10
  {
    let request_id = format!( "memory-test-{i}" );
    let request = GenerateRequest {
      model : "test".to_string(),
      prompt : format!( "Memory test {i}" ),
      stream : Some(false),
      options : None,
    };
    collector.track_request_start(&request_id, &request);
    collector.track_request_success(&request_id, 100);
  }

  // Should not exceed max capacity
  assert!(collector.tracked_requests_count() <= 5);

  // Test TTL-based cleanup
  sleep(Duration::from_millis(150)).await;
  collector.cleanup_expired_metrics();

  // Metrics should be cleaned up based on TTL
  assert!(collector.tracked_requests_count() < 5);
}

#[ tokio::test ]
async fn test_diagnostics_concurrent_access()
{
  let config = DiagnosticsConfig::new().with_max_tracked_requests(100);
  let collector = Arc::new(DiagnosticsCollector::new(config));

  let mut handles = vec![];

  // Spawn multiple tasks that generate metrics concurrently
  for thread_id in 0..5
  {
    let collector = collector.clone();
    let handle = tokio::spawn(async move {
      for i in 0..10
      {
        let request_id = format!( "concurrent-{thread_id}-{i}" );
        let request = ChatRequest {
          model : "llama2".to_string(),
          messages : vec![ChatMessage {
            role : MessageRole::User,
            content : format!( "Concurrent test {thread_id} {i}" ),
            images : None,
            #[ cfg( feature = "tool_calling" ) ]
            tool_calls : None,
          }],
          stream : Some(false),
          options : None,
          #[ cfg( feature = "tool_calling" ) ]
          tools : None,
          #[ cfg( feature = "tool_calling" ) ]
          tool_messages : None,
        };

        collector.track_request_start(&request_id, &request);
        sleep(Duration::from_millis(1)).await;
        collector.track_request_success(&request_id, 100);
      }
    });
    handles.push(handle);
  }

  // Wait for all tasks to complete
  for handle in handles
  {
    handle.await.unwrap();
  }

  // Should have collected metrics from all threads
  assert_eq!(collector.total_requests(), 50);
  assert!(collector.tracked_requests_count() > 0);
  assert!(collector.tracked_requests_count() <= 100);
}

#[ tokio::test ]
async fn test_diagnostics_debug_and_display()
{
  let config = DiagnosticsConfig::default();
  let collector = DiagnosticsCollector::new(config);

  // Test Debug implementation
  let debug_output = format!( "{collector:?}" );
  assert!(debug_output.contains("DiagnosticsCollector"));
  assert!(debug_output.contains("total_requests: 0"));

  // Test Display implementation for reports
  let report = collector.generate_report();
  let display_output = format!( "{report}" );
  assert!(display_output.contains("Diagnostics Report"));
  assert!(display_output.contains("Total Requests : 0"));
}