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
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
//! Salesforce SOSL (Salesforce Object Search Language) search API.
//!
//! This module provides types and methods for executing SOSL searches across
//! multiple objects and fields in Salesforce.

use crate::api::builder_unwrap::BuilderUnwrapExt;
use crate::types::validator::validate_sobject_name;
use serde::{Deserialize, Serialize};
use std::borrow::Cow;
use std::collections::HashMap;

/// Result from a SOSL search query.
///
/// SOSL searches can return results from multiple objects, each with its own
/// set of records.
///
/// # Examples
///
/// ```ignore
/// let results = client.rest()
///     .search("FIND {Acme} IN ALL FIELDS RETURNING Account(Name), Contact(Name)")
///     .await?;
///
/// for record_set in &results.search_records {
///     println!("Object: {}", record_set.attributes.type_);
///     for record in &record_set.records {
///         println!("  ID: {}", record.get("Id").must());
///     }
/// }
/// ```
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SearchResult {
    /// Search records grouped by object type.
    pub search_records: Vec<SearchRecords>,
}

/// Search results for a specific object type.
///
/// Contains the object type information and all matching records.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SearchRecords {
    /// Object type metadata.
    #[serde(rename = "attributes")]
    pub attributes: SearchAttributes,

    /// Matching records for this object type.
    pub records: Vec<HashMap<String, serde_json::Value>>,
}

/// Attributes describing the object type in search results.
///
/// Similar to regular SObject attributes but specific to search results.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SearchAttributes {
    /// Type of the object (e.g., "Account", "Contact").
    #[serde(rename = "type")]
    pub type_: String,

    /// URL for accessing this object type.
    pub url: String,
}

/// Builder for constructing SOSL search queries.
///
/// Provides a fluent API for building SOSL queries with proper escaping
/// and formatting.
///
/// # Examples
///
/// ```
/// use force::api::rest::SearchQueryBuilder;
///
/// let query = SearchQueryBuilder::new()
///     .find("Acme Corporation")
///     .in_name_fields()
///     .returning("Account", &["Id", "Name", "Industry"])
///     .limit(10)
///     .build();
///
/// assert_eq!(
///     query,
///     "FIND {Acme Corporation} IN NAME FIELDS RETURNING Account(Id, Name, Industry) LIMIT 10"
/// );
/// ```
#[derive(Debug, Clone)]
pub struct SearchQueryBuilder {
    /// Search text.
    search_text: String,
    /// âš¡ Bolt: Using `&'static str` for predefined search scopes avoids `.to_string()` heap allocations.
    /// Search scope (e.g., "ALL FIELDS", "NAME FIELDS").
    search_scope: Option<&'static str>,
    /// Objects and fields to return.
    returning: Vec<(String, Vec<String>)>,
    /// Maximum number of records per object.
    limit: Option<u32>,
    /// Offset for pagination.
    offset: Option<u32>,
}

impl SearchQueryBuilder {
    /// Creates a new search query builder.
    #[must_use]
    pub fn new() -> Self {
        Self {
            search_text: String::new(),
            search_scope: None,
            returning: Vec::new(),
            limit: None,
            offset: None,
        }
    }

    /// Sets the search text.
    ///
    /// The text will be automatically escaped for SOSL.
    ///
    /// # Arguments
    ///
    /// * `text` - The search text
    #[must_use]
    pub fn find(mut self, text: &str) -> Self {
        self.search_text = escape_sosl(text).into_owned();
        self
    }

    /// Searches in all fields.
    #[must_use]
    pub fn in_all_fields(mut self) -> Self {
        self.search_scope = Some("ALL FIELDS");
        self
    }

    /// Searches in name fields only.
    #[must_use]
    pub fn in_name_fields(mut self) -> Self {
        self.search_scope = Some("NAME FIELDS");
        self
    }

    /// Searches in email fields only.
    #[must_use]
    pub fn in_email_fields(mut self) -> Self {
        self.search_scope = Some("EMAIL FIELDS");
        self
    }

    /// Searches in phone fields only.
    #[must_use]
    pub fn in_phone_fields(mut self) -> Self {
        self.search_scope = Some("PHONE FIELDS");
        self
    }

    /// Searches in sidebar fields only.
    #[must_use]
    pub fn in_sidebar_fields(mut self) -> Self {
        self.search_scope = Some("SIDEBAR FIELDS");
        self
    }

    /// Adds an object type to return with specific fields.
    ///
    /// # Arguments
    ///
    /// * `sobject` - The object type (e.g., "Account", "Contact")
    /// * `fields` - The fields to return (e.g., `&["Id", "Name"]`)
    ///
    /// # Errors
    ///
    /// Returns an error if object names contain non-alphanumeric/underscore characters or
    /// if field names contain characters other than alphanumeric, underscores, or dots.
    pub fn try_returning(
        mut self,
        sobject: impl Into<String>,
        fields: &[impl AsRef<str>],
    ) -> Result<Self, crate::error::ForceError> {
        let sobject = sobject.into();
        validate_sobject_name(&sobject)?;

        #[allow(unused_doc_comments)]
        /// âš¡ Bolt: Pre-allocating capacity avoids multiple heap reallocations
        /// that would occur when using `.collect::<Result<Vec<_>, _>>()`
        let mut safe_fields = Vec::with_capacity(fields.len());
        for f in fields {
            let f_str = f.as_ref();
            validate_field_syntax_safe(f_str).map_err(crate::error::ForceError::InvalidInput)?;
            safe_fields.push(f_str.to_string());
        }

        self.returning.push((sobject, safe_fields));
        Ok(self)
    }

