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

fix: return internal errors as structured error responses #5159

Merged
merged 6 commits into from
May 15, 2024

Conversation

BrynCooke
Copy link
Contributor

When an http 500 is returned we should not return the details of the error to the client.
Instead, they are now logged at ERROR level.

In addition, the error is now returned as a graphql error rather than a plaintext error. This gives a better experience in sandbox.


Checklist

Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.

  • Changes are compatible1
  • Documentation2 completed
  • Performance impact assessed and acceptable
  • Tests added and passing3
    • Unit Tests
    • Integration Tests
    • Manual Tests

Exceptions

Note any exceptions here

Notes

Footnotes

  1. It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this.

  2. Configuration is an important part of many changes. Where applicable please try to document configuration examples.

  3. Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions.

When an http 500 is returned we should not return the details to the client. Instead, they are now logged.

This comment has been minimized.

@router-perf
Copy link

router-perf bot commented May 13, 2024

CI performance tests

  • step - Basic stress test that steps up the number of users over time
  • events_big_cap_high_rate_callback - Stress test for events with a lot of users, deduplication enabled and high rate event with a big queue capacity using callback mode
  • large-request - Stress test with a 1 MB request payload
  • events - Stress test for events with a lot of users and deduplication ENABLED
  • xxlarge-request - Stress test with 100 MB request payload
  • events_without_dedup - Stress test for events with a lot of users and deduplication DISABLED
  • xlarge-request - Stress test with 10 MB request payload
  • step-jemalloc-tuning - Clone of the basic stress test for jemalloc tuning
  • events_callback - Stress test for events with a lot of users and deduplication ENABLED in callback mode
  • no-graphos - Basic stress test, no GraphOS.
  • reload - Reload test over a long period of time at a constant rate of users
  • events_big_cap_high_rate - Stress test for events with a lot of users, deduplication enabled and high rate event with a big queue capacity
  • events_without_dedup_callback - Stress test for events with a lot of users and deduplication DISABLED using callback mode
  • const - Basic stress test that runs with a constant number of users

@BrynCooke BrynCooke changed the title Prevent internal server error from leaking details to the client Internal server error handling May 13, 2024
@BrynCooke BrynCooke requested review from garypen and abernix May 13, 2024 20:57
@Geal
Copy link
Contributor

Geal commented May 14, 2024

that's a great idea

@abernix abernix changed the title Internal server error handling fix: return internal errors as structured error responses May 14, 2024
@BrynCooke BrynCooke enabled auto-merge (squash) May 15, 2024 08:53
@BrynCooke BrynCooke merged commit 1186d3e into dev May 15, 2024
13 of 14 checks passed
@BrynCooke BrynCooke deleted the bryn/internal_server_error branch May 15, 2024 09:14
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.

None yet

5 participants