Removed obsolete IJsonApiRequest.BasePath

Author: Bart Koelman

src/JsonApiDotNetCore/Middleware/IJsonApiRequest.cs

@@ -1,4 +1,3 @@
-using System;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Resources.Annotations;
 
@@ -14,18 +13,6 @@ public interface IJsonApiRequest
         /// </summary>
         public EndpointKind Kind { get; }
 
-        /// <summary>
-        /// The request URL prefix. This may be an absolute or relative path, depending on <see cref="IJsonApiOptions.UseRelativeLinks" />.
-        /// </summary>
-        /// <example>
-        /// <code><![CDATA[
-        /// Absolute: https://example.com/api/v1
-        /// Relative: /api/v1
-        /// ]]></code>
-        /// </example>
-        [Obsolete("This value is calculated for backwards compatibility, but it is no longer used and will be removed in a future version.")]
-        string BasePath { get; }
-
         /// <summary>
         /// The ID of the primary (top-level) resource for this request. This would be null in "/blogs", "123" in "/blogs/123" or "/blogs/123/author".
         /// </summary>

src/JsonApiDotNetCore/Middleware/JsonApiMiddleware.cs

@@ -1,10 +1,8 @@
 using System;
-using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Net;
 using System.Net.Http;
-using System.Text;
 using System.Threading.Tasks;
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Configuration;
@@ -13,7 +11,6 @@
 using JsonApiDotNetCore.Serialization.Objects;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Http.Features;
-using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Controllers;
 using Microsoft.AspNetCore.Routing;
 using Microsoft.Net.Http.Headers;
@@ -218,7 +215,6 @@ private static void SetupResourceRequest(JsonApiRequest request, ResourceContext
             request.Kind = EndpointKind.Primary;
             request.PrimaryResource = primaryResourceContext;
             request.PrimaryId = GetPrimaryRequestId(routeValues);
-            request.BasePath = GetBasePath(primaryResourceContext.PublicName, options, httpRequest);
 
             string relationshipName = GetRelationshipNameForSecondaryRequest(routeValues);
 
@@ -245,58 +241,6 @@ private static string GetPrimaryRequestId(RouteValueDictionary routeValues)
             return routeValues.TryGetValue("id", out object id) ? (string)id : null;
         }
 
-        private static string GetBasePath(string resourceName, IJsonApiOptions options, HttpRequest httpRequest)
-        {
-            var builder = new StringBuilder();
-
-            if (!options.UseRelativeLinks)
-            {
-                builder.Append(httpRequest.Scheme);
-                builder.Append("://");
-                builder.Append(httpRequest.Host);
-            }
-
-            if (httpRequest.PathBase.HasValue)
-            {
-                builder.Append(httpRequest.PathBase);
-            }
-
-            string customRoute = GetCustomRoute(resourceName, options.Namespace, httpRequest.HttpContext);
-
-            if (!string.IsNullOrEmpty(customRoute))
-            {
-                builder.Append('/');
-                builder.Append(customRoute);
-            }
-            else if (!string.IsNullOrEmpty(options.Namespace))
-            {
-                builder.Append('/');
-                builder.Append(options.Namespace);
-            }
-
-            return builder.ToString();
-        }
-
-        private static string GetCustomRoute(string resourceName, string apiNamespace, HttpContext httpContext)
-        {
-            if (resourceName != null)
-            {
-                Endpoint endpoint = httpContext.GetEndpoint();
-                var routeAttribute = endpoint?.Metadata.GetMetadata<RouteAttribute>();
-
-                if (routeAttribute != null && httpContext.Request.Path.Value != null)
-                {
-                    List<string> trimmedComponents = httpContext.Request.Path.Value.Trim('/').Split('/').ToList();
-                    int resourceNameIndex = trimmedComponents.FindIndex(component => component == resourceName);
-                    string[] newComponents = trimmedComponents.Take(resourceNameIndex).ToArray();
-                    string customRoute = string.Join('/', newComponents);
-                    return customRoute == apiNamespace ? null : customRoute;
-                }
-            }
-
-            return null;
-        }
-
         private static string GetRelationshipNameForSecondaryRequest(RouteValueDictionary routeValues)
         {
             return routeValues.TryGetValue("relationshipName", out object routeValue) ? (string)routeValue : null;
@@ -318,7 +262,6 @@ private static void SetupOperationsRequest(JsonApiRequest request, IJsonApiOptio
         {
             request.IsReadOnly = false;
             request.Kind = EndpointKind.AtomicOperations;
-            request.BasePath = GetBasePath(null, options, httpRequest);
         }
     }
 }

src/JsonApiDotNetCore/Middleware/JsonApiRequest.cs

@@ -11,9 +11,6 @@ public sealed class JsonApiRequest : IJsonApiRequest
         /// <inheritdoc />
         public EndpointKind Kind { get; set; }
 
-        /// <inheritdoc />
-        public string BasePath { get; set; }
-
         /// <inheritdoc />
         public string PrimaryId { get; set; }
 
@@ -44,9 +41,6 @@ public void CopyFrom(IJsonApiRequest other)
             ArgumentGuard.NotNull(other, nameof(other));
 
             Kind = other.Kind;
-#pragma warning disable CS0618 // Type or member is obsolete
-            BasePath = other.BasePath;
-#pragma warning restore CS0618 // Type or member is obsolete
             PrimaryId = other.PrimaryId;
             PrimaryResource = other.PrimaryResource;
             SecondaryResource = other.SecondaryResource;

src/JsonApiDotNetCore/Serialization/RequestDeserializer.cs

@@ -203,9 +203,6 @@ private OperationContainer ParseForCreateOrUpdateResourceOperation(AtomicOperati
             var request = new JsonApiRequest
             {
                 Kind = EndpointKind.AtomicOperations,
-#pragma warning disable CS0618 // Type or member is obsolete
-                BasePath = _request.BasePath,
-#pragma warning restore CS0618 // Type or member is obsolete
                 PrimaryResource = primaryResourceContext,
                 OperationKind = kind
             };
@@ -329,9 +326,6 @@ private OperationContainer ParseForDeleteResourceOperation(AtomicOperationObject
             var request = new JsonApiRequest
             {
                 Kind = EndpointKind.AtomicOperations,
-#pragma warning disable CS0618 // Type or member is obsolete
-                BasePath = _request.BasePath,
-#pragma warning restore CS0618 // Type or member is obsolete
                 PrimaryId = primaryResource.StringId,
                 PrimaryResource = primaryResourceContext,
                 OperationKind = kind
@@ -366,9 +360,6 @@ private OperationContainer ParseForRelationshipOperation(AtomicOperationObject o
             var request = new JsonApiRequest
             {
                 Kind = EndpointKind.AtomicOperations,
-#pragma warning disable CS0618 // Type or member is obsolete
-                BasePath = _request.BasePath,
-#pragma warning restore CS0618 // Type or member is obsolete
                 PrimaryId = primaryResource.StringId,
                 PrimaryResource = primaryResourceContext,
                 SecondaryResource = secondaryResourceContext,

test/UnitTests/Middleware/JsonApiRequestTests.cs

@@ -70,7 +70,6 @@ public async Task Sets_request_properties_correctly(string requestMethod, string
             request.IsCollection.Should().Be(expectIsCollection);
             request.Kind.Should().Be(expectKind);
             request.IsReadOnly.Should().Be(expectIsReadOnly);
-            request.BasePath.Should().BeEmpty();
             request.PrimaryResource.Should().NotBeNull();
             request.PrimaryResource.PublicName.Should().Be("todoItems");
         }