fix: return 200 with null when item is not published instead of error (#819)

* fix: return 200 with `null` when item is not published instead of error

* fix: add tests

* fix: sonar issues

Author: spaenleh

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

@@ -181,7 +181,10 @@ export const getInformations = {
   },
 
   response: {
-    200: publishEntryWithViews,
+    200: {
+      ...publishEntryWithViews,
+      nullable: true,
+    },
   },
 };
 

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

@@ -13,6 +13,7 @@ import { Actor, Member } from '../../../member/entities/member';
 import { Item } from '../../entities/Item';
 import ItemService from '../../service';
 import { buildPublishedItemLink } from './constants';
+import { ItemPublishedNotFound } from './errors';
 
 interface ActionCount {
   actionCount: number;
@@ -67,12 +68,24 @@ export class ItemPublishedService {
 
     // item should be public first
     await itemTagRepository.getType(item, ItemTagType.Public, { shouldThrow: true });
-    const totalViews = await actionRepository.getAggregationForItem(item.path, {
-      view: 'library',
-      types: ['collection-view'],
-    });
-    const publishedItem = await itemPublishedRepository.getForItem(item);
-    return { totalViews: (totalViews?.[0] as ActionCount)?.actionCount, ...publishedItem };
+
+    try {
+      // get item published entry
+      const publishedItem = await itemPublishedRepository.getForItem(item);
+      // get views from the actions table
+      const totalViews = await actionRepository.getAggregationForItem(item.path, {
+        view: 'library',
+        types: ['collection-view'],
+      });
+      return { totalViews: (totalViews?.[0] as ActionCount)?.actionCount, ...publishedItem };
+    } catch (err) {
+      // when the item is found but it is not published we simply return `null`
+      if (err instanceof ItemPublishedNotFound) {
+        return null;
+      }
+      // if the error was not expecte we throw it back
+      throw err;
+    }
   }
 
   async getMany(actor: Actor, repositories: Repositories, itemIds: string[]) {

src/services/item/plugins/published/test/index.test.ts

@@ -142,10 +142,11 @@ describe('Item Published', () => {
           category: selectedCategories[1],
         });
 
+        const categoryId = selectedCategories.map(({ id }) => id);
         const res = await app.inject({
           method: HttpMethod.GET,
           url: `${ITEMS_ROUTE_PREFIX}/collections${qs.stringify(
-            { categoryId: selectedCategories.map(({ id }) => id) },
+            { categoryId },
             { addQueryPrefix: true, arrayFormat: 'repeat' },
           )}`,
         });
@@ -167,10 +168,11 @@ describe('Item Published', () => {
         // one random item category
         await ItemCategoryRepository.save({ item: collections[2], category: categories[2] });
 
+        const categoryId = selectedCategories.map(({ id }) => id).join(',');
         const res = await app.inject({
           method: HttpMethod.GET,
           url: `${ITEMS_ROUTE_PREFIX}/collections${qs.stringify(
-            { categoryId: selectedCategories.map(({ id }) => id).join(',') },
+            { categoryId },
             { addQueryPrefix: true, arrayFormat: 'repeat' },
           )}`,
         });
@@ -233,6 +235,27 @@ describe('Item Published', () => {
         const items = Object.values(result).map((i) => i.item);
         expectManyItems(items as Item[], [otherParentItem, parentItem]);
       });
+      it('Get publish info of non public item returns forbidden', async () => {
+        // simple item not public and not published
+        const { item } = await saveItemAndMembership({ member });
+        const res = await app.inject({
+          method: HttpMethod.GET,
+          url: `${ITEMS_ROUTE_PREFIX}/collections/${item.id}/informations`,
+        });
+        expect(res.statusCode).toBe(StatusCodes.FORBIDDEN);
+      });
+      it('Get publish info of public item that is not published yet returns null', async () => {
+        const { item } = await saveItemAndMembership({ member });
+        // make item public
+        await ItemTagRepository.post(member, item, ItemTagType.Public);
+
+        const res = await app.inject({
+          method: HttpMethod.GET,
+          url: `${ITEMS_ROUTE_PREFIX}/collections/${item.id}/informations`,
+        });
+        expect(res.statusCode).toBe(StatusCodes.OK);
+        expect(res.json()).toBe(null);
+      });
       it('Throw if category id is invalid', async () => {
         const res = await app.inject({
           method: HttpMethod.GET,