feat(dmmf): include primary keys in indexes section

prisma · Jul 10, 2024 · ac9a360 · ac9a360
1 parent d45499b
commit ac9a360
Show file tree

Hide file tree

Showing 17 changed files with 614 additions and 42 deletions.
diff --git a/prisma-fmt/src/get_datamodel.rs b/prisma-fmt/src/get_datamodel.rs
@@ -192,6 +192,18 @@ mod tests {
               ],
               "types": [],
               "indexes": [
+                {
+                  "model": "User",
+                  "type": "id",
+                  "isDefinedOnField": true,
+                  "fields": [
+                    {
+                      "path": [
+                        "id"
+                      ]
+                    }
+                  ]
+                },
                 {
                   "model": "User",
                   "type": "unique",
@@ -204,6 +216,18 @@ mod tests {
                     }
                   ]
                 },
+                {
+                  "model": "Post",
+                  "type": "id",
+                  "isDefinedOnField": true,
+                  "fields": [
+                    {
+                      "path": [
+                        "id"
+                      ]
+                    }
+                  ]
+                },
                 {
                   "model": "Post",
                   "type": "normal",

diff --git a/prisma-fmt/src/get_dmmf.rs b/prisma-fmt/src/get_dmmf.rs
@@ -468,6 +468,18 @@ mod tests {
                 ],
                 "types": [],
                 "indexes": [
+                  {
+                    "model": "A",
+                    "type": "id",
+                    "isDefinedOnField": true,
+                    "fields": [
+                      {
+                        "path": [
+                          "id"
+                        ]
+                      }
+                    ]
+                  },
                   {
                     "model": "A",
                     "type": "unique",
@@ -479,6 +491,18 @@ mod tests {
                         ]
                       }
                     ]
+                  },
+                  {
+                    "model": "B",
+                    "type": "id",
+                    "isDefinedOnField": true,
+                    "fields": [
+                      {
+                        "path": [
+                          "id"
+                        ]
+                      }
+                    ]
                   }
                 ]
               },

diff --git a/query-engine/dmmf/src/ast_builders/datamodel_ast_builder.rs b/query-engine/dmmf/src/ast_builders/datamodel_ast_builder.rs
@@ -1,6 +1,6 @@
 use crate::serialization_ast::{
     datamodel_ast::{Datamodel, Enum, EnumValue, Field, Function, Model, PrimaryKey, UniqueIndex},
-    Index, IndexField,
+    Index, IndexField, IndexType,
 };
 use bigdecimal::ToPrimitive;
 use itertools::Either;
@@ -243,34 +243,56 @@ fn relation_field_to_dmmf(field: walkers::RelationFieldWalker<'_>) -> Field {
 }
 
 fn model_indexes_to_dmmf(model: walkers::ModelWalker<'_>) -> impl Iterator<Item = Index> + '_ {
-    model.indexes().map(move |index| Index {
-        model: model.name().to_owned(),
-        r#type: index.index_type().into(),
-        is_defined_on_field: index.is_defined_on_field(),
-        name: index.name().map(ToOwned::to_owned),
-        mapped_name: index.mapped_name().map(ToOwned::to_owned),
-        algorithm: index.algorithm().map(|alg| alg.to_string()),
-        clustered: index.clustered(),
-        fields: index
-            .scalar_field_attributes()
-            .map(|sfa| IndexField {
-                path: sfa
-                    .as_path_to_indexed_field()
-                    .into_iter()
-                    .map(|(field_name, type_name)| match type_name {
-                        None => field_name.to_owned(),
-                        Some(type_name) => format!("{type_name}.{field_name}"),
-                    })
+    model
+        .primary_key()
+        .into_iter()
+        .map(move |pk| Index {
+            model: model.name().to_owned(),
+            r#type: IndexType::Id,
+            is_defined_on_field: pk.is_defined_on_field(),
+            name: pk.name().map(ToOwned::to_owned),
+            mapped_name: pk.mapped_name().map(ToOwned::to_owned),
+            algorithm: None,
+            clustered: pk.clustered(),
+            fields: pk
+                .scalar_field_attributes()
+                .map(scalar_field_attribute_to_dmmf)
+                .collect(),
+        })
+        .chain(model.indexes().map(move |index| {
+            Index {
+                model: model.name().to_owned(),
+                r#type: index.index_type().into(),
+                is_defined_on_field: index.is_defined_on_field(),
+                name: index.name().map(ToOwned::to_owned),
+                mapped_name: index.mapped_name().map(ToOwned::to_owned),
+                algorithm: index.algorithm().map(|alg| alg.to_string()),
+                clustered: index.clustered(),
+                fields: index
+                    .scalar_field_attributes()
+                    .map(scalar_field_attribute_to_dmmf)
                     .collect(),
-                sort_order: sfa.sort_order().map(Into::into),
-                length: sfa.length(),
-                operator_class: sfa.operator_class().map(|oc| match oc.get() {
-                    Either::Left(oc) => oc.to_string(),
-                    Either::Right(oc) => oc.to_owned(),
-                }),
+            }
+        }))
+}
+
+fn scalar_field_attribute_to_dmmf(sfa: walkers::ScalarFieldAttributeWalker<'_>) -> IndexField {
+    IndexField {
+        path: sfa
+            .as_path_to_indexed_field()
+            .into_iter()
+            .map(|(field_name, type_name)| match type_name {
+                None => field_name.to_owned(),
+                Some(type_name) => format!("{type_name}.{field_name}"),
             })
             .collect(),
-    })
+        sort_order: sfa.sort_order().map(Into::into),
+        length: sfa.length(),
+        operator_class: sfa.operator_class().map(|oc| match oc.get() {
+            Either::Left(oc) => oc.to_string(),
+            Either::Right(oc) => oc.to_owned(),
+        }),
+    }
 }
 
 fn default_value_to_serde(dv: &DefaultKind) -> serde_json::Value {

diff --git a/query-engine/dmmf/src/serialization_ast/datamodel_ast.rs b/query-engine/dmmf/src/serialization_ast/datamodel_ast.rs
@@ -141,31 +141,36 @@ pub struct IndexField {
     pub operator_class: Option<String>,
 }
 
-macro_rules! convert_enum {
-    ( $from:path => $to:ident { $( $variant:ident, )+ } ) => {
-        #[derive(Debug, serde::Serialize)]
-        #[serde(rename_all = "camelCase")]
-        pub enum $to {
-            $( $variant, )+
-        }
-
+macro_rules! from {
+    ( $from:path => $to:ident { $( $variant:ident ),+ } ) => {
         impl From<$from> for $to {
             fn from(value: $from) -> Self {
                 match value {
-                    $( <$from>::$variant => <$to>::$variant, )+
+                    $( <$from>::$variant => <$to>::$variant ),+
                 }
             }
         }
     };
 }
 
-convert_enum!(psl::parser_database::IndexType => IndexType {
+#[derive(Debug, serde::Serialize)]
+#[serde(rename_all = "camelCase")]
+pub enum IndexType {
+    Id,
     Normal,
     Unique,
     Fulltext,
-});
+}
 
-convert_enum!(psl::parser_database::SortOrder => SortOrder {
+// `Id` doesn't exist in `psl::parser_database::IndexType` as primary keys are not represented as
+// such on that level, so we only generate the From impl for the other three variants.
+from!(psl::parser_database::IndexType => IndexType { Normal, Unique, Fulltext });
+
+#[derive(Debug, serde::Serialize)]
+#[serde(rename_all = "camelCase")]
+pub enum SortOrder {
     Asc,
     Desc,
-});
+}
+
+from!(psl::parser_database::SortOrder => SortOrder { Asc, Desc });
diff --git a/query-engine/dmmf/src/tests/test-schemas/snapshots/odoo.snapshot.json.gz b/query-engine/dmmf/src/tests/test-schemas/snapshots/odoo.snapshot.json.gz
diff --git a/query-engine/dmmf/test_files/functions.json b/query-engine/dmmf/test_files/functions.json
@@ -61,6 +61,18 @@
   ],
   "types": [],
   "indexes": [
+    {
+      "model": "User",
+      "type": "id",
+      "isDefinedOnField": true,
+      "fields": [
+        {
+          "path": [
+            "id"
+          ]
+        }
+      ]
+    },
     {
       "model": "User",
       "type": "unique",

diff --git a/query-engine/dmmf/test_files/general.json b/query-engine/dmmf/test_files/general.json
@@ -727,6 +727,18 @@
   ],
   "types": [],
   "indexes": [
+    {
+      "model": "User",
+      "type": "id",
+      "isDefinedOnField": true,
+      "fields": [
+        {
+          "path": [
+            "id"
+          ]
+        }
+      ]
+    },
     {
       "model": "User",
       "type": "unique",
@@ -739,6 +751,18 @@
         }
       ]
     },
+    {
+      "model": "Profile",
+      "type": "id",
+      "isDefinedOnField": true,
+      "fields": [
+        {
+          "path": [
+            "id"
+          ]
+        }
+      ]
+    },
     {
       "model": "Profile",
       "type": "unique",
@@ -751,6 +775,47 @@
         }
       ]
     },
+    {
+      "model": "Post",
+      "type": "id",
+      "isDefinedOnField": false,
+      "fields": [
+        {
+          "path": [
+            "title"
+          ]
+        },
+        {
+          "path": [
+            "createdAt"
+          ]
+        }
+      ]
+    },
+    {
+      "model": "Category",
+      "type": "id",
+      "isDefinedOnField": true,
+      "fields": [
+        {
+          "path": [
+            "id"
+          ]
+        }
+      ]
+    },
+    {
+      "model": "PostToCategory",
+      "type": "id",
+      "isDefinedOnField": true,
+      "fields": [
+        {
+          "path": [
+            "id"
+          ]
+        }
+      ]
+    },
     {
       "model": "PostToCategory",
       "type": "unique",
@@ -768,6 +833,18 @@
         }
       ]
     },
+    {
+      "model": "A",
+      "type": "id",
+      "isDefinedOnField": true,
+      "fields": [
+        {
+          "path": [
+            "id"
+          ]
+        }
+      ]
+    },
     {
       "model": "A",
       "type": "unique",
@@ -780,6 +857,37 @@
         }
       ]
     },
+    {
+      "model": "B",
+      "type": "id",
+      "isDefinedOnField": true,
+      "fields": [
+        {
+          "path": [
+            "id"
+          ]
+        }
+      ]
+    },
+    {
+      "model": "NamedCompounds",
+      "type": "id",
+      "isDefinedOnField": false,
+      "name": "MyPrimary",
+      "mappedName": "DbPrimary",
+      "fields": [
+        {
+          "path": [
+            "a"
+          ]
+        },
+        {
+          "path": [
+            "b"
+          ]
+        }
+      ]
+    },
     {
       "model": "NamedCompounds",
       "type": "unique",
@@ -799,6 +907,19 @@
         }
       ]
     },
+    {
+      "model": "MappedSingles",
+      "type": "id",
+      "isDefinedOnField": true,
+      "mappedName": "Primary",
+      "fields": [
+        {
+          "path": [
+            "a"
+          ]
+        }
+      ]
+    },
     {
       "model": "MappedSingles",
       "type": "unique",