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

//! Data Dictionary Generator.
//!
//! This module provides a utility to generate a Markdown data dictionary
//! for a Salesforce SObject, combining Describe API metadata with optional
//! Field Usage Scanner statistics.
//!
//! This serves as a powerful "Exporter" to document schema directly from the API.

use crate::api::rest_operation::RestOperation;
use crate::auth::Authenticator;
use crate::client::ForceClient;
use crate::error::Result;
use std::collections::HashMap;
use std::fmt::Write;

use super::scanner::FieldUsageScanner;

/// Generator for SObject data dictionaries in Markdown format.
#[derive(Debug)]
pub struct DataDictionary<'a, A: Authenticator> {
    client: &'a ForceClient<A>,
}

impl<'a, A: Authenticator> DataDictionary<'a, A> {
    /// Creates a new data dictionary generator.
    ///
    /// # Arguments
    ///
    /// * `client` - The authenticated Force client.
    #[must_use]
    pub fn new(client: &'a ForceClient<A>) -> Self {
        Self { client }
    }

    /// Generates a Markdown data dictionary for the specified SObject.
    ///
    /// # Arguments
    ///
    /// * `sobject` - The API name of the SObject (e.g., "Account").
    /// * `include_usage` - Whether to scan and include field population statistics.
    ///
    /// # Returns
    ///
    /// A String containing the generated Markdown document.
    pub async fn generate(&self, sobject: &str, include_usage: bool) -> Result<String> {
        let describe = self.client.rest().describe(sobject).await?;

        let mut usage_map = HashMap::new();
        if include_usage {
            let scanner = FieldUsageScanner::new(self.client);
            let usages = scanner.scan(sobject).await?;
            usage_map.reserve(usages.len());
            for usage in usages {
                // ⚡ Bolt: Moving `name` out of `usage` and storing just `percentage` avoids a `.clone()` heap allocation and reduces map memory overhead.
                usage_map.insert(usage.name, usage.percentage);
            }
        }

        let mut md = String::with_capacity(1024);

        // ⚡ Bolt: Use `writeln!` directly to the `md` buffer instead of `format!` and `push_str`
        // to avoid intermediate String heap allocations for the header and each table row.
        let _ = writeln!(md, "# Data Dictionary: {}", describe.label);
        let _ = writeln!(md, "**API Name:** `{}`", describe.name);
        let _ = writeln!(md, "**Custom:** {}", describe.custom);
        md.push('\n');

        md.push_str("## Fields\n\n");

        if include_usage {
            md.push_str("| Label | API Name | Type | Required | Reference To | Populated % |\n");
            md.push_str("|---|---|---|---|---|---|\n");
        } else {
            md.push_str("| Label | API Name | Type | Required | Reference To |\n");
            md.push_str("|---|---|---|---|---|\n");
        }

        let mut fields = describe.fields;
        fields.sort_by(|a, b| crate::schema::cmp_field_names(&a.name, &b.name));

        for field in fields {
            let required = if !field.nillable && !field.defaulted_on_create {
                "Yes"
            } else {
                "No"
            };

            let _ = write!(
                md,
                "| {} | `{}` | {:?} | {} | ",
                field.label, field.name, field.type_, required
            );

            // ⚡ Bolt: Write reference_to directly without allocating a `join(", ")` String.
            let mut first = true;
            for r in &field.reference_to {
                if !first {
                    md.push_str(", ");
                }
                md.push_str(r);
                first = false;
            }

            if include_usage {
                if let Some(&percentage) = usage_map.get(&field.name) {
                    let _ = writeln!(md, " | {:.1}% |", percentage);
                } else {
                    md.push_str(" | N/A |\n");
                }
            } else {
                md.push_str(" |\n");
            }
        }

        Ok(md)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::client::builder;
    use crate::test_support::{MockAuthenticator, Must};
    use serde_json::json;
    use wiremock::matchers::{method, path, query_param};
    use wiremock::{Mock, MockServer, ResponseTemplate};

    #[tokio::test]
    async fn test_generate_dictionary_without_usage() {
        let mock_server = MockServer::start().await;
        let auth = MockAuthenticator::new("token", &mock_server.uri());
        let client = builder().authenticate(auth).build().await.must();

        let id_field = json!({
            "name": "Id", "type": "id", "label": "Account ID", "nillable": false,
            "defaultedOnCreate": true, "referenceTo": [],
            "aggregatable": true, "autoNumber": false, "byteLength": 18, "calculated": false,
            "cascadeDelete": false, "caseSensitive": false, "createable": false, "custom": false,
            "dependentPicklist": false, "deprecatedAndHidden": false, "digits": 0,
            "displayLocationInDecimal": false, "encrypted": false, "externalId": false,
            "filterable": true, "groupable": true, "highScaleNumber": false, "htmlFormatted": false,
            "idLookup": true, "length": 18, "nameField": false, "namePointing": false,
            "permissionable": false, "polymorphicForeignKey": false, "precision": 0,
            "queryByDistance": false, "restrictedDelete": false, "restrictedPicklist": false,
            "scale": 0, "soapType": "tns:ID", "sortable": true, "unique": false, "updateable": false,
            "writeRequiresMasterRead": false
        });

        let name_field = json!({
            "name": "Name", "type": "string", "label": "Account Name", "nillable": false,
            "defaultedOnCreate": false, "referenceTo": ["Account", "Contact"],
            "aggregatable": true, "autoNumber": false, "byteLength": 255, "calculated": false,
            "cascadeDelete": false, "caseSensitive": false, "createable": true, "custom": false,
            "dependentPicklist": false, "deprecatedAndHidden": false, "digits": 0,
            "displayLocationInDecimal": false, "encrypted": false, "externalId": false,
            "filterable": true, "groupable": true, "highScaleNumber": false, "htmlFormatted": false,
            "idLookup": false, "length": 255, "nameField": true, "namePointing": false,
            "permissionable": false, "polymorphicForeignKey": false, "precision": 0,
            "queryByDistance": false, "restrictedDelete": false, "restrictedPicklist": false,
            "scale": 0, "soapType": "xsd:string", "sortable": true, "unique": false, "updateable": true,
            "writeRequiresMasterRead": false
        });

        let describe_json = json!({
            "name": "Account", "label": "Account", "custom": true, "queryable": true,
            "activateable": false, "createable": true, "customSetting": false, "deletable": true,
            "deprecatedAndHidden": false, "feedEnabled": true, "hasSubtypes": false,
            "isSubtype": false, "keyPrefix": "001", "labelPlural": "Accounts", "layoutable": true,
            "mergeable": true, "mruEnabled": true, "replicateable": true, "retrieveable": true,
            "searchable": true, "triggerable": true, "undeletable": true, "updateable": true,
            "urls": {}, "childRelationships": [], "recordTypeInfos": [],
            "fields": [id_field, name_field]
        });

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

        let dict = DataDictionary::new(&client);
        let md = dict.generate("Account", false).await.must();

        assert!(md.contains("# Data Dictionary: Account"));
        assert!(md.contains("**Custom:** true"));
        // Without usage, should not have Populated % column
        assert!(!md.contains("Populated %"));
        // Check the table has 5 columns, not 6
        assert!(md.contains("| Label | API Name | Type | Required | Reference To |"));
        // Check that multiple referenceTo values are comma-separated
        assert!(md.contains("Account, Contact"));
    }

    #[tokio::test]
    async fn test_generate_dictionary() {
        let mock_server = MockServer::start().await;
        let auth = MockAuthenticator::new("token", &mock_server.uri());
        let client = builder().authenticate(auth).build().await.must();

        let id_field = json!({
            "name": "Id", "type": "id", "label": "Account ID", "nillable": false,
            "defaultedOnCreate": true, "referenceTo": [],
            // Padding required fields for parsing
            "aggregatable": true, "autoNumber": false, "byteLength": 18, "calculated": false,
            "cascadeDelete": false, "caseSensitive": false, "createable": false, "custom": false,
            "dependentPicklist": false, "deprecatedAndHidden": false, "digits": 0,
            "displayLocationInDecimal": false, "encrypted": false, "externalId": false,
            "filterable": true, "groupable": true, "highScaleNumber": false, "htmlFormatted": false,
            "idLookup": true, "length": 18, "nameField": false, "namePointing": false,
            "permissionable": false, "polymorphicForeignKey": false, "precision": 0,
            "queryByDistance": false, "restrictedDelete": false, "restrictedPicklist": false,
            "scale": 0, "soapType": "tns:ID", "sortable": true, "unique": false, "updateable": false,
            "writeRequiresMasterRead": false
        });

        let name_field = json!({
            "name": "Name", "type": "string", "label": "Account Name", "nillable": false,
            "defaultedOnCreate": false, "referenceTo": [],
            // Padding
            "aggregatable": true, "autoNumber": false, "byteLength": 255, "calculated": false,
            "cascadeDelete": false, "caseSensitive": false, "createable": true, "custom": false,
            "dependentPicklist": false, "deprecatedAndHidden": false, "digits": 0,
            "displayLocationInDecimal": false, "encrypted": false, "externalId": false,
            "filterable": true, "groupable": true, "highScaleNumber": false, "htmlFormatted": false,
            "idLookup": false, "length": 255, "nameField": true, "namePointing": false,
            "permissionable": false, "polymorphicForeignKey": false, "precision": 0,
            "queryByDistance": false, "restrictedDelete": false, "restrictedPicklist": false,
            "scale": 0, "soapType": "xsd:string", "sortable": true, "unique": false, "updateable": true,
            "writeRequiresMasterRead": false
        });

        let parent_id_field = json!({
            "name": "ParentId", "type": "reference", "label": "Parent Account ID", "nillable": true,
            "defaultedOnCreate": false, "referenceTo": ["Account"],
            // Padding
            "aggregatable": true, "autoNumber": false, "byteLength": 18, "calculated": false,
            "cascadeDelete": false, "caseSensitive": false, "createable": true, "custom": false,
            "dependentPicklist": false, "deprecatedAndHidden": false, "digits": 0,
            "displayLocationInDecimal": false, "encrypted": false, "externalId": false,
            "filterable": true, "groupable": true, "highScaleNumber": false, "htmlFormatted": false,
            "idLookup": false, "length": 18, "nameField": false, "namePointing": false,
            "permissionable": false, "polymorphicForeignKey": false, "precision": 0,
            "queryByDistance": false, "restrictedDelete": false, "restrictedPicklist": false,
            "scale": 0, "soapType": "tns:ID", "sortable": true, "unique": false, "updateable": true,
            "writeRequiresMasterRead": false
        });

        let describe_json = json!({
            "name": "Account", "label": "Account", "custom": false, "queryable": true,
            "activateable": false, "createable": true, "customSetting": false, "deletable": true,
            "deprecatedAndHidden": false, "feedEnabled": true, "hasSubtypes": false,
            "isSubtype": false, "keyPrefix": "001", "labelPlural": "Accounts", "layoutable": true,
            "mergeable": true, "mruEnabled": true, "replicateable": true, "retrieveable": true,
            "searchable": true, "triggerable": true, "undeletable": true, "updateable": true,
            "urls": {}, "childRelationships": [], "recordTypeInfos": [],
            "fields": [id_field, name_field, parent_id_field]
        });

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

        let query_json = json!({
            "totalSize": 1, "done": true,
            "records": [{
                "attributes": { "type": "AggregateResult", "url": "..." },
                "total": 100, "f0": 100, "f1": 95, "f2": 25
            }]
        });

        Mock::given(method("GET"))
            .and(path("/services/data/v60.0/query"))
            .and(query_param("q", "SELECT COUNT(Id) total, COUNT(Id) f0, COUNT(Name) f1, COUNT(ParentId) f2 FROM Account"))
            .respond_with(ResponseTemplate::new(200).set_body_json(query_json))
            .mount(&mock_server)
            .await;

        let dict = DataDictionary::new(&client);
        let md = dict.generate("Account", true).await.must();

        assert!(md.contains("# Data Dictionary: Account"));
        assert!(md.contains("**API Name:** `Account`"));
        assert!(md.contains("| Account ID | `Id` | Id | No |  | 100.0% |"));
        assert!(md.contains("| Account Name | `Name` | String | Yes |  | 95.0% |"));
        assert!(
            md.contains("| Parent Account ID | `ParentId` | Reference | No | Account | 25.0% |")
        );
    }
}