77178: Support embed sizes and use them in the ComCol tree

src/app/community-list-page/community-list-service.ts

@@ -19,6 +19,7 @@ import { CommunityListState } from './community-list.reducer';
 import { getCommunityPageRoute } from '../+community-page/community-page-routing-paths';
 import { getCollectionPageRoute } from '../+collection-page/collection-page-routing-paths';
 import { getFirstSucceededRemoteData, getFirstCompletedRemoteData } from '../core/shared/operators';
+import { followLink } from '../shared/utils/follow-link-config.model';
 
 /**
  * Each node in the tree is represented by a flatNode which contains info about the node itself and its position and
@@ -115,6 +116,10 @@ export class CommunityListService {
               private store: Store<any>) {
   }
 
+  private configOnePage: FindListOptions = Object.assign(new FindListOptions(), {
+    elementsPerPage: 1
+  });
+
   saveCommunityListStateToStore(expandedNodes: FlatNode[], loadingNode: FlatNode): void {
     this.store.dispatch(new CommunityListSaveAction(expandedNodes, loadingNode));
   }
@@ -168,7 +173,10 @@ export class CommunityListService {
           field: options.sort.field,
           direction: options.sort.direction
         }
-    }).pipe(
+      },
+      followLink('subcommunities', this.configOnePage, true, true),
+      followLink('collections', this.configOnePage, true, true))
+      .pipe(
         getFirstSucceededRemoteData(),
         map((results) => results.payload),
       );
@@ -233,7 +241,9 @@ export class CommunityListService {
         const nextSetOfSubcommunitiesPage = this.communityDataService.findByParent(community.uuid, {
             elementsPerPage: MAX_COMCOLS_PER_PAGE,
             currentPage: i
-        })
+          },
+          followLink('subcommunities', this.configOnePage, true, true),
+          followLink('collections', this.configOnePage, true, true))
           .pipe(
             getFirstCompletedRemoteData(),
             switchMap((rd: RemoteData<PaginatedList<Community>>) => {
@@ -289,7 +299,7 @@ export class CommunityListService {
   public getIsExpandable(community: Community): Observable<boolean> {
     let hasSubcoms$: Observable<boolean>;
     let hasColls$: Observable<boolean>;
-    hasSubcoms$ = this.communityDataService.findByParent(community.uuid, { elementsPerPage: 1 })
+    hasSubcoms$ = this.communityDataService.findByParent(community.uuid, this.configOnePage)
       .pipe(
         map((rd: RemoteData<PaginatedList<Community>>) => {
           if (hasValue(rd) && hasValue(rd.payload)) {
@@ -300,7 +310,7 @@ export class CommunityListService {
         }),
       );
 
-    hasColls$ = this.collectionDataService.findByParent(community.uuid, { elementsPerPage: 1 })
+    hasColls$ = this.collectionDataService.findByParent(community.uuid, this.configOnePage)
       .pipe(
         map((rd: RemoteData<PaginatedList<Collection>>) => {
           if (hasValue(rd) && hasValue(rd.payload)) {

src/app/core/data/comcol-data.service.ts

@@ -18,6 +18,7 @@ import { BitstreamDataService } from './bitstream-data.service';
 import { NoContent } from '../shared/NoContent.model';
 import { createFailedRemoteDataObject$ } from '../../shared/remote-data.utils';
 import { URLCombiner } from '../url-combiner/url-combiner';
+import { FollowLinkConfig } from '../../shared/utils/follow-link-config.model';
 
 export abstract class ComColDataService<T extends Community | Collection> extends DataService<T> {
   protected abstract cds: CommunityDataService;
@@ -66,11 +67,11 @@ export abstract class ComColDataService<T extends Community | Collection> extend
 
   protected abstract getFindByParentHref(parentUUID: string): Observable<string>;
 
-  public findByParent(parentUUID: string, options: FindListOptions = {}): Observable<RemoteData<PaginatedList<T>>> {
+  public findByParent(parentUUID: string, options: FindListOptions = {}, ...linksToFollow: FollowLinkConfig<T>[]): Observable<RemoteData<PaginatedList<T>>> {
     const href$ = this.getFindByParentHref(parentUUID).pipe(
       map((href: string) => this.buildHrefFromFindOptions(href, options))
     );
-    return this.findAllByHref(href$);
+    return this.findAllByHref(href$, options, true, true, ...linksToFollow);
   }
 
   /**

src/app/core/data/community-data.service.ts

@@ -19,6 +19,7 @@ import { RemoteData } from './remote-data';
 import { FindListOptions } from './request.models';
 import { RequestService } from './request.service';
 import { BitstreamDataService } from './bitstream-data.service';
+import { FollowLinkConfig } from '../../shared/utils/follow-link-config.model';
 
 @Injectable()
 @dataService(COMMUNITY)
@@ -45,9 +46,9 @@ export class CommunityDataService extends ComColDataService<Community> {
     return this.halService.getEndpoint(this.linkPath);
   }
 
-  findTop(options: FindListOptions = {}): Observable<RemoteData<PaginatedList<Community>>> {
+  findTop(options: FindListOptions = {}, ...linksToFollow: FollowLinkConfig<Community>[]): Observable<RemoteData<PaginatedList<Community>>> {
     const hrefObs = this.getFindAllHref(options, this.topLinkPath);
-    return this.findAllByHref(hrefObs, undefined);
+    return this.findAllByHref(hrefObs, undefined, true, true, ...linksToFollow);
   }
 
   protected getFindByParentHref(parentUUID: string): Observable<string> {

src/app/core/data/data.service.spec.ts

@@ -193,6 +193,16 @@ describe('DataService', () => {
       });
     });
 
+    it('should include single linksToFollow as embed and its size', () => {
+      const expected = `${endpoint}?embed.size=bundles=5&embed=bundles`;
+      const config: FindListOptions = Object.assign(new FindListOptions(), {
+        elementsPerPage: 5
+      });
+      (service as any).getFindAllHref({}, null, followLink('bundles', config,  true, true, true)).subscribe((value) => {
+        expect(value).toBe(expected);
+      });
+    });
+
     it('should include multiple linksToFollow as embed', () => {
       const expected = `${endpoint}?embed=bundles&embed=owningCollection&embed=templateItemOf`;
 
@@ -201,6 +211,18 @@ describe('DataService', () => {
       });
     });
 
+    it('should include multiple linksToFollow as embed and its sizes if given', () => {
+      const expected = `${endpoint}?embed=bundles&embed.size=owningCollection=2&embed=owningCollection&embed=templateItemOf`;
+
+      const config: FindListOptions = Object.assign(new FindListOptions(), {
+        elementsPerPage: 2
+      });
+
+      (service as any).getFindAllHref({}, null, followLink('bundles'), followLink('owningCollection', config, true, true, true), followLink('templateItemOf')).subscribe((value) => {
+        expect(value).toBe(expected);
+      });
+    });
+
     it('should not include linksToFollow with shouldEmbed = false', () => {
       const expected = `${endpoint}?embed=templateItemOf`;
 
@@ -216,6 +238,16 @@ describe('DataService', () => {
         expect(value).toBe(expected);
       });
     });
+
+    it('should include nested linksToFollow 2lvl and nested embed\'s size', () => {
+      const expected = `${endpoint}?embed.size=owningCollection/itemtemplate=4&embed=owningCollection/itemtemplate`;
+      const config: FindListOptions = Object.assign(new FindListOptions(), {
+        elementsPerPage: 4
+      });
+      (service as any).getFindAllHref({}, null, followLink('owningCollection', undefined, true, true, true, followLink('itemtemplate', config, true, true, true))).subscribe((value) => {
+        expect(value).toBe(expected);
+      });
+    });
   });
 
   describe('getIDHref', () => {

src/app/core/data/data.service.ts

@@ -215,10 +215,19 @@ export abstract class DataService<T extends CacheableObject> implements UpdateDa
    */
   protected addEmbedParams(href: string, args: string[], ...linksToFollow: FollowLinkConfig<T>[]) {
     linksToFollow.forEach((linkToFollow: FollowLinkConfig<T>) => {
-      if (linkToFollow !== undefined && linkToFollow.shouldEmbed) {
+      if (hasValue(linkToFollow) && linkToFollow.shouldEmbed) {
         const embedString = 'embed=' + String(linkToFollow.name);
-        const embedWithNestedString = this.addNestedEmbeds(embedString, ...linkToFollow.linksToFollow);
+        // Add the embeds size if given in the FollowLinkConfig.FindListOptions
-        args = this.addHrefArg(href, args, embedWithNestedString);
+        if (hasValue(linkToFollow.findListOptions) && hasValue(linkToFollow.findListOptions.elementsPerPage)) {
+          args = this.addHrefArg(href, args,
+            'embed.size=' + String(linkToFollow.name) + '=' + linkToFollow.findListOptions.elementsPerPage);
+        }
+        // Adds the nested embeds and their size if given
+        if (isNotEmpty(linkToFollow.linksToFollow)) {
+          args = this.addNestedEmbeds(embedString, href, args, ...linkToFollow.linksToFollow);
+        } else {
+          args = this.addHrefArg(href, args, embedString);
+        }
       }
     });
     return args;
@@ -243,21 +252,30 @@ export abstract class DataService<T extends CacheableObject> implements UpdateDa
   }
 
   /**
-   * Add the nested followLinks to the embed param, recursively, separated by a /
+   * Add the nested followLinks to the embed param, separated by a /, and their sizes, recursively
    * @param embedString     embedString so far (recursive)
+   * @param href            The href the params are to be added to
+   * @param args            params for the query string
    * @param linksToFollow   links we want to embed in query string if shouldEmbed is true
    */
-  protected addNestedEmbeds(embedString: string, ...linksToFollow: FollowLinkConfig<T>[]): string {
+  protected addNestedEmbeds(embedString: string, href: string, args: string[], ...linksToFollow: FollowLinkConfig<T>[]): string[] {
     let nestEmbed = embedString;
     linksToFollow.forEach((linkToFollow: FollowLinkConfig<T>) => {
-      if (linkToFollow !== undefined && linkToFollow.shouldEmbed) {
+      if (hasValue(linkToFollow) && linkToFollow.shouldEmbed) {
         nestEmbed = nestEmbed + '/' + String(linkToFollow.name);
-        if (linkToFollow.linksToFollow !== undefined) {
+        // Add the nested embeds size if given in the FollowLinkConfig.FindListOptions
-          nestEmbed = this.addNestedEmbeds(nestEmbed, ...linkToFollow.linksToFollow);
+        if (hasValue(linkToFollow.findListOptions) && hasValue(linkToFollow.findListOptions.elementsPerPage)) {
+          const nestedEmbedSize = 'embed.size=' + nestEmbed.split('=')[1] + '=' + linkToFollow.findListOptions.elementsPerPage;
+          args = this.addHrefArg(href, args, nestedEmbedSize);
+        }
+        if (hasValue(linkToFollow.linksToFollow) && isNotEmpty(linkToFollow.linksToFollow)) {
+          args = this.addNestedEmbeds(nestEmbed, href, args, ...linkToFollow.linksToFollow);
+        } else {
+          args = this.addHrefArg(href, args, nestEmbed);
         }
       }
     });
-    return nestEmbed;
+    return args;
   }
 
   /**