feat(flowcontrol): refine types and consolidate docs #1191
Merged
Conversation
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
✅ Deploy Preview for gateway-api-inference-extension ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
k8s-ci-robot
added
the
cncf-cla: yes
|
Hi @LukeAVanDrie. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
k8s-ci-robot
added
needs-ok-to-test
This commit improves the foundational `types` package by consolidating documentation and adding a safer default enum value in preparation for the new `FlowController` implementation. It also removes concepts related to displacement, which are out of scope for the initial release. Key changes: - The package-level `README.md` has been removed. Its content is now in a comprehensive GoDoc package comment in `doc.go`. This addresses reviewer feedback to co-locate documentation with the code it describes, reducing maintenance burden and preventing doc drift. - The package documentation has been rewritten to tell a clearer architectural narrative, explaining the request lifecycle through the lens of the `EnqueueAndWait` model. - The `ErrDisplaced` error and `QueueOutcomeEvictedDisplaced` outcome have been removed to align the types with the GA feature set. - A new `QueueOutcomeNotYetFinalized` enum value has been added. This serves as a safer, explicit zero-value for the `QueueOutcome` type, which is used by the new `ShardProcessor` to represent the initial state of a request before its lifecycle is complete.
LukeAVanDrie
force-pushed
the
feat/flow-control-types
branch
from
def65e8 to
40d9d21
Compare
|
/ok-to-test |
k8s-ci-robot
added
ok-to-test
|
No logic changes in this PR, all changes are comments and docs /lgtm |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ahg-g, LukeAVanDrie The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
kfswain
pushed a commit
to kfswain/llm-instance-gateway
that referenced
this pull request
Jul 31, 2025
This commit improves the foundational `types` package by consolidating documentation and adding a safer default enum value in preparation for the new `FlowController` implementation. It also removes concepts related to displacement, which are out of scope for the initial release. Key changes: - The package-level `README.md` has been removed. Its content is now in a comprehensive GoDoc package comment in `doc.go`. This addresses reviewer feedback to co-locate documentation with the code it describes, reducing maintenance burden and preventing doc drift. - The package documentation has been rewritten to tell a clearer architectural narrative, explaining the request lifecycle through the lens of the `EnqueueAndWait` model. - The `ErrDisplaced` error and `QueueOutcomeEvictedDisplaced` outcome have been removed to align the types with the GA feature set. - A new `QueueOutcomeNotYetFinalized` enum value has been added. This serves as a safer, explicit zero-value for the `QueueOutcome` type, which is used by the new `ShardProcessor` to represent the initial state of a request before its lifecycle is complete.
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.
This PR improves the
pkg/epp/flowcontrol/typespackage. It is a preparatory step that cleans up and refines our core data contracts before the mainFlowControllerengine logic is introduced.This change directly addresses previous reviewer feedback regarding documentation, co-locating it with the code to improve maintainability and prevent documentation drift.
This work tracks #674
Key Changes
Consolidated Documentation: The package-level
README.mdhas been removed, and its content has been migrated into a comprehensive GoDoc package comment (doc.go). The narrative has been rewritten to tell a clearer architectural story, explaining the request lifecycle through the lens of theEnqueueAndWaitmodel.Scoped feature set for GA: The
ErrDisplacederror andQueueOutcomeEvictedDisplacedoutcome have been removed. This aligns thetypespackage with the planned feature set for the initial release and follows the YAGNI principle. These types will be reintroduced in the future PR that implements the displacement feature itself.Safer Enum Zero-Value: A new
QueueOutcomeNotYetFinalizedenum value has been added. This serves as a safer, explicit zero-value for theQueueOutcometype. It prevents the default state of a new request item from being misinterpreted as a valid final outcome (e.g.,Dispatched), making the internal state machine more robust.Next Steps
Once this is merged, it unblocks the subsequent PR which will introduce the
FlowController'sShardProcessor.