[Wallet] Fix web3 syncing sagas #809
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,13 @@ | ||
| import { expectSaga } from 'redux-saga-test-plan' | ||
| import { call, delay, select } from 'redux-saga/effects' | ||
| import { pincodeSelector } from 'src/account/reducer' | ||
| import { navigateToError } from 'src/navigator/NavigationService' | ||
| import { setLatestBlockNumber, updateWeb3SyncProgress } from 'src/web3/actions' | ||
| import { | ||
| checkWeb3SyncProgress, | ||
|
There was a problem hiding this comment. @martinvol I do like the convention of There was a problem hiding this comment. Cool, no problem. Disabling VS code import organizing might not be a bad a idea since the pre-commit hook also sorts imports. There was a problem hiding this comment. Yeah but the way it de-dupes imports for you and removes unused ones is really nice |
||
| createNewAccount, | ||
| SYNC_TIMEOUT, | ||
| waitForWeb3Sync, | ||
| } from 'src/web3/saga' | ||
| import { currentAccountSelector } from 'src/web3/selectors' | ||
| import { createMockStore, sleep } from 'test/utils' | ||
|
|
@@ -37,6 +31,7 @@ jest.mock('src/web3/contracts', () => ({ | |
| .fn() | ||
| .mockReturnValueOnce({ startingBlock: 0, currentBlock: 10, highestBlock: 100 }) | ||
| .mockReturnValueOnce(false), | ||
| getBlock: jest.fn(() => ({ number: LAST_BLOCK_NUMBER })), | ||
| }, | ||
| }, | ||
| })) | ||
|
|
@@ -66,40 +61,37 @@ describe(createNewAccount, () => { | |
| }) | ||
| }) | ||
|
|
||
| describe(waitForWeb3Sync, () => { | ||
| it('reports connection successfully', async () => { | ||
| await expectSaga(waitForWeb3Sync) | ||
| .withState(state) | ||
| .provide([ | ||
| // needs this async function to win the race with a delay | ||
| [call(checkWeb3SyncProgress), call(async () => true)], | ||
| ]) | ||
| .returns(true) | ||
| .run() | ||
| }) | ||
|
|
||
| it('times out', async () => { | ||
| await expectSaga(waitForWeb3Sync) | ||
| .withState(state) | ||
| .provide([ | ||
| [call(checkWeb3SyncProgress), call(sleep, 100)], // sleep so timeout always wins the race | ||
| [delay(SYNC_TIMEOUT), true], | ||
| ]) | ||
| .returns(false) | ||
| .run() | ||
| expect(navigateToError).toHaveBeenCalled() | ||
| }) | ||
| }) | ||
|
|
||
| describe(checkWeb3SyncProgress, () => { | ||
| it('reports web3 status correctly', async () => { | ||
| await expectSaga(checkWeb3SyncProgress) | ||
| .withState(state) | ||
| .put(updateWeb3SyncProgress({ startingBlock: 0, currentBlock: 10, highestBlock: 100 })) // is syncing the first time | ||
| .put(setLatestBlockNumber(LAST_BLOCK_NUMBER)) // finished syncing the second time | ||
| .returns(true) | ||
| .run() | ||
| }) | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,7 +13,6 @@ import { currentLanguageSelector } from 'src/app/reducers' | |
| import { getWordlist } from 'src/backup/utils' | ||
| import { UNLOCK_DURATION } from 'src/geth/consts' | ||
| import { deleteChainData } from 'src/geth/geth' | ||
| import { navigateToError } from 'src/navigator/NavigationService' | ||
| import { waitWeb3LastBlock } from 'src/networkInfo/saga' | ||
| import Logger from 'src/utils/Logger' | ||
|
|
@@ -23,7 +22,6 @@ import { | |
| setAccount, | ||
| setLatestBlockNumber, | ||
| setPrivateCommentKey, | ||
| unlockAccount, | ||
| updateWeb3SyncProgress, | ||
| } from 'src/web3/actions' | ||
|
|
@@ -36,68 +34,67 @@ const MNEMONIC_BIT_LENGTH = (ETH_PRIVATE_KEY_LENGTH * 8) / 2 | |
|
|
||
| const TAG = 'web3/saga' | ||
| // The timeout for web3 to complete syncing and the latestBlock to be > 0 | ||
| export const SYNC_TIMEOUT = 60000 | ||
martinvol marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| const BLOCK_CHAIN_CORRUPTION_ERROR = "Error: CONNECTION ERROR: Couldn't connect to node on IPC." | ||
|
There was a problem hiding this comment. Can you remove this to a json as nice to have? |
||
|
|
||
| // checks if web3 claims it is currently syncing and attempts to wait for it to complete | ||
| export function* checkWeb3SyncProgress() { | ||
| while (true) { | ||
| try { | ||
| Logger.debug(TAG, 'checkWeb3SyncProgress', 'Checking sync progress') | ||
|
|
||
| // isSyncing returns a syncProgress object when it's still syncing, false otherwise | ||
| const syncProgress = yield web3.eth.isSyncing() | ||
|
|
||
| if (typeof syncProgress === 'boolean' && !syncProgress) { | ||
| Logger.debug(TAG, 'checkWeb3SyncProgress', 'Sync maybe complete, checking') | ||
|
|
||
| const latestBlock: Block = yield call(getLatestBlock) | ||
martinvol marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if (latestBlock && latestBlock.number > 0) { | ||
| yield put(setLatestBlockNumber(latestBlock.number)) | ||
| Logger.debug(TAG, 'checkWeb3SyncProgress', 'Sync is complete') | ||
| return true | ||
| } else { | ||
| Logger.debug(TAG, 'checkWeb3SyncProgress', 'Sync not actually complete, still waiting') | ||
| } | ||
| } else { | ||
| yield put(updateWeb3SyncProgress(syncProgress)) | ||
| } | ||
|
|
||
| yield delay(100) // wait 100ms while web3 syncs | ||
| } catch (error) { | ||
| if (error.toString().toLowerCase() === BLOCK_CHAIN_CORRUPTION_ERROR.toLowerCase()) { | ||
| CeloAnalytics.track(CustomEventNames.blockChainCorruption, {}, true) | ||
| const deleted = yield call(deleteChainData) | ||
| if (deleted) { | ||
| navigateToError('corruptedChainDeleted') | ||
| } | ||
| } else { | ||
| Logger.error(TAG, 'Unexpected sync error', error) | ||
|
There was a problem hiding this comment. @martinvol it's better to provide the error as the 3rd param to Logger.error, which has special logic to extract and format the error message nicely |
||
| } | ||
| return false | ||
|
There was a problem hiding this comment. @martinvol previously, you were not throwing or returning false in this case, which allowed the calling function to finish as though syncing were done. |
||
| } | ||
| } | ||
| } | ||
|
|
||
| export function* waitForWeb3Sync() { | ||
| try { | ||
| const { syncComplete, timeout } = yield race({ | ||
| syncComplete: call(checkWeb3SyncProgress), | ||
| timeout: delay(SYNC_TIMEOUT), | ||
| }) | ||
|
|
||
| if (timeout || !syncComplete) { | ||
| Logger.error(TAG, 'Could not complete sync') | ||
| navigateToError('web3FailedToSync') | ||
| return false | ||
| } | ||
|
|
||
| return true | ||
| } catch (error) { | ||
| Logger.error(TAG, 'checkWeb3Sync', error) | ||
| navigateToError('errorDuringSync') | ||
| return false | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -218,7 +215,3 @@ export function* getConnectedUnlockedAccount() { | |
| throw new Error(ErrorMessages.INCORRECT_PIN) | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cmcewen IIRC you recommended calling this
checkbutwaitis what it's really doing. Mind if we rename?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Volpe and I had a discussion about this - the reason I don't like using wait is that it actually makes a call to get the latest block to the geth node. Since I think we treat the
waitForgenerators as free in terms of cost, I would be wary of someone just adding this elsewhere and we end up doing a bunch of duplicate polling. I thinkwaitForshould imply solely waiting on state changes.