nautilus-orm-schema 0.1.5

Schema parsing and validation for Nautilus ORM
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
//! Integration tests for the analysis API (`analyze`, `completion`, `hover`, `goto_definition`).

use nautilus_schema::{
    analyze, completion, goto_definition, hover, semantic_tokens, CompletionKind, SemanticKind,
    Severity,
};

const VALID: &str = r#"
datasource db {
  provider = "postgresql"
  url      = "postgresql://localhost/test"
}

model User {
  id    Int    @id
  email String @unique
  name  String
  role  Role

  posts Post[]
}

model Post {
  id       Int  @id
  authorId Int
  author   User @relation(fields: [authorId], references: [id])
}

enum Role {
  Admin
  Member
}
"#;

#[test]
fn analyze_valid_returns_no_diagnostics() {
    let r = analyze(VALID);
    assert!(
        r.diagnostics.is_empty(),
        "expected no diagnostics, got: {:#?}",
        r.diagnostics
    );
    assert!(r.ast.is_some(), "ast should be Some");
    assert!(r.ir.is_some(), "ir should be Some");
}

#[test]
fn analyze_exposes_ir_models() {
    let r = analyze(VALID);
    let ir = r.ir.unwrap();
    assert!(ir.models.contains_key("User"));
    assert!(ir.models.contains_key("Post"));
    assert!(ir.enums.contains_key("Role"));
}

#[test]
fn analyze_lex_error_populates_diagnostics() {
    let src = "model User { id # Int @id }";
    let r = analyze(src);
    assert!(!r.diagnostics.is_empty());
    assert_eq!(r.diagnostics[0].severity, Severity::Error);
}

#[test]
fn analyze_parse_recovery_error_collected() {
    let src = r#"
!!!garbage!!!

model Good {
  id Int @id
}
"#;
    let r = analyze(src);
    assert!(r.ast.is_some());
    assert!(!r.diagnostics.is_empty(), "expected parse diagnostics");
}

#[test]
fn analyze_validation_error_has_span() {
    let src = r#"
model Dupe {
  id Int @id
}

model Dupe {
  id Int @id
}
"#;
    let r = analyze(src);
    let with_span: Vec<_> = r
        .diagnostics
        .iter()
        .filter(|d| d.span.start > 0 || d.span.end > 0)
        .collect();
    assert!(
        !with_span.is_empty(),
        "expected at least one diagnostic with a real span"
    );
}

#[test]
fn analyze_collects_multiple_datasource_diagnostics() {
    let src = r#"
datasource db {
  provider = 123
  url      = env("DATABASE_URL", 1)
  foo      = "bar"
}
"#;
    let r = analyze(src);
    let messages: Vec<&str> = r.diagnostics.iter().map(|d| d.message.as_str()).collect();

    assert!(
        r.ir.is_none(),
        "IR should be absent on config validation errors"
    );
    assert!(
        messages
            .iter()
            .any(|msg| msg.contains("Unknown field 'foo' in datasource block")),
        "missing unknown-field diagnostic: {:?}",
        messages
    );
    assert!(
        messages
            .iter()
            .any(|msg| msg.contains("Datasource 'provider' must be a string literal")),
        "missing provider diagnostic: {:?}",
        messages
    );
    assert!(
        messages.iter().any(
            |msg| msg.contains("Datasource 'url' env() call requires a single string argument")
        ),
        "missing url diagnostic: {:?}",
        messages
    );
}

