Use read-only interfaces for querying EF Core model

Author: bkoelman

src/Examples/DapperExample/TranslationToSql/DataModel/FromEntitiesDataModelService.cs

@@ -38,12 +38,12 @@ public void Initialize(DbContext dbContext)
         Initialize();
     }
 
-    private void ScanForeignKeys(IModel entityModel)
+    private void ScanForeignKeys(IReadOnlyModel entityModel)
     {
         foreach (RelationshipAttribute relationship in ResourceGraph.GetResourceTypes().SelectMany(resourceType => resourceType.Relationships))
         {
-            IEntityType? leftEntityType = entityModel.FindEntityType(relationship.LeftType.ClrType);
-            INavigation? navigation = leftEntityType?.FindNavigation(relationship.Property.Name);
+            IReadOnlyEntityType? leftEntityType = entityModel.FindEntityType(relationship.LeftType.ClrType);
+            IReadOnlyNavigation? navigation = leftEntityType?.FindNavigation(relationship.Property.Name);
 
             if (navigation != null)
             {
@@ -57,23 +57,23 @@ private void ScanForeignKeys(IModel entityModel)
         }
     }
 
-    private void ScanColumnNullability(IModel entityModel)
+    private void ScanColumnNullability(IReadOnlyModel entityModel)
     {
         foreach (ResourceType resourceType in ResourceGraph.GetResourceTypes())
         {
             ScanColumnNullability(resourceType, entityModel);
         }
     }
 
-    private void ScanColumnNullability(ResourceType resourceType, IModel entityModel)
+    private void ScanColumnNullability(ResourceType resourceType, IReadOnlyModel entityModel)
     {
-        IEntityType? entityType = entityModel.FindEntityType(resourceType.ClrType);
+        IReadOnlyEntityType? entityType = entityModel.FindEntityType(resourceType.ClrType);
 
         if (entityType != null)
         {
             foreach (AttrAttribute attribute in resourceType.Attributes)
             {
-                IProperty? property = entityType.FindProperty(attribute.Property.Name);
+                IReadOnlyProperty? property = entityType.FindProperty(attribute.Property.Name);
 
                 if (property != null)
                 {

src/Examples/NoEntityFrameworkExample/QueryLayerToLinqConverter.cs

@@ -7,9 +7,9 @@
 
 namespace NoEntityFrameworkExample;
 
-internal sealed class QueryLayerToLinqConverter(IModel model, IQueryableBuilder queryableBuilder)
+internal sealed class QueryLayerToLinqConverter(IReadOnlyModel entityModel, IQueryableBuilder queryableBuilder)
 {
-    private readonly IModel _model = model;
+    private readonly IReadOnlyModel _entityModel = entityModel;
     private readonly IQueryableBuilder _queryableBuilder = queryableBuilder;
 
     public IEnumerable<TResource> ApplyQueryLayer<TResource>(QueryLayer queryLayer, IEnumerable<TResource> resources)
@@ -21,7 +21,7 @@ public IEnumerable<TResource> ApplyQueryLayer<TResource>(QueryLayer queryLayer,
 
         // Convert QueryLayer into LINQ expression.
         IQueryable source = ((IEnumerable)resources).AsQueryable();
-        var context = QueryableBuilderContext.CreateRoot(source, typeof(Enumerable), _model, null);
+        var context = QueryableBuilderContext.CreateRoot(source, typeof(Enumerable), _entityModel, null);
         Expression expression = _queryableBuilder.ApplyQuery(queryLayer, context);
 
         // Insert null checks to prevent a NullReferenceException during execution of expressions such as:

src/JsonApiDotNetCore/Queries/QueryableBuilding/QueryClauseBuilderContext.cs

@@ -29,7 +29,7 @@ public sealed class QueryClauseBuilderContext
     /// <summary>
     /// The Entity Framework Core entity model.
     /// </summary>
-    public IModel EntityModel { get; }
+    public IReadOnlyModel EntityModel { get; }
 
     /// <summary>
     /// Used to produce unique names for lambda parameters.
@@ -51,7 +51,7 @@ public sealed class QueryClauseBuilderContext
     /// </summary>
     public object? State { get; }
 
-    public QueryClauseBuilderContext(Expression source, ResourceType resourceType, Type extensionType, IModel entityModel,
+    public QueryClauseBuilderContext(Expression source, ResourceType resourceType, Type extensionType, IReadOnlyModel entityModel,
         LambdaScopeFactory lambdaScopeFactory, LambdaScope lambdaScope, IQueryableBuilder queryableBuilder, object? state)
     {
         ArgumentGuard.NotNull(source);

src/JsonApiDotNetCore/Queries/QueryableBuilding/QueryableBuilderContext.cs

@@ -29,7 +29,7 @@ public sealed class QueryableBuilderContext
     /// <summary>
     /// The Entity Framework Core entity model.
     /// </summary>
-    public IModel EntityModel { get; }
+    public IReadOnlyModel EntityModel { get; }
 
     /// <summary>
     /// Used to produce unique names for lambda parameters.
@@ -41,7 +41,7 @@ public sealed class QueryableBuilderContext
     /// </summary>
     public object? State { get; }
 
-    public QueryableBuilderContext(Expression source, Type elementType, Type extensionType, IModel entityModel, LambdaScopeFactory lambdaScopeFactory,
+    public QueryableBuilderContext(Expression source, Type elementType, Type extensionType, IReadOnlyModel entityModel, LambdaScopeFactory lambdaScopeFactory,
         object? state)
     {
         ArgumentGuard.NotNull(source);
@@ -58,15 +58,15 @@ public QueryableBuilderContext(Expression source, Type elementType, Type extensi
         State = state;
     }
 
-    public static QueryableBuilderContext CreateRoot(IQueryable source, Type extensionType, IModel model, object? state)
+    public static QueryableBuilderContext CreateRoot(IQueryable source, Type extensionType, IReadOnlyModel entityModel, object? state)
     {
         ArgumentGuard.NotNull(source);
         ArgumentGuard.NotNull(extensionType);
-        ArgumentGuard.NotNull(model);
+        ArgumentGuard.NotNull(entityModel);
 
         var lambdaScopeFactory = new LambdaScopeFactory();
 
-        return new QueryableBuilderContext(source.Expression, source.ElementType, extensionType, model, lambdaScopeFactory, state);
+        return new QueryableBuilderContext(source.Expression, source.ElementType, extensionType, entityModel, lambdaScopeFactory, state);
     }
 
     public QueryClauseBuilderContext CreateClauseContext(IQueryableBuilder queryableBuilder, Expression source, ResourceType resourceType,

src/JsonApiDotNetCore/Queries/QueryableBuilding/SelectClauseBuilder.cs

@@ -40,8 +40,8 @@ public virtual Expression ApplySelect(FieldSelection selection, QueryClauseBuild
     private Expression CreateLambdaBodyInitializer(FieldSelection selection, ResourceType resourceType, LambdaScope lambdaScope,
         bool lambdaAccessorRequiresTestForNull, QueryClauseBuilderContext context)
     {
-        IEntityType entityType = context.EntityModel.FindEntityType(resourceType.ClrType)!;
-        IEntityType[] concreteEntityTypes = entityType.GetConcreteDerivedTypesInclusive().ToArray();
+        IReadOnlyEntityType entityType = context.EntityModel.FindEntityType(resourceType.ClrType)!;
+        IReadOnlyEntityType[] concreteEntityTypes = entityType.GetConcreteDerivedTypesInclusive().ToArray();
 
         Expression bodyInitializer = concreteEntityTypes.Length > 1
             ? CreateLambdaBodyInitializerForTypeHierarchy(selection, resourceType, concreteEntityTypes, lambdaScope, context)
@@ -56,12 +56,12 @@ private Expression CreateLambdaBodyInitializer(FieldSelection selection, Resourc
     }
 
     private Expression CreateLambdaBodyInitializerForTypeHierarchy(FieldSelection selection, ResourceType baseResourceType,
-        IEnumerable<IEntityType> concreteEntityTypes, LambdaScope lambdaScope, QueryClauseBuilderContext context)
+        IEnumerable<IReadOnlyEntityType> concreteEntityTypes, LambdaScope lambdaScope, QueryClauseBuilderContext context)
     {
         IReadOnlySet<ResourceType> resourceTypes = selection.GetResourceTypes();
         Expression rootCondition = lambdaScope.Accessor;
 
-        foreach (IEntityType entityType in concreteEntityTypes)
+        foreach (IReadOnlyEntityType entityType in concreteEntityTypes)
         {
             ResourceType? resourceType = resourceTypes.SingleOrDefault(type => type.ClrType == entityType.ClrType);
 
@@ -115,7 +115,7 @@ private Expression CreateLambdaBodyInitializerForSingleType(FieldSelection selec
     }
 
     private static ICollection<PropertySelector> ToPropertySelectors(FieldSelectors fieldSelectors, ResourceType resourceType, Type elementType,
-        IModel entityModel)
+        IReadOnlyModel entityModel)
     {
         var propertySelectors = new Dictionary<PropertyInfo, PropertySelector>();
 
@@ -134,17 +134,18 @@ private static ICollection<PropertySelector> ToPropertySelectors(FieldSelectors
         return propertySelectors.Values;
     }
 
-    private static void IncludeAllScalarProperties(Type elementType, Dictionary<PropertyInfo, PropertySelector> propertySelectors, IModel entityModel)
+    private static void IncludeAllScalarProperties(Type elementType, Dictionary<PropertyInfo, PropertySelector> propertySelectors, IReadOnlyModel entityModel)
     {
-        IEntityType entityType = entityModel.GetEntityTypes().Single(type => type.ClrType == elementType);
+        IReadOnlyEntityType entityType = entityModel.GetEntityTypes().Single(type => type.ClrType == elementType);
 
-        foreach (IProperty property in entityType.GetProperties().Where(property => !property.IsShadowProperty()))
+        foreach (IReadOnlyProperty property in entityType.GetProperties().Where(property => !property.IsShadowProperty()))
         {
             var propertySelector = new PropertySelector(property.PropertyInfo!);
             IncludeWritableProperty(propertySelector, propertySelectors);
         }
 
-        foreach (INavigation navigation in entityType.GetNavigations().Where(navigation => navigation.ForeignKey.IsOwnership && !navigation.IsShadowProperty()))
+        foreach (IReadOnlyNavigation navigation in entityType.GetNavigations()
+            .Where(navigation => navigation.ForeignKey.IsOwnership && !navigation.IsShadowProperty()))
         {
             var propertySelector = new PropertySelector(navigation.PropertyInfo!);
             IncludeWritableProperty(propertySelector, propertySelectors);