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

[FEA] Forbidding use of unsafe APIs #11369

Open
jihoonson opened this issue Aug 20, 2024 · 0 comments
Open

[FEA] Forbidding use of unsafe APIs #11369

jihoonson opened this issue Aug 20, 2024 · 0 comments
Labels
reliability Features to improve reliability or bugs that severly impact the reliability of the plugin tech debt

Comments

@jihoonson
Copy link
Collaborator

Is your feature request related to a problem? Please describe.

Not all APIs from the libraries we use are best-suited to our use case. Some are designed rather for other use cases. Some are simply designed badly. These APIs are considered as "unsafe" as they require us to pay more attention when using them. Wrong use of those APIs would introduce nasty bugs, which would not be caught during the build or the test but only after thorough debugging. An example of such bugs can be found in #11364. I was only able to locate the bug after executing the code line by line during the whole query processing. We should be able to avoid such issues in the first place, so that we could spend our time on more interesting problems.

Describe the solution you'd like

We could forbid use of such APIs if they are considered unsafe for our use case. With the forbidden API checker, we could register unsafe APIs, so that use of them would be caught during the build. In case we have to use unsafe APIs, we would have to explicitly skip the checker at certain lines. A downside is that the build time may increase.

Describe alternatives you've considered
I am not sure if there are alternatives besides just being careful when using them, which is what we do today.

@jihoonson jihoonson added feature request New feature or request ? - Needs Triage Need team to review and classify labels Aug 20, 2024
@sameerz sameerz added reliability Features to improve reliability or bugs that severly impact the reliability of the plugin tech debt and removed feature request New feature or request ? - Needs Triage Need team to review and classify labels Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
reliability Features to improve reliability or bugs that severly impact the reliability of the plugin tech debt
Projects
None yet
Development

No branches or pull requests

2 participants