Merge pull request #2969 from Alfresco/feature/MNT-24637_IncludeAspectNames

MNT-24637 Add include=aspectNames to favourites API.
2025-07-24 17:32:48 +00:00 · 2024-10-04 18:59:35 +01:00
parent 1350e68c29 093b3281fb
commit fb3c57aab4
7 changed files with 983 additions and 761 deletions
--- a/packaging/tests/tas-restapi/src/main/java/org/alfresco/rest/model/RestPersonFavoritesModel.java
+++ b/packaging/tests/tas-restapi/src/main/java/org/alfresco/rest/model/RestPersonFavoritesModel.java
@@ -45,13 +45,13 @@ public class RestPersonFavoritesModel extends TestModel implements IRestModel<Re

    private String targetGuid;
    private String createdAt;
+    private List<String> aspectNames;
    private List<String> allowableOperations;

    private RestTargetModel target;

    public RestPersonFavoritesModel()
-    {
-    }
+    {}

    public RestPersonFavoritesModel(String targetGuid, String createdAt)
    {
@@ -90,11 +90,23 @@ public class RestPersonFavoritesModel extends TestModel implements IRestModel<Re
        this.createdAt = createdAt;
    }

-    public List<String> getAllowableOperations() {
+    public List<String> getAspectNames()
+    {
+        return aspectNames;
+    }
+
+    public void setAspectNames(List<String> aspectNames)
+    {
+        this.aspectNames = aspectNames;
+    }
+
+    public List<String> getAllowableOperations()
+    {
        return allowableOperations;
    }

-    public void setAllowableOperations(List<String> allowableOperations) {
+    public void setAllowableOperations(List<String> allowableOperations)
+    {
        this.allowableOperations = allowableOperations;
    }
 }
--- a/packaging/tests/tas-restapi/src/test/java/org/alfresco/rest/favorites/GetFavoritesTests.java
+++ b/packaging/tests/tas-restapi/src/test/java/org/alfresco/rest/favorites/GetFavoritesTests.java
@@ -2,6 +2,11 @@ package org.alfresco.rest.favorites;

 import java.util.List;

+import org.hamcrest.Matchers;
+import org.springframework.http.HttpStatus;
+import org.testng.annotations.BeforeClass;
+import org.testng.annotations.Test;
+
 import org.alfresco.dataprep.CMISUtil.DocumentType;
 import org.alfresco.rest.RestTest;
 import org.alfresco.rest.model.RestErrorModel;
@@ -20,14 +25,11 @@ import org.alfresco.utility.model.TestGroup;
 import org.alfresco.utility.model.UserModel;
 import org.alfresco.utility.testrail.ExecutionType;
 import org.alfresco.utility.testrail.annotation.TestRail;
-import org.hamcrest.Matchers;
-import org.springframework.http.HttpStatus;
-import org.testng.annotations.BeforeClass;
-import org.testng.annotations.Test;

 public class GetFavoritesTests extends RestTest
 {
    private static final String ALLOWABLE_OPERATIONS = "allowableOperations";
+    private static final String ASPECT_NAMES = "aspectNames";
    private UserModel adminUserModel, userModel;
    private SiteModel firstSiteModel;
    private SiteModel secondSiteModel;
@@ -564,8 +566,7 @@ public class GetFavoritesTests extends RestTest
            description = "Verify if get favorites response returns allowableOperations object when requested")
    public void checkResponsesForGetFavoritesWithAllowableOperations()
    {
-        final RestPersonFavoritesModelsCollection adminFavorites =
-                restClient.authenticateUser(adminUserModel).withCoreAPI().usingAuthUser().include(ALLOWABLE_OPERATIONS).getFavorites();
+        final RestPersonFavoritesModelsCollection adminFavorites = restClient.authenticateUser(adminUserModel).withCoreAPI().usingAuthUser().include(ALLOWABLE_OPERATIONS).getFavorites();
        restClient.assertStatusCodeIs(HttpStatus.OK);

        adminFavorites.getEntries().stream()
@@ -576,18 +577,30 @@ public class GetFavoritesTests extends RestTest
    @TestRail(section = {TestGroup.REST_API, TestGroup.FAVORITES}, executionType = ExecutionType.REGRESSION,
            description = "Verify the get favorites request with properties parameter applied")
    @Test(groups = {TestGroup.REST_API, TestGroup.FAVORITES, TestGroup.REGRESSION})
-    public void checkSearchResponseContainsIsFavoriteWhenRequested() throws InterruptedException {
+    public void checkSearchResponseContainsIsFavoriteWhenRequested() throws InterruptedException
+    {
        final SearchRequest query = new SearchRequest();
        final RestRequestQueryModel queryReq = new RestRequestQueryModel();
        queryReq.setQuery(firstFileModel.getName());
        query.setQuery(queryReq);
        query.setInclude(List.of("isFavorite"));

-        Utility.sleep(500, 60000, () ->
-                {
+        Utility.sleep(500, 60000, () -> {
            restClient.authenticateUser(adminUserModel).withSearchAPI().search(query);
            restClient.onResponse().assertThat().body("list.entries.entry[0].isFavorite", Matchers.notNullValue());
+        });
    }
-        );
+
+    @Test(groups = {TestGroup.REST_API, TestGroup.FAVORITES, TestGroup.REGRESSION})
+    @TestRail(section = {TestGroup.REST_API, TestGroup.FAVORITES}, executionType = ExecutionType.REGRESSION,
+            description = "Verify if get favorites response returns aspectNames when requested")
+    public void checkResponsesForGetFavoritesWithAspectNames()
+    {
+        final RestPersonFavoritesModelsCollection adminFavorites = restClient.authenticateUser(adminUserModel).withCoreAPI().usingAuthUser().include(ASPECT_NAMES).getFavorites();
+        restClient.assertStatusCodeIs(HttpStatus.OK);
+
+        adminFavorites.getEntries().stream()
+                .map(RestPersonFavoritesModel::onModel)
+                .forEach(m -> m.assertThat().field(ASPECT_NAMES).isNotEmpty());
    }
 }
--- a/remote-api/src/main/java/org/alfresco/rest/api/impl/FavouritesImpl.java
+++ b/remote-api/src/main/java/org/alfresco/rest/api/impl/FavouritesImpl.java
@@ -26,6 +26,7 @@
 package org.alfresco.rest.api.impl;

 import static org.alfresco.rest.api.Nodes.PARAM_INCLUDE_ALLOWABLEOPERATIONS;
+import static org.alfresco.rest.api.Nodes.PARAM_INCLUDE_ASPECTNAMES;

 import java.util.AbstractList;
 import java.util.ArrayList;
@@ -38,6 +39,8 @@ import java.util.Map;
 import java.util.Set;
 import java.util.stream.Collectors;

+import org.apache.commons.collections.CollectionUtils;
+
 import org.alfresco.error.AlfrescoRuntimeException;
 import org.alfresco.model.ContentModel;
 import org.alfresco.query.PagingResults;
@@ -77,9 +80,6 @@ import org.alfresco.service.cmr.site.SiteService;
 import org.alfresco.service.namespace.NamespaceService;
 import org.alfresco.service.namespace.QName;
 import org.alfresco.util.Pair;
-import org.apache.commons.collections.CollectionUtils;
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;

 /**
 * Public REST API: Centralises access to favourites functionality and maps between representations repository and api representations.
@@ -89,9 +89,7 @@ import org.apache.commons.logging.LogFactory;
 */
 public class FavouritesImpl implements Favourites
 {
-    private static final Log logger = LogFactory.getLog(FavouritesImpl.class);
-
-    private static final List<String> ALLOWED_INCLUDES = List.of(PARAM_INCLUDE_PROPERTIES, PARAM_INCLUDE_ALLOWABLEOPERATIONS);
+    private static final List<String> ALLOWED_INCLUDES = List.of(PARAM_INCLUDE_PROPERTIES, PARAM_INCLUDE_ASPECTNAMES, PARAM_INCLUDE_ALLOWABLEOPERATIONS);

    private People people;
    private Sites sites;
@@ -105,8 +103,7 @@ public class FavouritesImpl implements Favourites
            ContentModel.PROP_TITLE,
            ContentModel.PROP_DESCRIPTION,
            SiteModel.PROP_SITE_VISIBILITY,
-            SiteModel.PROP_SITE_PRESET
-            );
+            SiteModel.PROP_SITE_PRESET);

    public void setPeople(People people)
    {
@@ -140,7 +137,7 @@ public class FavouritesImpl implements Favourites

    private Target getTarget(PersonFavourite personFavourite, Parameters parameters)
    {
-		Target target = null;
+        Target target;
        NodeRef nodeRef = personFavourite.getNodeRef();
        Type type = personFavourite.getType();
        if (type.equals(Type.FILE))
@@ -182,15 +179,19 @@ public class FavouritesImpl implements Favourites
        final List<String> paramsInclude = parameters.getInclude();
        if (!Collections.disjoint(paramsInclude, ALLOWED_INCLUDES))
        {
-            final List<String> includes = ALLOWED_INCLUDES.stream().filter(a -> paramsInclude.contains(a)).collect(Collectors.toList());
+            final List<String> includes = ALLOWED_INCLUDES.stream().filter(paramsInclude::contains).collect(Collectors.toList());
            // get node representation with only properties included
            Node node = nodes.getFolderOrDocument(personFavourite.getNodeRef(), null, null, includes, null);
            // Create a map from node properties excluding properties already in this Favorite
            Map<String, Object> filteredNodeProperties = filterProps(node.getProperties(), EXCLUDED_PROPS);
-            if(filteredNodeProperties.size() > 0 && paramsInclude.contains(PARAM_INCLUDE_PROPERTIES))
+            if (!filteredNodeProperties.isEmpty() && paramsInclude.contains(PARAM_INCLUDE_PROPERTIES))
            {
                fav.setProperties(filteredNodeProperties);
            }
+            if (paramsInclude.contains(PARAM_INCLUDE_ASPECTNAMES))
+            {
+                fav.setAspectNames(node.getAspectNames());
+            }
            final List<String> allowableOperations = node.getAllowableOperations();
            if (CollectionUtils.isNotEmpty(allowableOperations) && paramsInclude.contains(PARAM_INCLUDE_ALLOWABLEOPERATIONS))
            {
@@ -212,8 +213,7 @@ public class FavouritesImpl implements Favourites
    private CollectionWithPagingInfo<Favourite> wrap(Paging paging, PagingResults<PersonFavourite> personFavourites, Parameters parameters)
    {
        final List<PersonFavourite> page = personFavourites.getPage();
-    	final List<Favourite> list = new AbstractList<Favourite>()
-		{
+        final List<Favourite> list = new AbstractList<>() {
            @Override
            public Favourite get(int index)
            {
@@ -367,24 +367,25 @@ public class FavouritesImpl implements Favourites

        List<Pair<FavouritesService.SortFields, Boolean>> sortProps = getSortProps(parameters);

-    	final Set<Type> filteredByClientQuery = new HashSet<Type>();
+        final Set<Type> filteredByClientQuery = new HashSet<>();
        Set<Type> filterTypes = FavouritesService.Type.ALL_FILTER_TYPES; // Default all

        // filterType is of the form 'target.<site|file|folder>'
-    	QueryHelper.walk(parameters.getQuery(), new WalkerCallbackAdapter()
-        {
+        QueryHelper.walk(parameters.getQuery(), new WalkerCallbackAdapter() {
            @Override
-			public void or() {
+            public void or()
+            {
                // OR is supported but exists() will be called for each EXISTS so we don't
                // need to do anything here. If we don't override it then it will be assumed
                // that OR in the grammar is not supported.
            }

            @Override
-			public void exists(String filteredByClient, boolean negated) {
+            public void exists(String filteredByClient, boolean negated)
+            {
                if (filteredByClient != null)
                {
-                    int idx = filteredByClient.lastIndexOf("/");
+                    int idx = filteredByClient.lastIndexOf('/');
                    if (idx == -1 || idx == filteredByClient.length())
                    {
                        throw new InvalidArgumentException();
@@ -399,7 +400,7 @@ public class FavouritesImpl implements Favourites
            }
        });

-    	if (filteredByClientQuery.size() > 0)
+        if (!filteredByClientQuery.isEmpty())
        {
            filterTypes = filteredByClientQuery;
        }
@@ -419,8 +420,7 @@ public class FavouritesImpl implements Favourites
    }

    /**
-     * Returns a {@code {@link Parameters} object where almost all of its values are null.
-     * the non-null value is the {@literal include} and whatever value is passed for {@code personId} and {@code favouriteId}
+     * Returns a {@code {@link Parameters} object where almost all of its values are null. the non-null value is the {@literal include} and whatever value is passed for {@code personId} and {@code favouriteId}
     */
    private Parameters getDefaultParameters(String personId, String favouriteId)
    {
@@ -434,7 +434,7 @@ public class FavouritesImpl implements Favourites
    {
        List<Pair<FavouritesService.SortFields, Boolean>> sortProps = new ArrayList<>();
        List<SortColumn> sortCols = parameters.getSorting();
-        if ((sortCols != null) && (sortCols.size() > 0))
+        if (sortCols != null && !sortCols.isEmpty())
        {
            for (SortColumn sortCol : sortCols)
            {
@@ -447,7 +447,7 @@ public class FavouritesImpl implements Favourites
                {
                    throw new InvalidArgumentException("Invalid sort field: " + sortCol.column);
                }
-                sortProps.add(new Pair<>(sortField, (sortCol.asc ? Boolean.TRUE : Boolean.FALSE)));
+                sortProps.add(new Pair<>(sortField, sortCol.asc ? Boolean.TRUE : Boolean.FALSE));
            }
        }
        else
--- a/remote-api/src/main/java/org/alfresco/rest/api/model/DocumentTarget.java
+++ b/remote-api/src/main/java/org/alfresco/rest/api/model/DocumentTarget.java
@@ -25,6 +25,8 @@
 */
 package org.alfresco.rest.api.model;

+import java.util.Objects;
+
 /**
 * A document target favourite.
 * 
@@ -62,4 +64,24 @@ public class DocumentTarget extends Target
        return "DocumentTarget [file=" + file + "]";
    }

+    @Override
+    public boolean equals(Object o)
+    {
+        if (this == o)
+        {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass())
+        {
+            return false;
+        }
+        DocumentTarget that = (DocumentTarget) o;
+        return Objects.equals(file, that.file);
+    }
+
+    @Override
+    public int hashCode()
+    {
+        return Objects.hashCode(file);
+    }
 }
--- a/remote-api/src/main/java/org/alfresco/rest/api/model/Favourite.java
+++ b/remote-api/src/main/java/org/alfresco/rest/api/model/Favourite.java
@@ -28,6 +28,7 @@ package org.alfresco.rest.api.model;
 import java.util.Date;
 import java.util.List;
 import java.util.Map;
+import java.util.Objects;

 import org.alfresco.rest.framework.resource.UniqueId;

@@ -43,6 +44,7 @@ public class Favourite
    private Date createdAt;
    private Target target;
    private Map<String, Object> properties;
+    private List<String> aspectNames;
    private List<String> allowableOperations;

    public Date getCreatedAt()
@@ -86,18 +88,57 @@ public class Favourite
        this.properties = properties;
    }

-	public List<String> getAllowableOperations() {
+    public List<String> getAspectNames()
+    {
+        return aspectNames;
+    }
+
+    public void setAspectNames(List<String> aspectNames)
+    {
+        this.aspectNames = aspectNames;
+    }
+
+    public List<String> getAllowableOperations()
+    {
        return allowableOperations;
    }

-	public void setAllowableOperations(List<String> allowableOperations) {
+    public void setAllowableOperations(List<String> allowableOperations)
+    {
        this.allowableOperations = allowableOperations;
    }

    @Override
    public String toString()
    {
-		return "Favourite [targetGuid=" + targetGuid
-				+ ", createdAt=" + createdAt + ", target=" + target + ", properties=" + properties + "]";
+        return "Favourite{" +
+                "targetGuid='" + targetGuid + '\'' +
+                ", createdAt=" + createdAt +
+                ", target=" + target +
+                ", properties=" + properties +
+                ", aspectNames=" + aspectNames +
+                ", allowableOperations=" + allowableOperations +
+                '}';
+    }
+
+    @Override
+    public boolean equals(Object o)
+    {
+        if (this == o)
+        {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass())
+        {
+            return false;
+        }
+        Favourite favourite = (Favourite) o;
+        return Objects.equals(targetGuid, favourite.targetGuid) && Objects.equals(createdAt, favourite.createdAt) && Objects.equals(target, favourite.target) && Objects.equals(properties, favourite.properties) && Objects.equals(aspectNames, favourite.aspectNames) && Objects.equals(allowableOperations, favourite.allowableOperations);
+    }
+
+    @Override
+    public int hashCode()
+    {
+        return Objects.hash(targetGuid, createdAt, target, properties, aspectNames, allowableOperations);
    }
 }
--- a/remote-api/src/test/java/org/alfresco/AppContext04TestSuite.java
+++ b/remote-api/src/test/java/org/alfresco/AppContext04TestSuite.java
@@ -25,18 +25,17 @@
 */
 package org.alfresco;

-import org.alfresco.repo.web.scripts.TestWebScriptRepoServer;
-import org.alfresco.util.testing.category.DBTests;
-import org.alfresco.util.testing.category.NonBuildTests;
 import org.junit.experimental.categories.Categories;
 import org.junit.runner.RunWith;
 import org.junit.runners.Suite;

+import org.alfresco.repo.web.scripts.TestWebScriptRepoServer;
+import org.alfresco.util.testing.category.DBTests;
+import org.alfresco.util.testing.category.NonBuildTests;
+
@RunWith(Categories.class)
@Categories.ExcludeCategory({DBTests.class, NonBuildTests.class})
@Suite.SuiteClasses({
-    // [classpath:alfresco/application-context.xml, classpath:alfresco/web-scripts-application-context-test.xml,
-    // classpath:alfresco/web-scripts-application-context.xml]
        org.alfresco.repo.web.scripts.quickshare.QuickShareRestApiTest.class,
        org.alfresco.repo.web.scripts.admin.AdminWebScriptTest.class,
        org.alfresco.repo.web.scripts.audit.AuditWebScriptTest.class,
@@ -77,6 +76,7 @@ import org.junit.runners.Suite;
        org.alfresco.repo.web.scripts.node.NodeWebScripTest.class,
        org.alfresco.rest.api.impl.CommentsImplUnitTest.class,
        org.alfresco.rest.api.impl.DownloadsImplCheckArchiveStatusUnitTest.class,
+        org.alfresco.rest.api.impl.FavouritesImplUnitTest.class,
        org.alfresco.rest.api.impl.RestApiDirectUrlConfigUnitTest.class
 })
 public class AppContext04TestSuite
--- a/remote-api/src/test/java/org/alfresco/rest/api/impl/FavouritesImplUnitTest.java
+++ b/remote-api/src/test/java/org/alfresco/rest/api/impl/FavouritesImplUnitTest.java
@@ -0,0 +1,134 @@
+/*
+ * #%L
+ * Alfresco Remote API
+ * %%
+ * Copyright (C) 2005 - 2020 Alfresco Software Limited
+ * %%
+ * This file is part of the Alfresco software.
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail.  Otherwise, the software is
+ * provided under the following open source license terms:
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ * #L%
+ */
+package org.alfresco.rest.api.impl;
+
+import static java.util.Collections.singleton;
+
+import static org.junit.Assert.assertEquals;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+import static org.mockito.MockitoAnnotations.openMocks;
+
+import static org.alfresco.model.ContentModel.TYPE_CONTENT;
+import static org.alfresco.service.cmr.favourites.FavouritesService.Type.FILE;
+
+import java.util.List;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+
+import org.alfresco.repo.favourites.PersonFavourite;
+import org.alfresco.rest.api.Nodes;
+import org.alfresco.rest.api.People;
+import org.alfresco.rest.api.model.Document;
+import org.alfresco.rest.api.model.DocumentTarget;
+import org.alfresco.rest.api.model.Favourite;
+import org.alfresco.rest.framework.resource.parameters.Parameters;
+import org.alfresco.service.cmr.favourites.FavouritesService;
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.service.namespace.NamespaceService;
+
+/**
+ * Unit tests for {@link FavouritesImpl} class.
+ */
+public class FavouritesImplUnitTest
+{
+    static final String NODE_ID = "12345678";
+    static final NodeRef NODE_REF = new NodeRef("favourite://node/" + NODE_ID);
+    static final String PERSON_ID = "personId";
+    static final String ASPECT_NAME = "some:aspect";
+
+    @InjectMocks
+    FavouritesImpl favouritesImpl;
+    @Mock
+    People people;
+    @Mock
+    Nodes nodes;
+    @Mock
+    FavouritesService favouritesService;
+    @Mock
+    NamespaceService namespaceService;
+    @Mock
+    Favourite favourite;
+    @Mock
+    Document document;
+    @Mock
+    PersonFavourite personFavourite;
+
+    @Before
+    public void setUp()
+    {
+        openMocks(this);
+
+        when(nodes.getDocument(NODE_REF)).thenReturn(document);
+        when(nodes.nodeMatches(NODE_REF, singleton(TYPE_CONTENT), null)).thenReturn(true);
+        when(document.getGuid()).thenReturn(NODE_REF);
+        when(people.validatePerson(PERSON_ID, true)).thenReturn(PERSON_ID);
+        when(personFavourite.getNodeRef()).thenReturn(NODE_REF);
+        when(personFavourite.getType()).thenReturn(FILE);
+        when(favouritesService.addFavourite(PERSON_ID, NODE_REF)).thenReturn(personFavourite);
+        when(namespaceService.getPrefixes(anyString())).thenReturn(List.of("prefix"));
+    }
+
+    @Test
+    public void testAddFavourite()
+    {
+        DocumentTarget documentTarget = new DocumentTarget(document);
+        when(favourite.getTarget()).thenReturn(documentTarget);
+
+        Favourite response = favouritesImpl.addFavourite(PERSON_ID, favourite);
+
+        Favourite expected = new Favourite();
+        expected.setTarget(documentTarget);
+        expected.setTargetGuid(NODE_ID);
+        assertEquals(expected, response);
+    }
+
+    @Test
+    public void testAddFavouriteIncludeAspectNames()
+    {
+        List<String> includes = List.of("aspectNames");
+
+        DocumentTarget documentTarget = new DocumentTarget(document);
+        when(favourite.getTarget()).thenReturn(documentTarget);
+        when(nodes.getFolderOrDocument(NODE_REF, null, null, includes, null)).thenReturn(document);
+        when(document.getAspectNames()).thenReturn(List.of(ASPECT_NAME));
+
+        Parameters parameters = mock(Parameters.class);
+        when(parameters.getInclude()).thenReturn(includes);
+
+        Favourite response = favouritesImpl.addFavourite(PERSON_ID, favourite, parameters);
+
+        Favourite expected = new Favourite();
+        expected.setTarget(documentTarget);
+        expected.setTargetGuid(NODE_ID);
+        expected.setAspectNames(List.of(ASPECT_NAME));
+        assertEquals(expected, response);
+    }
+}