    /// Adds an object type to return with specific fields.
    ///
    /// # Arguments
    ///
    /// * `sobject` - The object type (e.g., "Account", "Contact")
    /// * `fields` - The fields to return (e.g., `&["Id", "Name"]`)
    ///
    /// # Panics
    ///
    /// Panics if object names contain non-alphanumeric/underscore characters or
    /// if field names contain characters other than alphanumeric, underscores, or dots.
    #[must_use]
    pub fn returning(self, sobject: impl Into<String>, fields: &[impl AsRef<str>]) -> Self {
        self.try_returning(sobject, fields)
            .unwrap_or_panic("returning")
    }

    /// Sets the maximum number of records to return per object.
    #[must_use]
    pub fn limit(mut self, limit: u32) -> Self {
        self.limit = Some(limit);
        self
    }

    /// Sets the offset for pagination.
    #[must_use]
    pub fn offset(mut self, offset: u32) -> Self {
        self.offset = Some(offset);
        self
    }

    /// Builds the SOSL query string (non-panicking version).
    ///
    /// # Errors
    ///
    /// Returns an error if search text is empty or no objects are specified in RETURNING.
    pub fn try_build(self) -> Result<String, crate::error::ForceError> {
        use std::fmt::Write;

        if self.search_text.is_empty() {
            return Err(crate::error::ForceError::InvalidInput(
                "search text cannot be empty".to_string(),
            ));
        }

        if self.returning.is_empty() {
            return Err(crate::error::ForceError::InvalidInput(
                "at least one object must be specified in RETURNING".to_string(),
            ));
        }

        let mut query = String::with_capacity(128);

        write!(&mut query, "FIND {{{}}}", self.search_text)
            .unwrap_or_else(|_| unreachable!("String format cannot fail"));

        if let Some(scope) = self.search_scope {
            write!(&mut query, " IN {}", scope)
                .unwrap_or_else(|_| unreachable!("String format cannot fail"));
        }

        query.push_str(" RETURNING ");

        // âš¡ Bolt: Write RETURNING clauses directly to the `query` buffer, avoiding a temporary `.collect::<Vec<_>>()` and `.join(", ")` allocation.
        for (i, (sobject, fields)) in self.returning.into_iter().enumerate() {
            if i > 0 {
                query.push_str(", ");
            }

            query.push_str(&sobject);
            if !fields.is_empty() {
                query.push('(');
                #[allow(unused_doc_comments)]
                /// âš¡ Bolt: Iterating over fields directly pushes them to the `query` string buffer.
                /// This avoids the intermediate heap allocation that would occur if `fields.join(", ")` was used.
                for (i, field) in fields.into_iter().enumerate() {
                    if i > 0 {
                        query.push_str(", ");
                    }
                    query.push_str(&field);
                }
                query.push(')');
            }
        }

        if let Some(limit) = self.limit {
            write!(&mut query, " LIMIT {}", limit)
                .unwrap_or_else(|_| unreachable!("String format cannot fail"));
        }

        if let Some(offset) = self.offset {
            write!(&mut query, " OFFSET {}", offset)
                .unwrap_or_else(|_| unreachable!("String format cannot fail"));
        }

        Ok(query)
    }

    /// Builds the SOSL query string.
    ///
    /// # Panics
    ///
    /// Panics if search text is empty or no objects are specified in RETURNING.
    #[must_use]
    pub fn build(self) -> String {
        self.try_build().unwrap_or_panic("build")
    }
}

impl Default for SearchQueryBuilder {
    fn default() -> Self {
        Self::new()
    }
}

/// Escapes special characters for SOSL search queries.
///
/// Reserved characters: ? & | ! { } [ ] ( ) ^ ~ * : \ " ' + -
fn escape_sosl<'a>(text: impl Into<Cow<'a, str>>) -> Cow<'a, str> {
    let text = text.into();
    let first_special = text.find([
        '?', '&', '|', '!', '{', '}', '[', ']', '(', ')', '^', '~', '*', ':', '\\', '"', '\'', '+',
        '-',
    ]);

    match first_special {
        Some(idx) => {
            let mut escaped = String::with_capacity(text.len() + 8);
            escaped.push_str(&text[..idx]);
            for c in text[idx..].chars() {
                match c {
                    '?' | '&' | '|' | '!' | '{' | '}' | '[' | ']' | '(' | ')' | '^' | '~' | '*'
                    | ':' | '\\' | '"' | '\'' | '+' | '-' => {
                        escaped.push('\\');
                        escaped.push(c);
                    }
                    _ => escaped.push(c),
                }
            }
            Cow::Owned(escaped)
        }
        None => text,
    }
}

/// Validates field syntax to prevent SOSL injection while allowing complex clauses.
///
/// Safe helper for field validation.
fn validate_field_syntax_safe(field: &str) -> Result<(), String> {
    FieldSyntaxValidator::new(field).validate()
}

struct FieldSyntaxValidator<'a> {
    field: &'a str,
    balance: i32,
    in_quote: Option<char>,
    escaped: bool,
}

impl<'a> FieldSyntaxValidator<'a> {
    fn new(field: &'a str) -> Self {
        Self {
            field,
            balance: 0,
            in_quote: None,
            escaped: false,
        }
    }

    fn validate(mut self) -> Result<(), String> {
        for c in self.field.chars() {
            self.process_char(c)?;
        }
        self.verify_completion()
    }

    fn process_char(&mut self, c: char) -> Result<(), String> {
        if self.escaped {
            self.escaped = false;
            return Ok(());
        }

        if c == '\\' {
            self.escaped = true;
            return Ok(());
        }

        if let Some(quote_char) = self.in_quote {
            if c == quote_char {
                self.in_quote = None;
            }
            return Ok(());
        }

        self.process_unquoted_char(c)
    }

    fn process_unquoted_char(&mut self, c: char) -> Result<(), String> {
        match c {
            '\'' | '"' => self.in_quote = Some(c),
            '(' => self.balance += 1,
            ')' => {
                self.balance -= 1;
                if self.balance < 0 {
                    return Err(format!(
                        "unbalanced parentheses (unexpected closing) in field: {}",
                        self.field
                    ));
                }
            }
            _ if c.is_ascii_alphanumeric() => {}
            '_' | '.' | ' ' | '\t' | '\n' | '\r' | ',' | '=' | '!' | '<' | '>' | '-' | '+'
            | ':' | '%' | '&' | '|' | '^' | '*' | '$' => {}
            ';' | '{' | '}' | '[' | ']' => {
                return Err(format!(
                    "field name contains invalid character outside quotes: '{}' in \"{}\"",
                    c, self.field
                ));
            }
            _ => {
                return Err(format!(
                    "field name contains invalid character: '{}' in \"{}\"",
                    c, self.field
                ));
            }
        }
        Ok(())
    }

    fn verify_completion(self) -> Result<(), String> {
        if self.in_quote.is_some() {
            return Err(format!("unclosed quote in field: {}", self.field));
        }
        if self.balance != 0 {
            return Err(format!(
                "unbalanced parentheses (unclosed opening) in field: {}",
                self.field
            ));
        }
        if self.escaped {
            return Err(format!("field cannot end with a backslash: {}", self.field));
        }
        Ok(())
    }
}

#[cfg(test)]
mod tests {

    use super::*;
    use crate::test_support::Must;

    /// Panicking wrapper for `validate_field_syntax_safe` — test-only.
    fn validate_field_syntax(field: &str) {
        if let Err(e) = validate_field_syntax_safe(field) {
            panic!("{e}");
        }
    }

