Changed IResourceContextProvider.GetResourceContexts() to return a set instead of a list. Made ResourceContext sealed and immutable and implemented Equals/GetHashCode so it works with sets.

Bart Koelman · Bart Koelman · commit 1c2726b402a9 · 2021-08-03T22:12:39.000+02:00
diff --git a/src/JsonApiDotNetCore/Configuration/IResourceContextProvider.cs b/src/JsonApiDotNetCore/Configuration/IResourceContextProvider.cs
@@ -10,14 +10,14 @@ namespace JsonApiDotNetCore.Configuration
     public interface IResourceContextProvider
     {
         /// <summary>
-        /// Gets all registered resource contexts.
+        /// Gets the metadata for all registered resources.
         /// </summary>
-        IReadOnlyCollection<ResourceContext> GetResourceContexts();
+        IReadOnlySet<ResourceContext> GetResourceContexts();
 
         /// <summary>
-        /// Gets the resource metadata for the specified exposed resource name.
+        /// Gets the resource metadata for the resource that is publicly exposed by the specified name.
         /// </summary>
-        ResourceContext GetResourceContext(string resourceName);
+        ResourceContext GetResourceContext(string publicName);
 
         /// <summary>
         /// Gets the resource metadata for the specified resource type.
diff --git a/src/JsonApiDotNetCore/Configuration/ResourceContext.cs b/src/JsonApiDotNetCore/Configuration/ResourceContext.cs
@@ -10,39 +10,39 @@ namespace JsonApiDotNetCore.Configuration
     /// Provides metadata for a resource, such as its attributes and relationships.
     /// </summary>
     [PublicAPI]
-    public class ResourceContext
+    public sealed class ResourceContext
     {
         private IReadOnlyCollection<ResourceFieldAttribute> _fields;
 
         /// <summary>
         /// The publicly exposed resource name.
         /// </summary>
-        public string PublicName { get; set; }
+        public string PublicName { get; }
 
         /// <summary>
         /// The CLR type of the resource.
         /// </summary>
-        public Type ResourceType { get; set; }
+        public Type ResourceType { get; }
 
         /// <summary>
         /// The identity type of the resource.
         /// </summary>
-        public Type IdentityType { get; set; }
+        public Type IdentityType { get; }
 
         /// <summary>
         /// Exposed resource attributes. See https://jsonapi.org/format/#document-resource-object-attributes.
         /// </summary>
-        public IReadOnlyCollection<AttrAttribute> Attributes { get; set; }
+        public IReadOnlyCollection<AttrAttribute> Attributes { get; }
 
         /// <summary>
         /// Exposed resource relationships. See https://jsonapi.org/format/#document-resource-object-relationships.
         /// </summary>
-        public IReadOnlyCollection<RelationshipAttribute> Relationships { get; set; }
+        public IReadOnlyCollection<RelationshipAttribute> Relationships { get; }
 
         /// <summary>
         /// Related entities that are not exposed as resource relationships.
         /// </summary>
-        public IReadOnlyCollection<EagerLoadAttribute> EagerLoads { get; set; }
+        public IReadOnlyCollection<EagerLoadAttribute> EagerLoads { get; }
 
         /// <summary>
         /// Exposed resource attributes and relationships. See https://jsonapi.org/format/#document-resource-object-fields.
@@ -56,7 +56,7 @@ public class ResourceContext
         /// <remarks>
         /// In the process of building the resource graph, this value is set based on <see cref="ResourceLinksAttribute.TopLevelLinks" /> usage.
         /// </remarks>
-        public LinkTypes TopLevelLinks { get; internal set; } = LinkTypes.NotConfigured;
+        public LinkTypes TopLevelLinks { get; }
 
         /// <summary>
         /// Configures which links to show in the <see cref="Serialization.Objects.ResourceLinks" /> object for this resource type. Defaults to
@@ -65,7 +65,7 @@ public class ResourceContext
         /// <remarks>
         /// In the process of building the resource graph, this value is set based on <see cref="ResourceLinksAttribute.ResourceLinks" /> usage.
         /// </remarks>
-        public LinkTypes ResourceLinks { get; internal set; } = LinkTypes.NotConfigured;
+        public LinkTypes ResourceLinks { get; }
 
         /// <summary>
         /// Configures which links to show in the <see cref="Serialization.Objects.RelationshipLinks" /> object for all relationships of this resource type.
@@ -75,11 +75,83 @@ public class ResourceContext
         /// <remarks>
         /// In the process of building the resource graph, this value is set based on <see cref="ResourceLinksAttribute.RelationshipLinks" /> usage.
         /// </remarks>
-        public LinkTypes RelationshipLinks { get; internal set; } = LinkTypes.NotConfigured;
+        public LinkTypes RelationshipLinks { get; }
+
+        public ResourceContext(string publicName, Type resourceType, Type identityType, IReadOnlyCollection<AttrAttribute> attributes,
+            IReadOnlyCollection<RelationshipAttribute> relationships, IReadOnlyCollection<EagerLoadAttribute> eagerLoads,
+            LinkTypes topLevelLinks = LinkTypes.NotConfigured, LinkTypes resourceLinks = LinkTypes.NotConfigured,
+            LinkTypes relationshipLinks = LinkTypes.NotConfigured)
+        {
+            ArgumentGuard.NotNullNorEmpty(publicName, nameof(publicName));
+            ArgumentGuard.NotNull(resourceType, nameof(resourceType));
+            ArgumentGuard.NotNull(identityType, nameof(identityType));
+            ArgumentGuard.NotNull(attributes, nameof(attributes));
+            ArgumentGuard.NotNull(relationships, nameof(relationships));
+            ArgumentGuard.NotNull(eagerLoads, nameof(eagerLoads));
+
+            PublicName = publicName;
+            ResourceType = resourceType;
+            IdentityType = identityType;
+            Attributes = attributes;
+            Relationships = relationships;
+            EagerLoads = eagerLoads;
+            TopLevelLinks = topLevelLinks;
+            ResourceLinks = resourceLinks;
+            RelationshipLinks = relationshipLinks;
+        }
 
         public override string ToString()
         {
             return PublicName;
         }
+
+        public override bool Equals(object obj)
+        {
+            if (ReferenceEquals(this, obj))
+            {
+                return true;
+            }
+
+            if (obj is null || GetType() != obj.GetType())
+            {
+                return false;
+            }
+
+            var other = (ResourceContext)obj;
+
+            return PublicName == other.PublicName && ResourceType == other.ResourceType && IdentityType == other.IdentityType &&
+                Attributes.SequenceEqual(other.Attributes) && Relationships.SequenceEqual(other.Relationships) && EagerLoads.SequenceEqual(other.EagerLoads) &&
+                TopLevelLinks == other.TopLevelLinks && ResourceLinks == other.ResourceLinks && RelationshipLinks == other.RelationshipLinks;
+        }
+
+        public override int GetHashCode()
+        {
+            var hashCode = new HashCode();
+
+            hashCode.Add(PublicName);
+            hashCode.Add(ResourceType);
+            hashCode.Add(IdentityType);
+
+            foreach (AttrAttribute attribute in Attributes)
+            {
+                hashCode.Add(attribute);
+            }
+
+            foreach (RelationshipAttribute relationship in Relationships)
+            {
+                hashCode.Add(relationship);
+            }
+
+            foreach (EagerLoadAttribute eagerLoad in EagerLoads)
+            {
+                hashCode.Add(eagerLoad);
+            }
+
+            hashCode.Add(TopLevelLinks);
+            hashCode.Add(ResourceLinks);
+            hashCode.Add(RelationshipLinks);
+
+            return hashCode.ToHashCode();
+        }
     }
 }
