http-client-vcr 1.1.0

Record http request and responses for testing
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
use crate::form_data::{analyze_form_data, filter_form_data};
use crate::serializable::{SerializableRequest, SerializableResponse};
use regex::Regex;
use serde_json::{Map, Value};
use std::collections::HashMap;
use std::fmt::Debug;

pub trait Filter: Debug + Send + Sync {
    fn filter_request(&self, request: &mut SerializableRequest);
    fn filter_response(&self, response: &mut SerializableResponse);
}

#[derive(Debug)]
pub struct FilterChain {
    filters: Vec<Box<dyn Filter>>,
}

impl FilterChain {
    pub fn new() -> Self {
        Self {
            filters: Vec::new(),
        }
    }

    pub fn add_filter(mut self, filter: Box<dyn Filter>) -> Self {
        self.filters.push(filter);
        self
    }

    pub fn filter_request(&self, request: &mut SerializableRequest) {
        for filter in &self.filters {
            filter.filter_request(request);
        }
    }

    pub fn filter_response(&self, response: &mut SerializableResponse) {
        for filter in &self.filters {
            filter.filter_response(response);
        }
    }
}

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

#[derive(Debug)]
pub struct HeaderFilter {
    headers_to_remove: Vec<String>,
    headers_to_replace: HashMap<String, String>,
}

impl HeaderFilter {
    pub fn new() -> Self {
        Self {
            headers_to_remove: Vec::new(),
            headers_to_replace: HashMap::new(),
        }
    }

    pub fn remove_header(mut self, header: impl Into<String>) -> Self {
        self.headers_to_remove.push(header.into());
        self
    }

    pub fn replace_header(
        mut self,
        header: impl Into<String>,
        replacement: impl Into<String>,
    ) -> Self {
        self.headers_to_replace
            .insert(header.into(), replacement.into());
        self
    }

    pub fn remove_auth_headers(self) -> Self {
        self.remove_header("Authorization")
            .remove_header("Cookie")
            .remove_header("Set-Cookie")
            .remove_header("X-API-Key")
            .remove_header("X-Auth-Token")
    }

    fn filter_headers(&self, headers: &mut HashMap<String, Vec<String>>) {
        for header in &self.headers_to_remove {
            headers.remove(header);
        }

        for (header, replacement) in &self.headers_to_replace {
            if let Some(values) = headers.get_mut(header) {
                values.clear();
                values.push(replacement.clone());
            }
        }
    }
}

impl Filter for HeaderFilter {
    fn filter_request(&self, request: &mut SerializableRequest) {
        self.filter_headers(&mut request.headers);
    }

    fn filter_response(&self, response: &mut SerializableResponse) {
        self.filter_headers(&mut response.headers);
    }
}

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

#[derive(Debug)]
pub struct BodyFilter {
    json_keys_to_remove: Vec<String>,
    json_keys_to_replace: HashMap<String, String>,
    regex_replacements: Vec<(Regex, String)>,
}

impl BodyFilter {
    pub fn new() -> Self {
        Self {
            json_keys_to_remove: Vec::new(),
            json_keys_to_replace: HashMap::new(),
            regex_replacements: Vec::new(),
        }
    }

    pub fn remove_json_key(mut self, key: impl Into<String>) -> Self {
        self.json_keys_to_remove.push(key.into());
        self
    }

    pub fn replace_json_key(
        mut self,
        key: impl Into<String>,
        replacement: impl Into<String>,
    ) -> Self {
        self.json_keys_to_replace
            .insert(key.into(), replacement.into());
        self
    }

    pub fn replace_regex(
        mut self,
        pattern: &str,
        replacement: impl Into<String>,
    ) -> Result<Self, regex::Error> {
        let regex = Regex::new(pattern)?;
        self.regex_replacements.push((regex, replacement.into()));
        Ok(self)
    }

    pub fn remove_common_sensitive_keys(self) -> Self {
        self.remove_json_key("password")
            .remove_json_key("token")
            .remove_json_key("api_key")
            .remove_json_key("secret")
            .remove_json_key("access_token")
            .remove_json_key("refresh_token")
            .remove_json_key("client_secret")
    }

    fn filter_json_object(&self, obj: &mut Map<String, Value>) {
        for key in &self.json_keys_to_remove {
            obj.remove(key);
        }

        for (key, replacement) in &self.json_keys_to_replace {
            if obj.contains_key(key) {
                obj.insert(key.clone(), Value::String(replacement.clone()));
            }
        }

        for (_, value) in obj.iter_mut() {
            self.filter_json_value(value);
        }
    }

    fn filter_json_value(&self, value: &mut Value) {
        match value {
            Value::Object(obj) => self.filter_json_object(obj),
            Value::Array(arr) => {
                for item in arr.iter_mut() {
                    self.filter_json_value(item);
                }
            }
            _ => {}
        }
    }

