Pass the full resource to LinkBuilder, instead of just its ID. This allows for more intelligence in the link builder, such as handling versioning or inheritance.

Bart Koelman · Bart Koelman · commit b76629db7981 · 2021-11-19T15:31:47.000+01:00
diff --git a/benchmarks/Serialization/SerializationBenchmarkBase.cs b/benchmarks/Serialization/SerializationBenchmarkBase.cs
@@ -229,15 +229,15 @@ public TopLevelLinks GetTopLevelLinks()
                 };
             }
 
-            public ResourceLinks GetResourceLinks(ResourceType resourceType, string id)
+            public ResourceLinks GetResourceLinks(ResourceType resourceType, IIdentifiable resource)
             {
                 return new ResourceLinks
                 {
                     Self = "Resource:Self"
                 };
             }
 
-            public RelationshipLinks GetRelationshipLinks(RelationshipAttribute relationship, string leftId)
+            public RelationshipLinks GetRelationshipLinks(RelationshipAttribute relationship, IIdentifiable leftResource)
             {
                 return new RelationshipLinks
                 {
diff --git a/src/JsonApiDotNetCore/Serialization/Response/ILinkBuilder.cs b/src/JsonApiDotNetCore/Serialization/Response/ILinkBuilder.cs
@@ -1,4 +1,5 @@
 using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Resources;
 using JsonApiDotNetCore.Resources.Annotations;
 using JsonApiDotNetCore.Serialization.Objects;
 
@@ -17,11 +18,11 @@ public interface ILinkBuilder
         /// <summary>
         /// Builds the links object for a returned resource (primary or included).
         /// </summary>
-        ResourceLinks? GetResourceLinks(ResourceType resourceType, string id);
+        ResourceLinks? GetResourceLinks(ResourceType resourceType, IIdentifiable resource);
 
         /// <summary>
         /// Builds the links object for a relationship inside a returned resource.
         /// </summary>
-        RelationshipLinks? GetRelationshipLinks(RelationshipAttribute relationship, string leftId);
+        RelationshipLinks? GetRelationshipLinks(RelationshipAttribute relationship, IIdentifiable leftResource);
     }
 }
diff --git a/src/JsonApiDotNetCore/Serialization/Response/LinkBuilder.cs b/src/JsonApiDotNetCore/Serialization/Response/LinkBuilder.cs
@@ -228,16 +228,16 @@ private string GetQueryStringInPaginationLink(int pageOffset, string? pageSizeVa
         }
 
         /// <inheritdoc />
