Skip to content

fix: ensure push notifications order#141

Merged
guglielmo-san merged 17 commits into
a2aproject:mainfrom
guglielmo-san:fix_flacky_tests
Oct 29, 2025
Merged

fix: ensure push notifications order#141
guglielmo-san merged 17 commits into
a2aproject:mainfrom
guglielmo-san:fix_flacky_tests

Conversation

@guglielmo-san

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

Copy link
Copy Markdown
Member

Description

This PR introduces a promise chain (this.notificationChain) to serialize the batches of notifications. This ensures that only one batch at a time is processed, in a predictable First-In, First-Out (FIFO) order. The test was already ensuring it and it caused some flakiness before, examples:

The push_notification_integration.spec.ts test file has been modified to simulate a more deterministic delay (100ms) on the completion of the first received notification. This guarantee a 100% test failure when the notification serialization is not implemented.

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 #140 🦕

@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 resolves a race condition within the push notification sending logic by introducing a promise-based serialization mechanism. This ensures that notification batches are processed sequentially in a predictable FIFO order, preventing concurrency issues. The effectiveness of this solution is confirmed by an enhanced integration test that now deterministically reproduces the original race condition.

Highlights

  • Race Condition Fix: Implemented a fix for a race condition in the SendPushNotification process to ensure reliable notification delivery.
  • Notification Serialization: Introduced a notificationChain (a promise chain) within DefaultPushNotificationSender to serialize batches of push notifications, ensuring they are processed one at a time.
  • FIFO Ordering: The new serialization mechanism guarantees First-In, First-Out (FIFO) processing order for notification batches, preventing out-of-order delivery issues.
  • Improved Test Coverage: Updated push_notification_integration.spec.ts to include a deterministic 100ms delay for 'submitted' status notifications, making the race condition reliably reproducible and validating the effectiveness of the fix.
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.

@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 effectively addresses the race condition in SendPushNotification by serializing notification batches using a promise chain. The changes to the integration test, which introduce a delay to deterministically trigger the race condition, are a great way to validate the fix. My review includes a suggestion to make the promise chain more resilient to potential errors, preventing the entire notification mechanism from halting. I've also recommended an improvement to the test assertions to make them clearer and more explicit about verifying the correct order of notifications.

Comment thread src/server/push_notification/default_push_notification_sender.ts Outdated
Comment thread test/server/push_notification_integration.spec.ts Outdated
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@guglielmo-san guglielmo-san changed the title Fix: Race condition on SendPushNotification fix: Race condition on SendPushNotification Oct 24, 2025

@ishymko ishymko left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Let's reference failed test runs from Actions as an example in the PR description.

Comment thread src/server/push_notification/default_push_notification_sender.ts Outdated
Comment thread test/server/push_notification_integration.spec.ts Outdated
Comment thread src/server/push_notification/default_push_notification_sender.ts Outdated
Comment thread test/server/push_notification_integration.spec.ts
@ishymko ishymko changed the title fix: Race condition on SendPushNotification fix: ensure push notifications order Oct 24, 2025
Comment thread test/server/push_notification_integration.spec.ts Outdated
Comment thread test/server/push_notification_integration.spec.ts
Comment thread test/server/push_notification_integration.spec.ts Outdated
Comment thread test/server/push_notification_integration.spec.ts Outdated
@ishymko ishymko requested a review from swapydapy October 24, 2025 14:32
Comment thread src/server/push_notification/default_push_notification_sender.ts Outdated
Comment thread test/server/push_notification_integration.spec.ts Outdated
Comment thread src/server/push_notification/default_push_notification_sender.ts Outdated
Co-authored-by: Ivan Shymko <vana.shimko@gmail.com>
@guglielmo-san guglielmo-san enabled auto-merge (squash) October 28, 2025 16:13
Comment thread src/server/push_notification/default_push_notification_sender.ts
@guglielmo-san guglielmo-san merged commit 22360e6 into a2aproject:main Oct 29, 2025
3 checks passed
@guglielmo-san guglielmo-san deleted the fix_flacky_tests branch October 29, 2025 08:12
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]: SendPushNotification does not implement any check to avoid race conditions

3 participants