Skip to content
This repository has been archived by the owner on Dec 11, 2019. It is now read-only.

Fixing recovery progress indicator showing before a recovery file has been loaded. #14017

Merged
merged 1 commit into from
May 5, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions app/browser/api/ledger.js
Original file line number Diff line number Diff line change
Expand Up @@ -1135,6 +1135,7 @@ const fileRecoveryKeys = (state, recoveryKeyFile) => {
return state
}

state = aboutPreferencesState.setRecoveryInProgress(state, true)
const result = loadKeysFromBackupFile(state, recoveryKeyFile)
const recoveryKey = result.recoveryKey || ''
state = result.state
Expand Down
18 changes: 8 additions & 10 deletions app/browser/reducers/ledgerReducer.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,14 @@ const ledgerReducer = (state, action, immutableAction) => {
}
case appConstants.APP_RECOVER_WALLET:
{
state = aboutPreferencesState.setPreferencesProp(
state,
'recoveryInProgress',
true
)
state = ledgerApi.recoverKeys(
state,
action.get('useRecoveryKeyFile'),
action.get('recoveryKey')
)
const recoveryKey = action.get('recoveryKey')
const useRecoveryKeyFile = action.get('useRecoveryKeyFile')

if (!useRecoveryKeyFile) {
state = aboutPreferencesState.setRecoveryInProgress(state, true)
}

state = ledgerApi.recoverKeys(state, useRecoveryKeyFile, recoveryKey)
break
}
case appConstants.APP_ON_FILE_RECOVERY_KEYS:
Expand Down
7 changes: 6 additions & 1 deletion app/common/state/aboutPreferencesState.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,15 @@ const aboutPreferencesState = {
return state.setIn(['about', 'preferences', key], value)
},

setRecoveryInProgress: (state, inProgress) => {
state = validateState(state)
return aboutPreferencesState.setPreferencesProp(state, 'recoveryInProgress', inProgress)
},

