Fix: sendResponse if RpcRequestProcessor.doProcess throw Throwable #334

JoeCqupt · 2023-12-14T08:35:51Z

Fix: sendResponse if RpcRequestProcessor.doProcess throw Throwable in ProcessTask

reproduce problem

class ExceptionTest

 @Test
    public void testGetBizClassLoaderException1() {
        server.registerUserProcessor(new SimpleServerUserProcessor() {
            @Override
            public ClassLoader getBizClassLoader() {
                throw new RuntimeException("getBizClassLoader fail.");
            }
        });

        RequestBody req = new RequestBody(4, "hello world");
        try {
            client.invokeSync(addr, req, 3000);
        } catch (InvokeServerException e) {
            Assert.assertTrue(true);
        } catch (RemotingException e) {
            String errMsg = "RemotingException in testGetBizClassLoaderException1";
            logger.error(errMsg);
            Assert.fail(errMsg);
        } catch (InterruptedException e) {
            String errMsg = "InterruptedException caught in testGetBizClassLoaderException1";
            logger.error(errMsg, e);
            Assert.fail(errMsg);
        }
    }

we except get InvokeServerException when userProcessor.getBizClassLoader throw exception.
but we get InvokeTimeoutException

The Reason

https://github.com/sofastack/sofa-bolt/blob/master/src/main/java/com/alipay/remoting/rpc/protocol/RpcRequestProcessor.java#L395

RpcRequestProcessor#ProcessTask did not handle Throwable.

Summary by CodeRabbit

Refactor
- Improved the error logging mechanism for enhanced clarity and consistency in handling RPC requests.
Tests
- Added tests for handling exceptions when accessing the business class loader, ensuring robust error management.

… ProcessTask

JoeCqupt · 2023-12-14T08:47:43Z

PTAL @OrezzerO @nobodyiam

JoeCqupt · 2023-12-14T18:29:29Z

I try to explore why .

maybe this comment show the reason :

https://github.com/sofastack/sofa-bolt/blob/master/src/main/java/com/alipay/remoting/rpc/protocol/RpcCommandHandler.java#L163

but

I still think sending an ack response is necessary way of handling exceptions
Duplicate ack responses will be ignored by the client

nobodyiam · 2023-12-18T01:12:32Z

I agree a clear response is necessary way of handling exceptions. @chuailiwu would you please help to take a look?

src/test/java/com/alipay/remoting/rpc/exception/ExceptionTest.java

OrezzerO · 2024-03-30T16:49:13Z

Do agree that a clear response is necessary.

As the comment said Other exceptions should be processed where exception was caught, because here we don't known whether ack had been sent back, I think it's fine to handle exception in ProcessTask.run, if they are throw to ProcessTask.run ,which means they are not handled in inner methods.

coderabbitai · 2024-04-01T04:09:35Z

Walkthrough

The recent update focuses on refining the error logging mechanism within the RpcRequestProcessor's run method, enhancing both clarity and consistency. Additionally, a new method, sendResponseIfNecessary, has been introduced to better manage exceptions. In the testing domain, a new method, testGetBizClassLoaderException1, has been added to scrutinize different exception scenarios related to the business class loader, further fortifying the robustness of exception handling.

Changes

Files	Change Summaries
`.../rpc/protocol/RpcRequestProcessor.java`	Refactored error logging, added `sendResponseIfNecessary` method for exception scenarios.
`.../rpc/exception/ExceptionTest.java`	Added `testGetBizClassLoaderException1` for testing RuntimeException scenarios in class loading.

🐰✨
In the land of code, where the binaries roam,
Changes were made, in the processor's home.
"Log the errors," the Rabbit decreed,
And test the exceptions, for quality we need.
With a hop and a skip, the updates were done,
In the quest for stability, another victory won.
🌟📜🐾

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 2

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 829be55 and 2bc30fb.

Files selected for processing (2)

src/main/java/com/alipay/remoting/rpc/protocol/RpcRequestProcessor.java (1 hunks)
src/test/java/com/alipay/remoting/rpc/exception/ExceptionTest.java (1 hunks)

Additional Context Used

Additional comments not posted (1)

src/main/java/com/alipay/remoting/rpc/protocol/RpcRequestProcessor.java (1)

398-402: The error handling and response sending logic in the ProcessTask's run method has been updated to ensure that a response is sent back in case of exceptions. This change aligns with the PR objectives and improves the robustness of the error handling mechanism. However, consider adding more context to the error message, such as the type of exception caught, to aid in debugging.

coderabbitai · 2024-04-01T04:11:11Z