    #[test]
    #[should_panic(
        expected = "Invalid input in returning: invalid input: field name contains invalid character: '@' in \"Invalid@Field\""
    )]
    fn test_returning_invalid_character_fallback() {
        let _ = SearchQueryBuilder::new()
            .find("test")
            .returning("Account", &["Invalid@Field"])
            .build();
    }

    #[test]
    #[should_panic(
        expected = "field name contains invalid character outside quotes: ';' in \"Invalid;Field\""
    )]
    fn test_validate_field_syntax_panics() {
        validate_field_syntax("Invalid;Field");
    }

    // RED PHASE - Write failing tests first

    #[test]
    fn test_search_result_deserialize() {
        let json = r#"{
            "searchRecords": [
                {
                    "attributes": {
                        "type": "Account",
                        "url": "/services/data/v60.0/sobjects/Account/001000000000001AAA"
                    },
                    "records": [
                        {
                            "Id": "001000000000001AAA",
                            "Name": "Acme Corporation"
                        }
                    ]
                }
            ]
        }"#;

        let result: SearchResult = serde_json::from_str(json).must();
        assert_eq!(result.search_records.len(), 1);
        assert_eq!(result.search_records[0].attributes.type_, "Account");
        assert_eq!(result.search_records[0].records.len(), 1);
    }

    #[test]
    fn test_search_result_multiple_objects() {
        let json = r#"{
            "searchRecords": [
                {
                    "attributes": {
                        "type": "Account",
                        "url": "/services/data/v60.0/sobjects/Account"
                    },
                    "records": [
                        {"Id": "001000000000001AAA", "Name": "Acme"}
                    ]
                },
                {
                    "attributes": {
                        "type": "Contact",
                        "url": "/services/data/v60.0/sobjects/Contact"
                    },
                    "records": [
                        {"Id": "003000000000001AAA", "Name": "John Doe"}
                    ]
                }
            ]
        }"#;

        let result: SearchResult = serde_json::from_str(json).must();
        assert_eq!(result.search_records.len(), 2);
        assert_eq!(result.search_records[0].attributes.type_, "Account");
        assert_eq!(result.search_records[1].attributes.type_, "Contact");
    }

    #[test]
    fn test_search_result_empty_records() {
        let json = r#"{
            "searchRecords": []
        }"#;

        let result: SearchResult = serde_json::from_str(json).must();
        assert_eq!(result.search_records.len(), 0);
    }

    #[test]
    fn test_search_query_builder_basic() {
        let query = SearchQueryBuilder::new()
            .find("Acme")
            .in_all_fields()
            .returning("Account", &["Id", "Name"])
            .build();

        assert_eq!(
            query,
            "FIND {Acme} IN ALL FIELDS RETURNING Account(Id, Name)"
        );
    }

    #[test]
    fn test_search_query_builder_multiple_objects() {
        let query = SearchQueryBuilder::new()
            .find("John")
            .in_name_fields()
            .returning("Account", &["Id", "Name"])
            .returning("Contact", &["Id", "FirstName", "LastName"])
            .build();

        assert_eq!(
            query,
            "FIND {John} IN NAME FIELDS RETURNING Account(Id, Name), Contact(Id, FirstName, LastName)"
        );
    }

    #[test]
    fn test_search_query_builder_with_limit() {
        let query = SearchQueryBuilder::new()
            .find("Test")
            .in_all_fields()
            .returning("Account", &["Id"])
            .limit(5)
            .build();

        assert_eq!(
            query,
            "FIND {Test} IN ALL FIELDS RETURNING Account(Id) LIMIT 5"
        );
    }

    #[test]
    fn test_search_query_builder_with_offset() {
        let query = SearchQueryBuilder::new()
            .find("Test")
            .in_all_fields()
            .returning("Account", &["Id"])
            .offset(10)
            .build();

        assert_eq!(
            query,
            "FIND {Test} IN ALL FIELDS RETURNING Account(Id) OFFSET 10"
        );
    }

    #[test]
    fn test_search_query_builder_with_limit_and_offset() {
        let query = SearchQueryBuilder::new()
            .find("Test")
            .in_all_fields()
            .returning("Account", &["Id"])
            .limit(5)
            .offset(10)
            .build();

        assert_eq!(
            query,
            "FIND {Test} IN ALL FIELDS RETURNING Account(Id) LIMIT 5 OFFSET 10"
        );
    }

    #[test]
    fn test_search_query_builder_sidebar_fields() {
        let query = SearchQueryBuilder::new()
            .find("test@example.com")
            .in_sidebar_fields()
            .returning("Contact", &["Id", "Email"])
            .build();

        assert_eq!(
            query,
            "FIND {test@example.com} IN SIDEBAR FIELDS RETURNING Contact(Id, Email)"
        );
    }

    #[test]
    fn test_search_query_builder_email_fields() {
        let query = SearchQueryBuilder::new()
            .find("test@example.com")
            .in_email_fields()
            .returning("Contact", &["Id", "Email"])
            .build();

        assert_eq!(
            query,
            "FIND {test@example.com} IN EMAIL FIELDS RETURNING Contact(Id, Email)"
        );
    }

    #[test]
    fn test_search_query_builder_phone_fields() {
        let query = SearchQueryBuilder::new()
            .find("415-555-0100")
            .in_phone_fields()
            .returning("Contact", &["Id", "Phone"])
            .build();

        assert_eq!(
            query,
            r"FIND {415\-555\-0100} IN PHONE FIELDS RETURNING Contact(Id, Phone)"
        );
    }

    #[test]
    fn test_search_query_builder_no_fields() {
        let query = SearchQueryBuilder::new()
            .find("Test")
            .returning("Account", &[] as &[&str])
            .build();

        // When no fields specified, just return the object name
        assert_eq!(query, "FIND {Test} RETURNING Account");
    }

    #[test]
    #[should_panic(expected = "search text cannot be empty")]
    fn test_search_query_builder_empty_text() {
        let _ = SearchQueryBuilder::new()
            .find("")
            .returning("Account", &["Id"])
            .build();
    }

    #[test]
    #[should_panic(expected = "at least one object must be specified")]
    fn test_search_query_builder_no_returning() {
        let _ = SearchQueryBuilder::new().find("Test").build();
    }

    // Test unwrap_or_panic logic by calling panicking methods on invalid states directly.
    #[test]
    #[should_panic(expected = "Invalid input in build: invalid input: search text cannot be empty")]
    fn test_build_panics_on_empty_search_text() {
        let _ = SearchQueryBuilder::new()
            .returning("Account", &["Id"])
            .build();
    }

    #[test]
    #[should_panic(
        expected = "Invalid input in build: invalid input: at least one object must be specified in RETURNING"
    )]
    fn test_build_panics_on_missing_returning() {
        let _ = SearchQueryBuilder::new().find("Test").build();
    }

    #[test]
    #[should_panic(
        expected = "Invalid input in returning: invalid input: SObject name contains invalid characters: Invalid;DROP"
    )]
    fn test_returning_panics_on_invalid_sobject() {
        let _ = SearchQueryBuilder::new()
            .find("Test")
            .returning("Invalid;DROP", &["Id"]);
    }

    #[test]
    #[should_panic(
        expected = "Invalid input in returning: invalid input: field name contains invalid character outside quotes: ';' in \"Invalid;Field\""
    )]
    fn test_returning_panics_on_invalid_field() {
        let _ = SearchQueryBuilder::new()
            .find("Test")
            .returning("Account", &["Invalid;Field"]);
    }

    #[test]
    #[should_panic(expected = "Invalid input in test_context: invalid input: test error")]
    fn test_unwrap_or_panic_helper() {
        let result: Result<(), crate::error::ForceError> = Err(
            crate::error::ForceError::InvalidInput("test error".to_string()),
        );
        result.unwrap_or_panic("test_context");
    }

    #[test]

    fn test_search_query_builder_try_build_errors() {
        let result = SearchQueryBuilder::new()
            .find("")
            .try_returning("Account", &["Id"])
            .unwrap_or_else(|_| panic!("Valid returning clause failed"))
            .try_build();
        assert!(
            matches!(result, Err(crate::error::ForceError::InvalidInput(msg)) if msg.contains("search text cannot be empty"))
        );

        let result = SearchQueryBuilder::new().find("Test").try_build();
        assert!(
            matches!(result, Err(crate::error::ForceError::InvalidInput(msg)) if msg.contains("at least one object must be specified in RETURNING"))
        );
    }

    #[test]
    fn test_search_query_builder_try_returning_errors() {
        // Invalid sobject
        let result =
            SearchQueryBuilder::new().try_returning("Account; DROP TABLE Account", &["Id"]);
        assert!(
            matches!(result, Err(crate::error::ForceError::InvalidInput(msg)) if msg.contains("SObject name contains invalid characters"))
        );

        // Invalid field syntax outside quotes
        let result = SearchQueryBuilder::new().try_returning("Account", &["Id;"]);
        assert!(
            matches!(result, Err(crate::error::ForceError::InvalidInput(msg)) if msg.contains("invalid character outside quotes"))
        );

        // Invalid field syntax unclosed quotes
        let result = SearchQueryBuilder::new().try_returning("Account", &["Id = 'value"]);
        assert!(
            matches!(result, Err(crate::error::ForceError::InvalidInput(msg)) if msg.contains("unclosed quote"))
        );

        // Invalid field syntax unclosed parenthesis
        let result = SearchQueryBuilder::new().try_returning("Account", &["COUNT(Id"]);
        assert!(
            matches!(result, Err(crate::error::ForceError::InvalidInput(msg)) if msg.contains("unbalanced parentheses (unclosed opening)"))
        );

        // Invalid field syntax unexpected closing parenthesis
        let result = SearchQueryBuilder::new().try_returning("Account", &["COUNT(Id))"]);
        assert!(
            matches!(result, Err(crate::error::ForceError::InvalidInput(msg)) if msg.contains("unbalanced parentheses (unexpected closing)"))
        );
    }

    #[test]
    fn test_search_query_builder_escaping() {
        let query = SearchQueryBuilder::new()
            .find(r#"? & | ! { } [ ] ( ) ^ ~ * : \ " ' + -"#)
            .returning("Account", &["Id"])
            .build();

        // All special characters should be escaped with backslash
        let expected = r#"FIND {\? \& \| \! \{ \} \[ \] \( \) \^ \~ \* \: \\ \" \' \+ \-} RETURNING Account(Id)"#;
        assert_eq!(query, expected);
    }

    #[test]
    fn test_returning_valid_inputs() {
        let query = SearchQueryBuilder::new()
            .find("test")
            .returning("Account", &["Name", "Id"])
            .returning("Custom__c", &["Field__c", "Parent__r.Name"])
            .build();

        assert_eq!(
            query,
            "FIND {test} RETURNING Account(Name, Id), Custom__c(Field__c, Parent__r.Name)"
        );
    }

    #[test]
    #[should_panic(expected = "SObject name contains invalid characters")]
    fn test_returning_invalid_sobject_space() {
        let _ = SearchQueryBuilder::new()
            .find("test")
            .returning("Account Name", &["Id"])
            .build();
    }

    #[test]
    #[should_panic(expected = "SObject name contains invalid characters")]
    fn test_returning_invalid_sobject_injection() {
        let _ = SearchQueryBuilder::new()
            .find("test")
            .returning("Account; DROP TABLE", &["Id"])
            .build();
    }

    #[test]
    fn test_returning_valid_field_clauses() {
        let query = SearchQueryBuilder::new()
            .find("test")
            .returning("Account", &["Name ORDER BY CreatedDate DESC", "Industry"])
            .build();

        assert_eq!(
            query,
            "FIND {test} RETURNING Account(Name ORDER BY CreatedDate DESC, Industry)"
        );
    }

    #[test]
    #[should_panic(expected = "unbalanced parentheses (unexpected closing) in field")]
    fn test_returning_invalid_field_injection() {
        let _ = SearchQueryBuilder::new()
            .find("test")
            .returning("Account", &["Id) LIMIT 1"])
            .build();
    }

    #[test]
    fn test_returning_valid_function_calls() {
        let query = SearchQueryBuilder::new()
            .find("test")
            .returning(
                "Account",
                &["toLabel(Industry)", "convertCurrency(AnnualRevenue)"],
            )
            .build();

        assert_eq!(
            query,
            "FIND {test} RETURNING Account(toLabel(Industry), convertCurrency(AnnualRevenue))"
        );
    }

    #[test]
    #[should_panic(expected = "unbalanced parentheses (unclosed opening) in field")]
    fn test_returning_invalid_unclosed_parenthesis() {
        let _ = SearchQueryBuilder::new()
            .find("test")
            .returning("Account", &["toLabel(Industry"])
            .build();
    }

    #[test]
    fn test_returning_valid_wildcard_clause() {
        let query = SearchQueryBuilder::new()
            .find("test")
            .returning("Account", &["Name WHERE Name LIKE 'Acme%'"])
            .build();

        assert_eq!(
            query,
            "FIND {test} RETURNING Account(Name WHERE Name LIKE 'Acme%')"
        );
    }

    #[test]
    fn test_returning_valid_complex_clauses() {
        let query = SearchQueryBuilder::new()
            .find("test")
            .returning(
                "Account",
                &["Name WHERE Name = 'Smith & Wesson' AND Industry = 'Tech'"],
            )
            .build();

        assert_eq!(
            query,
            "FIND {test} RETURNING Account(Name WHERE Name = 'Smith & Wesson' AND Industry = 'Tech')"
        );
    }

    #[test]
    fn test_returning_valid_escaped_wildcard() {
        let query = SearchQueryBuilder::new()
            .find("test")
            .returning("Account", &["Name WHERE Name LIKE '100\\%'"])
            .build();

        assert_eq!(
            query,
            "FIND {test} RETURNING Account(Name WHERE Name LIKE '100\\%')"
        );
    }

    #[test]
    fn test_returning_valid_semicolon_inside_quotes() {
        let query = SearchQueryBuilder::new()
            .find("test")
            .returning("Account", &["Name WHERE Name = 'Semi;Colon'"])
            .build();

        assert_eq!(
            query,
            "FIND {test} RETURNING Account(Name WHERE Name = 'Semi;Colon')"
        );
    }

    #[test]
    #[should_panic(expected = "field name contains invalid character outside quotes: ';'")]
    fn test_returning_invalid_semicolon_outside_quotes() {
        let _ = SearchQueryBuilder::new()
            .find("test")
            .returning("Account", &["Name; DROP TABLE"])
            .build();
    }

    #[test]
    fn test_returning_valid_system_variable() {
        let query = SearchQueryBuilder::new()
            .find("test")
            .returning("Account", &["Name WHERE OwnerId = $User.Id"])
            .build();

        assert_eq!(
            query,
            "FIND {test} RETURNING Account(Name WHERE OwnerId = $User.Id)"
        );
    }

    #[test]
    fn test_returning_valid_multiline_query() {
        let query = SearchQueryBuilder::new()
            .find("test")
            .returning("Account", &["Name\nWHERE\tName = 'Acme'"])
            .build();

        assert_eq!(
            query,
            "FIND {test} RETURNING Account(Name\nWHERE\tName = 'Acme')"
        );
    }

    #[test]
    #[should_panic(expected = "field cannot end with a backslash")]
    fn test_returning_invalid_trailing_backslash() {
        let _ = SearchQueryBuilder::new()
            .find("test")
            .returning("Account", &["Name\\"])
            .build();
    }

    #[test]
    fn test_returning_valid_escaped_quote_in_string() {
        let query = SearchQueryBuilder::new()
            .find("test")
            .returning("Account", &["Name WHERE Name = 'O\\'Reilly'"])
            .build();

        assert_eq!(
            query,
            "FIND {test} RETURNING Account(Name WHERE Name = 'O\\'Reilly')"
        );
    }

    #[test]
    fn test_escape_sosl_cow_optimization() {
        // Case 1: No special characters -> Cow::Borrowed
        let safe_text = "SimpleSearch";
        let result = escape_sosl(safe_text);
        assert!(matches!(result, std::borrow::Cow::Borrowed(_)));
        assert_eq!(result, "SimpleSearch");

        // Case 2: Special characters -> Cow::Owned
        let unsafe_text = "Search & Destroy";
        let result = escape_sosl(unsafe_text);
        assert!(matches!(result, std::borrow::Cow::Owned(_)));
        assert_eq!(result, r"Search \& Destroy");

        // Case 3: Owned String input, no escape -> Cow::Owned (reused input)
        let owned_safe = String::from("OwnedString");
        // We pass the string by value (transfer ownership)
        let result_owned = escape_sosl(owned_safe);
        // The implementation checks if special chars exist. If not, it returns the input Cow.
        // Since input was converted to Cow::Owned, output should be Cow::Owned with same data.
        assert!(matches!(result_owned, std::borrow::Cow::Owned(_)));
        assert_eq!(result_owned, "OwnedString");
    }
}

