fix(sidebar): Task assignment to use new status field (#720)

flow-typed/box-ui-elements.js

@@ -69,6 +69,10 @@ import {
     ORIGIN_ACTIVITY_SIDEBAR,
     ORIGIN_SKILLS_SIDEBAR,
     ORIGIN_METADATA_SIDEBAR,
+    TASK_APPROVED,
+    TASK_COMPLETED,
+    TASK_INCOMPLETE,
+    TASK_REJECTED,
 } from '../src/constants';
 
 type Method =
@@ -104,6 +108,7 @@ type ItemType = typeof TYPE_FILE | typeof TYPE_FOLDER | typeof TYPE_WEBLINK;
 type UploadStatus = typeof STATUS_PENDING | typeof STATUS_IN_PROGRESS | typeof STATUS_COMPLETE | typeof STATUS_ERROR;
 type Delimiter = typeof DELIMITER_SLASH | typeof DELIMITER_CARET;
 type Size = typeof SIZE_SMALL | typeof SIZE_LARGE | typeof SIZE_MEDIUM;
+type TaskAssignmentStatus = typeof TASK_APPROVED | typeof TASK_COMPLETED | typeof TASK_INCOMPLETE | typeof TASK_REJECTED;
 
 type SharedLink = {
     url: string,
@@ -523,8 +528,7 @@ type TaskAssignment = {
     type: 'task_assignment',
     id: string,
     assigned_to: User,
-    resolution_state: string,
-    message: string,
+    status: TaskAssignmentStatus,
 };
 
 type TaskAssignments = {

src/api/Feed.js

@@ -232,8 +232,7 @@ class Feed extends Base {
      * @param {BoxItem} file - The file to which the task is assigned
      * @param {string} taskId - ID of task to be updated
      * @param {string} taskAssignmentId - Task assignment ID
-     * @param {string} resolutionState - New task assignment status
-     * @param {string} message - optional the message to the assignee
+     * @param {TaskAssignmentStatus} taskStatus - New task assignment status
      * @param {Function} successCallback - the function which will be called on success
      * @param {Function} errorCallback - the function which will be called on error
      * @return {void}
@@ -242,8 +241,7 @@ class Feed extends Base {
         file: BoxItem,
         taskId: string,
         taskAssignmentId: string,
-        resolutionState: string,
-        message?: string,
+        taskStatus: TaskAssignmentStatus,
         successCallback: Function,
         errorCallback: ErrorCallback,
     ): void => {
@@ -259,8 +257,7 @@ class Feed extends Base {
         assignmentAPI.updateTaskAssignment({
             file,
             taskAssignmentId,
-            resolutionState,
-            message,
+            taskStatus,
             successCallback: (taskAssignment: TaskAssignment) => {
                 this.updateTaskAssignmentSuccessCallback(taskId, taskAssignment, successCallback);
             },
@@ -294,7 +291,6 @@ class Feed extends Base {
                         return {
                             ...item,
                             ...updatedAssignment,
-                            resolution_state: updatedAssignment.message.toLowerCase(),
                         };
                     }
 
@@ -513,7 +509,7 @@ class Feed extends Base {
                 id: assignee.id,
                 name: assignee.name,
             },
-            resolution_state: TASK_INCOMPLETE,
+            status: TASK_INCOMPLETE,
         }));
 
         const task = {
@@ -706,13 +702,12 @@ class Feed extends Base {
         }
 
         task.task_assignment_collection.entries = assignments.map(taskAssignment => {
-            const { id, assigned_to, message, resolution_state } = taskAssignment;
+            const { id, assigned_to, status } = taskAssignment;
             return {
                 type: TASK_ASSIGNMENT,
                 id,
                 assigned_to,
-                message,
-                resolution_state: message ? message.toLowerCase() : resolution_state,
+                status,
             };
         });
 

src/api/TaskAssignments.js

@@ -83,26 +83,23 @@ class TaskAssignments extends Base {
      *
      * @param {BoxItem} file - File object for which we are updating a task assignment
      * @param {string} taskAssignmentId - Task assignment to be edited
-     * @param {string} resolutionState - The updated task assignment status
+     * @param {TaskAssignmentStatus} taskStatus - The updated task assignment status
      * @param {Function} successCallback - Success callback
      * @param {Function} errorCallback - Error callback
-     * @param {string} [message] - The task assignments text
      * @return {void}
      */
     updateTaskAssignment({
         file,
         taskAssignmentId,
-        resolutionState,
-        message,
+        taskStatus,
         successCallback,
         errorCallback,
     }: {
         file: BoxItem,
         taskAssignmentId: string,
-        resolutionState: string,
+        taskStatus: TaskAssignmentStatus,
         successCallback: Function,
         errorCallback: ElementsErrorCallback,
-        message?: string,
     }): void {
         this.errorCode = ERROR_CODE_UPDATE_TASK_ASSIGNMENT;
         const { id = '', permissions } = file;
@@ -116,7 +113,7 @@ class TaskAssignments extends Base {
         }
 
         const requestData = {
-            data: { resolution_state: resolutionState, message },
+            data: { status: taskStatus },
         };
 
         this.put({

src/api/__tests__/Feed-test.js

@@ -45,8 +45,7 @@ jest.mock('../Tasks', () => {
                             name: 'Daniel DeMicco',
                             login: '[email protected]',
                         },
-                        resolution_state: 'incomplete',
-                        message: 'Completed',
+                        status: 'completed',
                     },
                 ],
             });
@@ -151,8 +150,7 @@ describe('api/Feed', () => {
                     name: 'Daniel DeMicco',
                     login: '[email protected]',
                 },
-                resolution_state: 'incomplete',
-                message: 'Completed',
+                status: 'completed',
             },
         ],
     };
@@ -409,11 +407,11 @@ describe('api/Feed', () => {
                 taskId,
                 {
                     ...tasks.entries[0].task_assignment_collection.entries[0],
-                    message: updatedState,
+                    status: updatedState,
                 },
                 successCb,
             );
-            expect(feed.updateFeedItem.mock.calls[0][0].task_assignment_collection.entries[0].resolution_state).toBe(
+            expect(feed.updateFeedItem.mock.calls[0][0].task_assignment_collection.entries[0].status).toBe(
                 updatedState,
             );
             expect(successCb).toBeCalled();
@@ -564,7 +562,7 @@ describe('api/Feed', () => {
                     entries: [
                         {
                             assigned_to: assignees[0],
-                            resolution_state: 'incomplete',
+                            status: 'incomplete',
                         },
                     ],
                     total_count: 1,
@@ -588,7 +586,7 @@ describe('api/Feed', () => {
                     entries: [
                         {
                             assigned_to: assignees[0],
-                            resolution_state: 'incomplete',
+                            status: 'incomplete',
                         },
                     ],
                     total_count: 1,
@@ -748,13 +746,12 @@ describe('api/Feed', () => {
                 {
                     id: '1',
                     assigned_to: { id: '1234' },
-                    message: 'completed',
-                    resolution_state: 'completed',
+                    status: 'completed',
                 },
             ];
             const expectedResult = {
                 task_assignment_collection: {
-                    entries: [{ ...assignments[0], type: 'task_assignment' }],
+                    entries: [{ ...assignments[0], status: 'completed', type: 'task_assignment' }],
                     total_count: 1,
                 },
             };
@@ -776,12 +773,12 @@ describe('api/Feed', () => {
                 {
                     id: '1',
                     assigned_to: { id: '1234' },
-                    resolution_state: 'completed',
+                    status: 'completed',
                 },
             ];
             const expectedResult = {
                 task_assignment_collection: {
-                    entries: [{ ...assignments[0], type: 'task_assignment' }],
+                    entries: [{ ...assignments[0], status: 'completed', type: 'task_assignment' }],
                     total_count: 1,
                 },
             };

src/api/__tests__/TaskAssignments-test.js

@@ -26,7 +26,7 @@ describe('api/TaskAssignments', () => {
             id: '987654321',
         };
 
-        const resolutionState = 'rejected';
+        const taskStatus = 'rejected';
         const successCallback = jest.fn();
         const errorCallback = jest.fn();
 
@@ -93,7 +93,7 @@ describe('api/TaskAssignments', () => {
                 taskAssignments.updateTaskAssignment({
                     file,
                     taskAssignmentId,
-                    resolutionState,
+                    taskStatus,
                     successCallback,
                     errorCallback,
                 });
@@ -106,13 +106,13 @@ describe('api/TaskAssignments', () => {
 
             test('should put a well formed task update to the tasks endpoint', () => {
                 const requestData = {
-                    data: { resolution_state: resolutionState },
+                    data: { status: taskStatus },
                 };
 
                 taskAssignments.updateTaskAssignment({
                     file,
                     taskAssignmentId,
-                    resolutionState,
+                    taskStatus,
                     successCallback,
                     errorCallback,
                 });

src/components/ContentSidebar/ActivityFeed/activity-feed/__tests__/ActiveState-test.js

@@ -25,7 +25,7 @@ const items = [
             entries: [
                 {
                     assigned_to: { name: 'Akon', id: 11 },
-                    resolution_state: 'incomplete',
+                    status: 'incomplete',
                 },
             ],
             total_count: 1,

src/components/ContentSidebar/ActivityFeed/activity-feed/__tests__/__snapshots__/ActiveState-test.js.snap

@@ -88,7 +88,7 @@ exports[`components/ContentSidebar/ActiveState/activity-feed/ActiveState should
                 "id": 11,
                 "name": "Akon",
               },
-              "resolution_state": "incomplete",
+              "status": "incomplete",
             },
           ],
           "total_count": 1,

src/components/ContentSidebar/ActivityFeed/task/Task.js

@@ -16,11 +16,7 @@ import RejectedAssignment from './RejectedAssignment';
 
 import './Task.scss';
 import { fillUserPlaceholder } from '../../../../util/fields';
-
-const TASK_APPROVED = 'approved';
-const TASK_REJECTED = 'rejected';
-const TASK_COMPLETED = 'completed';
-const TASK_INCOMPLETE = 'incomplete';
+import { TASK_APPROVED, TASK_REJECTED, TASK_COMPLETED, TASK_INCOMPLETE } from '../../../../constants';
 
 type Props = {
     task_assignment_collection: TaskAssignments | SelectorItems,
@@ -117,8 +113,8 @@ class Task extends React.Component<Props> {
                         {task_assignment_collection && task_assignment_collection.entries
                             ? task_assignment_collection.entries
                                   .map(fillUserPlaceholder)
-                                  .map(({ id: assignmentId, assigned_to, resolution_state }) => {
-                                      switch (resolution_state) {
+                                  .map(({ id: assignmentId, assigned_to, status }) => {
+                                      switch (status) {
                                           case TASK_COMPLETED:
                                           case TASK_APPROVED:
                                               return <CompletedAssignment {...assigned_to} key={assigned_to.id} />;

src/components/ContentSidebar/ActivityFeed/task/__tests__/Task-test.js

@@ -35,12 +35,12 @@ describe('components/ContentSidebar/ActivityFeed/task/Task', () => {
                 {
                     id: 0,
                     assigned_to: { name: 'Jake Thomas', id: 1 },
-                    resolution_state: 'incomplete',
+                    status: 'incomplete',
                 },
                 {
                     id: 1,
                     assigned_to: { name: 'Peter Pan', id: 2 },
-                    resolution_state: 'completed',
+                    status: 'completed',
                 },
             ],
         },
@@ -78,12 +78,12 @@ describe('components/ContentSidebar/ActivityFeed/task/Task', () => {
                     {
                         id: 0,
                         assigned_to: { name: 'Jake Thomas', id: 1 },
-                        resolution_state: 'incomplete',
+                        status: 'incomplete',
                     },
                     {
                         id: 1,
                         assigned_to: { name: 'Peter Pan', id: 2 },
-                        resolution_state: 'completed',
+                        status: 'completed',
                     },
                     ``,
                 ],
@@ -188,12 +188,12 @@ describe('components/ContentSidebar/ActivityFeed/task/Task', () => {
                     {
                         id: 0,
                         assigned_to: { name: 'Jake Thomas', id: 1 },
-                        resolution_state: 'incomplete',
+                        status: 'incomplete',
                     },
                     {
                         id: 1,
                         assigned_to: { name: 'Peter Pan', id: 2 },
-                        resolution_state: 'completed',
+                        status: 'completed',
                     },
                 ],
             },
@@ -227,12 +227,12 @@ describe('components/ContentSidebar/ActivityFeed/task/Task', () => {
                     {
                         id: 0,
                         assigned_to: { name: 'Jake Thomas', id: 1 },
-                        resolution_state: 'incomplete',
+                        status: 'incomplete',
                     },
                     {
                         id: 1,
                         assigned_to: { name: 'Peter Pan', id: 2 },
-                        resolution_state: 'completed',
+                        status: 'completed',
                     },
                 ],
             },

src/components/ContentSidebar/ActivitySidebar.js

@@ -149,19 +149,17 @@ class ActivitySidebar extends React.PureComponent<Props, State> {
      *
      * @param {string} taskId - ID of task to be updated
      * @param {string} taskAssignmentId - Task assignment ID
-     * @param {string} status - New task assignment status
-     * @param {string} message - the message to the assignee
+     * @param {TaskAssignmentStatus} status - New task assignment status
      * @return void
      */
-    updateTaskAssignment = (taskId: string, taskAssignmentId: string, status: string, message?: string): void => {
+    updateTaskAssignment = (taskId: string, taskAssignmentId: string, status: TaskAssignmentStatus): void => {
         const { file, api } = this.props;
 
         api.getFeedAPI(false).updateTaskAssignment(
             file,
             taskId,
             taskAssignmentId,
             status,
-            message,
             this.feedSuccessCallback,
             this.feedErrorCallback,
         );

src/constants.js

@@ -115,8 +115,8 @@ export const FIELD_MESSAGE = 'message';
 export const FIELD_TAGGED_MESSAGE = 'tagged_message';
 export const FIELD_TRASHED_AT = 'trashed_at';
 export const FIELD_ASSIGNED_TO = 'assigned_to';
-export const FIELD_RESOLUTION_STATE = 'resolution_state';
 export const FIELD_RELEVANCE: '' = '';
+export const FIELD_STATUS = 'status';
 
 /* ----------------------- Permissions --------------------------- */
 export const PERMISSION_CAN_PREVIEW = 'can_preview';
@@ -306,3 +306,9 @@ export const PLACEHOLDER_USER = { type: 'user', id: '2', name: '' };
 
 /* ------------------ Integrations ------------------------- */
 export const APP_INTEGRATION = 'app_integration';
+
+/* ------------------ Task Assignment Statuses ----------------- */
+export const TASK_APPROVED: 'approved' = 'approved';
+export const TASK_COMPLETED: 'completed' = 'completed';
+export const TASK_INCOMPLETE: 'incomplete' = 'incomplete';
+export const TASK_REJECTED: 'rejected' = 'rejected';