From 44a1379fbec6dae1e55fa7474d16fdefae38c0bf Mon Sep 17 00:00:00 2001 From: Samuel Hawksby-Robinson Date: Thu, 30 Mar 2023 11:00:32 +0100 Subject: [PATCH] Removed redudant PayloadMounter types --- server/pairing/client.go | 2 +- server/pairing/payload_management.go | 4 +- server/pairing/payload_mounter.go | 64 +++++++++++----------------- server/pairing/server.go | 2 +- 4 files changed, 30 insertions(+), 42 deletions(-) diff --git a/server/pairing/client.go b/server/pairing/client.go index e85a50665..e3e4df4dc 100644 --- a/server/pairing/client.go +++ b/server/pairing/client.go @@ -110,7 +110,7 @@ func (c *BaseClient) getChallenge() error { type SenderClient struct { *BaseClient accountMounter PayloadMounter - rawMessageMounter *RawMessagePayloadMounter + rawMessageMounter PayloadMounter installationMounter *InstallationPayloadMounterReceiver } diff --git a/server/pairing/payload_management.go b/server/pairing/payload_management.go index b358b7794..d59aa2c57 100644 --- a/server/pairing/payload_management.go +++ b/server/pairing/payload_management.go @@ -120,7 +120,7 @@ func (rmm *RawMessagePayloadMarshaller) MarshalProtobuf() ([]byte, error) { // InstallationPayloadMounterReceiver represents an InstallationPayload Repository type InstallationPayloadMounterReceiver struct { - *InstallationPayloadMounter + PayloadMounter *InstallationPayloadReceiver } @@ -133,6 +133,6 @@ func NewInstallationPayloadMounterReceiver(logger *zap.Logger, encryptor *Payloa } func (i *InstallationPayloadMounterReceiver) LockPayload() { - i.InstallationPayloadMounter.LockPayload() + i.PayloadMounter.LockPayload() i.InstallationPayloadReceiver.LockPayload() } diff --git a/server/pairing/payload_mounter.go b/server/pairing/payload_mounter.go index 4339724ec..b8b58d2df 100644 --- a/server/pairing/payload_mounter.go +++ b/server/pairing/payload_mounter.go @@ -65,13 +65,9 @@ func (bpm *BasePayloadMounter) Mount() error { | */ -// AccountPayloadMounter is responsible for the whole lifecycle of an AccountPayload -type AccountPayloadMounter struct { - *BasePayloadMounter -} - // NewAccountPayloadMounter generates a new and initialised AccountPayloadMounter -func NewAccountPayloadMounter(pe *PayloadEncryptor, config *SenderConfig, logger *zap.Logger) (*AccountPayloadMounter, error) { +// responsible for the whole lifecycle of an AccountPayload +func NewAccountPayloadMounter(pe *PayloadEncryptor, config *SenderConfig, logger *zap.Logger) (*BasePayloadMounter, error) { l := logger.Named("AccountPayloadLoader") l.Debug("fired", zap.Any("config", config)) @@ -84,13 +80,11 @@ func NewAccountPayloadMounter(pe *PayloadEncryptor, config *SenderConfig, logger return nil, err } - return &AccountPayloadMounter{ - BasePayloadMounter: NewBasePayloadMounter( - apl, - NewPairingPayloadMarshaller(p, l), - pe, - ), - }, nil + return NewBasePayloadMounter( + apl, + NewPairingPayloadMarshaller(p, l), + pe, + ), nil } // AccountPayloadLoader is responsible for loading, parsing and validating AccountPayload data @@ -147,21 +141,17 @@ func (apl *AccountPayloadLoader) Load() error { | */ -type RawMessagePayloadMounter struct { - *BasePayloadMounter -} - -func NewRawMessagePayloadMounter(logger *zap.Logger, pe *PayloadEncryptor, backend *api.GethStatusBackend, config *SenderConfig) *RawMessagePayloadMounter { +// NewRawMessagePayloadMounter generates a new and initialised RawMessagePayloadMounter +// responsible for the whole lifecycle of an RawMessagePayload +func NewRawMessagePayloadMounter(logger *zap.Logger, pe *PayloadEncryptor, backend *api.GethStatusBackend, config *SenderConfig) *BasePayloadMounter { pe = pe.Renew() payload := new(protobuf.SyncRawMessage) - return &RawMessagePayloadMounter{ - BasePayloadMounter: NewBasePayloadMounter( - NewRawMessageLoader(backend, payload, config), - NewRawMessagePayloadMarshaller(payload), - pe, - ), - } + return NewBasePayloadMounter( + NewRawMessageLoader(backend, payload, config), + NewRawMessagePayloadMarshaller(payload), + pe, + ) } type RawMessageLoader struct { @@ -194,21 +184,17 @@ func (r *RawMessageLoader) Load() (err error) { | */ -type InstallationPayloadMounter struct { - *BasePayloadMounter -} - -func NewInstallationPayloadMounter(logger *zap.Logger, pe *PayloadEncryptor, backend *api.GethStatusBackend, deviceType string) *InstallationPayloadMounter { +// NewInstallationPayloadMounter generates a new and initialised InstallationPayloadMounter +// responsible for the whole lifecycle of an InstallationPayload +func NewInstallationPayloadMounter(logger *zap.Logger, pe *PayloadEncryptor, backend *api.GethStatusBackend, deviceType string) *BasePayloadMounter { pe = pe.Renew() payload := new(protobuf.SyncRawMessage) - return &InstallationPayloadMounter{ - BasePayloadMounter: NewBasePayloadMounter( - NewInstallationPayloadLoader(backend, payload, deviceType), - NewRawMessagePayloadMarshaller(payload), - pe, - ), - } + return NewBasePayloadMounter( + NewInstallationPayloadLoader(backend, payload, deviceType), + NewRawMessagePayloadMarshaller(payload), + pe, + ) } type InstallationPayloadLoader struct { @@ -244,7 +230,9 @@ func (r *InstallationPayloadLoader) Load() error { | */ -func NewPayloadMounters(logger *zap.Logger, pe *PayloadEncryptor, backend *api.GethStatusBackend, config *SenderConfig) (*AccountPayloadMounter, *RawMessagePayloadMounter, *InstallationPayloadMounterReceiver, error) { +// NewPayloadMounters returns PayloadMounter s configured to handle local pairing transfers of: +// - AccountPayload, RawMessagePayload and InstallationPayload +func NewPayloadMounters(logger *zap.Logger, pe *PayloadEncryptor, backend *api.GethStatusBackend, config *SenderConfig) (PayloadMounter, PayloadMounter, *InstallationPayloadMounterReceiver, error) { am, err := NewAccountPayloadMounter(pe, config, logger) if err != nil { return nil, nil, nil, err diff --git a/server/pairing/server.go b/server/pairing/server.go index 81973f9f7..ab7b1009f 100644 --- a/server/pairing/server.go +++ b/server/pairing/server.go @@ -112,7 +112,7 @@ func MakeServerConfig(config *ServerConfig) error { type SenderServer struct { *BaseServer accountMounter PayloadMounter - rawMessageMounter *RawMessagePayloadMounter + rawMessageMounter PayloadMounter installationMounter *InstallationPayloadMounterReceiver }