Merge remote-tracking branch 'benma/syncstarted'

Author: benma

backend/accounts.go

@@ -742,7 +742,16 @@ func (backend *Backend) addAccount(account accounts.Interface) {
 	backend.accounts = append(backend.accounts, account)
 	sortAccounts(backend.accounts)
 
-	account.Observe(backend.Notify)
+	account.Observe(func(event observable.Event) {
+		backend.Notify(observable.Event{
+			Subject: fmt.Sprintf("account/%s/%s", account.Config().Config.Code, event.Subject),
+			Action:  event.Action,
+			Object:  event.Object,
+		})
+		if event.Subject == string(accountsTypes.EventSyncDone) {
+			backend.notifyNewTxs(account)
+		}
+	})
 	if backend.onAccountInit != nil {
 		backend.onAccountInit(account)
 	}
@@ -856,15 +865,6 @@ func (backend *Backend) createAndAddAccount(coin coinpkg.Coin, persistedConfig *
 			}
 			return ks, err
 		},
-		OnEvent: func(event accountsTypes.Event) {
-			backend.events <- AccountEvent{
-				Type: "account", Code: persistedConfig.Code,
-				Data: string(event),
-			}
-			if account != nil && event == accountsTypes.EventSyncDone {
-				backend.notifyNewTxs(account)
-			}
-		},
 		RateUpdater: backend.ratesUpdater,
 		GetNotifier: func(configurations signing.Configurations) accounts.Notifier {
 			return backend.notifier.ForAccount(persistedConfig.Code)

backend/accounts/baseaccount.go

@@ -33,6 +33,7 @@ import (
 	"github.com/BitBoxSwiss/bitbox-wallet-app/backend/signing"
 	"github.com/BitBoxSwiss/bitbox-wallet-app/util/errp"
 	"github.com/BitBoxSwiss/bitbox-wallet-app/util/observable"
+	"github.com/BitBoxSwiss/bitbox-wallet-app/util/observable/action"
 	"github.com/sirupsen/logrus"
 )
 
@@ -45,7 +46,6 @@ type AccountConfig struct {
 	// NotesFolder is the folder where the transaction notes are stored. Full path.
 	NotesFolder     string
 	ConnectKeystore func() (keystore.Keystore, error)
-	OnEvent         func(types.Event)
 	RateUpdater     *rates.RateUpdater
 	GetNotifier     func(signing.Configurations) Notifier
 	GetSaveFilename func(suggestedFilename string) string
@@ -83,12 +83,15 @@ func NewBaseAccount(config *AccountConfig, coin coin.Coin, log *logrus.Entry) *B
 		log:    log,
 	}
 	account.Synchronizer = synchronizer.NewSynchronizer(
-		func() { config.OnEvent(types.EventSyncStarted) },
 		func() {
 			if account.synced.CompareAndSwap(false, true) {
-				config.OnEvent(types.EventStatusChanged)
+				account.Notify(observable.Event{
+					Subject: string(types.EventStatusChanged),
+					Action:  action.Replace,
+					Object:  nil,
+				})
 			}
-			config.OnEvent(types.EventSyncDone)
+			account.notifySyncDone()
 		},
 		log,
 	)
@@ -129,7 +132,11 @@ func (account *BaseAccount) Offline() error {
 // changed.
 func (account *BaseAccount) SetOffline(offline error) {
 	account.offline = offline
-	account.config.OnEvent(types.EventStatusChanged)
+	account.Notify(observable.Event{
+		Subject: string(types.EventStatusChanged),
+		Action:  action.Replace,
+		Object:  nil,
+	})
 }
 
 // Initialize initializes the account. `accountIdentifier` is used as part of the filename of
@@ -153,7 +160,7 @@ func (account *BaseAccount) Initialize(accountIdentifier string) error {
 	if account.config.RateUpdater != nil {
 		account.config.RateUpdater.Observe(func(e observable.Event) {
 			if e.Subject == rates.RatesEventSubject {
-				account.config.OnEvent(types.EventSyncDone)
+				account.notifySyncDone()
 			}
 		})
 	}
@@ -227,7 +234,11 @@ func (account *BaseAccount) SetTxNote(txID string, note string) error {
 		return err
 	}
 	// Prompt refresh.
-	account.config.OnEvent(types.EventStatusChanged)
+	account.Notify(observable.Event{
+		Subject: string(types.EventStatusChanged),
+		Action:  action.Replace,
+		Object:  nil,
+	})
 	return nil
 }
 
@@ -311,3 +322,11 @@ func (account *BaseAccount) ExportCSV(w io.Writer, transactions []*TransactionDa
 	writer.Flush()
 	return writer.Error()
 }
+
+func (account *BaseAccount) notifySyncDone() {
+	account.Notify(observable.Event{
+		Subject: string(types.EventSyncDone),
+		Action:  action.Replace,
+		Object:  nil,
+	})
+}

backend/accounts/baseaccount_test.go

@@ -28,6 +28,7 @@ import (
 	"github.com/BitBoxSwiss/bitbox-wallet-app/backend/config"
 	"github.com/BitBoxSwiss/bitbox-wallet-app/backend/signing"
 	"github.com/BitBoxSwiss/bitbox-wallet-app/util/logging"
+	"github.com/BitBoxSwiss/bitbox-wallet-app/util/observable"
 	"github.com/BitBoxSwiss/bitbox-wallet-app/util/test"
 	"github.com/btcsuite/btcd/btcutil/hdkeychain"
 	"github.com/stretchr/testify/require"
@@ -65,7 +66,6 @@ func TestBaseAccount(t *testing.T) {
 		},
 		DBFolder:        test.TstTempDir("baseaccount_test_dbfolder"),
 		NotesFolder:     test.TstTempDir("baseaccount_test_notesfolder"),
-		OnEvent:         func(event types.Event) { events <- event },
 		RateUpdater:     nil,
 		GetNotifier:     nil,
 		GetSaveFilename: func(suggestedFilename string) string { return suggestedFilename },
@@ -122,6 +122,9 @@ func TestBaseAccount(t *testing.T) {
 		},
 	}
 	account := NewBaseAccount(cfg, mockCoin, logging.Get().WithGroup("baseaccount_test"))
+	account.Observe(func(event observable.Event) {
+		events <- types.Event(event.Subject)
+	})
 	require.NoError(t, account.Initialize(accountIdentifier))
 
 	t.Run("config", func(t *testing.T) {
@@ -132,7 +135,6 @@ func TestBaseAccount(t *testing.T) {
 	t.Run("synchronizer", func(t *testing.T) {
 		require.False(t, account.Synced())
 		done := account.Synchronizer.IncRequestsCounter()
-		require.Equal(t, types.EventSyncStarted, checkEvent())
 		require.False(t, account.Synced())
 		done()
 		require.Equal(t, types.EventStatusChanged, checkEvent()) // synced changed
@@ -141,7 +143,6 @@ func TestBaseAccount(t *testing.T) {
 
 		// no status changed event when syncing again (syncing is already true)
 		done = account.Synchronizer.IncRequestsCounter()
-		require.Equal(t, types.EventSyncStarted, checkEvent())
 		done()
 		require.Equal(t, types.EventSyncDone, checkEvent())
 

backend/accounts/types/event.go

@@ -19,16 +19,12 @@ type Event string
 
 const (
 	// EventStatusChanged is fired when the status changes. Check the status using Initialized().
-	EventStatusChanged Event = "statusChanged"
+	EventStatusChanged Event = "status-changed"
 
-	// EventSyncStarted is fired when syncing with the blockchain starts. This happens in the very
-	// beginning for the initial sync, and repeatedly afterwards when the wallet is updated (new
+	// EventSyncDone happens when a sync is completed, i.e. when the wallet is updated (new
 	// transactions, confirmations, etc.).
-	EventSyncStarted Event = "syncstarted"
+	EventSyncDone Event = "sync-done"
 
-	// EventSyncDone follows EventSyncStarted.
-	EventSyncDone Event = "syncdone"
-
-	// EventHeadersSynced is fired when the headers finished syncing.
-	EventHeadersSynced Event = "headersSynced"
+	// EventSyncedAddressesCount is emitted when the frontend should receives a sync progress update.
+	EventSyncedAddressesCount Event = "synced-addresses-count"
 )

backend/backend.go

@@ -106,11 +106,13 @@ var fixedURLWhitelist = []string{
 	"https://cointracking.info/import/bitbox/",
 }
 
-type backendEvent struct {
-	Type string      `json:"type"`
-	Data string      `json:"data"`
-	Meta interface{} `json:"meta"`
-}
+// event are events emitted by the backend.
+type event string
+
+const (
+	// eventNewTxs is emitted when the user should be notified of new transactions.
+	eventNewTxs event = "new-txs"
+)
 
 type deviceEvent struct {
 	DeviceID string `json:"deviceID"`
@@ -120,13 +122,6 @@ type deviceEvent struct {
 	Meta interface{} `json:"meta"`
 }
 
-// AccountEvent models an event triggered by an account.
-type AccountEvent struct {
-	Type string             `json:"type"`
-	Code accountsTypes.Code `json:"code"`
-	Data string             `json:"data"`
-}
-
 type authEventType string
 
 const (
@@ -332,11 +327,14 @@ func (backend *Backend) notifyNewTxs(account accounts.Interface) {
 		return
 	}
 	if unnotifiedCount != 0 {
-		backend.events <- backendEvent{Type: "backend", Data: "newTxs", Meta: map[string]interface{}{
-			"count":       unnotifiedCount,
-			"accountName": account.Config().Config.Name,
-		}}
-
+		backend.Notify(observable.Event{
+			Subject: string(eventNewTxs),
+			Action:  action.Replace,
+			Object: map[string]interface{}{
+				"count":       unnotifiedCount,
+				"accountName": account.Config().Config.Name,
+			},
+		})
 		if err := notifier.MarkAllNotified(); err != nil {
 			backend.log.WithError(err).Error("error marking notified")
 		}
@@ -774,7 +772,15 @@ func (backend *Backend) Register(theDevice device.Interface) error {
 
 	mainKeystore := len(backend.devices) == 1
 	theDevice.SetOnEvent(func(event deviceevent.Event, data interface{}) {
-		switch event {
+		backend.events <- deviceEvent{
+			DeviceID: theDevice.Identifier(),
+			Type:     "device",
+			Data:     string(event),
+			Meta:     data,
+		}
+	})
+	theDevice.Observe(func(event observable.Event) {
+		switch deviceevent.Event(event.Subject) {
 		case deviceevent.EventKeystoreGone:
 			backend.DeregisterKeystore()
 		case deviceevent.EventKeystoreAvailable:
@@ -783,30 +789,23 @@ func (backend *Backend) Register(theDevice device.Interface) error {
 				backend.registerKeystore(theDevice.Keystore())
 			}
 		}
-		backend.events <- deviceEvent{
-			DeviceID: theDevice.Identifier(),
-			Type:     "device",
-			Data:     string(event),
-			Meta:     data,
-		}
+		backend.Notify(observable.Event{
+			Subject: fmt.Sprintf(
+				"devices/%s/%s/%s",
+				theDevice.ProductName(),
+				theDevice.Identifier(),
+				event.Subject),
+			Action: event.Action,
+			Object: event.Object,
+		})
 	})
 
 	backend.onDeviceInit(theDevice)
 	if err := theDevice.Init(backend.Testing()); err != nil {
 		backend.onDeviceUninit(theDevice.Identifier())
 		return err
 	}
-	theDevice.Observe(backend.Notify)
-
-	// Old-school
-	select {
-	case backend.events <- backendEvent{
-		Type: "devices",
-		Data: "registeredChanged",
-	}:
-	default:
-	}
-	// New-school
+
 	backend.Notify(observable.Event{
 		Subject: "devices/registered",
 		Action:  action.Reload,
@@ -828,9 +827,6 @@ func (backend *Backend) Deregister(deviceID string) {
 		delete(backend.devices, deviceID)
 		backend.DeregisterKeystore()
 
-		// Old-school
-		backend.events <- backendEvent{Type: "devices", Data: "registeredChanged"}
-		// New-school
 		backend.Notify(observable.Event{
 			Subject: "devices/registered",
 			Action:  action.Reload,

backend/coins/btc/account.go

@@ -30,7 +30,6 @@ import (
 	"github.com/BitBoxSwiss/bitbox-wallet-app/backend/coins/btc/addresses"
 	"github.com/BitBoxSwiss/bitbox-wallet-app/backend/coins/btc/blockchain"
 	"github.com/BitBoxSwiss/bitbox-wallet-app/backend/coins/btc/db/transactionsdb"
-	"github.com/BitBoxSwiss/bitbox-wallet-app/backend/coins/btc/headers"
 	"github.com/BitBoxSwiss/bitbox-wallet-app/backend/coins/btc/maketx"
 	"github.com/BitBoxSwiss/bitbox-wallet-app/backend/coins/btc/transactions"
 	"github.com/BitBoxSwiss/bitbox-wallet-app/backend/coins/btc/types"
@@ -325,11 +324,6 @@ func (account *Account) Initialize() error {
 	account.SetOffline(account.coin.Blockchain().ConnectionError())
 	account.coin.Blockchain().RegisterOnConnectionErrorChangedEvent(onConnectionStatusChanged)
 	theHeaders := account.coin.Headers()
-	theHeaders.SubscribeEvent(func(event headers.Event) {
-		if event == headers.EventSynced {
-			account.Config().OnEvent(accountsTypes.EventHeadersSynced)
-		}
-	})
 	account.transactions = transactions.NewTransactions(
 		account.coin.Net(), account.db, theHeaders, account.Synchronizer,
 		account.coin.Blockchain(), account.notifier, account.log)
@@ -451,7 +445,11 @@ func (account *Account) Close() {
 		account.log.Info("Closed DB")
 	}
 
-	account.Config().OnEvent(accountsTypes.EventStatusChanged)
+	account.Notify(observable.Event{
+		Subject: string(accountsTypes.EventStatusChanged),
+		Action:  action.Replace,
+		Object:  nil,
+	})
 	account.closed = true
 }
 
@@ -588,7 +586,7 @@ func (account *Account) incAndEmitSyncCounter() {
 	if !account.Synced() {
 		synced := atomic.AddUint32(&account.syncedAddressesCount, 1)
 		account.Notify(observable.Event{
-			Subject: fmt.Sprintf("account/%s/synced-addresses-count", account.Config().Config.Code),
+			Subject: string(accountsTypes.EventSyncedAddressesCount),
 			Action:  action.Replace,
 			Object:  synced,
 		})
@@ -642,7 +640,11 @@ func (account *Account) onAddressStatus(address *addresses.AccountAddress, statu
 		// We are not closing client.blockchain here, as it is reused per coin with
 		// different accounts.
 		account.fatalError.Store(true)
-		account.Config().OnEvent(accountsTypes.EventStatusChanged)
+		account.Notify(observable.Event{
+			Subject: string(accountsTypes.EventStatusChanged),
+			Action:  action.Replace,
+			Object:  nil,
+		})
 		return
 	}
 	// Safe some work in case account was closed in the meantime.

backend/coins/btc/account_test.go

@@ -24,7 +24,6 @@ import (
 	"time"
 
 	"github.com/BitBoxSwiss/bitbox-wallet-app/backend/accounts"
-	accountsTypes "github.com/BitBoxSwiss/bitbox-wallet-app/backend/accounts/types"
 	"github.com/BitBoxSwiss/bitbox-wallet-app/backend/coins/btc/blockchain"
 	blockchainMock "github.com/BitBoxSwiss/bitbox-wallet-app/backend/coins/btc/blockchain/mocks"
 	"github.com/BitBoxSwiss/bitbox-wallet-app/backend/coins/coin"
@@ -93,7 +92,6 @@ func mockAccount(t *testing.T, accountConfig *config.Account) *Account {
 		&accounts.AccountConfig{
 			Config:          accountConfig,
 			DBFolder:        dbFolder,
-			OnEvent:         func(accountsTypes.Event) {},
 			RateUpdater:     nil,
 			GetNotifier:     func(signing.Configurations) accounts.Notifier { return nil },
 			GetSaveFilename: func(suggestedFilename string) string { return suggestedFilename },