feat(uaa-integration): Filter activity types for UAA (#3369)

JChan106 · web-flow · commit b9d196fcf330 · 2023-06-29T20:03:25.000Z
* feat(uaa-integration): Filter activity types for UAA

* feat(uaa-integration): Fix lint errors

* feat(uaa-integration): address PR comments

* feat(uaa-integration): fix test

* feat(uaa-integration): Fix another test

* feat(uaa-integration): Fix lint issue

* feat(uaa-integration): remove mutation from array
diff --git a/src/api/Feed.js b/src/api/Feed.js
@@ -35,6 +35,7 @@ import {
     FILE_ACTIVITY_TYPE_TASK,
     HTTP_STATUS_CODE_CONFLICT,
     IS_ERROR_DISPLAYED,
+    PERMISSION_CAN_VIEW_ANNOTATIONS,
     TASK_NEW_APPROVED,
     TASK_NEW_COMPLETED,
     TASK_NEW_REJECTED,
@@ -518,13 +519,22 @@ class Feed extends Base {
 
         const versionsPromise = shouldShowVersions ? this.fetchVersions() : Promise.resolve();
         const currentVersionPromise = shouldShowVersions ? this.fetchCurrentVersion() : Promise.resolve();
+
+        const annotationActivityType =
+            shouldShowAnnotations && permissions[PERMISSION_CAN_VIEW_ANNOTATIONS]
+                ? [FILE_ACTIVITY_TYPE_ANNOTATION]
+                : [];
+        const appActivityActivityType = shouldShowAppActivity ? [FILE_ACTIVITY_TYPE_APP_ACTIVITY] : [];
+        const taskActivityType = shouldShowTasks ? [FILE_ACTIVITY_TYPE_TASK] : [];
+        const filteredActivityTypes = [
+            ...annotationActivityType,
+            ...appActivityActivityType,
+            FILE_ACTIVITY_TYPE_COMMENT,
+            ...taskActivityType,
+        ];
+
         const fileActivitiesPromise = shouldUseUAA
-            ? this.fetchFileActivities(permissions, [
-                  FILE_ACTIVITY_TYPE_ANNOTATION,
-                  FILE_ACTIVITY_TYPE_APP_ACTIVITY,
-                  FILE_ACTIVITY_TYPE_COMMENT,
-                  FILE_ACTIVITY_TYPE_TASK,
-              ])
+            ? this.fetchFileActivities(permissions, filteredActivityTypes, shouldShowReplies)
             : Promise.resolve();
 
         const handleFeedItems = (feedItems: FeedItems) => {
@@ -675,9 +685,14 @@ class Feed extends Base {
      *
      * @param {BoxItemPermission} permissions - the file permissions
      * @param {FileActivityTypes[]} activityTypes - the activity types to filter by
+     * @param {boolean} shouldShowReplies - specify if replies should be included in the response
      * @return {Promise} - the file comments
      */
-    fetchFileActivities(permissions: BoxItemPermission, activityTypes: FileActivityTypes[]): Promise<Object> {
+    fetchFileActivities(
+        permissions: BoxItemPermission,
+        activityTypes: FileActivityTypes[],
+        shouldShowReplies?: boolean = false,
+    ): Promise<Object> {
         this.fileActivitiesAPI = new FileActivitiesAPI(this.options);
         return new Promise(resolve => {
             this.fileActivitiesAPI.getActivities({
@@ -686,6 +701,7 @@ class Feed extends Base {
                 permissions,
                 successCallback: resolve,
                 activityTypes,
+                shouldShowReplies,
             });
         });
     }
diff --git a/src/api/FileActivities.js b/src/api/FileActivities.js
@@ -5,18 +5,29 @@
  */
 
 import Base from './Base';
-import { PERMISSION_CAN_COMMENT, PERMISSION_CAN_VIEW_ANNOTATIONS, ERROR_CODE_FETCH_ACTIVITY } from '../constants';
+import {
+    ERROR_CODE_FETCH_ACTIVITY,
+    FILE_ACTIVITY_TYPE_ANNOTATION,
+    FILE_ACTIVITY_TYPE_COMMENT,
+    PERMISSION_CAN_COMMENT,
+    PERMISSION_CAN_VIEW_ANNOTATIONS,
+} from '../constants';
 import type { BoxItemPermission } from '../common/types/core';
 import type { ElementsXhrError } from '../common/types/api';
 import type { FileActivity, FileActivityTypes } from '../common/types/feed';
 
 // We only show the latest reply in the UI
 const REPLY_LIMIT = 1;
 
-const getFileActivityQueryParams = (fileID: string, activityTypes?: FileActivityTypes[] = []) => {
+const getFileActivityQueryParams = (
+    fileID: string,
+    activityTypes?: FileActivityTypes[] = [],
+    shouldShowReplies?: boolean = false,
+) => {
     const baseEndpoint = `/file_activities?file_id=${fileID}`;
     const hasActivityTypes = !!activityTypes && !!activityTypes.length;
-    const enabledRepliesQueryParam = `&enable_replies=true&reply_limit=${REPLY_LIMIT}`;
+    const enableReplies = shouldShowReplies ? 'true' : 'false';
+    const enabledRepliesQueryParam = `&enable_replies=${enableReplies}&reply_limit=${REPLY_LIMIT}`;
     const activityTypeQueryParam = hasActivityTypes ? `&activity_types=${activityTypes.join()}` : '';
 
     return `${baseEndpoint}${activityTypeQueryParam}${enabledRepliesQueryParam}`;
@@ -28,10 +39,11 @@ class FileActivities extends Base {
      *
      * @param {string} [id] - a box file id
      * @param {Array<FileActivityTypes>} activityTypes - optional. Array of File Activity types to filter by, returns all Activity Types if omitted.
+     * @param {boolean} shouldShowReplies - optional. Specify if replies should be included in the response
      * @return {string} base url for files
      */
-    getFilteredUrl(id: string, activityTypes?: FileActivityTypes[]): string {
-        return `${this.getBaseApiUrl()}${getFileActivityQueryParams(id, activityTypes)}`;
+    getFilteredUrl(id: string, activityTypes?: FileActivityTypes[], shouldShowReplies?: boolean): string {
+        return `${this.getBaseApiUrl()}${getFileActivityQueryParams(id, activityTypes, shouldShowReplies)}`;
     }
 
     /**
@@ -42,6 +54,7 @@ class FileActivities extends Base {
      * @param {string} fileId - the file id
      * @param {BoxItemPermission} permissions - the permissions for the file
      * @param {number} repliesCount - number of replies to return, by default all replies are returned
+     * @param {boolean} shouldShowReplies - specify if replies should be included in the response
      * @param {Function} successCallback - the success callback
      * @returns {void}
      */
@@ -51,13 +64,15 @@ class FileActivities extends Base {
         fileID,
         permissions,
         repliesCount,
+        shouldShowReplies,
         successCallback,
     }: {
         activityTypes: FileActivityTypes[],
         errorCallback: (e: ElementsXhrError, code: string) => void,
         fileID: string,
         permissions: BoxItemPermission,
         repliesCount?: number,
+        shouldShowReplies?: boolean,
         successCallback: (activity: FileActivity) => void,
     }): void {
         this.errorCode = ERROR_CODE_FETCH_ACTIVITY;
@@ -66,8 +81,12 @@ class FileActivities extends Base {
                 throw new Error('Missing file id!');
             }
 
-            this.checkApiCallValidity(PERMISSION_CAN_COMMENT, permissions, fileID);
-            this.checkApiCallValidity(PERMISSION_CAN_VIEW_ANNOTATIONS, permissions, fileID);
+            if (activityTypes.includes(FILE_ACTIVITY_TYPE_COMMENT)) {
+                this.checkApiCallValidity(PERMISSION_CAN_COMMENT, permissions, fileID);
+            }
+            if (activityTypes.includes(FILE_ACTIVITY_TYPE_ANNOTATION)) {
+                this.checkApiCallValidity(PERMISSION_CAN_VIEW_ANNOTATIONS, permissions, fileID);
+            }
         } catch (e) {
             errorCallback(e, this.errorCode);
             return;
@@ -80,7 +99,7 @@ class FileActivities extends Base {
             requestData: {
                 ...(repliesCount ? { replies_count: repliesCount } : null),
             },
-            url: this.getFilteredUrl(fileID, activityTypes),
+            url: this.getFilteredUrl(fileID, activityTypes, shouldShowReplies),
         });
     }
 }
diff --git a/src/api/__tests__/Feed.test.js b/src/api/__tests__/Feed.test.js
@@ -606,14 +606,24 @@ describe('api/Feed', () => {
         });
 
         test('should use the file activities api if shouldUseUAA is true', done => {
-            feed.feedItems(file, false, successCb, errorCb, errorCb, { shouldUseUAA: true });
+            feed.feedItems(file, false, successCb, errorCb, errorCb, {
+                shouldUseUAA: true,
+                shouldShowAnnotations: true,
+                shouldShowAppActivity: true,
+                shouldShowTasks: true,
+                shouldShowReplies: true,
+            });
             setImmediate(() => {
-                expect(feed.fetchFileActivities).toBeCalledWith(file.permissions, [
-                    FILE_ACTIVITY_TYPE_ANNOTATION,
-                    FILE_ACTIVITY_TYPE_APP_ACTIVITY,
-                    FILE_ACTIVITY_TYPE_COMMENT,
-                    FILE_ACTIVITY_TYPE_TASK,
-                ]);
+                expect(feed.fetchFileActivities).toBeCalledWith(
+                    file.permissions,
+                    [
+                        FILE_ACTIVITY_TYPE_ANNOTATION,
+                        FILE_ACTIVITY_TYPE_APP_ACTIVITY,
+                        FILE_ACTIVITY_TYPE_COMMENT,
+                        FILE_ACTIVITY_TYPE_TASK,
+                    ],
+                    true,
+                );
                 expect(feed.fetchComments).not.toBeCalled();
                 expect(feed.fetchThreadedComments).not.toBeCalled();
                 done();
@@ -842,7 +852,7 @@ describe('api/Feed', () => {
             });
 
             test('should return a promise and call the file activities api', () => {
-                const permissions = { can_edit: true, can_delete: true, can_resolve: true };
+                const permissions = { can_edit: true, can_delete: true, can_resolve: true, can_view_annotations: true };
                 const fileActivityItems = feed.fetchFileActivities(permissions, [
                     FILE_ACTIVITY_TYPE_ANNOTATION,
                     FILE_ACTIVITY_TYPE_APP_ACTIVITY,
@@ -860,6 +870,7 @@ describe('api/Feed', () => {
                     errorCallback: expect.any(Function),
                     fileID: feed.file.id,
                     permissions,
+                    shouldShowReplies: false,
                     successCallback: expect.any(Function),
                 });
                 expect(fileActivityItems).resolves.toEqual({ entries: mockFileActivities });
diff --git a/src/api/__tests__/FileActivities.test.js b/src/api/__tests__/FileActivities.test.js
@@ -26,11 +26,24 @@ describe('api/FileActivities', () => {
         `(
             'should return the filtered query parameters as $expected when $activityTypes is passed in',
             ({ activityTypes, expected }) => {
-                expect(fileActivities.getFilteredUrl('1', activityTypes)).toBe(
+                expect(fileActivities.getFilteredUrl('1', activityTypes, true)).toBe(
                     `https://api.box.com/2.0/file_activities?file_id=1${expected}&enable_replies=true&reply_limit=1`,
                 );
             },
         );
+
+        test.each`
+            enableReplies | expected
+            ${true}       | ${'&enable_replies=true'}
+            ${false}      | ${'&enable_replies=false'}
+        `(
+            'should return the enable_replies as $expected when $enableReplies is passed in',
+            ({ enableReplies, expected }) => {
+                expect(fileActivities.getFilteredUrl('1', ['comment', 'annotation', 'task'], enableReplies)).toBe(
+                    `https://api.box.com/2.0/file_activities?file_id=1&activity_types=comment,annotation,task${expected}&reply_limit=1`,
+                );
+            },
+        );
     });
 
     describe('getActivities()', () => {
@@ -40,7 +53,6 @@ describe('api/FileActivities', () => {
         test('should call the underlying get method', () => {
             const permissions = {
                 can_comment: true,
-                can_view_annotations: true,
             };
 
             fileActivities.getActivities({
@@ -49,6 +61,7 @@ describe('api/FileActivities', () => {
                 permissions,
                 successCallback,
                 errorCallback,
+                shouldShowReplies: true,
             });
 
             expect(fileActivities.get).toBeCalledWith({
@@ -68,7 +81,7 @@ describe('api/FileActivities', () => {
         ])('should reject with an error code for calls with invalid permissions %s', permissions => {
             fileActivities.getActivities({
                 fileID: '123',
-                activityTypes: ['comment', 'task'],
+                activityTypes: ['annotation', 'comment', 'task'],
                 permissions,
                 successCallback,
                 errorCallback,
