fixup! Cache and restore wallets

fixup! Cache and restore wallets

Co-authored-by: Cursor <[email protected]>

Author: paullinator

src/core/account/account-pixie.ts

@@ -11,13 +11,14 @@ import { close, update } from 'yaob'
 import {
   asMaybeOtpError,
   EdgeAccount,
+  EdgeCurrencyInfo,
   EdgeCurrencyWallet,
   EdgePluginMap,
   EdgeTokenMap
 } from '../../types/types'
 import { makePeriodicTask } from '../../util/periodic-task'
 import { snooze } from '../../util/snooze'
-import { loadWalletCache } from '../cache/cache-wallet-loader'
+import { loadWalletCache, WalletCacheSetup } from '../cache/cache-wallet-loader'
 import {
   makeWalletCacheSaver,
   WalletCacheSaver
@@ -41,6 +42,11 @@ import {
 
 export const EXPEDITED_SYNC_INTERVAL = 5000
 
+/** Returns the disklet path for the account's wallet cache file. */
+function getWalletCachePath(storageWalletId: string): string {
+  return `accountCache/${storageWalletId}/walletCache.json`
+}
+
 export interface AccountOutput {
   readonly accountApi: EdgeAccount
   readonly currencyWallets: { [walletId: string]: EdgeCurrencyWallet }
@@ -95,27 +101,20 @@ const accountPixie: TamePixie<AccountProps> = combinePixies({
 
         // Try to load wallet cache for instant UI.
         // Returns the cache setup if successful, undefined otherwise.
-        async function tryLoadCache(): Promise<
-          import('../cache/cache-wallet-loader').WalletCacheSetup | undefined
-        > {
+        // Assumes storage wallets are already initialized.
+        async function tryLoadCache(): Promise<WalletCacheSetup | undefined> {
           try {
             const storageWalletId = accountWalletInfos[0]?.id
             if (storageWalletId == null) {
               return undefined
             }
 
-            // Initialize ALL account storage wallets first.
-            // This is cheap (just file reads) and avoids race conditions.
-            await Promise.all(
-              accountWalletInfos.map(info => addStorageWallet(ai, info))
-            )
-
-            const cachePath = `accountCache/${storageWalletId}/walletCache.json`
+            const cachePath = getWalletCachePath(storageWalletId)
             const cacheJson = await ai.props.io.disklet.getText(cachePath)
 
             // Build currency info map from loaded plugins:
             const currencyInfos: {
-              [pluginId: string]: import('../../types/types').EdgeCurrencyInfo
+              [pluginId: string]: EdgeCurrencyInfo
             } = {}
             for (const pluginId of Object.keys(state.plugins.currency)) {
               currencyInfos[pluginId] =
@@ -148,8 +147,8 @@ const accountPixie: TamePixie<AccountProps> = combinePixies({
             // Check for "file not found" errors which are expected on first login:
             let isExpectedError = false
             if (error instanceof Error) {
-              // Disklet throws Error with 'Cannot read file' message
-              if (error.message.includes('Cannot read')) {
+              // Disklet throws Error with 'Cannot read file ...' message
+              if (error.message.startsWith('Cannot read file')) {
                 isExpectedError = true
               }
               // Node.js-style errors have a 'code' property
@@ -171,6 +170,12 @@ const accountPixie: TamePixie<AccountProps> = combinePixies({
         try {
           await waitForPlugins(ai)
 
+          // Initialize storage wallets (cheap file reads, needed for both paths):
+          await Promise.all(
+            accountWalletInfos.map(info => addStorageWallet(ai, info))
+          )
+          log.warn('Login: synced account repos')
+
           // Try cache-first login for instant UI:
           const cacheSetup = await tryLoadCache()
           if (cacheSetup != null) {
@@ -191,6 +196,10 @@ const accountPixie: TamePixie<AccountProps> = combinePixies({
               })
               .catch((error: unknown) => {
                 log.error('Login: background loading failed:', error)
+                input.props.dispatch({
+                  type: 'ACCOUNT_LOAD_FAILED',
+                  payload: { accountId, error }
+                })
               })
 
             return await stopUpdates
@@ -199,12 +208,6 @@ const accountPixie: TamePixie<AccountProps> = combinePixies({
           // Normal login flow (no cache available):
           await loadBuiltinTokens(ai, accountId)
 
-          // Start the repo:
-          await Promise.all(
-            accountWalletInfos.map(info => addStorageWallet(ai, info))
-          )
-          log.warn('Login: synced account repos')
-
           await loadAllFiles()
           log.warn('Login: loaded files')
 
@@ -342,7 +345,7 @@ const accountPixie: TamePixie<AccountProps> = combinePixies({
           if (accountApi != null && cacheSaver == null) {
             const storageWalletId = accountState.accountWalletInfos[0]?.id
             if (storageWalletId != null) {
-              const cachePath = `accountCache/${storageWalletId}/walletCache.json`
+              const cachePath = getWalletCachePath(storageWalletId)
 
               cacheSaver = makeWalletCacheSaver(
                 accountApi,

src/core/cache/cache-utils.ts

@@ -20,13 +20,28 @@ export function makeRealObjectPoller<T>(
 ): {
   tryGet: () => T | undefined
   waitFor: () => Promise<T>
+  cancel: () => void
 } {
   let sharedPromise: Promise<T> | undefined
+  let activeTimeoutId: ReturnType<typeof setTimeout> | undefined
+  let activeReject: ((error: Error) => void) | undefined
 
   function tryGet(): T | undefined {
     return getter()
   }
 
+  function cancel(): void {
+    if (activeTimeoutId != null) {
+      clearTimeout(activeTimeoutId)
+      activeTimeoutId = undefined
+    }
+    if (activeReject != null) {
+      activeReject(new Error(`Poller for ${label} was cancelled`))
+      activeReject = undefined
+    }
+    sharedPromise = undefined
+  }
+
   function waitFor(): Promise<T> {
     // Fast path: already available
     const immediate = tryGet()
@@ -37,20 +52,22 @@ export function makeRealObjectPoller<T>(
 
     sharedPromise = new Promise((resolve, reject) => {
       const startTime = Date.now()
-      let timeoutId: ReturnType<typeof setTimeout> | undefined
+      activeReject = reject
 
       const cleanup = (): void => {
-        if (timeoutId != null) {
-          clearTimeout(timeoutId)
-          timeoutId = undefined
+        if (activeTimeoutId != null) {
+          clearTimeout(activeTimeoutId)
+          activeTimeoutId = undefined
         }
+        activeReject = undefined
       }
 
       const check = (): void => {
         try {
           const real = tryGet()
           if (real != null) {
             cleanup()
+            sharedPromise = undefined
             resolve(real)
             return
           }
@@ -64,21 +81,21 @@ export function makeRealObjectPoller<T>(
             return
           }
 
-          timeoutId = setTimeout(check, POLL_INTERVAL_MS)
+          activeTimeoutId = setTimeout(check, POLL_INTERVAL_MS)
         } catch (error) {
           cleanup()
           sharedPromise = undefined
           reject(error)
         }
       }
 
-      timeoutId = setTimeout(check, POLL_INTERVAL_MS)
+      activeTimeoutId = setTimeout(check, POLL_INTERVAL_MS)
     })
 
     return sharedPromise
   }
 
-  return { tryGet, waitFor }
+  return { tryGet, waitFor, cancel }
 }
 
 /**

src/core/cache/cache-wallet-loader.ts

@@ -31,17 +31,13 @@ export interface WalletCacheSetup {
  * Callback to get a real wallet by ID for delegation.
  * Returns undefined if the real wallet is not yet available.
  */
-export type RealWalletLookup = (
-  walletId: string
-) => EdgeCurrencyWallet | undefined
+type RealWalletLookup = (walletId: string) => EdgeCurrencyWallet | undefined
 
 /**
  * Callback to get a real config by pluginId for delegation.
  * Returns undefined if the real config is not yet available.
  */
-export type RealConfigLookup = (
-  pluginId: string
-) => EdgeCurrencyConfig | undefined
+type RealConfigLookup = (pluginId: string) => EdgeCurrencyConfig | undefined
 
 /**
  * Options for loading wallet cache.

src/core/cache/cache-wallet-saver.ts

@@ -1,7 +1,11 @@
 import { Disklet } from 'disklet'
 
 import { EdgeAccount, EdgeLog } from '../../types/types'
-import { PARENT_CURRENCY_KEY, WalletCacheFile } from './cache-wallet-cleaners'
+import {
+  asWalletCacheFile,
+  PARENT_CURRENCY_KEY,
+  WalletCacheFile
+} from './cache-wallet-cleaners'
 
 /** Default minimum interval between saves: 5 seconds */
 const DEFAULT_THROTTLE_MS = 5000
@@ -149,12 +153,14 @@ export function makeWalletCacheSaver(
         })
       }
 
-      const cacheFile: WalletCacheFile = {
+      // Validate at write time so malformed data is caught immediately
+      // rather than producing an unusable cache on next login:
+      const cacheFile: WalletCacheFile = asWalletCacheFile({
         version: 1,
         tokens,
         wallets,
         configOtherMethodNames
-      }
+      })
 
       const cacheJson = JSON.stringify(cacheFile, null, 2)
       await disklet.setText(cachePath, cacheJson)

src/core/cache/cached-currency-wallet.ts

@@ -217,7 +217,9 @@ export function makeCachedCurrencyWallet(
   // ($internalStreamTransactions is called by client-side streamTransactions)
   const wallet: EdgeCurrencyWallet & InternalWalletMethods = {
     // Note: watch/on callbacks registered on this cached wallet will not fire
-    // because `update(cachedWallet)` is never called by the pixie system.
+    // from the pixie system (which only calls update() on real wallets).
+    // Setters like renameWallet/setFiatCurrencyCode call update(wallet) to
+    // push local changes through yaob, but watch/on won't fire reactively.
     // This is acceptable because:
     // - All getters delegate to the real wallet, so reads return live data.
     // - The GUI re-grabs wallets from `account.currencyWallets` on re-render,

test/fake/fake-currency-plugin.ts

@@ -24,7 +24,6 @@ import {
   InsufficientFundsError
 } from '../../src/index'
 import { upgradeCurrencyCode } from '../../src/types/type-helpers'
-import { snooze } from '../../src/util/snooze'
 
 const GENESIS_BLOCK = 1231006505
 
@@ -135,10 +134,6 @@ class FakeCurrencyEngine implements EdgeCurrencyEngine {
         : {
             testMethod: async (arg: string): Promise<string> => {
               return `testMethod called with: ${arg}`
-            },
-            testMethodWithDelay: async (arg: string): Promise<string> => {
-              await snooze(100)
-              return `delayed: ${arg}`
             }
           }
     this.walletId = walletInfo.id