Skip to content

Commit

Permalink
chore: beam 0.8 release notes (#203)
Browse files Browse the repository at this point in the history
* chore: beam 0.8 release notes

* Apply suggestions

Co-authored-by: Martin Lablans <6804500+lablans@users.noreply.github.com>

* Apply more suggestions

Co-authored-by: Tobias Kussel <TKussel@users.noreply.github.com>

---------

Co-authored-by: Martin Lablans <6804500+lablans@users.noreply.github.com>
Co-authored-by: Tobias Kussel <TKussel@users.noreply.github.com>
  • Loading branch information
3 people authored Jul 26, 2024
1 parent 7bc7af6 commit 1df2e78
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 6 deletions.
24 changes: 24 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
# Samply.Beam 0.8.0 - 2024-07-26

This major release of Beam 0.8 features many changes "under the hood", such as the highly anticipated upgrade of our `hyper` dependency to version 1, as well as many bug fixes. We were able to decrease the communication overhead between Beam.Proxies and the Beam.Broker and streamlined the behavior of some endpoints to make the usage of Samply.Beam simpler.

## Breaking changes

* The `filter=todo` parameter on the tasks endpoint will not yield tasks anymore that are claimed. This change of behavior streamlines some often occurring usage patterns of this endpoint.
* The library (`beam lib`) reexports types from `reqwest`, which has now been upgraded to use hyper 1.0. This may lead to compile errors in code bases using older reqwest versions.

## Minor changes

* Socket tasks may now hold additional metadata.
* New functions in beam lib to create sockets with metadata.
* Added `beam_lib::RawString`, a string wrapper to prevent beam lib from json encoding the string again. This is useful for beam_lib clients that handle serializing and deserializing types outside of beam_lib.
* Added a dedicated `beam_lib::Error::InvalidReceivers` error variant holding all invalid receivers when trying to create a task with invalid recipients.

## Bugfixes

* Fix broker deadlock when too many clients tried to fetch certificates at the same time.
* Re-validate expired proxy certificates when they are re-signed after an update.
* The broker will now only return valid (non-expired) certificates to beam proxies.
* beam-proxies will retry their health check connections to the broker immediately after a gateway timeout.
* Close SSE connection on a timeout without logging an error message.

# Samply.Beam 0.7.0 – 2023-10-04

This major release features almost 300 commits introducing multiple improvements, new features, and bug fixes. In particular, we are thrilled to introduce the possibility to use Samply.Beam for secure and easy *direct socket connections*. This opens Samply.Beam for many additional use cases, where a message-passing approach is not suitable, e.g. applications with high bandwidth demands.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

Samply.Beam is a distributed task broker designed for efficient communication across strict network environments. It provides most commonly used communication patterns across strict network boundaries, end-to-end encryption and signatures, as well as certificate management and validation on top of an easy to use REST API. In addition to task/response semantics, Samply.Beam supports high-performance applications with encrypted low-level direct socket connections.

## Latest version: Samply.Beam 0.7.0 – 2023-10-04
## Latest version: Samply.Beam 0.8.0 – 2024-07-26

This new version introduces many new features, such as direct socket connections, improved certificate caching and health monitoring for the Proxy (via a long-lived control connection) and the Broker. As indicated by the [major version change](https://semver.org/), some breaking changes have been introduced. Please check the [Changelog](CHANGELOG.md) for details.
This new major version includes some bugfixes, dependency upgrades and improvements to `beam-lib`. Please check the [Changelog](CHANGELOG.md) for more details.

Find info on all previous versions in the [Changelog](CHANGELOG.md).

Expand Down
2 changes: 1 addition & 1 deletion beam-lib/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "beam-lib"
version = "0.1.0"
version = "0.8.0"
edition = "2021"
license = "Apache-2.0"

Expand Down
2 changes: 1 addition & 1 deletion broker/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "beam-broker"
version = "0.7.0"
version = "0.8.0"
edition = "2021"
license = "Apache-2.0"
documentation = "https://github.com/samply/beam"
Expand Down
2 changes: 1 addition & 1 deletion proxy/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "beam-proxy"
version = "0.7.0"
version = "0.8.0"
edition = "2021"
license = "Apache-2.0"
documentation = "https://github.com/samply/beam"
Expand Down
2 changes: 1 addition & 1 deletion shared/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "shared"
version = "0.7.0"
version = "0.8.0"
edition = "2021"
license = "Apache-2.0"
documentation = "https://github.com/samply/beam"
Expand Down

0 comments on commit 1df2e78

Please sign in to comment.