Merge pull request #498 from oskarhane/3.0-store-credentials-config

Read and act on server config retain_connection_credentials

Author: irfannuri

package.json

@@ -98,7 +98,7 @@
     "redux-devtools": "^3.2.0",
     "redux-devtools-dock-monitor": "^1.1.1",
     "redux-devtools-log-monitor": "^1.0.11",
-    "redux-mock-store": "^1.2.2",
+    "redux-mock-store": "^1.2.3",
     "standard": "^8.6.0",
     "style-loader": "^0.16.1",
     "url-loader": "^0.5.8",

src/browser/modules/Stream/Auth/ConnectedView.jsx

@@ -20,13 +20,13 @@
 
 import { StyledConnectionBody, StyledCode, StyledConnectionFooter } from './styled'
 
-const ConnectedView = ({host, username}) => {
+const ConnectedView = ({host, username, storeCredentials}) => {
   return (
     <StyledConnectionBody>
       You are connected as user <StyledCode>{username}</StyledCode><br />
       to the server <StyledCode>{host}</StyledCode><br />
       <StyledConnectionFooter>
-        Connection credentials are stored in your web browser.
+        Connection credentials are {(storeCredentials ? '' : 'not ')}stored in your web browser.
       </StyledConnectionFooter>
     </StyledConnectionBody>
   )

src/browser/modules/Stream/Auth/ConnectionForm.jsx

@@ -24,6 +24,7 @@ import { withBus } from 'preact-suber'
 import { getActiveConnectionData, getActiveConnection, setActiveConnection, updateConnection, CONNECT } from 'shared/modules/connections/connectionsDuck'
 import { getInitCmd, updateBoltRouting } from 'shared/modules/settings/settingsDuck'
 import { executeSystemCommand } from 'shared/modules/commands/commandsDuck'
+import { shouldRetainConnectionCredentials } from 'shared/modules/dbMeta/dbMetaDuck'
 import { FORCE_CHANGE_PASSWORD } from 'shared/modules/cypher/cypherDuck'
 import { changeCurrentUsersPasswordQueryObj } from 'shared/modules/cypher/procedureFactory'
 import { toBoltHost, isRoutingHost } from 'services/utils'
@@ -151,6 +152,7 @@ export class ConnectionForm extends Component {
       view = <ConnectedView
         host={this.props.activeConnectionData.host}
         username={this.props.activeConnectionData.username}
+        storeCredentials={this.props.storeCredentials}
       />
     } else if (!this.state.isConnected && !this.state.passwordChangeNeeded) {
       view = (<ConnectForm
@@ -172,7 +174,8 @@ const mapStateToProps = (state) => {
   return {
     initCmd: getInitCmd(state),
     activeConnection: getActiveConnection(state),
-    activeConnectionData: getActiveConnectionData(state)
+    activeConnectionData: getActiveConnectionData(state),
+    storeCredentials: shouldRetainConnectionCredentials(state)
   }
 }
 
@@ -191,6 +194,7 @@ const mergeProps = (stateProps, dispatchProps, ownProps) => {
   return {
     activeConnection: stateProps.activeConnection,
     activeConnectionData: stateProps.activeConnectionData,
+    storeCredentials: stateProps.storeCredentials,
     ...ownProps,
     ...dispatchProps,
     executeInitCmd: () => {

src/shared/modules/connections/connectionsDuck.js

@@ -41,6 +41,7 @@ export const CONNECTION_SUCCESS = 'connections/CONNECTION_SUCCESS'
 export const DISCONNECTION_SUCCESS = 'connections/DISCONNECTION_SUCCESS'
 export const LOST_CONNECTION = 'connections/LOST_CONNECTION'
 export const UPDATE_CONNECTION_STATE = 'connections/UPDATE_CONNECTION_STATE'
+export const UPDATE_RETAIN_CREDENTIALS = NAME + '/UPDATE_RETAIN_CREDENTIALS'
 
 export const DISCONNECTED_STATE = 0
 export const CONNECTED_STATE = 1
@@ -78,7 +79,13 @@ export function getActiveConnection (state) {
 }
 
 export function getActiveConnectionData (state) {
-  return state[NAME].activeConnection ? state[NAME].connectionsById[state[NAME].activeConnection] : null
+  if (!state[NAME].activeConnection) return null
+  let data = state[NAME].connectionsById[state[NAME].activeConnection]
+  if (data.username && data.password) return data
+  if (!(data.username && data.password) && (memoryUsername && memoryPassword)) { // No retain state
+    return {...data, username: memoryUsername, password: memoryPassword}
+  }
+  return data
 }
 
 const addConnectionHelper = (state, obj) => {
@@ -134,6 +141,11 @@ const mergeConnectionHelper = (state, connection) => {
   )
 }
 
+// Local vars
+let memoryUsername = ''
+let memoryPassword = ''
+
+// Reducer
 export default function (state = initialState, action) {
   state = hydrate(initialState, state)
 
@@ -210,11 +222,20 @@ export const connectionLossFilter = (action) => {
   return notLostCodes.indexOf(action.error.code) < 0
 }
 
+export const setRetainCredentials = (shouldRetain) => {
+  return {
+    type: UPDATE_RETAIN_CREDENTIALS,
+    shouldRetain
+  }
+}
+
 // Epics
 export const connectEpic = (action$, store) => {
   return action$.ofType(CONNECT)
     .mergeMap((action) => {
       if (!action.$$responseChannel) return Rx.Observable.of(null)
+      memoryUsername = ''
+      memoryPassword = ''
       return bolt.openConnection(action, { encrypted: getEncryptionMode() }, onLostConnection(store.dispatch))
         .then((res) => ({ type: action.$$responseChannel, success: true }))
         .catch(([e]) => ({ type: action.$$responseChannel, success: false, error: e }))
@@ -324,3 +345,26 @@ export const checkSettingsForRoutingDriver = (action$, store) => {
       return { type: 'NOOP' }
     })
 }
+
+export const retainCredentialsSettingsEpic = (action$, store) => {
+  return action$.ofType(UPDATE_RETAIN_CREDENTIALS)
+    .do((action) => {
+      const connection = getActiveConnectionData(store.getState())
+      if (!action.shouldRetain && (connection.username || connection.password)) {
+        memoryUsername = connection.username
+        memoryPassword = connection.password
+        connection.username = ''
+        connection.password = ''
+        return store.dispatch(updateConnection(connection))
+      }
+      if (action.shouldRetain && memoryUsername && memoryPassword) {
+        connection.username = memoryUsername
+        connection.password = memoryPassword
+        memoryUsername = ''
+        memoryPassword = ''
+        return store.dispatch(updateConnection(connection))
+      }
+      return
+    })
+    .mapTo({ type: 'NOOP' })
+}

src/shared/modules/connections/connectionsDuck.test.js

@@ -181,3 +181,46 @@ describe('connectionsDucks Epics', () => {
     store.dispatch(action)
   })
 })
+
+describe('retainCredentialsSettingsEpic', () => {
+  // Given
+  const epicMiddleware = createEpicMiddleware(connections.retainCredentialsSettingsEpic)
+  const myMockStore = configureMockStore([epicMiddleware, createReduxMiddleware(bus)])
+  let store
+  beforeAll(() => {
+    bus.reset()
+    store = myMockStore({
+      connections: {
+        activeConnection: 'xxx',
+        connectionsById: {
+          xxx: {id: 'xxx', username: 'usr', password: 'pw'}
+        },
+        allConnectionIds: ['xxx']
+      }
+    })
+  })
+  afterEach(() => {
+    store.clearActions()
+    bus.reset()
+  })
+  test('Dispatches an action to remove credentials from localstorage', (done) => {
+    // Given
+    const action = connections.setRetainCredentials(false)
+    bus.take('NOOP', (currentAction) => {
+      // Then
+      expect(store.getActions()).toEqual([
+        action,
+        connections.updateConnection({
+          id: 'xxx',
+          username: '',
+          password: ''
+        }),
+        currentAction
+      ])
+      done()
+    })
+
+    // When
+    store.dispatch(action)
+  })
+})

src/shared/modules/dbMeta/dbMetaDuck.js

@@ -21,14 +21,15 @@
 import Rx from 'rxjs/Rx'
 import bolt from 'services/bolt/bolt'
 import { hydrate } from 'services/duckUtils'
-import { getJmxValues, getServerConfig } from 'services/bolt/boltHelpers'
+import { getJmxValues, getServerConfig, isConfigValFalsy } from 'services/bolt/boltHelpers'
 import {
   CONNECTED_STATE,
   CONNECTION_SUCCESS,
   connectionLossFilter,
   DISCONNECTION_SUCCESS,
   LOST_CONNECTION,
-  UPDATE_CONNECTION_STATE
+  UPDATE_CONNECTION_STATE,
+  setRetainCredentials
 } from 'shared/modules/connections/connectionsDuck'
 
 export const NAME = 'meta'
@@ -84,6 +85,11 @@ export const getStoreId = (state) => state[NAME].server.storeId
 export const getAvailableSettings = (state) => (state[NAME] || initialState).settings
 export const allowOutgoingConnections = (state) => getAvailableSettings(state)['browser.allow_outgoing_connections']
 export const credentialsTimeout = (state) => getAvailableSettings(state)['browser.credential_timeout'] || 0
+export const shouldRetainConnectionCredentials = (state) => {
+  const conf = getAvailableSettings(state)['browser.retain_connection_credentials']
+  if (conf === null || typeof conf === 'undefined') return true
+  return !isConfigValFalsy(conf)
+}
 
 /**
  * Helpers
@@ -240,8 +246,16 @@ export const dbMetaEpic = (some$, store) =>
         .mergeMap(() => {
           return getServerConfig(['browser.'])
             .then((settings) => {
-              if (settings) store.dispatch(updateSettings(settings))
-              return null
+              if (!settings) return
+              let retainCredentials = true
+              if ( // Check if we should wipe user creds from localstorage
+                typeof settings['browser.retain_connection_credentials'] !== 'undefined' &&
+                isConfigValFalsy(settings['browser.retain_connection_credentials'])
+              ) {
+                retainCredentials = false
+              }
+              store.dispatch(setRetainCredentials(retainCredentials))
+              store.dispatch(updateSettings(settings))
             })
         })
         .takeUntil(some$.ofType(LOST_CONNECTION).filter(connectionLossFilter))

src/shared/rootEpic.js

@@ -20,7 +20,7 @@
 
 import { combineEpics } from 'redux-observable'
 import { handleCommandsEpic, postConnectCmdEpic } from './modules/commands/commandsDuck'
-import { checkSettingsForRoutingDriver, connectEpic, disconnectEpic, startupConnectEpic, disconnectSuccessEpic, startupConnectionSuccessEpic, startupConnectionFailEpic, detectActiveConnectionChangeEpic, connectionLostEpic } from './modules/connections/connectionsDuck'
+import { retainCredentialsSettingsEpic, checkSettingsForRoutingDriver, connectEpic, disconnectEpic, startupConnectEpic, disconnectSuccessEpic, startupConnectionSuccessEpic, startupConnectionFailEpic, detectActiveConnectionChangeEpic, connectionLostEpic } from './modules/connections/connectionsDuck'
 import { dbMetaEpic, clearMetaOnDisconnectEpic } from './modules/dbMeta/dbMetaDuck'
 import { cancelRequestEpic } from './modules/requests/requestsDuck'
 import { discoveryOnStartupEpic } from './modules/discovery/discoveryDuck'
@@ -36,6 +36,7 @@ export default combineEpics(
   handleCommandsEpic,
   postConnectCmdEpic,
   connectionLostEpic,
+  retainCredentialsSettingsEpic,
   checkSettingsForRoutingDriver,
   connectEpic,
   disconnectEpic,

src/shared/services/bolt/boltHelpers.js

@@ -68,3 +68,6 @@ export const getJmxValues = (nameAttributePairs = []) => {
       return null
     })
 }
+
+export const isConfigValTruthy = (val) => [true, 'true', 'yes', 1, '1'].indexOf(val) > -1
+export const isConfigValFalsy = (val) => [false, 'false', 'no', 0, '0'].indexOf(val) > -1

yarn.lock

@@ -5646,7 +5646,7 @@ redux-devtools@^3.2.0:
     prop-types "^15.5.7"
     redux-devtools-instrument "^1.0.1"
 
-redux-mock-store@^1.2.2:
+redux-mock-store@^1.2.3:
   version "1.2.3"
   resolved "https://neo.jfrog.io/neo/api/npm/npm/redux-mock-store/-/redux-mock-store-1.2.3.tgz#1b3ad299da91cb41ba30d68e3b6f024475fb9e1b"