Skip to content

Latest commit

 

History

History
152 lines (112 loc) · 4.52 KB

CHANGELOG.md

File metadata and controls

152 lines (112 loc) · 4.52 KB
Raw

PhoenixClient

v0.11.1

  • Enhancements
    • Remove delay when sending messages through the socket.

v0.11.0

  • Enhancements
    • websocket_client is no longer an optional dependency.
    • Delegate heartbeat to the transport instead of using the phx_heartbeat message. This results in a much smaller payload for keeping the connection alive.
    • Add :ssl to extra_applications so it is included and started with OTP.

v0.10.0

  • Enhancements
    • Extra headers can be added to the initial socket connection through the socket_opts using the key headers: [{"header-name", "value"}]

v0.9.0

  • Enhancements
    • All out of band reply messages are delivered to the channel's caller as broadcast messages. This allows the use of push_async to send messages to the server that may :reply in an indeterminate amount of time.

v0.8.0

  • Enhancements
    • Add support for v1 and v2 phoenix channel message protocol.
  • Bug fixes
    • Remove the channels from the socket when disconnecting.
    • Merge query params from original url when constructing new connection url.

v0.7.0

  • Enhancements
    • Update to use the Phoenix message protocol version 2.0.0
    • Improved socket disconnect handling

v0.6.1

  • Enhancements
    • Do not exit if a call to join results in a timeout. Instead, return {:error, :timeout}.

v0.6.0

  • Enhancements

    • Removed Socket.status/1 in favor of Socket.connected?/1.
    • Channel.start_link and stop are now private. You should call Channel.join/leave to manage the lifecycle of the channel connection.
    • Added a DynamicSupervisor for Channel connections

  • Bug fixes

    • Refactored socket channel leaves and joins. The socket is now responsible for sending the join and leave messages. This fixes potential issues where the socket could attempt to join a topic more than once.

v0.5.1

  • Bug fixes
    • Attempt to reconnect the socket if transport exits abnormally.
    • Prevent the channel from delivering multiple "phx_error" or "phx_close". messages if the socket fails.
    • Set the socket status to :disconnected when the transport exits.

v0.5.0

Important This version has been renamed and refactored. You will need to migrate existing phoenix_channel_client projects before first use. Please see the readme for how to implement this new pattern.

  • Bug fixes

    • The Socket will monitor linked channels for down messages and remove them from the channel links.

  • Enhancements

    • Removed the requirement to define Socket and Channel modules that implement their respective behaviours. Sockets are now started by calling PhoenixClient.Socket.start_link directly. Channels are started by calling PhoenixClient.Channel.
    • Calls to PhoenixClient.Channel.push happen synchronously. This helps to reduce callback spaghetti code by making the reply available at the call site. If you do not require a response from the server, you can use push_async.
    • Non-reply messages that are pushed from the server will be sent to the pid of the process that called join. They will be delivered as %PhoenixClient.Message{}. See the main readme for an example of this.

v0.4.0

  • Breaking changes

    • Channel pids are not longer named by default. If you would like to name the pid, you can pass genserver_opts to the child spec:

      For example:

      {MyApp.Channel, {[socket: MyApp.Socket, topic: "room:lobby"], [name: MyApp.Channel]}}

    • Calls for join, push, cancel_push, and leave are no longer injected into the channel module. These functions have been moved to the PhoenixClient module.

      For example:

      MyChannel.join()
# becomes
PhoenixClient.join(channel_pid_or_name)

v0.3.2

  • Bug fixes
    • Fix issue with rejoin timer being fired before initial join.

v0.3.1

  • Bug fixes
    • Fix issue with socket spawning too many adaptors on reconnect timer.

v0.3.0

  • Enhancements

    • Pass handle_info/2, handle_call/3, and haneld_cast/2 messages through to the channel server process
    • Add ability to pass socket params
    • Add support for client SSL certificates
    • Use Jason as default JSON parser

  • Bug Fixes

    • Only send heartbeat messages when the channel is connected.
    • Quiet logging output

v0.2.0

  • Bug Fixes
    • Fixed issues with missing disconnect handlers in websocket code
    • Fixed crashes when sending socket closures to channels
    • Send adapter open args to websocket
  • Enhancements
    • Added reconnect timer

v0.1.0

  • Initial Release