Skip to content

Latest commit

 

History

History
280 lines (199 loc) · 17.6 KB

CHANGELOG.md

File metadata and controls

280 lines (199 loc) · 17.6 KB
Raw

v1.4.2

  • Redis Sentinel support for Redis high availability setup. Docs
  • Redis Engine now uses Redis pipeline for batching publish operations - this results in latency and throughput improvments when publish rate is high.
  • Refactored admin websocket. New option admin to enable admin websocket. New option insecure_admin to make this endpoint insecure (useful when admin websocket endpoint/port protected by firewall rules). web_password option renamed to admin_password, web_secret option renamed to admin_secret, insecure_web renamed to insecure_admin. But all old option names still supported to not break things in existing setups. Also note, that when you run Centrifugo with web interface enabled - you also make admin websocket available, because web interface uses it. A little more info in pull request.
  • Presence Redis Engine methods rewritten to lua to be atomic.
  • Some Redis connection params now can be set over environment variables. See #81
  • Fix busy loop when attempting to reconnect to Redis. Fixes large CPU usage while reconnecting.
  • Shorter message uids (22 bytes instead of 36). This was made in order to get some performance improvements.

v1.4.1

  • fix server crash on 32-bit architectures (due to this), see more details in #74.
  • fix compatibility with gocent introduced in v1.4.0

v1.4.0

No backwards incompatible changes here for most usage scenarios, but look carefully on notes below.

  • Timers in metrics marked as deprecated. time_api_mean, time_client_mean, time_api_max, time_client_max now return 0. This was made because timer's implementation used Timer from go-metrics library that does not suit very well for Centrifugo needs - so values were mostly useless in practice. So we decided to get rid of them for now to not confuse our users.
  • New node API method to get information from single node. That information will contain counters without aggregation over minute interval (what stats method does by default). So it can be useful if your metric aggregation system can deal with non-aggregated counters over time period itself. Also note that to use this method you should send API request to each Centrifugo node separately - as this method returns current raw statistics about one node. See issue for motivation description.
  • Centrifugo now handles SIGTERM in addition to SIGINT and makes shutdown when this signal received. During shutdown Centrifugo returns 503 status code on requests to handlers and closes client connections so clients will reconnect. If shutdown finished without errors in 10 seconds interval then Centrifugo exits with status code 0 (instead of 130 before, this fixes behaviour behind systemd after SIGTERM received).
  • Maximum limit in bytes for client request was added. It can be changed using client_request_max_size config option. By default 65536 bytes (64kb).
  • Packages for 64-bit Debian, Centos and Ubuntu hosted on packagecloud.io. If you are using Debian 7 or 8, Centos 6 or 7, Ubuntu 14.04 or Ubuntu 16.04 - you can find packages for those linux distribution following to packagecloud. Packages will be created every time we release new Centrifugo version.

v1.3.3

No backwards incompatible changes here

  • fix automatic presence expire in Redis engine - could lead to small memory leaks in Redis when using presence. Also could result in wrong presence information after non-graceful Centrifugo node shutdown.
  • configurable limit for amount of channels each client can subscribe to. Default 100. Can be changed using client_channel_limit configuration option.

v1.3.2

This release built using go 1.5.3 and includes security fix in Go lang

  • empty errors not included in client response (this requires using Javascript client >= 1.1.0)
  • optimization in Redis engine when using history - one round trip to Redis to publish message and save it into history instead of two. This was done over registering lua script on server start.
  • client errors improvements - include error advice when error occurred (fix or retry at moment)

Also note that Javascript client will be fully refreshed soon. See this pull request

v1.3.1

  • fix port configuration introduced in v1.3.0: --port should override default values for admin_port and api_port
  • use the same (http/https) scheme for Sockjs default iframe script source.
  • fix possible deadlock in shutdown

v1.3.0

