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

hotfix/APPEALS-27124: Add Support for "derived" destination_type for "ro-colocated" PacMan Recipients #19095

Merged
merged 22 commits into from
Aug 8, 2023

Conversation

ThorntonMatthew
Copy link
Contributor

@ThorntonMatthew ThorntonMatthew commented Jul 31, 2023

Resolves APPEALS-27124

Description

Updates to table schemas have been made to allow for null address_line_1 column values to accommodate the derived destination type (Pacman will get the address of the regional office via the claimant_station_of_jurisdiction value).

Acceptance Criteria

  • Code compiles correctly
  • Update the null constraints on the following tables for their address_line_1 columns to allow for null values:
    • public.vbms_distribution_destinations
    • caseflow_audit.vbms_distribution_destinations

Testing Plan

  1. Go to APPEALS-27121
  • For feature branches merging into master: Was this deployed to UAT?

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

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 Jul 31, 2023

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

View more on Code Climate.

@ThorntonMatthew ThorntonMatthew marked this pull request as ready for review August 1, 2023 02:14
@ThorntonMatthew ThorntonMatthew changed the base branch from master to feature/APPEALS-25109 August 1, 2023 19:50
@ThorntonMatthew ThorntonMatthew changed the base branch from feature/APPEALS-25109 to master August 1, 2023 19:50
@ThorntonMatthew ThorntonMatthew merged commit 03625dc into master Aug 8, 2023
11 of 14 checks passed
@ThorntonMatthew ThorntonMatthew deleted the hotfix/APPEALS-27124 branch August 8, 2023 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants