Custom Asset URL replacements. Resolves issues kontent-ai#311 and kontent-ai#193

xantari · xantari · commit cd47f06d819c · 2024-11-21T08:03:41.000-06:00
diff --git a/Kontent.Ai.Delivery.Abstractions/Configuration/DeliveryOptions.cs b/Kontent.Ai.Delivery.Abstractions/Configuration/DeliveryOptions.cs
@@ -79,5 +79,14 @@ public class DeliveryOptions
         /// </summary>
         [Obsolete("#312")]
         internal string Name { get; set; }
+
+        /// <summary>
+        /// Replaces the base URL of the asset URLs in the API response. The asset URL will retain all the identifying information such as project id, asset id and file name.<br/>
+        /// <b>NOTE: </b>Do not specify a trailing backslash in the URL.<br/>
+        /// <b>Example where AssetUrlReplacement is defined as "https://www.example.com/assets":</b><br/>
+        /// <b>Original Value:</b> https://preview-assets-us-01.kc-usercontent.com/7ffda7b5-bfb2-4226-8b4f-d2e333638416/614cb0cc-9e62-4572-a408-fc8715f990e8/test-asset.pdf <br/>
+        /// <b>New Value:</b> https://www.example.com/assets/7ffda7b5-bfb2-4226-8b4f-d2e333638416/614cb0cc-9e62-4572-a408-fc8715f990e8/test-asset.pdf
+        /// </summary>
+        public string AssetUrlReplacement { get; set; }
     }
 }
diff --git a/Kontent.Ai.Delivery.Abstractions/Extensions/DeliveryOptionsExtensions.cs b/Kontent.Ai.Delivery.Abstractions/Extensions/DeliveryOptionsExtensions.cs
@@ -24,10 +24,11 @@ public static void Configure(this DeliveryOptions o, DeliveryOptions options)
             o.DefaultRetryPolicyOptions = options.DefaultRetryPolicyOptions;
             o.IncludeTotalCount = options.IncludeTotalCount;
             // See #312
-            #pragma warning disable CS0618
+#pragma warning disable CS0618
             o.Name = options.Name;
-            #pragma warning restore CS0618
+#pragma warning restore CS0618
             o.DefaultRenditionPreset = options.DefaultRenditionPreset;
+            o.AssetUrlReplacement = options.AssetUrlReplacement;
         }
     }
 }
diff --git a/Kontent.Ai.Delivery.Tests/Builders/Configuration/DeliveryOptionsBuilderTests.cs b/Kontent.Ai.Delivery.Tests/Builders/Configuration/DeliveryOptionsBuilderTests.cs
@@ -1,14 +1,14 @@
-﻿using System;
-using Kontent.Ai.Delivery.Abstractions;
+﻿using Kontent.Ai.Delivery.Abstractions;
 using Kontent.Ai.Delivery.Configuration;
