changelog.md

Changelog

This file contains all the notable changes done to the Ballerina WebSocket package through the releases.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Fixed

• Address CVE-2024-47535 vulnerability

[2.12.0] - 2024-08-20

Added

• Implement custom error remote functions for onXXXError
• Introduce dispatcherStreamId annotation

[2.10.0] - 2023-09-15

Fixed

• Fix Compilation Error for Stream Type With "Error" Substring in Signature

[2.9.0] - 2023-06-30

Fixed

• Address CVE-2023-34462 netty Vulnerability

[2.8.0] - 2023-06-01

Fixed

• Dispatch onError remote function when there is a data binding failure

[2.7.1] - 2023-04-25

Fixed

• Fix dispatching failure when a - is used in the service path
• Fix the hanging issue when closing the connection while reading the message
• Fix the dispatching issue when custom dispatching has onMessage

[2.6.0] - 2023-02-27

Added

• Implement dispatching to custom remote functions

Fixed

• Fix data binding failure when a union type is used
• Fix data binding failure when a enum type is used
• Fix hanging issue of readMessage when it is called after connection closure

[2.5.0] - 2022-11-29

Added

• Support returning streams from WebSocket services

Changed

• API Docs Updated

Fixed

• Fix client returning irrelevant error message when given an ip address as the url

[2.4.0] - 2022-09-08

Added

• Incorporate constraint validation

Fixed

• Fix server sending 500 status code when the client invokes it with an incorrect URL

[2201.1.1] - 2022-06-30

Added

• Add data binding support for WebSocket

Fixed

• Fix the client connection closure issue

[2.2.1] - 2022-03-02

Changed

• Mark Websocket Service type as distinct

Added

• Introduce readMessage Client API

[1.2.0-beta.3] - 2021-10-10

Added

• Introduce write time out for WebSocket client
• Add OAuth2 JWT bearer grant type support
• Implement retry for WebSocket client
• Improve the 'get' resource to include header and query param values
• Add resource code snippet generation code action for tooling

[1.2.0-beta.2] - 2021-07-07

Added

• Implement declarative auth design for upgrade service
• Make WebSocket caller isolated

Fixed

• Remove the countdown latches in the implementation
• Fix the issue of not sending the handshake cancel response when panicked from the upgrade service
• Fix the client handshake timeout not working

[1.2.0-beta.1] - 2021-05-06

Fixed

• Fix the listener initialization with inline configs compiler plugin error
• Fix the dispatching to remote functions issue when observability is enabled

[1.2.0-alpha8] - 2021-04-22

Added

• Add compiler plugin validation for WebSocket

Fixed

• Improve error message when creating the WebSocket client with an invalid URL

[1.2.0-alpha5] - 2021-03-19

Added

• Introduce auth support for the WebSocket client
• Introduce HTTP cookie support for the WebSocket client
• Introduce support to send text, binary, and pong messages by returning them from the remote methods

Changed

• Make the websocket:Caller optional in WebSocket service remote functions
• Update SecureSocket API
• Convert all the timeout configurations to decimal

Removed

• Remove the support for the websocket:AsyncClient