add database configuration for ReferenceNumber (#1179)

* add database configuration for ReferenceNumber

Sqlite does not support this type
SQL Server Support

* remove unused code

* override sequence creation on sqlite

* add postgres tests

samples/Cryptocash.Api/Generated/Nox.Generator/Nox.Generator.NoxCodeGenerator/Infrastructure.Persistence/AppDbContext.g.cs

@@ -45,7 +45,7 @@ public AppDbContext(
             IUserProvider userProvider,
             ISystemProvider systemProvider,
             NoxCodeGenConventions codeGeneratorState
-        ) : base(publisher, userProvider, systemProvider, options)
+        ) : base(publisher, userProvider, systemProvider, databaseProvider, options)
         {
             _noxSolution = noxSolution;
             _dbProvider = databaseProvider;

src/Nox.ClientApi.Tests/.nox/design/Entitities/workplace.entity.nox.yaml

@@ -25,6 +25,16 @@ attributes:
       maxLength: 63
     isRequired: true
 
+  - name: ReferenceNumber
+    description: Workplace Code
+    type: referenceNumber
+    referenceNumberTypeOptions:
+      startsAt: 10
+      incrementsBy: 5
+      prefix: "WP-"
+      suffixCheckSumDigit: true
+    isRequired: false
+
   - name: Description
     description: Workplace Description
     type: text

src/Nox.ClientApi.Tests/Generated/Nox.Generator/Nox.Generator.NoxCodeGenerator/Application.Dto/WorkplaceDto.g.cs

@@ -43,6 +43,8 @@ public virtual IReadOnlyDictionary<string, IEnumerable<string>> Validate()
         else
             result.Add("Name", new [] { "Name is Required." });
 
+        if (this.ReferenceNumber is not null)
+            ExecuteActionAndCollectValidationExceptions("ReferenceNumber", () => DomainNamespace.WorkplaceMetadata.CreateReferenceNumber(this.ReferenceNumber.NonNullValue<System.String>()), result);
         if (this.Description is not null)
             ExecuteActionAndCollectValidationExceptions("Description", () => DomainNamespace.WorkplaceMetadata.CreateDescription(this.Description.NonNullValue<System.String>()), result); 
 
@@ -61,6 +63,12 @@ public virtual IReadOnlyDictionary<string, IEnumerable<string>> Validate()
     /// <remarks>Required.</remarks>    
     public System.String Name { get; set; } = default!;
 
+    /// <summary>
+    /// Workplace Code     
+    /// </summary>
+    /// <remarks>Optional.</remarks>    
+    public System.String? ReferenceNumber { get; set; }
+
     /// <summary>
     /// Workplace Description     
     /// </summary>

src/Nox.ClientApi.Tests/Generated/Nox.Generator/Nox.Generator.NoxCodeGenerator/Application.Extensions/WorkplaceExtensions.g.cs

@@ -15,6 +15,7 @@ public static WorkplaceDto ToDto(this ClientApi.Domain.Workplace entity)
         var dto = new WorkplaceDto();
         dto.SetIfNotNull(entity?.Id, (dto) => dto.Id = entity!.Id.Value);
         dto.SetIfNotNull(entity?.Name, (dto) => dto.Name =entity!.Name!.Value);
+        dto.SetIfNotNull(entity?.ReferenceNumber, (dto) => dto.ReferenceNumber =entity!.ReferenceNumber!.Value);
         dto.SetIfNotNull(entity?.Description, (dto) => dto.Description =entity!.Description!.Value);
         dto.SetIfNotNull(entity?.Greeting, (dto) => dto.Greeting =entity!.Greeting!.ToString());
         dto.SetIfNotNull(entity?.CountryId, (dto) => dto.CountryId = entity!.CountryId!.Value);

src/Nox.ClientApi.Tests/Generated/Nox.Generator/Nox.Generator.NoxCodeGenerator/Application.Queries/GetWorkplaceByIdQuery.g.cs

@@ -47,6 +47,7 @@ from itemLocalized in joinedData.Where(l => item.Id == l.Id).DefaultIfEmpty()
             {
         Id = item.Id,
         Name = item.Name,
+        ReferenceNumber = item.ReferenceNumber,
         Description = itemLocalized.Description ?? "[" + item.Description + "]",
         Greeting = item.Greeting,
         CountryId = item.CountryId,

src/Nox.ClientApi.Tests/Generated/Nox.Generator/Nox.Generator.NoxCodeGenerator/Application.Queries/GetWorkplacesQuery.g.cs

@@ -54,6 +54,7 @@ from itemLocalized in joinedData.Where(l => item.Id == l.Id).DefaultIfEmpty()
             {
         Id = item.Id,
         Name = item.Name,
+        ReferenceNumber = item.ReferenceNumber,
         Description = itemLocalized.Description ?? "[" + item.Description + "]",
         Greeting = item.Greeting,
         CountryId = item.CountryId,

src/Nox.ClientApi.Tests/Generated/Nox.Generator/Nox.Generator.NoxCodeGenerator/Domain/Workplace.g.cs

@@ -62,6 +62,12 @@ internal abstract partial class WorkplaceBase : EntityBase, IEntityConcurrent
     /// <remarks>Required.</remarks>   
     public Nox.Types.Text Name { get; set; } = null!;
 
+    /// <summary>
+    /// Workplace Code    
+    /// </summary>
+    /// <remarks>Optional.</remarks>   
+    public Nox.Types.ReferenceNumber? ReferenceNumber { get; set; } = null!;
+
     /// <summary>
     /// Workplace Description    
     /// </summary>

src/Nox.ClientApi.Tests/Generated/Nox.Generator/Nox.Generator.NoxCodeGenerator/Infrastructure.Persistence/AppDbContext.g.cs

@@ -45,7 +45,7 @@ public AppDbContext(
             IUserProvider userProvider,
             ISystemProvider systemProvider,
             NoxCodeGenConventions codeGeneratorState
-        ) : base(publisher, userProvider, systemProvider, options)
+        ) : base(publisher, userProvider, systemProvider, databaseProvider, options)
         {
             _noxSolution = noxSolution;
             _dbProvider = databaseProvider;

src/Nox.ClientApi.Tests/Generated/Nox.Generator/Nox.Generator.NoxCodeGenerator/Meta/WorkplaceMetadata.g.cs

@@ -43,6 +43,25 @@ public static Nox.Types.Text CreateName(System.String value)
             => Nox.Types.Text.From(value, NameTypeOptions);
 
 
+        /// <summary>
+        /// Type options for property 'ReferenceNumber'
+        /// </summary>
+        public static Nox.Types.ReferenceNumberTypeOptions ReferenceNumberTypeOptions {get; private set;} = new ()
+        {
+            StartsAt = 10,
+            IncrementsBy = 5,
+            Prefix = "WP-",
+            SuffixCheckSumDigit = true,
+        };
+
+
+        /// <summary>
+        /// Factory for property 'ReferenceNumber'
+        /// </summary>
+        public static Nox.Types.ReferenceNumber CreateReferenceNumber(System.String value)
+            => Nox.Types.ReferenceNumber.From(value, ReferenceNumberTypeOptions);
+
+
         /// <summary>
         /// Type options for property 'Description'
         /// </summary>
@@ -116,6 +135,15 @@ public static Nox.Types.Nuid CreateTenantId(System.UInt32 value)
                 .GetAttributeByName("Name")?
                 .UserInterface;
 
+        /// <summary>
+        /// User Interface for property 'ReferenceNumber'
+        /// </summary>
+        public static TypeUserInterface? ReferenceNumberUiOptions(NoxSolution solution) 
+            => solution.Domain!
+                .GetEntityByName("Workplace")
+                .GetAttributeByName("ReferenceNumber")?
+                .UserInterface;
+
         /// <summary>
         /// User Interface for property 'Description'
         /// </summary>

src/Nox.ClientApi.Tests/Tests/TestDatabaseInstanceService.cs

@@ -14,7 +14,7 @@ namespace ClientApi.Tests;
 public class TestDatabaseInstanceService : IAsyncLifetime, ITestDatabaseService
 {
 #if DEBUG    
-    public static readonly DatabaseServerProvider DbProviderKind = DatabaseServerProvider.SqlServer;
+    public static readonly DatabaseServerProvider DbProviderKind = DatabaseServerProvider.Postgres;
 #else
     public static readonly DatabaseServerProvider DbProviderKind = DatabaseServerProvider.SqlServer;
 #endif
@@ -38,8 +38,8 @@ public INoxDatabaseProvider GetDatabaseProvider(
     {        
         return DbProviderKind switch
         {
-            DatabaseServerProvider.Postgres => new PostgreSqlTestProvider("TODO", configurations, noxSolutionCodeGeneratorState, noxClientAssemblyProvider),
-            DatabaseServerProvider.SqlServer => new MsSqlTestProvider("Data Source=localhost;TrustServerCertificate=true;Initial Catalog=cleintapitests;User ID=sa;password=Developer*123;", configurations, noxSolutionCodeGeneratorState, noxClientAssemblyProvider),
+            DatabaseServerProvider.Postgres => new PostgreSqlTestProvider("Host=localhost; Database=clientapitests; Username=dev; Password=12345", configurations, noxSolutionCodeGeneratorState, noxClientAssemblyProvider),
+            DatabaseServerProvider.SqlServer => new MsSqlTestProvider("Data Source=localhost;TrustServerCertificate=true;Initial Catalog=clientapitests;User ID=sa;password=Developer*123;", configurations, noxSolutionCodeGeneratorState, noxClientAssemblyProvider),
             _ => throw new NotImplementedException($"{DbProviderKind} is not suported"),
         };
     }

src/Nox.EntityFramework.Postgres/PostgresDatabaseProvider.cs

@@ -70,4 +70,9 @@ public void UnSetStoreTypeFlag(NoxDataStoreTypeFlags storeTypeFlag)
     {
         StoreTypes &= storeTypeFlag;
     }
+
+    public string GetSqlStatementForSequenceNextValue(string sequenceName)
+    {
+        return $"SELECT nextval('{sequenceName}')";
+    }
 }

src/Nox.EntityFramework.SqlServer/SqlServerDatabaseProvider.cs

@@ -1,6 +1,7 @@
 using Microsoft.Data.SqlClient;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.EntityFrameworkCore.Metadata.Builders;
+
 using Nox.Infrastructure;
 using Nox.Solution;
 using Nox.Types;
@@ -72,4 +73,9 @@ public void UnSetStoreTypeFlag(NoxDataStoreTypeFlags storeTypeFlag)
     {
         StoreTypes &= storeTypeFlag;
     }
+
+    public string GetSqlStatementForSequenceNextValue(string sequenceName)
+    {
+       return $"SELECT NEXT VALUE FOR {sequenceName}"; 
+    }
 }

src/Nox.EntityFramework.Sqlite/SqliteDatabaseProvider.cs

@@ -48,4 +48,9 @@ public void UnSetStoreTypeFlag(NoxDataStoreTypeFlags storeTypeFlag)
     {
         StoreTypes &= storeTypeFlag;
     }
+
+    public string GetSqlStatementForSequenceNextValue(string sequenceName)
+    {
+        throw new NotSupportedException();
+    }
 }

src/Nox.EntityFramework.Sqlite/Type/SqliteReferenceNumberDatabaseConfigurator.cs

@@ -0,0 +1,16 @@
+using Microsoft.EntityFrameworkCore;
+using Nox.Solution;
+using Nox.Types;
+using Nox.Types.EntityFramework.Types;
+
+namespace Nox.EntityFramework.Sqlite.Type;
+
+public class SqliteReferenceNumberDatabaseConfigurator : ReferenceNumberDatabaseConfigurator, ISqliteNoxTypeDatabaseConfigurator
+{
+    public override bool IsDefault => false;
+
+    protected override void CreateSequence(NoxCodeGenConventions noxSolutionCodeGeneratorState, NoxSimpleTypeDefinition property, Entity entity, ModelBuilder modelBuilder, ReferenceNumberTypeOptions typeOptions)
+    {
+        //SQL Lite does not support sequences
+    }
+}

src/Nox.Generator/Infrastructure/Persistence/DbContext.template.cs

@@ -47,7 +47,7 @@ public AppDbContext(
             IUserProvider userProvider,
             ISystemProvider systemProvider,
             NoxCodeGenConventions codeGeneratorState
-        ) : base(publisher, userProvider, systemProvider, options)
+        ) : base(publisher, userProvider, systemProvider, databaseProvider, options)
         {
             _noxSolution = noxSolution;
             _dbProvider = databaseProvider;

src/Nox.Lib/Infrastructure/Persistence/EntityDbContextBase.cs

@@ -10,6 +10,8 @@
 using Microsoft.EntityFrameworkCore.Metadata.Builders;
 using System.Reflection.Emit;
 using Nox.Types.EntityFramework.Types;
+using Nox.Types.EntityFramework.Abstractions;
+using static Microsoft.EntityFrameworkCore.DbLoggerCategory.Database;
 
 namespace Nox.Infrastructure.Persistence
 {
@@ -18,18 +20,20 @@ public abstract class EntityDbContextBase : DbContext
         protected readonly IPublisher _publisher;
         protected readonly IUserProvider _userProvider;
         protected readonly ISystemProvider _systemProvider;
-
+        protected readonly INoxDatabaseProvider _databaseProvider;
 
         protected EntityDbContextBase(
             IPublisher publisher,
             IUserProvider userProvider,
             ISystemProvider systemProvider,
+            INoxDatabaseProvider databaseProvider,
             DbContextOptions options
             ) : base(options)
         {
             _publisher = publisher;
             _userProvider = userProvider;
             _systemProvider = systemProvider;
+            _databaseProvider = databaseProvider;
         }
 
         public override async Task<int> SaveChangesAsync(CancellationToken cancellationToken = new CancellationToken())
@@ -45,6 +49,23 @@ DbContextOptions options
                 throw new Nox.Exceptions.ConcurrencyException($"Latest value of {nameof(IEntityConcurrent.Etag)} must be provided", HttpStatusCode.Conflict);
             }
         }
+
+        public virtual async Task<long> GetSequenceNextValueAsync(string sequenceName)
+        {
+            var connection = base.Database.GetDbConnection();            
+            try
+            {
+                await connection.OpenAsync();
+                using var cmd = connection.CreateCommand();
+                cmd.CommandText = _databaseProvider.GetSqlStatementForSequenceNextValue(sequenceName);
+                var result = await cmd.ExecuteScalarAsync();
+                return (long)result!;
+            }
+            finally
+            {
+                await connection.CloseAsync();
+            }
+        }
         protected virtual async Task HandleDomainEvents()
         {
             var entriesWithDomainEvents = GetEntriesWithDomainEvents();
@@ -67,7 +88,6 @@ protected virtual void HandleSystemFields()
                 TrackConcurrency(entry);
             }
         }
