Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding unique key for child instance #19378

Merged
merged 13 commits into from
Oct 3, 2023
Merged

adding unique key for child instance #19378

merged 13 commits into from
Oct 3, 2023

Conversation

pamatyatake2
Copy link
Contributor

@pamatyatake2 pamatyatake2 commented Sep 6, 2023

Resolves APPEALS-29283

Description

Added key on different Page Route to remove the warning.

Acceptance Criteria

  • Code compiles correctly
  • Warning: Each child in a list should have a unique "key" prop. should not be present.
  • All the links should work as expected.

Testing Plan

  1. Go to Jira Issue/Test Plan Link or list them below
  2. login as ACBAUERVVHAH, redirect to localhost:3000.
  3. Press F12 and check in console and see if you are still seeing - '"Warning: Each child in a list should have a unique 'key' prop."
  4. check all links are working as expected.
  • For feature branches merging into master: 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

  • Add typical timestamps (created_at, updated_at) for new tables
  • Update column comments; include a "PII" prefix to indicate definite or potential PII data content
  • Have your migration classes inherit from Caseflow::Migration, especially when adding indexes (use add_safe_index) (see Writing DB migrations)
  • Verify that migrate:rollback works as desired (change supported functions)
  • Perform query profiling (eyeball Rails log, check bullet and fasterer output)
  • For queries using raw sql was an explain plan run by System Team
  • Add appropriate indexes (especially for foreign keys, polymorphic columns, unique constraints, and Rails scopes)
  • Run make check-fks; add any missing foreign keys or add to config/initializers/immigrant.rb (see Record associations and Foreign Keys)
  • Add belongs_to for associations to enable the schema diagrams to be automatically updated
  • Document any non-obvious semantics or logic useful for interpreting database data at Caseflow Data Model and Dictionary

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
Copy link

codeclimate bot commented Sep 6, 2023

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

View more on Code Climate.

@pamatyatake2 pamatyatake2 added Stakeholder: VHA Functionality associated with Veterans Health Administration workflows/feature requests Team: Titan A development team for the VHA business line ART: VHA labels Sep 11, 2023
@pamatyatake2 pamatyatake2 marked this pull request as ready for review September 11, 2023 16:02
Copy link
Contributor

@TylerBroyles TylerBroyles left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Just noticed a couple of variables that could be using single quotes instead of double quotes. The replace function could also be pulled out to a utilities file, since its' the exact same regex and replace value repeated in a lot of different spots.

@@ -8,39 +8,49 @@ import { DocketSwitchRulingContainer } from './judgeRuling/DocketSwitchRulingCon
import { DocketSwitchDenialContainer } from './denial/DocketSwitchDenialContainer';
import { DocketSwitchGrantContainer } from './grant/DocketSwitchGrantContainer';

const basePath = "/queue/appeals/:appealId/tasks/:taskId";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const basePath = "/queue/appeals/:appealId/tasks/:taskId";
const basePath = '/queue/appeals/:appealId/tasks/:taskId';

@@ -38,35 +38,42 @@ const RoutedReturnToLitSupport = (props) => {
);
};

const basePath = `/queue/appeals/:appealId/tasks/:taskId`;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const basePath = `/queue/appeals/:appealId/tasks/:taskId`;
const basePath = '/queue/appeals/:appealId/tasks/:taskId';

@@ -6,7 +6,7 @@ import { EditCavcRemandContainer } from './editCavcRemandContainer';
const basePath = '/queue/appeals/:appealId/edit_cavc_remand';

const PageRoutes = [
<PageRoute path={basePath} title="Edit Cavc Remand | Caseflow">
<PageRoute path={basePath} title="Edit Cavc Remand | Caseflow" key={basePath.replace(/[^\w\s]/gi, '_')} >
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could pull this replace out to a helper function in a utils file since it is used across all these different files and routes.

Copy link
Contributor

@TylerBroyles TylerBroyles left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@craigrva craigrva merged commit 36ff4fa into master Oct 3, 2023
15 checks passed
@craigrva craigrva deleted the pamatya/APPEALS-29283 branch October 3, 2023 19:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ART: VHA Stakeholder: VHA Functionality associated with Veterans Health Administration workflows/feature requests Team: Titan A development team for the VHA business line
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants