feat: add signin and signout actions, refactor dashboard

Author: pyphilia

public/app/config/config.js

@@ -79,6 +79,11 @@ const VISIBILITIES = {
   PRIVATE: 'private',
 };
 
+const DEFAULT_FORMAT = 'v1';
+const ACTIONS_VERBS = {
+  SIGNOUT: 'signout',
+};
+
 module.exports = {
   DEFAULT_LOGGING_LEVEL,
   DEFAULT_PROTOCOL,
@@ -103,4 +108,6 @@ module.exports = {
   DEFAULT_USER_MODE,
   MAX_RECENT_SPACES,
   VISIBILITIES,
+  DEFAULT_FORMAT,
+  ACTIONS_VERBS,
 };

public/app/db.js

@@ -10,6 +10,7 @@ const fsPromises = fs.promises;
 
 const SPACES_COLLECTION = 'spaces';
 const ACTIONS_COLLECTION = 'actions';
+const USER_COLLECTION = 'user';
 const USERS_COLLECTION = 'users';
 const APP_INSTANCE_RESOURCES_COLLECTION = 'appInstanceResources';
 const CLASSROOMS_COLLECTION = 'classrooms';
@@ -37,7 +38,7 @@ const bootstrapDatabase = (dbPath = DATABASE_PATH) => {
   db.defaults({
     [SPACES_COLLECTION]: [],
     [USERS_COLLECTION]: [],
-    user: { lang: DEFAULT_LANG },
+    [USER_COLLECTION]: { lang: DEFAULT_LANG },
     [ACTIONS_COLLECTION]: [],
     [APP_INSTANCE_RESOURCES_COLLECTION]: [],
     [CLASSROOMS_COLLECTION]: [],
@@ -47,6 +48,7 @@ const bootstrapDatabase = (dbPath = DATABASE_PATH) => {
 
 module.exports = {
   SPACES_COLLECTION,
+  USER_COLLECTION,
   USERS_COLLECTION,
   APP_INSTANCE_RESOURCES_COLLECTION,
   ACTIONS_COLLECTION,

public/app/listeners/postAction.js

@@ -1,6 +1,7 @@
 const ObjectId = require('bson-objectid');
 const { POST_ACTION_CHANNEL } = require('../config/channels');
 const logger = require('../logger');
+const { DEFAULT_FORMAT } = require('../config/config');
 
 const postAction = (mainWindow, db) => (event, payload = {}) => {
   try {
@@ -9,7 +10,7 @@ const postAction = (mainWindow, db) => (event, payload = {}) => {
       appInstanceId,
       spaceId,
       subSpaceId,
-      format,
+      format = DEFAULT_FORMAT,
       verb,
       data,
       geolocation,
@@ -21,9 +22,9 @@ const postAction = (mainWindow, db) => (event, payload = {}) => {
 
     // prepare the action that we will create
     const actionToWrite = {
-      spaceId,
-      subSpaceId,
-      appInstanceId,
+      ...(spaceId ? { spaceId } : {}),
+      ...(subSpaceId ? { subSpaceId } : {}),
+      ...(appInstanceId ? { appInstanceId } : {}),
       createdAt: now,
       updatedAt: now,
       data,
@@ -40,11 +41,13 @@ const postAction = (mainWindow, db) => (event, payload = {}) => {
       .push(actionToWrite)
       .write();
 
-    // send back the resource
-    mainWindow.webContents.send(
-      `${POST_ACTION_CHANNEL}_${appInstanceId}`,
-      actionToWrite
-    );
+    // send back the action to the app
+    if (appInstanceId) {
+      mainWindow.webContents.send(
+        `${POST_ACTION_CHANNEL}_${appInstanceId}`,
+        actionToWrite
+      );
+    }
   } catch (e) {
     logger.error(e);
     mainWindow.webContents.send(POST_ACTION_CHANNEL, null);

public/electron.js

@@ -15,12 +15,17 @@ const ua = require('universal-analytics');
 const { machineIdSync } = require('node-machine-id');
 const openAboutWindow = require('about-window').default;
 const logger = require('./app/logger');
-const { ensureDatabaseExists, bootstrapDatabase } = require('./app/db');
+const {
+  ensureDatabaseExists,
+  bootstrapDatabase,
+  USER_COLLECTION,
+} = require('./app/db');
 const {
   DATABASE_PATH,
   ICON_PATH,
   PRODUCT_NAME,
   escapeEscapeCharacter,
+  ACTIONS_VERBS,
 } = require('./app/config/config');
 const {
   LOAD_SPACE_CHANNEL,
@@ -602,6 +607,18 @@ app.on('ready', async () => {
 });
 
 app.on('window-all-closed', () => {
+  // post sign out action
+  const db = bootstrapDatabase(DATABASE_PATH);
+  const { id: userId, username, anonymous, geolocation } = db
+    .get(USER_COLLECTION)
+    .value();
+  postAction(mainWindow, db)(null, {
+    userId,
+    verb: ACTIONS_VERBS.SIGNOUT,
+    data: { id: userId, username, anonymous },
+    geolocation,
+  });
+
   app.quit();
 });
 

src/actions/action.js

@@ -1,44 +1,76 @@
 import { POST_ACTION_SUCCEEDED } from '../types';
 import { POST_ACTION_CHANNEL } from '../config/channels';
+import {
+  DEFAULT_ACTIONS_AS_ENABLED,
+  DEFAULT_GEOLOCATION_ENABLED,
+} from '../config/constants';
 
 const postAction = async (
   {
-    userId,
+    userId: actionUserId,
     appInstanceId,
     spaceId,
     subSpaceId,
     format,
     data,
     verb,
-    geolocation,
     visibility,
   } = {},
+  user,
   callback
 ) => () => {
   try {
-    window.ipcRenderer.send(POST_ACTION_CHANNEL, {
-      userId,
-      appInstanceId,
-      spaceId,
-      subSpaceId,
-      format,
-      data,
-      verb,
+    const mutableUser = user.toJS();
+    const {
+      id,
+      settings: {
+        actionsEnabled = DEFAULT_ACTIONS_AS_ENABLED,
+        geolocationEnabled = DEFAULT_GEOLOCATION_ENABLED,
+      },
       geolocation,
-      visibility,
-    });
+    } = mutableUser;
 
-    window.ipcRenderer.once(
-      `${POST_ACTION_CHANNEL}_${appInstanceId}`,
-      async (event, response) => {
-        callback({
-          // have to include the appInstanceId to avoid broadcasting
-          appInstanceId,
-          type: POST_ACTION_SUCCEEDED,
-          payload: response,
-        });
+    if (actionsEnabled) {
+      // get user id
+      let userId = actionUserId;
+      if (!actionUserId) {
+        userId = id;
       }
-    );
+
+      // add geolocation to action if enabled
+      let geolocationLatLong = null;
+      if (geolocationEnabled) {
+        const { latitude, longitude } = geolocation;
+        geolocationLatLong = { ll: [latitude, longitude] };
+      }
+
+      window.ipcRenderer.send(POST_ACTION_CHANNEL, {
+        userId,
+        appInstanceId,
+        spaceId,
+        subSpaceId,
+        format,
+        data,
+        verb,
+        geolocation: geolocationLatLong,
+        visibility,
+      });
+
+      // if action from app, wait in app channel
+      if (appInstanceId) {
+        window.ipcRenderer.once(
+          `${POST_ACTION_CHANNEL}_${appInstanceId}`,
+          async (event, response) => {
+            callback({
+              // have to include the appInstanceId to avoid broadcasting
+              appInstanceId,
+              type: POST_ACTION_SUCCEEDED,
+              payload: response,
+            });
+          }
+        );
+      }
+    }
   } catch (err) {
     // do nothing
   }

src/actions/authentication.js

@@ -20,6 +20,8 @@ import {
 } from '../config/channels';
 import { createFlag } from './common';
 import { ERROR_GENERAL } from '../config/errors';
+import { postAction } from './action';
+import { ACTION_VERBS } from '../config/constants';
 
 const flagSigningIn = createFlag(FLAG_SIGNING_IN);
 const flagSigningOut = createFlag(FLAG_SIGNING_OUT);
@@ -37,6 +39,7 @@ const signIn = async ({ username, anonymous }) => async dispatch => {
           type: SIGN_IN_SUCCEEDED,
           payload: user,
         });
+        // action is sent in sign in redirection
       }
       dispatch(flagSigningIn(false));
     });
@@ -46,7 +49,7 @@ const signIn = async ({ username, anonymous }) => async dispatch => {
   }
 };
 
-const signOut = () => dispatch => {
+const signOut = user => dispatch => {
   try {
     dispatch(flagSigningOut(true));
     window.ipcRenderer.send(SIGN_OUT_CHANNEL);
@@ -58,6 +61,18 @@ const signOut = () => dispatch => {
           type: SIGN_OUT_SUCCEEDED,
           payload: response,
         });
+        const username = user.get('username');
+        const id = user.get('id');
+        const anonymous = user.get('anonymous');
+        dispatch(
+          postAction(
+            {
+              verb: ACTION_VERBS.SIGNOUT,
+              data: { username, id, anonymous },
+            },
+            user
+          )
+        );
       }
       dispatch(flagSigningOut(false));
     });

src/components/common/MainMenu.js

@@ -1,4 +1,5 @@
 import React, { Component } from 'react';
+import { Map } from 'immutable';
 import PropTypes from 'prop-types';
 import { withRouter } from 'react-router';
 import { connect } from 'react-redux';
@@ -58,6 +59,11 @@ export class MainMenu extends Component {
     location: PropTypes.shape({ pathname: PropTypes.string.isRequired })
       .isRequired,
     userMode: PropTypes.oneOf(Object.values(USER_MODES)).isRequired,
+    user: PropTypes.instanceOf(Map),
+  };
+
+  static defaultProps = {
+    user: Map(),
   };
 
   handleClick = path => {
@@ -74,12 +80,12 @@ export class MainMenu extends Component {
 
   handleSignOut() {
     // pathname inside location matches the path in url
-    const { location: { pathname } = {}, dispatchSignOut } = this.props;
+    const { location: { pathname } = {}, dispatchSignOut, user } = this.props;
     if (pathname) {
       sessionStorage.setItem('redirect', pathname);
     }
 
-    dispatchSignOut();
+    dispatchSignOut(user);
   }
 
   renderSignOut() {
@@ -342,6 +348,7 @@ const mapStateToProps = ({ authentication }) => ({
   developerMode: authentication.getIn(['user', 'settings', 'developerMode']),
   userMode: authentication.getIn(['user', 'settings', 'userMode']),
   activity: Boolean(authentication.getIn(['current', 'activity']).size),
+  user: authentication.get('user'),
 });
 const mapDispatchToProps = {
   dispatchSignOut: signOut,