+using System;
 using Xunit;
 
 namespace Kontent.Ai.Delivery.Tests.Builders.Configuration
 {
     public class DeliveryOptionsBuilderTests
     {
         private const string EnvironmentId = "550cec62-90a6-4ab3-b3e4-3d0bb4c04f5c";
-        private const string PreviewApiKey = 
+        private const string PreviewApiKey =
             "eyJ0eXAiOiwq14X65DLCJhbGciOiJIUzI1NiJ-.eyJqdGkiOiABCjJlM2FiOTBjOGM0ODVmYjdmZTDEFRQZGM1NDIyMCIsImlhdCI6IjE1Mjg454wexiLCJleHAiOiIxODc0NDg3NjqasdfwicHJvamVjdF9pZCI6Ij" +
             "g1OTEwOTlkN2458198ewqewZjI3Yzg5M2FhZTJiNTE4IiwidmVyIjoiMS4wLjAiLCJhdWQiewqgsdaWV3LmRlbGl2ZXIua2VudGljb2Nsb3VkLmNvbSJ9._tSzbNDpbE55dsaLUTGsdgesg4b693TFuhRCRsDyoc";
 
@@ -58,7 +58,7 @@ public void BuildWithEnvironmentIdAndSecuredProductionApi()
             Assert.True(deliveryOptions.UseSecureAccess);
             Assert.Equal(SecuredApiKey, deliveryOptions.SecureAccessApiKey);
         }
-        
+
         [Fact]
         public void BuildWithRetryPolicyOptions()
         {
@@ -136,7 +136,7 @@ public void BuildWithCustomEndpointForPreviewApi()
                 .WithCustomEndpoint(customEndpoint)
                 .Build();
 
-           Assert.Equal(customEndpoint, deliveryOptions.PreviewEndpoint);
+            Assert.Equal(customEndpoint, deliveryOptions.PreviewEndpoint);
         }
 
         [Fact]
@@ -159,7 +159,7 @@ public void BuildWithCustomEndpointAsUriForPreviewApi()
         {
             const string customEndpoint = "http://www.custompreviewendpoint.com/";
             var uri = new Uri(customEndpoint, UriKind.Absolute);
-            
+
             var deliveryOptions = DeliveryOptionsBuilder
                 .CreateInstance()
                 .WithEnvironmentId(EnvironmentId)
@@ -185,7 +185,7 @@ public void BuildWithCustomEndpointAsUriForProductionApi()
 
             Assert.Equal(customEndpoint, deliveryOptions.ProductionEndpoint);
         }
-        
+
         [Fact]
         public void BuildWithDefaultRenditionPreset()
         {
@@ -200,5 +200,20 @@ public void BuildWithDefaultRenditionPreset()
 
             Assert.Equal(renditionPreset, deliveryOptions.DefaultRenditionPreset);
         }
+
+        [Fact]
+        public void BuildWithAssetUrlReplacement()
+        {
+            var assetUrl = "https://www.example.com/assets";
+
+            var deliveryOptions = DeliveryOptionsBuilder
+                .CreateInstance()
+                .WithEnvironmentId(EnvironmentId)
+                .UseProductionApi()
+                .WithAssetUrlReplacement(assetUrl)
+                .Build();
+
+            Assert.Equal(assetUrl, deliveryOptions.AssetUrlReplacement);
+        }
     }
 }
diff --git a/Kontent.Ai.Delivery.Tests/Builders/DeliveryClient/DeliveryClientBuilderTests.cs b/Kontent.Ai.Delivery.Tests/Builders/DeliveryClient/DeliveryClientBuilderTests.cs
@@ -1,6 +1,4 @@
-﻿using System;
-using System.Collections.Generic;
-using FakeItEasy;
+﻿using FakeItEasy;
 using Kontent.Ai.Delivery.Abstractions;
 using Kontent.Ai.Delivery.Builders.DeliveryClient;
 using Kontent.Ai.Delivery.ContentItems;
@@ -10,6 +8,8 @@
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Logging.Abstractions;
 using RichardSzalay.MockHttp;
+using System;
+using System.Collections.Generic;
 using Xunit;
 
 namespace Kontent.Ai.Delivery.Tests.Builders.DeliveryClient
@@ -27,7 +27,7 @@ public class DeliveryClientBuilderTests
         [Fact]
         public void BuildWithEnvironmentId_ReturnsDeliveryClientWithEnvironmentIdSet()
         {
-            var deliveryClient = (Delivery.DeliveryClient) DeliveryClientBuilder.WithEnvironmentId(EnvironmentId).Build();
+            var deliveryClient = (Delivery.DeliveryClient)DeliveryClientBuilder.WithEnvironmentId(EnvironmentId).Build();
 
             Assert.Equal(EnvironmentId, deliveryClient.DeliveryOptions.CurrentValue.EnvironmentId);
         }