-        public ResourceLinks? GetResourceLinks(ResourceType resourceType, string id)
+        public ResourceLinks? GetResourceLinks(ResourceType resourceType, IIdentifiable resource)
         {
             ArgumentGuard.NotNull(resourceType, nameof(resourceType));
-            ArgumentGuard.NotNullNorEmpty(id, nameof(id));
+            ArgumentGuard.NotNull(resource, nameof(resource));
 
             var links = new ResourceLinks();
 
             if (ShouldIncludeResourceLink(LinkTypes.Self, resourceType))
             {
-                links.Self = GetLinkForResourceSelf(resourceType, id);
+                links.Self = GetLinkForResourceSelf(resourceType, resource);
             }
 
             return links.HasValue() ? links : null;
@@ -257,30 +257,30 @@ private bool ShouldIncludeResourceLink(LinkTypes linkType, ResourceType resource
             return _options.ResourceLinks.HasFlag(linkType);
         }
 
-        private string? GetLinkForResourceSelf(ResourceType resourceType, string resourceId)
+        private string? GetLinkForResourceSelf(ResourceType resourceType, IIdentifiable resource)
         {
             string? controllerName = _controllerResourceMapping.GetControllerNameForResourceType(resourceType);
-            IDictionary<string, object?> routeValues = GetRouteValues(resourceId, null);
+            IDictionary<string, object?> routeValues = GetRouteValues(resource.StringId!, null);
 
             return RenderLinkForAction(controllerName, GetPrimaryControllerActionName, routeValues);
         }
 
         /// <inheritdoc />
-        public RelationshipLinks? GetRelationshipLinks(RelationshipAttribute relationship, string leftId)
+        public RelationshipLinks? GetRelationshipLinks(RelationshipAttribute relationship, IIdentifiable leftResource)
         {
             ArgumentGuard.NotNull(relationship, nameof(relationship));
-            ArgumentGuard.NotNullNorEmpty(leftId, nameof(leftId));
+            ArgumentGuard.NotNull(leftResource, nameof(leftResource));
 
             var links = new RelationshipLinks();
 
             if (ShouldIncludeRelationshipLink(LinkTypes.Self, relationship))
             {
-                links.Self = GetLinkForRelationshipSelf(leftId, relationship);
+                links.Self = GetLinkForRelationshipSelf(leftResource.StringId!, relationship);
             }
 
             if (ShouldIncludeRelationshipLink(LinkTypes.Related, relationship))
             {
-                links.Related = GetLinkForRelationshipRelated(leftId, relationship);
+                links.Related = GetLinkForRelationshipRelated(leftResource.StringId!, relationship);
             }
 
             return links.HasValue() ? links : null;
diff --git a/src/JsonApiDotNetCore/Serialization/Response/ResponseModelAdapter.cs b/src/JsonApiDotNetCore/Serialization/Response/ResponseModelAdapter.cs
@@ -204,7 +204,7 @@ protected virtual ResourceObject ConvertResource(IIdentifiable resource, Resourc
                 IImmutableSet<ResourceFieldAttribute> fieldSet = _sparseFieldSetCache.GetSparseFieldSetForSerializer(type);
 
                 resourceObject.Attributes = ConvertAttributes(resource, type, fieldSet);
-                resourceObject.Links = _linkBuilder.GetResourceLinks(type, resource.StringId!);
+                resourceObject.Links = _linkBuilder.GetResourceLinks(type, resource);
                 resourceObject.Meta = _resourceDefinitionAccessor.GetMeta(type, resource);
             }
 
@@ -292,7 +292,7 @@ private void PopulateRelationshipsInResourceObject(ResourceObjectTreeNode treeNo
         private void PopulateRelationshipInResourceObject(ResourceObjectTreeNode treeNode, RelationshipAttribute relationship)
         {
             SingleOrManyData<ResourceIdentifierObject> data = GetRelationshipData(treeNode, relationship);
-            RelationshipLinks? links = _linkBuilder.GetRelationshipLinks(relationship, treeNode.Resource.StringId!);
+            RelationshipLinks? links = _linkBuilder.GetRelationshipLinks(relationship, treeNode.Resource);
 
             if (links != null || data.IsAssigned)
             {
diff --git a/test/JsonApiDotNetCoreTests/UnitTests/Links/LinkInclusionTests.cs b/test/JsonApiDotNetCoreTests/UnitTests/Links/LinkInclusionTests.cs
@@ -166,7 +166,7 @@ public void Applies_cascading_settings_for_resource_links(LinkTypes linksInResou
             var linkBuilder = new LinkBuilder(options, request, paginationContext, httpContextAccessor, linkGenerator, controllerResourceMapping);
 
             // Act
-            ResourceLinks? resourceLinks = linkBuilder.GetResourceLinks(exampleResourceType, "id");
+            ResourceLinks? resourceLinks = linkBuilder.GetResourceLinks(exampleResourceType, new ExampleResource());
 
             // Assert
             if (expected == LinkTypes.Self)
@@ -331,7 +331,7 @@ public void Applies_cascading_settings_for_relationship_links(LinkTypes linksInR
             };
 
             // Act
-            RelationshipLinks? relationshipLinks = linkBuilder.GetRelationshipLinks(relationship, "?");
+            RelationshipLinks? relationshipLinks = linkBuilder.GetRelationshipLinks(relationship, new ExampleResource());
 
             // Assert
             if (expected == LinkTypes.None)
diff --git a/test/JsonApiDotNetCoreTests/UnitTests/Serialization/Response/ResponseModelAdapterTests.cs b/test/JsonApiDotNetCoreTests/UnitTests/Serialization/Response/ResponseModelAdapterTests.cs
@@ -595,12 +595,12 @@ private sealed class FakeLinkBuilder : ILinkBuilder
                 return null;
             }
 
-            public ResourceLinks? GetResourceLinks(ResourceType resourceType, string id)
+            public ResourceLinks? GetResourceLinks(ResourceType resourceType, IIdentifiable resource)
             {
                 return null;
             }
 
-            public RelationshipLinks? GetRelationshipLinks(RelationshipAttribute relationship, string leftId)
+            public RelationshipLinks? GetRelationshipLinks(RelationshipAttribute relationship, IIdentifiable leftResource)
             {
                 return null;
             }

Original file line number	Diff line number	Diff line change
`@@ -229,15 +229,15 @@ public TopLevelLinks GetTopLevelLinks()`
`229`	`229`	`};`
`230`	`230`	`}`
`231`	`231`
`232`		`- public ResourceLinks GetResourceLinks(ResourceType resourceType, string id)`
	`232`	`+ public ResourceLinks GetResourceLinks(ResourceType resourceType, IIdentifiable resource)`
`233`	`233`	`{`
`234`	`234`	`return new ResourceLinks`
`235`	`235`	`{`
`236`	`236`	`Self = "Resource:Self"`
`237`	`237`	`};`
`238`	`238`	`}`
`239`	`239`
`240`		`- public RelationshipLinks GetRelationshipLinks(RelationshipAttribute relationship, string leftId)`
	`240`	`+ public RelationshipLinks GetRelationshipLinks(RelationshipAttribute relationship, IIdentifiable leftResource)`
`241`	`241`	`{`
`242`	`242`	`return new RelationshipLinks`
`243`	`243`	`{`
Original file line number	Diff line number	Diff line change
`@@ -228,16 +228,16 @@ private string GetQueryStringInPaginationLink(int pageOffset, string? pageSizeVa`
`228`	`228`	`}`
`229`	`229`
`230`	`230`	`/// <inheritdoc />`
`231`		`- public ResourceLinks? GetResourceLinks(ResourceType resourceType, string id)`
	`231`	`+ public ResourceLinks? GetResourceLinks(ResourceType resourceType, IIdentifiable resource)`
`232`	`232`	`{`
`233`	`233`	`ArgumentGuard.NotNull(resourceType, nameof(resourceType));`
`234`		`- ArgumentGuard.NotNullNorEmpty(id, nameof(id));`
	`234`	`+ ArgumentGuard.NotNull(resource, nameof(resource));`
`235`	`235`
`236`	`236`	`var links = new ResourceLinks();`
`237`	`237`
`238`	`238`	`if (ShouldIncludeResourceLink(LinkTypes.Self, resourceType))`
`239`	`239`	`{`
`240`		`- links.Self = GetLinkForResourceSelf(resourceType, id);`
	`240`	`+ links.Self = GetLinkForResourceSelf(resourceType, resource);`
`241`	`241`	`}`
`242`	`242`
`243`	`243`	`return links.HasValue() ? links : null;`
`@@ -257,30 +257,30 @@ private bool ShouldIncludeResourceLink(LinkTypes linkType, ResourceType resource`
`257`	`257`	`return _options.ResourceLinks.HasFlag(linkType);`
`258`	`258`	`}`
`259`	`259`
`260`		`- private string? GetLinkForResourceSelf(ResourceType resourceType, string resourceId)`
	`260`	`+ private string? GetLinkForResourceSelf(ResourceType resourceType, IIdentifiable resource)`
`261`	`261`	`{`
`262`	`262`	`string? controllerName = _controllerResourceMapping.GetControllerNameForResourceType(resourceType);`
`263`		`- IDictionary<string, object?> routeValues = GetRouteValues(resourceId, null);`
	`263`	`+ IDictionary<string, object?> routeValues = GetRouteValues(resource.StringId!, null);`
`264`	`264`
`265`	`265`	`return RenderLinkForAction(controllerName, GetPrimaryControllerActionName, routeValues);`
`266`	`266`	`}`
`267`	`267`
`268`	`268`	`/// <inheritdoc />`
`269`		`- public RelationshipLinks? GetRelationshipLinks(RelationshipAttribute relationship, string leftId)`
	`269`	`+ public RelationshipLinks? GetRelationshipLinks(RelationshipAttribute relationship, IIdentifiable leftResource)`
`270`	`270`	`{`
`271`	`271`	`ArgumentGuard.NotNull(relationship, nameof(relationship));`
`272`		`- ArgumentGuard.NotNullNorEmpty(leftId, nameof(leftId));`
	`272`	`+ ArgumentGuard.NotNull(leftResource, nameof(leftResource));`
`273`	`273`
`274`	`274`	`var links = new RelationshipLinks();`
`275`	`275`
`276`	`276`	`if (ShouldIncludeRelationshipLink(LinkTypes.Self, relationship))`
`277`	`277`	`{`
`278`		`- links.Self = GetLinkForRelationshipSelf(leftId, relationship);`
	`278`	`+ links.Self = GetLinkForRelationshipSelf(leftResource.StringId!, relationship);`
`279`	`279`	`}`
`280`	`280`
`281`	`281`	`if (ShouldIncludeRelationshipLink(LinkTypes.Related, relationship))`
`282`	`282`	`{`
`283`		`- links.Related = GetLinkForRelationshipRelated(leftId, relationship);`
	`283`	`+ links.Related = GetLinkForRelationshipRelated(leftResource.StringId!, relationship);`
`284`	`284`	`}`
`285`	`285`
`286`	`286`	`return links.HasValue() ? links : null;`
Original file line number	Diff line number	Diff line change
`@@ -204,7 +204,7 @@ protected virtual ResourceObject ConvertResource(IIdentifiable resource, Resourc`
`204`	`204`	`IImmutableSet<ResourceFieldAttribute> fieldSet = _sparseFieldSetCache.GetSparseFieldSetForSerializer(type);`
`205`	`205`
`206`	`206`	`resourceObject.Attributes = ConvertAttributes(resource, type, fieldSet);`
`207`		`- resourceObject.Links = _linkBuilder.GetResourceLinks(type, resource.StringId!);`
	`207`	`+ resourceObject.Links = _linkBuilder.GetResourceLinks(type, resource);`
`208`	`208`	`resourceObject.Meta = _resourceDefinitionAccessor.GetMeta(type, resource);`
`209`	`209`	`}`
`210`	`210`
`@@ -292,7 +292,7 @@ private void PopulateRelationshipsInResourceObject(ResourceObjectTreeNode treeNo`
`292`	`292`	`private void PopulateRelationshipInResourceObject(ResourceObjectTreeNode treeNode, RelationshipAttribute relationship)`
`293`	`293`	`{`
`294`	`294`	`SingleOrManyData<ResourceIdentifierObject> data = GetRelationshipData(treeNode, relationship);`
`295`		`- RelationshipLinks? links = _linkBuilder.GetRelationshipLinks(relationship, treeNode.Resource.StringId!);`
	`295`	`+ RelationshipLinks? links = _linkBuilder.GetRelationshipLinks(relationship, treeNode.Resource);`
`296`	`296`
`297`	`297`	`if (links != null \|\| data.IsAssigned)`
`298`	`298`	`{`
Original file line number	Diff line number	Diff line change
`@@ -595,12 +595,12 @@ private sealed class FakeLinkBuilder : ILinkBuilder`
`595`	`595`	`return null;`
`596`	`596`	`}`
`597`	`597`
`598`		`- public ResourceLinks? GetResourceLinks(ResourceType resourceType, string id)`
	`598`	`+ public ResourceLinks? GetResourceLinks(ResourceType resourceType, IIdentifiable resource)`
`599`	`599`	`{`
`600`	`600`	`return null;`
`601`	`601`	`}`
`602`	`602`
`603`		`- public RelationshipLinks? GetRelationshipLinks(RelationshipAttribute relationship, string leftId)`
	`603`	`+ public RelationshipLinks? GetRelationshipLinks(RelationshipAttribute relationship, IIdentifiable leftResource)`
`604`	`604`	`{`
`605`	`605`	`return null;`
`606`	`606`	`}`