aedara/APPEALS-27848 Fix Deprecation Warning: The success? predicate is deprecated and will be removed in Rails 6.0

[AnandEdara]

Resolves APPEALS-27848

Description

Background

Deprecation Warning

DEPRECATION WARNING: The success? predicate is deprecated and will be removed in Rails 6.0. Please use successful? as provided by Rack::Response::Helpers.

Deprecation Horizon: Rails 6.0

References

See Rails commit where this deprecation was removed. It appears that only test code is affected:

Remove deprecated methods in ActionDispatch::TestResponse
#success?, missing? and error? were deprecated in Rails 5.2 in favor of #successful?, not_found? and server_error?.

Acceptance Criteria

• Code compiles correctly

Testing Plan

1. Go to Jira Issue/Test Plan Link or list them below

Local Development Environment

Allowed Deprecation Warning does NOT raise exception

• From local development Rails console, manually issue a test deprecation warning

ActiveSupport::Deprecation.warn("whatever")

• Confirm that an exception is NOT raised

Disallowed Deprecation Warning raises exception

• From local development Rails console, manually issue the deprecation warning

ActiveSupport::Deprecation.warn("The success? predicate is deprecated and will be removed in Rails 6.0")

• Confirm that exception DisallowedDeprecationError is raised

CI / Test Environment

Deprecation Warning is no longer emitted

• Confirm that all relevant specs pass:
  • spec/requests/health_checks_spec.rb

UAT

• From the caseflow UAT Rails console, manually issue the deprecation warning

ActiveSupport::Deprecation.warn("The success? predicate is deprecated and will be removed in Rails 6.0")

• Check Sentry for Caseflow UAT and confirm that an issue for DEPRECATION WARNING: The success? predicate is deprecated and will be removed in Rails 6.0 [...] was created
• Check Sentry for Caseflow UAT and confirm that an issue for exception DisallowedDeprecationError was NOT created
• Check the DSVA Slack channel #appeals-deprecation-alerts and confirm that a new alert was created for DEPRECATION WARNING: The success? predicate is deprecated and will be removed in Rails 6.0 [...]

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]

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

View more on Code Climate.

[jcroteau]

🎈