// Integration tests with wiremock
#[cfg(all(test, feature = "mock"))]
mod integration_tests {
    use super::*;
    use crate::client::builder;
    use crate::config::ClientConfig;
    use crate::test_support::{MockAuthenticator, MustMsg};
    use wiremock::matchers::{bearer_token, method, path, query_param};
    use wiremock::{Mock, MockServer, ResponseTemplate};

    fn sample_search_response() -> serde_json::Value {
        serde_json::json!({
            "searchRecords": [
                {
                    "attributes": {
                        "type": "Account",
                        "url": "/services/data/v60.0/sobjects/Account/001000000000001AAA"
                    },
                    "records": [
                        {
                            "Id": "001000000000001AAA",
                            "Name": "Acme Corporation",
                            "Industry": "Technology"
                        },
                        {
                            "Id": "001000000000002AAA",
                            "Name": "Acme Industries",
                            "Industry": "Manufacturing"
                        }
                    ]
                },
                {
                    "attributes": {
                        "type": "Contact",
                        "url": "/services/data/v60.0/sobjects/Contact/003000000000001AAA"
                    },
                    "records": [
                        {
                            "Id": "003000000000001AAA",
                            "FirstName": "John",
                            "LastName": "Acme"
                        }
                    ]
                }
            ]
        })
    }

    #[tokio::test]
    async fn test_search_success() {
        let mock_server = MockServer::start().await;
        let auth = MockAuthenticator::new("test_token", &mock_server.uri());

        let sosl = "FIND {Acme} IN ALL FIELDS RETURNING Account(Id, Name), Contact(Id, Name)";

        Mock::given(method("GET"))
            .and(path("/services/data/v60.0/search"))
            .and(query_param("q", sosl))
            .and(bearer_token("test_token"))
            .respond_with(ResponseTemplate::new(200).set_body_json(sample_search_response()))
            .mount(&mock_server)
            .await;

        let client = builder()
            .authenticate(auth)
            .build()
            .await
            .must_msg("Failed to build client");

        let results = client.rest().search(sosl).await.must_msg("Search failed");

        assert_eq!(results.search_records.len(), 2);
        assert_eq!(results.search_records[0].attributes.type_, "Account");
        assert_eq!(results.search_records[0].records.len(), 2);
        assert_eq!(results.search_records[1].attributes.type_, "Contact");
        assert_eq!(results.search_records[1].records.len(), 1);
    }

    #[tokio::test]
    async fn test_search_with_builder() {
        let mock_server = MockServer::start().await;
        let auth = MockAuthenticator::new("test_token", &mock_server.uri());

        let query = SearchQueryBuilder::new()
            .find("Acme")
            .in_name_fields()
            .returning("Account", &["Id", "Name"])
            .limit(10)
            .build();

        Mock::given(method("GET"))
            .and(path("/services/data/v60.0/search"))
            .and(query_param("q", query.as_str()))
            .respond_with(ResponseTemplate::new(200).set_body_json(sample_search_response()))
            .mount(&mock_server)
            .await;

        let client = builder()
            .authenticate(auth)
            .build()
            .await
            .must_msg("Failed to build client");

        let results = client.rest().search(&query).await.must_msg("Search failed");
        assert_eq!(results.search_records.len(), 2);
    }

    #[tokio::test]
    async fn test_search_empty_results() {
        let mock_server = MockServer::start().await;
        let auth = MockAuthenticator::new("test_token", &mock_server.uri());

        let empty_response = serde_json::json!({
            "searchRecords": []
        });

        Mock::given(method("GET"))
            .and(path("/services/data/v60.0/search"))
            .respond_with(ResponseTemplate::new(200).set_body_json(empty_response))
            .mount(&mock_server)
            .await;

        let client = builder()
            .authenticate(auth)
            .build()
            .await
            .must_msg("Failed to build client");

        let results = client
            .rest()
            .search("FIND {NonExistent} RETURNING Account(Id)")
            .await
            .must_msg("Search failed");

        assert_eq!(results.search_records.len(), 0);
    }

    #[tokio::test]
    async fn test_search_unauthorized() {
        let mock_server = MockServer::start().await;
        let auth = MockAuthenticator::new("invalid_token", &mock_server.uri());

        Mock::given(method("GET"))
            .and(path("/services/data/v60.0/search"))
            .respond_with(ResponseTemplate::new(401))
            .mount(&mock_server)
            .await;

        let client = builder()
            .authenticate(auth)
            .build()
            .await
            .must_msg("Failed to build client");

        let result = client
            .rest()
            .search("FIND {Test} RETURNING Account(Id)")
            .await;
        let Err(err) = result else {
            panic!("Expected an error");
        };
        assert!(err.to_string().contains(""));
    }

    #[tokio::test]
    async fn test_search_malformed_query() {
        let mock_server = MockServer::start().await;
        let auth = MockAuthenticator::new("test_token", &mock_server.uri());

        Mock::given(method("GET"))
            .and(path("/services/data/v60.0/search"))
            .respond_with(ResponseTemplate::new(400).set_body_json(serde_json::json!({
                "message": "Malformed SOSL query",
                "errorCode": "MALFORMED_QUERY"
            })))
            .mount(&mock_server)
            .await;

        let client = builder()
            .authenticate(auth)
            .build()
            .await
            .must_msg("Failed to build client");

        let result = client.rest().search("INVALID SOSL").await;
        let Err(err) = result else {
            panic!("Expected an error");
        };
        assert!(err.to_string().contains(""));
    }

    #[tokio::test]
    async fn test_search_single_object() {
        let mock_server = MockServer::start().await;
        let auth = MockAuthenticator::new("test_token", &mock_server.uri());

        let single_object_response = serde_json::json!({
            "searchRecords": [
                {
                    "attributes": {
                        "type": "Account",
                        "url": "/services/data/v60.0/sobjects/Account"
                    },
                    "records": [
                        {"Id": "001000000000001AAA", "Name": "Test Account"}
                    ]
                }
            ]
        });

        Mock::given(method("GET"))
            .and(path("/services/data/v60.0/search"))
            .respond_with(ResponseTemplate::new(200).set_body_json(single_object_response))
            .mount(&mock_server)
            .await;

        let client = builder()
            .authenticate(auth)
            .build()
            .await
            .must_msg("Failed to build client");

        let results = client
            .rest()
            .search("FIND {Test} RETURNING Account(Id, Name)")
            .await
            .must_msg("Search failed");

        assert_eq!(results.search_records.len(), 1);
        assert_eq!(results.search_records[0].attributes.type_, "Account");
    }

