Skip to content

fix: validate JSON-RPC params#155

Merged
guglielmo-san merged 12 commits into
a2aproject:mainfrom
guglielmo-san:implement_check_on_params
Oct 30, 2025
Merged

fix: validate JSON-RPC params#155
guglielmo-san merged 12 commits into
a2aproject:mainfrom
guglielmo-san:implement_check_on_params

Conversation

@guglielmo-san

@guglielmo-san guglielmo-san commented Oct 30, 2025

Copy link
Copy Markdown
Member

Description

This PR introduces checks on the params received on the request, according to the specifications.
This change allows to pass the tck mandatory test.

Thank you for opening a Pull Request!
Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Follow the CONTRIBUTING Guide.
  • Make your Pull Request title in the https://www.conventionalcommits.org/ specification.
    • Important Prefixes for release-please:
      • fix: which represents bug fixes, and correlates to a SemVer patch.
      • feat: represents a new feature, and correlates to a SemVer minor.
      • feat!:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a SemVer major.
  • Ensure the tests and linter pass
  • Appropriate docs were updated (if necessary)

Fixes #154 🦕

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @guglielmo-san, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the JsonRpcTransportHandler by implementing stricter validation for the params field in incoming JSON-RPC requests. The update ensures that params adheres to the expected structure of an object with non-empty string keys, thereby improving the robustness of the API and ensuring compliance with TCK specifications. This prevents malformed requests from being processed, leading to more predictable and secure behavior.

Highlights

  • Parameter Validation: Introduced robust validation for the params field in JSON-RPC requests, ensuring it is a valid object with non-empty string keys.
  • New Utility Method: Added a private isParamsValid method to JsonRpcTransportHandler to encapsulate the new parameter validation logic.
  • Test Coverage: Expanded test suite with new cases to verify correct error handling for invalid params types (string, array) and objects with empty string keys, as well as confirming valid object params are processed correctly.
  • TCK Compliance: This change specifically addresses and allows the passing of a mandatory TCK test related to JSON-RPC compliance.
Ignored Files
  • Ignored by pattern: .github/workflows/** (1)
    • .github/workflows/unit-tests.yml
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@guglielmo-san guglielmo-san changed the title Implement check on params fix: implement check on params Oct 30, 2025
@guglielmo-san guglielmo-san requested a review from ishymko October 30, 2025 10:01

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces validation for the params field in JSON-RPC requests to ensure it's a non-array object with non-empty keys, which aligns with the TCK tests. The implementation is correct, and new tests are added to cover the validation logic. I have a few suggestions to improve the code:

  • The error message for invalid params could be more descriptive.
  • The new validation function can be made more concise.
  • The new tests have some duplication that can be removed by using parameterized tests.

Overall, this is a good change that improves the robustness of the request handling.

Comment thread src/server/transports/jsonrpc_transport_handler.ts Outdated
Comment thread src/server/transports/jsonrpc_transport_handler.ts Outdated
Comment thread test/server/jsonrpc_transport_handler.spec.ts Outdated
guglielmo-san and others added 2 commits October 30, 2025 11:13
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Comment thread src/server/transports/jsonrpc_transport_handler.ts Outdated
Comment thread src/server/transports/jsonrpc_transport_handler.ts Outdated
Comment thread src/server/transports/jsonrpc_transport_handler.ts Outdated
Comment thread test/server/jsonrpc_transport_handler.spec.ts Outdated
@guglielmo-san guglielmo-san requested a review from ishymko October 30, 2025 10:57
@ishymko ishymko changed the title fix: implement check on params fix: validate JSON-RPC params Oct 30, 2025
@guglielmo-san guglielmo-san merged commit 5b39f4d into a2aproject:main Oct 30, 2025
4 checks passed
@guglielmo-san guglielmo-san deleted the implement_check_on_params branch October 30, 2025 11:30
ishymko pushed a commit that referenced this pull request Nov 5, 2025
🤖 I have created a release *beep* *boop*
---


## [0.3.5](v0.3.4...v0.3.5)
(2025-11-05)


### Bug Fixes

* cancel/task now returns the expected 'cancelled' task status
([#158](#158))
([3eec0bd](3eec0bd))
* correct the default value in the agentCardPath comment
([#130](#130))
([3279c7b](3279c7b))
* enable follow up task issue on non blocking request
([#160](#160))
([352dc05](352dc05))
* ensure push notifications order
([#141](#141))
([22360e6](22360e6))
* ensure user messages are added to existing tasks
([#138](#138))
([00fb916](00fb916))
* validate JSON-RPC params
([#155](#155))
([5b39f4d](5b39f4d))
* validate JSON-RPC request id according to the spec
([#152](#152))
([9558c36](9558c36))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
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

Successfully merging this pull request may close these issues.

[Bug]: Check the format of params

2 participants