Fix block attribute doc comment reformatting

This is achieved by a massive cleanup and simplification of the AST reformatter. - The comments attached to block attributes will follow them after reformatting. - Enum attributes do not get reformatted with an extra leading space anymore - Empty lines at beginning and end of blocks are reformatted away. closes prisma/language-tools#1186 Also included: - diagnostics: delete dead warnings code and stop using thiserror — compile times will thank us.
prisma · Jul 5, 2022 · a1b2a66 · a1b2a66
1 parent 09f9659
commit a1b2a66
Show file tree

Hide file tree

Showing 41 changed files with 777 additions and 1,018 deletions.
diff --git a/introspection-engine/connectors/mongodb-introspection-connector/tests/remapping_names/mod.rs b/introspection-engine/connectors/mongodb-introspection-connector/tests/remapping_names/mod.rs
@@ -131,7 +131,7 @@ fn remapping_model_fields_with_numbers() {
         model Outer {
           id String @id @default(auto()) @map("_id") @db.ObjectId
           // This field was commented out because of an invalid name. Please provide a valid one that matches [a-zA-Z][a-zA-Z0-9_]*
-          // 1 Int    @map("1")
+          // 1 Int @map("1")
         }
     "#]];
 
@@ -161,7 +161,7 @@ fn remapping_model_fields_with_numbers_dirty() {
           id String @id @default(auto()) @map("_id") @db.ObjectId
           // Multiple data types found: String: 50%, Int: 50% out of 2 sampled entries
           // This field was commented out because of an invalid name. Please provide a valid one that matches [a-zA-Z][a-zA-Z0-9_]*
-          // 1 Json   @map("1")
+          // 1 Json @map("1")
         }
     "#]];
 

diff --git a/introspection-engine/introspection-engine-tests/tests/commenting_out/sqlite.rs b/introspection-engine/introspection-engine-tests/tests/commenting_out/sqlite.rs
@@ -82,7 +82,7 @@ async fn field_with_empty_name(api: &TestApi) -> TestResult {
     let expectation = expect![[r#"
         model A {
           // This field was commented out because of an invalid name. Please provide a valid one that matches [a-zA-Z][a-zA-Z0-9_]*
-          // Int @default(autoincrement()) @map(" ")
+          //   Int @default(autoincrement()) @map(" ")
         }
     "#]];
 

diff --git a/introspection-engine/introspection-engine-tests/tests/re_introspection/mysql.rs b/introspection-engine/introspection-engine-tests/tests/re_introspection/mysql.rs
@@ -259,8 +259,8 @@ async fn mysql_keeps_renamed_enum_defaults(api: &TestApi) -> TestResult {
         }
 
         enum A_val {
-          is_false  @map("0")
-          is_true   @map("1")
+          is_false @map("0")
+          is_true  @map("1")
         }
     "#]];
 

diff --git a/introspection-engine/introspection-engine-tests/tests/remapping_database_names/mod.rs b/introspection-engine/introspection-engine-tests/tests/remapping_database_names/mod.rs
@@ -11,24 +11,45 @@ use test_macros::test_connector;
 
 #[test_connector(tags(Postgres))]
 async fn should_not_remap_if_renaming_would_lead_to_duplicate_names(api: &TestApi) -> TestResult {
-    api.database()
-        .raw_cmd("CREATE TABLE nodes(id serial primary key)")
-        .await?;
+    let sql = r#"
+        CREATE TABLE nodes(id serial primary key);
+        CREATE TABLE _nodes(
+            node_a int NOT NULL,
+            node_b int NOT NULL,
+            CONSTRAINT _nodes_node_a_fkey FOREIGN KEY(node_a) REFERENCES nodes(id) ON DELETE CASCADE ON UPDATE CASCADE,
+            CONSTRAINT _nodes_node_b_fkey FOREIGN KEY(node_b) REFERENCES nodes(id) ON DELETE CASCADE ON UPDATE CASCADE
+        );
+        
+    "#;
+    api.raw_cmd(sql).await;
 
-    api.database()
-        .raw_cmd(
-            "CREATE TABLE _nodes(
-                node_a int not null,
-                node_b int not null,
-                constraint _nodes_node_a_fkey foreign key(node_a) references nodes(id) on delete cascade on update cascade,
-                constraint _nodes_node_b_fkey foreign key(node_b) references nodes(id) on delete cascade on update cascade
-            )
-        ",
-        )
-        .await?;
+    let expected = expect![[r#"
+        generator client {
+          provider = "prisma-client-js"
+        }
+
+        datasource db {
+          provider = "postgresql"
+          url      = "env(TEST_DATABASE_URL)"
+        }
+
+        model nodes {
+          id Int @id @default(autoincrement())
+          _nodes__nodes_node_aTonodes _nodes[] @relation("_nodes_node_aTonodes") @ignore
+          _nodes__nodes_node_bTonodes _nodes[] @relation("_nodes_node_bTonodes") @ignore
+        }
 
-    assert!(api.introspect().await.is_ok());
+        /// The underlying table does not contain a valid unique identifier and can therefore currently not be handled by the Prisma Client.
+        model _nodes {
+        node_a Int
+        node_b Int
+        nodes__nodes_node_aTonodes nodes @relation("_nodes_node_aTonodes", fields: [node_a], references: [id], onDelete: Cascade)
+        nodes__nodes_node_bTonodes nodes @relation("_nodes_node_bTonodes", fields: [node_b], references: [id], onDelete: Cascade)
 
+        @@ignore
+        }
+    "#]];
+    api.expect_datamodel(&expected).await;
     Ok(())
 }
 

diff --git a/libs/datamodel/core/src/lib.rs b/libs/datamodel/core/src/lib.rs
@@ -122,8 +122,7 @@ pub fn parse_schema_parserdb(file: impl Into<SourceFile>) -> Result<ValidatedSch
     let preview_features = preview_features(&generators);
     let datasources = load_sources(db.ast(), preview_features, &mut diagnostics);
 
-    let out = validate(db, &datasources, preview_features, diagnostics);
-
+    let mut out = validate(db, &datasources, preview_features, diagnostics);
     out.diagnostics
         .to_result()
         .map_err(|err| err.to_pretty_string("schema.prisma", file.as_str()))?;
@@ -178,7 +177,7 @@ fn parse_datamodel_internal(
             },
             datamodel,
         ),
-        warnings: out.diagnostics.warnings().to_vec(),
+        warnings: out.diagnostics.into_warnings(),
     })
 }
 
@@ -209,7 +208,7 @@ pub fn parse_configuration(schema: &str) -> Result<ValidatedConfiguration, diagn
             generators,
             datasources,
         },
