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

Remove lock options from the IPCs api #2151

Merged
merged 1 commit into from
Oct 11, 2023
Merged

Remove lock options from the IPCs api #2151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
84 changes: 43 additions & 41 deletions api/ipcs/service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,78 +5,75 @@ package ipcs

import (
"net/http"
"sync"

"github.com/gorilla/rpc/v2"

"go.uber.org/zap"

"github.com/ava-labs/avalanchego/api"
"github.com/ava-labs/avalanchego/api/server"
"github.com/ava-labs/avalanchego/chains"
"github.com/ava-labs/avalanchego/ids"
"github.com/ava-labs/avalanchego/ipcs"
"github.com/ava-labs/avalanchego/snow/engine/common"
"github.com/ava-labs/avalanchego/utils/json"
"github.com/ava-labs/avalanchego/utils/logging"
)

// IPCServer maintains the IPCs
type IPCServer struct {
httpServer server.Server
Copy link
Contributor

Choose a reason for hiding this comment

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

httpServer was not really used. Cleaned it up

chainManager chains.Manager
type Service struct {
log logging.Logger
chainManager chains.Manager
lock sync.RWMutex
ipcs *ipcs.ChainIPCs
}

// NewService returns a new IPCs API service
func NewService(log logging.Logger, chainManager chains.Manager, httpServer server.Server, ipcs *ipcs.ChainIPCs) (*common.HTTPHandler, error) {
ipcServer := &IPCServer{
log: log,
chainManager: chainManager,
httpServer: httpServer,

ipcs: ipcs,
}

newServer := rpc.NewServer()
func NewService(log logging.Logger, chainManager chains.Manager, ipcs *ipcs.ChainIPCs) (http.Handler, error) {
server := rpc.NewServer()
codec := json.NewCodec()
newServer.RegisterCodec(codec, "application/json")
newServer.RegisterCodec(codec, "application/json;charset=UTF-8")

return &common.HTTPHandler{Handler: newServer}, newServer.RegisterService(ipcServer, "ipcs")
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Main goal of this PR is to remove the usage of common.WriteLock

server.RegisterCodec(codec, "application/json")
server.RegisterCodec(codec, "application/json;charset=UTF-8")
return server, server.RegisterService(
&Service{
log: log,
chainManager: chainManager,
ipcs: ipcs,
},
"ipcs",
)
}

// PublishBlockchainArgs are the arguments for calling PublishBlockchain
type PublishBlockchainArgs struct {
BlockchainID string `json:"blockchainID"`
}

// PublishBlockchainReply are the results from calling PublishBlockchain
type PublishBlockchainReply struct {
ConsensusURL string `json:"consensusURL"`
DecisionsURL string `json:"decisionsURL"`
}

// PublishBlockchain publishes the finalized accepted transactions from the blockchainID over the IPC
func (ipc *IPCServer) PublishBlockchain(_ *http.Request, args *PublishBlockchainArgs, reply *PublishBlockchainReply) error {
ipc.log.Warn("deprecated API called",
// PublishBlockchain publishes the finalized accepted transactions from the
// blockchainID over the IPC
func (s *Service) PublishBlockchain(_ *http.Request, args *PublishBlockchainArgs, reply *PublishBlockchainReply) error {
s.log.Warn("deprecated API called",
zap.String("service", "ipcs"),
zap.String("method", "publishBlockchain"),
logging.UserString("blockchainID", args.BlockchainID),
)

chainID, err := ipc.chainManager.Lookup(args.BlockchainID)
chainID, err := s.chainManager.Lookup(args.BlockchainID)
if err != nil {
ipc.log.Error("chain lookup failed",
s.log.Error("chain lookup failed",
logging.UserString("blockchainID", args.BlockchainID),
zap.Error(err),
)
return err
}

ipcs, err := ipc.ipcs.Publish(chainID)
s.lock.Lock()
defer s.lock.Unlock()

ipcs, err := s.ipcs.Publish(chainID)
if err != nil {
ipc.log.Error("couldn't publish chain",
s.log.Error("couldn't publish chain",
logging.UserString("blockchainID", args.BlockchainID),
zap.Error(err),
)
Expand All @@ -89,31 +86,33 @@ func (ipc *IPCServer) PublishBlockchain(_ *http.Request, args *PublishBlockchain
return nil
}

// UnpublishBlockchainArgs are the arguments for calling UnpublishBlockchain
type UnpublishBlockchainArgs struct {
BlockchainID string `json:"blockchainID"`
}

// UnpublishBlockchain closes publishing of a blockchainID
func (ipc *IPCServer) UnpublishBlockchain(_ *http.Request, args *UnpublishBlockchainArgs, _ *api.EmptyReply) error {
ipc.log.Warn("deprecated API called",
func (s *Service) UnpublishBlockchain(_ *http.Request, args *UnpublishBlockchainArgs, _ *api.EmptyReply) error {
s.log.Warn("deprecated API called",
zap.String("service", "ipcs"),
zap.String("method", "unpublishBlockchain"),
logging.UserString("blockchainID", args.BlockchainID),
)

chainID, err := ipc.chainManager.Lookup(args.BlockchainID)
chainID, err := s.chainManager.Lookup(args.BlockchainID)
if err != nil {
ipc.log.Error("chain lookup failed",
s.log.Error("chain lookup failed",
logging.UserString("blockchainID", args.BlockchainID),
zap.Error(err),
)
return err
}

ok, err := ipc.ipcs.Unpublish(chainID)
s.lock.Lock()
defer s.lock.Unlock()

ok, err := s.ipcs.Unpublish(chainID)
if !ok {
ipc.log.Error("couldn't publish chain",
s.log.Error("couldn't publish chain",
logging.UserString("blockchainID", args.BlockchainID),
zap.Error(err),
)
Expand All @@ -122,17 +121,20 @@ func (ipc *IPCServer) UnpublishBlockchain(_ *http.Request, args *UnpublishBlockc
return err
}

// GetPublishedBlockchainsReply is the result from calling GetPublishedBlockchains
type GetPublishedBlockchainsReply struct {
Chains []ids.ID `json:"chains"`
}

// GetPublishedBlockchains returns blockchains being published
func (ipc *IPCServer) GetPublishedBlockchains(_ *http.Request, _ *struct{}, reply *GetPublishedBlockchainsReply) error {
ipc.log.Warn("deprecated API called",
func (s *Service) GetPublishedBlockchains(_ *http.Request, _ *struct{}, reply *GetPublishedBlockchainsReply) error {
s.log.Warn("deprecated API called",
zap.String("service", "ipcs"),
zap.String("method", "getPublishedBlockchains"),
)
reply.Chains = ipc.ipcs.GetPublishedBlockchains()

s.lock.RLock()
defer s.lock.RUnlock()

reply.Chains = s.ipcs.GetPublishedBlockchains()
return nil
}
12 changes: 10 additions & 2 deletions node/node.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1236,11 +1236,19 @@ func (n *Node) initIPCAPI() error {
return nil
}
n.Log.Warn("initializing deprecated ipc API")
service, err := ipcsapi.NewService(n.Log, n.chainManager, n.APIServer, n.IPCs)
service, err := ipcsapi.NewService(n.Log, n.chainManager, n.IPCs)
if err != nil {
return err
}
return n.APIServer.AddRoute(service, &sync.RWMutex{}, "ipcs", "")
return n.APIServer.AddRoute(
&common.HTTPHandler{
LockOptions: common.NoLock,
Handler: service,
},
&sync.RWMutex{},
"ipcs",
"",
)
}

// Give chains aliases as specified by the genesis information
Expand Down