#[test]
fn analyze_collects_multiple_generator_diagnostics_and_later_warnings() {
    let src = r#"
generator client {
  provider  = 123
  output    = 456
  interface = 789
  foo       = "bar"
}

model User {
  id        Int      @id
  updatedAt DateTime @updatedAt @default(now())
}
"#;
    let r = analyze(src);
    let messages: Vec<&str> = r.diagnostics.iter().map(|d| d.message.as_str()).collect();

    assert!(
        r.ir.is_none(),
        "IR should be absent on config validation errors"
    );
    assert!(
        messages
            .iter()
            .any(|msg| msg.contains("Generator 'provider' must be a string literal")),
        "missing provider diagnostic: {:?}",
        messages
    );
    assert!(
        messages
            .iter()
            .any(|msg| msg.contains("Generator 'output' must be a string literal")),
        "missing output diagnostic: {:?}",
        messages
    );
    assert!(
        messages
            .iter()
            .any(|msg| msg.contains("Generator 'interface' must be a string literal")),
        "missing interface diagnostic: {:?}",
        messages
    );
    assert!(
        messages
            .iter()
            .any(|msg| msg.contains("Unknown field 'foo' in generator block")),
        "missing unknown-field diagnostic: {:?}",
        messages
    );
    assert!(
        r.diagnostics.iter().any(|d| {
            d.severity == Severity::Warning && d.message.contains("both @updatedAt and @default")
        }),
        "missing later warning: {:?}",
        r.diagnostics
    );
}

#[test]
fn completion_at_empty_source_returns_top_level_keywords() {
    let items = completion("", 0);
    let labels: Vec<&str> = items.iter().map(|i| i.label.as_str()).collect();
    assert!(labels.contains(&"model"), "missing 'model': {:?}", labels);
    assert!(labels.contains(&"enum"), "missing 'enum': {:?}", labels);
    assert!(
        labels.contains(&"datasource"),
        "missing 'datasource': {:?}",
        labels
    );
    assert!(
        labels.contains(&"generator"),
        "missing 'generator': {:?}",
        labels
    );
    assert!(
        items.iter().all(|i| i.kind == CompletionKind::Keyword),
        "all top-level items should be Keyword kind"
    );
}

#[test]
fn completion_inside_datasource_only_contains_datasource_fields() {
    let src = "datasource db {\n  \n}";
    let offset = src.find("\n  \n").unwrap() + 3;
    let items = completion(src, offset);
    let labels: Vec<&str> = items.iter().map(|i| i.label.as_str()).collect();

    assert!(
        labels.contains(&"provider"),
        "missing provider: {:?}",
        labels
    );
    assert!(labels.contains(&"url"), "missing url: {:?}", labels);
    assert!(
        !labels.contains(&"output"),
        "unexpected output: {:?}",
        labels
    );
    assert!(
        !labels.contains(&"interface"),
        "unexpected interface: {:?}",
        labels
    );
    assert!(
        !labels.contains(&"recursive_type_depth"),
        "unexpected recursive_type_depth: {:?}",
        labels
    );
}

#[test]
fn completion_inside_generator_only_contains_generator_fields() {
    let src = "generator client {\n  \n}";
    let offset = src.find("\n  \n").unwrap() + 3;
    let items = completion(src, offset);
    let labels: Vec<&str> = items.iter().map(|i| i.label.as_str()).collect();

    assert!(
        labels.contains(&"provider"),
        "missing provider: {:?}",
        labels
    );
    assert!(labels.contains(&"output"), "missing output: {:?}", labels);
    assert!(
        labels.contains(&"interface"),
        "missing interface: {:?}",
        labels
    );
    assert!(
        labels.contains(&"recursive_type_depth"),
        "missing recursive_type_depth: {:?}",
        labels
    );
    assert!(!labels.contains(&"url"), "unexpected url: {:?}", labels);
}

#[test]
fn completion_inside_default_args_excludes_unsupported_functions() {
    let src = "model User {\n  id Uuid @default()\n}";
    let offset = src.find("@default(").unwrap() + "@default(".len();
    let items = completion(src, offset);
    let labels: Vec<&str> = items.iter().map(|i| i.label.as_str()).collect();

    assert!(labels.contains(&"autoincrement()"), "missing autoincrement");
    assert!(labels.contains(&"now()"), "missing now");
    assert!(labels.contains(&"uuid()"), "missing uuid");
    assert!(!labels.contains(&"cuid()"), "unexpected cuid: {:?}", labels);
    assert!(
        !labels.contains(&"dbgenerated(\"expr\")"),
        "unexpected dbgenerated: {:?}",
        labels
    );
}

#[test]
fn completion_inside_model_contains_scalar_types() {
    let src = "model User {\n  \n}";
    let offset = src.find("\n  \n").unwrap() + 3;
    let items = completion(src, offset);
    let labels: Vec<&str> = items.iter().map(|i| i.label.as_str()).collect();
    for ty in &["String", "Int", "Boolean", "Float", "DateTime", "Uuid"] {
        assert!(labels.contains(ty), "missing type '{}': {:?}", ty, labels);
    }
}

#[test]
fn completion_inside_model_includes_user_defined_types() {
    let src =
        "type Address {\n  street String\n}\n\nmodel Post {\n  author \n}\n\nmodel User {\n  id Int @id\n}\n";
    let offset = src.find("author ").unwrap() + "author ".len();
    let items = completion(src, offset);
    let labels: Vec<&str> = items.iter().map(|i| i.label.as_str()).collect();
    assert!(
        labels.contains(&"User"),
        "User model should appear as a type completion: {:?}",
        labels
    );
    assert!(
        labels.contains(&"Address"),
        "Address composite type should appear as a type completion: {:?}",
        labels
    );
}

#[test]
fn completion_inside_type_only_includes_scalar_and_enum_types() {
    let src = r#"
type Address {
  label 
}

enum LabelKind {
  Home
}

model User {
  id Int @id
}
"#;
    let offset = src.find("label ").unwrap() + "label ".len();
    let items = completion(src, offset);
    let labels: Vec<&str> = items.iter().map(|i| i.label.as_str()).collect();
    assert!(labels.contains(&"String"));
    assert!(labels.contains(&"LabelKind"));
    assert!(
        !labels.contains(&"User"),
        "model refs are invalid in type blocks"
    );
}

#[test]
fn completion_after_at_returns_field_attributes() {
    let src = "model User {\n  id Int @\n}";
    let offset = src.find('@').unwrap() + 1;
    let items = completion(src, offset);
    assert!(
        items
            .iter()
            .any(|i| i.kind == CompletionKind::FieldAttribute),
        "expected field attribute completions after '@': {:?}",
        items
    );
    let labels: Vec<&str> = items.iter().map(|i| i.label.as_str()).collect();
    assert!(
        labels.contains(&"id"),
        "missing 'id' attribute: {:?}",
        labels
    );
    assert!(
        labels.contains(&"unique"),
        "missing 'unique' attribute: {:?}",
        labels
    );
}

#[test]
fn completion_after_atat_returns_model_attributes() {
    let src = "model User {\n  id Int @id\n  @@\n}";
    let offset = src.find("@@").unwrap() + 2;
    let items = completion(src, offset);
    assert!(
        items
            .iter()
            .any(|i| i.kind == CompletionKind::ModelAttribute),
        "expected model attribute completions after '@@': {:?}",
        items
    );
}

#[test]
fn hover_on_model_field_returns_type_info() {
    let offset = VALID.find("email").unwrap() + 2;
    let h = hover(VALID, offset);
    assert!(h.is_some(), "hover returned None for field 'email'");
    let info = h.unwrap();
    assert!(
        info.content.contains("email") || info.content.contains("String"),
        "unexpected hover content: {}",
        info.content
    );
    assert!(info.span.is_some());
}

#[test]
fn hover_on_provider_field_mentions_real_generator_providers() {
    let src = r#"
generator client {
  provider = "nautilus-client-rs"
}
"#;
    let offset = src.find("provider").unwrap() + 2;
    let h = hover(src, offset).expect("hover returned None");

    assert!(
        h.content.contains("nautilus-client-rs")
            && h.content.contains("nautilus-client-py")
            && h.content.contains("nautilus-client-js"),
        "unexpected hover content: {}",
        h.content
    );
    assert!(
        !h.content.contains("\"python\""),
        "unexpected stale provider alias in hover: {}",
        h.content
    );
}