-        warnings: diagnostics.warnings().to_owned(),
+        warnings: diagnostics.into_warnings(),
     })
 }
 
@@ -248,11 +247,11 @@ pub fn render_datamodel_and_config_to_string(
 }
 
 /// Renders as a string into the stream.
-fn render_schema_ast(schema: &ast::SchemaAst, ident_width: usize) -> String {
-    let mut out = String::with_capacity(schema.tops.len() * 20);
-    let mut renderer = schema_ast::renderer::Renderer::new(&mut out, ident_width);
+fn render_schema_ast(schema: &ast::SchemaAst, indent_width: usize) -> String {
+    let mut renderer = schema_ast::renderer::Renderer::new(indent_width);
+    renderer.stream.reserve(schema.tops.len() * 20);
     renderer.render(schema);
-    reformat(&out, 2).expect("Internal error: failed to reformat introspected schema")
+    reformat(&renderer.stream, 2).expect("Internal error: failed to reformat introspected schema")
 }
 
 fn preview_features(generators: &[Generator]) -> BitFlags<PreviewFeature> {

diff --git a/libs/datamodel/core/src/mcf.rs b/libs/datamodel/core/src/mcf.rs
@@ -23,6 +23,6 @@ fn model_to_serializable(config: &ValidatedConfiguration) -> SerializeableMcf {
     SerializeableMcf {
         generators: generator::generators_to_json_value(&config.subject.generators),
         datasources: source::render_sources_to_json_value(&config.subject.datasources),
-        warnings: config.warnings.iter().map(|f| f.description()).collect(),
+        warnings: config.warnings.iter().map(|f| f.message().to_owned()).collect(),
     }
 }
diff --git a/libs/datamodel/core/src/transform/ast_to_dml/common.rs b/libs/datamodel/core/src/transform/ast_to_dml/common.rs
@@ -9,19 +9,16 @@ pub fn parse_and_validate_preview_features(
     preview_features: Vec<String>,
     feature_map: &FeatureMap,
     span: ast::Span,
-) -> (Vec<PreviewFeature>, Diagnostics) {
-    let mut diagnostics = Diagnostics::new();
+    diagnostics: &mut Diagnostics,
+) -> Vec<PreviewFeature> {
     let mut features = vec![];
 
     for feature_str in preview_features {
         let feature_opt = PreviewFeature::parse_opt(&feature_str);
         match feature_opt {
             Some(feature) if feature_map.is_deprecated(&feature) => {
                 features.push(feature);
-                diagnostics.push_warning(DatamodelWarning::new_deprecated_preview_feature_warning(
-                    &feature_str,
-                    span,
-                ))
+                diagnostics.push_warning(DatamodelWarning::new_feature_deprecated(&feature_str, span));
             }
 
             Some(feature) if !feature_map.is_valid(&feature) => {
@@ -42,5 +39,5 @@ pub fn parse_and_validate_preview_features(
         }
     }
 
-    (features, diagnostics)
+    features
 }
diff --git a/libs/datamodel/core/src/transform/ast_to_dml/generator_loader.rs b/libs/datamodel/core/src/transform/ast_to_dml/generator_loader.rs
@@ -107,8 +107,7 @@ impl GeneratorLoader {
 
         let preview_features = match preview_features_arg {
             Some((Ok(arr), span)) => {
-                let (features, mut diag) = parse_and_validate_preview_features(arr, &GENERATOR, span);
-                diagnostics.append(&mut diag);
+                let features = parse_and_validate_preview_features(arr, &GENERATOR, span, diagnostics);
 
                 Some(features)
             }

diff --git a/libs/datamodel/core/tests/attributes/builtin_attributes.rs b/libs/datamodel/core/tests/attributes/builtin_attributes.rs
@@ -40,7 +40,7 @@ fn duplicate_attributes_should_error() {
           [1;94m-->[0m  [4mschema.prisma:3[0m
         [1;94m   | [0m
         [1;94m 2 | [0m  id String @id
-        [1;94m 3 | [0m  unique String @[1;91munique[0m @unique
+        [1;94m 3 | [0m  unique String @[1;91munique [0m@unique
         [1;94m   | [0m
         [1;91merror[0m: [1mAttribute "@unique" is defined twice.[0m
           [1;94m-->[0m  [4mschema.prisma:3[0m

diff --git a/libs/datamodel/core/tests/attributes/id_negative.rs b/libs/datamodel/core/tests/attributes/id_negative.rs
@@ -1106,7 +1106,7 @@ fn mongodb_no_unique_index_for_id() {
           [1;94m-->[0m  [4mschema.prisma:12[0m
         [1;94m   | [0m
         [1;94m11 | [0mmodel User {
-        [1;94m12 | [0m  id String @[1;91munique[0m @id @map("_id") @test.ObjectId
+        [1;94m12 | [0m  id String @[1;91munique [0m@id @map("_id") @test.ObjectId
         [1;94m   | [0m
     "#]];
 

diff --git a/libs/datamodel/core/tests/attributes/index_negative.rs b/libs/datamodel/core/tests/attributes/index_negative.rs
@@ -103,7 +103,7 @@ fn index_does_not_accept_missing_length_with_extended_indexes() {
           [1;94m-->[0m  [4mschema.prisma:14[0m
         [1;94m   | [0m
         [1;94m13 | [0m         id         Int    @id
-        [1;94m14 | [0m         firstName  String @[1;91munique[0m @test.Text
+        [1;94m14 | [0m         firstName  String @[1;91munique [0m@test.Text
         [1;94m   | [0m
         [1;91merror[0m: [1mYou cannot define an index on fields with native type `Text` of MySQL. Please use the `length` argument to the field in the index definition to allow this.[0m
           [1;94m-->[0m  [4mschema.prisma:16[0m

diff --git a/libs/datamodel/core/tests/base/comments.rs b/libs/datamodel/core/tests/base/comments.rs
@@ -32,8 +32,7 @@ fn free_floating_doc_comments_must_work_in_models() {
     }
     "#;
 
-    // must not crash
-    let _ = parse(dml);
+    assert_valid(dml);
 }
 
 #[test]
@@ -44,8 +43,7 @@ fn free_floating_doc_comments_must_work_in_enums() {
       /// documentation comment
     }"#;
 
-    // must not crash
-    let _ = parse(dml);
+    assert_valid(dml);
 }
 
 #[test]
@@ -57,8 +55,7 @@ fn doc_comments_must_work_on_block_attributes() {
       @@id([id1, id2]) /// Documentation comment block attribute
     }"#;
 
-    // must not crash
-    let _ = parse(dml);
+    assert_valid(dml);
 }
 
 #[test]
@@ -70,8 +67,7 @@ fn comments_must_work_on_block_attributes() {
       @@id([id1, id2]) // Documentation comment block attribute
     }"#;
 
-    // must not crash
-    let _ = parse(dml);
+    assert_valid(dml);
 }
 
 #[test]
@@ -87,7 +83,6 @@ fn comments_must_work_in_enums() {
       // Comment below
     }"#;
 
-    // must not crash
     let schema = parse(dml);
     schema
         .assert_has_enum("Role")
@@ -136,8 +131,7 @@ fn comments_in_a_generator_must_work() {
     }
     "#;
 
-    // must not crash
-    let _ = parse(dml);
+    assert_valid(dml);
 }
 
 #[test]
@@ -150,8 +144,7 @@ fn comments_in_a_datasource_must_work() {
         }
     "#;
 
-    // must not crash
-    let _ = parse(dml);
+    assert_valid(dml);
 }
 
 #[test]

diff --git a/libs/datamodel/core/tests/common/mod.rs b/libs/datamodel/core/tests/common/mod.rs
@@ -297,6 +297,7 @@ impl ModelAsserts for dml::Model {
         self
     }
 
+    #[track_caller]
     fn assert_with_documentation(&self, t: &str) -> &Self {
         assert_eq!(self.documentation, Some(t.to_owned()));
         self

diff --git a/libs/datamodel/core/tests/config/nice_warnings.rs b/libs/datamodel/core/tests/config/nice_warnings.rs
@@ -1,6 +1,5 @@
 use crate::common::*;
-use datamodel::ast::Span;
-use datamodel::diagnostics::DatamodelWarning;
+use diagnostics::{DatamodelWarning, Span};
 
 #[test]
 fn nice_warning_for_deprecated_generator_preview_feature() {
@@ -13,9 +12,8 @@ fn nice_warning_for_deprecated_generator_preview_feature() {
 
     let res = datamodel::parse_configuration(schema).unwrap();
 
-    res.warnings
-        .assert_is(DatamodelWarning::new_deprecated_preview_feature_warning(
-            "middlewares",
-            Span::new(88, 103),
-        ));
+    res.warnings.assert_is(DatamodelWarning::new_feature_deprecated(
+        "middlewares",
+        Span::new(88, 103),
+    ));
 }