rigg 0.17.0

Configuration-as-code CLI for Azure AI Search and Microsoft Foundry
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
//! Core description dispatch engine.
//!
//! Given a `Change` and its `ResourceKind`, produces a human-readable English
//! description by trying resource-specific patterns first, then falling back
//! to a generic description.

use rigg_core::resources::ResourceKind;
use rigg_diff::{Change, ChangeKind};

use super::helpers::{bool_enabled_text, build_fallback, str_val, val_preview};
use super::index_advanced::describe_index_advanced;
use super::long_text::{describe_long_text_diff, is_long_text_change, long_text_subject};
use super::resource_fields::{describe_index_field, describe_skillset_skill};
use super::resource_fields_extra::{
    describe_agent_tools, describe_alias_index, describe_container, describe_field_mapping,
    describe_indexer_params, describe_kb_ks_ref, describe_ks_blob_params, describe_schedule,
};

pub(super) fn build_description(
    change: &Change,
    kind: ResourceKind,
    name: &str,
    old_label: &str,
    new_label: &str,
) -> String {
    let path = &change.path;
    let kind_name = kind.display_name();

    // A. Whole-resource presence (path = ".")
    if path == "." {
        return match change.kind {
            ChangeKind::Added => {
                format!("{} '{}' only exists {}", kind_name, name, new_label)
            }
            ChangeKind::Removed => {
                format!("{} '{}' only exists {}", kind_name, name, old_label)
            }
            ChangeKind::Modified => format!(
                "{} '{}' differs between {} and {}",
                kind_name, name, old_label, new_label
            ),
        };
    }

    // Try resource-specific patterns first
    if let Some(desc) = try_specific_pattern(change, kind, name, old_label, new_label) {
        return desc;
    }

    // Fallback: generic description
    build_fallback(change, kind_name, name, old_label, new_label)
}

/// Try resource-type-specific and path-pattern-specific descriptions.
fn try_specific_pattern(
    change: &Change,
    kind: ResourceKind,
    name: &str,
    old_label: &str,
    new_label: &str,
) -> Option<String> {
    let path = &change.path;
    let kind_name = kind.display_name();

    // C. Long text properties — line-level diff for modified, full text for added/removed
    if is_long_text_change(change, kind) {
        let subject = long_text_subject(path, kind, name);
        return Some(describe_long_text_diff(
            change, &subject, old_label, new_label,
        ));
    }

    // B. Top-level simple properties
    match (path.as_str(), kind, change.kind) {
        // Description field (all resource types)
        ("description", _, ChangeKind::Modified) => {
            let old_v = str_val(&change.old_value);
            let new_v = str_val(&change.new_value);
            return Some(format!(
                "The description of {} '{}' differs: {} has \"{}\" while {} has \"{}\"",
                kind_name, name, old_label, old_v, new_label, new_v
            ));
        }
        ("description", _, ChangeKind::Added) => {
            let new_v = str_val(&change.new_value);
            return Some(format!(
                "{} '{}' has a description {} (\"{}\") but not {}",
                kind_name, name, new_label, new_v, old_label
            ));
        }
        ("description", _, ChangeKind::Removed) => {
            let old_v = str_val(&change.old_value);
            return Some(format!(
                "{} '{}' has a description {} (\"{}\") but not {}",
                kind_name, name, old_label, old_v, new_label
            ));
        }

        // Agent-specific
        ("model", ResourceKind::Agent, ChangeKind::Modified) => {
            let old_v = str_val(&change.old_value);
            let new_v = str_val(&change.new_value);
            return Some(format!(
                "Agent '{}' uses model '{}' {} but uses '{}' {}",
                name, new_v, new_label, old_v, old_label
            ));
        }
        ("kind", ResourceKind::Agent, ChangeKind::Modified) => {
            let old_v = str_val(&change.old_value);
            let new_v = str_val(&change.new_value);
            return Some(format!(
                "Agent '{}' has kind '{}' {} but kind '{}' {}",
                name, new_v, new_label, old_v, old_label
            ));
        }
        ("temperature", ResourceKind::Agent, ChangeKind::Modified) => {
            let old_v = val_preview(&change.old_value);
            let new_v = val_preview(&change.new_value);
            return Some(format!(
                "Agent '{}' has temperature {} {} (was {} {})",
                name, new_v, new_label, old_v, old_label
            ));
        }
        ("top_p", ResourceKind::Agent, ChangeKind::Modified) => {
            let old_v = val_preview(&change.old_value);
            let new_v = val_preview(&change.new_value);
            return Some(format!(
                "Agent '{}' has top_p {} {} (was {} {})",
                name, new_v, new_label, old_v, old_label
            ));
        }

        // Indexer references
        ("dataSourceName", ResourceKind::Indexer, ChangeKind::Modified) => {
            let old_v = str_val(&change.old_value);
            let new_v = str_val(&change.new_value);
            return Some(format!(
                "Indexer '{}' references data source '{}' {} but '{}' {}",
                name, new_v, new_label, old_v, old_label
            ));
        }
        ("targetIndexName", ResourceKind::Indexer, ChangeKind::Modified) => {
            let old_v = str_val(&change.old_value);
            let new_v = str_val(&change.new_value);
            return Some(format!(
                "Indexer '{}' targets index '{}' {} but '{}' {}",
                name, new_v, new_label, old_v, old_label
            ));
        }
        ("skillsetName", ResourceKind::Indexer, ChangeKind::Modified) => {
            let old_v = str_val(&change.old_value);
            let new_v = str_val(&change.new_value);
            return Some(format!(
                "Indexer '{}' references skillset '{}' {} but '{}' {}",
                name, new_v, new_label, old_v, old_label
            ));
        }
        ("skillsetName", ResourceKind::Indexer, ChangeKind::Added) => {
            let new_v = str_val(&change.new_value);
            return Some(format!(
                "Indexer '{}' references skillset '{}' {} but has no skillset {}",
                name, new_v, new_label, old_label
            ));
        }
        ("skillsetName", ResourceKind::Indexer, ChangeKind::Removed) => {
            let old_v = str_val(&change.old_value);
            return Some(format!(
                "Indexer '{}' references skillset '{}' {} but has no skillset {}",
                name, old_v, old_label, new_label
            ));
        }
        ("disabled", ResourceKind::Indexer, ChangeKind::Modified) => {
            let old_text = bool_enabled_text(&change.old_value);
            let new_text = bool_enabled_text(&change.new_value);
            return Some(format!(
                "Indexer '{}' is {} {} (was {} {})",
                name, new_text, new_label, old_text, old_label
            ));
        }

        // Index scoring
        ("defaultScoringProfile", ResourceKind::Index, ChangeKind::Modified) => {
            let old_v = str_val(&change.old_value);
            let new_v = str_val(&change.new_value);
            return Some(format!(
                "Index '{}' uses default scoring profile '{}' {} (was '{}' {})",
                name, new_v, new_label, old_v, old_label
            ));
        }

        // SynonymMap format
        ("format", ResourceKind::SynonymMap, ChangeKind::Modified) => {
            let old_v = str_val(&change.old_value);
            let new_v = str_val(&change.new_value);
            return Some(format!(
                "Synonym map '{}' has format '{}' {} (was '{}' {})",
                name, new_v, new_label, old_v, old_label
            ));
        }

        // DataSource type
        ("type", ResourceKind::DataSource, ChangeKind::Modified) => {
            let old_v = str_val(&change.old_value);
            let new_v = str_val(&change.new_value);
            return Some(format!(
                "Data source '{}' has type '{}' {} (was '{}' {})",
                name, new_v, new_label, old_v, old_label
            ));
        }

        // Knowledge source properties
        ("indexName", ResourceKind::KnowledgeSource, ChangeKind::Modified) => {
            let old_v = str_val(&change.old_value);
            let new_v = str_val(&change.new_value);
            return Some(format!(
                "Knowledge source '{}' references index '{}' {} but '{}' {}",
                name, new_v, new_label, old_v, old_label
            ));
        }
        ("knowledgeBaseName", ResourceKind::KnowledgeSource, ChangeKind::Modified) => {
            let old_v = str_val(&change.old_value);
            let new_v = str_val(&change.new_value);
            return Some(format!(
                "Knowledge source '{}' belongs to knowledge base '{}' {} but '{}' {}",
                name, new_v, new_label, old_v, old_label
            ));
        }
        ("queryType", ResourceKind::KnowledgeSource, ChangeKind::Modified) => {
            let old_v = str_val(&change.old_value);
            let new_v = str_val(&change.new_value);
            return Some(format!(
                "Knowledge source '{}' uses query type '{}' {} (was '{}' {})",
                name, new_v, new_label, old_v, old_label
            ));
        }
        ("top", ResourceKind::KnowledgeSource, ChangeKind::Modified) => {
            let old_v = val_preview(&change.old_value);
            let new_v = val_preview(&change.new_value);
            return Some(format!(
                "Knowledge source '{}' returns top {} results {} (was {} {})",
                name, new_v, new_label, old_v, old_label
            ));
        }

        _ => {}
    }

    // D. Index fields
    if path.starts_with("fields[") {
        return Some(describe_index_field(
            change, kind, name, old_label, new_label,
        ));
    }

    // E. Skillset skills
    if path.starts_with("skills[") && kind == ResourceKind::Skillset {
        return Some(describe_skillset_skill(change, name, old_label, new_label));
    }

    // F. Indexer field mappings
    if (path.starts_with("fieldMappings[") || path.starts_with("outputFieldMappings["))
        && kind == ResourceKind::Indexer
    {
        return Some(describe_field_mapping(change, name, old_label, new_label));
    }

    // G. Indexer schedule
    if path.starts_with("schedule") && kind == ResourceKind::Indexer {
        return Some(describe_schedule(change, name, old_label, new_label));
    }

    // H. Indexer parameters
    if path.starts_with("parameters") && kind == ResourceKind::Indexer {
        return Some(describe_indexer_params(change, name, old_label, new_label));
    }

    // I. Data source container
    if path.starts_with("container") && kind == ResourceKind::DataSource {
        return Some(describe_container(change, name, old_label, new_label));
    }

    // J. Detection policies
    if (path == "dataChangeDetectionPolicy" || path == "dataDeletionDetectionPolicy")
        && kind == ResourceKind::DataSource
    {
        let policy_type = if path.contains("Change") {
            "change detection"
        } else {
            "deletion detection"
        };
        return Some(match change.kind {
            ChangeKind::Added => format!(
                "Data source '{}' has a {} policy {} but not {}",
                name, policy_type, new_label, old_label
            ),
            ChangeKind::Removed => format!(
                "Data source '{}' has a {} policy {} but not {}",
                name, policy_type, old_label, new_label
            ),
            ChangeKind::Modified => format!(
                "Data source '{}' {} policy differs between {} and {}",
                name, policy_type, old_label, new_label
            ),
        });
    }

    // K. Knowledge base references
    if path.starts_with("knowledgeSources[") && kind == ResourceKind::KnowledgeBase {
        return Some(describe_kb_ks_ref(change, name, old_label, new_label));
    }
    if path == "storageContainer" && kind == ResourceKind::KnowledgeBase {
        let old_v = str_val(&change.old_value);
        let new_v = str_val(&change.new_value);
        return Some(format!(
            "Knowledge base '{}' storage container is '{}' {} (was '{}' {})",
            name, new_v, new_label, old_v, old_label
        ));
    }

    // L. Knowledge source parameters
    if path.starts_with("azureBlobParameters") && kind == ResourceKind::KnowledgeSource {
        return Some(describe_ks_blob_params(change, name, old_label, new_label));
    }
    if path == "selectFields" && kind == ResourceKind::KnowledgeSource {
        let old_v = val_preview(&change.old_value);
        let new_v = val_preview(&change.new_value);
        return Some(format!(
            "Knowledge source '{}' select fields changed: {} {} (was {} {})",
            name, new_v, new_label, old_v, old_label
        ));
    }
    if path == "semanticConfiguration" && kind == ResourceKind::KnowledgeSource {
        let old_v = str_val(&change.old_value);
        let new_v = str_val(&change.new_value);
        return Some(format!(
            "Knowledge source '{}' semantic configuration is '{}' {} (was '{}' {})",
            name, new_v, new_label, old_v, old_label
        ));
    }

    // M. Agent tools
    if path.starts_with("tools") && kind == ResourceKind::Agent {
        return Some(describe_agent_tools(change, name, old_label, new_label));
    }
    if path == "tool_resources" && kind == ResourceKind::Agent {
        return Some(format!(
            "Agent '{}' tool resources differ between {} and {}",
            name, old_label, new_label
        ));
    }
    if path == "metadata" && kind == ResourceKind::Agent {
        return Some(format!(
            "Agent '{}' metadata differs between {} and {}",
            name, old_label, new_label
        ));
    }

    // N. Alias indexes
    if path.starts_with("indexes[") && kind == ResourceKind::Alias {
        return Some(describe_alias_index(change, name, old_label, new_label));
    }

    // O. Index advanced config
    if kind == ResourceKind::Index {
        if let Some(desc) = describe_index_advanced(change, name, old_label, new_label) {
            return Some(desc);
        }
    }

    None
}

