Add pagination to user queues #14242

hschallhorn · 2020-05-11T18:10:56Z

Resolves #14142

Description

Adds pagination to user queues

Acceptance Criteria

The tasks in user's queues are paginated

Testing Plan

Create some dummy data to play with

3.times do 
  ColocatedTask.actions_assigned_to_colocated.map(&:to_sym).each do |action|
    appeal = FactoryBot.create(:appeal)
    parent = FactoryBot.create(
      :ama_task,
      assigned_to: User.first,
      assigned_by: User.first,
      appeal: appeal
    )
    task = FactoryBot.create(
      :ama_colocated_task,
      action,
      assigned_to: Colocated.singleton,
      appeal: appeal,
      assigned_by: User.first,
      parent_id: parent.id
    )
    task.children.first.on_hold!
  end
end

Sign in as BVALSPORER
TODO

User Facing Changes

Screenshots of UI changes added to PR & Original Issue

BEFORE	AFTER

codeclimate · 2020-05-11T18:16:44Z

Code Climate has analyzed commit 56e9531 and detected 0 issues on this pull request.

View more on Code Climate.

hschallhorn · 2020-05-11T18:20:04Z

app/controllers/tasks_controller.rb

@@ -42,7 +42,7 @@ def set_application
  #      GET /tasks?user_id=xxx&role=attorney
  #      GET /tasks?user_id=xxx&role=judge
  def index
-    tasks = QueueForRole.new(user_role).create(user: user).tasks
+    tasks = user.use_task_pages_api? ? [] : QueueForRole.new(user_role).create(user: user).tasks


This only improves the initial load time of a queue. Will file followup tickets to improve load times after creating or updating tasks. These tickets would remove QueueForRole here

caseflow/app/controllers/tasks_controller.rb

Lines 71 to 83 in b0bf1be

def create

return invalid_type_error unless task_classes_valid?

tasks = []

param_groups = create_params.group_by { |param| param[:type] }

param_groups.each do |task_type, param_group|

tasks << valid_task_classes[task_type.to_sym].create_many_from_params(param_group, current_user)

end

modified_tasks = [parent_tasks_from_params, tasks].flatten!

tasks_to_return = (QueueForRole.new(user_role).create(user: current_user).tasks + modified_tasks).uniq

render json: { tasks: json_tasks(tasks_to_return) }

and here

caseflow/app/controllers/tasks_controller.rb

Lines 95 to 102 in b0bf1be

def update

tasks = task.update_from_params(update_params, current_user)

tasks.each { |t| return invalid_record_error(t) unless t.valid? }

tasks_to_return = (QueueForRole.new(user_role).create(user: current_user).tasks + tasks).uniq

render json: { tasks: json_tasks(tasks_to_return) }

end

and should exist outside of pagination

hschallhorn · 2020-05-11T18:50:10Z

app/controllers/concerns/task_pagination_concern.rb

+      tasks: tasks, params: params, ama_serializer: WorkQueue::TaskSerializer
+    ).call
+  end
+end


Pulled all this out of organization task pages controller to be reused in user task pages controller.

hschallhorn · 2020-05-11T19:05:14Z

app/models/organization.rb

@@ -141,10 +141,6 @@ def completed_tasks_tab
    ::OrganizationCompletedTasksTab.new(assignee: self, show_regional_office_column: show_regional_office_in_queue?)
  end

-  def ama_task_serializer
-    WorkQueue::TaskSerializer
-  end


Pulled out here

hschallhorn · 2020-05-11T20:16:34Z

app/controllers/users/task_pages_controller.rb

+  def assignee
+    user
+  end
+end


New controller for requesting paged tasks assigned to a user

hschallhorn · 2020-05-11T20:17:08Z

app/models/queue_config.rb

@@ -48,7 +48,7 @@ def attach_tasks_to_tab(tab)
      # This allows us to only instantiate TaskPager if we are using the task pages API.
      task_page_count: task_pager.task_page_count,
      total_task_count: tab.tasks.count,
-      task_page_endpoint_base_path: "#{assignee_is_org? ? "#{assignee.path}/" : ''}#{endpoint}"
+      task_page_endpoint_base_path: "#{assignee_is_org? ? "#{assignee.path}/" : "users/#{assignee.id}/"}#{endpoint}"


this is the endpoint the front end uses to request paged tasks

hschallhorn · 2020-05-11T20:24:19Z

app/models/queue_tabs/on_hold_tasks_tab.rb

+      assigned_to_type: Organization.name,
+      appeal_type: LegacyAppeal.name,
+      type: ColocatedTask.subclasses.map(&:name)
+    )


Copies logic from AttorneyQueue. Only issue is that it will return multiple colocated tasks for one appeal. Debating on how to fix this. Currently affects 42 cases out of ~2500

