Removed non-generic Identifiable and throw for resource classes that only implement IIdentifiable (without ID) when building the resource graph

Author: Bart Koelman

benchmarks/BenchmarkResource.cs

@@ -5,7 +5,7 @@
 namespace Benchmarks
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class BenchmarkResource : Identifiable
+    public sealed class BenchmarkResource : Identifiable<int>
     {
         [Attr(PublicName = BenchmarkResourcePublicNames.NameAttr)]
         public string Name { get; set; }

benchmarks/Deserialization/DeserializationBenchmarkBase.cs

@@ -56,7 +56,7 @@ protected DeserializationBenchmarkBase()
         protected abstract JsonApiRequest CreateJsonApiRequest(IResourceGraph resourceGraph);
 
         [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-        public sealed class ResourceA : Identifiable
+        public sealed class ResourceA : Identifiable<int>
         {
             [Attr]
             public bool Attribute01 { get; set; }

benchmarks/Serialization/SerializationBenchmarkBase.cs

@@ -64,7 +64,7 @@ protected SerializationBenchmarkBase()
         protected abstract IEvaluatedIncludeCache CreateEvaluatedIncludeCache(IResourceGraph resourceGraph);
 
         [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-        public sealed class ResourceA : Identifiable
+        public sealed class ResourceA : Identifiable<int>
         {
             [Attr]
             public bool Attribute01 { get; set; }

benchmarks/SubResource.cs

@@ -5,7 +5,7 @@
 namespace Benchmarks
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class SubResource : Identifiable
+    public sealed class SubResource : Identifiable<int>
     {
         [Attr]
         public string Value { get; set; }

src/Examples/GettingStarted/Models/Book.cs

@@ -5,7 +5,7 @@
 namespace GettingStarted.Models
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class Book : Identifiable
+    public sealed class Book : Identifiable<int>
     {
         [Attr]
         public string Title { get; set; }

src/Examples/GettingStarted/Models/Person.cs

@@ -6,7 +6,7 @@
 namespace GettingStarted.Models
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class Person : Identifiable
+    public sealed class Person : Identifiable<int>
     {
         [Attr]
         public string Name { get; set; }

src/Examples/JsonApiDotNetCoreExample/Models/Person.cs

@@ -6,7 +6,7 @@
 namespace JsonApiDotNetCoreExample.Models
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class Person : Identifiable
+    public sealed class Person : Identifiable<int>
     {
         [Attr]
         public string FirstName { get; set; }

src/Examples/JsonApiDotNetCoreExample/Models/Tag.cs

@@ -7,7 +7,7 @@
 namespace JsonApiDotNetCoreExample.Models
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class Tag : Identifiable
+    public sealed class Tag : Identifiable<int>
     {
         [Required]
         [MinLength(1)]

src/Examples/JsonApiDotNetCoreExample/Models/TodoItem.cs

@@ -7,7 +7,7 @@
 namespace JsonApiDotNetCoreExample.Models
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class TodoItem : Identifiable
+    public sealed class TodoItem : Identifiable<int>
     {
         [Attr]
         public string Description { get; set; }

src/Examples/MultiDbContextExample/Models/ResourceA.cs

@@ -5,7 +5,7 @@
 namespace MultiDbContextExample.Models
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class ResourceA : Identifiable
+    public sealed class ResourceA : Identifiable<int>
     {
         [Attr]
         public string NameA { get; set; }

src/Examples/MultiDbContextExample/Models/ResourceB.cs

@@ -5,7 +5,7 @@
 namespace MultiDbContextExample.Models
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class ResourceB : Identifiable
+    public sealed class ResourceB : Identifiable<int>
     {
         [Attr]
         public string NameB { get; set; }

src/Examples/NoEntityFrameworkExample/Models/WorkItem.cs

@@ -6,7 +6,7 @@
 namespace NoEntityFrameworkExample.Models
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class WorkItem : Identifiable
+    public sealed class WorkItem : Identifiable<int>
     {
         [Attr]
         public bool IsBlocked { get; set; }

src/Examples/ReportsExample/Models/Report.cs

@@ -5,7 +5,7 @@
 namespace ReportsExample.Models
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class Report : Identifiable
+    public sealed class Report : Identifiable<int>
     {
         [Attr]
         public string Title { get; set; }

src/JsonApiDotNetCore/Configuration/JsonApiValidationFilter.cs

@@ -64,7 +64,7 @@ private IServiceProvider GetScopedServiceProvider()
 
         private static bool IsId(string key)
         {
-            return key == nameof(Identifiable.Id) || key.EndsWith($".{nameof(Identifiable.Id)}", StringComparison.Ordinal);
+            return key == nameof(Identifiable<object>.Id) || key.EndsWith($".{nameof(Identifiable<object>.Id)}", StringComparison.Ordinal);
         }
 
         private static bool IsAtPrimaryEndpoint(IJsonApiRequest request)

src/JsonApiDotNetCore/Configuration/ResourceGraphBuilder.cs

@@ -3,6 +3,7 @@
 using System.Linq;
 using System.Reflection;
 using JetBrains.Annotations;
+using JsonApiDotNetCore.Errors;
 using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Resources.Annotations;
 using Microsoft.EntityFrameworkCore;
@@ -130,14 +131,19 @@ public ResourceGraphBuilder Add(Type resourceClrType, Type idClrType = null, str
             if (resourceClrType.IsOrImplementsInterface(typeof(IIdentifiable)))
             {
                 string effectivePublicName = publicName ?? FormatResourceName(resourceClrType);
-                Type effectiveIdType = idClrType ?? _typeLocator.TryGetIdType(resourceClrType) ?? typeof(int);
+                Type effectiveIdType = idClrType ?? _typeLocator.TryGetIdType(resourceClrType);
+
+                if (effectiveIdType == null)
+                {
+                    throw new InvalidConfigurationException($"Resource type '{resourceClrType}' implements 'IIdentifiable', but not 'IIdentifiable<TId>'.");
+                }
 
                 ResourceType resourceType = CreateResourceType(effectivePublicName, resourceClrType, effectiveIdType);
                 _resourceTypes.Add(resourceType);
             }
             else
             {
-                _logger.LogWarning($"Entity '{resourceClrType}' does not implement '{nameof(IIdentifiable)}'.");
+                _logger.LogWarning($"Skipping: Type '{resourceClrType}' does not implement '{nameof(IIdentifiable)}'.");
             }
 
             return this;
@@ -168,7 +174,7 @@ private IReadOnlyCollection<AttrAttribute> GetAttributes(Type resourceClrType)
                 // Although strictly not correct, 'id' is added to the list of attributes for convenience.
                 // For example, it enables to filter on ID, without the need to special-case existing logic.
                 // And when using sparse fields, it silently adds 'id' to the set of attributes to retrieve.
-                if (property.Name == nameof(Identifiable.Id) && attribute == null)
+                if (property.Name == nameof(Identifiable<object>.Id) && attribute == null)
                 {
                     var idAttr = new AttrAttribute
                     {

src/JsonApiDotNetCore/Queries/Internal/Parsing/FilterParser.cs

@@ -154,7 +154,7 @@ protected ComparisonExpression ParseComparison(string operatorName)
 
                 PropertyInfo leftProperty = leftChain.Fields[^1].Property;
 
-                if (leftProperty.Name == nameof(Identifiable.Id) && rightTerm is LiteralConstantExpression rightConstant)
+                if (leftProperty.Name == nameof(Identifiable<object>.Id) && rightTerm is LiteralConstantExpression rightConstant)
                 {
                     string id = DeObfuscateStringId(leftProperty.ReflectedType, rightConstant.Value);
                     rightTerm = new LiteralConstantExpression(id);
@@ -214,7 +214,7 @@ protected AnyExpression ParseAny()
 
             PropertyInfo targetAttributeProperty = targetAttribute.Fields[^1].Property;
 
-            if (targetAttributeProperty.Name == nameof(Identifiable.Id))
+            if (targetAttributeProperty.Name == nameof(Identifiable<object>.Id))
             {
                 constantSet = DeObfuscateIdConstants(constantSet, targetAttributeProperty);
             }

src/JsonApiDotNetCore/Queries/Internal/QueryLayerComposer.cs

@@ -483,7 +483,7 @@ protected virtual IDictionary<ResourceFieldAttribute, QueryLayer> GetProjectionF
 
         private static AttrAttribute GetIdAttribute(ResourceType resourceType)
         {
-            return resourceType.GetAttributeByPropertyName(nameof(Identifiable.Id));
+            return resourceType.GetAttributeByPropertyName(nameof(Identifiable<object>.Id));
         }
     }
 }

src/JsonApiDotNetCore/Queries/Internal/SparseFieldSetCache.cs

@@ -96,7 +96,7 @@ public IImmutableSet<AttrAttribute> GetIdAttributeSetForRelationshipQuery(Resour
         {
             ArgumentGuard.NotNull(resourceType, nameof(resourceType));
 
-            AttrAttribute idAttribute = resourceType.GetAttributeByPropertyName(nameof(Identifiable.Id));
+            AttrAttribute idAttribute = resourceType.GetAttributeByPropertyName(nameof(Identifiable<object>.Id));
             var inputExpression = new SparseFieldSetExpression(ImmutableHashSet.Create<ResourceFieldAttribute>(idAttribute));
 
             // Intentionally not cached, as we are fetching ID only (ignoring any sparse fieldset that came from query string).

src/JsonApiDotNetCore/QueryStrings/Internal/SparseFieldSetQueryStringParameterReader.cs

@@ -92,7 +92,7 @@ private SparseFieldSetExpression GetSparseFieldSet(string parameterValue, Resour
             if (sparseFieldSet == null)
             {
                 // We add ID on an incoming empty fieldset, so that callers can distinguish between no fieldset and an empty one.
-                AttrAttribute idAttribute = resourceType.GetAttributeByPropertyName(nameof(Identifiable.Id));
+                AttrAttribute idAttribute = resourceType.GetAttributeByPropertyName(nameof(Identifiable<object>.Id));
                 return new SparseFieldSetExpression(ImmutableHashSet.Create<ResourceFieldAttribute>(idAttribute));
             }
 

src/JsonApiDotNetCore/Resources/IIdentifiable.cs

@@ -1,8 +1,7 @@
 namespace JsonApiDotNetCore.Resources
 {
     /// <summary>
-    /// When implemented by a class, indicates to JsonApiDotNetCore that the class represents a JSON:API resource. Note that JsonApiDotNetCore also assumes
-    /// that a property named 'Id' exists.
+    /// Defines the basic contract for a JSON:API resource. All resource classes must implement <see cref="IIdentifiable{TId}" />.
     /// </summary>
     public interface IIdentifiable
     {
@@ -26,7 +25,7 @@ public interface IIdentifiable
     public interface IIdentifiable<TId> : IIdentifiable
     {
         /// <summary>
-        /// The typed identifier as used by the underlying data store (usually numeric).
+        /// The typed identifier as used by the underlying data store (usually numeric or Guid).
         /// </summary>
         TId Id { get; set; }
     }

src/JsonApiDotNetCore/Resources/Identifiable.cs

@@ -4,13 +4,9 @@
 
 namespace JsonApiDotNetCore.Resources
 {
-    /// <inheritdoc />
-    public abstract class Identifiable : Identifiable<int>
-    {
-    }
-
     /// <summary>
-    /// A convenient basic implementation of <see cref="IIdentifiable" /> that provides conversion between <see cref="Id" /> and <see cref="StringId" />.
+    /// A convenient basic implementation of <see cref="IIdentifiable{TId}" /> that provides conversion between typed <see cref="Id" /> and
+    /// <see cref="StringId" />.
     /// </summary>
     /// <typeparam name="TId">
     /// The resource identifier type.

src/JsonApiDotNetCore/Resources/IdentifiableExtensions.cs

@@ -9,7 +9,7 @@ public static object GetTypedId(this IIdentifiable identifiable)
         {
             ArgumentGuard.NotNull(identifiable, nameof(identifiable));
 
-            PropertyInfo property = identifiable.GetType().GetProperty(nameof(Identifiable.Id));
+            PropertyInfo property = identifiable.GetType().GetProperty(nameof(Identifiable<object>.Id));
 
             if (property == null)
             {

src/JsonApiDotNetCore/Serialization/JsonConverters/ResourceObjectConverter.cs

@@ -183,7 +183,7 @@ private static IDictionary<string, object> ReadAttributes(ref Utf8JsonReader rea
                         {
                             object attributeValue;
 
-                            if (property.Name == nameof(Identifiable.Id))
+                            if (property.Name == nameof(Identifiable<object>.Id))
                             {
                                 attributeValue = JsonInvalidAttributeInfo.Id;
                             }

src/JsonApiDotNetCore/Serialization/Response/LinkBuilder.cs

@@ -24,9 +24,13 @@ public class LinkBuilder : ILinkBuilder
         private const string PageSizeParameterName = "page[size]";
         private const string PageNumberParameterName = "page[number]";
 
-        private static readonly string GetPrimaryControllerActionName = NoAsyncSuffix(nameof(BaseJsonApiController<Identifiable, int>.GetAsync));
-        private static readonly string GetSecondaryControllerActionName = NoAsyncSuffix(nameof(BaseJsonApiController<Identifiable, int>.GetSecondaryAsync));
-        private static readonly string GetRelationshipControllerActionName = NoAsyncSuffix(nameof(BaseJsonApiController<Identifiable, int>.GetRelationshipAsync));
+        private static readonly string GetPrimaryControllerActionName = NoAsyncSuffix(nameof(BaseJsonApiController<Identifiable<int>, int>.GetAsync));
+
+        private static readonly string GetSecondaryControllerActionName =
+            NoAsyncSuffix(nameof(BaseJsonApiController<Identifiable<int>, int>.GetSecondaryAsync));
+
+        private static readonly string GetRelationshipControllerActionName =
+            NoAsyncSuffix(nameof(BaseJsonApiController<Identifiable<int>, int>.GetRelationshipAsync));
 
         private readonly IJsonApiOptions _options;
         private readonly IJsonApiRequest _request;

src/JsonApiDotNetCore/Serialization/Response/ResponseModelAdapter.cs

@@ -215,7 +215,7 @@ protected virtual IDictionary<string, object> ConvertAttributes(IIdentifiable re
 
             foreach (AttrAttribute attr in resourceType.Attributes)
             {
-                if (!fieldSet.Contains(attr) || attr.Property.Name == nameof(Identifiable.Id))
+                if (!fieldSet.Contains(attr) || attr.Property.Name == nameof(Identifiable<object>.Id))
                 {
                     continue;
                 }

test/DiscoveryTests/TestResource.cs

@@ -4,7 +4,7 @@
 namespace DiscoveryTests
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class TestResource : Identifiable
+    public sealed class TestResource : Identifiable<int>
     {
     }
 }

test/JsonApiDotNetCoreTests/IntegrationTests/Archiving/BroadcastComment.cs

@@ -6,7 +6,7 @@
 namespace JsonApiDotNetCoreTests.IntegrationTests.Archiving
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class BroadcastComment : Identifiable
+    public sealed class BroadcastComment : Identifiable<int>
     {
         [Attr]
         public string Text { get; set; }

test/JsonApiDotNetCoreTests/IntegrationTests/Archiving/TelevisionBroadcast.cs

@@ -7,7 +7,7 @@
 namespace JsonApiDotNetCoreTests.IntegrationTests.Archiving
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class TelevisionBroadcast : Identifiable
+    public sealed class TelevisionBroadcast : Identifiable<int>
     {
         [Attr]
         public string Title { get; set; }

test/JsonApiDotNetCoreTests/IntegrationTests/Archiving/TelevisionNetwork.cs

@@ -6,7 +6,7 @@
 namespace JsonApiDotNetCoreTests.IntegrationTests.Archiving
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class TelevisionNetwork : Identifiable
+    public sealed class TelevisionNetwork : Identifiable<int>
     {
         [Attr]
         public string Name { get; set; }

test/JsonApiDotNetCoreTests/IntegrationTests/Archiving/TelevisionStation.cs

@@ -6,7 +6,7 @@
 namespace JsonApiDotNetCoreTests.IntegrationTests.Archiving
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class TelevisionStation : Identifiable
+    public sealed class TelevisionStation : Identifiable<int>
     {
         [Attr]
         public string Name { get; set; }

test/JsonApiDotNetCoreTests/IntegrationTests/AtomicOperations/Performer.cs

@@ -6,7 +6,7 @@
 namespace JsonApiDotNetCoreTests.IntegrationTests.AtomicOperations
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class Performer : Identifiable
+    public sealed class Performer : Identifiable<int>
     {
         [Attr]
         public string ArtistName { get; set; }

test/JsonApiDotNetCoreTests/IntegrationTests/CompositeKeys/CarExpressionRewriter.cs

@@ -78,7 +78,7 @@ public override QueryExpression VisitMatchText(MatchTextExpression expression, o
 
         private static bool IsCarId(PropertyInfo property)
         {
-            return property.Name == nameof(Identifiable.Id) && property.DeclaringType == typeof(Car);
+            return property.Name == nameof(Identifiable<object>.Id) && property.DeclaringType == typeof(Car);
         }
 
         private QueryExpression RewriteFilterOnCarStringIds(ResourceFieldChainExpression existingCarIdChain, IEnumerable<string> carStringIds)

test/JsonApiDotNetCoreTests/IntegrationTests/CompositeKeys/Dealership.cs

@@ -6,7 +6,7 @@
 namespace JsonApiDotNetCoreTests.IntegrationTests.CompositeKeys
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class Dealership : Identifiable
+    public sealed class Dealership : Identifiable<int>
     {
         [Attr]
         public string Address { get; set; }

test/JsonApiDotNetCoreTests/IntegrationTests/CompositeKeys/Engine.cs

@@ -5,7 +5,7 @@
 namespace JsonApiDotNetCoreTests.IntegrationTests.CompositeKeys
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class Engine : Identifiable
+    public sealed class Engine : Identifiable<int>
     {
         [Attr]
         public string SerialCode { get; set; }

test/JsonApiDotNetCoreTests/IntegrationTests/ContentNegotiation/Policy.cs

@@ -5,7 +5,7 @@
 namespace JsonApiDotNetCoreTests.IntegrationTests.ContentNegotiation
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class Policy : Identifiable
+    public sealed class Policy : Identifiable<int>
     {
         [Attr]
         public string Name { get; set; }

test/JsonApiDotNetCoreTests/IntegrationTests/ControllerActionResults/Toothbrush.cs

@@ -5,7 +5,7 @@
 namespace JsonApiDotNetCoreTests.IntegrationTests.ControllerActionResults
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class Toothbrush : Identifiable
+    public sealed class Toothbrush : Identifiable<int>
     {
         [Attr]
         public bool IsElectric { get; set; }

test/JsonApiDotNetCoreTests/IntegrationTests/CustomRoutes/Civilian.cs

@@ -5,7 +5,7 @@
 namespace JsonApiDotNetCoreTests.IntegrationTests.CustomRoutes
 {
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class Civilian : Identifiable
+    public sealed class Civilian : Identifiable<int>
     {
         [Attr]
         public string Name { get; set; }