force-sync 0.2.0

Correctness-first bidirectional Salesforce and Postgres sync engine
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
//! Integration tests for the Salesforce REST apply lane.

use async_trait::async_trait;
use force::{
    auth::{AccessToken, Authenticator, TokenResponse},
    client::{ForceClient, builder},
    error::Result as ForceResult,
    types::SalesforceId,
};
use serde_json::json;
use wiremock::{
    Mock, MockServer, ResponseTemplate,
    matchers::{body_json, header, method, path, query_param},
};

use force_sync::{ApplyError, RestApplyResult, SalesforceApplier};

#[derive(Debug, Clone)]
struct MockAuthenticator {
    token: String,
    instance_url: String,
}

impl MockAuthenticator {
    fn new(token: &str, instance_url: &str) -> Self {
        Self {
            token: token.to_string(),
            instance_url: instance_url.to_string(),
        }
    }
}

#[async_trait]
impl Authenticator for MockAuthenticator {
    async fn authenticate(&self) -> ForceResult<AccessToken> {
        Ok(AccessToken::from_response(TokenResponse {
            access_token: self.token.clone(),
            instance_url: self.instance_url.clone(),
            token_type: "Bearer".to_string(),
            issued_at: "1704067200000".to_string(),
            signature: "test_sig".to_string(),
            expires_in: Some(7200),
            refresh_token: None,
        }))
    }

    async fn refresh(&self) -> ForceResult<AccessToken> {
        self.authenticate().await
    }
}

async fn test_client(mock_server: &MockServer) -> ForceClient<MockAuthenticator> {
    builder()
        .authenticate(MockAuthenticator::new("test_token", &mock_server.uri()))
        .build()
        .await
        .unwrap_or_else(|error| panic!("unexpected client build error: {error}"))
}

fn salesforce_id(id: &str) -> SalesforceId {
    SalesforceId::new(id)
        .unwrap_or_else(|error| panic!("unexpected Salesforce ID construction error: {error}"))
}

#[tokio::test]
async fn apply_rest_upsert_create_returns_created_id() {
    let mock_server = MockServer::start().await;
    let client = test_client(&mock_server).await;
    let applier = SalesforceApplier::new(client);

    Mock::given(method("PATCH"))
        .and(path(
            "/services/data/v60.0/sobjects/Account/ExternalId__c/ACME-001",
        ))
        .and(header("Authorization", "Bearer test_token"))
        .and(body_json(json!({"Name": "Acme Corp"})))
        .respond_with(ResponseTemplate::new(201).set_body_json(json!({
            "id": "001000000000001AAA",
            "success": true,
            "created": true,
            "errors": []
        })))
        .expect(1)
        .mount(&mock_server)
        .await;

    let result = applier
        .apply_rest_upsert(
            "Account",
            "ExternalId__c",
            "ACME-001",
            &json!({"Name": "Acme Corp"}),
        )
        .await
        .unwrap_or_else(|error| panic!("unexpected apply error: {error}"));

    assert_eq!(
        result,
        RestApplyResult {
            salesforce_id: Some(salesforce_id("001000000000001AAA")),
            created: true,
        }
    );
}

#[tokio::test]
async fn apply_rest_upsert_update_204_fails_when_lookup_finds_no_row() {
    let mock_server = MockServer::start().await;
    let client = test_client(&mock_server).await;
    let applier = SalesforceApplier::new(client);

    Mock::given(method("PATCH"))
        .and(path(
            "/services/data/v60.0/sobjects/Account/ExternalId__c/ACME-002",
        ))
        .and(header("Authorization", "Bearer test_token"))
        .and(body_json(json!({"Name": "Acme Updated"})))
        .respond_with(ResponseTemplate::new(204))
        .expect(1)
        .mount(&mock_server)
        .await;

    Mock::given(method("GET"))
        .and(path("/services/data/v60.0/query"))
        .and(query_param(
            "q",
            "SELECT Id FROM Account WHERE ExternalId__c = 'ACME-002' LIMIT 1",
        ))
        .and(header("Authorization", "Bearer test_token"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({
            "totalSize": 0,
            "done": true,
            "records": []
        })))
        .expect(1)
        .mount(&mock_server)
        .await;

    let result = applier
        .apply_rest_upsert(
            "Account",
            "ExternalId__c",
            "ACME-002",
            &json!({"Name": "Acme Updated"}),
        )
        .await;

    let Err(error) = result else {
        panic!("expected 204 follow-up lookup failure");
    };

    assert!(matches!(error, ApplyError::Permanent(_)));
    assert!(
        error
            .to_string()
            .contains("follow-up lookup did not return")
    );
}