src/test/java/com/alipay/remoting/rpc/exception/ExceptionTest.java

+
+        RequestBody req = new RequestBody(4, "hello world");
+        try {
+            client.invokeSync(addr, req, 3000);


To ensure the test fails if client.invokeSync does not throw an exception, add Assert.fail(); after this line. This change makes the test's intention clearer and ensures it properly fails when the expected exception is not thrown.

+ Assert.fail("Expected InvokeServerException was not thrown.");

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

client.invokeSync(addr, req, 3000);

client.invokeSync(addr, req, 3000);

Assert.fail("Expected InvokeServerException was not thrown.");

coderabbitai · 2024-04-01T04:11:11Z

src/test/java/com/alipay/remoting/rpc/exception/ExceptionTest.java

+            logger.error(errMsg);
+            Assert.fail(errMsg);
+        } catch (InvokeServerException e) {
+            Assert.assertTrue(true);


The assertion Assert.assertTrue(true); is redundant and does not contribute to the test's effectiveness. Consider removing it or replacing it with a more meaningful assertion, such as checking the message or type of the caught exception if applicable.

- Assert.assertTrue(true);

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

Assert.assertTrue(true);

coderabbitai

Actionable comments posted: 1

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 2bc30fb and 32d7b4a.

Files selected for processing (1)

src/test/java/com/alipay/remoting/rpc/exception/ExceptionTest.java (1 hunks)

src/test/java/com/alipay/remoting/rpc/exception/ExceptionTest.java

OrezzerO

LGTM

…ofastack#334) * fix: sendResponse if RpcRequestProcessor.doProcess throw Throwable in ProcessTask * update unit test * update unit test

sofastack-cla bot added bug Something isn't working cla:yes First-time contributor size/M labels Dec 14, 2023

fix: sendResponse if RpcRequestProcessor.doProcess throw Throwable in…

ecab9fe

… ProcessTask

JoeCqupt force-pushed the master branch from 7c00f3d to ecab9fe Compare December 14, 2023 08:44

OrezzerO reviewed Mar 30, 2024

View reviewed changes

src/test/java/com/alipay/remoting/rpc/exception/ExceptionTest.java Outdated Show resolved Hide resolved

src/test/java/com/alipay/remoting/rpc/exception/ExceptionTest.java Outdated Show resolved Hide resolved

update unit test

2bc30fb

coderabbitai bot reviewed Apr 1, 2024

View reviewed changes

update unit test

32d7b4a

coderabbitai bot reviewed Apr 8, 2024

View reviewed changes

src/test/java/com/alipay/remoting/rpc/exception/ExceptionTest.java Show resolved Hide resolved

OrezzerO approved these changes Apr 12, 2024

View reviewed changes

chuailiwu merged commit 0d576a6 into sofastack:master Apr 16, 2024
3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: sendResponse if RpcRequestProcessor.doProcess throw Throwable #334

Fix: sendResponse if RpcRequestProcessor.doProcess throw Throwable #334

JoeCqupt commented Dec 14, 2023 •

edited by coderabbitai bot

JoeCqupt commented Dec 14, 2023 •

edited

JoeCqupt commented Dec 14, 2023 •

edited

nobodyiam commented Dec 18, 2023

OrezzerO commented Mar 30, 2024

coderabbitai bot commented Apr 1, 2024 •

edited

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot Apr 1, 2024

coderabbitai bot Apr 1, 2024

coderabbitai bot left a comment

OrezzerO left a comment

	client.invokeSync(addr, req, 3000);
	client.invokeSync(addr, req, 3000);
	Assert.fail("Expected InvokeServerException was not thrown.");

Fix: sendResponse if RpcRequestProcessor.doProcess throw Throwable #334

Fix: sendResponse if RpcRequestProcessor.doProcess throw Throwable #334

Conversation

JoeCqupt commented Dec 14, 2023 • edited by coderabbitai bot

reproduce problem

The Reason

Summary by CodeRabbit

JoeCqupt commented Dec 14, 2023 • edited

JoeCqupt commented Dec 14, 2023 • edited

nobodyiam commented Dec 18, 2023

OrezzerO commented Mar 30, 2024

coderabbitai bot commented Apr 1, 2024 • edited

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Apr 1, 2024

Choose a reason for hiding this comment

coderabbitai bot Apr 1, 2024

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

OrezzerO left a comment

Choose a reason for hiding this comment

JoeCqupt commented Dec 14, 2023 •

edited by coderabbitai bot

JoeCqupt commented Dec 14, 2023 •

edited

JoeCqupt commented Dec 14, 2023 •

edited

coderabbitai bot commented Apr 1, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)