rlsp-yaml 0.12.0

A fast, lightweight YAML language server
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
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
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
// SPDX-License-Identifier: MIT

use regex::Regex;
use rlsp_yaml_parser::LineIndex;
use rlsp_yaml_parser::ScalarStyle;
use rlsp_yaml_parser::Span;
use rlsp_yaml_parser::node::{Document, Node};
use tower_lsp::lsp_types::{DocumentLink, Position, Range, Url};

/// Maximum allowed URL length to prevent `DoS` attacks.
const MAX_URL_LENGTH: usize = 2048;

/// Regex pattern for detecting URLs with http://, https://, or file:// schemes.
/// Excludes common delimiters and whitespace to avoid capturing surrounding text.
static URL_REGEX: std::sync::LazyLock<Regex> = std::sync::LazyLock::new(|| {
    Regex::new(r#"(https?|file)://[^\s<>"{}|\\^`\[\]()]+"#)
        .unwrap_or_else(|_| unreachable!("static regex is valid"))
});

/// Find all document links (URLs and `!include` paths) in the given YAML AST.
///
/// Walks every `Node::Scalar` in the AST. For each scalar:
/// - Applies `URL_REGEX` to the decoded scalar `value`, producing `DocumentLink`s
///   with byte-accurate ranges for single-line scalars. Multi-line scalars
///   (literal `|` and folded `>` block styles) fall back to the full `node.loc`
///   span as the range — precise in-value offset arithmetic across embedded
///   newlines is not performed.
/// - If the scalar carries a `!include` tag, treats `value` as a file path and
///   resolves it against `base_uri` when provided.
///
/// **Deliberate behavior change from the pre-retrofit implementation:**
/// Comments are no longer scanned — comments are not `Node::Scalar` nodes in
/// the AST. URLs that previously appeared only in comments will not produce
/// links.
///
/// Returns a vector of `DocumentLink` with accurate position ranges.
/// Invalid or overly long URLs are silently skipped.
#[must_use]
pub fn find_document_links(docs: &[Document<Span>], base_uri: Option<&Url>) -> Vec<DocumentLink> {
    let mut links = Vec::new();
    for doc in docs {
        let idx = doc.line_index();
        collect_node_links(&doc.root, base_uri, &mut links, idx);
    }
    links
}

/// Recursively walk `node` and collect document links into `out`.
fn collect_node_links(
    node: &Node<Span>,
    base_uri: Option<&Url>,
    out: &mut Vec<DocumentLink>,
    idx: &LineIndex,
) {
    match node {
        Node::Scalar {
            value,
            style,
            tag,
            loc,
            ..
        } => {
            // !include tag: treat value as a file path.
            if tag.as_deref() == Some("!include") {
                // Reject empty paths and control characters that are invalid in file paths.
                if !value.is_empty() && !value.contains(['\n', '\r', '\x00']) {
                    if let Some(target) = resolve_include_path(value, base_uri) {
                        out.push(DocumentLink {
                            range: span_to_range(*loc, idx),
                            target: Some(target),
                            tooltip: Some("Open included file".to_string()),
                            data: None,
                        });
                    }
                }
                // Do not also scan the value for URLs when it's an !include tag.
                return;
            }

            // URL detection in scalar value.
            let is_multiline = matches!(style, ScalarStyle::Literal(_) | ScalarStyle::Folded(_));
            // quote_char_len: opening quote character count in the source before `value` bytes.
            // For single/double-quoted scalars the first source byte is the quote character.
            let quote_utf16 = match style {
                ScalarStyle::SingleQuoted | ScalarStyle::DoubleQuoted => 1u32,
                ScalarStyle::Plain | ScalarStyle::Literal(_) | ScalarStyle::Folded(_) => 0u32,
            };

            for mat in URL_REGEX.find_iter(value) {
                let matched = trim_trailing_punctuation(mat.as_str());
                if matched.len() > MAX_URL_LENGTH {
                    continue;
                }
                let Ok(url) = Url::parse(matched) else {
                    continue;
                };
                let range = if is_multiline {
                    // Multi-line scalar: fall back to the full node span.
                    span_to_range(*loc, idx)
                } else {
                    // Single-line scalar: compute the precise character range within the
                    // source line. loc.start column is the codepoint column of the scalar's
                    // opening character (including the quote for quoted styles).
                    let loc_start_col = idx.line_column(loc.start).1;
                    let start_utf16 = u32::try_from(loc_start_col as usize).unwrap_or(u32::MAX)
                        + quote_utf16
                        + byte_to_utf16_offset(value, mat.start());
                    let end_utf16 = u32::try_from(loc_start_col as usize).unwrap_or(u32::MAX)
                        + quote_utf16
                        + byte_to_utf16_offset(value, mat.start() + matched.len());
                    let lsp_line =
                        u32::try_from(idx.line_column(loc.start).0.saturating_sub(1) as usize)
                            .unwrap_or(u32::MAX);
                    Range {
                        start: Position {
                            line: lsp_line,
                            character: start_utf16,
                        },
                        end: Position {
                            line: lsp_line,
                            character: end_utf16,
                        },
                    }
                };
                out.push(DocumentLink {
                    range,
                    target: Some(url),
                    tooltip: None,
                    data: None,
                });
            }
        }
        Node::Mapping { entries, .. } => {
            for (key, val) in entries {
                collect_node_links(key, base_uri, out, idx);
                collect_node_links(val, base_uri, out, idx);
            }
        }
        Node::Sequence { items, .. } => {
            for item in items {
                collect_node_links(item, base_uri, out, idx);
            }
        }
        Node::Alias { .. } => {}
    }
}

/// Convert a `Span` to an LSP `Range`.
///
/// `Pos::line` is 1-based; LSP lines are 0-based — hence `saturating_sub(1)`.
/// `Pos::column` is 0-based codepoints; used directly as LSP character offset
/// (same limitation as `schema_validation.rs:span_to_range`).
fn span_to_range(loc: Span, idx: &LineIndex) -> Range {
    Range {
        start: Position {
            line: idx.line_column(loc.start).0.saturating_sub(1),
            character: idx.line_column(loc.start).1,
        },
        end: Position {
            line: idx.line_column(loc.end).0.saturating_sub(1),
            character: idx.line_column(loc.end).1,
        },
    }
}

/// Resolve an `!include` path to a `Url`.
///
/// - Paths starting with a known URL scheme are parsed directly.
/// - Absolute paths (`/...`) become `file:///...` URLs.
/// - Relative paths are resolved against the directory of `base_uri`.
///   Returns `None` if `base_uri` is absent for a relative path.
fn resolve_include_path(path: &str, base_uri: Option<&Url>) -> Option<Url> {
    // Already a URL
    if path.starts_with("http://") || path.starts_with("https://") || path.starts_with("file://") {
        return Url::parse(path).ok();
    }

    // Absolute filesystem path
    if path.starts_with('/') {
        return Url::parse(&format!("file://{path}")).ok();
    }

    // Relative path — requires a base URI
    let base = base_uri?;
    // `base.join(".")` gives the directory (trailing slash preserved by the URL spec)
    let dir = base.join(".").ok()?;
    dir.join(path).ok()
}

/// Trim trailing punctuation characters that are commonly found after URLs in prose.
fn trim_trailing_punctuation(s: &str) -> &str {
    s.trim_end_matches(['.', ',', ';', ':', '!', '?'])
}

/// Convert a byte offset to a UTF-16 code unit offset within `s[..byte_offset]`.
///
/// LSP uses UTF-16 code units for character positions.
fn byte_to_utf16_offset(s: &str, byte_offset: usize) -> u32 {
    u32::try_from(s[..byte_offset].chars().map(char::len_utf16).sum::<usize>()).unwrap_or(u32::MAX)
}

#[cfg(test)]
#[expect(
    clippy::indexing_slicing,
    clippy::unwrap_used,
    clippy::cast_possible_truncation,
    reason = "test code"
)]
mod tests {
    use rlsp_yaml_parser::Span;
    use rlsp_yaml_parser::node::Document;
    use rstest::rstest;

