Adds support for the "folders only" flag on retrieving siblings of a node. (#19861)

AndyButland · Copilot · web-flow · commit 63ed1eec410b · 2025-08-07T12:35:04.000+02:00
* Adds support for the "folders only" flag on retrieving siblings of a node.

* Apply suggestions from code review

Co-authored-by: Copilot &lt;175728472+Copilot@users.noreply.github.com&gt;

* Updated test code.

* Removed double secondary ordering by node Id and ensured we include this clause for all sort orders.

* Ensure that ordering by node Id is always added only once and last, and only if it's not already been included in the order by clause.

---------

Co-authored-by: Copilot &lt;175728472+Copilot@users.noreply.github.com&gt;
diff --git a/src/Umbraco.Cms.Api.Management/Controllers/DataType/Tree/SiblingsDataTypeTreeController.cs b/src/Umbraco.Cms.Api.Management/Controllers/DataType/Tree/SiblingsDataTypeTreeController.cs
@@ -15,6 +15,9 @@ public SiblingsDataTypeTreeController(IEntityService entityService, IDataTypeSer
 
     [HttpGet("siblings")]
     [ProducesResponseType(typeof(SubsetViewModel<DataTypeTreeItemResponseModel>), StatusCodes.Status200OK)]
-    public Task<ActionResult<SubsetViewModel<DataTypeTreeItemResponseModel>>> Siblings(CancellationToken cancellationToken, Guid target, int before, int after)
-        => GetSiblings(target, before, after);
+    public async Task<ActionResult<SubsetViewModel<DataTypeTreeItemResponseModel>>> Siblings(CancellationToken cancellationToken, Guid target, int before, int after, bool foldersOnly = false)
+    {
+        RenderFoldersOnly(foldersOnly);
+        return await GetSiblings(target, before, after);
+    }
 }
diff --git a/src/Umbraco.Cms.Api.Management/Controllers/Document/Tree/SiblingsDocumentTreeController.cs b/src/Umbraco.Cms.Api.Management/Controllers/Document/Tree/SiblingsDocumentTreeController.cs
@@ -36,9 +36,9 @@ public SiblingsDocumentTreeController(
     [HttpGet("siblings")]
     [MapToApiVersion("1.0")]
     [ProducesResponseType(typeof(SubsetViewModel<DocumentTreeItemResponseModel>), StatusCodes.Status200OK)]
-    public Task<ActionResult<SubsetViewModel<DocumentTreeItemResponseModel>>> Siblings(CancellationToken cancellationToken, Guid target, int before, int after, Guid? dataTypeId = null)
+    public async Task<ActionResult<SubsetViewModel<DocumentTreeItemResponseModel>>> Siblings(CancellationToken cancellationToken, Guid target, int before, int after, Guid? dataTypeId = null)
     {
         IgnoreUserStartNodesForDataType(dataTypeId);
-        return GetSiblings(target, before, after);
+        return await GetSiblings(target, before, after);
     }
 }
diff --git a/src/Umbraco.Cms.Api.Management/Controllers/DocumentBlueprint/Tree/SiblingsDocumentBlueprintTreeController.cs b/src/Umbraco.Cms.Api.Management/Controllers/DocumentBlueprint/Tree/SiblingsDocumentBlueprintTreeController.cs
@@ -16,10 +16,14 @@ public SiblingsDocumentBlueprintTreeController(IEntityService entityService, IDo
 
     [HttpGet("siblings")]
     [ProducesResponseType(typeof(SubsetViewModel<DocumentBlueprintTreeItemResponseModel>), StatusCodes.Status200OK)]
-    public Task<ActionResult<SubsetViewModel<DocumentBlueprintTreeItemResponseModel>>> Siblings(
+    public async Task<ActionResult<SubsetViewModel<DocumentBlueprintTreeItemResponseModel>>> Siblings(
         CancellationToken cancellationToken,
         Guid target,
         int before,
-        int after) =>
-        GetSiblings(target, before, after);
+        int after,
+        bool foldersOnly = false)
+    {
+        RenderFoldersOnly(foldersOnly);
+        return await GetSiblings(target, before, after);
+    }
 }
diff --git a/src/Umbraco.Cms.Api.Management/Controllers/DocumentType/Tree/SiblingsDocumentTypeTreeController.cs b/src/Umbraco.Cms.Api.Management/Controllers/DocumentType/Tree/SiblingsDocumentTypeTreeController.cs
@@ -15,10 +15,14 @@ public SiblingsDocumentTypeTreeController(IEntityService entityService, IContent
 
     [HttpGet("siblings")]
     [ProducesResponseType(typeof(SubsetViewModel<DocumentTypeTreeItemResponseModel>), StatusCodes.Status200OK)]
-    public Task<ActionResult<SubsetViewModel<DocumentTypeTreeItemResponseModel>>> Siblings(
+    public async Task<ActionResult<SubsetViewModel<DocumentTypeTreeItemResponseModel>>> Siblings(
         CancellationToken cancellationToken,
         Guid target,
         int before,
-        int after) =>
-        GetSiblings(target, before, after);
+        int after,
+        bool foldersOnly = false)
+    {
+        RenderFoldersOnly(foldersOnly);
+        return await GetSiblings(target, before, after);
+    }
 }
diff --git a/src/Umbraco.Cms.Api.Management/Controllers/Media/Tree/SiblingsMediaTreeController.cs b/src/Umbraco.Cms.Api.Management/Controllers/Media/Tree/SiblingsMediaTreeController.cs
@@ -25,9 +25,9 @@ public SiblingsMediaTreeController(
 
     [HttpGet("siblings")]
     [ProducesResponseType(typeof(SubsetViewModel<MediaTreeItemResponseModel>), StatusCodes.Status200OK)]
-    public Task<ActionResult<SubsetViewModel<MediaTreeItemResponseModel>>> Siblings(CancellationToken cancellationToken, Guid target, int before, int after, Guid? dataTypeId = null)
+    public async Task<ActionResult<SubsetViewModel<MediaTreeItemResponseModel>>> Siblings(CancellationToken cancellationToken, Guid target, int before, int after, Guid? dataTypeId = null)
     {
         IgnoreUserStartNodesForDataType(dataTypeId);
-        return GetSiblings(target, before, after);
+        return await GetSiblings(target, before, after);
     }
 }
diff --git a/src/Umbraco.Cms.Api.Management/Controllers/MediaType/Tree/SiblingsMediaTypeTreeController.cs b/src/Umbraco.Cms.Api.Management/Controllers/MediaType/Tree/SiblingsMediaTypeTreeController.cs
@@ -15,6 +15,14 @@ public SiblingsMediaTypeTreeController(IEntityService entityService, IMediaTypeS
 
     [HttpGet("siblings")]
     [ProducesResponseType(typeof(SubsetViewModel<MediaTypeTreeItemResponseModel>), StatusCodes.Status200OK)]
-    public Task<ActionResult<SubsetViewModel<MediaTypeTreeItemResponseModel>>> Siblings(CancellationToken cancellationToken, Guid target, int before, int after)
-        => GetSiblings(target, before, after);
+    public async Task<ActionResult<SubsetViewModel<MediaTypeTreeItemResponseModel>>> Siblings(
+        CancellationToken cancellationToken,
+        Guid target,
+        int before,
+        int after,
+        bool foldersOnly = false)
+    {
+        RenderFoldersOnly(foldersOnly);
+        return await GetSiblings(target, before, after);
+    }
 }
diff --git a/src/Umbraco.Cms.Api.Management/Controllers/Template/Tree/SiblingsTemplateTreeController.cs b/src/Umbraco.Cms.Api.Management/Controllers/Template/Tree/SiblingsTemplateTreeController.cs
@@ -15,10 +15,10 @@ public SiblingsTemplateTreeController(IEntityService entityService)
 
     [HttpGet("siblings")]
     [ProducesResponseType(typeof(SubsetViewModel<NamedEntityTreeItemResponseModel>), StatusCodes.Status200OK)]
-    public Task<ActionResult<SubsetViewModel<NamedEntityTreeItemResponseModel>>> Siblings(
+    public async Task<ActionResult<SubsetViewModel<NamedEntityTreeItemResponseModel>>> Siblings(
         CancellationToken cancellationToken,
         Guid target,
         int before,
         int after) =>
-        GetSiblings(target, before, after);
+        await GetSiblings(target, before, after);
 }
diff --git a/src/Umbraco.Cms.Api.Management/Controllers/Tree/EntityTreeControllerBase.cs b/src/Umbraco.Cms.Api.Management/Controllers/Tree/EntityTreeControllerBase.cs
@@ -127,7 +127,7 @@ protected virtual IEntitySlim[] GetSiblingEntities(Guid target, int before, int
         EntityService
             .GetSiblings(
                 target,
-                ItemObjectType,
+                [ItemObjectType],
                 before,
                 after,
                 out totalBefore,
diff --git a/src/Umbraco.Cms.Api.Management/Controllers/Tree/FolderTreeControllerBase.cs b/src/Umbraco.Cms.Api.Management/Controllers/Tree/FolderTreeControllerBase.cs
@@ -51,6 +51,24 @@ protected override IEntitySlim[] GetPagedChildEntities(Guid parentKey, int skip,
             take,
             out totalItems);
 
+    protected override IEntitySlim[] GetSiblingEntities(Guid target, int before, int after, out long totalBefore, out long totalAfter)
+    {
+        totalBefore = 0;
+        totalAfter = 0;
+
+        UmbracoObjectTypes[] siblingObjectTypes = GetObjectTypes();
+
+        return EntityService.GetSiblings(
+                target,
+                siblingObjectTypes,
+                before,
+                after,
+                out totalBefore,
+                out totalAfter,
+                ordering: ItemOrdering)
+            .ToArray();
+    }
+
     protected override TItem MapTreeItemViewModel(Guid? parentKey, IEntitySlim entity)
     {
         TItem viewModel = base.MapTreeItemViewModel(parentKey, entity);
@@ -93,19 +111,19 @@ private IEntitySlim[] GetEntities(Guid? parentKey, int skip, int take, out long
     {
         totalItems = 0;
 
-        UmbracoObjectTypes[] childObjectTypes = _foldersOnly ? [FolderObjectType] : [FolderObjectType, ItemObjectType];
-
-        IEntitySlim[] itemEntities = EntityService.GetPagedChildren(
-                    parentKey,
-                    [FolderObjectType, ItemObjectType],
-                    childObjectTypes,
-                    skip,
-                    take,
-                    false,
-                    out totalItems,
-                    ordering: ItemOrdering)
-                .ToArray();
-
-        return itemEntities;
+        UmbracoObjectTypes[] childObjectTypes = GetObjectTypes();
+
+        return EntityService.GetPagedChildren(
+                parentKey,
+                [FolderObjectType, ItemObjectType],
+                childObjectTypes,
+                skip,
+                take,
+                false,
+                out totalItems,
+                ordering: ItemOrdering)
+            .ToArray();
     }
+
+    private UmbracoObjectTypes[] GetObjectTypes() => _foldersOnly ? [FolderObjectType] : [FolderObjectType, ItemObjectType];
 }
diff --git a/src/Umbraco.Cms.Api.Management/Services/Entities/UserStartNodeEntitiesService.cs b/src/Umbraco.Cms.Api.Management/Services/Entities/UserStartNodeEntitiesService.cs
@@ -190,7 +190,7 @@ out long totalAfter
         if (userStartNodePaths.Any(path => $"{targetParent?.Path},".StartsWith($"{path},")))
         {
             // The requested parent of the target is one of the user start nodes (or a descendant of one), all siblings are by definition allowed.
-            siblings = _entityService.GetSiblings(targetKey, umbracoObjectType, before, after, out totalBefore, out totalAfter, ordering: ordering).ToArray();
+            siblings = _entityService.GetSiblings(targetKey, [umbracoObjectType], before, after, out totalBefore, out totalAfter, ordering: ordering).ToArray();
             return ChildUserAccessEntities(siblings, userStartNodePaths);
         }
 
@@ -206,7 +206,7 @@ out long totalAfter
 
         // Even though we know the IDs of the allowed sibling entities to fetch, we still use a Query to yield correctly sorted children.
         IQuery<IUmbracoEntity> query = _scopeProvider.CreateQuery<IUmbracoEntity>().Where(x => allowedSiblingIds.Contains(x.Id));
-        siblings = _entityService.GetSiblings(targetKey, umbracoObjectType, before, after, out totalBefore, out totalAfter, query, ordering).ToArray();
+        siblings = _entityService.GetSiblings(targetKey, [umbracoObjectType], before, after, out totalBefore, out totalAfter, query, ordering).ToArray();
         return ChildUserAccessEntities(siblings, userStartNodePaths);
     }
 
diff --git a/src/Umbraco.Core/Persistence/Repositories/IEntityRepository.cs b/src/Umbraco.Core/Persistence/Repositories/IEntityRepository.cs
@@ -22,7 +22,7 @@ public interface IEntityRepository : IRepository
     /// <summary>
     /// Gets sibling entities of a specified target entity, within a given range before and after the target, ordered as specified.
     /// </summary>
-    /// <param name="objectType">The object type key of the entities.</param>
+    /// <param name="objectTypes">The object type keys of the entities.</param>
     /// <param name="targetKey">The key of the target entity whose siblings are to be retrieved.</param>
     /// <param name="before">The number of siblings to retrieve before the target entity.</param>
     /// <param name="after">The number of siblings to retrieve after the target entity.</param>
@@ -32,7 +32,7 @@ public interface IEntityRepository : IRepository
     /// <param name="totalAfter">Outputs the total number of siblings after the target entity.</param>
     /// <returns>Enumerable of sibling entities.</returns>
     IEnumerable<IEntitySlim> GetSiblings(
-        Guid objectType,
+        ISet<Guid> objectTypes,
         Guid targetKey,
         int before,
         int after,
diff --git a/src/Umbraco.Core/Services/EntityService.cs b/src/Umbraco.Core/Services/EntityService.cs
@@ -321,7 +321,7 @@ public IEnumerable<IEntitySlim> GetChildren(Guid? key, UmbracoObjectTypes object
     /// <inheritdoc />
     public IEnumerable<IEntitySlim> GetSiblings(
         Guid key,
-        UmbracoObjectTypes objectType,
+        IEnumerable<UmbracoObjectTypes> objectTypes,
         int before,
         int after,
         out long totalBefore,
@@ -343,8 +343,10 @@ public IEnumerable<IEntitySlim> GetSiblings(
 
         using ICoreScope scope = ScopeProvider.CreateCoreScope();
 
+        var objectTypeGuids = objectTypes.Select(x => x.GetGuid()).ToHashSet();
+
         IEnumerable<IEntitySlim> siblings = _entityRepository.GetSiblings(
-            objectType.GetGuid(),
+            objectTypeGuids,
             key,
             before,
             after,
diff --git a/src/Umbraco.Core/Services/IEntityService.cs b/src/Umbraco.Core/Services/IEntityService.cs
@@ -174,7 +174,7 @@ IEnumerable<IEntitySlim> GetAll<T>(params Guid[] keys)
     /// Gets sibling entities of a specified target entity, within a given range before and after the target, ordered as specified.
     /// </summary>
     /// <param name="key">The key of the target entity whose siblings are to be retrieved.</param>
-    /// <param name="objectType">The object type key of the entities.</param>
+    /// <param name="objectTypes">The object types of the entities.</param>
     /// <param name="before">The number of siblings to retrieve before the target entity. Needs to be greater or equal to 0.</param>
     /// <param name="after">The number of siblings to retrieve after the target entity. Needs to be greater or equal to 0.</param>
     /// <param name="filter">An optional filter to apply to the result set.</param>
@@ -184,7 +184,7 @@ IEnumerable<IEntitySlim> GetAll<T>(params Guid[] keys)
     /// <returns>Enumerable of sibling entities.</returns>
     IEnumerable<IEntitySlim> GetSiblings(
         Guid key,
-        UmbracoObjectTypes objectType,
+        IEnumerable<UmbracoObjectTypes> objectTypes,
         int before,
         int after,
         out long totalBefore,
diff --git a/src/Umbraco.Infrastructure/Persistence/Repositories/Implement/EntityRepository.cs b/src/Umbraco.Infrastructure/Persistence/Repositories/Implement/EntityRepository.cs
diff --git a/tests/Umbraco.Tests.Integration/Umbraco.Infrastructure/Services/EntityServiceTests.cs b/tests/Umbraco.Tests.Integration/Umbraco.Infrastructure/Services/EntityServiceTests.cs
diff --git a/tests/Umbraco.Tests.Integration/appsettings.Tests.json b/tests/Umbraco.Tests.Integration/appsettings.Tests.json
diff --git a/tests/Umbraco.Tests.UnitTests/Umbraco.Core/Services/EntityServiceTests.cs b/tests/Umbraco.Tests.UnitTests/Umbraco.Core/Services/EntityServiceTests.cs

Original file line number	Diff line number	Diff line change
`@@ -36,9 +36,9 @@ public SiblingsDocumentTreeController(`
`36`	`36`	`[HttpGet("siblings")]`
`37`	`37`	`[MapToApiVersion("1.0")]`
`38`	`38`	`[ProducesResponseType(typeof(SubsetViewModel<DocumentTreeItemResponseModel>), StatusCodes.Status200OK)]`
`39`		`- public Task<ActionResult<SubsetViewModel<DocumentTreeItemResponseModel>>> Siblings(CancellationToken cancellationToken, Guid target, int before, int after, Guid? dataTypeId = null)`
	`39`	`+ public async Task<ActionResult<SubsetViewModel<DocumentTreeItemResponseModel>>> Siblings(CancellationToken cancellationToken, Guid target, int before, int after, Guid? dataTypeId = null)`
`40`	`40`	`{`
`41`	`41`	`IgnoreUserStartNodesForDataType(dataTypeId);`
`42`		`- return GetSiblings(target, before, after);`
	`42`	`+ return await GetSiblings(target, before, after);`
`43`	`43`	`}`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,9 +25,9 @@ public SiblingsMediaTreeController(`
`25`	`25`
`26`	`26`	`[HttpGet("siblings")]`
`27`	`27`	`[ProducesResponseType(typeof(SubsetViewModel<MediaTreeItemResponseModel>), StatusCodes.Status200OK)]`
`28`		`- public Task<ActionResult<SubsetViewModel<MediaTreeItemResponseModel>>> Siblings(CancellationToken cancellationToken, Guid target, int before, int after, Guid? dataTypeId = null)`
	`28`	`+ public async Task<ActionResult<SubsetViewModel<MediaTreeItemResponseModel>>> Siblings(CancellationToken cancellationToken, Guid target, int before, int after, Guid? dataTypeId = null)`
`29`	`29`	`{`
`30`	`30`	`IgnoreUserStartNodesForDataType(dataTypeId);`
`31`		`- return GetSiblings(target, before, after);`
	`31`	`+ return await GetSiblings(target, before, after);`
`32`	`32`	`}`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -190,7 +190,7 @@ out long totalAfter`
`190`	`190`	`if (userStartNodePaths.Any(path => $"{targetParent?.Path},".StartsWith($"{path},")))`
`191`	`191`	`{`
`192`	`192`	`// The requested parent of the target is one of the user start nodes (or a descendant of one), all siblings are by definition allowed.`
`193`		`- siblings = _entityService.GetSiblings(targetKey, umbracoObjectType, before, after, out totalBefore, out totalAfter, ordering: ordering).ToArray();`
	`193`	`+ siblings = _entityService.GetSiblings(targetKey, [umbracoObjectType], before, after, out totalBefore, out totalAfter, ordering: ordering).ToArray();`
`194`	`194`	`return ChildUserAccessEntities(siblings, userStartNodePaths);`
`195`	`195`	`}`
`196`	`196`
`@@ -206,7 +206,7 @@ out long totalAfter`
`206`	`206`
`207`	`207`	`// Even though we know the IDs of the allowed sibling entities to fetch, we still use a Query to yield correctly sorted children.`
`208`	`208`	`IQuery<IUmbracoEntity> query = _scopeProvider.CreateQuery<IUmbracoEntity>().Where(x => allowedSiblingIds.Contains(x.Id));`
`209`		`- siblings = _entityService.GetSiblings(targetKey, umbracoObjectType, before, after, out totalBefore, out totalAfter, query, ordering).ToArray();`
	`209`	`+ siblings = _entityService.GetSiblings(targetKey, [umbracoObjectType], before, after, out totalBefore, out totalAfter, query, ordering).ToArray();`
`210`	`210`	`return ChildUserAccessEntities(siblings, userStartNodePaths);`
`211`	`211`	`}`
`212`	`212`