diff --git a/src/JsonApiDotNetCore/Configuration/ResourceGraph.cs b/src/JsonApiDotNetCore/Configuration/ResourceGraph.cs
@@ -14,27 +14,27 @@ namespace JsonApiDotNetCore.Configuration
     public sealed class ResourceGraph : IResourceGraph
     {
         private static readonly Type ProxyTargetAccessorType = Type.GetType("Castle.DynamicProxy.IProxyTargetAccessor, Castle.Core");
-        private readonly IReadOnlyCollection<ResourceContext> _resources;
+        private readonly IReadOnlySet<ResourceContext> _resourceContexts;
 
-        public ResourceGraph(IReadOnlyCollection<ResourceContext> resources)
+        public ResourceGraph(IReadOnlySet<ResourceContext> resourceContexts)
         {
-            ArgumentGuard.NotNull(resources, nameof(resources));
+            ArgumentGuard.NotNull(resourceContexts, nameof(resourceContexts));
 
-            _resources = resources;
+            _resourceContexts = resourceContexts;
         }
 
         /// <inheritdoc />
-        public IReadOnlyCollection<ResourceContext> GetResourceContexts()
+        public IReadOnlySet<ResourceContext> GetResourceContexts()
         {
-            return _resources;
+            return _resourceContexts;
         }
 
         /// <inheritdoc />
-        public ResourceContext GetResourceContext(string resourceName)
+        public ResourceContext GetResourceContext(string publicName)
         {
-            ArgumentGuard.NotNullNorEmpty(resourceName, nameof(resourceName));
+            ArgumentGuard.NotNullNorEmpty(publicName, nameof(publicName));
 
-            return _resources.SingleOrDefault(resourceContext => resourceContext.PublicName == resourceName);
+            return _resourceContexts.SingleOrDefault(resourceContext => resourceContext.PublicName == publicName);
         }
 
         /// <inheritdoc />
@@ -43,8 +43,8 @@ public ResourceContext GetResourceContext(Type resourceType)
             ArgumentGuard.NotNull(resourceType, nameof(resourceType));
 
             return IsLazyLoadingProxyForResourceType(resourceType)
-                ? _resources.SingleOrDefault(resourceContext => resourceContext.ResourceType == resourceType.BaseType)
-                : _resources.SingleOrDefault(resourceContext => resourceContext.ResourceType == resourceType);
+                ? _resourceContexts.SingleOrDefault(resourceContext => resourceContext.ResourceType == resourceType.BaseType)
+                : _resourceContexts.SingleOrDefault(resourceContext => resourceContext.ResourceType == resourceType);
         }
 
         private bool IsLazyLoadingProxyForResourceType(Type resourceType)
