RSDEV-148: performance of API document search (#55)

* rather than filtering all records by permission, which is a performance hit, only filter in the case where the viewable user of the user performing a search is a PI. In this case, the searching user should only see docs shared with the group, as oppose to all of the group member PIs work, which is the case for regular users. Also some code cleanup
* use list of users as sql query input rather than looping through each user and performing a sql query for each when getting all of a users records. apply search terms to records list before determining which records can be viewed by the subject user to increase performance
* replace inefficient check on permissions based on whether owing user is a pi with single check after getting all records using new query which takes a list of user ids. only checks permissions if the owning user is a pi which is the only case where the subject user may not be allowed to view

Author: rs-fraser

src/main/java/com/researchspace/api/v1/controller/DocumentsApiController.java

@@ -144,7 +144,7 @@ public ApiDocumentSearchResult getDocuments(
      * Converting search results to ApiSearchResult
      */
     ApiDocumentSearchResult searchResult = new ApiDocumentSearchResult();
-    List<ApiDocumentInfo> info = new ArrayList<ApiDocumentInfo>();
+    List<ApiDocumentInfo> info = new ArrayList<>();
     convertISearchResults(
         pgCrit,
         srchConfig,

src/main/java/com/researchspace/dao/RecordDao.java

@@ -23,7 +23,6 @@ public interface RecordDao extends GenericDao<Record, Long> {
    *
    * @param parentId - The Id of the record whose child records we need to retrieve.
    * @param pgCrit Pagination Criteria
-   * @param recordTypefilter
    * @return An {@link ISearchResults} object.
    */
   ISearchResults<BaseRecord> getPaginatedChildRecordsOfParentWithFilter(
@@ -35,9 +34,6 @@ ISearchResults<BaseRecord> getPaginatedChildRecordsOfParentWithFilter(
    * Retrieves a list of ids of all the visible, non-deleted, normal (i.e., not templates)
    * structured documents belonging to a parent folder id. The ids are all ordered by creation date
    * ascending, i.e., oldest entries first.
-   *
-   * @param parentId
-   * @return
    */
   List<Long> getNotebookContentsExcludeFolders(Long parentId);
 
@@ -46,7 +42,6 @@ ISearchResults<BaseRecord> getPaginatedChildRecordsOfParentWithFilter(
    *
    * @param users A collection of users to order
    * @param pgCrit PAgination criteria for sorting purposes
-   * @return
    */
   Map<String, DatabaseUsageByUserGroupByResult> getTotalRecordsForUsers(
       Collection<User> users, PaginationCriteria<User> pgCrit);
@@ -60,12 +55,7 @@ Map<String, DatabaseUsageByUserGroupByResult> getTotalRecordsForUsers(
   Map<String, DatabaseUsageByUserGroupByResult> getTotalRecordsForUsers(
       PaginationCriteria<User> pgCrit);
 
-  /**
-   * Gets record in the database related with field
-   *
-   * @param fieldId
-   * @return
-   */
+  /** Gets record in the database related with field */
   BaseRecord getRecordFromFieldId(long fieldId);
 
   Long getCountOfUsersWithRecords();
@@ -91,40 +81,26 @@ Map<String, DatabaseUsageByUserGroupByResult> getTotalRecordsForUsers(
    */
   List<RSpaceDocView> getRecordViewsById(Set<Long> dbids);
 
-  /**
-   * Get records by id, from a list of Ids.
-   *
-   * @param dbids
-   * @return
-   */
+  /** Get records by id, from a list of Ids. */
   List<Record> getRecordsById(List<Long> dbids);
 
   /**
-   * Gets all viewable records belonging to the user. This method does <em>not</em> return items
-   * belonging to other users.
-   *
-   * @param user
-   * @return
+   * Gets all viewable records belonging to the set of users. This method does <em>not</em> return
+   * items belonging to other users.
    */
-  Set<BaseRecord> getViewableRecordsForUser(User user);
+  Set<BaseRecord> getViewableRecordsForUsers(Set<Long> userIds);
 
   /**
-   * Gets all viewable templates belonging to the user. This method does <em>not</em> return items
-   * belonging to other users.
-   *
-   * @param user
-   * @return
+   * Gets all viewable templates belonging to the set of users. This method does <em>not</em> return
+   * items belonging to other users.
    */
-  Set<BaseRecord> getViewableTemplatesForUser(User user);
+  Set<BaseRecord> getViewableTemplatesForUsers(Set<Long> userIds);
 
   /**
-   * Gets all viewable media files belonging to the user. This method does <em>not</em> return items
-   * belonging to other users.
-   *
-   * @param user
-   * @return
+   * Gets all viewable media files belonging to the set of users. This method does <em>not</em>
+   * return items belonging to other users.
    */
-  Set<BaseRecord> getViewableMediaFiles(User user);
+  Set<BaseRecord> getViewableMediaFiles(Set<Long> userIds);
 
   /** Tests if BaseRecord with id is a Record or not */
   boolean isRecord(Long id);
@@ -144,8 +120,6 @@ List<String> getTextDataFromOntologyFilesOwnedByUserIfSharedWithAGroup(
    * If <code>admin</code> is linked to a community, gets all tags in documents created by users of
    * that community. Otherwise, returns an empty set.
    *
-   * @param admin
-   * @param tagSearch
    * @return A list of docTag values (these may contain multiple individual tags)
    */
   List<String> getTagsMetaDataForRecordsVisibleByCommunityAdmin(User admin, String tagSearch);
@@ -155,7 +129,6 @@ List<String> getTextDataFromOntologyFilesOwnedByUserIfSharedWithAGroup(
   /**
    * Gets some metadata of Documents that link to a media file
    *
-   * @param mediaFileId
    * @return a possibly empty but non-null List
    */
   List<RecordInformation> getInfosOfDocumentsLinkedToMediaFile(Long mediaFileId);
@@ -166,43 +139,24 @@ List<String> getTextDataFromOntologyFilesOwnedByUserIfSharedWithAGroup(
    * RSPAC-1735) in the same transaction, whereby hibernate occasionally does not issue an SQL
    * 'delete from RecordToFolder' from old folder <em>In general use RecordManager#move to move
    * items around </em>
-   *
-   * @param toUpdate
-   * @param newFolderId
-   * @return
    */
   int updateRecordToFolder(RecordToFolder toUpdate, Long newFolderId);
 
-  /**
-   * Get the ids of not-deleted notebooks belonging to the user
-   *
-   * @param user
-   * @return
-   */
+  /** Get the ids of not-deleted notebooks belonging to the user */
   List<Long> getAllNotebookIdsOwnedByUser(User user);
 
   /**
    * Gets ids of all not-deleted StructuredDocuments that are in notebooks, where both the documents
    * and notebooks are owned by the user
-   *
-   * @param user
-   * @return
    */
   List<Long> getAllDocumentIdsInNotebooksForUser(User user);
 
-  /**
-   * Gets the ids of all not-deleted Structured Documents owned by the user.
-   *
-   * @param user
-   * @return
-   */
+  /** Gets the ids of all not-deleted Structured Documents owned by the user. */
   List<Long> getAllNonTemplateNonTemporaryStrucDocIdsOwnedByUser(User user);
 
   /**
    * Gets not-deleted document count for a user, based on filter.
    *
-   * @param recordTypes
-   * @param user
    * @return the number of documents owned by the user, of the specified types
    */
   Long getRecordCountForUser(RecordTypeFilter recordTypes, User user);