Al/appeals 45664 #23279

pamatyatake2 · 2024-10-18T15:49:24Z

Resolves APPEALS-45664

Description

Please explain the changes you made here.

Added new saved_searches_controller.rb and its actions. index, show, delete and create.
Added test for the controller -> saved_searches_controller_spec.rb
Added Serializer for saved_search
Added two scopes in model to get the data from the backend.
added a method to validate if its a VHA_ADMIN
Added template files for index and show.

Acceptance Criteria

Code compiles correctly
Handle saving of new saved search
Handle deletion of saved search
Validation to ensure user can only delete their own Saved Search, not other users'
Make index to return all Saved Searches
Make action to return saved searches for a specific user
Need validation to ensure User is a VHA admin

Testing Plan

In Ruby Console:

FactoryBot.create_list(:saved_search, 10)

user = User.find_by_css_id("VHAADMIN")
# use VHAADMIN as a user when getting the set-cookie from the browser or 
# change VHAADMIN to any VHA admin that you use
FactoryBot.create_list(:saved_search, 5, user: user)

Go to Jira Issue/Test Plan Link or list them below
You can use postman to test the functionality.
login to postman, copy set-cookie from the browser and paste it in POSTMAN.
access -> GET: localhost:3000/saved_searches.json -> this should return all the saved search for all user.
GET: localhost:3000/saved_searches/:id -> this should only return single saved search based on the id.
POST: localhost:3000/saved_searches/ -> this should create a new saved search
DELETE: localhost:3000/saved_searches/:id. > Thi should delete a saved search for that user.

Tester can use Postman using this link with pre-saved URL endpoint criteria to ease help with testing.

In order to make an API call tester needs to capture _caseflow_session from the Chrome browser after logging in through the frontend with the type of user they want to test the endpoint with e.g vha admin

For feature branches merging into main: Was this deployed to UAT?

Frontend

User Facing Changes

Screenshots of UI changes added to PR & Original Issue

BEFORE	AFTER

Storybook Story

For Frontend (Presentation) Components

Add a Storybook file alongside the component file (e.g. create MyComponent.stories.js alongside MyComponent.jsx)
Give it a title that reflects the component's location within the overall Caseflow hierarchy
Write a separate story (within the same file) for each discrete variation of the component

Backend

Database Changes

Only for Schema Changes

Integrations: Adding endpoints for external APIs

Check that Caseflow's external API code for the endpoint matches the code in the relevant integration repo
- Request: Service name, method name, input field names
- Response: Check expected data structure
- Check that calls are wrapped in MetricService record block
Check that all configuration is coming from ENV variables
- Listed all new ENV variables in description
- Worked with or notified System Team that new ENV variables need to be set
Update Fakes
For feature branches: Was this tested in Caseflow UAT

Best practices

Code Documentation Updates

Add or update code comments at the top of the class, module, and/or component.

Tests

Test Coverage

Did you include any test coverage for your code? Check below:

RSpec
Jest
Other

Code Climate

Your code does not add any new code climate offenses? If so why?

No new code climate issues added

Monitoring, Logging, Auditing, Error, and Exception Handling Checklist

Monitoring

Are performance metrics (e.g., response time, throughput) being tracked?
Are key application components monitored (e.g., database, cache, queues)?
Is there a system in place for setting up alerts based on performance thresholds?

Logging

Are logs being produced at appropriate log levels (debug, info, warn, error, fatal)?
Are logs structured (e.g., using log tags) for easier querying and analysis?
Are sensitive data (e.g., passwords, tokens) redacted or omitted from logs?
Is log retention and rotation configured correctly?
Are logs being forwarded to a centralized logging system if needed?

Auditing

Are user actions being logged for audit purposes?
Are changes to critical data being tracked ?
Are logs being securely stored and protected from tampering or exposing protected data?

Error Handling

Are errors being caught and handled gracefully?
Are appropriate error messages being displayed to users?
Are critical errors being reported to an error tracking system (e.g., Sentry, ELK)?
Are unhandled exceptions being caught at the application level ?

Exception Handling

Are custom exceptions defined and used where appropriate?
Is exception handling consistent throughout the codebase?
Are exceptions logged with relevant context and stack trace information?
Are exceptions being grouped and categorized for easier analysis and resolution?

codeclimate · 2024-10-18T15:59:36Z

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

View more on Code Climate.

…lizer

TylerBroyles

Looks good. I left a lot of comments around around naming conventions and small things like that so if you have any questions let me know.

TylerBroyles · 2024-10-24T17:05:02Z

client/app/nonComp/pages/SavedSearches.jsx

@@ -18,19 +18,19 @@ const SavedSearches = () => {

  const ALL_TABS = [
    {
-      key: 'my_saved_searches',


I wouldn't bother doing any minor tweaks to the javascript files in this PR that really only affect mocked data. Let's just keep it all backend.

@pamatyatake2 let revert this change here

app/controllers/saved_searches_controller.rb

app/models/saved_search.rb

TylerBroyles · 2024-10-24T17:30:17Z

app/models/saved_search.rb

@@ -7,6 +7,10 @@ class SavedSearch < CaseflowRecord
  validates :description, presence: true, length: { maximum: 1000 }
  validate :saved_search_limit

+  scope :all_saved_searches, -> { order(created_at: :desc) }
+
+  scope :my_saved_searches, ->(user) { where(user_id: user).order(created_at: :desc) }


Active record is smart enough to realize that user_id is a foreign key and automatically transform user -> user.id, but I think it's probably better to make it more explicit in the scope. You can also chain scopes and if you keep the other scope you should chain it here instead of repeating .order(created_at: :desc). This is also why I don't think the name makes much sense when you look at it written out like this.

Suggested change

scope :my_saved_searches, ->(user) { where(user_id: user).order(created_at: :desc) }

scope :my_saved_searches, ->(user) { where(user: user).all_saved_searches }

app/controllers/saved_searches_controller.rb

app/views/saved_searches/index.html.erb

app/controllers/saved_searches_controller.rb

TylerBroyles

Looks good overall. I noticed a couple of small things around the index/show html methods and some cleanup that we might want to address.

TylerBroyles · 2024-10-25T17:47:55Z

app/models/saved_search.rb

@@ -7,6 +7,9 @@ class SavedSearch < CaseflowRecord
  validates :description, presence: true, length: { maximum: 1000 }
  validate :saved_search_limit

+  # Ex:- scope :active, -> {where(:active => true)}


Suggested change

# Ex:- scope :active, -> {where(:active => true)}

TylerBroyles · 2024-10-25T17:55:30Z

app/serializers/saved_search_serializer.rb

+  attribute :userCssId do |object|
+    object.user.css_id
+  end
+  attribute :userFullName do |object|


These will error if there is no user. I would group them up as a user attribute. It would be similar to how the task serializer handles it's assigned to relationship. It's just an example so that the frontend redux store will be able to look for user attributes like this savedSearch.user.cssId

# Example assigned_to from task serializer attribute :assigned_to do |object| assignee = object.try(:unscoped_assigned_to) { css_id: assignee.try(:css_id), full_name: assignee.try(:full_name), is_organization: assignee.is_a?(Organization), name: assignee.is_a?(Organization) ? assignee.name : assignee.css_id, status: assignee.try(:status), type: assignee.class.name, id: assignee.id } end

TylerBroyles · 2024-10-25T18:02:18Z

app/controllers/saved_searches_controller.rb

+  private
+
+  def organization
+    @organization ||= BusinessLine.find_by(url: params[:decision_review_business_line_slug])


The decision_review_business_line_slug is not included in any of your routes so it's not going to know what this :decision_review_business_line_slug param is. It would have to be using the :business_line_slug param from the routes.
Something like this might work

@organization ||= Organization.find_by(url: params[:business_line_slug] || params[:organization_slug])

app/views/saved_searches/index.html.erb

app/views/saved_searches/show.html.erb

TylerBroyles · 2024-10-25T18:16:34Z

spec/controllers/saved_searches_controller_spec.rb

+# frozen_string_literal: true
+
+describe SavedSearchesController, :postgres, type: :controller do
+  let(:user) { create(:user, :vha_admin_user, :with_saved_search_reports) }


I think the :vha_admin_user trait already creates adds the user to the VhaBusienssLine so you probably don't have to add it later non_comp_org.add_user(user)

TylerBroyles · 2024-10-25T18:27:38Z

spec/controllers/saved_searches_controller_spec.rb

+  let(:non_comp_org) { VhaBusinessLine.singleton }
+
+  let(:default_user) { create(:user) }
+  let(:vha_business_line) { VhaBusinessLine.singleton }


vha_business_line and non_comp_org can probably be combined into one variable since they are doing the same thing.

TylerBroyles · 2024-10-25T18:28:14Z

spec/controllers/saved_searches_controller_spec.rb

+      }
+    end
+
+    context "VHA user creating saved search" do


Suggested change

context "VHA user creating saved search" do

context "VHA admin user creating saved search" do

TylerBroyles · 2024-10-25T18:28:24Z

spec/controllers/saved_searches_controller_spec.rb

+      end
+    end
+
+    context "VHA user saved search not exists" do


Suggested change

context "VHA user saved search not exists" do

context "VHA admin user saved search not exists" do

TylerBroyles · 2024-10-25T18:32:19Z

config/routes.rb

@@ -308,6 +308,7 @@
  get '/remands(/*path)', to: redirect('/supplemental_claims/%{path}')

  resources :decision_reviews, param: :business_line_slug do
+    resources :saved_searches, only: [:index, :create, :destroy, :show]


This still does not match the current SavedSearches page url which is /decision_reviews/business_line_slug/report/searches. This route would match /decision_reviews/business_line_slug/searches. Is that the intention?

TylerBroyles

I noticed one last thing, but that should be it.

TylerBroyles · 2024-10-26T00:40:02Z

app/serializers/saved_search_serializer.rb

+class SavedSearchSerializer
+  include FastJsonapi::ObjectSerializer
+
+  attribute :name


We probably also need to serialize the id since that will be what we are sending back to the backend when we are deleting a saved search.

almorbah and others added 2 commits October 17, 2024 14:21

added controller actions and routes

1362d80

Merge branch 'feature/APPEALS-45267' into Al/APPEALS-45664

09786a0

almorbah and others added 9 commits October 21, 2024 12:11

added action logic

e2a783a

adding index for the controller, modificaiton in the routes and seria…

abda93f

…lizer

added spes tests

e94b7ea

spec for index, show and controller

359e869

Merge branch 'feature/APPEALS-45267' into Al/APPEALS-45664

66d4b4c

fixing the linter and frontend error

7442c91

serializer spec for saved_search

1f2bc1b

linter fix

05602da

adding show template

010e3c8

pamatyatake2 added Stakeholder: VHA Functionality associated with Veterans Health Administration workflows/feature requests ruby Pull requests that update Ruby code ART: VHA Saved Search - Reassign cases to camo Team: Titan A development team for the VHA business line labels Oct 23, 2024

almorbah marked this pull request as ready for review October 24, 2024 14:02

TylerBroyles changed the base branch from main to feature/APPEALS-45267 October 24, 2024 14:39

brandondorner and others added 2 commits October 24, 2024 11:08

Merge branch 'feature/APPEALS-45267' into Al/APPEALS-45664

58b2926

renamed saved search factory file

1db4af5

TylerBroyles requested changes Oct 24, 2024

View reviewed changes

almorbah and others added 8 commits October 24, 2024 17:34

made changes to PR feedback

b91c2ff

changed routes setup

edc3462

fixing the route and pr comments

cd81930

fixing spec tests and linting errors

60c0d75

linting errors

2870721

fixing the failed tests

8009c08

fixing spec tests

f762d04

making linter happy

e9c9a48

brandondorner previously approved these changes Oct 25, 2024

View reviewed changes

TylerBroyles requested changes Oct 25, 2024

View reviewed changes

pamatyatake2 dismissed brandondorner’s stale review via cd81930 October 25, 2024 20:04

TylerBroyles requested changes Oct 26, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Al/appeals 45664 #23279

Al/appeals 45664 #23279

pamatyatake2 commented Oct 18, 2024 •

edited by TylerBroyles

Loading

codeclimate bot commented Oct 18, 2024 •

edited

Loading

TylerBroyles left a comment

TylerBroyles Oct 24, 2024

almorbah Oct 24, 2024

TylerBroyles Oct 24, 2024

TylerBroyles left a comment

TylerBroyles Oct 25, 2024

TylerBroyles Oct 25, 2024

TylerBroyles Oct 25, 2024

TylerBroyles Oct 25, 2024

TylerBroyles Oct 25, 2024

TylerBroyles Oct 25, 2024

TylerBroyles Oct 25, 2024

TylerBroyles Oct 25, 2024

TylerBroyles left a comment

TylerBroyles Oct 26, 2024

	scope :my_saved_searches, ->(user) { where(user_id: user).order(created_at: :desc) }
	scope :my_saved_searches, ->(user) { where(user: user).all_saved_searches }

	context "VHA user creating saved search" do
	context "VHA admin user creating saved search" do

	context "VHA user saved search not exists" do
	context "VHA admin user saved search not exists" do

Al/appeals 45664 #23279

Are you sure you want to change the base?

Al/appeals 45664 #23279

Conversation

pamatyatake2 commented Oct 18, 2024 • edited by TylerBroyles Loading

Description

Acceptance Criteria

Testing Plan

Frontend

User Facing Changes

Storybook Story

Backend

Database Changes

Integrations: Adding endpoints for external APIs

Best practices

Code Documentation Updates

Tests

Test Coverage

Code Climate

Monitoring, Logging, Auditing, Error, and Exception Handling Checklist

Monitoring

Logging

Auditing

Error Handling

Exception Handling

codeclimate bot commented Oct 18, 2024 • edited Loading

TylerBroyles left a 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

TylerBroyles left a 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

TylerBroyles left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pamatyatake2 commented Oct 18, 2024 •

edited by TylerBroyles

Loading

codeclimate bot commented Oct 18, 2024 •

edited

Loading