Fix ProtocolCodeBasedDecoder memory leak

JoeCqupt commented 3 months ago

reproduce code

    @Test
    public void testDecodeIllegalPacket2() {
        EmbeddedChannel channel = new EmbeddedChannel();
        ProtocolCodeBasedDecoder decoder = new ProtocolCodeBasedDecoder(1);
        channel.pipeline().addLast(decoder);

        ByteBuf byteBuf = ByteBufAllocator.DEFAULT.buffer(8);
        byteBuf.writeByte((byte) 13);

        int readerIndex = byteBuf.readerIndex();

        Assert.assertEquals(0, readerIndex);
        Exception exception = null;
        try {
            channel.writeInbound(byteBuf);
        } catch (Exception e) {
            // ignore
            exception = e;
        }
        Assert.assertNotNull(exception);
        Assert.assertTrue(byteBuf.refCnt() == 0);
    }

when ProtocolCodeBasedDecoder#decode() throw exception . ByteBuf param not released

Summary by CodeRabbit

New Features
- Enhanced error handling for decoding processes, improving robustness against unexpected input.
- Introduced a new test case to improve coverage for decoder interactions with illegal packets.
Bug Fixes
- Ensured consistent state of the buffer after exception handling during decoding operations.

coderabbitai[bot] commented 3 months ago

Walkthrough

The changes enhance the error handling and readability of the decode method in the ProtocolCodeBasedDecoder class. Key improvements include restructuring the try-finally block for better buffer index management and adding explicit checks for null protocol objects. The test suite for the decoder is also strengthened with new tests that confirm proper behavior when illegal packets are processed, ensuring robust performance under error conditions.

Changes

Files	Change Summary
`src/main/java/com/alipay/remoting/codec/ProtocolCodeBasedDecoder.java` `src/test/java/com/alipay/remoting/codec/ProtocolCodeBasedDecoderTest.java`	The decoder's `decode` method is modified for improved error handling and clarity, with added checks for null protocol objects. The test suite is updated with enhanced tests to validate decoder behavior for illegal packets, including checks on `ByteBuf` state.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Decoder
    participant ByteBuf

    Client->>Decoder: Send data
    Decoder->>ByteBuf: Process data
    ByteBuf->>Decoder: Check for errors
    alt No error
        Decoder->>Client: Return decoded data
    else Error occurred
        ByteBuf->>Decoder: Reset reader index
        Decoder->>Client: Throw CodecException
    end

🐇 Through the code, we hop and play,
With tweaks that brighten the day!
Errors handled, tests anew,
Our decoder shines, it’s tried and true!
So let’s all cheer, hip-hip-hooray!
For robust code that’s here to stay! 🎉

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

JoeCqupt commented 3 months ago

这个CI好像有问题，线下跑的单测一点问题没有，CI跑就报错线下：

CI： https://github.com/sofastack/sofa-bolt/actions/runs/10111851447/job/27964641532?pr=355#step:5:1442

funky-eyes commented 3 months ago

这个CI好像有问题，线下跑的单测一点问题没有，CI跑就报错线下： CI： https://github.com/sofastack/sofa-bolt/actions/runs/10111851447/job/27964641532?pr=355#step:5:1442

我跟你有相同的问题

JoeCqupt commented 3 months ago

@chuailiwu

OrezzerO commented 2 months ago

Hi, @JoeCqupt , I doubt if it is a bug of bolt. ByteBuf will be released at channelInactive method. I think you need to check in what condition (such as you encounter an exception when decoding but not close the connection ) you did not invoke this method.

JoeCqupt commented 2 months ago

Hi, @JoeCqupt , I doubt if it is a bug of bolt. ByteBuf will be released at channelInactive method. I think you need to check in what condition (such as you encounter an exception when decoding but not close the connection ) you did not invoke this method.

yep. you are right. This modification is optional

sofastack / sofa-bolt