jiq 3.21.0

Interactive JSON query tool with real-time output
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
//! Tests for entry context detection (to_entries, with_entries)

use super::common::{DEFAULT_ARRAY_SAMPLE_SIZE, empty_field_names, field_names_from, tracker_for};
use crate::autocomplete::*;
use crate::query::ResultType;
use serde_json::Value;
use std::sync::Arc;

fn create_object_json() -> (Arc<Value>, ResultType) {
    let json = r#"{"name": "alice", "age": 30, "active": true}"#;
    let parsed = serde_json::from_str::<Value>(json).unwrap();
    (Arc::new(parsed), ResultType::Object)
}

// ============================================================================
// detect_entry_context unit tests
// ============================================================================

mod detect_entry_context_tests {
    use crate::autocomplete::{EntryContext, detect_entry_context};

    #[test]
    fn test_no_entry_context_at_root() {
        assert_eq!(detect_entry_context(".", 1), EntryContext::None);
        assert_eq!(detect_entry_context(".name", 5), EntryContext::None);
    }

    #[test]
    fn test_with_entries_direct_context() {
        assert_eq!(
            detect_entry_context("with_entries(.", 14),
            EntryContext::Direct
        );
        assert_eq!(
            detect_entry_context("with_entries(.key", 17),
            EntryContext::Direct
        );
    }

    #[test]
    fn test_with_entries_after_pipe() {
        assert_eq!(
            detect_entry_context("with_entries(. | .", 18),
            EntryContext::Direct
        );
    }

    #[test]
    fn test_with_entries_opaque_after_value_pipe() {
        assert_eq!(
            detect_entry_context("with_entries(.value | .", 23),
            EntryContext::OpaqueValue
        );
    }

    #[test]
    fn test_with_entries_opaque_after_value_map() {
        assert_eq!(
            detect_entry_context("with_entries(.value | map(.", 27),
            EntryContext::OpaqueValue
        );
    }

    #[test]
    fn test_with_entries_direct_value_without_transformation() {
        // Just .value without further navigation is Direct (we can still suggest .key/.value)
        assert_eq!(
            detect_entry_context("with_entries(.value", 19),
            EntryContext::Direct
        );
    }

    #[test]
    fn test_with_entries_none_after_value_field_access() {
        // After .value.field, we've navigated into the value structure
        assert_eq!(
            detect_entry_context("with_entries(.value.", 20),
            EntryContext::None
        );
    }

    #[test]
    fn test_with_entries_closed_no_context() {
        assert_eq!(
            detect_entry_context("with_entries(.value) | .", 24),
            EntryContext::None
        );
    }

    #[test]
    fn test_with_entries_nested() {
        assert_eq!(
            detect_entry_context("with_entries(with_entries(.", 27),
            EntryContext::Direct
        );
    }

    #[test]
    fn test_with_entries_with_whitespace() {
        assert_eq!(
            detect_entry_context("with_entries (.", 15),
            EntryContext::Direct
        );
    }

    #[test]
    fn test_to_entries_with_array_iteration() {
        assert_eq!(
            detect_entry_context("to_entries | .[].", 17),
            EntryContext::Direct
        );
    }

    #[test]
    fn test_to_entries_with_map() {
        assert_eq!(
            detect_entry_context("to_entries | map(.", 18),
            EntryContext::Direct
        );
    }

    #[test]
    fn test_to_entries_with_map_value_pipe() {
        assert_eq!(
            detect_entry_context("to_entries | map(.value | .", 27),
            EntryContext::OpaqueValue
        );
    }

    #[test]
    fn test_to_entries_opaque_with_nested_select() {
        assert_eq!(
            detect_entry_context("to_entries | map(.value | select(.", 34),
            EntryContext::OpaqueValue
        );
    }

    #[test]
    fn test_to_entries_complex_opaque_pattern() {
        // The pattern from the plan: to_entries | map({k: .key, v: .value | map(select(.
        assert_eq!(
            detect_entry_context("to_entries | map({k: .key, v: .value | map(select(.", 51),
            EntryContext::OpaqueValue
        );
    }

    #[test]
    fn test_string_literal_false_positive_prevention() {
        // .value inside a string should not trigger entry context
        assert_eq!(
            detect_entry_context("with_entries(\"has.value\" | .", 28),
            EntryContext::Direct
        );
    }

    #[test]
    fn test_to_entries_in_string_no_detection() {
        // "to_entries" in a string should not trigger detection
        assert_eq!(
            detect_entry_context("\"to_entries\" | .[].", 19),
            EntryContext::None
        );
    }

    #[test]
    fn test_values_not_value() {
        // .values (plural) should not trigger entry context
        assert_eq!(
            detect_entry_context("with_entries(.values", 20),
            EntryContext::Direct
        );
    }

    #[test]
    fn test_nested_functions_trigger_opaque() {
        let nested_patterns = [
            ("with_entries(.value | map(.", EntryContext::OpaqueValue),
            ("with_entries(.value | select(.", EntryContext::OpaqueValue),
            ("with_entries(.value | sort_by(.", EntryContext::OpaqueValue),
            (
                "with_entries(.value | group_by(.",
                EntryContext::OpaqueValue,
            ),
            (
                "with_entries(.value | unique_by(.",
                EntryContext::OpaqueValue,
            ),
        ];

        for (query, expected) in nested_patterns {
            assert_eq!(
                detect_entry_context(query, query.len()),
                expected,
                "Pattern '{}' should return {:?}",
                query,
                expected
            );
        }
    }
}

// ============================================================================
// Integration tests - get_suggestions with entry context
// ============================================================================

#[test]
fn test_to_entries_array_iteration_suggests_key_value() {
    let (parsed, result_type) = create_object_json();
    let query = "to_entries | .[].";
    let tracker = tracker_for(query);

    let suggestions = get_suggestions(
        query,
        query.len(),
        Some(parsed.clone()),
        Some(result_type.clone()),
        Some(parsed),
        empty_field_names(),
        &tracker,
        DEFAULT_ARRAY_SAMPLE_SIZE,
    );

    // No leading dot because user already typed the dot in ".[].""
    assert!(
        suggestions.iter().any(|s| s.text == "key"),
        "Should suggest 'key' for to_entries | .[]."
    );
    assert!(
        suggestions.iter().any(|s| s.text == "value"),
        "Should suggest 'value' for to_entries | .[]."
    );
}

#[test]
fn test_to_entries_map_suggests_key_value() {
    let (parsed, result_type) = create_object_json();
    let query = "to_entries | map(.";
    let tracker = tracker_for(query);

    let suggestions = get_suggestions(
        query,
        query.len(),
        Some(parsed.clone()),
        Some(result_type.clone()),
        Some(parsed),
        empty_field_names(),
        &tracker,
        DEFAULT_ARRAY_SAMPLE_SIZE,
    );

    assert!(
        suggestions.iter().any(|s| s.text == ".key"),
        "Should suggest '.key' for to_entries | map(."
    );
    assert!(
        suggestions.iter().any(|s| s.text == ".value"),
        "Should suggest '.value' for to_entries | map(."
    );
}

#[test]
fn test_to_entries_opaque_value_shows_all_fields() {
    let json = r#"{"services": {"web": {"port": 8080}, "db": {"port": 5432}}}"#;
    let parsed = Arc::new(serde_json::from_str::<Value>(json).unwrap());
    let all_fields = field_names_from(&parsed);

    let query = "to_entries | map(.value | .";
    let tracker = tracker_for(query);

    let suggestions = get_suggestions(
        query,
        query.len(),
        Some(parsed.clone()),
        Some(ResultType::Object),
        Some(parsed),
        all_fields,
        &tracker,
        DEFAULT_ARRAY_SAMPLE_SIZE,
    );

    // Should show all fields since we can't determine the structure after .value | .
    assert!(
        suggestions.iter().any(|s| s.text == ".services"),
        "Should include original JSON fields in opaque context"
    );
    // Should NOT show .key/.value since we're in opaque context
    let key_with_desc = suggestions
        .iter()
        .any(|s| s.text == ".key" && s.description.is_some());
    assert!(
        !key_with_desc,
        "Should NOT suggest entry '.key' in opaque context"
    );
}

