Bento Event Relay

Relays Redis PubSub events to front-ends via Socket.IO. Originally designed for the Bento platform, but can be used in a more generic context if needed.

Configuration

All configuration is done via environment variables:

# If true, JSON_MESSAGES will parse all messages received from the subscription
# and de-serialize them before passing them to the socket.io connection.
# e.g. If the message {"test": true} is passed with JSON_MESSAGES on, the
# corresponding socket.io message will be:
# {"message": {"test": true}, "channel": "chord.something"}
# Otherwise, the message will be:
# {"message": "{\"test\": true}", "channel": "chord.something"}
JSON_MESSAGES="true" 

# Default: blank, base path for the service-info endpoint
# If blank, the service-info endpoint will be mounted on /service-info
# If e.g. /base, the endpoint will be mounted on /base/service-info
SERVICE_URL_BASE_PATH=

# socket.io "path" for the server created by the service. Socket.io requires
# a trailing slash.
SOCKET_IO_PATH="/socket.io/"

# Connection string (redis:// URL or path to UNIX socket file) for the Redis instance.
REDIS_CONNECTION=

# Subscription pattern the Redis PubSub connection. The default is configured
# to the below value for the Bento platform, but it can be set to anything.
# See https://redis.io/topics/pubsub and specifically the pattern-matching.
REDIS_SUBSCRIBE_PATTERN="bento.*"

# Where the service will listen for requests. Can be a UNIX socket path or a
# port number (e.g. 8080, which is the default value if nothing is set.)
# Will also check the SERVICE_SOCKET environment variable for legacy reasons
# related to the Bento platform.
SERVICE_LISTEN_ON=8080
SERVICE_LISTEN_ON="/path/to/event_relay.sock"

Starting

To start bento_event_relay in "production" mode, run the following:

NODE_ENV=production npm run start

To start it in "development" mode (with automatic restart on file changes), run the following:

NODE_ENV=development npx nodemon

HTTP Endpoints

The bento_event_relay service only has one HTTP endpoint, /service-info, which follows the GA4GH service-info schema standard.