Refactor Katib Context Management: Replace context.TODO() with Propagated context.Context#2649
Open
invo-coder19 wants to merge 1 commit intokubeflow:masterfrom
Open
Refactor Katib Context Management: Replace context.TODO() with Propagated context.Context#2649invo-coder19 wants to merge 1 commit intokubeflow:masterfrom
invo-coder19 wants to merge 1 commit intokubeflow:masterfrom
Conversation
|
🎉 Welcome to the Kubeflow Katib repo! 🎉 Thanks for opening your first PR! We're excited to have you onboard 🚀 Next steps:
Feel free to ask questions in the comments. Thanks again for contributing! 🙏 |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
There are ~30 instances in production code (excluding tests and generated files) where context.TODO() is used as a placeholder. This is not suitable for production, as it prevents proper context propagation, including cancellation, deadlines, and request-scoped values.
In controller logic, the reconciler already receives a context.Context via:
Reconcile(ctx context.Context, ...)
However, this context was not consistently passed down through the call chain and into Kubernetes API calls.
Changes
Replaced all occurrences of context.TODO() in production code with the appropriate propagated ctx.
Ensured the ctx received in Reconcile is threaded through all downstream function calls.
Updated Kubernetes client/API calls to use the propagated context.
Benefits
Enables proper cancellation and timeout handling.
Aligns with Go best practices for context usage.
Improves observability and tracing capabilities.
Removes placeholder code that could lead to unintended behavior in production.