Possible backwards incompatibility here (in client side code) - see first point.

  • omit fields in message JSON if field contains empty value: client on top level, info on top level, default_info in info object, channel_info in info object. This also affects top level data in join/leave messages and presence data – i.e. default_info and channel_info keys not included in JSON when empty. This can require adapting your client side code a bit if you rely on these keys but for most cases this should not affect your application. But we strongly suggest to test before updating. This change allows to reduce message size. See migration notes below for more details.
  • new option --admin_port to bind admin websocket and web interface to separate port. #44
  • new option --api_port to bind API endpoint to separate port. #44
  • new option --insecure_web to use web interface without setting web_password and web_secret (for use in development or when you protected web interface by firewall rules). #44
  • new channel option history_drop_inactive to drastically reduce resource usage (engine memory, messages travelling around) when you use message history. See #50
  • new Redis engine option --redis_api_num_shards. This option sets a number of Redis shard queues Centrifugo will use in addition to standard centrifugo.api queue. This allows to increase amount of messages you can publish into Centrifugo and preserve message order in channels. See #52 and documentation for more details.
  • fix race condition resulting in client disconnections on high channel subscribe/unsubscribe rate. #54
  • refactor last_event_id related stuff to prevent memory leaks on large amout of channels. #48
  • send special disconnect message to client when we don't want it to reconnect to Centrifugo (at moment to client sending malformed message).
  • pong wait handler for raw websocket to detect non responding clients.

Also it's recommended to update javascipt client to latest version as it has some useful changes (see its changelog).

How to migrate

Message before:

{
	"uid":"442586d4-688c-4a0d-52ad-d0a13d201dfc",
	"timestamp":"1450817253",
	"info": null,
	"channel":"$public:chat",
	"data":{"input":"1"},
	"client":""
}

Message now:

{
	"uid":"442586d4-688c-4a0d-52ad-d0a13d201dfc",
	"timestamp":"1450817253",
	"channel":"$public:chat",
	"data":{"input":"1"},
}

I.e. not using empty client and info keys. If those keys are non empty then they present in message.

Join message before:

{
	"user":"2694",
	"client":"93615872-4e45-4da2-4733-55c955133436",
	"default_info": null,
	"channel_info":null
}

Join message now:

{
	"user":"2694",
	"client":"93615872-4e45-4da2-4733-55c955133436"
}

If "default_info" or "channel_info" exist then they would be included:

{
	"user":"2694",
	"client":"93615872-4e45-4da2-4733-55c955133436",
	"default_info": {"username": "FZambia"},
	"channel_info": {"extra": "some data here"}
}

v1.2.0

No backwards incompatible changes here.

  • New recover option to automatically recover missed messages based on last message ID. See pull request and chapter in docs for more information. Note that you need centrifuge-js >= v1.1.0 to use new recover option
  • New broadcast API method to send the same data into many channels. See issue and updated API description in docs
  • Dockerfile now checks SHA256 sum when downloading release zip archive.
  • release built using Go 1.5.2

v1.1.0

No backwards incompatible changes here.

  • support enabling web interface over environment variable CENTRIFUGO_WEB
  • close client's connection after its message queue exceeds 10MB (default, can be modified using max_client_queue_size configuration file option)
  • fix theoretical server crash on start when reading from redis API queue

v1.0.0

A bad and a good news here. Let's start with a good one. Centrifugo is still real-time messaging server and just got v1.0 release. The bad – it is not fully backwards compatible with previous versions. Actually there are three changes that ruin compatibility. If you don't use web interface and private channels then there is only one change. But it affects all stack - Centrifugo itself, client library and API library.

Starting from this release Centrifugo won't support multiple registered projects. It will work with only one application. You don't need to use project key anymore. Changes resulted in simplified configuration file format. The only required option is secret now. See updated documentation to see how to set secret. Also changes opened a way for exporting Centrifugo node statistics via HTTP API stats command.

As this is v1 release we'll try to be more careful about backwards compatibility in future. But as we are trying to make a good software required changes will be done if needed.

Highlights of this release are:

  • Centrifugo now works with single project only. No more project key. secret the only required configuration option.
  • web interface is now embedded, this means that when downloading release you get possibility to run Centrifugo web interface just providing --web flag to centrifugo when starting process.
  • when secret set via environment variable CENTRIFUGO_SECRET then configuration file is not required anymore. But note, that when Centrifugo configured via environment variables it's not possible to reload configuration sending HUP signal to process.
  • new stats command added to export various node stats and metrics via HTTP API call. Look its response example in docs chapter.
  • new insecure_api option to turn on insecure HTTP API mode. Read more in docs chapter.
  • minor clean-ups in client protocol. But as protocol incapsulated in javascript client library you only need to update centrifuge-js.
  • release built using Go 1.5.1

Documentation was updated to fit all these release notes. Also all API and client libraries were updated – Javascript browser client (centrifuge-js), Python API client (cent), Django helper module (adjacent). API clients for Ruby (centrifuge-ruby) and PHP (phpcent) too. Admin web interface was also updated to support changes introduced here.