    fn filter_body(&self, body: &mut Option<String>) {
        if let Some(body_str) = body {
            if let Ok(mut json_value) = serde_json::from_str::<Value>(body_str) {
                // Handle JSON body
                self.filter_json_value(&mut json_value);
                if let Ok(filtered_json) = serde_json::to_string(&json_value) {
                    *body_str = filtered_json;
                }
            } else if body_str.contains('=') && body_str.contains('&') {
                // Handle form-encoded body with smart form data parsing
                let filtered = filter_form_data(body_str, "[FILTERED]");
                *body_str = filtered;
            } else {
                // Handle other text formats with regex
                for (regex, replacement) in &self.regex_replacements {
                    *body_str = regex.replace_all(body_str, replacement).to_string();
                }
            }
        }
    }
}

impl Filter for BodyFilter {
    fn filter_request(&self, request: &mut SerializableRequest) {
        self.filter_body(&mut request.body);
    }

    fn filter_response(&self, response: &mut SerializableResponse) {
        self.filter_body(&mut response.body);
    }
}

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

#[derive(Debug)]
pub struct UrlFilter {
    query_params_to_remove: Vec<String>,
    query_params_to_replace: HashMap<String, String>,
}

impl UrlFilter {
    pub fn new() -> Self {
        Self {
            query_params_to_remove: Vec::new(),
            query_params_to_replace: HashMap::new(),
        }
    }

    pub fn remove_query_param(mut self, param: impl Into<String>) -> Self {
        self.query_params_to_remove.push(param.into());
        self
    }

    pub fn replace_query_param(
        mut self,
        param: impl Into<String>,
        replacement: impl Into<String>,
    ) -> Self {
        self.query_params_to_replace
            .insert(param.into(), replacement.into());
        self
    }

    pub fn remove_common_sensitive_params(self) -> Self {
        self.remove_query_param("api_key")
            .remove_query_param("token")
            .remove_query_param("access_token")
            .remove_query_param("key")
    }
}

impl Filter for UrlFilter {
    fn filter_request(&self, request: &mut SerializableRequest) {
        if let Ok(mut url) = url::Url::parse(&request.url) {
            let mut query_pairs: Vec<(String, String)> = url
                .query_pairs()
                .map(|(k, v)| (k.to_string(), v.to_string()))
                .collect();

            query_pairs.retain(|(key, _)| !self.query_params_to_remove.contains(key));

            for (key, value) in &mut query_pairs {
                if let Some(replacement) = self.query_params_to_replace.get(key) {
                    *value = replacement.clone();
                }
            }

            url.query_pairs_mut().clear();
            for (key, value) in query_pairs {
                url.query_pairs_mut().append_pair(&key, &value);
            }

            request.url = url.to_string();
        }
    }

    fn filter_response(&self, _response: &mut SerializableResponse) {
        // URL filtering only applies to requests
    }
}

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

#[derive(Debug)]
pub struct SmartFormFilter {
    replacement_pattern: String,
    verbose: bool,
}

impl SmartFormFilter {
    pub fn new() -> Self {
        Self {
            replacement_pattern: "[FILTERED]".to_string(),
            verbose: false,
        }
    }

    pub fn with_replacement_pattern(mut self, pattern: impl Into<String>) -> Self {
        self.replacement_pattern = pattern.into();
        self
    }

    pub fn verbose(mut self) -> Self {
        self.verbose = true;
        self
    }

    fn filter_form_body(&self, body: &mut Option<String>) {
        if let Some(body_str) = body {
            // Check if this looks like form data
            if body_str.contains('=') && (body_str.contains('&') || !body_str.contains(' ')) {
                if self.verbose {
                    println!("🔍 Analyzing form data in request body...");
                    let analysis = analyze_form_data(body_str);
                    analysis.print_summary();
                }

                let filtered = filter_form_data(body_str, &self.replacement_pattern);
                *body_str = filtered;

                if self.verbose {
                    println!("✅ Form data filtered");
                }
            }
        }
    }
}

impl Filter for SmartFormFilter {
    fn filter_request(&self, request: &mut SerializableRequest) {
        self.filter_form_body(&mut request.body);
    }

    fn filter_response(&self, _response: &mut SerializableResponse) {
        // Form filtering only applies to request bodies typically
    }
}

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

#[derive(Debug)]
pub struct CustomFilter<F>
where
    F: Fn(&mut SerializableRequest, &mut SerializableResponse) + Send + Sync + Debug,
{
    filter_fn: F,
}

impl<F> CustomFilter<F>
where
    F: Fn(&mut SerializableRequest, &mut SerializableResponse) + Send + Sync + Debug,
{
    pub fn new(filter_fn: F) -> Self {
        Self { filter_fn }
    }
}

impl<F> Filter for CustomFilter<F>
where
    F: Fn(&mut SerializableRequest, &mut SerializableResponse) + Send + Sync + Debug,
{
    fn filter_request(&self, request: &mut SerializableRequest) {
        let mut dummy_response = SerializableResponse {
            status: 200,
            headers: HashMap::new(),
            body: None,
            body_base64: None,
            version: "Http1_1".to_string(),
        };
        (self.filter_fn)(request, &mut dummy_response);
    }

    fn filter_response(&self, response: &mut SerializableResponse) {
        let mut dummy_request = SerializableRequest {
            method: "GET".to_string(),
            url: "https://example.com".to_string(),
            headers: HashMap::new(),
            body: None,
            body_base64: None,
            version: "Http1_1".to_string(),
        };
        (self.filter_fn)(&mut dummy_request, response);
    }
}