legacy_colocated_tasks = ColocatedTask.open.where(appeal_type: LegacyAppeal.name, assigned_to: Colocated.singleton) legacy_colocated_tasks.pluck(:appeal_id).uniq.count => 2593 legacy_colocated_tasks.group(:appeal_id).count.values.select { |count| count > 1 }.count => 42

hschallhorn · 2020-05-11T20:25:42Z

app/models/task_pager.rb

@@ -23,7 +23,7 @@ def initialize(args)
  end

  def paged_tasks
-    sorted_tasks(filtered_tasks).page(page).per(TASKS_PER_PAGE)
+    @paged_tasks ||= sorted_tasks(filtered_tasks).page(page).per(TASKS_PER_PAGE)


We were calling this again every time we called paged tasks

hschallhorn · 2020-05-11T20:26:21Z

app/models/user.rb

@@ -337,7 +337,7 @@ def queue_tabs
  end

  def self.default_active_tab
-    Constants.QUEUE_CONFIG.ASSIGNED_TASKS_TAB_NAME
+    Constants.QUEUE_CONFIG.INDIVIDUALLY_ASSIGNED_TASKS_TAB_NAME


Error from previous PRs

hschallhorn · 2020-05-11T20:26:50Z

client/app/queue/AttorneyTaskListView.jsx

@@ -73,6 +73,7 @@ class AttorneyTaskListView extends React.PureComponent {
        assignedTasks={this.props.workableTasks}
        onHoldTasks={this.props.onHoldTasks}
        completedTasks={this.props.completedTasks}
+        paginationOptions={this.props.paginationOptions}


Pass pagination options though to queue table builder

hschallhorn · 2020-05-11T20:26:58Z

client/app/queue/AttorneyTaskListView.jsx

@@ -124,7 +123,7 @@ AttorneyTaskListView.propTypes = {
  resetErrorMessages: PropTypes.func,
  showErrorMessage: PropTypes.func,
  onHoldTasks: PropTypes.array,
-  organizations: PropTypes.array,


Orgs was unused

hschallhorn · 2020-05-11T20:27:02Z

client/app/queue/ColocatedTaskListView.jsx

@@ -40,6 +40,7 @@ class ColocatedTaskListView extends React.PureComponent {
        assignedTasks={this.props.assignedTasks}
        onHoldTasks={this.props.onHoldTasks}
        completedTasks={this.props.completedTasks}
+        paginationOptions={this.props.paginationOptions}


Pass pagination options though to queue table builder

hschallhorn · 2020-05-11T20:27:18Z

client/app/queue/ColocatedTaskListView.jsx

@@ -71,7 +70,6 @@ ColocatedTaskListView.propTypes = {
  completedTasks: PropTypes.array,
  hideSuccessMessage: PropTypes.func,
  onHoldTasks: PropTypes.array,
-  organizations: PropTypes.array,
-  queueConfig: PropTypes.object,


orgs and queue config were unused

hschallhorn · 2020-05-11T20:29:00Z

config/routes.rb

-  resources :users, only: [:index, :update]
-  resources :users, only: [:index] do
+  resources :users, only: [:index, :update] do
+    resources :task_pages, only: [:index], controller: 'users/task_pages'


Route for user tasks pager

hschallhorn · 2020-05-11T20:29:59Z

spec/controllers/tasks_controller_spec.rb

+
+        context "when using task pages api" do
+          before do
+            expect(QueueForRole).not_to receive(:new)


Ensure we are not pulling tasks from QueueForRole

hschallhorn · 2020-05-11T20:30:38Z

spec/controllers/tasks_controller_spec.rb

+            expect(response.status).to eq 200
+
+            queue_for_role_tasks = JSON.parse(response.body)["tasks"]["data"]
+            expect(queue_for_role_tasks.size).to be(0)


ensure tasks are not being sent to the front end outside of queue config

hschallhorn · 2020-05-11T20:30:43Z

spec/controllers/tasks_controller_spec.rb

+            expect(queue_for_role_tasks.size).to be(0)
+
+            paged_tasks = JSON.parse(response.body)["queue_config"]["tabs"].first["tasks"]
+            expect(paged_tasks.size).to be(1)


ensure tasks are being sent though queue config

hschallhorn · 2020-05-11T20:31:45Z

spec/models/queue_config_spec.rb

@@ -232,7 +232,8 @@
          let!(:on_hold_tasks) { create_list(:ama_task, 5, :on_hold, assigned_to: assignee) }
          let!(:completed_tasks) { create_list(:ama_task, 7, :completed, assigned_to: assignee) }

-          before { allow(assignee).to receive(:use_task_pages_api?).and_return(true) }
+          before { FeatureToggle.enable!(:user_queue_pagination) }
+          after { FeatureToggle.disable!(:user_queue_pagination) }


Use feature toggle

hschallhorn · 2020-05-11T20:32:23Z

spec/models/queue_tabs/on_hold_tasks_tab_spec.rb

+      let!(:other_folks_tasks) { create_list(:ama_task, 1) }
+      let!(:assignee_active_tasks) { create_list(:ama_task, 1, :assigned, assigned_to: assignee) }
+      let!(:assignee_on_hold_tasks) { create_list(:ama_task, 3, :on_hold, assigned_to: assignee) }
+      let!(:assignee_legacy_colocated_tasks) { create_list(:colocated_task, 5, assigned_by: assignee) }


New model test to ensure we pick up attorney tasks

hschallhorn · 2020-05-11T21:55:08Z

app/controllers/users_controller.rb

@@ -77,16 +77,20 @@ def filter_by_css_id_or_name
    render json: { users: json_users(users) }
  end

+  def id
+    @id ||= params[:id] || params[:user_id]


Could not for the life of me get a route were I could pass :id as the param, only :user_id. Very very open to suggestions 🙏

hschallhorn · 2020-05-11T21:56:27Z

app/models/user.rb

@@ -325,7 +325,7 @@ def update_status!(new_status)
  end

  def use_task_pages_api?
-    false
+    FeatureToggle.enabled?(:user_queue_pagination, user: self)


Checks if pagination is enabled for this user

hschallhorn · 2020-05-11T21:57:12Z

client/app/queue/OrganizationQueue.jsx

-      />
-    </div>;
-  }
-


All of this is pulled out into client/app/queue/QueueTableBuilder.jsx

…hub.com/department-of-veterans-affairs/caseflow into hschallhorn/14142-user-queue-pagination

hschallhorn · 2020-05-12T16:11:52Z

app/models/user.rb

+  def attorney?
+    non_administered_judge_teams.any? || attorney_in_vacols?
+  end
+


Rely on user being on a judge team before checking vacols

hschallhorn · 2020-05-12T16:12:25Z

app/models/user.rb

@@ -325,7 +333,7 @@ def update_status!(new_status)
  end

  def use_task_pages_api?
-    false
+    FeatureToggle.enabled?(:user_queue_pagination, user: self) && !attorney? && !judge?


Cannot paginate attorney or judge queues as they will have legacy tasks that are not persisted in the database.

hschallhorn · 2020-05-12T16:13:26Z

client/app/queue/QueueApp.jsx

@@ -277,7 +277,7 @@ class QueueApp extends React.PureComponent {

    return (
      <OrganizationQueueLoadingScreen urlToLoad={`${url}/tasks`}>
-        <OrganizationQueue {...this.props} paginationOptions={querystring.parse(window.location.search.slice(1))} />
+        <OrganizationQueue {...this.props} />


This is now done in queue table builder

hschallhorn · 2020-05-12T16:13:38Z

client/app/queue/QueueTable.jsx

@@ -660,7 +660,7 @@ HeaderRow.propTypes = FooterRow.propTypes = Row.propTypes = BodyRows.propTypes =
  useTaskPagesApi: PropTypes.bool,
  userReadableColumnNames: PropTypes.object,
  tabPaginationOptions: PropTypes.shape({
-    [QUEUE_CONFIG.PAGE_NUMBER_REQUEST_PARAM]: PropTypes.number,
+    [QUEUE_CONFIG.PAGE_NUMBER_REQUEST_PARAM]: PropTypes.string,


suppress console warning

hschallhorn · 2020-05-12T16:14:57Z

client/test/karma/queue/ColocatedTaskListView-test.js

@@ -317,7 +317,7 @@ describe('ColocatedTaskListView', () => {
        }
    ],
    "tasks_per_page": 15,
-    "use_task_pages_api": true
+    "use_task_pages_api": false


Ensure these tests still pass without pagination turned on (ensures we did not break anything). This was not being used on the front end until now.

hschallhorn · 2020-05-12T16:15:18Z

spec/controllers/organizations/task_pages_controller_spec.rb

-        allow_any_instance_of(::Organizations::TaskPagesController).to receive(:json_tasks).and_return([])
-
-        subject
-      end


Pulled out to shared example below

hschallhorn · 2020-05-12T16:15:49Z

spec/models/queue_config_spec.rb

@@ -76,7 +76,7 @@
        let(:assignee) { user }

        it "is the assigned tab" do
-          expect(subject[:active_tab]).to eq(Constants.QUEUE_CONFIG.ASSIGNED_TASKS_TAB_NAME)
+          expect(subject[:active_tab]).to eq(Constants.QUEUE_CONFIG.INDIVIDUALLY_ASSIGNED_TASKS_TAB_NAME)


Bug from previous PRs

hschallhorn · 2020-05-12T17:54:28Z

Closing to create a stacked PR!

hschallhorn added 6 commits May 11, 2020 11:02

Add assigned colocated tasks to user on hold tabs

fe83559

Use pagination feature toggle

dcdcb73

Use paged tasks in task controller

b0bf1be

Create a task pager for users

08fcd51

Only request paged tasks once

0d964de

Enable pagination on the front end for users

704aadc

hschallhorn self-assigned this May 11, 2020

hschallhorn commented May 11, 2020

View reviewed changes

hschallhorn and others added 2 commits May 11, 2020 14:37

combine task pages controllers

5cf38a1

Merge branch 'master' into hschallhorn/14142-user-queue-pagination

93e1f6a

hschallhorn commented May 11, 2020

View reviewed changes

hschallhorn added 2 commits May 11, 2020 17:18

Code climate part 1!

78bbd55

Merge queue table builder and organization queue

aab8fea

Merge branch 'master' into hschallhorn/14142-user-queue-pagination

6eb17a9

hschallhorn commented May 11, 2020

View reviewed changes

hschallhorn and others added 11 commits May 11, 2020 18:23

Move pagination option parsing into queue table builder

9bb778d

Fix js test

9d04534

Fix tests

aa99bda

Merge branch 'master' into hschallhorn/14142-user-queue-pagination

82590b1

List and test fix

9aea0a9

Merge branch 'hschallhorn/14142-user-queue-pagination' of https://git…

b46a11e

…hub.com/department-of-veterans-affairs/caseflow into hschallhorn/14142-user-queue-pagination

Do not paginate attorney or judge queues

99a85ae

Remove tests

d794622

Merge branch 'master' into hschallhorn/14142-user-queue-pagination

8d7d82e

Test fix

e0fbe61

Merge branch 'master' into hschallhorn/14142-user-queue-pagination

0ad1143

hschallhorn commented May 12, 2020

View reviewed changes

Remove unused

56e9531

hschallhorn commented May 12, 2020

View reviewed changes

hschallhorn closed this May 12, 2020

hschallhorn deleted the hschallhorn/14142-user-queue-pagination branch May 15, 2020 14:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add pagination to user queues #14242

Add pagination to user queues #14242

hschallhorn commented May 11, 2020 •

edited

codeclimate bot commented May 11, 2020 •

edited

hschallhorn May 11, 2020 •

edited

hschallhorn May 11, 2020

hschallhorn May 11, 2020

hschallhorn May 11, 2020

hschallhorn May 11, 2020

hschallhorn May 11, 2020

hschallhorn May 11, 2020

hschallhorn May 11, 2020

hschallhorn May 11, 2020

hschallhorn May 11, 2020

hschallhorn May 11, 2020

hschallhorn May 11, 2020

hschallhorn May 11, 2020

hschallhorn May 11, 2020

hschallhorn May 11, 2020

hschallhorn May 11, 2020

hschallhorn May 11, 2020

hschallhorn May 11, 2020

hschallhorn May 11, 2020

hschallhorn May 11, 2020

hschallhorn May 11, 2020

hschallhorn May 12, 2020

hschallhorn May 12, 2020

hschallhorn May 12, 2020

hschallhorn May 12, 2020 •

edited

hschallhorn May 12, 2020

hschallhorn May 12, 2020

hschallhorn May 12, 2020

hschallhorn commented May 12, 2020

	def create
	return invalid_type_error unless task_classes_valid?

	tasks = []
	param_groups = create_params.group_by { \|param\| param[:type] }
	param_groups.each do \|task_type, param_group\|
	tasks << valid_task_classes[task_type.to_sym].create_many_from_params(param_group, current_user)
	end
	modified_tasks = [parent_tasks_from_params, tasks].flatten!

	tasks_to_return = (QueueForRole.new(user_role).create(user: current_user).tasks + modified_tasks).uniq

	render json: { tasks: json_tasks(tasks_to_return) }

	def update
	tasks = task.update_from_params(update_params, current_user)
	tasks.each { \|t\| return invalid_record_error(t) unless t.valid? }

	tasks_to_return = (QueueForRole.new(user_role).create(user: current_user).tasks + tasks).uniq

	render json: { tasks: json_tasks(tasks_to_return) }
	end

Add pagination to user queues #14242

Add pagination to user queues #14242

Conversation

hschallhorn commented May 11, 2020 • edited

Description

Acceptance Criteria

Testing Plan

User Facing Changes

codeclimate bot commented May 11, 2020 • edited

hschallhorn May 11, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hschallhorn May 12, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hschallhorn commented May 12, 2020

hschallhorn commented May 11, 2020 •

edited

codeclimate bot commented May 11, 2020 •

edited

hschallhorn May 11, 2020 •

edited

hschallhorn May 12, 2020 •

edited