Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 19 additions & 1 deletion pkg/loop/internal/relayer/relayer.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"errors"
"fmt"
"math/big"
"sync"

"github.com/google/uuid"
"google.golang.org/grpc"
Expand Down Expand Up @@ -102,6 +103,9 @@ type pluginRelayerServer struct {
*net.BrokerExt

impl looptypes.PluginRelayer

activeRelayerMu sync.Mutex
activeRelayer net.Resource
}

func RegisterPluginRelayerServer(server *grpc.Server, broker net.Broker, brokerCfg net.BrokerConfig, impl looptypes.PluginRelayer) error {
Expand Down Expand Up @@ -150,12 +154,13 @@ func (p *pluginRelayerServer) NewRelayer(ctx context.Context, request *pb.NewRel
err = r.Start(ctx)
if err != nil {
p.CloseAll(ksRes, ksCSARes, crRes)
err = errors.Join(err, r.Close())
return nil, err
}

const name = "Relayer"
rRes := net.Resource{Closer: r, Name: name}
id, _, err := p.ServeNew(name, func(s *grpc.Server) {
id, relayerResource, err := p.ServeNew(name, func(s *grpc.Server) {
pb.RegisterServiceServer(s, &goplugin.ServiceServer{Srv: r})
pb.RegisterRelayerServer(s, newChainRelayerServer(r, p.BrokerExt))
if evmService, ok := r.(types.EVMService); ok {
Expand All @@ -175,9 +180,22 @@ func (p *pluginRelayerServer) NewRelayer(ctx context.Context, request *pb.NewRel
return nil, err
}

p.replaceActiveRelayer(relayerResource)

return &pb.NewRelayerReply{RelayerID: id}, nil
}

func (p *pluginRelayerServer) replaceActiveRelayer(next net.Resource) {
p.activeRelayerMu.Lock()
prev := p.activeRelayer
p.activeRelayer = next
p.activeRelayerMu.Unlock()

if prev.Closer != nil {
p.CloseAll(prev)
}
}

// relayerClient adapts a GRPC [pb.RelayerClient] to implement [Relayer].
type relayerClient struct {
*net.BrokerExt
Expand Down
32 changes: 32 additions & 0 deletions pkg/loop/internal/relayer/relayer_lifecycle_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
package relayer

import (
"testing"

"github.com/stretchr/testify/require"

"github.com/smartcontractkit/chainlink-common/pkg/logger"
loopnet "github.com/smartcontractkit/chainlink-common/pkg/loop/internal/net"
)

func TestReplaceActiveRelayerClosesPreviousResource(t *testing.T) {
server := newPluginRelayerServer(nil, loopnet.BrokerConfig{Logger: logger.Test(t)}, nil)
first := &countingCloser{}
second := &countingCloser{}

server.replaceActiveRelayer(loopnet.Resource{Closer: first, Name: "first"})
require.Equal(t, 0, first.closed)

server.replaceActiveRelayer(loopnet.Resource{Closer: second, Name: "second"})
require.Equal(t, 1, first.closed)
require.Equal(t, 0, second.closed)
}

type countingCloser struct {
closed int
}

func (c *countingCloser) Close() error {
c.closed++
return nil
}
3 changes: 3 additions & 0 deletions pkg/loop/internal/types/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ import (

type PluginRelayer interface {
services.Service
// NewRelayer returns the active relayer for the plugin. Re-invoking NewRelayer
// replaces the previously served relayer; implementations must not retain
// background resources from old relayers outside the returned service.
Comment on lines +14 to +16
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why is it desirable to introduce this property? If NewRelayer is being called more than once, that is definitionally a bug that we should diagnose. If we want to also be defensive about enforcing the existing singleton property, then we could do that, but it's really most important to find the upstream root cause that allowed this to happen.

Also, we used to run multiple relayers instances inside of one plugin, in which case multiple calls were expected, and so a singleton or even single swappable instance is actually too restrictive and keying on chain ID would be more aligned.

NewRelayer(ctx context.Context, config string, keystore, csaKeystore core.Keystore, capabilityRegistry core.CapabilitiesRegistry) (Relayer, error)
}

Expand Down
Loading