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

akonhilas/APPEALS-34880 #19947

Merged
merged 6 commits into from
Nov 14, 2023
Merged

Conversation

konhilas-ariana
Copy link
Contributor

@konhilas-ariana konhilas-ariana commented Nov 14, 2023

Resolves Webex Services Fails to Handles Both Virtual Hearings and Hearing Days

https://jira.devops.va.gov/browse/APPEALS-34880

Description

Daily docket page presents a 500 error. This is due to a failure that occurs whenever attempting to generate Webex conference links for the hearing day.

Acceptance Criteria

  • Code compiles correctly

Testing Plan

  1. Go to https://jira.devops.va.gov/browse/APPEALS-34885
  • For feature branches merging into master: Was this deployed to UAT?

Backend

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?

@konhilas-ariana konhilas-ariana changed the base branch from master to feature/APPEALS-26734 November 14, 2023 18:43
Copy link

codeclimate bot commented Nov 14, 2023

Code Climate has analyzed commit 0916f7f and detected 17 issues on this pull request.

Here's the issue category breakdown:

Category Count
Duplication 4
Complexity 10
Style 3

View more on Code Climate.

@konhilas-ariana konhilas-ariana marked this pull request as ready for review November 14, 2023 20:33
Copy link
Contributor

@ThorntonMatthew ThorntonMatthew left a comment

Choose a reason for hiding this comment

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

THANK YOU!!

@ThorntonMatthew ThorntonMatthew merged commit e01a021 into feature/APPEALS-26734 Nov 14, 2023
12 of 14 checks passed
@ThorntonMatthew ThorntonMatthew deleted the akonhilas/APPEALS-34880 branch November 14, 2023 21:10
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.

2 participants