Skip to content

Commit

Permalink
fix(f3): try again when we fail to fetch the manifest
Browse files Browse the repository at this point in the history
Continuing with the function here will lead to a panic. This can happen,
e.g., if the lotus node stops and/or returns an error while the
participant is waiting for its lease to expire.
  • Loading branch information
Stebalien committed Oct 24, 2024
1 parent 02a8b97 commit f5e827f
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 0 deletions.
1 change: 1 addition & 0 deletions chain/lf3/participation.go
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,7 @@ func (p *Participant) awaitLeaseExpiry(ctx context.Context, lease api.F3Particip
}
log.Errorw("Failed to check F3 progress while awaiting lease expiry. Retrying after backoff.", "attempts", p.backoff.Attempt(), "backoff", p.backoff.Duration(), "err", err)
p.backOff(ctx)
continue
case manifest == nil || manifest.NetworkName != lease.Network:
// If we got an unexpected manifest, or no manifest, go back to the
// beginning and try to get another ticket. Switching from having a manifest
Expand Down
75 changes: 75 additions & 0 deletions chain/lf3/participation_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
package lf3_test

import (
"context"
"errors"
"testing"
"time"

"github.com/jpillora/backoff"
"github.com/stretchr/testify/require"

"github.com/filecoin-project/go-address"
"github.com/filecoin-project/go-f3/gpbft"
"github.com/filecoin-project/go-f3/manifest"

"github.com/filecoin-project/lotus/api"
"github.com/filecoin-project/lotus/chain/lf3"
"github.com/filecoin-project/lotus/node/modules/dtypes"
)

type manifestFailAPI struct {
manifestRequested chan struct{}
}

func (m *manifestFailAPI) F3GetManifest(ctx context.Context) (*manifest.Manifest, error) {
select {
case m.manifestRequested <- struct{}{}:
default:
}
return nil, errors.New("test error")
}

func (m *manifestFailAPI) F3GetOrRenewParticipationTicket(ctx context.Context, minerID address.Address, previous api.F3ParticipationTicket, instances uint64) (api.F3ParticipationTicket, error) {
switch string(previous) {
case "good ticket":
return api.F3ParticipationTicket("bad ticket"), nil
case "":
return api.F3ParticipationTicket("good ticket"), nil
default:
panic("unexpected ticket")
}
}

func (m *manifestFailAPI) F3GetProgress(ctx context.Context) (gpbft.Instant, error) {
return gpbft.Instant{}, nil
}

func (m *manifestFailAPI) F3Participate(ctx context.Context, ticket api.F3ParticipationTicket) (api.F3ParticipationLease, error) {
return api.F3ParticipationLease{
Network: "test",
Issuer: "foobar",
MinerID: 0,
FromInstance: 0,
ValidityTerm: 10,
}, nil
}

// Test that we correctly handle failed requests for the manifest and keep trying to get it.
func TestParticipantManifestFailure(t *testing.T) {
api := &manifestFailAPI{manifestRequested: make(chan struct{}, 5)}
addr, err := address.NewIDAddress(1000)
require.NoError(t, err)

p := lf3.NewParticipant(context.Background(), api, dtypes.MinerAddress(addr),
&backoff.Backoff{
Min: 1 * time.Second,
Max: 1 * time.Minute,
Factor: 1.5,
}, 13, 5)
require.NoError(t, p.Start(context.Background()))
<-api.manifestRequested
<-api.manifestRequested
<-api.manifestRequested
require.NoError(t, p.Stop(context.Background()))
}

0 comments on commit f5e827f

Please sign in to comment.