@@ -36,18 +36,21 @@ public void BuildWithEnvironmentId_ReturnsDeliveryClientWithEnvironmentIdSet()
         public void BuildWithDeliveryOptions_ReturnsDeliveryClientWithDeliveryOptions()
         {
             var guid = new Guid(EnvironmentId);
+            var assetReplacementUrl = "https://cdn.example.com/assets";
 
-            var deliveryClient = (Delivery.DeliveryClient) DeliveryClientBuilder
+            var deliveryClient = (Delivery.DeliveryClient)DeliveryClientBuilder
                 .WithOptions(builder => builder
                     .WithEnvironmentId(guid)
                     .UsePreviewApi(PreviewApiKey)
                     .WithCustomEndpoint(PreviewEndpoint)
+                    .WithAssetUrlReplacement("https://cdn.example.com/assets")
                     .Build()
                 ).Build();
 
             Assert.Equal(EnvironmentId, deliveryClient.DeliveryOptions.CurrentValue.EnvironmentId);
             Assert.True(deliveryClient.DeliveryOptions.CurrentValue.UsePreviewApi);
             Assert.Equal(PreviewEndpoint, deliveryClient.DeliveryOptions.CurrentValue.PreviewEndpoint);
+            Assert.Equal(assetReplacementUrl, deliveryClient.DeliveryOptions.CurrentValue.AssetUrlReplacement);
         }
 
         [Fact]
@@ -65,7 +68,7 @@ public void BuildWithOptionalSteps_ReturnsDeliveryClientWithSetInstances()
             var mockDeliveryHttpClient = new DeliveryHttpClient(new MockHttpMessageHandler().ToHttpClient());
             var mockLoggerFactory = A.Fake<ILoggerFactory>();
 
-            var deliveryClient = (Delivery.DeliveryClient) DeliveryClientBuilder
+            var deliveryClient = (Delivery.DeliveryClient)DeliveryClientBuilder
                 .WithEnvironmentId(EnvironmentId)
                 .WithDeliveryHttpClient(mockDeliveryHttpClient)
                 .WithContentLinkUrlResolver(mockContentLinkUrlResolver)
@@ -119,7 +122,7 @@ public void BuildWithOptionalStepsAndCustomProvider_ReturnsDeliveryClientWithSet
         {
             var modelProvider = new FakeModelProvider();
 
-            var deliveryClient = (Delivery.DeliveryClient) DeliveryClientBuilder
+            var deliveryClient = (Delivery.DeliveryClient)DeliveryClientBuilder
                 .WithEnvironmentId(EnvironmentId)
                 .WithModelProvider(modelProvider)
                 .Build();
@@ -137,7 +140,7 @@ public void BuildWithoutOptionalSteps_ReturnsDeliveryClientWithDefaultImplementa
                 typeof(UnknownContentItem)
             };
 
-            var deliveryClient = (Delivery.DeliveryClient) DeliveryClientBuilder
+            var deliveryClient = (Delivery.DeliveryClient)DeliveryClientBuilder
                 .WithEnvironmentId(_guid)
                 .Build();
             var actualResolvableInlineContentItemTypes = GetResolvableInlineContentItemTypes(deliveryClient);
diff --git a/Kontent.Ai.Delivery.Tests/ValueConverterTests.cs b/Kontent.Ai.Delivery.Tests/ValueConverterTests.cs
@@ -1,11 +1,4 @@
-﻿using System;
-using System.Collections.Generic;
-using System.IO;
-using System.Linq;
-using System.Net.Http;
-using System.Reflection;
-using System.Threading.Tasks;
-using AngleSharp.Html.Parser;
+﻿using AngleSharp.Html.Parser;
 using FakeItEasy;
 using Kontent.Ai.Delivery.Abstractions;
 using Kontent.Ai.Delivery.ContentItems;
@@ -14,6 +7,13 @@
 using Kontent.Ai.Urls.Delivery.QueryParameters;
 using NodaTime;
 using RichardSzalay.MockHttp;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Net.Http;
+using System.Reflection;
+using System.Threading.Tasks;
 using Xunit;
 
 namespace Kontent.Ai.Delivery.Tests
@@ -72,7 +72,7 @@ public async void LinkedItemCodenamesValueConverter()
 
             var article = await client.GetItemAsync<Article>("on_roasts");
 
-            Assert.Equal(new[]{"coffee_processing_techniques", "origins_of_arabica_bourbon"}, article.Item.RelatedArticleCodenames);
+            Assert.Equal(new[] { "coffee_processing_techniques", "origins_of_arabica_bourbon" }, article.Item.RelatedArticleCodenames);
         }
 
         [Fact]
