See the upgrade guides to bring your Phoenix 1.3.x apps up to speed, including instructions on upgrading to Cowboy 2 for HTTP support.
We have used the opportunity of writing the new Cowboy 2 adapter to do an overhaul in how Phoenix.Socket
interacts with transports. The result is a new API that makes it very easy to implement new transports and also allows developers to provide custom socket implementations without ceremony. For example, if you would like to have direct control of the socket and bypass the channel implementation completely, it is now very straight-forward to do so. See the Phoenix.Socket.Transport
behaviour for more information.
This overhaul means that the transport/3
macro in Phoenix.Socket
is deprecated. Instead of defining transports in your socket.ex file:
transport :websocket, Phoenix.Transport.Websocket,
key1: value1, key2: value2, key3: value3
transport :longpoll, Phoenix.Transport.LongPoll,
key1: value1, key2: value2, key3: value3
Configurations must be applied directly in your endpoint file via the Phoenix.Endpoint.socket/3
macro:
socket "/socket", MyApp.UserSocket,
websocket: [key1: value1, key2: value2, key3: value3],
longpoll: [key1: value1, key2: value2, key3: value3]
Note the websocket/longpoll configuration given to socket/3 will only apply after you remove all transport/3
calls from your socket definition. If you have explicitly upgraded to Cowboy 2, any transport defined with the transport/3
macro will be ignored.
The old APIs for building transports are also deprecated. The good news is: adapting an existing transport to the new API is a less error prone process where you should mostly remove code.
- [phx.new] Update Ecto deps with the release of Ecto 3.0 including
phoenix_ecto
4.0 - [phx.new] Import Ecto's
.formatter.exs
in new projects - [phx.new] Use Ecto 3.0RC, with
ecto_sql
in new project deps - [phx.new] Use Plug 1.7 with new
:plug_cowboy
dependency for cowboy adapter - [phx.gen.html|json|schema|context] Support new Ecto 3.0 usec datetime types
- [Phoenix] Add
Phoenix.json_library/0
and replacePoison
withJason
for JSON encoding in new projects - [Endpoint] Add
Cowboy2Adapter
for HTTP2 support with cowboy2 - [Endpoint] The
socket/3
macro now accepts direct configuration about websockets and longpoll - [Endpoint] Support MFA function in
:check_origin
config for custom origin checking - [Endpoint] Add new
:phoenix_error_render
instrumentation callback - [Endpoint] Log the configured url instead of raw IP when booting endpoint webserver
- [Endpoint] Allow custom keyword pairs to be passed to the socket
:connect_info
options. - [Router] Display list of available routes on debugger 404 error page
- [Router] Raise on duplicate plugs in
pipe_through
scopes - [Controller] Support partial file downloads with
:offset
and:length
options tosend_download/3
- [Controller] Add additional security headers to
put_secure_browser_headers
(x-content-type-options
,x-download-options
, andx-permitted-cross-domain-policies
) - [Controller] Add
put_router_url/2
to override the default URL generation pulled from endpoint configuration - [Logger] Add whitelist support to
filter_parameters
logger configuration, via new:keep
tuple format - [Socket] Add new
phoenix_socket_connect
instrumentation - [Socket] Improve error message when missing socket mount in endpoint
- [Logger] Log calls to user socket connect
- [Presence] Add
Presence.get_by_key
to fetch presences for specific user - [CodeReloader] Add
:reloadable_apps
endpoint configuration option to allow recompiling local dependencies - [ChannelTest] Respect user's configured ExUnit
:assert_receive_timeout
for macro assertions
- Add missing
.formatter.exs
to hex package for proper elixir formatter integration - [phx.gen.cert] Fix usage inside umbrella applications
- [phx.new] Revert
Routes.static_url
in app layout in favor of originalRoutes.static_path
- [phx.new] Use phoenix_live_reload 1.2-rc to fix hex version errors
- [phx.gen.json|html] Fix generator tests incorrectly encoding datetimes
- [phx.gen.cert] Fix generation of cert inside umbrella projects
- [Channel] Fix issue with WebSocket transport sending wrong ContentLength header with 403 response
- [Router] Fix forward aliases failing to expand within scope block
- [Router] Fix regression in router compilation failing to escape plug options
- Generate new Elixir 1.5+ child spec (therefore new apps require Elixir v1.5)
- Use webpack for asset bundling
- [Controller] Passing a view in
render/3
andrender/4
is deprecated in favor ofput_view/2
- [Endpoint] The
:handler
option in the endpoint is deprecated in favor of:adapter
- [Socket]
transport/3
is deprecated. The transport is now specified in the endpoint - [Transport] The transport system has seen an overhaul and been drastically simplified. The previous mechanism for building transports is still supported but it is deprecated. Please see
Phoenix.Socket.Transport
for more information
- Add new instance-based Presence API with simplified synchronization callbacks
- Accept a function for socket and channel
params
for dynamic parameter generation when connecting and joining - Fix race condition when presence diff arrives before state
- Immediately rejoin channels on socket reconnect for faster recovery after reconnection
- Fix reconnect caused by pending heartbeat
The CHANGELOG for v1.3 releases can be found in the v1.3 branch.