Merge pull request #300 from Atypical-Consulting/fix/fk-constraints

fix: generate FOREIGN KEY constraints in DatabaseInitializer

Author: phmatray

src/templates/Ninjadog.Templates.CrudWebApi/Template/Database/DatabaseInitializerTemplate.cs

@@ -49,16 +49,17 @@ private static string GenerateCreateTableSqlQueries(List<NinjadogEntityWithKey>
         {
             stringBuilder
                 .AppendLine()
-                .AppendLine($"await connection.ExecuteAsync(@\"{GenerateSqlCreateTableQuery(entity, enumNames, softDelete, auditing, provider)}\");");
+                .AppendLine($"await connection.ExecuteAsync(@\"{GenerateSqlCreateTableQuery(entity, entities, enumNames, softDelete, auditing, provider)}\");");
         }
 
         return stringBuilder.ToString();
     }
 
-    private static string GenerateSqlCreateTableQuery(NinjadogEntityWithKey entity, HashSet<string>? enumNames, bool softDelete, bool auditing, string provider)
+    private static string GenerateSqlCreateTableQuery(NinjadogEntityWithKey entity, List<NinjadogEntityWithKey> allEntities, HashSet<string>? enumNames, bool softDelete, bool auditing, string provider)
     {
         var st = entity.StringTokens;
         var entityKey = entity.Properties.GetEntityKey();
+        var fkConstraints = GetForeignKeyConstraints(entity, allEntities);
         IndentedStringBuilder stringBuilder = new(0);
 
         stringBuilder
@@ -74,7 +75,7 @@ private static string GenerateSqlCreateTableQuery(NinjadogEntityWithKey entity,
         {
             var p = nonKeyProperties[i];
             var isLast = i == nonKeyProperties.Count - 1;
-            var needsComma = !isLast || softDelete || auditing;
+            var needsComma = !isLast || softDelete || auditing || fkConstraints.Count > 0;
 
             if (needsComma)
             {
@@ -88,7 +89,7 @@ private static string GenerateSqlCreateTableQuery(NinjadogEntityWithKey entity,
 
         if (softDelete)
         {
-            var needsComma = auditing;
+            var needsComma = auditing || fkConstraints.Count > 0;
             stringBuilder
                 .AppendLine("IsDeleted INTEGER NOT NULL DEFAULT 0,")
                 .Append(needsComma ? "DeletedAt TEXT," : "DeletedAt TEXT)");
@@ -100,14 +101,77 @@ private static string GenerateSqlCreateTableQuery(NinjadogEntityWithKey entity,
 
         if (auditing)
         {
+            var needsComma = fkConstraints.Count > 0;
             stringBuilder
-                .AppendLine("CreatedAt TEXT NOT NULL,")
-                .Append("UpdatedAt TEXT)");
+                .AppendLine("CreatedAt TEXT NOT NULL,");
+            if (needsComma)
+            {
+                stringBuilder.AppendLine("UpdatedAt TEXT,");
+            }
+            else
+            {
+                stringBuilder.Append("UpdatedAt TEXT)");
+            }
+        }
+
+        for (var i = 0; i < fkConstraints.Count; i++)
+        {
+            var (fkColumn, parentTable, parentPk) = fkConstraints[i];
+            var isLast = i == fkConstraints.Count - 1;
+            var constraint = $"FOREIGN KEY ({fkColumn}) REFERENCES {parentTable}({parentPk})";
+
+            if (isLast)
+            {
+                stringBuilder.Append($"{constraint})");
+            }
+            else
+            {
+                stringBuilder.AppendLine($"{constraint},");
+            }
         }
 
         return stringBuilder.ToString();
     }
 
+    private static List<(string FkColumn, string ParentTable, string ParentPk)> GetForeignKeyConstraints(
+        NinjadogEntityWithKey entity, List<NinjadogEntityWithKey> allEntities)
+    {
+        var constraints = new List<(string FkColumn, string ParentTable, string ParentPk)>();
+
+        foreach (var potentialParent in allEntities)
+        {
+            if (potentialParent.Relationships == null)
+            {
+                continue;
+            }
+
+            foreach (var (_, relationship) in potentialParent.Relationships)
+            {
+                if (relationship.RelatedEntity != entity.Key)
+                {
+                    continue;
+                }
+
+                if (relationship.RelationshipType is not (NinjadogEntityRelationshipType.OneToMany or NinjadogEntityRelationshipType.OneToOne))
+                {
+                    continue;
+                }
+
+                var parentPk = potentialParent.Properties.GetEntityKey();
+                var fkColumnName = parentPk.Key == "Id"
+                    ? $"{potentialParent.Key}Id"
+                    : parentPk.Key;
+
+                if (entity.Properties.ContainsKey(fkColumnName))
+                {
+                    constraints.Add((fkColumnName, potentialParent.StringTokens.Models, parentPk.Key));
+                }
+            }
+        }
+
+        return constraints;
+    }
+
     private static string MapToDbType(string typeName, string provider, HashSet<string>? enumNames = null)
     {
         return enumNames?.Contains(typeName) == true

src/tests/Ninjadog.Tests/Templates/DatabaseInitializerTemplateTests.GenerateOne_WithRelationships_AddsForeignKeyConstraints.verified.txt

@@ -0,0 +1,35 @@
+//------------------------------------------------------------------------------
+// This code was powered by the Ninjadog Engine
+//
+// Developed by: Atypical Consulting SRL - Philippe Matray
+// Generated on: [SCRUBBED]
+// Version     : [SCRUBBED]
+//
+// This file is part of a custom software solution crafted to meet your
+// specific needs. For optimal performance and compatibility, modifications
+// should be coordinated with Ninjadog support services.
+//------------------------------------------------------------------------------
+
+using Dapper;
+
+namespace TestApp.Api.Database;
+
+public partial class DatabaseInitializer(IDbConnectionFactory connectionFactory)
+{
+    public async Task InitializeAsync()
+    {
+        using var connection = await connectionFactory.CreateConnectionAsync();
+        
+        await connection.ExecuteAsync(@"CREATE TABLE IF NOT EXISTS Authors (
+            Id CHAR(36) PRIMARY KEY,
+            Name TEXT NOT NULL)");
+
+        await connection.ExecuteAsync(@"CREATE TABLE IF NOT EXISTS Posts (
+            Id CHAR(36) PRIMARY KEY,
+            Title TEXT NOT NULL,
+            Content TEXT NOT NULL,
+            AuthorId CHAR(36) NOT NULL,
+            FOREIGN KEY (AuthorId) REFERENCES Authors(Id))");
+
+    }
+}

src/tests/Ninjadog.Tests/Templates/DatabaseInitializerTemplateTests.cs

@@ -30,4 +30,12 @@ public Task GenerateOne_WithAuditing_AddsAuditColumns()
         var result = _template.GenerateOne(settings);
         return Verify(result.Content);
     }
+
+    [Fact]
+    public Task GenerateOne_WithRelationships_AddsForeignKeyConstraints()
+    {
+        var settings = new RelationshipSettings();
+        var result = _template.GenerateOne(settings);
+        return Verify(result.Content);
+    }
 }