Why use Bifröst?

Quickstart

Usage

1. Create an API endpoint in your application that can give users a realtime token

get"/api/bifrost-token"doauthenticate_user!payload={channels:["user:#{current_user.id}","global"]}jwt=JWT.encode(payload,ENV["JWT_SECRET"],"HS512"){token:jwt}.to_jsonend

2. Subscribe clients to channels

// Recommend using ReconnectingWebSocket to automatically reconnect websockets if you deploy the server or have any network disconnectionsimportReconnectingWebSocketfrom"reconnectingwebsocket";letws=newReconnectingWebSocket(`${process.env.BIFROST_WSS_URL}/subscribe`);// URL your bifrost server is running on// Step 1// ======// When you first open the websocket the goal is to request a signed realtime// token from your server side application and then authenticate with bifrost,// subscribing your user to the channels your server side app allows them to// connect tows.onopen=function(){axios.get("/api/bifrost-token").then((resp)=>{constjwtToken=resp.data.token;constmsg={event:"authenticate",data:jwtToken,// Your server generated token with allowed channels};ws.send(JSON.stringify(msg));console.log("WS Connected");});};// Step 2// ======// Upon receiving a message you can check the event name and ignore subscribed// and pong events, everything else will be an event sent by your server side// app.ws.onmessage=function(event){constmsg=JSON.parse(event.data);switch(msg.event){case"subscribed":{constchannelName=JSON.parse(msg.data).channel;console.log(`Subscribed to channel${channelName}`);break;}default:{// Note:// We advise you broadcast messages with a data keyconsteventData=JSON.parse(msg.data);console.log(`Bifrost msg:${msg.event}`,eventData);if(msg.event==="new_item"){console.log("new item!",eventData);}}}};// Step 3// ======// Do some cleanup when the socket closesws.onclose=function(event){console.error("WS Closed",event);};

3. Broadcast messages from the server

data={channel:"user:1",# Channel to broadcast tomessage:{event:"new_item",data:JSON.dump(item)},exp:Time.zone.now.to_i +1.hour}jwt=JWT.encode(data,ENV["JWT_SECRET"],"HS512")url=ENV.fetch("BIFROST_URL")url +="/broadcast"req=HTTP.post(url,json:{token:jwt})ifreq.status >206raise"Error communicating with Bifrost server on URL:#{url}"end

You're done 🚀

Ping Pong 🏓

GET /info.json

{"stats":{"deliveries":117,"connected":21  }}

Contributing

Prerequisites

brew install crystal-lang

Running locally

JWT_SECRET=[> 64 character string]

./sentry

Running the tests

crystal spec

Built With

Versioning

Authors

License