-
Notifications
You must be signed in to change notification settings - Fork 495
fix: enforce upper bound on history_length #1177
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
Open
ez-lbz
wants to merge
2
commits into
a2aproject:main
Choose a base branch
from
ez-lbz:fix/history-length-upper-bound
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+120
−1
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,6 +10,17 @@ | |
| from a2a.utils.errors import InvalidParamsError | ||
|
|
||
|
|
||
| MAX_HISTORY_LENGTH = 1000 | ||
| """Maximum allowed value for a ``history_length`` request. | ||
|
|
||
| Keeps a single request from asking the server to materialize an | ||
| unbounded history (e.g. ``historyLength=999999999``). The value is a | ||
| pragmatic cap aligned with the other A2A SDKs' semantics, where very | ||
| large values effectively mean "return everything available"; clients | ||
| requesting more than this cap get ``InvalidParamsError``. | ||
| """ | ||
|
|
||
|
|
||
| @runtime_checkable | ||
| class HistoryLengthConfig(Protocol): | ||
| """Protocol for configuration arguments containing history_length field.""" | ||
|
|
@@ -25,9 +36,13 @@ def HasField(self, field_name: Literal['history_length']) -> bool: # noqa: N802 | |
|
|
||
|
|
||
| def validate_history_length(config: HistoryLengthConfig | None) -> None: | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The PR description states that right now server "allowing an unbounded-history read via an absurdly large parameter", but the change into validate_history_length doesn't affect this, full task history will still be loaded in memory. example on_get_task: |
||
| """Validates that history_length is non-negative.""" | ||
| """Validates that history_length is non-negative and within limits.""" | ||
| if config and config.history_length < 0: | ||
| raise InvalidParamsError(message='history length must be non-negative') | ||
| if config and config.history_length > MAX_HISTORY_LENGTH: | ||
| raise InvalidParamsError( | ||
| message=f'history length must be at most {MAX_HISTORY_LENGTH}' | ||
| ) | ||
|
|
||
|
|
||
| def apply_history_length( | ||
|
|
||
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
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
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
Oops, something went wrong.
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 was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd avoid setting MAX_HISTORY_LENGTH just as a global constant. If this change lands it should be configurable, opt-in, with None default and set by some server config