@@ -120,7 +120,7 @@ public async void RichTextViaValueConverter()
             Assert.NotNull(hostedVideo);
             Assert.NotNull(tweet);
         }
-        
+
         [Fact]
         public async Task AssetElementValueConverter_NoPresetSpecifiedInConfig_AssetUrlIsUntouched()
         {
@@ -138,7 +138,26 @@ public async Task AssetElementValueConverter_NoPresetSpecifiedInConfig_AssetUrlI
 
             Assert.Equal(assetUrl, teaserImage.Url);
         }
-        
+
+        [Fact]
+        public async Task AssetElementValueConverter_NoPresetSpecifiedInConfig_AssetUrlReplacementSpecifiedInConfig_AssetUrlIsTouched()
+        {
+            var mockHttp = new MockHttpMessageHandler();
+            mockHttp
+                .When($"{_baseUrl}/items/coffee_beverages_explained")
+                .Respond("application/json", await File.ReadAllTextAsync(Path.Combine(Environment.CurrentDirectory, $"Fixtures{Path.DirectorySeparatorChar}DeliveryClient{Path.DirectorySeparatorChar}coffee_beverages_explained.json")));
+
+            var client = InitializeDeliveryClient(mockHttp);
+            client.DeliveryOptions.CurrentValue.AssetUrlReplacement = "https://cdn.example.com/assets";
+
+            var response = await client.GetItemAsync<Article>("coffee_beverages_explained");
+            var teaserImage = response.Item.TeaserImage.FirstOrDefault();
+
+            var assetUrl = "https://cdn.example.com/assets/975bf280-fd91-488c-994c-2f04416e5ee3/e700596b-03b0-4cee-ac5c-9212762c027a/coffee-beverages-explained-1080px.jpg";
+
+            Assert.Equal(assetUrl, teaserImage.Url);
+        }
+
         [Fact]
         public async Task AssetElementValueConverter_DefaultPresetSpecifiedInConfig_AssetUrlContainsDefaultRenditionQuery()
         {
@@ -149,7 +168,7 @@ public async Task AssetElementValueConverter_DefaultPresetSpecifiedInConfig_Asse
 
             var defaultRenditionPreset = "default";
 
-            var client = InitializeDeliveryClient(mockHttp, new DeliveryOptions { EnvironmentId = _guid, DefaultRenditionPreset = defaultRenditionPreset});
+            var client = InitializeDeliveryClient(mockHttp, new DeliveryOptions { EnvironmentId = _guid, DefaultRenditionPreset = defaultRenditionPreset });
 
             var response = await client.GetItemAsync<Article>("coffee_beverages_explained");
             var teaserImage = response.Item.TeaserImage.FirstOrDefault();
@@ -159,7 +178,29 @@ public async Task AssetElementValueConverter_DefaultPresetSpecifiedInConfig_Asse
 
             Assert.Equal($"{assetUrl}?{defaultRenditionQuery}", teaserImage.Url);
         }
