deepstream.io v1.0.0 Release Notes
Release Date: 2016-07-09 // over 7 years ago-
๐ Features
CLI
You can start deepstream via a command line interface. You find it in the bin directory. It provides these subcommands:
start
stop
status
install
info
hash
append a--help
to see the usage.
๐ง ###### File based configuration ๐ง You can now use a file based configuration instead of setting options via
ds.set(key, value)
. deepstream is shipped with a conf directory which contains three files:- config.yml this is the main config file, you can specify most of the deepstream options in that file
- permissions.yml this file can be consumed by the PermissionHandler. It's not used by default, but you can enable it in the config.yml
- users.yml this file can be consumed by the AuthenticationHandler. It's not used by default, but you can enable it in the config.yml
For all config types support these file types: .yml, .json and .js
Constructor API
There are different options what you can pass:
- not passing any arguments ( consistent with 0.x )
- passing
null
will result in loading the default configuration file in the directory conf/config.yml - passing a string which is a path to a configuration file, supported formats: .yml, .json and .js
- passing an object which defines several options, all other options will be merged from deepstream's default values
Valve permissions rules
You can write your permission into a structured file. This file supports a special syntax, which allows you to do advanced permission checks. This syntax is called Valve.
โจ Enhancements
uws
deepstream now uses uws, a native C++ websocket server
๐ ###### no process.exit on plugin initialization error or timeout deepstream will not longer stops your process via
process.exit()
. This happened before when a connector failed to initialise correctly #243 instead it will throw an error now.Currently the API provides no event or callback to handle this error other than subscribing to the global
uncaughtException
event.process.once('uncaughtException', err => { // err.code will equal to of these constant values: // C.EVENT.PLUGIN_INITIALIZATION_TIMEOUT // or C.EVENT.PLUGIN_INITIALIZATION_ERROR })
Keep in mind that deepstream will be in an unpredictable state and you should consider to create a new instance.
๐ฅ Breaking Changes
Permission Handler
In 0.x you can set a
permissionHandler
which needs to implement two functions:isValidUser(connectionData, authData, callback)
canPerformAction(username, message, callback)
In deepstream 1.0 the
isValidUser
andonClientDisconnect
methods are no longer part of thepermissionHandler
and are instead within the newauthenticationHandler
.You can reuse the same 0.x permission handler except you will have to set it on both explicitly.
const permissionHandler = new CustomPermissionHandler() ds.set( 'permissionHandler', permissionHandler ) ds.set( 'authenticationHandler', permissionHandler )
๐ ###### Plugin API ๐ All connectors including, the
permissionHandler
,authenticationHandler
andlogger
all need to implement the plugin interface which means exporting an object that:- has a constructor
- ๐ has an
isReady
property which is true once the connector has been initialized. For example in the case a database connector this would only betrue
once the connection has been established. If the connector is synchronous you can set this to true within the constructor. - extends the EventEmitter, and emits a
ready
event once initialized anderror
on error.
Logger and colors options
๐ง The color flag can't be set in the root level of the configuration anymore. ๐ The default logger will print logs to the StdOut/StdErr in colors. ๐ง You can use the deepstream.io-logger-winston which can be configured in the config.yml file with several options.
Connection redirects
๐ฒ deepstream clients now have a handshake protocol which allows them to be redirected to the most efficient node and expect an initial connection ack before logging in. As such In order to connect a client to deepstream server you need also to have a client with version 1.0 or higher.
More details in the client changelog.