Add UnexpectedServerException for centralized server error handling by CodeByAfroj · Pull Request #13740 · TEAMMATES/teammates

CodeByAfroj · 2026-04-06T19:12:51Z

Outline of Solution

This PR introduces a new UnexpectedServerException to handle unexpected server-side errors in a centralized way.

Changes made:

Added a new custom exception UnexpectedServerException
Mapped it to HTTP 500 in WebApiServlet
Replaced direct JsonResult(..., HttpStatus.SC_INTERNAL_SERVER_ERROR) returns with throwing UnexpectedServerException in CreateAccountAction

Rationale:

Previously, some parts of the code returned HTTP 500 responses directly when unexpected checked exceptions occurred. This bypassed the centralized error handling in WebApiServlet.

This change ensures:

Centralized error handling
Consistent HTTP 500 responses
Cleaner and more maintainable code

Testing:

Verified that the flow still returns HTTP 500
Confirmed errors are handled via WebApiServlet

Replaced JsonResult error handling with UnexpectedServerException for better error management.

Added handling for UnexpectedServerException in WebApiServlet.

github-actions · 2026-04-06T19:13:06Z

Hi @CodeByAfroj, thank you for your interest in contributing to TEAMMATES!
However, your PR does not appear to follow our contributing guidelines:

Title must start with the issue number the PR is fixing in square brackets, e.g. [#<issue-number>]

Please address the above before we proceed to review your PR.

CodeByAfroj · 2026-04-06T19:14:13Z

Hi, I’ve submitted a PR for this issue. Please review it.

Changed UnexpectedServerException to extend RuntimeException instead of Exception.

Added a comment to clarify the purpose of the exception.

iZUMi-kyouka · 2026-04-06T20:51:32Z

src/main/java/teammates/ui/webapi/CreateAccountAction.java

        } catch (InvalidParametersException | EntityAlreadyExistsException | EntityDoesNotExistException e) {
            // There should not be any invalid parameter or entity conflict here
            log.severe("Unexpected error", e);
-            return new JsonResult(e.getMessage(), HttpStatus.SC_INTERNAL_SERVER_ERROR);


I believe this is not the only place this occurrence of returning a JsonResult with the HTTP 500 directly. For one, UnpublishFeedbackSessionAction has one of this instance.

Thanks for giving me a feedback . I will Do the required changes ASAP.

@CodeByAfroj

Please check the codebase for ALL instances of directly returning the error. You can try searching for the pattern e.g. the log.severe part or the return new JsonResult part. One example: teammates/ui/webapi/JoinCourseAction.java:58

Thanks for the suggestion! Give me some time i will fix it ASAP.

iZUMi-kyouka · 2026-04-06T20:52:30Z

src/main/java/teammates/ui/webapi/CreateAccountAction.java

@@ -73,7 +74,7 @@ public JsonResult execute() throws InvalidHttpRequestBodyException, InvalidOpera
        } catch (InvalidParametersException | EntityAlreadyExistsException | EntityDoesNotExistException e) {
            // There should not be any invalid parameter or entity conflict here
            log.severe("Unexpected error", e);


I suppose these logs were initially there because we bypassed the centralised error handling, which will otherwise have logged this unexpected error.

These redundant log.severe calls should be removed too since the centralised error handling already logs the error.

I got this and thanks again , I will fix them .

iZUMi-kyouka · 2026-04-06T20:53:57Z

Hi @CodeByAfroj, thank you for your interest in contributing to TEAMMATES! However, your PR does not appear to follow our contributing guidelines:
* Title must start with the issue number the PR is fixing in square brackets, e.g. `[#<issue-number>]`
Please address the above before we proceed to review your PR.

Please address this too @CodeByAfroj

Updated UnexpectedServerException to include error message.

CodeByAfroj · 2026-04-07T11:41:28Z

Hi, I have addressed all the feedback and ensured that all checks are passing now. Kindly review.

CodeByAfroj · 2026-04-08T19:28:04Z

I Have gone through the All project files and changed the return format according to your expectations please review and let me know , if there any feedback .

iZUMi-kyouka · 2026-04-09T04:55:55Z

src/main/java/teammates/ui/servlets/WebApiServlet.java

-            log.severe(e.getClass().getSimpleName() + " caught by WebApiServlet: " + e.getMessage(), e);
-            throwError(resp, statusCode, e.getMessage());
+            String message;
+            if (e.getMessage() != null && !e.getMessage().isEmpty()) {


Should use StringHelper.isEmpty instead

iZUMi-kyouka · 2026-04-09T04:58:28Z

src/main/java/teammates/ui/webapi/JoinCourseAction.java

        } catch (InvalidParametersException ipe) {
-            // There should not be any invalid parameter here
            log.severe("Unexpected error", ipe);
            return new JsonResult(ipe.getMessage(), HttpStatus.SC_INTERNAL_SERVER_ERROR);


Changes not done? Please do not remove comments.

Thank you so much for your feedback, I wiil respond you ASAP. Your feedback really helping me

CodeByAfroj · 2026-04-09T13:33:46Z

I have made the changes please review and let me know if any suggessions

CodeByAfroj · 2026-04-11T17:34:38Z

i have correct all the changes please review

iZUMi-kyouka · 2026-04-12T06:21:54Z

Are you using an IDE to make the fix? JoinCourseAction still needs this fix. @CodeByAfroj

CodeByAfroj · 2026-04-12T08:55:35Z

Are you using an IDE to make the fix? JoinCourseAction still needs this fix. @CodeByAfroj
I am only using the vs code editor , I got this , I try to fix it

CodeByAfroj · 2026-04-12T10:59:41Z

Are you using an IDE to make the fix? JoinCourseAction still needs this fix. @CodeByAfroj

this action returns a JsonResult as expected , But for previous Actions they directly throwing Some different exceptions, so we made a custom exception.Now for this action Changing it to throw UnexpectedServerException causes test failures, so I have retained the current behavior here.

CodeByAfroj added 3 commits April 7, 2026 00:13

Add UnexpectedServerException class

45247cb

Improve error handling in CreateAccountAction

0dd5de4

Replaced JsonResult error handling with UnexpectedServerException for better error management.

Handle UnexpectedServerException in WebApiServlet

494f9ad

Added handling for UnexpectedServerException in WebApiServlet.

CodeByAfroj added 5 commits April 7, 2026 01:43

Refactor UnexpectedServerException to extend RuntimeException

b4d0129

Changed UnexpectedServerException to extend RuntimeException instead of Exception.

Fix exception handling by re-adding UnexpectedServerException

67fb289

Update WebApiServlet.java

16335ce

Change UnexpectedServerException to extend RuntimeException

57f216f

Add documentation comment for UnexpectedServerException

f8de9a8

Added a comment to clarify the purpose of the exception.

iZUMi-kyouka requested changes Apr 6, 2026

View reviewed changes

CodeByAfroj added 6 commits April 7, 2026 02:46

Improve error handling in WebApiServlet

27f9d97

Enhance error handling in CreateAccountAction

e61ed39

Updated UnexpectedServerException to include error message.

Update UnpublishFeedbackSessionAction.java

1499a25

Refactor error message handling in WebApiServlet

c57b60d

Update UnpublishFeedbackSessionAction.java

6d13d68

Update WebApiServlet.java

64c4b06

CodeByAfroj added 11 commits April 8, 2026 19:49

Changed All The log.severe to UnexpectedServerException class

b64c47f

Changed All The log.severe to UnexpectedServerException class

0a20175

changed to previous httpStatus

07822a3

corrected JoinCourseAction

147d369

Fix JoinCourseAction exception handling correctly

4c98926

Fix JoinCourseAction exception handling correctly

13c1beb

Fix JoinCourseAction exception handling correctly

744b06e

Fix JoinCourseAction exception handling correctly

3db65b1

Fix JoinCourseAction exception handling correctly

5093668

Preserve original exception behavior in JoinCourseAction

70621fc

Fix InvalidParametersException handling in JoinCourseAction

4810157

CodeByAfroj added 3 commits April 8, 2026 23:30

Fix InvalidParametersException handling in JoinCourseAction

95dd346

Fix InvalidParametersException handling in JoinCourseAction

6dce74a

Merge branch 'master' into fix/unexpected-server-exception

9fe528b

iZUMi-kyouka requested changes Apr 9, 2026

View reviewed changes

CodeByAfroj added 6 commits April 9, 2026 18:00

Address reviewer comments (StringHelper + restore comments)

b20e422

Address reviewer comments (StringHelper + restore comments)

30d040d

Adressed All Errors

fbeb8be

Adressed All Errors

54b9d94

Adressed All Errors

4adeb8e

Adressed All Errors

5b64455

Merge branch 'master' into fix/unexpected-server-exception

2d1f76e

Update the JoinCousrseAction FIle

0882502

CodeByAfroj added 4 commits April 12, 2026 16:35

Retained the same behaviour

801c7c5

Retained the same behaviour

886b3b9

Retained the same behaviour

8f31652

Merge branch 'master' into fix/unexpected-server-exception

15e8af1

Conversation

CodeByAfroj commented Apr 6, 2026

Changes made:

Rationale:

Testing:

Uh oh!

github-actions bot commented Apr 6, 2026

Uh oh!

CodeByAfroj commented Apr 6, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iZUMi-kyouka Apr 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iZUMi-kyouka commented Apr 6, 2026

Uh oh!

CodeByAfroj commented Apr 7, 2026

Uh oh!

CodeByAfroj commented Apr 8, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CodeByAfroj commented Apr 9, 2026

Uh oh!

CodeByAfroj commented Apr 11, 2026

Uh oh!

iZUMi-kyouka commented Apr 12, 2026

Uh oh!

CodeByAfroj commented Apr 12, 2026

Uh oh!

CodeByAfroj commented Apr 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

iZUMi-kyouka Apr 6, 2026 •

edited

Loading