Skip to content

[Improvement] Handle /configs servlet write failures with explicit HTTP 500 #10268

@justinmclean

Description

@justinmclean

What would you like to be improved?

ConfigServlet#doGet catches IllegalStateException, IOException, and generic Exception but only logs them. It does not set an error status or return an error payload. If res.getWriter() or response writing fails (for example due to client disconnect or output stream failure), the endpoint can fail silently, leaving clients with an aborted/partial response and no explicit server-side HTTP failure signal.

How should we improve?

In ConfigServlet#doGet, when any exception occurs during response generation, set HttpServletResponse.SC_INTERNAL_SERVER_ERROR and return a small JSON error body (or at minimum set the status). Keep logging with exception context.

Here's a unit test to help:

  @Test
  public void testDoGetShouldSetInternalServerErrorWhenGetWriterFails() throws Exception {
    ConfigServlet configServlet = new ConfigServlet(new ServerConfig());
    HttpServletResponse response = mock(HttpServletResponse.class);
    when(response.getWriter()).thenThrow(new IOException("broken output stream"));

    configServlet.doGet(null, response);

    verify(response).setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
  }

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions