[PART 1] Add task pagination endpoint for user tasks #14252

hschallhorn · 2020-05-12T18:03:32Z

THIS PR

Part 1 of stack to speed up user queues and bump #14142
Part 2

Description

Creates an endpoint to request the paged tasks of a user

AC

Tests pass (no visible changes)

Testing

# Log in as a colocated user
user = User.find_by_css_id("BVALSPORER")
FeatureToggle.enable!(:user_queue_pagination, users: [user.css_id])
User.authentication_service = Fakes::AuthenticationService
User.authentication_service.user_session = User.authentication_service.get_user_session(user.id)

# Create some tasks for them
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

# Get set up to make some requests!
app.get '/'
csrf=app.session.to_hash["_csrf_token"]
base_url = "/users/#{user.id}/task_pages?authenticity_token=#{CGI.escape csrf}&"

# Base request for assigned tasks
params = "tab=assigned_person"
app.get "#{base_url}#{params}"
response_body = JSON.parse(app.response.body); nil
response_body["tasks"]["data"].count
=> 15 # May be different for you but should be no higher than 15
response_body["total_task_count"].eql? Task.active.where(assigned_to: user).count
=> true

# on hold tasks
params = "tab=on_hold_person"
app.get "#{base_url}#{params}"
response_body = JSON.parse(app.response.body); nil
response_body["tasks"]["data"].count
=> 15
response_body["total_task_count"].eql? Task.on_hold.where(assigned_to: user).count
=> true

# sorted tasks
params = "tab=on_hold_person&sort_by=taskColumn"
app.get "#{base_url}#{params}"
response_body = JSON.parse(app.response.body); nil
tasks = response_body["tasks"]["data"]; nil
tasks.map { |task| task["attributes"]["type"] }
=> ["AddressVerificationColocatedTask",
 "AddressVerificationColocatedTask",
 "AddressVerificationColocatedTask",
 "AddressVerificationColocatedTask",
 "AddressVerificationColocatedTask",
 "ExtensionColocatedTask",
 "ExtensionColocatedTask",
 "ExtensionColocatedTask",
 "ExtensionColocatedTask",
 "ExtensionColocatedTask",
 "HearingClarificationColocatedTask",
 "HearingClarificationColocatedTask",
 "HearingClarificationColocatedTask",
 "HearingClarificationColocatedTask",
 "HearingClarificationColocatedTask"]


# paged sorted tasks
params = "tab=on_hold_person&sort_by=taskColumn&page=2"
app.get "#{base_url}#{params}"
response_body = JSON.parse(app.response.body); nil
tasks = response_body["tasks"]["data"]; nil
tasks.map { |task| task["attributes"]["type"] }
=> ["IhpColocatedTask",
 "IhpColocatedTask",
 "IhpColocatedTask",
 "IhpColocatedTask",
 "IhpColocatedTask",
 "NewRepArgumentsColocatedTask",
 "NewRepArgumentsColocatedTask",
 "NewRepArgumentsColocatedTask",
 "NewRepArgumentsColocatedTask",
 "NewRepArgumentsColocatedTask",
 "RetiredVljColocatedTask",
 "RetiredVljColocatedTask",
 "RetiredVljColocatedTask",
 "RetiredVljColocatedTask",
 "RetiredVljColocatedTask"]

# Filtered tasks
params = "tab=on_hold_person&filter%5B%5D=col%3DtaskColumn%26val%3DIhpColocatedTask"
app.get "#{base_url}#{params}"
response_body = JSON.parse(app.response.body); nil
tasks = response_body["tasks"]["data"]; nil
tasks.map { |task| task["attributes"]["type"] }.uniq
=> ["IhpColocatedTask"]

THE FULL STACK

spoilers!

Part 2 of stack to bump #14142 [Part 1](https://github.com//pull/14252)

Description

Allows user queues to be paginated

Testing

Log in as BVALSPORER
Pad your queue with some tasks

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

Enable pagination

FeatureToggle.enable!(:user_queue_pagination, users: ["BVALSPORER"])

Test Pagination!

Initial queue load only loads first page of tasks

With dev tools open, got to the user's queue

This request for tasks only returns the first 15 tasks for each tab.
total_task_count and task_page_count are correct
This request does not return all tasks assigned to the user in tasks: { data: [] }

Filtering, sorting, paging, and switching tabs work

Try a combination of filtering and sorting to confirm the correct tasks are show. Bonus points for trying the same combination more than once and noticing the loading page is not shown because we're pulling from cached results. Each request should only return 15 tasks.

Sorting

