Skip to content

Reduce the maximum length of string primary keys in the EF 6 and EF Core stores #2367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Reduce the maximum length of string primary keys in the EF 6 and EF Core stores #2367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 23 additions & 12 deletions ...ddict.EntityFramework/Configurations/OpenIddictEntityFrameworkApplicationConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
using System.Data.Entity.Infrastructure.Annotations;
using System.Data.Entity.ModelConfiguration;
using System.Diagnostics.CodeAnalysis;
using System.Linq.Expressions;
using OpenIddict.EntityFramework.Models;

namespace OpenIddict.EntityFramework;
Expand Down Expand Up @@ -37,39 +38,49 @@ public OpenIddictEntityFrameworkApplicationConfiguration()
// Entity Framework would throw an exception due to the TKey generic parameter
// being non-nullable when using value types like short, int, long or Guid.

HasKey(application => application.Id);
HasKey(static application => application.Id);

Property(application => application.ApplicationType)
Property(static application => application.ApplicationType)
.HasMaxLength(50);

Property(application => application.ClientId)
Property(static application => application.ClientId)
.HasMaxLength(100)
.HasColumnAnnotation(IndexAnnotation.AnnotationName, new IndexAnnotation(new IndexAttribute
{
IsUnique = true
}));

Property(application => application.ClientType)
Property(static application => application.ClientType)
.HasMaxLength(50);

Property(application => application.ConcurrencyToken)
Property(static application => application.ConcurrencyToken)
.HasMaxLength(50)
.IsConcurrencyToken();

Property(application => application.ConsentType)
Property(static application => application.ConsentType)
.HasMaxLength(50);