There are 2 new API libraries: gocent and jscent. First for Go language. And second for NodeJS.

Also if you are interested take a look at centrifuge-go – experimental Centrifugo client for Go language. It allows to connect to Centrifugo from non-browser environment. Also it can be used as a reference to make a client in another language (still hoping that clients in Java/Objective-C/Swift to use from Android/IOS applications appear one day – but we need community help here).

How to migrate

  • Use new versions of Centrifugal libraries - browser client and API client. Project key not needed in client connection parameters, in client token generation, in HTTP API client initialization.
  • Another backwards incompatible change related to private channel subscriptions. Actually this is not related to Centrifugo but to Javascript client but it's better to write about it here. Centrifuge-js now sends JSON (application/json) request instead of application/x-www-form-urlencoded when client wants to subscribe on private channel. See in docs how to deal with JSON in this case.
  • --web is now a boolean flag. Previously it was used to set path to admin web interface. Now it indicates whether or not Centrifugo must serve web interface. To provide path to custom web application directory use --web_path string option.

I.e. before v1 you started Centrifugo like this to use web interface:

centrifugo --config=config.json --web=/path/to/web/app

Now all you need to do is run:

centrifugo --config=config.json --web

And no need to download web interface repository at all! Just run command above and check http://localhost:8000.

If you don't want to use embedded web interface you can still specify path to your own web interface directory:

centrifugo --config=config.json --web --web_path=/path/to/web/app

v0.3.0

  • new channels API command – allows to get list of active channnels in project at moment (with one or more subscribers).
  • message_send_timeout option default value is now 0 (last default value was 60 seconds) i.e. send timeout is not used by default. This means that Centrifugo won't start lots of goroutines and timers for every message sent to client. This helps to drastically reduce memory allocations. But in this case it's recommended to keep Centrifugo behind properly configured reverse proxy like Nginx to deal with connection edge cases - slow reads, slow writes etc.
  • Centrifugo now sends pings into pure Websocket connections. Default value is 25 seconds and can be adjusted using ping_interval configuration option. Note that this option also sets SockJS heartbeat messages interval. This opens a road to set reasonable value for Nginx proxy_read_timeout for /connection location to mimic behaviour of message_send_timeout which is now not used by default
  • improvements in Redis Engine locking.
  • tests now require Redis instance running to test Redis engine. Tests use Redis database 9 to run commands and if that database is not empty then tests will fail to prevent corrupting existing data.
  • all dependencies now vendored.

v0.2.4

  • HTTP API endpoint now can handle json requests. Used in client written in Go at moment. Old behaviour have not changed, so this is absolutely optional.
  • dependency packages updated to latest versions - websocket, securecookie, sockjs-go.

v0.2.3

Critical bug fix for Redis Engine!

  • fixed bug when entire server could unsubscribe from Redis channel when client closed its connection.

v0.2.2

  • Add TLS support. New flags are:
    • --ssl - accept SSL connections. This requires an X509 certificate and a key file.
    • --ssl_cert="file.cert" - path to X509 certificate file.
    • --ssl_key="file.key" - path to X509 certificate key.
  • Updated Dockerfile

v0.2.1

  • set expire on presence hash and set keys in Redis Engine. This prevents staling presence keys in Redis.

v0.2.0

  • add optional client field to publish API requests. client will be added on top level of published message. This means that there is now a way to include client connection ID to publish API request to Centrifugo (to get client connection ID call centrifuge.getClientId() in javascript). This client will be included in a message as I said above and you can compare current client ID in javascript with client ID in message and if both values equal then in some situations you will wish to drop this message as it was published by this client and probably already processed (via optimistic optimization or after successful AJAX call to web application backend initiated this message).
  • client limited channels - like user limited channels but for client. Only client with ID used in channel name can subscribe on such channel. Default client channel boundary is &. If you have channels with & in its name - then you must adapt your channel names to not use & or run Centrifugo with another client channel boundary using client_channel_boundary configuration file option.
  • fix for presence and history client calls - check subscription on channel before returning result or return Permission Denied error if not subscribed.
  • handle interrupts - unsubscribe clients from all channels. Many thanks again to Mr Klaus Post.
  • code refactoring, detach libcentrifugo real-time core from Centrifugo service.

v0.1.1

Lots of internal refactoring, no API changes. Thanks to Mr Klaus Post (@klauspost) and Mr Dmitry Chestnykh (@dchest)

v0.1.0

First release. New documentation.