Adding Tweet Streaming Feature in World Mood Tracker loklak App
The World Mood Tracker was added to loklak apps with the feature to display aggregated data from the emotion classifier of loklak server. The next step in the app was adding the feature to display the stream of Tweets from a country as they are discovered by loklak. With the addition of stream servlet in loklak, it was possible to utilise it in this app.
In this blog post, I will be discussing the steps taken while adding to introduce this feature in World Mood Tracker app.
Props for WorldMap component
The WorldMap component holds the view for the map displayed in the app. This is where API calls to classifier endpoint are made and results are displayed on the map. In order to display tweets on clicking a country, we need to define react props so that methods from higher level components can be called.
In order to enable props, we need to change the constructor for the component –
export default class WorldMap extends React.Component { constructor(props) { super(props); ... } ... }
[SOURCE]
We can now pass the method from parent component to enable streaming and other components can close the stream by using props in them –
export default class WorldMoodTracker extends React.Component { ... showStream(countryName, countryCode) { /* Do something to enable streaming component */ ... } render() { return ( ... <WorldMap showStream={this.showStream}/> ... ) } }
[SOURCE]
Defining Actions on Clicking Country Map
As mentioned in an earlier blog post, World Mood Tracker uses Datamaps to visualize data on a map. In order to trigger a piece of code on clicking a country, we can use the “done” method of the Datamaps instance. This is where we use the props passed earlier –
done: function(datamap) { datamap.svg.selectAll('.datamaps-subunit').on('click', function (geography) { props.showStream(geography.properties.name, reverseCountryCode(geography.id)); }) }
[SOURCE]
The name and ID for the country will be used to display name and make API call to stream endpoint respectively.
The StreamOverlay Component
The StreamOverlay components hold all the utilities to display the stream of Tweets from loklak. This component is used from its parent components whose state holds info about displaying this component –
export default class WorldMoodTracker extends React.Component { ... getStreamOverlay() { if (this.state.enabled) { return (<StreamOverlay show={true} channel={this.state.channel} country={this.state.country} onClose={this.onOverlayClose}/>); } } render() { return ( ... {this.getStreamOverlay()} ... ) } }
[SOURCE]
The corresponding props passed are used to render the component and connect to the stream from loklak server.
Creating Overlay Modal
On clicking the map, an overlay is shown. To display this overlay, react-overlays is used. The Modal component offered by the packages provides a very simple interface to define the design and interface of the component, including style, onclose hook, etc.
import {Modal} from 'react-overlays'; <Modal aria-labelledby='modal-label' style={modalStyle} backdropStyle={backdropStyle} show={true} onHide={this.close}> <div style={dialogStyle()}> ... </div> </Modal>
[SOURCE]
It must be noted that modalStyle and backdropStyle are React style objects.
Dialog Style
The dialog style is defined to provide some space at the top, clicking where, the overlay is closed. To do this, vertical height units are used –
const dialogStyle = function () { return { position: 'absolute', width: '100%', top: '5vh', height: '95vh', padding: 20 ... }; };
[SOURCE]
Connecting to loklak Tweet Stream
loklak sends Server Sent Events to clients connected to it. To utilise this stream, we can use the natively supported EventSource object. Event stream is started with the render method of the StreamOverlay component –
render () { this.startEventSource(this.props.channel); ... }
[SOURCE]
This channel is used to connect to twitter/country/<country-ID> channel on the stream and then this can be passed to EventStream constructor. On receiving a message, a list of Tweets is appended and later rendered in the view –
startEventSource(country) { let channel = 'twitter%2Fcountry%2F' + country; if (this.eventSource) { return; } this.eventSource = new EventSource(host + '/api/stream.json?channel=' + channel); this.eventSource.onmessage = (event) => { let json = JSON.parse(event.data); this.state.tweets.push(json); if (this.state.tweets.length > 250) { this.state.tweets.shift(); } this.setState(this.state); }; }
[SOURCE]
The size of the list is restricted to 250 here, so when a newer Tweet comes in, the oldest one is chopped off. And thanks to fast DOM actions in React, the rendering doesn’t take much time.
Rendering Tweets
The Tweets are displayed as simple cards on which user can click to open it on Twitter in a new tab. It contains basic information about the Tweet – screen name and Tweet text. Images are not rendered as it would make no sense to load them when Tweets are coming at a high rate.
function getTweetHtml(json) { return ( <div style={{padding: '5px', borderRadius: '3px', border: '1px solid black', margin: '10px'}}> <a href={json.link} target="_blank"> <div style={{marginBottom: '5px'}}> <b>@{json['screen_name']}</b> </div> <div style={{overflowX: 'hidden'}}>{json['text']}</div> </a> </div> ) }
[SOURCE]
They are rendered using a simple map in the render method of StreamOverlay component –
<div className={styles.container} style={{'height': '100%', 'overflowY': 'auto', 'overflowX': 'hidden', maxWidth: '100%'}}> {this.state.tweets.reverse().map(getTweetHtml)} </div>
[SOURCE]
Closing Overlay
With the previous setup in place, we can now see Tweets from the loklak backend as they arrive. But the problem is that we will still be connected to the stream when we click-close the modal. Also, we would need to close the overlay from the parent component in order to stop rendering it.
We can use the onclose method for the Modal here –
close() { if (this.eventSource) { this.eventSource.close(); this.eventSource = null; } this.props.onClose(); }
[SOURCE]
Here, props.onClose() disables rendering of StreamOverlay in the parent component.
Conclusion
In this blog post, I explained how the flow of props are used in the World Mood Tracker app to turn on and off the streaming in the overlay defined using react-overlays. This feature shows a basic setup for using the newly introduced stream API in loklak.
The motivation of such application was taken from emojitracker by mroth as mentioned in fossasia/labs.fossasia.org#136. The changes were proposed in fossasia/apps.loklak.org#315 by @singhpratyush (me).
The app can be accessed live at https://singhpratyush.github.io/world-mood-tracker/index.html.
Resources
- DataMaps documentation – https://github.com/markmarkoh/datamaps/blob/master/README.md#getting-started.
- React-overlays documentation and examples – https://react-bootstrap.github.io/react-overlays/.
- How I Built Emojitracker by Matthew Rothenberg – https://medium.com/@mroth/how-i-built-emojitracker-179cfd8238ac.
- Props in ReactJS – https://facebook.github.io/react/docs/components-and-props.html.
- Channels available in loklak server for streaming – https://github.com/loklak/loklak_server/blob/development/docs/misc/StreamChannels.md.
You must be logged in to post a comment.