    use super::*;

    fn load_docs(yaml: &str) -> Vec<Document<Span>> {
        rlsp_yaml_parser::load(yaml).unwrap_or_default()
    }

    fn base(uri: &str) -> Url {
        Url::parse(uri).unwrap()
    }

    /// Helper to extract (`line`, `start_char`, `end_char`, `url`) tuples from `DocumentLink`s.
    fn links_as_tuples(links: &[DocumentLink]) -> Vec<(u32, u32, u32, String)> {
        links
            .iter()
            .map(|l| {
                (
                    l.range.start.line,
                    l.range.start.character,
                    l.range.end.character,
                    l.target
                        .as_ref()
                        .map(ToString::to_string)
                        .unwrap_or_default(),
                )
            })
            .collect()
    }

    // ========== Basic URL Detection Tests ==========

    #[rstest]
    // ========== Basic URL Detection Tests ==========
    #[case::quoted_string("homepage: \"https://example.com\"\n", 1)]
    #[case::single_quoted_string("url: 'https://example.com'\n", 1)]
    #[case::unquoted_value("homepage: https://example.com\n", 1)]
    // Comment lines are not AST nodes — no links produced (deliberate drop).
    #[case::in_comment("# See https://example.com for details\n", 0)]
    // ========== Multiple URLs Tests ==========
    #[case::multiple_on_same_line("urls: https://example.com https://other.com\n", 2)]
    #[case::across_multiple_lines("url1: https://example.com\nurl2: https://other.com\n", 2)]
    // Inline comment: scalar value is "value"; URL is in comment — not an AST node.
    #[case::inline_comment("key: value # See https://example.com\n", 0)]
    // ========== Multi-Document YAML Tests ==========
    #[case::first_document_section("url: https://first.com\n---\nother: content\n", 1)]
    #[case::middle_section("first: doc\n---\nurl: https://middle.com\n---\nlast: doc\n", 1)]
    #[case::all_sections(
        "url: https://first.com\n---\nurl: https://second.com\n---\nurl: https://third.com\n",
        3
    )]
    // ========== Edge Cases Tests ==========
    #[case::empty_document("", 0)]
    #[case::no_urls("key: value\nother: data\n# comment\n", 0)]
    // Comment line — no link (deliberate drop).
    #[case::url_at_line_end("# comment https://example.com\n", 0)]
    #[case::mixed_schemes_same_line("http://a.com https://b.com file:///c\n", 3)]
    #[case::stop_at_space("url: https://exam ple.com\n", 1)]
    #[case::special_encodings("url: https://example.com/path%20with%20spaces\n", 1)]
    #[case::multibyte_utf8_before_url("説明: https://example.com\n", 1)]
    #[case::mixed_multibyte_chars("日本語: https://example.jp 説明\n", 1)]
    // ========== Security Tests ==========
    #[case::scheme_only_rejected("url: https://\n", 0)]
    #[case::localhost_no_tld("url: https://localhost\n", 1)]
    // Comment — no link (deliberate drop).
    #[case::comment_no_space_after_hash("#https://example.com\n", 0)]
    // ========== Scheme and Validation Tests ==========
    #[case::three_schemes(
        "http: http://example.com\nhttps: https://example.com\nfile: file:///path/to/file\n",
        3
    )]
    #[case::only_allowed_schemes(
        "\nurl1: https://example.com\nurl2: ftp://example.com\nurl3: http://example.com\nurl4: file:///path/to/file\nurl5: javascript:alert(1)\n",
        3
    )]
    #[case::validated_urls_only(
        "\nurl1: https://valid.com\nurl2: https://\nurl3: https://another-valid.com\n",
        2
    )]
    fn find_document_links_returns_len(#[case] text: &str, #[case] expected_len: usize) {
        let result = find_document_links(&load_docs(text), None);
        assert_eq!(result.len(), expected_len);
    }

    // ========== Basic URL Detection Tests (tuple content) ==========

    #[test]
    fn should_detect_url_in_quoted_string() {
        let text = "homepage: \"https://example.com\"\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1, "should find exactly one URL");
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].0, 0, "line should be 0");
        assert_eq!(tuples[0].1, 11, "start character after opening quote");
        assert_eq!(tuples[0].3, "https://example.com/");
    }

    #[test]
    fn should_detect_url_in_single_quoted_string() {
        let text = "url: 'https://example.com'\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].1, 6, "start character after opening quote");
    }

    #[test]
    fn should_detect_url_in_unquoted_value() {
        let text = "homepage: https://example.com\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].1, 10, "start character after 'homepage: '");
        assert_eq!(tuples[0].3, "https://example.com/");
    }

    // URL in a comment — AST walk does not visit comments; no link produced.
    #[test]
    fn comment_url_produces_no_link() {
        let text = "# See https://example.com for details\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(
            result.len(),
            0,
            "comment URLs are not detected (deliberate drop)"
        );
    }

    #[test]
    fn should_detect_http_and_https_and_file_schemes() {
        let text =
            "http: http://example.com\nhttps: https://example.com\nfile: file:///path/to/file\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 3, "should detect all three schemes");
        let tuples = links_as_tuples(&result);
        assert!(tuples[0].3.starts_with("http://"));
        assert!(tuples[1].3.starts_with("https://"));
        assert!(tuples[2].3.starts_with("file:///"));
    }

    // ========== Multiple URLs Tests (tuple content) ==========

    #[test]
    fn should_detect_multiple_urls_on_same_line() {
        let text = "urls: https://example.com https://other.com\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 2);
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].3, "https://example.com/");
        assert_eq!(tuples[1].3, "https://other.com/");
    }

    #[test]
    fn should_detect_urls_across_multiple_lines() {
        let text = "url1: https://example.com\nurl2: https://other.com\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 2);
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].0, 0);
        assert_eq!(tuples[1].0, 1);
    }

    // URL in inline comment — AST scalar value is "value", comment is not a node.
    #[test]
    fn inline_comment_url_produces_no_link() {
        let text = "key: value # See https://example.com\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(
            result.len(),
            0,
            "URL in inline comment is not detected (deliberate drop)"
        );
    }

    // ========== Multi-Document YAML Tests (tuple content) ==========

    #[test]
    fn should_detect_urls_in_first_document_section() {
        let text = "url: https://first.com\n---\nother: content\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].0, 0, "URL in first section");
    }

    #[test]
    fn should_detect_urls_in_middle_section() {
        let text = "first: doc\n---\nurl: https://middle.com\n---\nlast: doc\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].0, 2, "URL in middle section");
    }

    #[test]
    fn should_detect_urls_in_all_sections() {
        let text =
            "url: https://first.com\n---\nurl: https://second.com\n---\nurl: https://third.com\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 3);
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].3, "https://first.com/");
        assert_eq!(tuples[1].3, "https://second.com/");
        assert_eq!(tuples[2].3, "https://third.com/");
    }

    // ========== Edge Cases Tests (tuple content) ==========

    #[test]
    fn should_detect_url_at_line_start() {
        let text = "https://example.com # comment\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].1, 0, "URL starts at column 0");
    }

    #[test]
    fn should_detect_url_with_query_params() {
        let text = "url: https://example.com?foo=bar&baz=qux\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].3, "https://example.com/?foo=bar&baz=qux");
    }

    #[test]
    fn should_detect_url_with_fragment() {
        let text = "url: https://example.com#section\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].3, "https://example.com/#section");
    }

    #[test]
    fn should_detect_url_with_path() {
        let text = "url: https://example.com/path/to/resource\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].3, "https://example.com/path/to/resource");
    }

    #[test]
    fn should_detect_url_with_port() {
        let text = "url: https://example.com:8080/path\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].3, "https://example.com:8080/path");
    }

    #[test]
    fn should_detect_url_with_username() {
        let text = "url: https://user@example.com/path\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].3, "https://user@example.com/path");
    }

    #[test]
    fn should_trim_trailing_period_in_prose() {
        let text = "See https://example.com.\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].3, "https://example.com/");
        // Verify range doesn't include the period
        let url_text = "https://example.com";
        assert_eq!(
            tuples[0].2 - tuples[0].1,
            url_text.len() as u32,
            "range should exclude trailing period"
        );
    }

    #[test]
    fn should_trim_trailing_comma() {
        let text = "urls: https://example.com, https://other.com\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 2);
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].3, "https://example.com/");
    }

    #[test]
    fn should_stop_at_parentheses() {
        let text = "(see https://example.com)\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].3, "https://example.com/");
        // Verify range doesn't include closing paren
        assert!(!tuples[0].3.contains(')'));
    }

    #[test]
    fn should_stop_at_square_brackets() {
        let text = "[https://example.com]\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        let tuples = links_as_tuples(&result);
        assert!(!tuples[0].3.contains(']'));
    }

    #[test]
    fn should_stop_at_curly_braces() {
        let text = "{url: https://example.com}\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        let tuples = links_as_tuples(&result);
        assert!(!tuples[0].3.contains('}'));
    }

    // ========== Security Tests ==========

    #[test]
    fn should_skip_extremely_long_urls() {
        let long_url = format!("https://example.com/{}", "a".repeat(3000));
        let text = format!("url: {long_url}\n");
        let result = find_document_links(&load_docs(&text), None);

        assert_eq!(result.len(), 0, "URLs over 2048 chars should be skipped");
    }

    #[test]
    fn should_handle_url_at_max_length() {
        // URL exactly at 2048 chars
        let path = "a".repeat(2048 - "https://example.com/".len());
        let url = format!("https://example.com/{path}");
        let text = format!("url: {url}\n");
        let result = find_document_links(&load_docs(&text), None);

        assert_eq!(
            result.len(),
            1,
            "URL at exactly 2048 chars should be detected"
        );
    }

    #[test]
    fn should_stop_at_space_in_url() {
        let text = "url: https://exam ple.com\n";
        let result = find_document_links(&load_docs(text), None);

        // Regex stops at space, so "https://exam" is matched and is a valid URL
        assert_eq!(result.len(), 1, "URL up to space should be detected");
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].3, "https://exam/");
    }

    #[test]
    fn should_handle_url_with_special_encodings() {
        let text = "url: https://example.com/path%20with%20spaces\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].3, "https://example.com/path%20with%20spaces");
    }

    #[test]
    fn should_handle_multibyte_utf8_before_url() {
        let text = "説明: https://example.com\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        // UTF-16 offset calculation should handle multi-byte chars correctly
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].3, "https://example.com/");
    }

    #[test]
    fn should_handle_emoji_before_url() {
        let text = "🔗 https://example.com\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        let tuples = links_as_tuples(&result);
        // Emoji takes 2 UTF-16 code units
        assert_eq!(tuples[0].1, 3, "start position after emoji and space");
    }

    #[test]
    fn should_handle_mixed_multibyte_chars_and_urls() {
        let text = "日本語: https://example.jp 説明\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].3, "https://example.jp/");
    }

    #[test]
    fn should_handle_file_url_with_triple_slash() {
        let text = "file: file:///absolute/path/to/file\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].3, "file:///absolute/path/to/file");
    }

    #[test]
    fn should_handle_file_url_windows_path() {
        let text = "file: file:///C:/Windows/path\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].3, "file:///C:/Windows/path");
    }

    // ========== Scheme and Validation Tests ==========

    #[test]
    fn should_only_detect_allowed_schemes() {
        let text = r"
url1: https://example.com
url2: ftp://example.com
url3: http://example.com
url4: file:///path/to/file
url5: javascript:alert(1)
";
        let result = find_document_links(&load_docs(text), None);

        // Only http, https, file should be detected (ftp and javascript are not matched by regex)
        assert_eq!(
            result.len(),
            3,
            "only http, https, file schemes should be detected"
        );
        let tuples = links_as_tuples(&result);
        assert!(tuples[0].3.starts_with("https://"));
        assert!(tuples[1].3.starts_with("http://"));
        assert!(tuples[2].3.starts_with("file:///"));
    }

    #[test]
    fn should_validate_urls_with_url_parse() {
        // This test verifies the Url::parse() validation layer exists.
        // Most invalid URLs are already filtered by regex, but we test edge cases.
        // Test URL with just a scheme and domain (should be valid)
        let text = "url: https://example\n";
        let result = find_document_links(&load_docs(text), None);

        // This is actually a valid URL (no TLD required)
        assert_eq!(result.len(), 1, "simple domain should be valid");

        // The validation layer is tested by should_skip_incomplete_url_scheme_only
        // which verifies https:// (no domain) is rejected
    }

    #[test]
    fn should_only_include_validated_urls() {
        let text = r"
url1: https://valid.com
url2: https://
url3: https://another-valid.com
";
        let result = find_document_links(&load_docs(text), None);

        // Only the 2 valid URLs should be included (https:// with no domain fails validation)
        assert_eq!(result.len(), 2, "only validated URLs should be included");
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].3, "https://valid.com/");
        assert_eq!(tuples[1].3, "https://another-valid.com/");
    }

    // ========== Position Accuracy Tests ==========

    #[test]
    fn should_calculate_correct_positions_for_quoted_urls() {
        let text = "url: \"https://example.com\"\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        let link = &result[0];
        // Should start after the opening quote (character 6)
        assert_eq!(link.range.start.character, 6);
        // Should end before the closing quote
        let url_text = "https://example.com";
        assert_eq!(
            link.range.end.character - link.range.start.character,
            url_text.len() as u32
        );
    }

    #[test]
    fn should_calculate_correct_line_numbers_in_multi_document() {
        let text = "first: doc\n---\nurl: https://example.com\n---\nlast: doc\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1);
        assert_eq!(result[0].range.start.line, 2, "URL is on line 2");
    }

    #[test]
    fn should_have_consistent_ranges_across_lines() {
        let text = "line1: https://first.com\nline2: https://second.com\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 2);
        assert_eq!(result[0].range.start.line, 0);
        assert_eq!(result[1].range.start.line, 1);
        // Both URLs should have same relative position on their lines
        assert_eq!(
            result[0].range.start.character,
            result[1].range.start.character
        );
    }

    // ========== !include Tests ==========

    // Tests 1–3: include path resolution (collapsed — same shape: len==1 + target url)
    #[rstest]
    #[case::relative_path_with_base(
        "config: !include foo.yaml\n",
        Some("file:///dir/doc.yaml"),
        "file:///dir/foo.yaml"
    )]
    #[case::absolute_path(
        "config: !include /absolute/path.yaml\n",
        None,
        "file:///absolute/path.yaml"
    )]
    #[case::parent_relative_path(
        "config: !include ../relative.yaml\n",
        Some("file:///dir/subdir/doc.yaml"),
        "file:///dir/relative.yaml"
    )]
    fn include_resolves_to_expected_url(
        #[case] text: &str,
        #[case] base_uri: Option<&str>,
        #[case] expected_url: &str,
    ) {
        let b = base_uri.map(base);
        let result = find_document_links(&load_docs(text), b.as_ref());
        let include_links: Vec<_> = result
            .iter()
            .filter(|l| l.tooltip.as_deref() == Some("Open included file"))
            .collect();
        assert_eq!(include_links.len(), 1);
        assert_eq!(
            include_links[0].target.as_ref().unwrap().as_str(),
            expected_url
        );
    }

    // Test 4: !include inside quotes → no link (tag-based: parser won't tag a quoted string as !include)
    #[test]
    fn should_skip_include_inside_double_quotes() {
        let text = "note: \"some text with !include in quotes\"\n";
        let b = base("file:///dir/doc.yaml");
        let result = find_document_links(&load_docs(text), Some(&b));

        assert!(
            result
                .iter()
                .all(|l| l.tooltip.as_deref() != Some("Open included file")),
            "!include inside quotes should be ignored"
        );
    }

    // Test 5: no !include → only URL links returned
    #[test]
    fn should_return_only_url_links_when_no_include_present() {
        let text = "url: https://example.com\n";
        let b = base("file:///dir/doc.yaml");
        let result = find_document_links(&load_docs(text), Some(&b));

        assert_eq!(result.len(), 1);
        assert!(
            result[0].tooltip.is_none(),
            "should be a URL link, not include"
        );
    }

    // Test 6: relative path without base URI → no include link
    #[test]
    fn should_skip_relative_include_when_no_base_uri() {
        let text = "config: !include foo.yaml\n";
        let result = find_document_links(&load_docs(text), None);

        assert!(
            result
                .iter()
                .all(|l| l.tooltip.as_deref() != Some("Open included file")),
            "relative !include without base_uri should be skipped"
        );
    }

    // Test 7: multiple !include tags on different lines
    #[test]
    fn should_detect_multiple_includes_on_different_lines() {
        let text = "a: !include a.yaml\nb: !include b.yaml\nc: !include c.yaml\n";
        let b = base("file:///dir/doc.yaml");
        let result = find_document_links(&load_docs(text), Some(&b));

        let include_links: Vec<_> = result
            .iter()
            .filter(|l| l.tooltip.as_deref() == Some("Open included file"))
            .collect();
        assert_eq!(include_links.len(), 3);
        assert_eq!(
            include_links[0].target.as_ref().unwrap().as_str(),
            "file:///dir/a.yaml"
        );
        assert_eq!(
            include_links[1].target.as_ref().unwrap().as_str(),
            "file:///dir/b.yaml"
        );
        assert_eq!(
            include_links[2].target.as_ref().unwrap().as_str(),
            "file:///dir/c.yaml"
        );
    }

    // Test 8: !include with no path → no link
    #[test]
    fn should_skip_include_with_no_path() {
        let text = "config: !include\n";
        let b = base("file:///dir/doc.yaml");
        let result = find_document_links(&load_docs(text), Some(&b));

        assert!(
            result
                .iter()
                .all(|l| l.tooltip.as_deref() != Some("Open included file")),
            "!include with no path should be skipped"
        );
    }

    // Test 9: both URL and !include present — URL in comment produces no link; !include is detected
    #[test]
    fn should_detect_include_but_not_comment_url_on_separate_lines() {
        let text = "# https://example.com\nconfig: !include foo.yaml\n";
        let b = base("file:///dir/doc.yaml");
        let result = find_document_links(&load_docs(text), Some(&b));

        let url_count = result.iter().filter(|l| l.tooltip.is_none()).count();
        let include_count = result
            .iter()
            .filter(|l| l.tooltip.as_deref() == Some("Open included file"))
            .count();
        assert_eq!(
            url_count, 0,
            "comment URL produces no link (deliberate drop)"
        );
        assert_eq!(include_count, 1, "should find one include link");
    }

    // Test 10: !include on a separate mapping entry following a double-quoted value with apostrophe.
    // The old text-scanner tested that apostrophes inside double-quoted strings didn't confuse
    // quote-tracking. With tag-based detection, the parser handles quoting; this test verifies
    // the AST walk finds !include in the same mapping as a double-quoted scalar with apostrophes.
    #[test]
    fn should_not_suppress_include_after_double_quoted_value_with_apostrophe() {
        let text = "note: \"it's ok\"\nconfig: !include foo.yaml\n";
        let b = base("file:///dir/doc.yaml");
        let result = find_document_links(&load_docs(text), Some(&b));

        assert_eq!(
            result
                .iter()
                .filter(|l| l.tooltip.as_deref() == Some("Open included file"))
                .count(),
            1,
            "!include on a key following a double-quoted value with apostrophe should be detected"
        );
    }

    // ========== New rstest regression cases (5 required by dispatch) ==========

    #[rstest]
    // (a) URL in a quoted scalar produces a link inside the quoted scalar's loc
    #[case::url_in_quoted_scalar(
        "link: \"https://example.com/path\"\n",
        None,
        1,
        "https://example.com/path"
    )]
    // (b) URL in a plain scalar produces a correct range (start character is after key+colon+space)
    #[case::url_in_plain_scalar(
        "link: https://example.com/path\n",
        None,
        1,
        "https://example.com/path"
    )]
    // (c) !include tag on a scalar produces a link resolved against base_uri
    #[case::include_tag_produces_link(
        "cfg: !include config.yaml\n",
        Some("file:///base/doc.yaml"),
        1,
        "file:///base/config.yaml"
    )]
    // (d) URL in a comment produces NO link (deliberate drop)
    #[case::comment_url_no_link("# https://example.com\n", None, 0, "")]
    fn regression_document_links(
        #[case] text: &str,
        #[case] base_uri: Option<&str>,
        #[case] expected_count: usize,
        #[case] expected_url: &str,
    ) {
        let b = base_uri.map(|u| Url::parse(u).unwrap());
        let result = find_document_links(&load_docs(text), b.as_ref());
        assert_eq!(result.len(), expected_count);
        if expected_count > 0 {
            let url = result[0].target.as_ref().map_or("", Url::as_str);
            assert!(
                url.starts_with(expected_url) || url == expected_url,
                "expected URL starting with {expected_url:?}, got {url:?}"
            );
        }
    }

    // (e) URL exceeding MAX_URL_LENGTH is skipped — standalone because rstest cases cannot call
    // functions to generate the long string at compile time.
    #[test]
    fn regression_url_over_max_length_skipped() {
        let long_path = "a".repeat(MAX_URL_LENGTH + 1);
        let text = format!("url: https://example.com/{long_path}\n");
        let result = find_document_links(&load_docs(&text), None);
        assert_eq!(result.len(), 0, "URL over MAX_URL_LENGTH must be skipped");
    }

    // ========== New tests from test-engineer list ==========

    // A. URL in a mapping key scalar
    #[test]
    fn url_in_mapping_key_scalar_is_detected() {
        let text = "https://example.com: value\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(result.len(), 1, "URL in a mapping key should be detected");
        let tuples = links_as_tuples(&result);
        assert_eq!(tuples[0].3, "https://example.com/");
        assert_eq!(tuples[0].0, 0, "URL key is on line 0");
        assert_eq!(tuples[0].1, 0, "URL key starts at column 0");
    }

    // D. URL in literal block scalar uses full node.loc range (fallback)
    #[test]
    fn url_in_literal_block_scalar_detected_with_full_node_range() {
        let text = "doc: |\n  https://example.com\n  more text\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(
            result.len(),
            1,
            "URL in literal block scalar should be found"
        );
        assert_eq!(
            result[0].target.as_ref().unwrap().as_str(),
            "https://example.com/"
        );
        // Range uses full node.loc (fallback for multi-line): start.line == 0 (doc: key line)
        // or wherever the parser puts the block scalar start — just assert the link exists.
    }

    // E. URL in folded block scalar detected
    #[test]
    fn url_in_folded_block_scalar_detected() {
        let text = "doc: >\n  https://example.com\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(
            result.len(),
            1,
            "URL in folded block scalar should be found"
        );
        assert_eq!(
            result[0].target.as_ref().unwrap().as_str(),
            "https://example.com/"
        );
    }

    // J. !include with URL-scheme absolute path
    #[test]
    fn include_with_url_scheme_path_detected() {
        let text = "ref: !include https://example.com/schema.yaml\n";
        let result = find_document_links(&load_docs(text), None);

        let include_links: Vec<_> = result
            .iter()
            .filter(|l| l.tooltip.as_deref() == Some("Open included file"))
            .collect();
        assert_eq!(
            include_links.len(),
            1,
            "!include with URL path should produce a link"
        );
        assert_eq!(
            include_links[0].target.as_ref().unwrap().as_str(),
            "https://example.com/schema.yaml"
        );
    }

    // K. Non-scalar roots produce no spurious links
    #[test]
    fn mapping_node_without_url_value_produces_no_links() {
        let text = "outer:\n  inner: plain text\n";
        let result = find_document_links(&load_docs(text), None);

        assert_eq!(
            result.len(),
            0,
            "mapping without URL values should produce no links"
        );
    }

    // Security: !include with newline in value → no link
    #[test]
    fn include_with_newline_in_value_produces_no_link() {
        // A literal block scalar tagged with !include — value will contain \n
        let text = "config: !include |\n  foo\n  bar\n";
        let b = base("file:///dir/doc.yaml");
        let result = find_document_links(&load_docs(text), Some(&b));

        assert!(
            result
                .iter()
                .all(|l| l.tooltip.as_deref() != Some("Open included file")),
            "!include with newline in scalar value must not produce a link"
        );
    }
}