yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add query string info to links in API output (#15327)

Browse Source
This commit is contained in:
Kenn Jacobsen
2023-11-30 10:36:53 +01:00
committed by GitHub
parent 87380902f0
commit 016709eecd
3 changed files with 58 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
src/Umbraco.Core/Models/DeliveryApi/ApiLink.cs
View File

@@ -2,19 +2,32 @@ namespace Umbraco.Cms.Core.Models.DeliveryApi;
public sealed class ApiLink
{
[Obsolete("Please use the overload that accepts a query string. Will be removed in V14.")]
public static ApiLink Content(string title, string? target, Guid destinationId, string destinationType, IApiContentRoute route)
=> new(LinkType.Content, null, title, target, destinationId, destinationType, route);
=> Content(title, queryString: null, target, destinationId, destinationType, route);
public static ApiLink Content(string title, string? queryString, string? target, Guid destinationId, string destinationType, IApiContentRoute route)
=> new(LinkType.Content, url: null, queryString, title, target, destinationId, destinationType, route);
[Obsolete("Please use the overload that accepts a query string. Will be removed in V14.")]
public static ApiLink Media(string title, string url, string? target, Guid destinationId, string destinationType)
=> new(LinkType.Media, url, title, target, destinationId, destinationType, null);
=> Media(title, url, queryString: null, target, destinationId, destinationType);
public static ApiLink Media(string title, string url, string? queryString, string? target, Guid destinationId, string destinationType)
=> new(LinkType.Media, url, queryString, title, target, destinationId, destinationType, route: null);
[Obsolete("Please use the overload that accepts a query string. Will be removed in V14.")]
public static ApiLink External(string? title, string url, string? target)
=> new(LinkType.External, url, title, target, null, null, null);
=> External(title, url, queryString: null, target);
private ApiLink(LinkType linkType, string? url, string? title, string? target, Guid? destinationId, string? destinationType, IApiContentRoute? route)
public static ApiLink External(string? title, string url, string? queryString, string? target)
=> new(LinkType.External, url, queryString, title, target, null, null, null);
private ApiLink(LinkType linkType, string? url, string? queryString, string? title, string? target, Guid? destinationId, string? destinationType, IApiContentRoute? route)
{
LinkType = linkType;
Url = url;
QueryString = queryString;
Title = title;
Target = target;
DestinationId = destinationId;
@@ -24,6 +37,8 @@ public sealed class ApiLink
public string? Url { get; }
public string? QueryString { get; }
public string? Title { get; }
public string? Target { get; }

6
src/Umbraco.Infrastructure/PropertyEditors/ValueConverters/MultiUrlPickerValueConverter.cs
View File

@@ -185,6 +185,7 @@ public class MultiUrlPickerValueConverter : PropertyValueConverterBase, IDeliver
? null
: ApiLink.Content(
item.Name.IfNullOrWhiteSpace(_apiContentNameProvider.GetName(content)),
item.QueryString,
item.Target,
content.Key,
content.ContentType.Alias,
@@ -195,12 +196,13 @@ public class MultiUrlPickerValueConverter : PropertyValueConverterBase, IDeliver
? null
: ApiLink.Media(
item.Name.IfNullOrWhiteSpace(_apiContentNameProvider.GetName(media)),
_apiMediaUrlProvider.GetUrl(media),
$"{_apiMediaUrlProvider.GetUrl(media)}{item.QueryString}",
item.QueryString,
item.Target,
media.Key,
media.ContentType.Alias);
default:
return ApiLink.External(item.Name, $"{item.Url}{item.QueryString}", item.Target);
return ApiLink.External(item.Name, $"{item.Url}{item.QueryString}", item.QueryString, item.Target);
}
}

35
tests/Umbraco.Tests.UnitTests/Umbraco.Core/DeliveryApi/MultiUrlPickerValueConverterTests.cs
View File

@@ -157,11 +157,45 @@ public class MultiUrlPickerValueConverterTests : PropertyValueConverterTests
var link = result.First();
Assert.AreEqual("The link", link.Title);
Assert.AreEqual("https://umbraco.com/?something=true", link.Url);
Assert.AreEqual("?something=true", link.QueryString);
Assert.AreEqual(LinkType.External, link.LinkType);
Assert.AreEqual("_blank", link.Target);
Assert.Null(link.Route);
}
[Test]
public void MultiUrlPickerValueConverter_AppliesExplicitConfigurationToMediaLink()
{
var publishedDataType = new PublishedDataType(123, "test", new Lazy<object>(() => new MultiUrlPickerConfiguration { MaxNumber = 1 }));
var publishedPropertyType = new Mock<IPublishedPropertyType>();
publishedPropertyType.SetupGet(p => p.DataType).Returns(publishedDataType);
var valueConverter = MultiUrlPickerValueConverter();
var inter = Serializer().Serialize(new[]
{
new MultiUrlPickerValueEditor.LinkDto
{
Udi = new GuidUdi(Constants.UdiEntityType.Media, PublishedMedia.Key),
Name = "Custom link name",
QueryString = "?something=true",
Target = "_blank"
}
});
var result = valueConverter.ConvertIntermediateToDeliveryApiObject(Mock.Of<IPublishedElement>(), publishedPropertyType.Object, PropertyCacheLevel.Element, inter, false, false) as IEnumerable<ApiLink>;
Assert.NotNull(result);
Assert.AreEqual(1, result.Count());
var link = result.First();
Assert.AreEqual("Custom link name", link.Title);
Assert.AreEqual(PublishedMedia.Key, link.DestinationId);
Assert.AreEqual("TheMediaType", link.DestinationType);
Assert.AreEqual("the-media-url?something=true", link.Url);
Assert.AreEqual(LinkType.Media, link.LinkType);
Assert.AreEqual("_blank", link.Target);
Assert.AreEqual("?something=true", link.QueryString);
Assert.AreEqual(null, link.Route);
}
[Test]
public void MultiUrlPickerValueConverter_AppliesExplicitConfigurationToContentLink()
{
@@ -190,6 +224,7 @@ public class MultiUrlPickerValueConverterTests : PropertyValueConverterTests
Assert.AreEqual("/the-page-url", link.Route!.Path);
Assert.AreEqual(LinkType.Content, link.LinkType);
Assert.AreEqual("_blank", link.Target);
Assert.AreEqual("?something=true", link.QueryString);
Assert.Null(link.Url);
}