#[tokio::test]
async fn apply_rest_upsert_update_204_resolves_salesforce_id_when_link_missing() {
    let mock_server = MockServer::start().await;
    let client = test_client(&mock_server).await;
    let applier = SalesforceApplier::new(client);

    Mock::given(method("PATCH"))
        .and(path(
            "/services/data/v60.0/sobjects/Account/ExternalId__c/ACME-003",
        ))
        .and(header("Authorization", "Bearer test_token"))
        .and(body_json(json!({"Name": "Acme Updated"})))
        .respond_with(ResponseTemplate::new(204))
        .expect(1)
        .mount(&mock_server)
        .await;

    Mock::given(method("GET"))
        .and(path("/services/data/v60.0/query"))
        .and(query_param(
            "q",
            "SELECT Id FROM Account WHERE ExternalId__c = 'ACME-003' LIMIT 1",
        ))
        .and(header("Authorization", "Bearer test_token"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({
            "totalSize": 1,
            "done": true,
            "records": [{
                "attributes": {
                    "type": "Account",
                    "url": "/services/data/v60.0/sobjects/Account/001000000000003AAA"
                },
                "Id": "001000000000003AAA"
            }]
        })))
        .expect(1)
        .mount(&mock_server)
        .await;

    let result = applier
        .apply_rest_upsert(
            "Account",
            "ExternalId__c",
            "ACME-003",
            &json!({"Name": "Acme Updated"}),
        )
        .await
        .unwrap_or_else(|error| panic!("unexpected apply error: {error}"));

    assert_eq!(
        result,
        RestApplyResult {
            salesforce_id: Some(salesforce_id("001000000000003AAA")),
            created: false,
        }
    );
}

#[tokio::test]
async fn apply_rest_delete_uses_salesforce_id() {
    let mock_server = MockServer::start().await;
    let client = test_client(&mock_server).await;
    let applier = SalesforceApplier::new(client);
    let record_id = salesforce_id("001000000000001AAA");

    Mock::given(method("DELETE"))
        .and(path(
            "/services/data/v60.0/sobjects/Account/001000000000001AAA",
        ))
        .and(header("Authorization", "Bearer test_token"))
        .respond_with(ResponseTemplate::new(204))
        .expect(1)
        .mount(&mock_server)
        .await;

    applier
        .apply_rest_delete("Account", &record_id)
        .await
        .unwrap_or_else(|error| panic!("unexpected delete error: {error}"));
}

#[tokio::test]
async fn apply_rest_delete_404_is_idempotent_success() {
    let mock_server = MockServer::start().await;
    let client = test_client(&mock_server).await;
    let applier = SalesforceApplier::new(client);
    let record_id = salesforce_id("001000000000004AAA");

    Mock::given(method("DELETE"))
        .and(path(
            "/services/data/v60.0/sobjects/Account/001000000000004AAA",
        ))
        .and(header("Authorization", "Bearer test_token"))
        .respond_with(ResponseTemplate::new(404).set_body_string("not found"))
        .expect(1)
        .mount(&mock_server)
        .await;

    applier
        .apply_rest_delete("Account", &record_id)
        .await
        .unwrap_or_else(|error| panic!("unexpected delete error: {error}"));
}

#[tokio::test]
async fn transient_rest_upsert_failure_is_retryable() {
    let mock_server = MockServer::start().await;
    let client = test_client(&mock_server).await;
    let applier = SalesforceApplier::new(client);

    Mock::given(method("PATCH"))
        .and(path(
            "/services/data/v60.0/sobjects/Account/ExternalId__c/ACME-503",
        ))
        .respond_with(ResponseTemplate::new(503).set_body_string("temporary outage"))
        .mount(&mock_server)
        .await;

    let result = applier
        .apply_rest_upsert(
            "Account",
            "ExternalId__c",
            "ACME-503",
            &json!({"Name": "Acme Retry"}),
        )
        .await;

    let Err(error) = result else {
        panic!("expected retryable apply error");
    };

    assert!(matches!(error, ApplyError::Retryable(_)));
    assert!(error.to_string().contains("temporary outage"));
}

