fix: add endpoint for featured collections (#1883)

* fix: add endpoint for featured collections

* fix: add GRAASPER_CREATOR_ID to test env

* fix: apply limit to hitsPerPage param

* fix: make requested changes

* fix: sort featured by name asc

* fix: update expectation for featured collection

* fix: limit changed name:

* fix: tests

Author: spaenleh

.github/workflows/test.yml

@@ -18,6 +18,7 @@ env:
   # random keys
   APPS_JWT_SECRET: 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
   APPS_PUBLISHER_ID: 9c9cea73-f3b7-48a3-aa6e-ead82c0685e7 # mock uuid
+  GRAASPER_CREATOR_ID: bbbf7cac-6139-45e4-8fbf-4cf767b50b29 # mock uuid
   AUTH_TOKEN_JWT_SECRET: 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
   COOKIE_DOMAIN: localhost
   CLIENT_HOST: http://localhost:3114

src/services/item/plugins/publication/published/plugins/search/search.controller.test.ts

@@ -18,7 +18,7 @@ import { db } from '../../../../../../../drizzle/db';
 import { itemsRawTable } from '../../../../../../../drizzle/schema';
 import { type ItemRaw } from '../../../../../../../drizzle/types';
 import { assertIsDefined } from '../../../../../../../utils/assertions';
-import { ITEMS_ROUTE_PREFIX } from '../../../../../../../utils/config';
+import { GRAASPER_CREATOR_ID, ITEMS_ROUTE_PREFIX } from '../../../../../../../utils/config';
 import { MeiliSearchWrapper } from './meilisearch';
 
 jest.mock('./meilisearch');
@@ -498,6 +498,117 @@ describe('Collection Search endpoints', () => {
     });
   });
 
