feat: add recent spaces, home displays favorite and recent spaces

Author: pyphilia

public/app/config/channels.js

@@ -49,4 +49,5 @@ module.exports = {
   GET_USER_MODE_CHANNEL: 'user:mode:get',
   SET_USER_MODE_CHANNEL: 'user:mode:set',
   SET_SPACE_AS_FAVORITE_CHANNEL: 'user:set-space-favorite:set',
+  SET_SPACE_AS_RECENT_CHANNEL: 'user:set-space-recent:set',
 };

public/app/config/config.js

@@ -63,10 +63,13 @@ const DEFAULT_USER = {
     userMode: DEFAULT_USER_MODE,
   },
   favoriteSpaces: [],
+  recentSpaces: [],
 };
 
 const ANONYMOUS_USERNAME = 'Anonymous';
 
+const MAX_RECENT_SPACES_SPACES = 5;
+
 module.exports = {
   DEFAULT_LOGGING_LEVEL,
   DEFAULT_PROTOCOL,
@@ -89,4 +92,5 @@ module.exports = {
   VISUAL_SYNC_MODE,
   DEFAULT_SYNC_MODE,
   DEFAULT_USER_MODE,
+  MAX_RECENT_SPACES_SPACES,
 };

public/app/config/messages.js

@@ -61,6 +61,8 @@ const ERROR_GETTING_USER_MODE = 'There was an error getting the user mode';
 const ERROR_SETTING_USER_MODE = 'There was an error setting the user mode';
 const ERROR_SETTING_SPACE_AS_FAVORITE =
   'There was an error setting space as favorite';
+const ERROR_SETTING_SPACE_AS_RECENT =
+  'There was an error setting space as recent space';
 
 module.exports = {
   ERROR_GETTING_DEVELOPER_MODE,
@@ -108,4 +110,5 @@ module.exports = {
   ERROR_SETTING_USER_MODE,
   ERROR_GETTING_USER_MODE,
   ERROR_SETTING_SPACE_AS_FAVORITE,
+  ERROR_SETTING_SPACE_AS_RECENT,
 };

public/app/listeners/index.js

@@ -30,6 +30,7 @@ const postAppInstanceResource = require('./postAppInstanceResource');
 const patchAppInstanceResource = require('./patchAppInstanceResource');
 const getAppInstance = require('./getAppInstance');
 const setSpaceAsFavorite = require('./setSpaceAsFavorite');
+const setSpaceAsRecent = require('./setSpaceAsRecent');
 
 module.exports = {
   loadSpace,
@@ -64,4 +65,5 @@ module.exports = {
   getUserMode,
   setUserMode,
   setSpaceAsFavorite,
+  setSpaceAsRecent,
 };

public/app/listeners/loadSpace.js

@@ -97,7 +97,7 @@ const loadSpace = (mainWindow, db) => async (event, { fileLocation }) => {
       .push(...actions)
       .write();
 
-    return mainWindow.webContents.send(LOADED_SPACE_CHANNEL);
+    return mainWindow.webContents.send(LOADED_SPACE_CHANNEL, { spaceId: id });
   } catch (err) {
     logger.error(err);
     mainWindow.webContents.send(LOADED_SPACE_CHANNEL, ERROR_GENERAL);

public/app/listeners/setSpaceAsFavorite.js

@@ -6,31 +6,19 @@ const setSpaceAsFavorite = (mainWindow, db) => async (
   event,
   { spaceId, favorite }
 ) => {
-  // add spaceId if does not exist
   try {
-    if (favorite) {
-      const foundId = db
-        .get('user.favoriteSpaces')
-        .find(id => id === spaceId)
-        .value();
-      if (!foundId) {
-        db.get('user.favoriteSpaces')
-          .push(spaceId)
-          .write();
-      }
+    const favoriteSpaces = db.get('user.favoriteSpaces');
+    const foundId = favoriteSpaces.find(id => id === spaceId).value();
+
+    // add spaceId if does not exist
+    if (favorite && !foundId) {
+      favoriteSpaces.push(spaceId).write();
     }
     // remove spaceId if exists
-    else {
-      const foundId = db
-        .get('user.favoriteSpaces')
-        .find(id => id === spaceId)
-        .value();
-      if (foundId) {
-        db.get('user.favoriteSpaces')
-          .remove(id => id === spaceId)
-          .write();
-      }
+    else if (!favorite && foundId) {
+      favoriteSpaces.remove(id => id === spaceId).write();
     }
+
     mainWindow.webContents.send(SET_SPACE_AS_FAVORITE_CHANNEL, {
       favorite,
       spaceId,

public/app/listeners/setSpaceAsRecent.js

@@ -0,0 +1,43 @@
+const { SET_SPACE_AS_RECENT_CHANNEL } = require('../config/channels');
+const logger = require('../logger');
+const { ERROR_GENERAL } = require('../config/errors');
+const { MAX_RECENT_SPACES_SPACES } = require('../config/config');
+
+const setSpaceAsRecent = (mainWindow, db) => async (
+  event,
+  { spaceId, isRecent }
+) => {
+  try {
+    const recentSpaces = db.get('user.recentSpaces');
+    const foundId = recentSpaces.find(id => id === spaceId).value();
+
+    // add spaceId
+    if (isRecent) {
+      // if exist, remove, then push
+      if (foundId) {
+        recentSpaces.remove(id => id === spaceId).write();
+      }
+      recentSpaces.push(spaceId).write();
+
+      // remove first element if contains more than fixed elements
+      if (recentSpaces.size().value() > MAX_RECENT_SPACES_SPACES) {
+        const firstEl = recentSpaces.take(1).value();
+        recentSpaces.remove(firstEl).write();
+      }
+    }
+    // remove spaceId if exists
+    else if (!isRecent && foundId) {
+      recentSpaces.remove(id => id === spaceId).write();
+    }
+
+    mainWindow.webContents.send(SET_SPACE_AS_RECENT_CHANNEL, {
+      isRecent,
+      spaceId,
+    });
+  } catch (e) {
+    logger.error(e);
+    mainWindow.webContents.send(SET_SPACE_AS_RECENT_CHANNEL, ERROR_GENERAL);
+  }
+};
+
+module.exports = setSpaceAsRecent;

public/electron.js

@@ -57,6 +57,7 @@ const {
   GET_USER_MODE_CHANNEL,
   SET_USER_MODE_CHANNEL,
   SET_SPACE_AS_FAVORITE_CHANNEL,
+  SET_SPACE_AS_RECENT_CHANNEL,
 } = require('./app/config/channels');
 const env = require('./env.json');
 const {
@@ -92,6 +93,7 @@ const {
   setUserMode,
   getUserMode,
   setSpaceAsFavorite,
+  setSpaceAsRecent,
 } = require('./app/listeners');
 const isMac = require('./app/utils/isMac');
 
@@ -406,9 +408,12 @@ app.on('ready', async () => {
   // called when getting sync mode
   ipcMain.on(GET_SYNC_MODE_CHANNEL, getSyncMode(mainWindow, db));
 
-  // called when setting developer mode
+  // called when setting space as favorite
   ipcMain.on(SET_SPACE_AS_FAVORITE_CHANNEL, setSpaceAsFavorite(mainWindow, db));
 
+  // called when setting space as recent
+  ipcMain.on(SET_SPACE_AS_RECENT_CHANNEL, setSpaceAsRecent(mainWindow, db));
+
   // called when getting geolocation enabled
   ipcMain.on(
     GET_GEOLOCATION_ENABLED_CHANNEL,

src/App.js

@@ -15,7 +15,6 @@ import SpacesNearby from './components/SpacesNearby';
 import Settings from './components/Settings';
 import LoadSpace from './components/LoadSpace';
 import SpaceScreen from './components/space/SpaceScreen';
-import FavoriteSpaces from './components/FavoriteSpaces';
 import SyncScreen from './components/space/SyncScreen';
 import DeveloperScreen from './components/developer/DeveloperScreen';
 import { OnlineTheme, OfflineTheme } from './themes';
@@ -33,7 +32,7 @@ import {
   DEVELOPER_PATH,
   DASHBOARD_PATH,
   SIGN_IN_PATH,
-  FAVORITE_PATH,
+  SAVED_SPACES_PATH,
 } from './config/paths';
 import {
   getGeolocation,
@@ -50,6 +49,7 @@ import {
   CONNECTION_ONLINE_MESSAGE,
 } from './config/messages';
 import './App.css';
+import SavedSpaces from './components/SavedSpaces';
 
 const styles = () => ({
   toastrIcon: { marginBottom: '-20px', fontSize: '45px' },
@@ -165,8 +165,8 @@ export class App extends Component {
                   />
                   <Route
                     exact
-                    path={FAVORITE_PATH}
-                    component={Authorization()(FavoriteSpaces)}
+                    path={SAVED_SPACES_PATH}
+                    component={Authorization()(SavedSpaces)}
                   />
                   <Route
                     exact