// ---------------------------------------------------------------------------
// Tests
// ---------------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::{Value, json};

    // Helper to create a Change
    fn change(path: &str, kind: ChangeKind, old: Option<Value>, new: Option<Value>) -> Change {
        Change {
            path: path.to_string(),
            kind,
            old_value: old,
            new_value: new,
            description: None,
        }
    }

    // === Whole-resource presence tests ===

    #[test]
    fn test_whole_resource_added() {
        let c = change(".", ChangeKind::Added, None, Some(json!({})));
        let desc = build_description(
            &c,
            ResourceKind::Index,
            "products",
            "locally",
            "on the server",
        );
        assert_eq!(desc, "Index 'products' only exists on the server");
    }

    #[test]
    fn test_whole_resource_removed() {
        let c = change(".", ChangeKind::Removed, Some(json!({})), None);
        let desc = build_description(
            &c,
            ResourceKind::Agent,
            "helper",
            "locally",
            "on the server",
        );
        assert_eq!(desc, "Agent 'helper' only exists locally");
    }

    // === Top-level property tests ===

    #[test]
    fn test_description_modified() {
        let c = change(
            "description",
            ChangeKind::Modified,
            Some(json!("old text")),
            Some(json!("new text")),
        );
        let desc = build_description(
            &c,
            ResourceKind::Index,
            "my-index",
            "locally",
            "on the server",
        );
        assert!(desc.contains("description"));
        assert!(desc.contains("old text"));
        assert!(desc.contains("new text"));
        assert!(!desc.contains("\u{2192}")); // no arrow
    }

    #[test]
    fn test_agent_model_changed() {
        let c = change(
            "model",
            ChangeKind::Modified,
            Some(json!("gpt-4")),
            Some(json!("gpt-4o")),
        );
        let desc = build_description(
            &c,
            ResourceKind::Agent,
            "helper",
            "locally",
            "on the server",
        );
        assert!(desc.contains("gpt-4o"));
        assert!(desc.contains("gpt-4"));
    }

    #[test]
    fn test_indexer_disabled_changed() {
        let c = change(
            "disabled",
            ChangeKind::Modified,
            Some(json!(false)),
            Some(json!(true)),
        );
        let desc = build_description(
            &c,
            ResourceKind::Indexer,
            "my-ixer",
            "locally",
            "on the server",
        );
        assert!(desc.contains("disabled"));
        assert!(desc.contains("enabled"));
    }

    // === Cross-environment labels ===

    #[test]
    fn test_cross_env_labels() {
        let c = change(
            "description",
            ChangeKind::Modified,
            Some(json!("old")),
            Some(json!("new")),
        );
        let desc = build_description(&c, ResourceKind::Index, "idx", "on prod", "on staging");
        assert!(desc.contains("on prod"));
        assert!(desc.contains("on staging"));
    }
}