-        
+
+        [Fact]
+        public async Task AssetElementValueConverter_DefaultPresetSpecifiedInConfig_AssetUrlReplacementSpecifiedInConfig_AssetUrlContainsDefaultRenditionQuery()
+        {
+            var mockHttp = new MockHttpMessageHandler();
+            mockHttp
+                .When($"{_baseUrl}/items/coffee_beverages_explained")
+                .Respond("application/json", await File.ReadAllTextAsync(Path.Combine(Environment.CurrentDirectory, $"Fixtures{Path.DirectorySeparatorChar}DeliveryClient{Path.DirectorySeparatorChar}coffee_beverages_explained.json")));
+
+            var defaultRenditionPreset = "default";
+
+            var client = InitializeDeliveryClient(mockHttp, new DeliveryOptions { EnvironmentId = _guid, DefaultRenditionPreset = defaultRenditionPreset });
+            client.DeliveryOptions.CurrentValue.AssetUrlReplacement = "https://cdn.example.com/assets";
+
+            var response = await client.GetItemAsync<Article>("coffee_beverages_explained");
+            var teaserImage = response.Item.TeaserImage.FirstOrDefault();
+
+            var assetUrl = "https://cdn.example.com/assets/975bf280-fd91-488c-994c-2f04416e5ee3/e700596b-03b0-4cee-ac5c-9212762c027a/coffee-beverages-explained-1080px.jpg";
+            var defaultRenditionQuery = "w=200&h=150&fit=clip&rect=7,23,300,200";
+
+            Assert.Equal($"{assetUrl}?{defaultRenditionQuery}", teaserImage.Url);
+        }
+
         [Fact]
         public async Task AssetElementValueConverter_MobilePresetSpecifiedInConfig_AssetUrlIsUntouchedAsThereIsNoMobileRenditionSpecified()
         {
@@ -170,8 +211,8 @@ public async Task AssetElementValueConverter_MobilePresetSpecifiedInConfig_Asset
 
             var defaultRenditionPreset = "mobile";
 
-            var client = InitializeDeliveryClient(mockHttp, new DeliveryOptions { EnvironmentId = _guid, DefaultRenditionPreset = defaultRenditionPreset});
-            
+            var client = InitializeDeliveryClient(mockHttp, new DeliveryOptions { EnvironmentId = _guid, DefaultRenditionPreset = defaultRenditionPreset });
+
             var response = await client.GetItemAsync<Article>("coffee_beverages_explained");
             var teaserImage = response.Item.TeaserImage.FirstOrDefault();
 
@@ -180,6 +221,27 @@ public async Task AssetElementValueConverter_MobilePresetSpecifiedInConfig_Asset
             Assert.Equal(assetUrl, teaserImage.Url);
         }
 
