Reserved names replacement in tables! is also applied in joinable!

Author: meven

diesel_cli/src/infer_schema_internals/data_structures.rs

@@ -102,6 +102,7 @@ pub struct ForeignKeyConstraint {
     pub child_table: TableName,
     pub parent_table: TableName,
     pub foreign_key: String,
+    pub foreign_key_rust_name: String,
     pub primary_key: String,
 }
 

diesel_cli/src/infer_schema_internals/inference.rs

@@ -109,6 +109,12 @@ pub fn load_foreign_key_constraints(
 
     constraints.map(|mut ct| {
         ct.sort();
+        ct.iter_mut().for_each(|foreign_key_constraint| {
+            if RESERVED_NAMES.contains(&foreign_key_constraint.foreign_key_rust_name.as_str()) {
+                foreign_key_constraint.foreign_key_rust_name =
+                    format!("{}_", foreign_key_constraint.foreign_key_rust_name.as_str());
+            }
+        });
         ct
     })
 }

diesel_cli/src/infer_schema_internals/information_schema.rs

@@ -239,7 +239,7 @@ where
                     .filter(kcu::constraint_schema.eq(&foreign_key_schema))
                     .filter(kcu::constraint_name.eq(&foreign_key_name))
                     .select(((kcu::table_name, kcu::table_schema), kcu::column_name))
-                    .first::<(TableName, _)>(connection)?;
+                    .first::<(TableName, String)>(connection)?;
                 let (mut primary_key_table, primary_key_column) = kcu::table
                     .filter(kcu::constraint_schema.eq(primary_key_schema))
                     .filter(kcu::constraint_name.eq(primary_key_name))
@@ -252,7 +252,8 @@ where
                 Ok(ForeignKeyConstraint {
                     child_table: foreign_key_table,
                     parent_table: primary_key_table,
-                    foreign_key: foreign_key_column,
+                    foreign_key: foreign_key_column.clone(),
+                    foreign_key_rust_name: foreign_key_column,
                     primary_key: primary_key_column,
                 })
             },
@@ -462,12 +463,14 @@ mod tests {
             child_table: table_2.clone(),
             parent_table: table_1.clone(),
             foreign_key: "fk_one".into(),
+            foreign_key_rust_name: "fk_one".into(),
             primary_key: "id".into(),
         };
         let fk_two = ForeignKeyConstraint {
             child_table: table_3.clone(),
             parent_table: table_2.clone(),
             foreign_key: "fk_two".into(),
+            foreign_key_rust_name: "fk_two".into(),
             primary_key: "id".into(),
         };
         assert_eq!(

diesel_cli/src/infer_schema_internals/mysql.rs

@@ -62,16 +62,18 @@ pub fn load_foreign_key_constraints(
             kcu::column_name,
             kcu::referenced_column_name,
         ))
-        .load::<(TableName, TableName, _, _)>(connection)?
+        .load::<(TableName, TableName, String, _)>(connection)?
         .into_iter()
         .map(
             |(mut child_table, mut parent_table, foreign_key, primary_key)| {
                 child_table.strip_schema_if_matches(&default_schema);
                 parent_table.strip_schema_if_matches(&default_schema);
+
                 ForeignKeyConstraint {
                     child_table,
                     parent_table,
-                    foreign_key,
+                    foreign_key: foreign_key.clone(),
+                    foreign_key_rust_name: foreign_key,
                     primary_key,
                 }
             },

diesel_cli/src/infer_schema_internals/sqlite.rs

@@ -77,7 +77,8 @@ pub fn load_foreign_key_constraints(
                     ForeignKeyConstraint {
                         child_table: child_table.clone(),
                         parent_table,
-                        foreign_key: row.foreign_key,
+                        foreign_key: row.foreign_key.clone(),
+                        foreign_key_rust_name: row.foreign_key,
                         primary_key: row.primary_key,
                     }
                 })
@@ -290,12 +291,14 @@ fn load_foreign_key_constraints_loads_foreign_keys() {
         child_table: table_2.clone(),
         parent_table: table_1.clone(),
         foreign_key: "fk_one".into(),
+        foreign_key_rust_name: "fk_one".into(),
         primary_key: "id".into(),
     };
     let fk_two = ForeignKeyConstraint {
         child_table: table_3.clone(),
         parent_table: table_2.clone(),
         foreign_key: "fk_two".into(),
+        foreign_key_rust_name: "fk_two".into(),
         primary_key: "id".into(),
     };
     let fks = load_foreign_key_constraints(&connection, None).unwrap();

diesel_cli/src/print_schema.rs

@@ -249,7 +249,7 @@ impl<'a> Display for Joinable<'a> {
         write!(
             f,
             "joinable!({} -> {} ({}));",
-            self.0.child_table.name, self.0.parent_table.name, self.0.foreign_key,
+            self.0.child_table.name, self.0.parent_table.name, self.0.foreign_key_rust_name,
         )
     }
 }

diesel_cli/tests/print_schema.rs

@@ -64,6 +64,15 @@ fn print_schema_with_foreign_keys() {
     test_print_schema("print_schema_with_foreign_keys", vec!["--with-docs"]);
 }
 
+#[test]
+#[cfg(feature = "postgres")]
+fn print_schema_with_foreign_keys_reserved_names() {
+    test_print_schema(
+        "print_schema_with_foreign_keys_reserved_names",
+        vec!["--with-docs"],
+    );
+}
+
 #[test]
 fn print_schema_column_renaming() {
     test_print_schema("print_schema_column_renaming", vec!["--with-docs"]);

diesel_cli/tests/print_schema/print_schema_with_foreign_keys_reserved_names/diesel.toml

@@ -0,0 +1,3 @@
+[print_schema]
+file = "src/schema.rs"
+with_docs = true

diesel_cli/tests/print_schema/print_schema_with_foreign_keys_reserved_names/postgres/expected.rs

@@ -0,0 +1,41 @@
+table! {
+    /// Representation of the `posts` table.
+    ///
+    /// (Automatically generated by Diesel.)
+    posts (id) {
+        /// The `id` column of the `posts` table.
+        ///
+        /// Its SQL type is `Int4`.
+        ///
+        /// (Automatically generated by Diesel.)
+        id -> Int4,
+        /// The `type` column of the `posts` table.
+        ///
+        /// Its SQL type is `Int4`.
+        ///
+        /// (Automatically generated by Diesel.)
+        #[sql_name = "type"]
+        type_ -> Int4,
+    }
+}
+
+table! {
+    /// Representation of the `users` table.
+    ///
+    /// (Automatically generated by Diesel.)
+    users (id) {
+        /// The `id` column of the `users` table.
+        ///
+        /// Its SQL type is `Int4`.
+        ///
+        /// (Automatically generated by Diesel.)
+        id -> Int4,
+    }
+}
+
+joinable!(posts -> users (type_));
+
+allow_tables_to_appear_in_same_query!(
+    posts,
+    users,
+);

diesel_cli/tests/print_schema/print_schema_with_foreign_keys_reserved_names/postgres/schema.sql

@@ -0,0 +1,2 @@
+CREATE TABLE users (id SERIAL PRIMARY KEY);
+CREATE TABLE posts (id SERIAL PRIMARY KEY, type INTEGER NOT NULL REFERENCES users);