#[tokio::test]
async fn apply_rest_delete_server_error_is_retryable() {
    let mock_server = MockServer::start().await;
    let client = test_client(&mock_server).await;
    let applier = SalesforceApplier::new(client);
    let record_id = salesforce_id("001000000000005AAA");

    Mock::given(method("DELETE"))
        .and(path(
            "/services/data/v60.0/sobjects/Account/001000000000005AAA",
        ))
        .and(header("Authorization", "Bearer test_token"))
        .respond_with(ResponseTemplate::new(503).set_body_string("service unavailable"))
        .mount(&mock_server)
        .await;

    let result = applier.apply_rest_delete("Account", &record_id).await;

    let Err(error) = result else {
        panic!("expected retryable delete error");
    };

    assert!(matches!(error, ApplyError::Retryable(_)));
}

#[tokio::test]
async fn apply_rest_delete_bad_request_is_permanent() {
    let mock_server = MockServer::start().await;
    let client = test_client(&mock_server).await;
    let applier = SalesforceApplier::new(client);
    let record_id = salesforce_id("001000000000006AAA");

    Mock::given(method("DELETE"))
        .and(path(
            "/services/data/v60.0/sobjects/Account/001000000000006AAA",
        ))
        .and(header("Authorization", "Bearer test_token"))
        .respond_with(ResponseTemplate::new(400).set_body_string("bad request"))
        .mount(&mock_server)
        .await;

    let result = applier.apply_rest_delete("Account", &record_id).await;

    let Err(error) = result else {
        panic!("expected permanent delete error");
    };

    assert!(matches!(error, ApplyError::Permanent(_)));
}

#[tokio::test]
async fn apply_rest_upsert_permanent_400_classified_correctly() {
    let mock_server = MockServer::start().await;
    let client = test_client(&mock_server).await;
    let applier = SalesforceApplier::new(client);

    Mock::given(method("PATCH"))
        .and(path(
            "/services/data/v60.0/sobjects/Account/ExternalId__c/ACME-400",
        ))
        .respond_with(ResponseTemplate::new(400).set_body_json(json!([{
            "message": "FIELD_INTEGRITY_EXCEPTION",
            "errorCode": "FIELD_INTEGRITY_EXCEPTION",
            "fields": ["Name"]
        }])))
        .mount(&mock_server)
        .await;

    let result = applier
        .apply_rest_upsert(
            "Account",
            "ExternalId__c",
            "ACME-400",
            &json!({"Name": null}),
        )
        .await;

    let Err(error) = result else {
        panic!("expected permanent apply error for 400");
    };

    assert!(matches!(error, ApplyError::Permanent(_)));
}

#[tokio::test]
async fn apply_rest_upsert_update_204_fails_when_id_field_is_null_in_query_result() {
    let mock_server = MockServer::start().await;
    let client = test_client(&mock_server).await;
    let applier = SalesforceApplier::new(client);

    // Upsert returns 204 (update, no body)
    Mock::given(method("PATCH"))
        .and(path(
            "/services/data/v60.0/sobjects/Account/ExternalId__c/ACME-NULL",
        ))
        .and(header("Authorization", "Bearer test_token"))
        .respond_with(ResponseTemplate::new(204))
        .expect(1)
        .mount(&mock_server)
        .await;

    // Follow-up query returns a record but the Id field is null
    Mock::given(method("GET"))
        .and(path("/services/data/v60.0/query"))
        .and(query_param(
            "q",
            "SELECT Id FROM Account WHERE ExternalId__c = 'ACME-NULL' LIMIT 1",
        ))
        .and(header("Authorization", "Bearer test_token"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({
            "totalSize": 1,
            "done": true,
            "records": [{
                "attributes": {
                    "type": "Account",
                    "url": "/services/data/v60.0/sobjects/Account/001000000000099AAA"
                },
                "Id": null
            }]
        })))
        .expect(1)
        .mount(&mock_server)
        .await;

    let result = applier
        .apply_rest_upsert(
            "Account",
            "ExternalId__c",
            "ACME-NULL",
            &json!({"Name": "Test"}),
        )
        .await;

    let Err(error) = result else {
        panic!("expected permanent error for null Id field");
    };

    assert!(
        matches!(error, ApplyError::Permanent(_)),
        "expected Permanent error, got: {error}"
    );
    let error_text = error.to_string();
    assert!(
        error_text.contains("follow-up lookup did not return")
            || error_text.contains("invalid Salesforce"),
        "unexpected error message: {error_text}"
    );
}