+        [Fact]
+        public async Task AssetElementValueConverter_MobilePresetSpecifiedInConfig_AssetUrlReplacementSpecifiedInConfig_AssetUrlIsUntouchedAsThereIsNoMobileRenditionSpecified()
+        {
+            var mockHttp = new MockHttpMessageHandler();
+            mockHttp
+                .When($"{_baseUrl}/items/coffee_beverages_explained")
+                .Respond("application/json", await File.ReadAllTextAsync(Path.Combine(Environment.CurrentDirectory, $"Fixtures{Path.DirectorySeparatorChar}DeliveryClient{Path.DirectorySeparatorChar}coffee_beverages_explained.json")));
+
+            var defaultRenditionPreset = "mobile";
+
+            var client = InitializeDeliveryClient(mockHttp, new DeliveryOptions { EnvironmentId = _guid, DefaultRenditionPreset = defaultRenditionPreset });
+            client.DeliveryOptions.CurrentValue.AssetUrlReplacement = "https://cdn.example.com/assets";
+
+            var response = await client.GetItemAsync<Article>("coffee_beverages_explained");
+            var teaserImage = response.Item.TeaserImage.FirstOrDefault();
+
+            var assetUrl = "https://cdn.example.com/assets/975bf280-fd91-488c-994c-2f04416e5ee3/e700596b-03b0-4cee-ac5c-9212762c027a/coffee-beverages-explained-1080px.jpg";
+
+            Assert.Equal(assetUrl, teaserImage.Url);
+        }
+
         private DeliveryClient InitializeDeliveryClient(MockHttpMessageHandler mockHttp, DeliveryOptions options = null)
         {
             var deliveryHttpClient = new DeliveryHttpClient(mockHttp.ToHttpClient());
diff --git a/Kontent.Ai.Delivery/Configuration/DeliveryOptionsBuilder.cs b/Kontent.Ai.Delivery/Configuration/DeliveryOptionsBuilder.cs
@@ -1,5 +1,5 @@
-﻿using System;
-using Kontent.Ai.Delivery.Abstractions;
+﻿using Kontent.Ai.Delivery.Abstractions;
+using System;
 using DefaultRetryPolicyOptions = Kontent.Ai.Delivery.Abstractions.DefaultRetryPolicyOptions;
 
 namespace Kontent.Ai.Delivery.Configuration
@@ -101,7 +101,13 @@ IOptionalDeliveryConfiguration IOptionalDeliveryConfiguration.WithCustomEndpoint
         IOptionalDeliveryConfiguration IOptionalDeliveryConfiguration.WithDefaultRenditionPreset(string presetCodename)
         {
             _deliveryOptions.DefaultRenditionPreset = presetCodename;
-            
+
+            return this;
+        }
+
+        IOptionalDeliveryConfiguration IOptionalDeliveryConfiguration.WithAssetUrlReplacement(string url)
+        {
+            _deliveryOptions.AssetUrlReplacement = url;
             return this;
         }
 
diff --git a/Kontent.Ai.Delivery/Configuration/IDeliveryOptionsBuilder.cs b/Kontent.Ai.Delivery/Configuration/IDeliveryOptionsBuilder.cs
@@ -1,6 +1,6 @@
-﻿using System;
+﻿using Kontent.Ai.Delivery.Abstractions;
 using Kontent.Ai.Urls.Delivery.QueryParameters;
-using Kontent.Ai.Delivery.Abstractions;
+using System;
 
 
 namespace Kontent.Ai.Delivery.Configuration
@@ -69,7 +69,7 @@ public interface IOptionalDeliveryConfiguration : IDeliveryOptionsBuild
         /// Please note that using this option might increase the response time.
         /// </summary>
         IOptionalDeliveryConfiguration IncludeTotalCount();
-        
+
         /// <summary>
         /// Change configuration of the default retry policy.
         /// </summary>
@@ -104,6 +104,17 @@ public interface IOptionalDeliveryConfiguration : IDeliveryOptionsBuild
         /// </remarks>
         /// <param name="presetCodename">Codename of the rendition preset to be applied automatically.</param>
         IOptionalDeliveryConfiguration WithDefaultRenditionPreset(string presetCodename);
+
+        /// <summary>
+        /// Replaces the base URL of the asset URLs in the API response. The asset URL will retain all the identifying information such as project id, asset id and file name.<br/>
+        /// <b>NOTE: </b>Do not specify a trailing backslash in the URL.<br/>
+        /// <b>Example where url is defined as "https://www.example.com/assets":</b><br/>
+        /// <b>Original Value:</b> https://preview-assets-us-01.kc-usercontent.com/7ffda7b5-bfb2-4226-8b4f-d2e333638416/614cb0cc-9e62-4572-a408-fc8715f990e8/test-asset.pdf <br/>
+        /// <b>New Value:</b> https://www.example.com/assets/7ffda7b5-bfb2-4226-8b4f-d2e333638416/614cb0cc-9e62-4572-a408-fc8715f990e8/test-asset.pdf
+        /// </summary>
+        /// <param name="url">URL to substitute for asset urls</param>
+        /// <returns></returns>
+        IOptionalDeliveryConfiguration WithAssetUrlReplacement(string url);
     }
 
     /// <summary>
diff --git a/Kontent.Ai.Delivery/ContentItems/AssetElementValueConverter.cs b/Kontent.Ai.Delivery/ContentItems/AssetElementValueConverter.cs

Original file line number	Diff line number	Diff line change
`@@ -24,10 +24,11 @@ public static void Configure(this DeliveryOptions o, DeliveryOptions options)`
`24`	`24`	`o.DefaultRetryPolicyOptions = options.DefaultRetryPolicyOptions;`
`25`	`25`	`o.IncludeTotalCount = options.IncludeTotalCount;`
`26`	`26`	`// See #312`
`27`		`- #pragma warning disable CS0618`
	`27`	`+#pragma warning disable CS0618`
`28`	`28`	`o.Name = options.Name;`
`29`		`- #pragma warning restore CS0618`
	`29`	`+#pragma warning restore CS0618`
`30`	`30`	`o.DefaultRenditionPreset = options.DefaultRenditionPreset;`
	`31`	`+ o.AssetUrlReplacement = options.AssetUrlReplacement;`
`31`	`32`	`}`
`32`	`33`	`}`
`33`	`34`	`}`