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

[api] API delay before readiness #4516

Merged
merged 4 commits into from
Jan 7, 2025
+13 −0
Merged

[api] API delay before readiness #4516

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7d5dc50
delay ready for api node
envestcc Dec 6, 2024
fdf670d
only enable for gateway
envestcc Dec 9, 2024
62ef777
address comment
envestcc Jan 7, 2025
59b8648
Merge branch 'master' into ready_delay
dustinxie Jan 7, 2025
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
4 changes: 4 additions & 0 deletions api/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
package api

import (
"time"

"github.com/iotexproject/iotex-core/v2/gasstation"
"github.com/iotexproject/iotex-core/v2/pkg/tracer"
)
Expand All @@ -27,6 +29,8 @@ type Config struct {
WebsocketRateLimit int `yaml:"websocketRateLimit"`
// ListenerLimit is the maximum number of listeners.
ListenerLimit int `yaml:"listenerLimit"`
// ReadyDuration is the duration to wait for the server to be ready.
ReadyDuration time.Duration `yaml:"readyDuration"`
Copy link
Member

Choose a reason for hiding this comment

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

where is this value set? I also don't see a default value

Copy link
Member Author

Choose a reason for hiding this comment

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

0 is default value, which means no delay

}

// DefaultConfig is the default config
Expand Down
10 changes: 10 additions & 0 deletions server/itx/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import (
"net/http/pprof"
"runtime"
"sync"
"time"

"github.com/pkg/errors"
"go.uber.org/zap"
Expand Down Expand Up @@ -231,9 +232,18 @@ func StartServer(ctx context.Context, svr *Server, probeSvr *probe.Server, cfg c
log.L().Panic("Failed to stop server.", zap.Error(err))
}
}()
if cfg.API.ReadyDuration > 0 {
Copy link
Collaborator

Choose a reason for hiding this comment

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

which apis or functions will be impacted? any of them could be started? e.g., heartbeat

Copy link
Member Author

Choose a reason for hiding this comment

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

The waiting occurs after all lifecycle items (e.g., API, P2P) have already started, except for the heartBeat logging and admin API(for debug).

From an external perspective:

  • P2P is already ready and can receive blocks and actions.
  • The API(e.g. http, grpc, wss) is not ready because the GET /readiness returns 503.

// wait for a while to make sure the server is ready
// The original intention was to ensure that all transactions that were not received during the restart were included in block, thereby avoiding inconsistencies in the state of the API node.
log.L().Info("Waiting for server to be ready.", zap.Duration("duration", cfg.API.ReadyDuration))
readyTimer := time.NewTimer(cfg.API.ReadyDuration)
<-readyTimer.C
readyTimer.Stop()
Copy link
Member

Choose a reason for hiding this comment

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

can simplify to time.Sleep(cfg.API.ReadyDuration)?

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed

}
if err := probeSvr.TurnOn(); err != nil {
log.L().Panic("Failed to turn on probe server.", zap.Error(err))
}
log.L().Info("Server is ready.")

if cfg.System.HeartbeatInterval > 0 {
task := routine.NewRecurringTask(NewHeartbeatHandler(svr, cfg.Network).Log, cfg.System.HeartbeatInterval)
Expand Down
Loading