setRecoveryStatus: (state, status) => {
state = validateState(state)
const date = new Date().getTime()
state = aboutPreferencesState.setPreferencesProp(state, 'recoveryInProgress', false)
state = aboutPreferencesState.setRecoveryInProgress(state, false)
state = aboutPreferencesState.setPreferencesProp(state, 'recoverySucceeded', status)
return aboutPreferencesState.setPreferencesProp(state, 'updatedStamp', date)
}
Expand Down
36 changes: 35 additions & 1 deletion test/unit/app/browser/api/ledgerTest.js
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,8 @@ describe('ledger api unit tests', function () {
getPromotion: () => {},
setPromotion: () => {},
setTimeUntilReconcile: () => {},
isReadyToReconcile: () => isReadyToReconcile
isReadyToReconcile: () => isReadyToReconcile,
recoverWallet: () => {}
}
window.getWalletPassphrase = (parsedData) => {
if (walletPassphraseReturn === 'error') {
Expand Down Expand Up @@ -2320,6 +2321,39 @@ describe('ledger api unit tests', function () {
})
})

describe('fileRecoveryKeys', function () {
let stub
let setRecoveryInProgressSpy

before(function () {
setRecoveryInProgressSpy = sinon.spy(aboutPreferencesState, 'setRecoveryInProgress')
})

after(function () {
stub.restore()
setRecoveryInProgressSpy.restore()
})

it('does not modify state if there is no recovery key file', function () {
const result = ledgerApi.fileRecoveryKeys(defaultAppState, false)
assert.deepEqual(result, defaultAppState)
})

it('sets recovery in progress when a recovery key file is received', function () {
ledgerApi.setClient(ledgerClientObject)
stub = sinon.stub(fs, 'readFileSync', (path, options) => {
return 'Fake file key...'
})
const stateWithPreferences = defaultAppState
.setIn(['about'], Immutable.fromJS({
preferences: {}
}))
ledgerApi.fileRecoveryKeys(stateWithPreferences, 'file.txt')
assert.equal(stateWithPreferences, setRecoveryInProgressSpy.getCall(0).args[0])
assert.equal(true, setRecoveryInProgressSpy.getCall(0).args[1])
})
})

describe('checkReferralActivity', function () {
let checkForUpdateSpy, roundtripSpy, fakeClock

Expand Down
68 changes: 50 additions & 18 deletions test/unit/app/browser/reducers/ledgerReducerTest.js
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ describe('ledgerReducer unit tests', function () {
}
fakeAboutPreferencesState = {
setRecoveryStatus: dummyModifyState,
setPreferencesProp: dummyModifyState
setRecoveryInProgress: dummyModifyState
}
mockery.registerMock('../../browser/api/ledger', fakeLedgerApi)
mockery.registerMock('../../common/state/ledgerState', fakeLedgerState)
Expand Down Expand Up @@ -151,30 +151,62 @@ describe('ledgerReducer unit tests', function () {

describe('APP_RECOVER_WALLET', function () {
let recoverKeysSpy
let modifiedState
let setPreferencesPropSpy
let setRecoveryInProgressSpy
before(function () {
recoverKeysSpy = sinon.spy(fakeLedgerApi, 'recoverKeys')
setPreferencesPropSpy = sinon.spy(fakeAboutPreferencesState, 'setPreferencesProp')
returnedState = ledgerReducer(appState, Immutable.fromJS({
actionType: appConstants.APP_RECOVER_WALLET,
useRecoveryKeyFile: 'useKeyFile',
recoveryKey: 'firstKey'
}))
setRecoveryInProgressSpy = sinon.spy(fakeAboutPreferencesState, 'setRecoveryInProgress')
})
after(function () {
recoverKeysSpy.restore()
setPreferencesPropSpy.restore()
})
it('calls aboutPreferencesState.setPreferencesProp', function () {
assert(setPreferencesPropSpy.withArgs(appState, 'recoveryInProgress', true).calledOnce)
setRecoveryInProgressSpy.restore()
})
it('calls ledgerApi.recoverKeys', function () {
modifiedState = fakeAboutPreferencesState.setPreferencesProp(appState, 'recoveryInProgress', true)
assert(recoverKeysSpy.withArgs(modifiedState, 'useKeyFile', 'firstKey').calledOnce)

describe('with key file', function () {
before(function () {
returnedState = ledgerReducer(appState, Immutable.fromJS({
actionType: appConstants.APP_RECOVER_WALLET,
useRecoveryKeyFile: 'useKeyFile',
recoveryKey: 'firstKey'
}))
})
after(function () {
recoverKeysSpy.reset()
setRecoveryInProgressSpy.reset()
})
it('does not call aboutPreferencesState.setRecoveryInProgress if a recovery file is used', function () {
assert(setRecoveryInProgressSpy.withArgs(appState, true).notCalled)
})
it('calls ledgerApi.recoverKeys', function () {
assert(recoverKeysSpy.withArgs(appState, 'useKeyFile', 'firstKey').calledOnce)
})
it('returns a modified state', function () {
assert.notDeepEqual(returnedState, appState)
})
})
it('returns a modified state', function () {
assert.notDeepEqual(returnedState, appState)

describe('without key file', function () {
let modifiedState
before(function () {
returnedState = ledgerReducer(appState, Immutable.fromJS({
actionType: appConstants.APP_RECOVER_WALLET,
useRecoveryKeyFile: false,
recoveryKey: 'firstKey'
}))
})
after(function () {
recoverKeysSpy.reset()
setRecoveryInProgressSpy.reset()
})
it('calls aboutPreferencesState.setRecoveryInProgress if a recovery file is not used', function () {
assert(setRecoveryInProgressSpy.withArgs(appState, true).calledOnce)
})
it('calls ledgerApi.recoverKeys', function () {
modifiedState = fakeAboutPreferencesState.setRecoveryInProgress(appState, true)
assert(recoverKeysSpy.withArgs(modifiedState, false, 'firstKey').calledOnce)
})
it('returns a modified state', function () {
assert.notDeepEqual(returnedState, appState)
})
})
})

Expand Down
16 changes: 13 additions & 3 deletions test/unit/app/common/state/aboutPreferencesStateTest.js
Original file line number Diff line number Diff line change
Expand Up @@ -65,15 +65,25 @@ describe('aboutPreferencesState unit test', function () {
describe('setRecoveryStatus', function () {
it('updates recoverySucceeded', function () {
const result = aboutPreferencesState.setRecoveryStatus(defaultState, true)
assert.equal(result.getIn(['about', 'preferences', 'recoverySucceeded']), true)
assert.equal(aboutPreferencesState.getPreferencesProp(result, 'recoverySucceeded'), true)
})
it('recoveryInProgress is false when recovery is successful', function () {
const result = aboutPreferencesState.setRecoveryStatus(defaultState, true)
assert.equal(result.getIn(['about', 'preferences', 'recoveryInProgress']), false)
assert.equal(aboutPreferencesState.getPreferencesProp(result, 'recoveryInProgress'), false)
})
it('recoveryInProgress is false when recovery is not successful', function () {
const result = aboutPreferencesState.setRecoveryStatus(defaultState, false)
assert.equal(result.getIn(['about', 'preferences', 'recoveryInProgress']), false)
assert.equal(aboutPreferencesState.getPreferencesProp(result, 'recoveryInProgress'), false)
})
})

describe('setRecoveryInProgress', function () {
it('updates recoveryInProgress', function () {
const result = aboutPreferencesState.setRecoveryInProgress(defaultState, true)
assert.equal(aboutPreferencesState.getPreferencesProp(result, 'recoveryInProgress'), true)

const nextResult = aboutPreferencesState.setRecoveryInProgress(defaultState, false)
assert.equal(aboutPreferencesState.getPreferencesProp(nextResult, 'recoveryInProgress'), false)
})
})
})