diff --git a/src/JsonApiDotNetCore/Configuration/ResourceGraphBuilder.cs b/src/JsonApiDotNetCore/Configuration/ResourceGraphBuilder.cs
@@ -17,7 +17,7 @@ public class ResourceGraphBuilder
     {
         private readonly IJsonApiOptions _options;
         private readonly ILogger<ResourceGraphBuilder> _logger;
-        private readonly List<ResourceContext> _resources = new();
+        private readonly HashSet<ResourceContext> _resourceContexts = new();
         private readonly TypeLocator _typeLocator = new();
 
         public ResourceGraphBuilder(IJsonApiOptions options, ILoggerFactory loggerFactory)
@@ -34,20 +34,7 @@ public ResourceGraphBuilder(IJsonApiOptions options, ILoggerFactory loggerFactor
         /// </summary>
         public IResourceGraph Build()
         {
-            _resources.ForEach(SetResourceLinksOptions);
-            return new ResourceGraph(_resources);
-        }
-
-        private void SetResourceLinksOptions(ResourceContext resourceContext)
-        {
-            var attribute = (ResourceLinksAttribute)resourceContext.ResourceType.GetCustomAttribute(typeof(ResourceLinksAttribute));
-
-            if (attribute != null)
-            {
-                resourceContext.RelationshipLinks = attribute.RelationshipLinks;
-                resourceContext.ResourceLinks = attribute.ResourceLinks;
-                resourceContext.TopLevelLinks = attribute.TopLevelLinks;
-            }
+            return new ResourceGraph(_resourceContexts);
         }
 
         /// <summary>
@@ -102,7 +89,7 @@ public ResourceGraphBuilder Add(Type resourceType, Type idType = null, string pu
         {
             ArgumentGuard.NotNull(resourceType, nameof(resourceType));
 
-            if (_resources.Any(resourceContext => resourceContext.ResourceType == resourceType))
+            if (_resourceContexts.Any(resourceContext => resourceContext.ResourceType == resourceType))
             {
                 return this;
             }
@@ -113,7 +100,7 @@ public ResourceGraphBuilder Add(Type resourceType, Type idType = null, string pu
                 Type effectiveIdType = idType ?? _typeLocator.TryGetIdType(resourceType);
 
                 ResourceContext resourceContext = CreateResourceContext(effectivePublicName, resourceType, effectiveIdType);
-                _resources.Add(resourceContext);
+                _resourceContexts.Add(resourceContext);
             }
             else
             {
@@ -125,15 +112,16 @@ public ResourceGraphBuilder Add(Type resourceType, Type idType = null, string pu
 
         private ResourceContext CreateResourceContext(string publicName, Type resourceType, Type idType)
         {
-            return new()
-            {
-                PublicName = publicName,
-                ResourceType = resourceType,
-                IdentityType = idType,
-                Attributes = GetAttributes(resourceType),
-                Relationships = GetRelationships(resourceType),
-                EagerLoads = GetEagerLoads(resourceType)
-            };
+            IReadOnlyCollection<AttrAttribute> attributes = GetAttributes(resourceType);
+            IReadOnlyCollection<RelationshipAttribute> relationships = GetRelationships(resourceType);
+            IReadOnlyCollection<EagerLoadAttribute> eagerLoads = GetEagerLoads(resourceType);
+
+            var linksAttribute = (ResourceLinksAttribute)resourceType.GetCustomAttribute(typeof(ResourceLinksAttribute));
+
+            return linksAttribute == null
+                ? new ResourceContext(publicName, resourceType, idType, attributes, relationships, eagerLoads)
+                : new ResourceContext(publicName, resourceType, idType, attributes, relationships, eagerLoads, linksAttribute.TopLevelLinks,
+                    linksAttribute.ResourceLinks, linksAttribute.RelationshipLinks);
         }
 
         private IReadOnlyCollection<AttrAttribute> GetAttributes(Type resourceType)
diff --git a/src/JsonApiDotNetCore/ObjectExtensions.cs b/src/JsonApiDotNetCore/ObjectExtensions.cs
@@ -21,7 +21,15 @@ public static T[] AsArray<T>(this T element)
 
         public static List<T> AsList<T>(this T element)
         {
-            return new()
+            return new List<T>
+            {
+                element
+            };
+        }
+
+        public static HashSet<T> AsHashSet<T>(this T element)
+        {
+            return new HashSet<T>
             {
                 element
             };
diff --git a/test/JsonApiDotNetCoreExampleTests/UnitTests/Links/LinkInclusionTests.cs b/test/JsonApiDotNetCoreExampleTests/UnitTests/Links/LinkInclusionTests.cs
@@ -56,12 +56,8 @@ public sealed class LinkInclusionTests
         public void Applies_cascading_settings_for_top_level_links(LinkTypes linksInResourceContext, LinkTypes linksInOptions, LinkTypes expected)
         {
             // Arrange
-            var exampleResourceContext = new ResourceContext
-            {
-                PublicName = nameof(ExampleResource),
-                ResourceType = typeof(ExampleResource),
-                TopLevelLinks = linksInResourceContext
-            };
+            var exampleResourceContext = new ResourceContext(nameof(ExampleResource), typeof(ExampleResource), typeof(int), Array.Empty<AttrAttribute>(),
+                Array.Empty<RelationshipAttribute>(), Array.Empty<EagerLoadAttribute>(), linksInResourceContext);
 
             var options = new JsonApiOptions
             {
@@ -84,7 +80,7 @@ public void Applies_cascading_settings_for_top_level_links(LinkTypes linksInReso
                 TotalResourceCount = 10
             };
 
-            var resourceGraph = new ResourceGraph(exampleResourceContext.AsArray());
+            var resourceGraph = new ResourceGraph(exampleResourceContext.AsHashSet());
             var httpContextAccessor = new FakeHttpContextAccessor();
             var linkGenerator = new FakeLinkGenerator();
             var controllerResourceMapping = new FakeControllerResourceMapping();
@@ -157,12 +153,8 @@ public void Applies_cascading_settings_for_top_level_links(LinkTypes linksInReso
         public void Applies_cascading_settings_for_resource_links(LinkTypes linksInResourceContext, LinkTypes linksInOptions, LinkTypes expected)
         {
             // Arrange
-            var exampleResourceContext = new ResourceContext
-            {
-                PublicName = nameof(ExampleResource),
-                ResourceType = typeof(ExampleResource),
-                ResourceLinks = linksInResourceContext
-            };
+            var exampleResourceContext = new ResourceContext(nameof(ExampleResource), typeof(ExampleResource), typeof(int), Array.Empty<AttrAttribute>(),
+                Array.Empty<RelationshipAttribute>(), Array.Empty<EagerLoadAttribute>(), resourceLinks: linksInResourceContext);
 
             var options = new JsonApiOptions
             {
@@ -171,7 +163,7 @@ public void Applies_cascading_settings_for_resource_links(LinkTypes linksInResou
 
             var request = new JsonApiRequest();
             var paginationContext = new PaginationContext();
-            var resourceGraph = new ResourceGraph(exampleResourceContext.AsArray());
+            var resourceGraph = new ResourceGraph(exampleResourceContext.AsHashSet());
             var httpContextAccessor = new FakeHttpContextAccessor();
             var linkGenerator = new FakeLinkGenerator();
             var controllerResourceMapping = new FakeControllerResourceMapping();
@@ -323,12 +315,8 @@ public void Applies_cascading_settings_for_relationship_links(LinkTypes linksInR
             LinkTypes linksInOptions, LinkTypes expected)
         {
             // Arrange
-            var exampleResourceContext = new ResourceContext
-            {
-                PublicName = nameof(ExampleResource),
-                ResourceType = typeof(ExampleResource),
-                RelationshipLinks = linksInResourceContext
-            };
+            var exampleResourceContext = new ResourceContext(nameof(ExampleResource), typeof(ExampleResource), typeof(int), Array.Empty<AttrAttribute>(),
+                Array.Empty<RelationshipAttribute>(), Array.Empty<EagerLoadAttribute>(), relationshipLinks: linksInResourceContext);
 
             var options = new JsonApiOptions
             {
@@ -337,7 +325,7 @@ public void Applies_cascading_settings_for_relationship_links(LinkTypes linksInR
 
             var request = new JsonApiRequest();
             var paginationContext = new PaginationContext();
-            var resourceGraph = new ResourceGraph(exampleResourceContext.AsArray());
+            var resourceGraph = new ResourceGraph(exampleResourceContext.AsHashSet());
             var httpContextAccessor = new FakeHttpContextAccessor();
             var linkGenerator = new FakeLinkGenerator();
             var controllerResourceMapping = new FakeControllerResourceMapping();
diff --git a/test/UnitTests/Middleware/JsonApiMiddlewareTests.cs b/test/UnitTests/Middleware/JsonApiMiddlewareTests.cs

Original file line number	Diff line number	Diff line change
`@@ -14,27 +14,27 @@ namespace JsonApiDotNetCore.Configuration`
`14`	`14`	`public sealed class ResourceGraph : IResourceGraph`
`15`	`15`	`{`
`16`	`16`	`private static readonly Type ProxyTargetAccessorType = Type.GetType("Castle.DynamicProxy.IProxyTargetAccessor, Castle.Core");`
`17`		`- private readonly IReadOnlyCollection<ResourceContext> _resources;`
	`17`	`+ private readonly IReadOnlySet<ResourceContext> _resourceContexts;`
`18`	`18`
`19`		`- public ResourceGraph(IReadOnlyCollection<ResourceContext> resources)`
	`19`	`+ public ResourceGraph(IReadOnlySet<ResourceContext> resourceContexts)`
`20`	`20`	`{`
`21`		`- ArgumentGuard.NotNull(resources, nameof(resources));`
	`21`	`+ ArgumentGuard.NotNull(resourceContexts, nameof(resourceContexts));`
`22`	`22`
`23`		`- _resources = resources;`
	`23`	`+ _resourceContexts = resourceContexts;`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`/// <inheritdoc />`
`27`		`- public IReadOnlyCollection<ResourceContext> GetResourceContexts()`
	`27`	`+ public IReadOnlySet<ResourceContext> GetResourceContexts()`
`28`	`28`	`{`
`29`		`- return _resources;`
	`29`	`+ return _resourceContexts;`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`/// <inheritdoc />`
`33`		`- public ResourceContext GetResourceContext(string resourceName)`
	`33`	`+ public ResourceContext GetResourceContext(string publicName)`
`34`	`34`	`{`
`35`		`- ArgumentGuard.NotNullNorEmpty(resourceName, nameof(resourceName));`
	`35`	`+ ArgumentGuard.NotNullNorEmpty(publicName, nameof(publicName));`
`36`	`36`
`37`		`- return _resources.SingleOrDefault(resourceContext => resourceContext.PublicName == resourceName);`
	`37`	`+ return _resourceContexts.SingleOrDefault(resourceContext => resourceContext.PublicName == publicName);`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`/// <inheritdoc />`
`@@ -43,8 +43,8 @@ public ResourceContext GetResourceContext(Type resourceType)`
`43`	`43`	`ArgumentGuard.NotNull(resourceType, nameof(resourceType));`
`44`	`44`
`45`	`45`	`return IsLazyLoadingProxyForResourceType(resourceType)`
`46`		`- ? _resources.SingleOrDefault(resourceContext => resourceContext.ResourceType == resourceType.BaseType)`
`47`		`- : _resources.SingleOrDefault(resourceContext => resourceContext.ResourceType == resourceType);`
	`46`	`+ ? _resourceContexts.SingleOrDefault(resourceContext => resourceContext.ResourceType == resourceType.BaseType)`
	`47`	`+ : _resourceContexts.SingleOrDefault(resourceContext => resourceContext.ResourceType == resourceType);`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`private bool IsLazyLoadingProxyForResourceType(Type resourceType)`