+  describe('GET /collections/featured', () => {
+    it('get featured collections', async () => {
+      // Meilisearch is mocked so format of API doesn't matter, we just want it to proxy MultiSearchParams;
+      const fakeResponse = {
+        results: [
+          {
+            indexUid: 'index',
+            hits: [
+              {
+                name: 'Geogebra',
+                description: 'Interactive tools from geogebra for mathematics.',
+                content: '',
+                creator: {
+                  id: GRAASPER_CREATOR_ID,
+                  name: 'Graasper',
+                },
+                level: [],
+                discipline: [],
+                'resource-type': [],
+                id: v4(),
+                type: 'folder',
+                isPublishedRoot: true,
+                isHidden: false,
+                publicationUpdatedAt: '2021-10-20T13:03:42.712Z',
+                createdAt: '2021-10-20T13:12:47.821Z',
+                updatedAt: '2021-10-23T09:25:39.798Z',
+                lang: 'en',
+                likes: 9,
+                _formatted: {
+                  name: 'Geogebra',
+                  description: 'Interactive tools from geogebra for mathematics.',
+                  content: '',
+                  creator: {
+                    id: GRAASPER_CREATOR_ID,
+                    name: 'Graasper',
+                  },
+                  level: [],
+                  discipline: [],
+                  'resource-type': [],
+                  id: v4(),
+                  type: 'folder',
+                  isPublishedRoot: true,
+                  isHidden: false,
+                  publicationUpdatedAt: '2021-10-20T13:03:42.712Z',
+                  createdAt: '2021-10-20T13:12:47.821Z',
+                  updatedAt: '2021-10-23T09:25:39.798Z',
+                  lang: 'en',
+                  likes: 9,
+                },
+              },
+              {
+                name: 'PhET',
+                content: '',
+                description: '',
+                creator: {
+                  id: GRAASPER_CREATOR_ID,
+                  name: 'Graasper',
+                },
+                level: [],
+                discipline: [],
+                'resource-type': [],
+                id: v4(),
+                type: 'folder',
+                isPublishedRoot: true,
+                isHidden: false,
+                publicationUpdatedAt: '2021-10-20T13:03:42.712Z',
+                createdAt: '2021-10-20T13:03:42.712Z',
+                updatedAt: '2021-11-10T10:49:39.296Z',
+                lang: 'en',
+                likes: 7,
+                _formatted: {
+                  name: 'PhET',
+                  description: '',
+                  content: '',
+                  creator: {
+                    id: GRAASPER_CREATOR_ID,
+                    name: 'Graasper',
+                  },
+                  level: [],
+                  discipline: [],
+                  'resource-type': [],
+                  id: v4(),
+                  type: 'folder',
+                  isPublishedRoot: true,
+                  isHidden: false,
+                  publicationUpdatedAt: '2021-10-20T13:03:42.712Z',
+                  createdAt: '2021-10-20T13:03:42.712Z',
+                  updatedAt: '2021-11-10T10:49:39.296Z',
+                  lang: 'en',
+                  likes: 7,
+                },
+              },
+            ] as never[],
+            processingTimeMs: 123,
+            query: '',
+          },
+        ],
+      };
+      jest.spyOn(MeiliSearchWrapper.prototype, 'search').mockResolvedValue(fakeResponse);
+      const res = await app.inject({
+        method: HttpMethod.Get,
+        url: `${ITEMS_ROUTE_PREFIX}/collections/featured`,
+      });
+      expect(res.statusCode).toBe(StatusCodes.OK);
+      // The creator should be Graasp (GRAASPER_CREATOR_ID)
+      res.json().hits.forEach(({ creator }) => {
+        expect(creator.id).toEqual(GRAASPER_CREATOR_ID);
+      });
+    });
+  });
+
   describe('GET /collections/liked', () => {
     it('get most liked items', async () => {
       // Meilisearch is mocked so format of API doesn't matter, we just want it to proxy MultiSearchParams;

src/services/item/plugins/publication/published/plugins/search/search.controller.ts

@@ -6,10 +6,10 @@ import { ActionTriggers } from '@graasp/sdk';
 
 import { resolveDependency } from '../../../../../../../di/utils';
 import { db } from '../../../../../../../drizzle/db';
-import { MEILISEARCH_REBUILD_SECRET } from '../../../../../../../utils/config';
+import { GRAASPER_CREATOR_ID, MEILISEARCH_REBUILD_SECRET } from '../../../../../../../utils/config';
 import { ActionService } from '../../../../../../action/action.service';
 import { optionalIsAuthenticated } from '../../../../../../auth/plugins/passport';
-import { getFacets, getMostLiked, getMostRecent, search } from './search.schemas';
+import { getFacets, getFeatured, getMostLiked, getMostRecent, search } from './search.schemas';
 import { SearchService } from './search.service';
 
 export type SearchFields = {
@@ -52,6 +52,15 @@ const plugin: FastifyPluginAsyncTypebox = async (fastify) => {
     },
   );
 
+  fastify.get(
+    '/collections/featured',
+    { preHandler: optionalIsAuthenticated, schema: getFeatured },
+    async ({ query }) => {
+      const searchResults = await searchService.getFeatured(GRAASPER_CREATOR_ID, query.limit);
+      return searchResults;
+    },
+  );
+
   fastify.get(
     '/collections/liked',
     { preHandler: optionalIsAuthenticated, schema: getMostLiked },

src/services/item/plugins/publication/published/plugins/search/search.schemas.ts

@@ -8,6 +8,7 @@ import { ItemType, TagCategory } from '@graasp/sdk';
 import { customType, registerSchemaAsRef } from '../../../../../../../plugins/typebox';
 import { errorSchemaRef } from '../../../../../../../schemas/global';
 import {
+  GET_FEATURED_ITEMS_MAXIMUM,
   GET_MOST_LIKED_ITEMS_MAXIMUM,
   GET_MOST_RECENT_ITEMS_MAXIMUM,
 } from '../../../../../../../utils/config';
@@ -98,6 +99,23 @@ export const search = {
   },
 } as const satisfies FastifySchema;
 
+export const getFeatured = {
+  operationId: 'getFeaturedCollections',
+  tags: ['collection'],
+  summary: 'Get featured collections',
+  description: 'Get collections that we want to feature on the library home page.',
+
+  querystring: customType.StrictObject({
+    limit: Type.Optional(
+      Type.Number({ minimum: 1, maximum: GET_FEATURED_ITEMS_MAXIMUM, default: 12 }),
+    ),
+  }),
+  response: {
+    [StatusCodes.OK]: meilisearchSearchResponseSchema,
+    '4xx': errorSchemaRef,
+  },
+} as const satisfies FastifySchema;
+
 export const getMostLiked = {
   operationId: 'getMostLikedCollections',
   tags: ['collection', 'like'],

src/services/item/plugins/publication/published/plugins/search/search.service.test.ts

@@ -1,6 +1,7 @@
 import { v4 } from 'uuid';
 
 import { MOCK_LOGGER } from '../../../../../../../../test/app';
+import { GRAASPER_CREATOR_ID } from '../../../../../../../utils/config';
 import HookManager from '../../../../../../../utils/hook';
 import { ItemService } from '../../../../../item.service';
 import { ItemPublishedService } from '../../itemPublished.service';
@@ -165,6 +166,30 @@ describe('getMostRecent', () => {
   });
 });
 
+describe('getFeatured', () => {
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+  it('apply creator and sort by publication updatedAt', async () => {
+    const MOCK_RESULT = { hits: [] } as never;
+    const spy = jest
+      .spyOn(meilisearchClient, 'search')
+      .mockResolvedValue({ results: [MOCK_RESULT] });
+    const serviceSpy = jest.spyOn(searchService, 'search');
+
+    const results = await searchService.getFeatured(GRAASPER_CREATOR_ID, 4);
+    expect(results).toEqual(MOCK_RESULT);
+
+    // verify the arguments passed to the search function inside the service
+    const { creatorId } = serviceSpy.mock.calls[0][0];
+    expect(creatorId).toEqual(GRAASPER_CREATOR_ID);
+    // verify arguments passed to the meilisearch API
+    const { sort, hitsPerPage } = spy.mock.calls[0][0].queries[0];
+    expect(sort).toEqual(['name:asc']);
+    expect(hitsPerPage).toEqual(4);
+  });
+});
+
 describe('getFacets', () => {
   afterEach(() => {
     jest.clearAllMocks();

src/services/item/plugins/publication/published/plugins/search/search.service.ts

@@ -6,6 +6,7 @@ import { TagCategory, TagCategoryType, UUID } from '@graasp/sdk';
 import { TagRaw } from '../../../../../../../drizzle/types';
 import { BaseLogger } from '../../../../../../../logger';
 import {
+  GET_FEATURED_ITEMS_MAXIMUM,
   GET_MOST_LIKED_ITEMS_MAXIMUM,
   GET_MOST_RECENT_ITEMS_MAXIMUM,
 } from '../../../../../../../utils/config';
@@ -77,6 +78,17 @@ export class SearchService {
     return filters;
   }
 
+  async getFeatured(creatorId: string, limit: number = GET_FEATURED_ITEMS_MAXIMUM) {
+    return await this.search({
+      creatorId,
+      hitsPerPage: limit,
+      // order by most recently updated first
+      sort: ['name:asc'],
+      // only include top level content
+      isPublishedRoot: true,
+    });
+  }
+
   async getMostLiked(limit: number = GET_MOST_LIKED_ITEMS_MAXIMUM) {
     return await this.search({ sort: ['likes:desc'], limit });
   }
@@ -86,7 +98,16 @@ export class SearchService {
   }
 
   async search(body: Omit<MultiSearchQuery, 'filter' | 'indexUid' | 'q'> & SearchFilters) {
-    const { tags, langs, isPublishedRoot, query, creatorId, ...q } = body;
+    const { tags, langs, isPublishedRoot, query, creatorId, limit, page, ...q } = body;
+    // should allways use pagination arguments together
+    // page + hitsPerPage
+    // limit + offset
+    if (limit && page) {
+      throw new Error(
+        "'page' used together with 'limit'. Use 'page' in combination with 'hitsPerPage'. Otherwise use 'limit' with 'offset'. For more information see: https://www.meilisearch.com/docs/guides/front_end/pagination",
+      );
+    }
+
     const filters = this.buildFilters({
       creatorId,
       tags,
@@ -101,6 +122,8 @@ export class SearchService {
           indexUid: this.meilisearchClient.getActiveIndexName(),
           attributesToHighlight: ['*'],
           ...q,
+          limit,
+          page,
           q: query,
           filter: filters,
         },

src/utils/config.ts

@@ -331,6 +331,10 @@ if (!process.env.APPS_PUBLISHER_ID) {
   throw new Error('APPS_PUBLISHER_ID is not defined');
 }
 export const APPS_PUBLISHER_ID = process.env.APPS_PUBLISHER_ID;
+if (!process.env.GRAASPER_CREATOR_ID) {
+  throw new Error('GRAASPER_CREATOR_ID is not defined');
+}
+export const GRAASPER_CREATOR_ID = process.env.GRAASPER_CREATOR_ID;
 
 // used for hashing password
 export const SALT_ROUNDS = 10;
@@ -345,7 +349,7 @@ export const RECAPTCHA_SECRET_ACCESS_KEY = process.env.RECAPTCHA_SECRET_ACCESS_K
 export const RECAPTCHA_VERIFY_LINK = 'https://www.google.com/recaptcha/api/siteverify';
 export const RECAPTCHA_SCORE_THRESHOLD = 0.5;
 
-// todo: use env var?
+export const GET_FEATURED_ITEMS_MAXIMUM = 50;
 export const GET_MOST_LIKED_ITEMS_MAXIMUM = 50;
 export const GET_MOST_RECENT_ITEMS_MAXIMUM = 50;