-
         protected virtual void AuditEntity(EntityEntry<AuditableEntityBase> entry)
         {
             var user = _userProvider.GetUser();
@@ -91,7 +111,6 @@ protected virtual void AuditEntity(EntityEntry<AuditableEntityBase> entry)
                     break;
             }
         }
-
         private void ReattachOwnedEntries<T>(EntityEntry<AuditableEntityBase> parentEntry)
             where T : class
         {
@@ -172,15 +191,15 @@ protected virtual void ClearDomainEvents(List<EntityEntry<IEntityHaveDomainEvent
         protected virtual void ConfigureEnumeration(EntityTypeBuilder enumModelBuilder, EnumerationTypeOptions enumTypeOptions)
         {
             enumModelBuilder.HasKey(nameof(EnumerationBase.Id));
-            
+
             enumModelBuilder
                 .Property(nameof(EnumerationBase.Id))
                 .HasConversion<EnumerationConverter>();
 
             enumModelBuilder
                 .Property(nameof(EnumerationBase.Name))
                 .IsRequired(true);
- 
+
             foreach (var enumValue in enumTypeOptions.Values)
             {
                 enumModelBuilder.HasData(new { Id = Enumeration.From(enumValue.Id, enumTypeOptions), Name = enumValue.Name });
@@ -205,7 +224,7 @@ protected virtual void ConfigureEnumerationLocalized(EntityTypeBuilder enumModel
                 .IsFixedLength(false)
                 .HasMaxLength(10)
                 .HasConversion<CultureCodeConverter>();
-            
+
             enumModelBuilder
                 .HasOne(enumType)
                 .WithMany()

src/Nox.Solution/NoxCodeGenConventions.cs

@@ -61,4 +61,10 @@ public NoxCodeGenConventions(NoxSolution noxSolution)
     public string GetEntityDtoTypeFullName(string dtoName) => $"{DtoNameSpace}.{dtoName}";
 
     public static string GetForeignKeyPropertyName(Entity entity, EntityRelationship relationship) => $"{entity.GetNavigationPropertyName(relationship)}Id";
+
+    /// <summary>
+    /// Computes the Database Sequence Name to be used by an Entity Attribute
+    /// </summary>
+    /// <remarks>lower case so its fully compatible with postgres</remarks>
+    public string GetDatabaseSequenceName(string entityName, string attributeName) => $"Seq{entityName}{attributeName}".ToLowerInvariant();
 }

src/Nox.Types.EntityFramework/Abstractions/INoxDatabaseProvider.cs

@@ -13,4 +13,9 @@ public interface INoxDatabaseProvider
     string ToTableNameForSqlRaw(string table, string schema);
     void SetStoreTypeFlag(NoxDataStoreTypeFlags storeType);
     void UnSetStoreTypeFlag(NoxDataStoreTypeFlags storeTypeFlag);
+
+    /// <summary>
+    /// Raw SQL to Select Sequence Next Value
+    /// </summary>
+    string GetSqlStatementForSequenceNextValue(string sequenceName);
 }

src/Nox.Types.EntityFramework/Types/ReferenceNumber/ReferenceNumberConverter.cs

@@ -0,0 +1,8 @@
+using Microsoft.EntityFrameworkCore.Storage.ValueConversion;
+
+namespace Nox.Types.EntityFramework.Types;
+
+public class ReferenceNumberConverter : ValueConverter<ReferenceNumber, string>
+{
+    public ReferenceNumberConverter() : base(referenceNumber => referenceNumber.Value, currentNumber => ReferenceNumber.FromDatabase(currentNumber)) { }
+}