Skip to content

Commit

Permalink
fix returned error and split tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@cristaloleg
cristaloleg committed Nov 4, 2024
1 parent 6ff7cb7 commit 46eabdc
Show file tree
Hide file tree
Showing 2 changed files with 157 additions and 85 deletions.
36 changes: 17 additions & 19 deletions sync/sync_head.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -174,28 +174,26 @@ func (s *Syncer[H]) verify(ctx context.Context, newHead H) (bool, error) {
}

var verErr *header.VerifyError
if !errors.As(err, &verErr) {
return false, nil
}
if errors.As(err, &verErr) {
if verErr.SoftFailure {
err := s.verifySkipping(ctx, sbjHead, newHead)
var errValSet *NewValidatorSetCantBeTrustedError
return errors.As(err, &errValSet), err
}

if verErr.SoftFailure {
err := s.verifySkipping(ctx, sbjHead, newHead)
return false, err
logF := log.Warnw
if errors.Is(err, header.ErrKnownHeader) {
logF = log.Debugw
}
logF("invalid network header",
"height_of_invalid", newHead.Height(),
"hash_of_invalid", newHead.Hash(),
"height_of_subjective", sbjHead.Height(),
"hash_of_subjective", sbjHead.Hash(),
"reason", verErr.Reason)
}

logF := log.Warnw
if errors.Is(err, header.ErrKnownHeader) {
logF = log.Debugw
}
logF("invalid network header",
"height_of_invalid", newHead.Height(),
"hash_of_invalid", newHead.Hash(),
"height_of_subjective", sbjHead.Height(),
"hash_of_subjective", sbjHead.Hash(),
"reason", verErr.Reason,
)

return verErr.SoftFailure, err
return false, err
}

