force 0.2.0

Production-ready Salesforce Platform API client with REST and Bulk API 2.0 support
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
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
//! Integration tests for HTTP middleware using wiremock.

#[cfg(test)]
mod integration_tests {
    use crate::auth::{AccessToken, TokenResponse};
    use crate::error::ForceError;
    use crate::http::{
        HttpExecutor, RequestErrorKind, RequestRetryClass, RetryEvent, RetryPolicy, TelemetryHooks,
    };
    use crate::test_support::Must;
    use std::sync::Arc;
    use std::sync::Mutex;
    use std::sync::atomic::{AtomicU32, Ordering};
    use wiremock::matchers::{header, method, path};
    use wiremock::{Mock, MockServer, ResponseTemplate};

    #[derive(serde::Deserialize, Debug)]
    struct TestResponse {
        id: String,
        name: String,
    }

    #[derive(serde::Deserialize, Debug)]
    struct IdOnlyResponse {
        id: String,
    }

    fn create_test_token() -> AccessToken {
        let response = TokenResponse {
            access_token: "test_token_123".to_string(),
            instance_url: "https://test.salesforce.com".to_string(),
            token_type: "Bearer".to_string(),
            issued_at: "1640000000000".to_string(), // 2021-12-20
            signature: "test_signature".to_string(),
            expires_in: Some(7200), // 2 hours
            refresh_token: None,
        };
        AccessToken::from_response(response)
    }
    #[tokio::test]
    async fn test_successful_request_with_bearer_token() {
        // Arrange
        let mock_server = MockServer::start().await;
        let executor = HttpExecutor::new();
        let token = create_test_token();

        Mock::given(method("GET"))
            .and(path("/services/data/v60.0/sobjects"))
            .and(header("Authorization", "Bearer test_token_123"))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "sobjects": []
            })))
            .mount(&mock_server)
            .await;

        // Act
        let url = format!("{}/services/data/v60.0/sobjects", mock_server.uri());
        let request = reqwest::Client::new().get(&url).build().must();

        let result = executor
            .execute(request, &token, || async {
                panic!("Should not call refresh on success")
            })
            .await;

        // Assert
        let response = result.must();
        assert_eq!(response.status(), 200);
    }

    #[tokio::test]
    async fn test_401_triggers_token_refresh_and_retry() {
        // Arrange
        let mock_server = MockServer::start().await;
        let executor = HttpExecutor::new();
        let token = create_test_token();
        let refresh_count = Arc::new(AtomicU32::new(0));
        let refresh_count_clone = Arc::clone(&refresh_count);

        // First request returns 401
        Mock::given(method("GET"))
            .and(path("/test"))
            .and(header("Authorization", "Bearer test_token_123"))
            .respond_with(ResponseTemplate::new(401))
            .up_to_n_times(1)
            .mount(&mock_server)
            .await;

        // Second request (after refresh) returns 200
        Mock::given(method("GET"))
            .and(path("/test"))
            .and(header("Authorization", "Bearer new_token_456"))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "success": true
            })))
            .mount(&mock_server)
            .await;

        // Act
        let url = format!("{}/test", mock_server.uri());
        let request = reqwest::Client::new().get(&url).build().must();

        let result = executor
            .execute(request, &token, || {
                let count = Arc::clone(&refresh_count_clone);
                async move {
                    count.fetch_add(1, Ordering::SeqCst);
                    let response = TokenResponse {
                        access_token: "new_token_456".to_string(),
                        instance_url: "https://test.salesforce.com".to_string(),
                        token_type: "Bearer".to_string(),
                        issued_at: "1640000000000".to_string(),
                        signature: "test_signature".to_string(),
                        expires_in: Some(7200),
                        refresh_token: None,
                    };
                    Ok(AccessToken::from_response(response))
                }
            })
            .await;

        // Assert
        let response = result.must();
        assert_eq!(response.status(), 200);
        assert_eq!(refresh_count.load(Ordering::SeqCst), 1);
    }

    #[tokio::test]
    async fn test_429_returns_rate_limit_error_with_retry_after() {
        // Arrange
        let mock_server = MockServer::start().await;
        let executor = HttpExecutor::new();
        let token = create_test_token();

        Mock::given(method("GET"))
            .and(path("/test"))
            .respond_with(
                ResponseTemplate::new(429)
                    .append_header("Retry-After", "120")
                    .set_body_string("Rate limit exceeded"),
            )
            .mount(&mock_server)
            .await;

        // Act
        let url = format!("{}/test", mock_server.uri());
        let request = reqwest::Client::new().get(&url).build().must();

        let result = executor
            .execute(request, &token, || async {
                panic!("Should not refresh on 429")
            })
            .await;

        // Assert
        match result {
            Err(ForceError::Http(crate::error::HttpError::RateLimitExceeded {
                retry_after_seconds,
            })) => {
                assert_eq!(retry_after_seconds, 120);
            }
            _ => panic!("Expected RateLimitExceeded error, got: {:?}", result),
        }
    }

    #[tokio::test]
    async fn test_429_defaults_to_60s_when_header_missing() {
        // Arrange
        let mock_server = MockServer::start().await;
        let executor = HttpExecutor::new();
        let token = create_test_token();

        Mock::given(method("GET"))
            .and(path("/test"))
            .respond_with(ResponseTemplate::new(429).set_body_string("Rate limit exceeded"))
            .mount(&mock_server)
            .await;

        // Act
        let url = format!("{}/test", mock_server.uri());
        let request = reqwest::Client::new().get(&url).build().must();

        let result = executor
            .execute(request, &token, || async {
                panic!("Should not refresh on 429")
            })
            .await;

        // Assert
        match result {
            Err(ForceError::Http(crate::error::HttpError::RateLimitExceeded {
                retry_after_seconds,
            })) => {
                assert_eq!(retry_after_seconds, 60);
            }
            _ => panic!(
                "Expected RateLimitExceeded error with default 60s, got: {:?}",
                result
            ),
        }
    }

    #[tokio::test]
    async fn test_429_defaults_to_60s_when_header_invalid() {
        // Arrange
        let mock_server = MockServer::start().await;
        let executor = HttpExecutor::new();
        let token = create_test_token();

        Mock::given(method("GET"))
            .and(path("/test"))
            .respond_with(
                ResponseTemplate::new(429)
                    .append_header("Retry-After", "soon")
                    .set_body_string("Rate limit exceeded"),
            )
            .mount(&mock_server)
            .await;

        // Act
        let url = format!("{}/test", mock_server.uri());
        let request = reqwest::Client::new().get(&url).build().must();

        let result = executor
            .execute(request, &token, || async {
                panic!("Should not refresh on 429")
            })
            .await;

        // Assert
        match result {
            Err(ForceError::Http(crate::error::HttpError::RateLimitExceeded {
                retry_after_seconds,
            })) => {
                assert_eq!(retry_after_seconds, 60);
            }
            _ => panic!(
                "Expected RateLimitExceeded error with default 60s, got: {:?}",
                result
            ),
        }
    }

    #[tokio::test]
    async fn test_503_retries_with_exponential_backoff() {
        // Arrange
        let mock_server = MockServer::start().await;
        // Use shorter backoff for testing to speed up execution
        let executor = HttpExecutor::with_config(2, std::time::Duration::from_secs(30))
            .with_base_backoff(std::time::Duration::from_millis(10));
        let token = create_test_token();

        // First two requests return 503
        Mock::given(method("GET"))
            .and(path("/test"))
            .respond_with(ResponseTemplate::new(503))
            .up_to_n_times(2)
            .mount(&mock_server)
            .await;

        // Third request succeeds
        Mock::given(method("GET"))
            .and(path("/test"))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "recovered": true
            })))
            .mount(&mock_server)
            .await;

        // Act
        let url = format!("{}/test", mock_server.uri());
        let request = reqwest::Client::new().get(&url).build().must();

        let start = std::time::Instant::now();
        let result = executor
            .execute(request, &token, || async {
                panic!("Should not refresh on 503 retry")
            })
            .await;
        let elapsed = start.elapsed();

        // Assert
        let response = result.must();
        assert_eq!(response.status(), 200);
        // Should have waited ~10ms + ~20ms = ~30ms for backoff
        assert!(elapsed.as_millis() >= 25);
    }

    #[tokio::test]
    async fn test_503_does_not_retry_mutation_by_default() {
        let mock_server = MockServer::start().await;
        let executor = HttpExecutor::with_config(3, std::time::Duration::from_secs(30));
        let token = create_test_token();

        Mock::given(method("POST"))
            .and(path("/test"))
            .respond_with(ResponseTemplate::new(503).set_body_string("temporary outage"))
            .expect(1)
            .mount(&mock_server)
            .await;

        let url = format!("{}/test", mock_server.uri());
        let request = reqwest::Client::new().post(&url).build().must();

        let result = executor
            .execute(request, &token, || async {
                panic!("Should not refresh on 503")
            })
            .await;

        let Err(ForceError::Http(crate::error::HttpError::StatusError { status_code, .. })) =
            result
        else {
            panic!("Expected 503 status error for non-retried mutation");
        };
        assert_eq!(status_code, 503);
    }

    #[tokio::test]
    async fn test_503_can_retry_mutation_with_explicit_policy() {
        let mock_server = MockServer::start().await;
        let executor = HttpExecutor::with_retry_policy(
            RetryPolicy::new(3, 2),
            std::time::Duration::from_secs(30),
        );
        let token = create_test_token();

        Mock::given(method("POST"))
            .and(path("/test"))
            .respond_with(ResponseTemplate::new(503))
            .up_to_n_times(2)
            .mount(&mock_server)
            .await;

        Mock::given(method("POST"))
            .and(path("/test"))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "recovered": true
            })))
            .mount(&mock_server)
            .await;

        let url = format!("{}/test", mock_server.uri());
        let request = reqwest::Client::new().post(&url).build().must();

        let result = executor
            .execute(request, &token, || async {
                panic!("Should not refresh on 503")
            })
            .await;

        let response = result.must();
        assert_eq!(response.status(), 200);
    }

    #[derive(Debug, Clone, PartialEq, Eq)]
    struct OwnedRequestCompletion {
        method: String,
        path: String,
        request_class: &'static str,
        status_code: Option<u16>,
        error_kind: Option<RequestErrorKind>,
        retries: u32,
        elapsed_ms: u128,
    }
    #[tokio::test]
    async fn test_telemetry_hooks_capture_retry_and_completion() {
        let mock_server = MockServer::start().await;
        let token = create_test_token();
        let retries = Arc::new(AtomicU32::new(0));
        let completions: Arc<Mutex<Vec<OwnedRequestCompletion>>> = Arc::new(Mutex::new(Vec::new()));
        let retries_clone = Arc::clone(&retries);
        let completions_clone = Arc::clone(&completions);

        let hooks = TelemetryHooks::new()
            .on_retry(move |event: &RetryEvent| {
                assert_eq!(event.method, "GET");
                assert_eq!(event.path, "/test");
                // Verify request class is correctly identified
                assert_eq!(event.request_class, "read");
                retries_clone.fetch_add(1, Ordering::SeqCst);
            })
            .on_complete(move |completion| {
                if let Ok(mut guard) = completions_clone.lock() {
                    guard.push(OwnedRequestCompletion {
                        method: completion.method.to_string(),
                        path: completion.path.to_string(),
                        request_class: completion.request_class,
                        status_code: completion.status_code,
                        error_kind: completion.error_kind,
                        retries: completion.retries,
                        elapsed_ms: completion.elapsed_ms,
                    });
                } else {
                    panic!("completion lock poisoned");
                }
            });

        let executor = HttpExecutor::with_config(2, std::time::Duration::from_secs(30))
            .with_telemetry_hooks(hooks);

        Mock::given(method("GET"))
            .and(path("/test"))
            .respond_with(ResponseTemplate::new(503))
            .up_to_n_times(1)
            .mount(&mock_server)
            .await;

        Mock::given(method("GET"))
            .and(path("/test"))
            .respond_with(ResponseTemplate::new(200))
            .mount(&mock_server)
            .await;

        let url = format!("{}/test?secret=redacted", mock_server.uri());
        let request = reqwest::Client::new().get(&url).build().must();

        let result = executor
            .execute(request, &token, || async {
                panic!("Should not refresh on 503")
            })
            .await;

        let response = result.must();
        assert_eq!(response.status(), 200);
        assert_eq!(retries.load(Ordering::SeqCst), 1);
        let Ok(completions) = completions.lock() else {
            panic!("completion lock poisoned");
        };
        assert_eq!(completions.len(), 1);
        assert_eq!(completions[0].path, "/test");
        assert_eq!(completions[0].request_class, "read");
        assert_eq!(completions[0].status_code, Some(200));
        assert_eq!(completions[0].retries, 1);
    }

    #[tokio::test]
    async fn test_api_error_parsing_salesforce_format() {
        // Arrange
        let mock_server = MockServer::start().await;
        let executor = HttpExecutor::new();
        let token = create_test_token();

        let error_body = serde_json::json!([
            {
                "errorCode": "INVALID_FIELD",
                "message": "Field 'InvalidField' does not exist",
                "fields": ["InvalidField"]
            }
        ]);

        Mock::given(method("POST"))
            .and(path("/test"))
            .respond_with(ResponseTemplate::new(400).set_body_json(error_body))
            .mount(&mock_server)
            .await;

        // Act
        let url = format!("{}/test", mock_server.uri());
        let request = reqwest::Client::new().post(&url).build().must();

        let result = executor
            .execute(request, &token, || async {
                panic!("Should not refresh on 400")
            })
            .await;

        // Assert
        match result {
            Err(ForceError::Http(crate::error::HttpError::StatusError {
                status_code,
                message,
            })) => {
                assert_eq!(status_code, 400);
                assert!(message.contains("INVALID_FIELD"));
                assert!(message.contains("Field 'InvalidField' does not exist"));
            }
            _ => panic!("Expected StatusError, got: {:?}", result),
        }
    }

    #[tokio::test]
    async fn test_execute_json_deserializes_response() {
        // Arrange
        let mock_server = MockServer::start().await;
        let executor = HttpExecutor::new();
        let token = create_test_token();

        let response_data = serde_json::json!({
            "id": "001xx000003DGbm",
            "name": "Test Account"
        });

        Mock::given(method("GET"))
            .and(path("/test"))
            .respond_with(ResponseTemplate::new(200).set_body_json(response_data))
            .mount(&mock_server)
            .await;

        // Act
        let url = format!("{}/test", mock_server.uri());
        let request = reqwest::Client::new().get(&url).build().must();

        let result: Result<TestResponse, ForceError> = executor
            .execute_json(request, &token, || async { panic!("Should not refresh") })
            .await;

        // Assert
        let response = result.must();
        assert_eq!(response.id, "001xx000003DGbm");
        assert_eq!(response.name, "Test Account");
    }

    #[tokio::test]
    async fn test_malformed_json_returns_serialization_error() {
        // Arrange
        let mock_server = MockServer::start().await;
        let executor = HttpExecutor::new();
        let token = create_test_token();

        Mock::given(method("GET"))
            .and(path("/test"))
            .respond_with(ResponseTemplate::new(200).set_body_string("{invalid json"))
            .mount(&mock_server)
            .await;

        // Act
        let url = format!("{}/test", mock_server.uri());
        let request = reqwest::Client::new().get(&url).build().must();

        let result: Result<IdOnlyResponse, ForceError> = executor
            .execute_json(request, &token, || async { panic!("Should not refresh") })
            .await;

        // Assert

        // Should get a Serialization error when parsing JSON fails
        assert!(matches!(result, Err(ForceError::Serialization(_))));
    }

    #[tokio::test]
    async fn test_double_401_fails_after_refresh() {
        // Arrange
        let mock_server = MockServer::start().await;
        let executor = HttpExecutor::new();
        let token = create_test_token();

        // Both requests return 401 (refresh doesn't help)
        Mock::given(method("GET"))
            .and(path("/test"))
            .respond_with(ResponseTemplate::new(401))
            .mount(&mock_server)
            .await;

        // Act
        let url = format!("{}/test", mock_server.uri());
        let request = reqwest::Client::new().get(&url).build().must();

        let result = executor
            .execute(request, &token, || async {
                let response = TokenResponse {
                    access_token: "new_token".to_string(),
                    instance_url: "https://test.salesforce.com".to_string(),
                    token_type: "Bearer".to_string(),
                    issued_at: "1640000000000".to_string(),
                    signature: "test_signature".to_string(),
                    expires_in: Some(7200),
                    refresh_token: None,
                };
                Ok(AccessToken::from_response(response))
            })
            .await;

        // Assert
        match result {
            Err(ForceError::Http(crate::error::HttpError::StatusError {
                status_code,
                message,
            })) => {
                assert_eq!(status_code, 401);
                assert!(message.contains("after token refresh"));
            }
            _ => panic!("Expected StatusError with 401, got: {:?}", result),
        }
    }

    #[tokio::test]
    async fn test_network_timeout_retries() {
        // Arrange
        let mock_server = MockServer::start().await;
        // Use short backoff and timeout
        let executor = HttpExecutor::with_config(2, std::time::Duration::from_millis(50))
            .with_base_backoff(std::time::Duration::from_millis(10));
        let token = create_test_token();

        // First request times out (delay > 50ms)
        Mock::given(method("GET"))
            .and(path("/test"))
            .respond_with(
                ResponseTemplate::new(200).set_delay(std::time::Duration::from_millis(100)),
            )
            .up_to_n_times(1)
            .mount(&mock_server)
            .await;

        // Second request succeeds
        Mock::given(method("GET"))
            .and(path("/test"))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "recovered": true
            })))
            .mount(&mock_server)
            .await;

        // Act
        let url = format!("{}/test", mock_server.uri());
        let request = reqwest::Client::new().get(&url).build().must();

        let start = std::time::Instant::now();
        let result = executor
            .execute(request, &token, || async {
                panic!("Should not refresh on timeout retry")
            })
            .await;
        let elapsed = start.elapsed();

        // Assert
        let response = result.must();
        assert_eq!(response.status(), 200);
        // Should have waited at least 50ms (timeout) + 10ms (backoff)
        assert!(elapsed.as_millis() >= 60);
    }

    #[tokio::test]
    async fn test_idempotent_mutation_retries_on_503() {
        let mock_server = MockServer::start().await;
        // Policy: Read=3, Mutation=0. IdempotentMutation=3 (implied from Read).
        let executor = HttpExecutor::with_retry_policy(
            RetryPolicy::new(3, 0),
            std::time::Duration::from_secs(30),
        );
        let token = create_test_token();

        // Fail 2 times with 503
        Mock::given(method("POST"))
            .and(path("/test"))
            .respond_with(ResponseTemplate::new(503))
            .up_to_n_times(2)
            .mount(&mock_server)
            .await;

        // Succeed on 3rd attempt
        Mock::given(method("POST"))
            .and(path("/test"))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "recovered": true
            })))
            .mount(&mock_server)
            .await;

        let url = format!("{}/test", mock_server.uri());
        let request = reqwest::Client::new().post(&url).build().must();

        // Explicitly use IdempotentMutation
        let result = executor
            .execute_response_with_retry_class(
                request,
                &token,
                || async { panic!("Should not refresh on 503") },
                RequestRetryClass::IdempotentMutation,
            )
            .await;

        let response = result.must();
        assert_eq!(response.status(), 200);
    }
}