feat(graphql): add subscriptions support for events and transactions #8698
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
|
The latest updates on your projects. Learn more about Vercel for GitHub. 6 Skipped Deployments
|
iota-ci
added
infrastructure
sergiupopescu199
force-pushed
the
sc-platform/issue-8561
branch
from
afd45ad to
3e7e3e5
Compare
tomxey
approved these changes
Oct 2, 2025
Contributor
tomxey
left a comment
tomxey
left a comment
There was a problem hiding this comment.
looks good!
do we also plan to add some automated tests for this?
Contributor
Author
|
During implementation, I did consider adding tests, but our current GraphQL client used for testing setup only supports HTTP requests. Since subscriptions operate over WebSockets, we'd need to:
This would significantly increase the scope of changes and require additional time. We can create a new issue ti tackle this. |
kodemartin
approved these changes
Oct 3, 2025
Contributor
kodemartin
left a comment
kodemartin
left a comment
There was a problem hiding this comment.
Looks splendid! Left a few minor comments and nits
sergiupopescu199
merged commit 66810b3
into
sc-platform/feat/streaming-support
38 of 39 checks passed
sergiupopescu199
added a commit
that referenced
this pull request
Nov 11, 2025
…8698) # Description of change This PR adds the feature to add subscription support for `events` and `transactions` for GraphQL. For filtering capabilities it leverages the [`@oneOf`](https://graphql.org/blog/2025-09-04-multioption-inputs-with-oneof/) directive which does not allow more than one filter at a time for the input filter object. ## Links to any relevant issues fixes #8561 ## How the change has been tested - [x] Basic tests (linting, compilation, formatting, unit/integration tests) - [ ] Patch-specific tests (correctness, functionality coverage) - ran graphql tests ```shell cargo nextest run -p iota-graphql-rpc --features pg_integration --no-fail-fast --test-threads 1 ``` - used the iota binary to spin up an indexer and graphql instance and test the subscription queries ``` cargo r --features indexer -- start --force-regenesis --with-indexer --with-graphql ``` - used the integrated graphiQL ui to issue subscription queries - used a third party graphql client (Postman) to issue the same queries > [!NOTE] > At approximately 1k subscribers, the local machine reached its operational limit. The sheer intensity and concurrent demand of managing the network, indexer, GraphQL server, and a high volume of WebSocket connections prevented reliable testing. In future iteration we could add **Prometheus** metrics to track the total amount of active subscribers, how many subscribers experience lags, ect... ### Infrastructure QA (only required for crates that are maintained by @iotaledger/infrastructure) - [ ] Synchronization of the indexer from genesis for a network including migration objects. - [ ] Restart of indexer synchronization locally without resetting the database. - [ ] Restart of indexer synchronization on a production-like database. - [ ] Deployment of services using Docker. - [ ] Verification of API backward compatibility. > [!NOTE] > The following patch does not affect the normal operation of the indexer, thus tests were skipped. ### Release Notes - [x] GraphQL: Add `Subscription` support for `Event` and `TransactionBlock`.
sergiupopescu199
added a commit
that referenced
this pull request
Nov 13, 2025
…8698) # Description of change This PR adds the feature to add subscription support for `events` and `transactions` for GraphQL. For filtering capabilities it leverages the [`@oneOf`](https://graphql.org/blog/2025-09-04-multioption-inputs-with-oneof/) directive which does not allow more than one filter at a time for the input filter object. ## Links to any relevant issues fixes #8561 ## How the change has been tested - [x] Basic tests (linting, compilation, formatting, unit/integration tests) - [ ] Patch-specific tests (correctness, functionality coverage) - ran graphql tests ```shell cargo nextest run -p iota-graphql-rpc --features pg_integration --no-fail-fast --test-threads 1 ``` - used the iota binary to spin up an indexer and graphql instance and test the subscription queries ``` cargo r --features indexer -- start --force-regenesis --with-indexer --with-graphql ``` - used the integrated graphiQL ui to issue subscription queries - used a third party graphql client (Postman) to issue the same queries > [!NOTE] > At approximately 1k subscribers, the local machine reached its operational limit. The sheer intensity and concurrent demand of managing the network, indexer, GraphQL server, and a high volume of WebSocket connections prevented reliable testing. In future iteration we could add **Prometheus** metrics to track the total amount of active subscribers, how many subscribers experience lags, ect... ### Infrastructure QA (only required for crates that are maintained by @iotaledger/infrastructure) - [ ] Synchronization of the indexer from genesis for a network including migration objects. - [ ] Restart of indexer synchronization locally without resetting the database. - [ ] Restart of indexer synchronization on a production-like database. - [ ] Deployment of services using Docker. - [ ] Verification of API backward compatibility. > [!NOTE] > The following patch does not affect the normal operation of the indexer, thus tests were skipped. ### Release Notes - [x] GraphQL: Add `Subscription` support for `Event` and `TransactionBlock`.
sergiupopescu199
added a commit
that referenced
this pull request
Nov 20, 2025
…8698) # Description of change This PR adds the feature to add subscription support for `events` and `transactions` for GraphQL. For filtering capabilities it leverages the [`@oneOf`](https://graphql.org/blog/2025-09-04-multioption-inputs-with-oneof/) directive which does not allow more than one filter at a time for the input filter object. ## Links to any relevant issues fixes #8561 ## How the change has been tested - [x] Basic tests (linting, compilation, formatting, unit/integration tests) - [ ] Patch-specific tests (correctness, functionality coverage) - ran graphql tests ```shell cargo nextest run -p iota-graphql-rpc --features pg_integration --no-fail-fast --test-threads 1 ``` - used the iota binary to spin up an indexer and graphql instance and test the subscription queries ``` cargo r --features indexer -- start --force-regenesis --with-indexer --with-graphql ``` - used the integrated graphiQL ui to issue subscription queries - used a third party graphql client (Postman) to issue the same queries > [!NOTE] > At approximately 1k subscribers, the local machine reached its operational limit. The sheer intensity and concurrent demand of managing the network, indexer, GraphQL server, and a high volume of WebSocket connections prevented reliable testing. In future iteration we could add **Prometheus** metrics to track the total amount of active subscribers, how many subscribers experience lags, ect... ### Infrastructure QA (only required for crates that are maintained by @iotaledger/infrastructure) - [ ] Synchronization of the indexer from genesis for a network including migration objects. - [ ] Restart of indexer synchronization locally without resetting the database. - [ ] Restart of indexer synchronization on a production-like database. - [ ] Deployment of services using Docker. - [ ] Verification of API backward compatibility. > [!NOTE] > The following patch does not affect the normal operation of the indexer, thus tests were skipped. ### Release Notes - [x] GraphQL: Add `Subscription` support for `Event` and `TransactionBlock`.
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.
Description of change
This PR adds the feature to add subscription support for
eventsandtransactionsfor GraphQL.For filtering capabilities it leverages the
@oneOfdirective which does not allow more than one filter at a time for the input filter object.Links to any relevant issues
fixes #8561
How the change has been tested
Basic tests (linting, compilation, formatting, unit/integration tests)
Patch-specific tests (correctness, functionality coverage)
ran graphql tests
Note
At approximately 1k subscribers, the local machine reached its operational limit. The sheer intensity and concurrent demand of managing the network, indexer, GraphQL server, and a high volume of WebSocket connections prevented reliable testing.
In future iteration we could add Prometheus metrics to track the total amount of active subscribers, how many subscribers experience lags, ect...
Infrastructure QA (only required for crates that are maintained by @iotaledger/infrastructure)
Note
The following patch does not affect the normal operation of the indexer, thus tests were skipped.
Release Notes
Subscriptionsupport forEventandTransactionBlock.