Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix proposal panic #1791

Merged
merged 2 commits into from
Feb 27, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions core/discovery/brokerdiscovery/repository.go
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,10 @@ func (r *Repository) Stop() {
}

func (r *Repository) proposalRegisterMessage(message registerMessage) error {
if !message.Proposal.IsSupported() {
return nil
}

r.storage.AddProposal(message.Proposal)

r.watchdogLock.Lock()
Expand All @@ -124,6 +128,10 @@ func (r *Repository) proposalUnregisterMessage(message unregisterMessage) error
}

func (r *Repository) proposalPingMessage(message pingMessage) error {
if !message.Proposal.IsSupported() {
return nil
}

r.storage.AddProposal(message.Proposal)

r.watchdogLock.Lock()
Expand Down
89 changes: 76 additions & 13 deletions core/discovery/brokerdiscovery/repository_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,27 +18,53 @@
package brokerdiscovery

import (
"encoding/json"
"testing"
"time"

"github.com/mysteriumnetwork/node/communication/nats"
"github.com/mysteriumnetwork/node/eventbus"
"github.com/mysteriumnetwork/node/market"
"github.com/mysteriumnetwork/node/money"
"github.com/stretchr/testify/assert"
)

func init() {
market.RegisterServiceDefinitionUnserializer(
"mock_service",
func(rawDefinition *json.RawMessage) (market.ServiceDefinition, error) {
return mockServiceDefinition{}, nil
},
)
market.RegisterPaymentMethodUnserializer(
"mock_payment",
func(rawDefinition *json.RawMessage) (market.PaymentMethod, error) {
return mockPaymentMethod{}, nil
},
)
market.RegisterContactUnserializer("mock_contact",
func(rawMessage *json.RawMessage) (market.ContactDefinition, error) {
return mockContact{}, nil
},
)
}

var (
proposalFirst = market.ServiceProposal{
ProviderID: "0x1",
ServiceDefinition: market.UnsupportedServiceDefinition{},
PaymentMethod: market.UnsupportedPaymentMethod{},
ProviderContacts: []market.Contact{},
ServiceType: "mock_service",
ServiceDefinition: mockServiceDefinition{},
PaymentMethodType: "mock_payment",
PaymentMethod: mockPaymentMethod{},
ProviderContacts: []market.Contact{market.Contact{Type: "mock_contact", Definition: mockContact{}}},
}
proposalSecond = market.ServiceProposal{
ProviderID: "0x2",
ServiceDefinition: market.UnsupportedServiceDefinition{},
PaymentMethod: market.UnsupportedPaymentMethod{},
ProviderContacts: []market.Contact{},
ServiceType: "mock_service",
ServiceDefinition: mockServiceDefinition{},
PaymentMethodType: "mock_payment",
PaymentMethod: mockPaymentMethod{},
ProviderContacts: []market.Contact{market.Contact{Type: "mock_contact", Definition: mockContact{}}},
}
)

Expand All @@ -52,18 +78,29 @@ func Test_Subscriber_StartSyncsNewProposals(t *testing.T) {
assert.NoError(t, err)

proposalRegister(connection, `{
"proposal": {"provider_id": "0x1"}
"proposal": {"provider_id": "0x1", "service_type": "mock_service", "payment_method_type": "mock_payment", "provider_contacts": [{"type":"mock_contact"}]}
}`)

assert.Eventually(t, proposalCountEquals(repo, 1), 2*time.Second, 1*time.Millisecond)
assert.Exactly(t, []market.ServiceProposal{proposalFirst}, repo.storage.Proposals())
}

func Test_Subscriber_SkipUnsupportedProposal(t *testing.T) {
connection := nats.StartConnectionMock()
defer connection.Close()

repo := NewRepository(connection, eventbus.New(), 10*time.Millisecond, 1*time.Millisecond)
err := repo.Start()
defer repo.Stop()
assert.NoError(t, err)

proposalRegister(connection, `{
"proposal": {"provider_id": "0x2"}
"proposal": {"provider_id": "0x1", "service_type": "unknown"}
}`)

assert.Eventually(t, proposalCountEquals(repo, 2), 2*time.Second, 1*time.Millisecond)
assert.Exactly(t, []market.ServiceProposal{proposalFirst, proposalSecond}, repo.storage.Proposals())
time.Sleep(10 * time.Millisecond)
assert.Len(t, repo.storage.Proposals(), 0)
assert.Exactly(t, []market.ServiceProposal{}, repo.storage.Proposals())
}

func Test_Subscriber_StartSyncsIdleProposals(t *testing.T) {
Expand Down Expand Up @@ -91,11 +128,11 @@ func Test_Subscriber_StartSyncsHealthyProposals(t *testing.T) {
assert.NoError(t, err)

proposalRegister(connection, `{
"proposal": {"provider_id": "0x1"}
"proposal": {"provider_id": "0x1", "service_type": "mock_service", "payment_method_type": "mock_payment", "provider_contacts": [{"type":"mock_contact"}]}
}`)

proposalPing(connection, `{
"proposal": {"provider_id": "0x1"}
"proposal": {"provider_id": "0x1", "service_type": "mock_service", "payment_method_type": "mock_payment", "provider_contacts": [{"type":"mock_contact"}]}
}`)

assert.Eventually(t, proposalCountEquals(repo, 1), 2*time.Second, 1*time.Millisecond)
Expand All @@ -113,7 +150,7 @@ func Test_Subscriber_StartSyncsStoppedProposals(t *testing.T) {
assert.NoError(t, err)

proposalUnregister(connection, `{
"proposal": {"provider_id": "0x1"}
"proposal": {"provider_id": "0x1", "service_type": "mock_service", "payment_method_type": "mock_payment", "provider_contacts": [{"type":"mock_contact"}]}
}`)

assert.Eventually(t, proposalCountEquals(repo, 1), 2*time.Second, 1*time.Millisecond)
Expand Down Expand Up @@ -146,3 +183,29 @@ func proposalCountEquals(subscriber *Repository, count int) func() bool {
return len(subscriber.storage.Proposals()) == count
}
}

type mockServiceDefinition struct {
}

func (service mockServiceDefinition) GetLocation() market.Location {
return market.Location{}
}

type mockPaymentMethod struct {
}

func (method mockPaymentMethod) GetPrice() money.Money {
return money.Money{}
}

func (method mockPaymentMethod) GetType() string {
return "mock"
}

func (method mockPaymentMethod) GetRate() market.PaymentRate {
return market.PaymentRate{
PerTime: time.Minute,
}
}

type mockContact struct{}
2 changes: 1 addition & 1 deletion docker-compose.e2e-basic.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ services:
- ./e2e/blockchain/keystore:/keystore

accountant:
image: mysteriumnetwork/accountant:latest
image: mysteriumnetwork/accountant:0.0.2
environment:
PORT: 8889
expose:
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.e2e-compatibility.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ services:
- ./e2e/blockchain/keystore:/keystore

accountant:
image: mysteriumnetwork/accountant:latest
image: mysteriumnetwork/accountant:0.0.2
environment:
PORT: 8889
expose:
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.e2e-traversal.yml
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ services:
ipv4_address: 172.31.0.203

accountant:
image: mysteriumnetwork/accountant:latest
image: mysteriumnetwork/accountant:0.0.2
environment:
PORT: 8889
expose:
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.localnet.yml
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ services:
ipv4_address: 172.31.0.203

accountant:
image: mysteriumnetwork/accountant:latest
image: mysteriumnetwork/accountant:0.0.2
environment:
PORT: 8889
expose:
Expand Down
13 changes: 10 additions & 3 deletions market/payment_method.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"time"

"github.com/mysteriumnetwork/node/money"
"github.com/rs/zerolog/log"
)

// PaymentMethod is a interface for all types of payment methods
Expand All @@ -42,18 +43,24 @@ type PaymentRate struct {
type UnsupportedPaymentMethod struct {
}

// GetPrice returns a zero price
// GetPrice should not be called
func (UnsupportedPaymentMethod) GetPrice() money.Money {
//this should never be called
log.Error().Msg("Unsupported proposal GetPrice should not be called")
return money.Money{}
}

// GetType returns unsupported
// GetType should not be called
func (UnsupportedPaymentMethod) GetType() string {
//this should never be called
log.Error().Msg("Unsupported proposal GetType should not be called")
return "UNSUPPORTED"
}

// GetRate returns zero payment rate
// GetRate should not be called
func (UnsupportedPaymentMethod) GetRate() PaymentRate {
//this should never be called
log.Error().Msg("Unsupported proposal GetRate should not be called")
return PaymentRate{}
}

Expand Down
11 changes: 8 additions & 3 deletions market/service_definition.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@

package market

import "encoding/json"
import (
"encoding/json"

"github.com/rs/zerolog/log"
)

// ServiceDefinition interface is interface for all service definition types
type ServiceDefinition interface {
Expand All @@ -28,10 +32,11 @@ type ServiceDefinition interface {
type UnsupportedServiceDefinition struct {
}

// GetLocation always panics on unsupported service types
// GetLocation should not be called for unsupported service types
func (UnsupportedServiceDefinition) GetLocation() Location {
//no location available - should never be called
panic("not supported")
log.Error().Msg("Unsupported proposal GetLocation should not be called")
return Location{}
}

var _ ServiceDefinition = UnsupportedServiceDefinition{}
Expand Down