Sorting on a column
- Displays the tasks in the correct order
- Affects tasks on higher number pages
- Updates the address bar to show sorting (confirm this url is correct by bookmarking this page and clicking the bookmark. It should show the same order of tasks and the correct indicator of which column is being sorted http://localhost:3000/queue?tab=assigned_person&page=2&sort_by=taskColumn&order=desc)

Filtering

Filtering on a column
- Displays the correctly filtered tasks
- Affects tasks on higher number pages
- Updates the address bar to show filtering (confirm this url is correct by bookmarking this page and clicking the bookmark. It should show the same filtered tasks and the correct indicator of which column is being filtered http://localhost:3000/queue?tab=on_hold_person&page=2&filter%5B%5D=col%3DtaskColumn%26val%3DAddressVerificationColocatedTask%7CExtensionColocatedTask%7CHearingClarificationColocatedTask%7CIhpColocatedTask)

Paging

Going to a new page
- Preserves any filtering
- Preserves any sorting
- Displays the correct "showing tasks x of xx"
- Updates the address bar to show paging (confirm this url is correct by bookmarking this page and clicking the bookmark. It should show the same page of tasks and the correct page indicator http://localhost:3000/queue?tab=on_hold_person&page=2)

Changing tabs

Changing tabs
- Changes the tab (I ddon't know what you expected here
- Updates the address bar to show the updated tab (confirm this url is correct by bookmarking this page and clicking the bookmark. It should show the same tab of tasks and the correct tab indicator http://localhost:3000/queue?tab=on_hold_person&page=1)

Any combinations of the above

THINGS THAT SHOULD NOT HAVE CHANGED

The appearance and functionality of attorney queues

BEFORE	AFTER

The appearance and functionality of judge queues

BEFORE	AFTER

The appearance and functionality of organization queues

BEFORE	AFTER

codeclimate · 2020-05-12T18:09:08Z

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

View more on Code Climate.

hschallhorn · 2020-05-12T18:10:25Z

app/controllers/concerns/task_pagination_concern.rb

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


Pulled out of app/controllers/organizations/task_pages_controller.rb to be reused in app/controllers/users/task_pages_controller.rb

hschallhorn · 2020-05-12T18:10:42Z

app/models/organization.rb

-  def ama_task_serializer
-    WorkQueue::TaskSerializer
-  end
-


Pulled out here: https://github.com/department-of-veterans-affairs/caseflow/pull/14252/files#diff-75cb7aca7b3d8d599db00de89371bff9R38

hschallhorn · 2020-05-12T18:10:57Z

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}"


URL the front end will use to request paged tasks

hschallhorn · 2020-05-12T18:16:09Z

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'


New route for the pagination of user tasks

hschallhorn · 2020-05-12T19:31:34Z

spec/controllers/organizations/task_pages_controller_spec.rb

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


Pulled out into spec/controllers/paged_tasks_shared_examples.rb

…rt-1

yoomlam

Left some suggestions.

Also manually tested:

the sum of tasks.count equals the response_body["total_task_count"]
other filters work
bad filter returns empty list

app/controllers/users_controller.rb

app/controllers/users/task_pages_controller.rb

spec/controllers/paged_tasks_shared_examples.rb

spec/models/task_pager_spec.rb

…rt-1

yoomlam

Good to go! 🥇

…rt-1

va-bot · 2020-05-15T14:29:16Z

	1 Warning
⚠️	This is a Big PR. Try to break this down if possible. Stacked pull requests encourage more detailed and thorough code reviews

Generated by 🚫 Danger

Add task pagination endpoint for user tasks

27d78c2

hschallhorn commented May 12, 2020

View reviewed changes

hschallhorn mentioned this pull request May 12, 2020

[PART 2] Allow user queues to be paginated #14253

Merged

32 tasks

hschallhorn and others added 5 commits May 12, 2020 16:48

Fix tests

320a08c

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

57bea1e

…rt-1

Add tests!

f953efb

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

7d82126

…rt-1

Remove test that doesnt even run

19ed556

hschallhorn self-assigned this May 12, 2020

yoomlam reviewed May 13, 2020

View reviewed changes

hschallhorn and others added 2 commits May 14, 2020 12:44

Feedback!

f9ab9a5

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

3ec5607

…rt-1

yoomlam approved these changes May 15, 2020

View reviewed changes

hschallhorn added 2 commits May 15, 2020 10:26

Allow user queues to be paginated (#14253)

99928e0

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

b9cf987

…rt-1

hschallhorn added the Ready-to-Merge This PR is ready to be merged and will be picked up by va-bot to automatically merge to master label May 15, 2020

va-bot merged commit 7270430 into master May 15, 2020

va-bot deleted the hschallhorn/14142-user-queue-pagination-part-1 branch May 15, 2020 14:55

This was referenced Sep 29, 2020

Fix missing Legacy cases after case is signed #13872

Closed

Fix missing AMA cases after case is put on hold #13664

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[PART 1] Add task pagination endpoint for user tasks #14252

[PART 1] Add task pagination endpoint for user tasks #14252

hschallhorn commented May 12, 2020 •

edited by yoomlam

Loading

codeclimate bot commented May 12, 2020 •

edited

Loading

hschallhorn May 12, 2020

hschallhorn May 12, 2020

hschallhorn May 12, 2020

hschallhorn May 12, 2020

hschallhorn May 12, 2020

yoomlam left a comment

yoomlam left a comment

va-bot commented May 15, 2020

[PART 1] Add task pagination endpoint for user tasks #14252

[PART 1] Add task pagination endpoint for user tasks #14252

Conversation

hschallhorn commented May 12, 2020 • edited by yoomlam Loading

THIS PR

Description

AC

Testing

THE FULL STACK

Description

Testing

Initial queue load only loads first page of tasks

Filtering, sorting, paging, and switching tabs work

Sorting

Filtering

Paging

Changing tabs

Any combinations of the above

THINGS THAT SHOULD NOT HAVE CHANGED

codeclimate bot commented May 12, 2020 • edited Loading

hschallhorn May 12, 2020

Choose a reason for hiding this comment

hschallhorn May 12, 2020

Choose a reason for hiding this comment

hschallhorn May 12, 2020

Choose a reason for hiding this comment

hschallhorn May 12, 2020

Choose a reason for hiding this comment

hschallhorn May 12, 2020

Choose a reason for hiding this comment

yoomlam left a comment

Choose a reason for hiding this comment

yoomlam left a comment

Choose a reason for hiding this comment

va-bot commented May 15, 2020

hschallhorn commented May 12, 2020 •

edited by yoomlam

Loading

codeclimate bot commented May 12, 2020 •

edited

Loading