CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is roughly based on Keep a Changelog.

This project intends to inhere to Semantic Versioning, but has not yet reached 1.0 so all APIs might be changed.

Unreleased

v0.11.1 - 2024-10-29

Bug Fixes

• Fixed an infinite loop in the actor that could occur when all Client instances are dropped and there are still ongoing operations (#124)

Contributors

Thanks to the people who contributed to this release:

• @Sytten

v0.11.0 - 2024-10-25

Changes

• Updated tungstenite bounds to support 0.24 as well as 0.23. (#121)

Contributors

Thanks to the people who contributed to this release:

• @Sytten

v0.10.2 - 2024-08-21

Bug Fixes

• send graphql-specific ping instead of ws ping frame (#117)

Changes

• Tidied up some documentation (#114)
• Handled some clippy lints (#114)

Bug Fixes

• graphql-transport-ws pings are now responded to with graphql-tranport-ws pongs, rather than websocket pongs (#116)
• Keep alives now send graphql-transport-ws ping messages instead of websocket ping frames (#117)

Contributors

Thanks to the people who contributed to this release:

• @vorporeal
• @szgupta
• @carlocorradini

v0.10.1 - 2024-06-08

Bug Fixes

• Fixed some compile errors when ws_stream_wasm was enabled and tungstenite was not (#111)

v0.10.0 - 2024-06-08

Breaking Changes

• All Connection trait functions now return impl Future instead of BoxFuture (#108)
• Removed the legacy API that was deprecated in v0.8.0 (#81)
• The deprecated async-tungstenite feature has been removed. Use the tungstenite feature instead, which works with async-tungtenite, tokio-tungstenite and any other library that provides a futures::{Stream, Sink} based tungsetenite interface. (#106)

Changes

• MSRV is now 1.76
• Updated dependencies (#100)
  • tungstenite 0.23
  • graphql_client 0.14
• Removed unused dependencies (#105)
  • async-trait
  • pin-project-lite

Contributors

Thanks to the people who contributed to this release:

• @carlocorradini

v0.9.0 - 2024-06-08

Breaking Changes

• The no-logging feature has been removed in favour of a default logging feature (#97)

New Features

• Added keep-alive functionality. When enabled this will send periodic pings when the connection appears inactive. If these pings are not replied to, the connection will be considered broken. (#93, #94, #103)
• Client is now Debug (#101)

Changes

• simplify keep alive implementation
• pin release-plz version (#91)

Contributors

Thanks to the people who contributed to this release:

• @rhishikeshj
• @carlocorradini

0.8.2 - 2024-04-09

Changes

• Client::subscribe now takes &self instead of &mut self, to make sharing a Client among threads easier (#88)
• Client is now clone, again to make sharing among threads easier (#88)

v0.8.1 - 2024-03-21

Fixes

• Hopefully fixed the docs.rs build

v0.8.0 - 2024-03-17

Breaking Changes

• async_tungstenite is no longer a default feautre, you should explicitly enable it if you need it.
• Updated to tungstenite 0.21
• MSRV is now 1.69 (there was no official MSRV before)
• Subscription IDs sent to the server are now just monotonic numbers rather than uuids.

Deprecations

These will be removed in a future version, probably in v0.9.0

• AsyncWebsocketClient and all its supporting traits and structs are now deprecated.
• The async-tungstenite feature flag is deprecated and will be removed in favour of tungstenite eventually.

New Features

• Added an entirely new client API as a replacement for the old API.
• Added a subscribe function to next::ClientBuilder to make creating a single subscription on a given connection easier.

Changes

• graphql-ws-client now depends only on tungstenite and not directly on async-tungstenite (or tokio-tungstenite). This should allow it to work with more versions of the async libraries (provided they support the same tungstenite version).

v0.8.0-rc.2 - 2024-02-13

Breaking Changes

• async-tungstenite is no longer automatically enabled when adding any of the client feature flags.

Changes

• graphql-ws-client now depends only on tungstenite and not directly on async-tungstenite (or tokio-tungstenite) This should allow it to work with more versions of the async libraries (provided they support the same tungstenite version).

Bug Fixes

• Fixed tokio-tungstenite support by switching the async_tungstenite Connection impl to a generic impl on any tungstenite compatible Stream & Sink.

v0.8.0-rc.1 - 2024-02-10

Breaking Changes

• The next api is now available at the top level rather than the next module.
• async_tungstenite is no longer a default feautre, you should explicitly enable it if you need it
• Updated to async_tungstenite 0.25
• Renamed Client::streaming_operation to subscribe in next api.
• MSRV is now 1.69 (there was no official MSRV before)

Deprecations

These will be removed in a future version, probably in v0.9.0

• AsyncWebsocketClient and all its supporting traits and structs are now deprecated.

New Features

• Added a subscribe function to next::ClientBuilder to make creating a single subscription on a given connection easier.

v0.8.0-alpha.2 - 2024-01-30

Breaking Changes

• Error::Close now has a code as well as a reason.

New Features

• Added a next module with a significant re-work of the API

v0.8.0-alpha.1 - 2024-01-19

Breaking Changes

• Subscription IDs sent to the server are now just monotonic numbers rather than uuids.
• SubscriptionStream no longer takes GraphqlClient as a generic parameter
• Removed the GraphqlClient trait and all its uses
• Changed the StreamingOperation trait:
  • Removed the GenericResponse associated type
  • decode_response now always takes a serde_json::value - I expect most implementations of this will now just be a call to serde_json::from_value

v0.7.0 - 2024-01-03

Breaking Changes

• async_tungstenite dependency has been updated to 0.24

v0.6.0 - 2023-10-01

Breaking Changes

• async_tungstenite dependency has been updated to 0.23, pulling in a tungstenite security fix

v0.5.0 - 2023-07-13

Breaking Changes

• cynic dependency has been updated to 3
• graphql_client dependency has been updated to 0.13
• async_tungstenite dependency has been updated to 0.22

Bug Fixes

• Updated the cynic code to support operations with variables.

v0.4.0 - 2023-04-02

Breaking Changes

• cynic dependency has been updated to 2.2
• async_tungstenite dependency has been updated to 0.19
• graphql_client dependency has been updated to 0.12

Bug Fixes

• The examples now compile.

v0.3.0 - 2022-12-26

New Features

• Added support for wasm with the ws_stream_wasm library.

Changes

• Updated some dependency versions

Bug Fixes

• graphql-ws-client will no longer panic when it receives a Ping event.
• The AsyncWebsocketClientBuilder type is now Send.

v0.2.0 - 2022-01-27

Breaking Changes

• Clients are now created through builder types rather than directly. See the AsyncWebsocketClientBuilder type (or it's CynicClientBuilder alias)
• cynic support is now behind the client-cynic feature.
• It's now recommended to use a custom impl of futures::task::Spawn for tokio rather than the async_executors crate, as async_executors is not compatible with #[tokio::main]. An example impl is provided for tokio in the examples folder.

New Features

• graphql_client is now supported, behind the client-graphql-client feature.
• graphql-ws-client now has an example
• streaming_operation now returns a SubscriptionStream type. This is still a Stream but also exposes a stop_operation function that can be used to tell the server to end the stream.
• cynic no longer requires the use of async_executors - it now only requires an impl futures::task::Spawn. An example is included for tokio. Old code using the AsyncStd executor should continue to work but tokio users are encouraged to provide their own using the example.

Bug Fixes

• graphql-ws-client has better support for running inside #[tokio::main]
• Cynic will now use the log crate rather than printing to stdout.

v0.1.0 - 2021-04-04

• Initial release