    #[tokio::test]
    async fn test_search_with_custom_api_version() {
        let mock_server = MockServer::start().await;
        let auth = MockAuthenticator::new("custom_token", &mock_server.uri());

        Mock::given(method("GET"))
            .and(path("/services/data/v59.0/search"))
            .respond_with(ResponseTemplate::new(200).set_body_json(sample_search_response()))
            .mount(&mock_server)
            .await;

        let config = ClientConfig {
            api_version: "v59.0".into(),
            ..Default::default()
        };
        let client = builder()
            .authenticate(auth)
            .config(config)
            .build()
            .await
            .must_msg("Failed to build client");

        let results = client
            .rest()
            .search("FIND {Acme} RETURNING Account(Id)")
            .await
            .must_msg("Search failed");

        assert_eq!(results.search_records.len(), 2);
    }

    #[tokio::test]
    async fn test_search_email_fields() {
        let mock_server = MockServer::start().await;
        let auth = MockAuthenticator::new("test_token", &mock_server.uri());

        let query = SearchQueryBuilder::new()
            .find("test@example.com")
            .in_email_fields()
            .returning("Contact", &["Id", "Email"])
            .build();

        Mock::given(method("GET"))
            .and(path("/services/data/v60.0/search"))
            .and(query_param(
                "q",
                "FIND {test@example.com} IN EMAIL FIELDS RETURNING Contact(Id, Email)",
            ))
            .respond_with(ResponseTemplate::new(200).set_body_json(sample_search_response()))
            .mount(&mock_server)
            .await;

        let client = builder()
            .authenticate(auth)
            .build()
            .await
            .must_msg("Failed to build client");

        client.rest().search(&query).await.must_msg("Search failed");
    }

    #[tokio::test]
    async fn test_search_phone_fields() {
        let mock_server = MockServer::start().await;
        let auth = MockAuthenticator::new("test_token", &mock_server.uri());

        let query = SearchQueryBuilder::new()
            .find("415-555-0100")
            .in_phone_fields()
            .returning("Contact", &["Id", "Phone"])
            .build();

        Mock::given(method("GET"))
            .and(path("/services/data/v60.0/search"))
            .respond_with(ResponseTemplate::new(200).set_body_json(sample_search_response()))
            .mount(&mock_server)
            .await;

        let client = builder()
            .authenticate(auth)
            .build()
            .await
            .must_msg("Failed to build client");

        client.rest().search(&query).await.must_msg("Search failed");
    }

    #[tokio::test]
    async fn test_search_with_limit_and_offset() {
        let mock_server = MockServer::start().await;
        let auth = MockAuthenticator::new("test_token", &mock_server.uri());

        let query = SearchQueryBuilder::new()
            .find("Acme")
            .in_all_fields()
            .returning("Account", &["Id"])
            .limit(10)
            .offset(20)
            .build();

        Mock::given(method("GET"))
            .and(path("/services/data/v60.0/search"))
            .and(query_param(
                "q",
                "FIND {Acme} IN ALL FIELDS RETURNING Account(Id) LIMIT 10 OFFSET 20",
            ))
            .respond_with(ResponseTemplate::new(200).set_body_json(sample_search_response()))
            .mount(&mock_server)
            .await;

        let client = builder()
            .authenticate(auth)
            .build()
            .await
            .must_msg("Failed to build client");

        client.rest().search(&query).await.must_msg("Search failed");
    }

    #[tokio::test]
    async fn test_search_multiple_calls() {
        let mock_server = MockServer::start().await;
        let auth = MockAuthenticator::new("test_token", &mock_server.uri());

        Mock::given(method("GET"))
            .and(path("/services/data/v60.0/search"))
            .respond_with(ResponseTemplate::new(200).set_body_json(sample_search_response()))
            .expect(3)
            .mount(&mock_server)
            .await;

        let client = builder()
            .authenticate(auth)
            .build()
            .await
            .must_msg("Failed to build client");

        for _ in 0..3 {
            let results = client
                .rest()
                .search("FIND {Test} RETURNING Account(Id)")
                .await
                .must_msg("Search failed");
            assert_eq!(results.search_records.len(), 2);
        }
    }

    #[tokio::test]
    async fn test_search_cloned_handler() {
        let mock_server = MockServer::start().await;
        let auth = MockAuthenticator::new("test_token", &mock_server.uri());

        Mock::given(method("GET"))
            .and(path("/services/data/v60.0/search"))
            .respond_with(ResponseTemplate::new(200).set_body_json(sample_search_response()))
            .expect(2)
            .mount(&mock_server)
            .await;

        let client = builder()
            .authenticate(auth)
            .build()
            .await
            .must_msg("Failed to build client");

        let handler1 = client.rest();
        let handler2 = handler1.clone();

        let results1 = handler1
            .search("FIND {Test} RETURNING Account(Id)")
            .await
            .must_msg("Handler1 search failed");
        let results2 = handler2
            .search("FIND {Test} RETURNING Account(Id)")
            .await
            .must_msg("Handler2 search failed");

        assert_eq!(results1.search_records.len(), results2.search_records.len());
    }
}