From 98a4f832b90fde146db881b80032b8fae858648c Mon Sep 17 00:00:00 2001
From: Titouan Rigoudy <titouan.rigoudy@gmail.com>
Date: Fri, 11 Mar 2016 14:05:04 +0100
Subject: [PATCH] Add LoginStatusPane.

---
 src/actions/socketHandlerActions.js  |  14 ++--
 src/components/ConnectForm.js        |  12 ++--
 src/components/SolsticeApp.js        |  11 +--
 src/constants/login.js               |   4 ++
 src/containers/LoginStatusPane.js    | 104 +++++++++++++++++++++++++++
 src/reducers/index.js                |   2 +
 src/reducers/login.js                |  56 +++++++++++++++
 src/reducers/socket.js               |   6 +-
 src/utils/propTypeRequiredWrapper.js |  15 ++++
 src/utils/propTypeSymbol.js          |  20 ++++++
 10 files changed, 223 insertions(+), 21 deletions(-)
 create mode 100644 src/constants/login.js
 create mode 100644 src/containers/LoginStatusPane.js
 create mode 100644 src/reducers/login.js
 create mode 100644 src/utils/propTypeRequiredWrapper.js
 create mode 100644 src/utils/propTypeSymbol.js

diff --git a/src/actions/socketHandlerActions.js b/src/actions/socketHandlerActions.js
index 2bccdaa..a4735dd 100644
--- a/src/actions/socketHandlerActions.js
+++ b/src/actions/socketHandlerActions.js
@@ -13,18 +13,18 @@ export default {
         }
     }),
 
-    onerror: event => ({
-        type: SOCKET_SET_ERROR
-    }),
+    onerror: event => ({ type: SOCKET_SET_ERROR }),
 