HasMany(application => application.Authorizations)
.WithOptional(authorization => authorization.Application!)
.Map(association =>
if (typeof(TKey) == typeof(string))
{
var parameter = Expression.Parameter(typeof(TApplication), "application");
var property = Expression.Property(parameter,
typeof(TApplication).GetProperty(nameof(OpenIddictEntityFrameworkApplication.Id))!);
var lambda = Expression.Lambda<Func<TApplication, string>>(property, parameter);

Property(lambda).HasMaxLength(100);
}

HasMany(static application => application.Authorizations)
.WithOptional(static authorization => authorization.Application!)
.Map(static association =>
{
association.MapKey(nameof(OpenIddictEntityFrameworkAuthorization.Application) +
nameof(OpenIddictEntityFrameworkApplication.Id));
});

HasMany(application => application.Tokens)
.WithOptional(token => token.Application!)
.Map(association =>
HasMany(static application => application.Tokens)
.WithOptional(static token => token.Application!)
.Map(static association =>
{
association.MapKey(nameof(OpenIddictEntityFrameworkToken.Application) +
nameof(OpenIddictEntityFrameworkApplication.Id));
Expand Down
29 changes: 20 additions & 9 deletions ...ict.EntityFramework/Configurations/OpenIddictEntityFrameworkAuthorizationConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
using System.ComponentModel;
using System.Data.Entity.ModelConfiguration;
using System.Diagnostics.CodeAnalysis;
using System.Linq.Expressions;
using OpenIddict.EntityFramework.Models;

namespace OpenIddict.EntityFramework;
Expand Down Expand Up @@ -35,25 +36,35 @@ public OpenIddictEntityFrameworkAuthorizationConfiguration()
// Entity Framework would throw an exception due to the TKey generic parameter
// being non-nullable when using value types like short, int, long or Guid.

HasKey(authorization => authorization.Id);
HasKey(static authorization => authorization.Id);

Property(authorization => authorization.ConcurrencyToken)
Property(static authorization => authorization.ConcurrencyToken)
.HasMaxLength(50)
.IsConcurrencyToken();

Property(authorization => authorization.Status)
if (typeof(TKey) == typeof(string))
{
var parameter = Expression.Parameter(typeof(TAuthorization), "authorization");
var property = Expression.Property(parameter,
typeof(TAuthorization).GetProperty(nameof(OpenIddictEntityFrameworkAuthorization.Id))!);
var lambda = Expression.Lambda<Func<TAuthorization, string>>(property, parameter);

Property(lambda).HasMaxLength(100);
}

Property(static authorization => authorization.Status)
.HasMaxLength(50);

Property(authorization => authorization.Subject)
Property(static authorization => authorization.Subject)
.HasMaxLength(400);

Property(authorization => authorization.Type)
Property(static authorization => authorization.Type)
.HasMaxLength(50);

HasMany(authorization => authorization.Tokens)
.WithOptional(token => token.Authorization!)
.Map(association => association.MapKey(nameof(OpenIddictEntityFrameworkToken.Authorization) +
nameof(OpenIddictEntityFrameworkAuthorization.Id)))
HasMany(static authorization => authorization.Tokens)
.WithOptional(static token => token.Authorization!)
.Map(static association => association.MapKey(nameof(OpenIddictEntityFrameworkToken.Authorization) +
nameof(OpenIddictEntityFrameworkAuthorization.Id)))
.WillCascadeOnDelete();

ToTable("OpenIddictAuthorizations");
Expand Down
17 changes: 14 additions & 3 deletions src/OpenIddict.EntityFramework/Configurations/OpenIddictEntityFrameworkScopeConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
using System.Data.Entity.Infrastructure.Annotations;
using System.Data.Entity.ModelConfiguration;
using System.Diagnostics.CodeAnalysis;
using System.Linq.Expressions;
using OpenIddict.EntityFramework.Models;

namespace OpenIddict.EntityFramework;
Expand All @@ -31,13 +32,23 @@ public OpenIddictEntityFrameworkScopeConfiguration()
// Entity Framework would throw an exception due to the TKey generic parameter
// being non-nullable when using value types like short, int, long or Guid.

HasKey(scope => scope.Id);
HasKey(static scope => scope.Id);

Property(scope => scope.ConcurrencyToken)
Property(static scope => scope.ConcurrencyToken)
.HasMaxLength(50)
.IsConcurrencyToken();

Property(scope => scope.Name)
if (typeof(TKey) == typeof(string))
{
var parameter = Expression.Parameter(typeof(TScope), "scope");
var property = Expression.Property(parameter,
typeof(TScope).GetProperty(nameof(OpenIddictEntityFrameworkScope.Id))!);
var lambda = Expression.Lambda<Func<TScope, string>>(property, parameter);

Property(lambda).HasMaxLength(100);
}

Property(static scope => scope.Name)
.HasMaxLength(200)
.HasColumnAnnotation(IndexAnnotation.AnnotationName, new IndexAnnotation(new IndexAttribute
{
Expand Down
23 changes: 17 additions & 6 deletions src/OpenIddict.EntityFramework/Configurations/OpenIddictEntityFrameworkTokenConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
using System.Data.Entity.Infrastructure.Annotations;
using System.Data.Entity.ModelConfiguration;
using System.Diagnostics.CodeAnalysis;
using System.Linq.Expressions;
using OpenIddict.EntityFramework.Models;

namespace OpenIddict.EntityFramework;
Expand Down Expand Up @@ -37,26 +38,36 @@ public OpenIddictEntityFrameworkTokenConfiguration()
// Entity Framework would throw an exception due to the TKey generic parameter
// being non-nullable when using value types like short, int, long or Guid.

HasKey(token => token.Id);
HasKey(static token => token.Id);

Property(token => token.ConcurrencyToken)
Property(static token => token.ConcurrencyToken)
.HasMaxLength(50)
.IsConcurrencyToken();

if (typeof(TKey) == typeof(string))
{
var parameter = Expression.Parameter(typeof(TToken), "token");
var property = Expression.Property(parameter,
typeof(TToken).GetProperty(nameof(OpenIddictEntityFrameworkToken.Id))!);
var lambda = Expression.Lambda<Func<TToken, string>>(property, parameter);

Property(lambda).HasMaxLength(100);
}

// Warning: the index on the ReferenceId property MUST NOT be declared as
// a unique index, as Entity Framework 6.x doesn't support creating indexes
// with null-friendly WHERE conditions, unlike Entity Framework Core.
Property(token => token.ReferenceId)
Property(static token => token.ReferenceId)
.HasMaxLength(100)
.HasColumnAnnotation(IndexAnnotation.AnnotationName, new IndexAnnotation(new IndexAttribute()));

Property(token => token.Status)
Property(static token => token.Status)
.HasMaxLength(50);

Property(token => token.Subject)
Property(static token => token.Subject)
.HasMaxLength(400);

Property(token => token.Type)
Property(static token => token.Type)
.HasMaxLength(150);

ToTable("OpenIddictTokens");
Expand Down
28 changes: 17 additions & 11 deletions ...tityFrameworkCore/Configurations/OpenIddictEntityFrameworkCoreApplicationConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ public void Configure(EntityTypeBuilder<TApplication> builder)
// Entity Framework would throw an exception due to the TKey generic parameter
// being non-nullable when using value types like short, int, long or Guid.

builder.HasKey(application => application.Id);
builder.HasKey(static application => application.Id);

builder.Property(application => application.ApplicationType)
builder.Property(static application => application.ApplicationType)
.HasMaxLength(50);

// Warning: the non-generic overlord is deliberately used to work around
Expand All @@ -51,30 +51,36 @@ public void Configure(EntityTypeBuilder<TApplication> builder)
builder.HasIndex(nameof(OpenIddictEntityFrameworkCoreApplication.ClientId))
.IsUnique();

builder.Property(application => application.ClientId)
builder.Property(static application => application.ClientId)
.HasMaxLength(100);

builder.Property(application => application.ClientType)
builder.Property(static application => application.ClientType)
.HasMaxLength(50);

builder.Property(application => application.ConcurrencyToken)
builder.Property(static application => application.ConcurrencyToken)
.HasMaxLength(50)
.IsConcurrencyToken();

builder.Property(application => application.ConsentType)
builder.Property(static application => application.ConsentType)
.HasMaxLength(50);

builder.Property(application => application.Id)
builder.Property(static application => application.Id)
.ValueGeneratedOnAdd();

builder.HasMany(application => application.Authorizations)
.WithOne(authorization => authorization.Application!)
if (typeof(TKey) == typeof(string))
{
builder.Property(static application => application.Id)
.HasMaxLength(100);
}

builder.HasMany(static application => application.Authorizations)
.WithOne(static authorization => authorization.Application!)
.HasForeignKey(nameof(OpenIddictEntityFrameworkCoreAuthorization.Application) +
nameof(OpenIddictEntityFrameworkCoreApplication.Id))
.IsRequired(required: false);

builder.HasMany(application => application.Tokens)
.WithOne(token => token.Application!)
builder.HasMany(static application => application.Tokens)
.WithOne(static token => token.Application!)
.HasForeignKey(nameof(OpenIddictEntityFrameworkCoreToken.Application) + nameof(OpenIddictEntityFrameworkCoreApplication.Id))
.IsRequired(required: false);

Expand Down
22 changes: 14 additions & 8 deletions ...tyFrameworkCore/Configurations/OpenIddictEntityFrameworkCoreAuthorizationConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,32 +40,38 @@ public void Configure(EntityTypeBuilder<TAuthorization> builder)
// Entity Framework would throw an exception due to the TKey generic parameter
// being non-nullable when using value types like short, int, long or Guid.

builder.HasKey(authorization => authorization.Id);
builder.HasKey(static authorization => authorization.Id);

builder.HasIndex(
nameof(OpenIddictEntityFrameworkCoreAuthorization.Application) + nameof(OpenIddictEntityFrameworkCoreApplication.Id),
nameof(OpenIddictEntityFrameworkCoreAuthorization.Status),
nameof(OpenIddictEntityFrameworkCoreAuthorization.Subject),
nameof(OpenIddictEntityFrameworkCoreAuthorization.Type));

builder.Property(authorization => authorization.ConcurrencyToken)
builder.Property(static authorization => authorization.ConcurrencyToken)
.HasMaxLength(50)
.IsConcurrencyToken();

builder.Property(authorization => authorization.Id)
builder.Property(static authorization => authorization.Id)
.ValueGeneratedOnAdd();

builder.Property(authorization => authorization.Status)
if (typeof(TKey) == typeof(string))
{
builder.Property(static authorization => authorization.Id)
.HasMaxLength(100);
}

builder.Property(static authorization => authorization.Status)
.HasMaxLength(50);

builder.Property(authorization => authorization.Subject)
builder.Property(static authorization => authorization.Subject)
.HasMaxLength(400);

builder.Property(authorization => authorization.Type)
builder.Property(static authorization => authorization.Type)
.HasMaxLength(50);

builder.HasMany(authorization => authorization.Tokens)
.WithOne(token => token.Authorization!)
builder.HasMany(static authorization => authorization.Tokens)
.WithOne(static token => token.Authorization!)
.HasForeignKey(nameof(OpenIddictEntityFrameworkCoreToken.Authorization) +
nameof(OpenIddictEntityFrameworkCoreAuthorization.Id))
.IsRequired(required: false);
Expand Down
14 changes: 10 additions & 4 deletions ...ict.EntityFrameworkCore/Configurations/OpenIddictEntityFrameworkCoreScopeConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,22 +34,28 @@ public void Configure(EntityTypeBuilder<TScope> builder)
// Entity Framework would throw an exception due to the TKey generic parameter
// being non-nullable when using value types like short, int, long or Guid.

builder.HasKey(scope => scope.Id);
builder.HasKey(static scope => scope.Id);

// Warning: the non-generic overlord is deliberately used to work around
// a breaking change introduced in Entity Framework Core 3.x (where a
// generic entity type builder is now returned by the HasIndex() method).
builder.HasIndex(nameof(OpenIddictEntityFrameworkCoreScope.Name))
.IsUnique();

builder.Property(scope => scope.ConcurrencyToken)
builder.Property(static scope => scope.ConcurrencyToken)
.HasMaxLength(50)
.IsConcurrencyToken();

builder.Property(scope => scope.Id)
builder.Property(static scope => scope.Id)
.ValueGeneratedOnAdd();

builder.Property(scope => scope.Name)
if (typeof(TKey) == typeof(string))
{
builder.Property(static scope => scope.Id)
.HasMaxLength(100);
}

builder.Property(static scope => scope.Name)
.HasMaxLength(200);

builder.ToTable("OpenIddictScopes");
Expand Down
20 changes: 13 additions & 7 deletions ...ict.EntityFrameworkCore/Configurations/OpenIddictEntityFrameworkCoreTokenConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public void Configure(EntityTypeBuilder<TToken> builder)
// Entity Framework would throw an exception due to the TKey generic parameter
// being non-nullable when using value types like short, int, long or Guid.

builder.HasKey(token => token.Id);
builder.HasKey(static token => token.Id);

// Warning: the non-generic overlord is deliberately used to work around
// a breaking change introduced in Entity Framework Core 3.x (where a
Expand All @@ -54,23 +54,29 @@ public void Configure(EntityTypeBuilder<TToken> builder)
nameof(OpenIddictEntityFrameworkCoreToken.Subject),
nameof(OpenIddictEntityFrameworkCoreToken.Type));

builder.Property(token => token.ConcurrencyToken)
builder.Property(static token => token.ConcurrencyToken)
.HasMaxLength(50)
.IsConcurrencyToken();

builder.Property(token => token.Id)
builder.Property(static token => token.Id)
.ValueGeneratedOnAdd();

builder.Property(token => token.ReferenceId)
if (typeof(TKey) == typeof(string))
{
builder.Property(static token => token.Id)
.HasMaxLength(100);
}

builder.Property(static token => token.ReferenceId)
.HasMaxLength(100);

builder.Property(token => token.Status)
builder.Property(static token => token.Status)
.HasMaxLength(50);

builder.Property(token => token.Subject)
builder.Property(static token => token.Subject)
.HasMaxLength(400);

builder.Property(token => token.Type)
builder.Property(static token => token.Type)
.HasMaxLength(150);

builder.ToTable("OpenIddictTokens");
Expand Down
Loading