mockforge-http 0.3.116

HTTP/REST protocol support for MockForge
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
use axum::{
    extract::{Path, Query, State},
    http::StatusCode,
    response::Json,
};
use mockforge_core::proxy::config::{BodyTransform, BodyTransformRule, TransformOperation};
use serde::{Deserialize, Serialize};

use super::{default_true, ManagementState};

/// Request body for creating/updating proxy replacement rules
#[derive(Debug, Deserialize, Serialize)]
pub struct ProxyRuleRequest {
    /// URL pattern to match (supports wildcards like "/api/users/*")
    pub pattern: String,
    /// Rule type: "request" or "response"
    #[serde(rename = "type")]
    pub rule_type: String,
    /// Optional status code filter for response rules
    #[serde(default)]
    pub status_codes: Vec<u16>,
    /// Body transformations to apply
    pub body_transforms: Vec<BodyTransformRequest>,
    /// Whether this rule is enabled
    #[serde(default = "default_true")]
    pub enabled: bool,
}

/// Request body for individual body transformations
#[derive(Debug, Deserialize, Serialize)]
pub struct BodyTransformRequest {
    /// JSONPath expression to target (e.g., "$.userId", "$.email")
    pub path: String,
    /// Replacement value (supports template expansion like "{{uuid}}", "{{faker.email}}")
    pub replace: String,
    /// Operation to perform: "replace", "add", or "remove"
    #[serde(default)]
    pub operation: String,
}

/// Response format for proxy rules
#[derive(Debug, Serialize)]
pub struct ProxyRuleResponse {
    /// Rule ID (index in the array)
    pub id: usize,
    /// URL pattern
    pub pattern: String,
    /// Rule type
    #[serde(rename = "type")]
    pub rule_type: String,
    /// Status codes (for response rules)
    pub status_codes: Vec<u16>,
    /// Body transformations
    pub body_transforms: Vec<BodyTransformRequest>,
    /// Whether enabled
    pub enabled: bool,
}

/// List all proxy replacement rules
pub(crate) async fn list_proxy_rules(
    State(state): State<ManagementState>,
) -> Result<Json<serde_json::Value>, StatusCode> {
    let proxy_config = match &state.proxy_config {
        Some(config) => config,
        None => {
            return Ok(Json(serde_json::json!({
                "error": "Proxy not configured. Proxy config not available."
            })));
        }
    };

    let config = proxy_config.read().await;

    let mut rules: Vec<ProxyRuleResponse> = Vec::new();

    // Add request replacement rules
    for (idx, rule) in config.request_replacements.iter().enumerate() {
        rules.push(ProxyRuleResponse {
            id: idx,
            pattern: rule.pattern.clone(),
            rule_type: "request".to_string(),
            status_codes: Vec::new(),
            body_transforms: rule
                .body_transforms
                .iter()
                .map(|t| BodyTransformRequest {
                    path: t.path.clone(),
                    replace: t.replace.clone(),
                    operation: format!("{:?}", t.operation).to_lowercase(),
                })
                .collect(),
            enabled: rule.enabled,
        });
    }

    // Add response replacement rules
    let request_count = config.request_replacements.len();
    for (idx, rule) in config.response_replacements.iter().enumerate() {
        rules.push(ProxyRuleResponse {
            id: request_count + idx,
            pattern: rule.pattern.clone(),
            rule_type: "response".to_string(),
            status_codes: rule.status_codes.clone(),
            body_transforms: rule
                .body_transforms
                .iter()
                .map(|t| BodyTransformRequest {
                    path: t.path.clone(),
                    replace: t.replace.clone(),
                    operation: format!("{:?}", t.operation).to_lowercase(),
                })
                .collect(),
            enabled: rule.enabled,
        });
    }

    Ok(Json(serde_json::json!({
        "rules": rules
    })))
}

/// Create a new proxy replacement rule
pub(crate) async fn create_proxy_rule(
    State(state): State<ManagementState>,
    Json(request): Json<ProxyRuleRequest>,
) -> Result<Json<serde_json::Value>, StatusCode> {
    let proxy_config = match &state.proxy_config {
        Some(config) => config,
        None => {
            return Ok(Json(serde_json::json!({
                "error": "Proxy not configured. Proxy config not available."
            })));
        }
    };

    // Validate request
    if request.body_transforms.is_empty() {
        return Ok(Json(serde_json::json!({
            "error": "At least one body transform is required"
        })));
    }

    let body_transforms: Vec<BodyTransform> = request
        .body_transforms
        .iter()
        .map(|t| {
            let op = match t.operation.as_str() {
                "replace" => TransformOperation::Replace,
                "add" => TransformOperation::Add,
                "remove" => TransformOperation::Remove,
                _ => TransformOperation::Replace,
            };
            BodyTransform {
                path: t.path.clone(),
                replace: t.replace.clone(),
                operation: op,
            }
        })
        .collect();

    let new_rule = BodyTransformRule {
        pattern: request.pattern.clone(),
        status_codes: request.status_codes.clone(),
        body_transforms,
        enabled: request.enabled,
    };

    let mut config = proxy_config.write().await;

    let rule_id = if request.rule_type == "request" {
        config.request_replacements.push(new_rule);
        config.request_replacements.len() - 1
    } else if request.rule_type == "response" {
        config.response_replacements.push(new_rule);
        config.request_replacements.len() + config.response_replacements.len() - 1
    } else {
        return Ok(Json(serde_json::json!({
            "error": format!("Invalid rule type: {}. Must be 'request' or 'response'", request.rule_type)
        })));
    };

    Ok(Json(serde_json::json!({
        "id": rule_id,
        "message": "Rule created successfully"
    })))
}

/// Get a specific proxy replacement rule
pub(crate) async fn get_proxy_rule(
    State(state): State<ManagementState>,
    Path(id): Path<String>,
) -> Result<Json<serde_json::Value>, StatusCode> {
    let proxy_config = match &state.proxy_config {
        Some(config) => config,
        None => {
            return Ok(Json(serde_json::json!({
                "error": "Proxy not configured. Proxy config not available."
            })));
        }
    };

    let config = proxy_config.read().await;
    let rule_id: usize = match id.parse() {
        Ok(id) => id,
        Err(_) => {
            return Ok(Json(serde_json::json!({
                "error": format!("Invalid rule ID: {}", id)
            })));
        }
    };

    let request_count = config.request_replacements.len();

    if rule_id < request_count {
        // Request rule
        let rule = &config.request_replacements[rule_id];
        Ok(Json(serde_json::json!({
            "id": rule_id,
            "pattern": rule.pattern,
            "type": "request",
            "status_codes": [],
            "body_transforms": rule.body_transforms.iter().map(|t| serde_json::json!({
                "path": t.path,
                "replace": t.replace,
                "operation": format!("{:?}", t.operation).to_lowercase()
            })).collect::<Vec<_>>(),
            "enabled": rule.enabled
        })))
    } else if rule_id < request_count + config.response_replacements.len() {
        // Response rule
        let response_idx = rule_id - request_count;
        let rule = &config.response_replacements[response_idx];
        Ok(Json(serde_json::json!({
            "id": rule_id,
            "pattern": rule.pattern,
            "type": "response",
            "status_codes": rule.status_codes,
            "body_transforms": rule.body_transforms.iter().map(|t| serde_json::json!({
                "path": t.path,
                "replace": t.replace,
                "operation": format!("{:?}", t.operation).to_lowercase()
            })).collect::<Vec<_>>(),
            "enabled": rule.enabled
        })))
    } else {
        Ok(Json(serde_json::json!({
            "error": format!("Rule ID {} not found", rule_id)
        })))
    }
}

/// Update a proxy replacement rule
pub(crate) async fn update_proxy_rule(
    State(state): State<ManagementState>,
    Path(id): Path<String>,
    Json(request): Json<ProxyRuleRequest>,
) -> Result<Json<serde_json::Value>, StatusCode> {
    let proxy_config = match &state.proxy_config {
        Some(config) => config,
        None => {
            return Ok(Json(serde_json::json!({
                "error": "Proxy not configured. Proxy config not available."
            })));
        }
    };

    let mut config = proxy_config.write().await;
    let rule_id: usize = match id.parse() {
        Ok(id) => id,
        Err(_) => {
            return Ok(Json(serde_json::json!({
                "error": format!("Invalid rule ID: {}", id)
            })));
        }
    };

    let body_transforms: Vec<BodyTransform> = request
        .body_transforms
        .iter()
        .map(|t| {
            let op = match t.operation.as_str() {
                "replace" => TransformOperation::Replace,
                "add" => TransformOperation::Add,
                "remove" => TransformOperation::Remove,
                _ => TransformOperation::Replace,
            };
            BodyTransform {
                path: t.path.clone(),
                replace: t.replace.clone(),
                operation: op,
            }
        })
        .collect();

    let updated_rule = BodyTransformRule {
        pattern: request.pattern.clone(),
        status_codes: request.status_codes.clone(),
        body_transforms,
        enabled: request.enabled,
    };

    let request_count = config.request_replacements.len();

    if rule_id < request_count {
        // Update request rule
        config.request_replacements[rule_id] = updated_rule;
    } else if rule_id < request_count + config.response_replacements.len() {
        // Update response rule
        let response_idx = rule_id - request_count;
        config.response_replacements[response_idx] = updated_rule;
    } else {
        return Ok(Json(serde_json::json!({
            "error": format!("Rule ID {} not found", rule_id)
        })));
    }

    Ok(Json(serde_json::json!({
        "id": rule_id,
        "message": "Rule updated successfully"
    })))
}

/// Delete a proxy replacement rule
pub(crate) async fn delete_proxy_rule(
    State(state): State<ManagementState>,
    Path(id): Path<String>,
) -> Result<Json<serde_json::Value>, StatusCode> {
    let proxy_config = match &state.proxy_config {
        Some(config) => config,
        None => {
            return Ok(Json(serde_json::json!({
                "error": "Proxy not configured. Proxy config not available."
            })));
        }
    };

    let mut config = proxy_config.write().await;
    let rule_id: usize = match id.parse() {
        Ok(id) => id,
        Err(_) => {
            return Ok(Json(serde_json::json!({
                "error": format!("Invalid rule ID: {}", id)
            })));
        }
    };

    let request_count = config.request_replacements.len();

    if rule_id < request_count {
        // Delete request rule
        config.request_replacements.remove(rule_id);
    } else if rule_id < request_count + config.response_replacements.len() {
        // Delete response rule
        let response_idx = rule_id - request_count;
        config.response_replacements.remove(response_idx);
    } else {
        return Ok(Json(serde_json::json!({
            "error": format!("Rule ID {} not found", rule_id)
        })));
    }

    Ok(Json(serde_json::json!({
        "id": rule_id,
        "message": "Rule deleted successfully"
    })))
}

/// Get proxy rules and transformation configuration for inspection
pub(crate) async fn get_proxy_inspect(
    State(state): State<ManagementState>,
    Query(params): Query<std::collections::HashMap<String, String>>,
) -> Result<Json<serde_json::Value>, StatusCode> {
    let limit: usize = params.get("limit").and_then(|s| s.parse().ok()).unwrap_or(50);
    let offset: usize = params.get("offset").and_then(|s| s.parse().ok()).unwrap_or(0);

    let proxy_config = match &state.proxy_config {
        Some(config) => config.read().await,
        None => {
            return Ok(Json(serde_json::json!({
                "error": "Proxy not configured. Proxy config not available."
            })));
        }
    };

    let mut rules = Vec::new();
    for (idx, rule) in proxy_config.request_replacements.iter().enumerate() {
        rules.push(serde_json::json!({
            "id": idx,
            "kind": "request",
            "pattern": rule.pattern,
            "enabled": rule.enabled,
            "status_codes": rule.status_codes,
            "transform_count": rule.body_transforms.len(),
            "transforms": rule.body_transforms.iter().map(|t| serde_json::json!({
                "path": t.path,
                "operation": t.operation,
                "replace": t.replace
            })).collect::<Vec<_>>()
        }));
    }
    let request_rule_count = rules.len();
    for (idx, rule) in proxy_config.response_replacements.iter().enumerate() {
        rules.push(serde_json::json!({
            "id": request_rule_count + idx,
            "kind": "response",
            "pattern": rule.pattern,
            "enabled": rule.enabled,
            "status_codes": rule.status_codes,
            "transform_count": rule.body_transforms.len(),
            "transforms": rule.body_transforms.iter().map(|t| serde_json::json!({
                "path": t.path,
                "operation": t.operation,
                "replace": t.replace
            })).collect::<Vec<_>>()
        }));
    }

    let total = rules.len();
    let paged_rules: Vec<_> = rules.into_iter().skip(offset).take(limit).collect();

    Ok(Json(serde_json::json!({
        "enabled": proxy_config.enabled,
        "target_url": proxy_config.target_url,
        "prefix": proxy_config.prefix,
        "timeout_seconds": proxy_config.timeout_seconds,
        "follow_redirects": proxy_config.follow_redirects,
        "passthrough_by_default": proxy_config.passthrough_by_default,
        "rules": paged_rules,
        "request_rule_count": request_rule_count,
        "response_rule_count": total.saturating_sub(request_rule_count),
        "limit": limit,
        "offset": offset,
        "total": total
    })))
}