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

Documentation: clarify the threading model #312

Open
chibenwa opened this issue Dec 16, 2024 · 0 comments
Open

Documentation: clarify the threading model #312

chibenwa opened this issue Dec 16, 2024 · 0 comments

Comments

@chibenwa
Copy link

Issue description

CF linagora/tmail-backend#1247

Got my ass kicked today diagnoising an unresponsive Apisix plugin when the underlying Redis is down.

By instinct I pushed the team to use a non blocking apprach as it leads to better resource management.

But digging more I discovered the code actually runs directly on the netty event loop. This means that any blocking IOs would cause the plugin to stop progress.

While I'm very happy the plugin runs directly Netty (performance!) this should be better documented, and also I do believe the examples should include an asynchronous example. Most of the devs around do not have the culture to understand the danger and need strong guidance. Busy tech leaders need a clear succinct statement to orientate code review and catch defects early.

I would happily propose myself to write this doc!

Environment

  • your apisix-java-plugin-runner version : 4.0

Minimal test code / Steps to reproduce the issue

Code snippet: https://github.com/linagora/tmail-backend/tree/master/demo/apisix/tmail-apisix-plugin-runner

Reactified version: linagora/tmail-backend#1412

What's the expected result?

Doc and example being clear enough so that no other team ever do the mistakes mine did!

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

No branches or pull requests

1 participant