#[test]
fn test_to_entries_complex_pattern_shows_all_fields() {
    let json = r#"{"name": "test", "items": [1, 2, 3]}"#;
    let parsed = Arc::new(serde_json::from_str::<Value>(json).unwrap());
    let all_fields = field_names_from(&parsed);

    // Complex pattern from the plan
    let query = "to_entries | map({service: .key, config: .value | map(select(.";
    let tracker = tracker_for(query);

    let suggestions = get_suggestions(
        query,
        query.len(),
        Some(parsed.clone()),
        Some(ResultType::Object),
        Some(parsed),
        all_fields,
        &tracker,
        DEFAULT_ARRAY_SAMPLE_SIZE,
    );

    // In opaque context, should fall back to all fields
    assert!(
        suggestions.iter().any(|s| s.text == ".name"),
        "Should include original JSON fields in complex opaque pattern"
    );
}

#[test]
fn test_key_value_have_correct_descriptions() {
    let (parsed, result_type) = create_object_json();
    let query = "to_entries | map(.";
    let tracker = tracker_for(query);

    let suggestions = get_suggestions(
        query,
        query.len(),
        Some(parsed.clone()),
        Some(result_type.clone()),
        Some(parsed),
        empty_field_names(),
        &tracker,
        DEFAULT_ARRAY_SAMPLE_SIZE,
    );

    let key_suggestion = suggestions.iter().find(|s| s.text == ".key");
    assert!(
        key_suggestion
            .and_then(|s| s.description.as_ref())
            .map(|d| d.contains("to_entries") || d.contains("with_entries"))
            .unwrap_or(false),
        ".key should have description mentioning entry context"
    );

    let value_suggestion = suggestions.iter().find(|s| s.text == ".value");
    assert!(
        value_suggestion
            .and_then(|s| s.description.as_ref())
            .map(|d| d.contains("to_entries") || d.contains("with_entries"))
            .unwrap_or(false),
        ".value should have description mentioning entry context"
    );
}

#[test]
fn test_key_value_appear_first_in_to_entries() {
    let (parsed, result_type) = create_object_json();
    let query = "to_entries | map(.";
    let tracker = tracker_for(query);

    let suggestions = get_suggestions(
        query,
        query.len(),
        Some(parsed.clone()),
        Some(result_type.clone()),
        Some(parsed),
        empty_field_names(),
        &tracker,
        DEFAULT_ARRAY_SAMPLE_SIZE,
    );

    assert!(suggestions.len() >= 2, "Should have at least 2 suggestions");
    assert_eq!(
        suggestions[0].text, ".key",
        "First suggestion should be '.key'"
    );
    assert_eq!(
        suggestions[1].text, ".value",
        "Second suggestion should be '.value'"
    );
}

#[test]
fn test_no_duplicate_key_value_suggestions() {
    // Simulate a scenario where the result already has key/value from entry structure
    // The result of to_entries is [{key: ..., value: ...}, ...]
    let json = r#"[{"key": "name", "value": "alice"}, {"key": "age", "value": 30}]"#;
    let parsed = Arc::new(serde_json::from_str::<Value>(json).unwrap());

    let query = "to_entries | .[].";
    let tracker = tracker_for(query);

    let suggestions = get_suggestions(
        query,
        query.len(),
        Some(parsed.clone()),
        Some(ResultType::ArrayOfObjects),
        Some(parsed),
        empty_field_names(),
        &tracker,
        DEFAULT_ARRAY_SAMPLE_SIZE,
    );

    // Count occurrences of key and value suggestions
    let key_count = suggestions.iter().filter(|s| s.text == "key").count();
    let value_count = suggestions.iter().filter(|s| s.text == "value").count();

    assert_eq!(
        key_count, 1,
        "Should have exactly one 'key' suggestion, not duplicates"
    );
    assert_eq!(
        value_count, 1,
        "Should have exactly one 'value' suggestion, not duplicates"
    );

    // Verify they have the entry context description
    let key_suggestion = suggestions.iter().find(|s| s.text == "key").unwrap();
    assert!(
        key_suggestion
            .description
            .as_ref()
            .map(|d| d.contains("to_entries") || d.contains("with_entries"))
            .unwrap_or(false),
        "key suggestion should have entry context description"
    );
}