status-im
/
status-go
mirror of https://github.com/status-im/status-go.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added functionality to local pairing that makes client calls (more) idempotent

This commit is contained in:
Samuel Hawksby-Robinson 2023-07-12 23:29:38 +01:00
parent 3c6087e5c4
commit 6f1c9af76b
5 changed files with 194 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
VERSION
View File

@ -1 +1 @@
0.163.11
0.163.12

23
api/geth_backend.go
View File

@ -12,10 +12,6 @@ import (
"sync"
"time"
"github.com/status-im/status-go/common/dbsetup"
"github.com/status-im/status-go/images"
"github.com/status-im/status-go/walletdatabase"
"github.com/imdario/mergo"
"github.com/ethereum/go-ethereum/common"
@ -27,9 +23,11 @@ import (
"github.com/status-im/status-go/account"
"github.com/status-im/status-go/account/generator"
"github.com/status-im/status-go/appdatabase"
"github.com/status-im/status-go/common/dbsetup"
"github.com/status-im/status-go/connection"
"github.com/status-im/status-go/eth-node/crypto"
"github.com/status-im/status-go/eth-node/types"
"github.com/status-im/status-go/images"
"github.com/status-im/status-go/logutils"
"github.com/status-im/status-go/multiaccounts"
"github.com/status-im/status-go/multiaccounts/accounts"
@ -43,6 +41,7 @@ import (
"github.com/status-im/status-go/protocol/identity/colorhash"
"github.com/status-im/status-go/protocol/requests"
"github.com/status-im/status-go/rpc"
"github.com/status-im/status-go/server/pairing/statecontrol"
"github.com/status-im/status-go/services/ext"
"github.com/status-im/status-go/services/personal"
"github.com/status-im/status-go/services/rpcfilters"
@ -50,6 +49,7 @@ import (
"github.com/status-im/status-go/signal"
"github.com/status-im/status-go/sqlite"
"github.com/status-im/status-go/transactions"
"github.com/status-im/status-go/walletdatabase"
)
var (
@ -92,7 +92,7 @@ type GethStatusBackend struct {
selectedAccountKeyID string
log log.Logger
allowAllRPC bool // used only for tests, disables api method restrictions
localPairing bool // used to disable login/logout signalling
LocalPairingStateManager *statecontrol.ProcessStateManager
}
// NewGethStatusBackend create a new GethStatusBackend instance
@ -116,7 +116,8 @@ func (b *GethStatusBackend) initialize() {
b.personalAPI = personalAPI
b.statusNode.SetMultiaccountsDB(b.multiaccountsDB)
b.log = log.New("package", "status-go/api.GethStatusBackend")
b.localPairing = false
b.LocalPairingStateManager = new(statecontrol.ProcessStateManager)
b.LocalPairingStateManager.SetPairing(false)
}
// StatusNode returns reference to node manager
@ -493,7 +494,7 @@ func (b *GethStatusBackend) StartNodeWithKey(acc multiaccounts.Account, password
return err
}
// get logged in
if !b.localPairing {
if !b.LocalPairingStateManager.IsPairing() {
return b.LoggedIn(acc.KeyUID, err)
}
return nil
@ -761,7 +762,7 @@ func (b *GethStatusBackend) StartNodeWithAccount(acc multiaccounts.Account, pass
_ = b.StopNode()
}
// get logged in
if !b.localPairing {
if !b.LocalPairingStateManager.IsPairing() {
return b.LoggedIn(acc.KeyUID, err)
}
return err
@ -1659,7 +1660,7 @@ func (b *GethStatusBackend) stopNode() error {
if b.statusNode == nil || !b.IsNodeRunning() {
return nil
}
if !b.localPairing {
if !b.LocalPairingStateManager.IsPairing() {
defer signal.SendNodeStopped()
}
@ -2267,10 +2268,6 @@ func (b *GethStatusBackend) SwitchFleet(fleet string, conf *params.NodeConfig) e
return nil
}
func (b *GethStatusBackend) SetLocalPairing(value bool) {
b.localPairing = value
}
func (b *GethStatusBackend) getAppDBPath(keyUID string) string {
return filepath.Join(b.rootDataDir, fmt.Sprintf("%s-v4.db", keyUID))
}

38
mobile/status.go
View File

@ -9,8 +9,6 @@ import (
"sync"
"unsafe"
"github.com/status-im/status-go/logutils"
validator "gopkg.in/go-playground/validator.v9"
"github.com/ethereum/go-ethereum/log"
@ -27,6 +25,7 @@ import (
"github.com/status-im/status-go/exportlogs"
"github.com/status-im/status-go/extkeys"
"github.com/status-im/status-go/images"
"github.com/status-im/status-go/logutils"
"github.com/status-im/status-go/multiaccounts"
"github.com/status-im/status-go/multiaccounts/accounts"
"github.com/status-im/status-go/multiaccounts/settings"
@ -1051,9 +1050,9 @@ func GetConnectionStringForBeingBootstrapped(configJSON string) string {
return makeJSONResponse(fmt.Errorf("no config given, PayloadSourceConfig is expected"))
}
statusBackend.SetLocalPairing(true)
statusBackend.LocalPairingStateManager.SetPairing(true)
defer func() {
statusBackend.SetLocalPairing(false)
statusBackend.LocalPairingStateManager.SetPairing(false)
}()
cs, err := pairing.StartUpReceiverServer(statusBackend, configJSON)
@ -1080,9 +1079,9 @@ func GetConnectionStringForBootstrappingAnotherDevice(configJSON string) string
return makeJSONResponse(fmt.Errorf("no config given, SendingServerConfig is expected"))
}
statusBackend.SetLocalPairing(true)
statusBackend.LocalPairingStateManager.SetPairing(true)
defer func() {
statusBackend.SetLocalPairing(false)
statusBackend.LocalPairingStateManager.SetPairing(false)
}()
cs, err := pairing.StartUpSenderServer(statusBackend, configJSON)
@ -1101,24 +1100,25 @@ func GetConnectionStringForBootstrappingAnotherDevice(configJSON string) string
// Example: A mobile device (device with a camera) receiving account data from
// a device with a screen (mobile or desktop devices)
func InputConnectionStringForBootstrapping(cs, configJSON string) string {
var err error
if configJSON == "" {
return makeJSONResponse(fmt.Errorf("no config given, ReceiverClientConfig is expected"))
}
statusBackend.SetLocalPairing(true)
defer func() {
statusBackend.SetLocalPairing(false)
}()
err := pairing.StartUpReceivingClient(statusBackend, cs, configJSON)
err = statusBackend.LocalPairingStateManager.StartPairing(cs)
defer func() { statusBackend.LocalPairingStateManager.StopPairing(cs, err) }()
if err != nil {
return makeJSONResponse(err)
}
err = statusBackend.Logout()
err = pairing.StartUpReceivingClient(statusBackend, cs, configJSON)
if err != nil {
return makeJSONResponse(err)
}
return makeJSONResponse(statusBackend.Logout())
}
// InputConnectionStringForBootstrappingAnotherDevice starts a pairing.SendingClient
// The given server.ConnectionParams string will determine the server.Mode
//
@ -1127,16 +1127,18 @@ func InputConnectionStringForBootstrapping(cs, configJSON string) string {
//
// Example: A mobile (device with camera) sending account data to a desktop device (device without camera)
func InputConnectionStringForBootstrappingAnotherDevice(cs, configJSON string) string {
var err error
if configJSON == "" {
return makeJSONResponse(fmt.Errorf("no config given, SenderClientConfig is expected"))
}
statusBackend.SetLocalPairing(true)
defer func() {
statusBackend.SetLocalPairing(false)
}()
err = statusBackend.LocalPairingStateManager.StartPairing(cs)
defer func() { statusBackend.LocalPairingStateManager.StopPairing(cs, err) }()
if err != nil {
return makeJSONResponse(err)
}
err := pairing.StartUpSendingClient(statusBackend, cs, configJSON)
err = pairing.StartUpSendingClient(statusBackend, cs, configJSON)
return makeJSONResponse(err)
}

93
server/pairing/statecontrol/state_management.go Normal file
View File

@ -0,0 +1,93 @@
package statecontrol
// TODO refactor into the pairing package once the backend dependencies have been removed.
import (
"fmt"
"sync"
)
var (
ErrProcessStateManagerAlreadyPairing = fmt.Errorf("cannot start new LocalPairing session, already pairing")
ErrProcessStateManagerAlreadyPaired = func(sessionName string) error {
return fmt.Errorf("given connection string already successfully used '%s'", sessionName)
}
)
// ProcessStateManager represents a g
type ProcessStateManager struct {
pairing bool
pairingLock sync.Mutex
// sessions represents a map[string]bool:
// where string is a ConnectionParams string and bool is the transfer success state of that connection string
sessions sync.Map
}
// IsPairing returns if the ProcessStateManager is currently in pairing mode
func (psm *ProcessStateManager) IsPairing() bool {
psm.pairingLock.Lock()
defer psm.pairingLock.Unlock()
return psm.pairing
}
// SetPairing sets the ProcessStateManager pairing state
func (psm *ProcessStateManager) SetPairing(state bool) {
psm.pairingLock.Lock()
defer psm.pairingLock.Unlock()
psm.pairing = state
}
// RegisterSession stores a sessionName with the default false value.
// In practice a sessionName will be a ConnectionParams string provided by the server mode device.
// The boolean value represents whether the ConnectionParams string session resulted in a successful transfer.
func (psm *ProcessStateManager) RegisterSession(sessionName string) {
psm.sessions.Store(sessionName, false)
}
// CompleteSession updates a transfer session with a given transfer success state only if the session is registered.
func (psm *ProcessStateManager) CompleteSession(sessionName string) {
r, c := psm.GetSession(sessionName)
if r && !c {
psm.sessions.Store(sessionName, true)
}
}
// GetSession returns two booleans for a given sessionName.
// These represent if the sessionName has been registered and if it has resulted in a successful transfer
func (psm *ProcessStateManager) GetSession(sessionName string) (bool, bool) {
completed, registered := psm.sessions.Load(sessionName)
if !registered {
return registered, false
}
return registered, completed.(bool)
}
// StartPairing along with StopPairing are the core functions of the ProcessStateManager
// This function takes a sessionName, which in practice is a ConnectionParams string, and attempts to init pairing state management.
// The function will return an error if the ProcessStateManager is already currently pairing or if the sessionName was previously successful.
func (psm *ProcessStateManager) StartPairing(sessionName string) error {
if psm.IsPairing() {
return ErrProcessStateManagerAlreadyPairing
}
registered, completed := psm.GetSession(sessionName)
if completed {
return ErrProcessStateManagerAlreadyPaired(sessionName)
}
if !registered {
psm.RegisterSession(sessionName)
}
psm.SetPairing(true)
return nil
}
// StopPairing takes a sessionName and an error, if the error is nil the sessionName will be recorded as successful
// the pairing state of the ProcessStateManager is set to false.
func (psm *ProcessStateManager) StopPairing(sessionName string, err error) {
if err == nil {
psm.CompleteSession(sessionName)
}
psm.SetPairing(false)
}

58
server/pairing/statecontrol/state_management_test.go Normal file
View File

@ -0,0 +1,58 @@
package statecontrol
import (
"testing"
"github.com/stretchr/testify/require"
)
const (
cs = "cs2:4FHRnp:Q4:uqnn"
cs1 = cs + "1234"
cs2 = cs + "qwer"
)
func TestProcessStateManager_StartPairing(t *testing.T) {
psm := new(ProcessStateManager)
// A new psm should start with no error
err := psm.StartPairing(cs)
require.NoError(t, err)
// A started psm should return an ErrProcessStateManagerAlreadyPairing if another start is attempted
err = psm.StartPairing(cs)
require.EqualError(t, err, ErrProcessStateManagerAlreadyPairing.Error())
// A psm should start without error if the pairing process has been stopped with an error
psm.StopPairing(cs, err)
err = psm.StartPairing(cs)
require.NoError(t, err)
// A psm should return an error if starting with a conn string that previously succeeded (a nil error)
psm.StopPairing(cs, nil)
err = psm.StartPairing(cs)
require.EqualError(t, err, ErrProcessStateManagerAlreadyPaired(cs).Error())
// A psm should be able to start with a new connection string if the psm has been stopped
err = psm.StartPairing(cs1)
require.NoError(t, err)
// A started psm should return an ErrProcessStateManagerAlreadyPairing if another start is attempted
err = psm.StartPairing(cs1)
require.EqualError(t, err, ErrProcessStateManagerAlreadyPairing.Error())
// A started psm should return an ErrProcessStateManagerAlreadyPairing if another start is attempted regardless of
// the given connection string.
err = psm.StartPairing(cs2)
require.EqualError(t, err, ErrProcessStateManagerAlreadyPairing.Error())
// A psm should start without error if the pairing process has been stopped with an error
psm.StopPairing(cs1, err)
err = psm.StartPairing(cs2)
require.NoError(t, err)
// A psm should return an error if starting with a conn string that previously succeeded (a nil error)
psm.StopPairing(cs2, nil)
err = psm.StartPairing(cs2)
require.EqualError(t, err, ErrProcessStateManagerAlreadyPaired(cs2).Error())
}