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.

Sign up for GitHub

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: worker: Close all storage paths on worker shutdown #9153

Merged
merged 4 commits into from
Aug 11, 2022
Merged

fix: worker: Close all storage paths on worker shutdown #9153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f390c18
Close all storage paths on worker shutdown
Aug 10, 2022
10dba44
Add return value assignments
Aug 10, 2022
4d10487
log errors when closing all paths instead of stopping execution
Aug 11, 2022
1c98e37
fiximports
Aug 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions api/api_worker.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ type Worker interface {
StorageLocal(ctx context.Context) (map[storiface.ID]string, error) //perm:admin
StorageAddLocal(ctx context.Context, path string) error //perm:admin
StorageDetachLocal(ctx context.Context, path string) error //perm:admin
StorageDetachAll(ctx context.Context) error //perm:admin
StorageRedeclareLocal(ctx context.Context, id *storiface.ID, dropMissing bool) error //perm:admin

// SetEnabled marks the worker as enabled/disabled. Not that this setting
Expand Down
13 changes: 13 additions & 0 deletions api/proxy_gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file modified build/openrpc/full.json.gz
View file
Open in desktop
Binary file not shown.
Binary file modified build/openrpc/gateway.json.gz
View file
Open in desktop
Binary file not shown.
Binary file modified build/openrpc/miner.json.gz
View file
Open in desktop
Binary file not shown.
Binary file modified build/openrpc/worker.json.gz
View file
Open in desktop
Binary file not shown.
7 changes: 7 additions & 0 deletions cmd/lotus-worker/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,13 @@ var stopCmd = &cli.Command{
defer closer()

ctx := lcli.ReqContext(cctx)

// Detach any storage associated with this worker
err = api.StorageDetachAll(ctx)
if err != nil {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm of the opinion that we should continue execution since shutdown should be best effort and should not be stopped if we can't close some paths
But the linter doesn't allow me ignore the return. Is there a better way to do this here? What are your thoughts?

Copy link
Contributor

@geoff-vball geoff-vball Aug 10, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

replace err with _ if you want to explicitly ignore a return value. Leave a helpful comment with why you're doing so :)

In this case we can probably just log the error instead of returning if we want to continue on.

return err
}

err = api.Shutdown(ctx)
if err != nil {
return err
Expand Down
20 changes: 20 additions & 0 deletions cmd/lotus-worker/sealworker/rpc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (

"github.com/google/uuid"
"github.com/gorilla/mux"
logging "github.com/ipfs/go-log/v2"
"github.com/mitchellh/go-homedir"
"golang.org/x/xerrors"

Expand All @@ -23,6 +24,8 @@ import (
"github.com/filecoin-project/lotus/storage/sealer/storiface"
)

var log = logging.Logger("sealworker")

func WorkerHandler(authv func(ctx context.Context, token string) ([]auth.Permission, error), remote http.HandlerFunc, a api.Worker, permissioned bool) http.Handler {
mux := mux.NewRouter()
readerHandler, readerServerOpt := rpcenc.ReaderParamDecoder()
Expand Down Expand Up @@ -146,6 +149,23 @@ func (w *Worker) StorageDetachLocal(ctx context.Context, path string) error {
return w.LocalStore.ClosePath(ctx, localPath.ID)
}

func (w *Worker) StorageDetachAll(ctx context.Context) error {

lps, err := w.LocalStore.Local(ctx)
if err != nil {
return xerrors.Errorf("getting local path list: %w", err)
}

for _, lp := range lps {
err = w.LocalStore.ClosePath(ctx, lp.ID)
if err != nil {
log.Warnf("unable to close path: %w", err)
}
}

return nil
}

func (w *Worker) StorageRedeclareLocal(ctx context.Context, id *storiface.ID, dropMissing bool) error {
return w.LocalStore.Redeclare(ctx, id, dropMissing)
}
Expand Down
10 changes: 10 additions & 0 deletions documentation/en/api-v0-methods-worker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
* [SetEnabled](#SetEnabled)
* [Storage](#Storage)
* [StorageAddLocal](#StorageAddLocal)
* [StorageDetachAll](#StorageDetachAll)
* [StorageDetachLocal](#StorageDetachLocal)
* [StorageLocal](#StorageLocal)
* [StorageRedeclareLocal](#StorageRedeclareLocal)
Expand Down Expand Up @@ -2121,6 +2122,15 @@ Inputs:

Response: `{}`

### StorageDetachAll


Perms: admin

Inputs: `null`

Response: `{}`

### StorageDetachLocal


Expand Down