Merge pull request #541 from oskarhane/3.0-maxFrames

Listen for config maxFrames and enforce that limit in stream

Author: pe4cey

src/browser/modules/Sidebar/Settings.jsx

@@ -65,6 +65,12 @@ const visualSettings =
     {
       title: 'Result Frames',
       settings: [
+        {
+          maxFrames: {
+            displayName: 'Maximum number of result frames',
+            tooltip: 'Max number of result frames. When reached, old frames gets retired.'
+          }
+        },
         {
           maxHistory: {
             displayName: 'Max History',

src/shared/modules/settings/settingsDuck.js

@@ -65,7 +65,8 @@ const initialState = {
   maxRows: 1000,
   shouldReportUdc: true,
   autoComplete: true,
-  scrollToTop: true
+  scrollToTop: true,
+  maxFrames: 30
 }
 
 export default function settings (state = initialState, action) {

src/shared/modules/stream/__snapshots__/streamDuck.test.js.snap

@@ -0,0 +1,33 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`streamDuck cuts the number of frames when config is set 1`] = `
+Array [
+  1,
+]
+`;
+
+exports[`streamDuck cuts the number of frames when config is set 2`] = `
+Object {
+  "1": Object {
+    "id": 1,
+  },
+}
+`;
+
+exports[`streamDuck dont remove pinned frames when cutting frames 1`] = `
+Array [
+  1,
+  2,
+]
+`;
+
+exports[`streamDuck dont remove pinned frames when cutting frames 2`] = `
+Object {
+  "1": Object {
+    "isPinned": 1,
+  },
+  "2": Object {
+    "isPinned": 1,
+  },
+}
+`;

src/shared/modules/stream/epics.test.js

@@ -0,0 +1,69 @@
+/*
+ * Copyright (c) 2002-2017 "Neo Technology,"
+ * Network Engine for Objects in Lund AB [http://neotechnology.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/* global describe, afterEach, test, expect, beforeAll */
+import configureMockStore from 'redux-mock-store'
+import { createEpicMiddleware } from 'redux-observable'
+import { createBus, createReduxMiddleware } from 'suber'
+
+import * as stream from './streamDuck'
+import { update as updateSettings } from 'shared/modules/settings/settingsDuck'
+
+const bus = createBus()
+const epicMiddleware = createEpicMiddleware(stream.maxFramesConfigEpic)
+const mockStore = configureMockStore([epicMiddleware, createReduxMiddleware(bus)])
+
+describe('streamDuckEpics', () => {
+  let store
+  beforeAll(() => {
+    store = mockStore({
+      settings: {
+        cmdchar: ':',
+        maxFrames: 50
+      },
+      frames: {
+        allIds: [],
+        byId: {},
+        maxFrames: 50
+      }
+    })
+  })
+  afterEach(() => {
+    store.clearActions()
+    bus.reset()
+  })
+
+  test('listens on UPDATE and sets new maxFrames', (done) => {
+    // Given
+    const action = updateSettings({maxFrames: 3})
+    bus.take('NOOP', (currentAction) => {
+      // Then
+      expect(store.getActions()).toEqual([
+        action,
+        { type: stream.SET_MAX_FRAMES, maxFrames: 3 },
+        { type: 'NOOP' }
+      ])
+      done()
+    })
+
+    // When
+    store.dispatch(action)
+  })
+})

src/shared/modules/stream/streamDuck.js

@@ -19,8 +19,11 @@
  */
 
 import uuid from 'uuid'
+import 'rxjs/add/operator/do'
+import 'rxjs/add/operator/mapTo'
 import { moveInArray } from 'services/utils'
 import { hydrate } from 'services/duckUtils'
+import { UPDATE as SETTINGS_UPDATE } from '../settings/settingsDuck'
 
 export const NAME = 'frames'
 export const ADD = 'frames/ADD'
@@ -31,12 +34,7 @@ export const FRAME_TYPE_FILTER_UPDATED = 'frames/FRAME_TYPE_FILTER_UPDATED'
 export const PIN = `${NAME}/PIN`
 export const UNPIN = `${NAME}/UNPIN`
 export const SET_RECENT_VIEW = 'frames/SET_RECENT_VIEW'
-
-const initialState = {
-  allIds: [],
-  byId: {},
-  recentView: null
-}
+export const SET_MAX_FRAMES = NAME + '/SET_MAX_FRAMES'
 
 /**
  * Selectors
@@ -63,12 +61,11 @@ function addFrame (state, newState) {
     const pos = findFirstFreePos(state)
     allIds.splice(pos, 0, newState.id)
   }
-  return Object.assign(
-    {},
-    state,
-    {allIds: allIds},
-    {byId: byId}
-  )
+  return ensureFrameLimit({
+    ...state,
+    allIds,
+    byId
+  })
 }
 
 function removeFrame (state, id) {
@@ -129,6 +126,28 @@ function setRecentViewHelper (state, recentView) {
   return Object.assign({}, state, {recentView})
 }
 
+function ensureFrameLimit (state) {
+  const limit = state.maxFrames || 1
+  if (state.allIds.length <= limit) return state
+  let numToRemove = state.allIds.length - limit
+  let removeIds = state.allIds.slice(-1 * numToRemove).filter((id) => !state.byId[id].isPinned)
+  let byId = {...state.byId}
+  removeIds.forEach((id) => delete byId[id])
+  return {
+    ...state,
+    allIds: state.allIds.slice(0, state.allIds.length - removeIds.length),
+    byId
+  }
+}
+
+/** Inital state */
+export const initialState = {
+  allIds: [],
+  byId: {},
+  recentView: null,
+  maxFrames: 30
+}
+
 /**
  * Reducer
 */
@@ -150,6 +169,9 @@ export default function reducer (state = initialState, action) {
       return unpinFrame(state, action.id)
     case SET_RECENT_VIEW:
       return setRecentViewHelper(state, action.view)
+    case SET_MAX_FRAMES:
+      const newState = {...state, maxFrames: action.maxFrames}
+      return ensureFrameLimit(newState)
     default:
       return state
   }
@@ -203,3 +225,13 @@ export function setRecentView (view) {
     view
   }
 }
+
+// Epics
+export const maxFramesConfigEpic = (action$, store) =>
+  action$.ofType(SETTINGS_UPDATE)
+    .do((action) => {
+      const newMaxFrames = action.state.maxFrames
+      if (!newMaxFrames) return
+      store.dispatch({ type: SET_MAX_FRAMES, maxFrames: newMaxFrames })
+    })
+    .mapTo({ type: 'NOOP' })

src/shared/modules/stream/streamDuck.test.js

@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) 2002-2017 "Neo Technology,"
+ * Network Engine for Objects in Lund AB [http://neotechnology.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/* global describe, test, expect */
+import reducer, { add, SET_MAX_FRAMES, initialState } from './streamDuck'
+
+describe('streamDuck', () => {
+  test('limits the number of frames in the reducer', () => {
+    // Given
+    const init = {...initialState, maxFrames: 1}
+    const action = add({cmd: 'xxx', id: 1})
+    const action2 = add({cmd: 'yyy', id: 2})
+
+    // When
+    const newState = reducer(init, action)
+
+    // Then
+    expect(newState.allIds.length).toBe(1)
+
+    // When
+    const newState2 = reducer(newState, action2)
+
+    // Then
+    expect(newState2.allIds.length).toBe(1)
+  })
+  test('cuts the number of frames when config is set', () => {
+    // Given
+    const init = {...initialState, maxFrames: 2, allIds: [1, 2], byId: {'1': {id: 1}, '2': {id: 2}}}
+    const action = { type: SET_MAX_FRAMES, maxFrames: 1 }
+
+    // When
+    const newState = reducer(init, action)
+
+    // Then
+    expect(newState.allIds.length).toBe(1)
+    expect(newState.allIds).toMatchSnapshot()
+    expect(newState.byId).toMatchSnapshot()
+  })
+  test('dont remove pinned frames when cutting frames', () => {
+    // Given
+    const byId = {'1': {isPinned: 1}, '2': {isPinned: 1}}
+    const init = {...initialState, maxFrames: 2, allIds: [1, 2], byId}
+    const action = { type: SET_MAX_FRAMES, maxFrames: 1 }
+
+    // When
+    const newState = reducer(init, action)
+
+    // Then
+    expect(newState.allIds.length).toBe(2)
+    expect(newState.allIds).toMatchSnapshot()
+    expect(newState.byId).toMatchSnapshot()
+  })
+})

src/shared/rootEpic.js

@@ -31,6 +31,7 @@ import { featuresDiscoveryEpic } from './modules/features/featuresDuck'
 import { syncItemsEpic, clearSyncEpic, syncFavoritesEpic, loadFavoritesFromSyncEpic, loadFoldersFromSyncEpic, syncFoldersEpic } from './modules/sync/syncDuck'
 import { credentialsTimeoutEpic } from './modules/credentialsPolicy/credentialsPolicyDuck'
 import { bootEpic, incrementEventEpic, udcStartupEpic, trackSyncLogoutEpic, trackConnectsEpic, eventFiredEpic } from './modules/udc/udcDuck'
+import { maxFramesConfigEpic } from './modules/stream/streamDuck'
 
 export default combineEpics(
   handleCommandsEpic,
@@ -68,5 +69,6 @@ export default combineEpics(
   incrementEventEpic,
   trackSyncLogoutEpic,
   trackConnectsEpic,
-  eventFiredEpic
+  eventFiredEpic,
+  maxFramesConfigEpic
 )