#[test]
fn hover_on_default_attribute_omits_unsupported_functions() {
    let src = r#"
model User {
  id Uuid @default(uuid())
}
"#;
    let offset = src.find("@default").unwrap() + 2;
    let h = hover(src, offset).expect("hover returned None");

    assert!(h.content.contains("autoincrement()"));
    assert!(h.content.contains("now()"));
    assert!(h.content.contains("uuid()"));
    assert!(
        !h.content.contains("cuid()"),
        "unexpected hover: {}",
        h.content
    );
    assert!(
        !h.content.contains("dbgenerated"),
        "unexpected hover: {}",
        h.content
    );
}

#[test]
fn hover_on_model_declaration_returns_model_summary() {
    let offset = VALID.find("model User").unwrap() + 2;
    let h = hover(VALID, offset);
    assert!(h.is_some(), "hover returned None on model declaration");
    let info = h.unwrap();
    assert!(
        info.content.contains("User"),
        "hover content should mention model name: {}",
        info.content
    );
}

#[test]
fn hover_on_enum_returns_variant_list() {
    let offset = VALID.find("enum Role").unwrap() + 2;
    let h = hover(VALID, offset);
    assert!(h.is_some(), "hover returned None on enum");
    let info = h.unwrap();
    assert!(info.content.contains("Admin") || info.content.contains("Member"));
}

#[test]
fn hover_outside_all_declarations_returns_none() {
    let src = "// comment\nmodel User { id Int @id }\n";
    let h = hover(src, 2);
    let _ = h;
}

#[test]
fn goto_definition_user_type_resolves_to_model_span() {
    let offset = VALID.find("author   User").unwrap() + "author   ".len() + 1;
    let span = goto_definition(VALID, offset);
    assert!(span.is_some(), "goto_definition returned None");
    let s = span.unwrap();
    let slice = &VALID[s.start..s.end];
    assert!(
        slice.contains("User"),
        "span does not cover User declaration: {:?}",
        slice
    );
}

#[test]
fn goto_definition_scalar_field_returns_none() {
    let offset = VALID.find("email String").unwrap() + "email ".len() + 1;
    let span = goto_definition(VALID, offset);
    assert!(
        span.is_none(),
        "expected None for scalar type, got: {:?}",
        span
    );
}

#[test]
fn goto_definition_enum_field_resolves_to_enum_span() {
    let offset = VALID.find("role  Role").unwrap() + "role  ".len() + 1;
    let span = goto_definition(VALID, offset);
    assert!(
        span.is_some(),
        "goto_definition returned None for enum field"
    );
    let s = span.unwrap();
    let slice = &VALID[s.start..s.end];
    assert!(
        slice.contains("Role"),
        "span does not cover Role declaration: {:?}",
        slice
    );
}

#[test]
fn goto_definition_composite_type_field_resolves_to_type_span() {
    let src = r#"
type Address {
  street String
}

model User {
  id      Int @id
  address Address
}
"#;
    let offset = src.find("address Address").unwrap() + "address ".len() + 1;
    let span = goto_definition(src, offset).expect("goto_definition returned None");
    let slice = &src[span.start..span.end];
    assert!(
        slice.contains("type Address"),
        "span does not cover Address type declaration: {:?}",
        slice
    );
}

#[test]
fn goto_definition_type_field_enum_resolves_to_enum_span() {
    let src = r#"
type Address {
  kind Role
}

enum Role {
  Home
}
"#;
    let offset = src.find("kind Role").unwrap() + "kind ".len() + 1;
    let span = goto_definition(src, offset).expect("goto_definition returned None");
    let slice = &src[span.start..span.end];
    assert!(
        slice.contains("enum Role"),
        "span does not cover Role enum declaration: {:?}",
        slice
    );
}

#[test]
fn semantic_tokens_include_type_block_references() {
    let src = r#"
type Address {
  kind Role
}

enum Role {
  Home
}
"#;
    let analysis = analyze(src);
    let ast = analysis.ast.as_ref().expect("ast");
    let tokens = semantic_tokens(ast, &analysis.tokens);
    assert!(
        tokens
            .iter()
            .any(|token| token.kind == SemanticKind::EnumRef
                && &src[token.span.start..token.span.end] == "Role"),
        "expected enum semantic token for Role reference inside type block"
    );
}