/*
Expand Down
206 changes: 140 additions & 66 deletions sync/sync_head_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ func TestSyncer_HeadWithNotEnoughValidators(t *testing.T) {
require.True(t, wrappedGetter.withTrustedHead)
}

func TestSyncer_verifySkipping(t *testing.T) {
func TestSyncer_verifySkippingSuccess(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
t.Cleanup(cancel)

Expand Down Expand Up @@ -178,105 +178,179 @@ func TestSyncer_verifySkipping(t *testing.T) {
require.NoError(t, err)
})

t.Run("success (with bad candidates)", func(t *testing.T) {
const iters = 4
const iters = 4

headers := suite.GenDummyHeaders(total)
err = remoteStore.Append(ctx, headers...)
require.NoError(t, err)
headers := suite.GenDummyHeaders(total)
err = remoteStore.Append(ctx, headers...)
require.NoError(t, err)

var verifyCounter atomic.Int32
for i := range total {
headers[i].VerifyFn = func(hdr *headertest.DummyHeader) error {
if i >= 501 {
return nil
}
var verifyCounter atomic.Int32
for i := range total {
headers[i].VerifyFn = func(hdr *headertest.DummyHeader) error {
if hdr.Height() != badHeaderHeight {
return nil
}

verifyCounter.Add(1)
if verifyCounter.Load() <= iters {
return &header.VerifyError{
Reason: headertest.ErrDummyVerify,
SoftFailure: hdr.SoftFailure,
}
}
verifyCounter.Add(1)
if verifyCounter.Load() >= iters {
return nil
}

return &header.VerifyError{
Reason: headertest.ErrDummyVerify,
SoftFailure: hdr.SoftFailure,
}
}
}

headers[total-1].VerifyFailure = true
headers[total-1].SoftFailure = true
headers[total-1].VerifyFailure = true
headers[total-1].SoftFailure = true

subjHead, err := syncer.subjectiveHead(ctx)
require.NoError(t, err)
subjHead, err := syncer.subjectiveHead(ctx)
require.NoError(t, err)

err = syncer.verifySkipping(ctx, subjHead, headers[total-1])
require.NoError(t, err)
})
err = syncer.verifySkipping(ctx, subjHead, headers[total-1])
require.NoError(t, err)
}

func TestSyncer_verifySkippingSuccessWithBadCandidates(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
t.Cleanup(cancel)

const total = 1000
const badHeaderHeight = total + 1

t.Run("success", func(t *testing.T) {
const iters = 4
suite := headertest.NewTestSuite(t)
head := suite.Head()

headers := suite.GenDummyHeaders(total)
err = remoteStore.Append(ctx, headers...)
localStore := newTestStore(t, ctx, head)
remoteStore := newTestStore(t, ctx, head)

// create a wrappedGetter to track exchange interactions
wrappedGetter := newWrappedGetter(local.NewExchange(remoteStore))

syncer, err := NewSyncer(
wrappedGetter,
localStore,
headertest.NewDummySubscriber(),
WithBlockTime(time.Nanosecond),
WithRecencyThreshold(time.Nanosecond), // forces a request for a new sync target
// ensures that syncer's store contains a subjective head that is within
// the unbonding period so that the syncer can use a header from the network
// as a sync target
WithTrustingPeriod(time.Hour),
)
require.NoError(t, err)

// start the syncer which triggers a Head request that will
// load the syncer's subjective head from the store, and request
// a new sync target from the network rather than from trusted peers
err = syncer.Start(ctx)
require.NoError(t, err)
t.Cleanup(func() {
err = syncer.Stop(ctx)
require.NoError(t, err)
})

var verifyCounter atomic.Int32
for i := range total {
headers[i].VerifyFn = func(hdr *headertest.DummyHeader) error {
if hdr.Height() != badHeaderHeight {
return nil
}
const iters = 4

verifyCounter.Add(1)
if verifyCounter.Load() >= iters {
return nil
}
headers := suite.GenDummyHeaders(total)
err = remoteStore.Append(ctx, headers...)
require.NoError(t, err)

var verifyCounter atomic.Int32
for i := range total {
headers[i].VerifyFn = func(hdr *headertest.DummyHeader) error {
if i >= 501 {
return nil
}

verifyCounter.Add(1)
if verifyCounter.Load() <= iters {
return &header.VerifyError{
Reason: headertest.ErrDummyVerify,
SoftFailure: hdr.SoftFailure,
}
}
return nil
}
}

headers[total-1].VerifyFailure = true
headers[total-1].SoftFailure = true
headers[total-1].VerifyFailure = true
headers[total-1].SoftFailure = true

subjHead, err := syncer.subjectiveHead(ctx)
require.NoError(t, err)
subjHead, err := syncer.subjectiveHead(ctx)
require.NoError(t, err)

err = syncer.verifySkipping(ctx, subjHead, headers[total-1])
require.NoError(t, err)
}

func TestSyncer_verifySkippingCannotVerify(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
t.Cleanup(cancel)

const total = 1000
const badHeaderHeight = total + 1

suite := headertest.NewTestSuite(t)
head := suite.Head()

localStore := newTestStore(t, ctx, head)
remoteStore := newTestStore(t, ctx, head)

// create a wrappedGetter to track exchange interactions
wrappedGetter := newWrappedGetter(local.NewExchange(remoteStore))

err = syncer.verifySkipping(ctx, subjHead, headers[total-1])
syncer, err := NewSyncer(
wrappedGetter,
localStore,
headertest.NewDummySubscriber(),
WithBlockTime(time.Nanosecond),
WithRecencyThreshold(time.Nanosecond), // forces a request for a new sync target
// ensures that syncer's store contains a subjective head that is within
// the unbonding period so that the syncer can use a header from the network
// as a sync target
WithTrustingPeriod(time.Hour),
)
require.NoError(t, err)

// start the syncer which triggers a Head request that will
// load the syncer's subjective head from the store, and request
// a new sync target from the network rather than from trusted peers
err = syncer.Start(ctx)
require.NoError(t, err)
t.Cleanup(func() {
err = syncer.Stop(ctx)
require.NoError(t, err)
})

t.Run("cannot verify", func(t *testing.T) {
headers := suite.GenDummyHeaders(total)
err = remoteStore.Append(ctx, headers...)
require.NoError(t, err)
headers := suite.GenDummyHeaders(total)
err = remoteStore.Append(ctx, headers...)
require.NoError(t, err)

for i := range total {
headers[i].VerifyFn = func(hdr *headertest.DummyHeader) error {
if hdr.Height() != badHeaderHeight {
return nil
}
for i := range total {
headers[i].VerifyFn = func(hdr *headertest.DummyHeader) error {
if hdr.Height() != badHeaderHeight {
return nil
}

return &header.VerifyError{
Reason: headertest.ErrDummyVerify,
SoftFailure: hdr.SoftFailure,
}
return &header.VerifyError{
Reason: headertest.ErrDummyVerify,
SoftFailure: hdr.SoftFailure,
}
}
}

headers[total-1].VerifyFailure = true
headers[total-1].SoftFailure = true
headers[total-1].VerifyFailure = true
headers[total-1].SoftFailure = true

subjHead, err := syncer.subjectiveHead(ctx)
require.NoError(t, err)
subjHead, err := syncer.subjectiveHead(ctx)
require.NoError(t, err)

err = syncer.verifySkipping(ctx, subjHead, headers[total-1])
var verErr *NewValidatorSetCantBeTrustedError
assert.ErrorAs(t, err, &verErr)
})
err = syncer.verifySkipping(ctx, subjHead, headers[total-1])
var verErr *NewValidatorSetCantBeTrustedError
assert.ErrorAs(t, err, &verErr, "%T", err)
}

type wrappedGetter struct {
Expand Down

0 comments on commit 46eabdc

Please sign in to comment.