-    onopen: event => (dispatch, getState) => ({
-        type: SOCKET_SET_OPEN
-    }),
+    onopen: event => ({ type: SOCKET_SET_OPEN }),
 
     onmessage: event => {
         const action = { type: SOCKET_RECEIVE_MESSAGE };
         try {
-            action.payload = JSON.parse(event.data);
+            const { variant, fields: [data] } = JSON.parse(event.data);
+            if (typeof variant === "undefined") {
+                throw new Error('Missing "variant" field in control response');
+            }
+            action.payload = { variant, data };
         } catch (err) {
             action.error = true;
             action.payload = err;
diff --git a/src/components/ConnectForm.js b/src/components/ConnectForm.js
index 2b8d2f6..e8952a4 100644
--- a/src/components/ConnectForm.js
+++ b/src/components/ConnectForm.js
@@ -5,12 +5,12 @@ import { STATE_CLOSED } from "../constants/socket";
 import ControlRequest from "../utils/ControlRequest";
 
 const ConnectForm = (props) => {
-    const { fields: { url }, handleSubmit, socket, socketActions } = props;
-    const submit = (values, dispatch) => {
-        dispatch(socketActions.open(values.url));
-    };
+    const { fields: { url }, handleSubmit, socket, socketOpen } = props;
+
+    const onSubmit = handleSubmit((values) => socketOpen(values.url));
+
     return (
-        <form onSubmit={handleSubmit(submit)}>
+        <form onSubmit={onSubmit}>
             <input type="url" defaultValue="ws://localhost:2244" {...url}
                 required pattern="wss?://.+"/>
             <button type="submit" disabled={socket.state !== STATE_CLOSED}>
@@ -24,7 +24,7 @@ ConnectForm.propTypes = {
     fields: PropTypes.object.isRequired,
     handleSubmit: PropTypes.func.isRequired,
     socket: PropTypes.object.isRequired,
-    socketActions: PropTypes.object.isRequired
+    socketOpen: PropTypes.func.isRequired
 };
 
 export default reduxForm({
diff --git a/src/components/SolsticeApp.js b/src/components/SolsticeApp.js
index 22b65b6..42889c5 100644
--- a/src/components/SolsticeApp.js
+++ b/src/components/SolsticeApp.js
@@ -3,15 +3,17 @@ import React, {PropTypes} from "react";
 import ConnectForm from  "../components/ConnectForm";
 import SocketStatusPane from "../components/SocketStatusPane";
 
+import LoginStatusPane from "../containers/LoginStatusPane";
+
 import { STATE_OPEN } from "../constants/socket";
 
 const SolsticeApp = (props) => {
-    const { socket, actions } = props;
+    const { actions, socket } = props;
     if (socket.state !== STATE_OPEN ) {
         return (
             <main>
                 <ConnectForm socket={socket}
-                    socketActions={actions.socketActions}/>
+                    socketOpen={actions.socketActions.open}/>
                 <SocketStatusPane {...socket} />
             </main>
         );
@@ -20,13 +22,14 @@ const SolsticeApp = (props) => {
         <main>
             <h1>Solstice web UI</h1>
             <SocketStatusPane {...socket} />
+            <LoginStatusPane socketSend={actions.socketActions.send}/>
         </main>
     );
 };
 
 SolsticeApp.propTypes = {
-    socket: PropTypes.object.isRequired,
-    actions: PropTypes.object.isRequired
+    actions: PropTypes.object.isRequired,
+    socket: PropTypes.object.isRequired
 };
 
 export default SolsticeApp;
diff --git a/src/constants/login.js b/src/constants/login.js
new file mode 100644
index 0000000..a172aae
--- /dev/null
+++ b/src/constants/login.js
@@ -0,0 +1,4 @@
+export const LOGIN_STATUS_UNKNOWN = Symbol("LOGIN_STATUS_UNKNOWN");
+export const LOGIN_STATUS_PENDING = Symbol("LOGIN_STATUS_PENDING");
+export const LOGIN_STATUS_SUCCESS = Symbol("LOGIN_STATUS_SUCCESS");
+export const LOGIN_STATUS_FAILURE = Symbol("LOGIN_STATUS_FAILURE");
diff --git a/src/containers/LoginStatusPane.js b/src/containers/LoginStatusPane.js
new file mode 100644
index 0000000..70e8608
--- /dev/null
+++ b/src/containers/LoginStatusPane.js
@@ -0,0 +1,104 @@
+import React, { PropTypes } from "react";
+import { connect } from "react-redux";
+
+import ControlRequest from "../utils/ControlRequest";
+import propTypeSymbol from "../utils/propTypeSymbol";
+import {
+    LOGIN_STATUS_UNKNOWN,
+    LOGIN_STATUS_PENDING,
+    LOGIN_STATUS_SUCCESS,
+    LOGIN_STATUS_FAILURE
+} from "../constants/login";
+
+const ID = "login-status-pane";
+
+const INTERVAL_MSEC = 60 * 1000;
+
+class LoginStatusPane extends React.Component
+{
+    constructor(props) {
+        super(props);
+    }
+
+    componentDidMount() {
+        const fetchStatus = () => {
+            this.props.socketSend(ControlRequest.loginStatus());
+        };
+        fetchStatus();
+        // Refresh login status periodically
+        this.interval_id = setInterval(fetchStatus, INTERVAL_MSEC);
+    }
+
+    componentWillUnmount() {
+        clearInterval(this.interval_id);
+    }
+
+    render_unknown() {
+        return (
+            <div id={ID}>
+                Fetching login status...
+            </div>
+        );
+    }
+
+    render_pending() {
+        return (
+            <div id={ID}>
+                Logging in as {this.props.username}...
+            </div>
+        );
+    }
+
+    render_success() {
+        let motd_element;
+        if (this.props.motd) {
+            motd_element = (
+                <span id="login-motd">
+                    MOTD: {this.props.motd}
+                </span>
+            );
+        }
+        return (
+            <div id={ID}>
+                Logged in as {this.props.username}
+                {motd_element}
+            </div>
+        );
+    }
+
+    render_failure() {
+        return (
+            <div id={ID}>
+                Failed to log in as {this.props.username}
+                <span id="login-reason">
+                    Reason: {this.props.reason}
+                </span>
+            </div>
+        );
+    }
+
+    render() {
+        switch (this.props.status) {
+            case LOGIN_STATUS_UNKNOWN:
+                return this.render_unknown();
+            case LOGIN_STATUS_PENDING:
+                return this.render_pending();
+            case LOGIN_STATUS_SUCCESS:
+                return this.render_success();
+            case LOGIN_STATUS_FAILURE:
+                return this.render_failure();
+        }
+    }
+}
+
+LoginStatusPane.propTypes = {
+    status: propTypeSymbol.isRequired,
+    username: PropTypes.string,
+    motd: PropTypes.string,
+    reason: PropTypes.string,
+    socketSend: PropTypes.func.isRequired
+};
+
+export default connect(
+    state => state.login
+)(LoginStatusPane);
diff --git a/src/reducers/index.js b/src/reducers/index.js
index 046f269..b986903 100644
--- a/src/reducers/index.js
+++ b/src/reducers/index.js
@@ -1,9 +1,11 @@
 import { combineReducers } from "redux";
 import { reducer as form } from "redux-form";
 
+import login from "./login";
 import socket from "./socket";
 
 const rootReducer = combineReducers({
+    login,
     socket,
     form
 });
diff --git a/src/reducers/login.js b/src/reducers/login.js
new file mode 100644
index 0000000..975d633
--- /dev/null
+++ b/src/reducers/login.js
@@ -0,0 +1,56 @@
+import { SOCKET_RECEIVE_MESSAGE } from "../constants/ActionTypes";
+import {
+    LOGIN_STATUS_UNKNOWN,
+    LOGIN_STATUS_PENDING,
+    LOGIN_STATUS_SUCCESS,
+    LOGIN_STATUS_FAILURE
+} from "../constants/login";
+
+const initialState = {
+    status: LOGIN_STATUS_UNKNOWN
+};
+
+export default (state = initialState, action) => {
+    const { type, payload } = action;
+    if (type !== SOCKET_RECEIVE_MESSAGE) {
+        return state;
+    }
+
+    const { variant, data } = payload;
+    if (variant !== "LoginStatusResponse") {
+        return state;
+    }
+
+    switch (data.variant) {
+        case "Pending":
+        { // sub-block required otherwise const username declarations clash
+            const [ username ] = data.fields;
+            return {
+                status: LOGIN_STATUS_PENDING,
+                username
+            };
+        }
+        case "Success":
+        { // sub-block required otherwise const username declarations clash
+            const [ username, motd ] = data.fields;
+            return {
+                status: LOGIN_STATUS_SUCCESS,
+                username,
+                motd
+            };
+        }
+
+        case "Failure":
+        { // sub-block required otherwise const username declarations clash
+            const [ username, reason ] = data.fields;
+            return {
+                status: LOGIN_STATUS_FAILURE,
+                username,
+                reason
+            };
+        }
+
+        default:
+            return state;
+    }
+};
diff --git a/src/reducers/socket.js b/src/reducers/socket.js
index 3e34b3e..ba32ab8 100644
--- a/src/reducers/socket.js
+++ b/src/reducers/socket.js
@@ -1,5 +1,3 @@
-import objectAssign from "object-assign";
-
 import * as types from "../constants/ActionTypes";
 import {
     STATE_OPENING, STATE_OPEN, STATE_CLOSING, STATE_CLOSED
@@ -10,7 +8,7 @@ const initialState = {
     url: null
 };
 
-export default function socket(state = initialState, action) {
+export default (state = initialState, action) => {
     switch (action.type) {
         case types.SOCKET_SET_OPENING:
             if (action.error) {
@@ -47,4 +45,4 @@ export default function socket(state = initialState, action) {
         default:
             return state;
     }
-}
+};
diff --git a/src/utils/propTypeRequiredWrapper.js b/src/utils/propTypeRequiredWrapper.js
new file mode 100644
index 0000000..da57263
--- /dev/null
+++ b/src/utils/propTypeRequiredWrapper.js
@@ -0,0 +1,15 @@
+const checkRequiredThenValidate = (validator) =>
+    (props, propName, componentName, ...rest) =>
+{
+    if (props[propName] !== null) {
+        return validator(props, propName, componentName, ...rest);
+    }
+    return new Error(
+        `Missing prop \`${propName}\` not supplied to \`${componentName}\``
+    );
+};
+
+export default (validator) => {
+    validator.isRequired = checkRequiredThenValidate(validator);
+    return validator;
+};
diff --git a/src/utils/propTypeSymbol.js b/src/utils/propTypeSymbol.js
new file mode 100644
index 0000000..7c39ffa
--- /dev/null
+++ b/src/utils/propTypeSymbol.js
@@ -0,0 +1,20 @@
+import propTypeRequiredWrapper from "./propTypeRequiredWrapper";
+
+// Simple validator for Symbols (instanceof does not work on symbols).
+function propTypeSymbol(props, propName, componentName) {
+    const prop = props[propName];
+    if (prop === null) {
+        return;
+    }
+    const type = typeof prop;
+    if (type === "symbol") {
+        return;
+    }
+    return new Error(
+        `Invalid prop \`${propName}\` of type \`${type}\` ` +
+        `supplied to \`${componentName}\`, expected \`symbol\``
+    );
+}
+
+export default propTypeRequiredWrapper(propTypeSymbol);
+