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
31 changes: 21 additions & 10 deletions deployment/common/view/nops.go
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,27 @@ type OCRKeyView struct {
KeyBundleID string `json:"keyBundleID"`
}

// nodeInfoBestEffort returns node info for all nodes found in JD. A node with malformed
// metadata (e.g. an unparsable chain ID) is kept with partial info instead of failing the view.
func nodeInfoBestEffort(lggr logger.Logger, nodeIDs []string, oc cldf_offchain.Client) (deployment.Nodes, error) {
nodes, err := deployment.NodeInfo(nodeIDs, oc)
if err == nil {
return nodes, nil
}
if len(nodes) == 0 && !errors.Is(err, deployment.ErrMissingNodeMetadata) {
return nil, fmt.Errorf("failed to get node info: %w", err)
}
lggr.Warnf("Incomplete node metadata, continuing with partial node info: %v", err)

return nodes, nil
}

// GenerateNopsView generates a view of nodes with their details
func GenerateNopsView(lggr logger.Logger, nodeIDs []string, oc cldf_offchain.Client) (map[string]NopView, error) {
nv := make(map[string]NopView)
nodes, err := deployment.NodeInfo(nodeIDs, oc)
if errors.Is(err, deployment.ErrMissingNodeMetadata) {
lggr.Warnf("Missing node metadata: %s", err.Error())
} else if err != nil {
return nv, fmt.Errorf("failed to get node info: %w", err)
nodes, err := nodeInfoBestEffort(lggr, nodeIDs, oc)
if err != nil {
return nv, err
}
nodesResp, err := oc.ListNodes(context.Background(), &nodev1.ListNodesRequest{
Filter: &nodev1.ListNodesRequest_Filter{
Expand Down Expand Up @@ -159,11 +172,9 @@ type NopNameRemapper func(nodeName string) string
// GenerateNOPsViewV2 generates a view of nodes with their details in a new format.
// `deploymentKey` refers to the deployment identifier (e.g., "keystone", "cre", "ccip", "data-feeds"), which usually refers to the CLD domain.
func GenerateNOPsViewV2(ctx context.Context, lggr logger.Logger, nodeIDs []string, oc cldf_offchain.Client, deploymentKey string, nopNameRemapperFunc NopNameRemapper) (map[string]NopViewV2, error) {
nodes, err := deployment.NodeInfo(nodeIDs, oc)
if errors.Is(err, deployment.ErrMissingNodeMetadata) {
lggr.Warnf("Missing node metadata: %s", err.Error())
} else if err != nil {
return nil, fmt.Errorf("failed to get node info: %w", err)
nodes, err := nodeInfoBestEffort(lggr, nodeIDs, oc)
if err != nil {
return nil, err
}
nodesResp, err := oc.ListNodes(ctx, &nodev1.ListNodesRequest{
Filter: &nodev1.ListNodesRequest_Filter{
Expand Down
38 changes: 38 additions & 0 deletions deployment/common/view/nops_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,23 @@ func TestGenerateNopsView(t *testing.T) {
assert.Empty(t, v)
})

t.Run("node with malformed chain ID is kept and does not drop other nodes", func(t *testing.T) {
malformedJDService := &customJDService{
NodeServiceClient: jdService,
chainConfigs: map[string][]*nodev1.ChainConfig{
"node_2": {malformedEVMChainConfig(p2pIDs[1])},
},
}

v2, err := GenerateNOPsViewV2(t.Context(), lggr, nodeIDs, malformedJDService, "test", nil)
require.NoError(t, err)
require.Len(t, v2["testnop"].Nodes, 3)

v1, err := GenerateNopsView(lggr, nodeIDs, malformedJDService)
require.NoError(t, err)
require.Len(t, v1, 3)
})

t.Run("error from ListNodes", func(t *testing.T) {
// Create a custom JD service that returns an error for ListNodes
errorJDService := &customJDService{
Expand Down Expand Up @@ -136,6 +153,7 @@ func assertLabelExists(t *testing.T, labels []LabelView, key, expectedValue stri
type customJDService struct {
nodev1.NodeServiceClient
listNodesError error
chainConfigs map[string][]*nodev1.ChainConfig
*test.UnimplementedCSAServiceClient
*test.UnimplementedJobServiceClient
}
Expand All @@ -146,3 +164,23 @@ func (s *customJDService) ListNodes(ctx context.Context, req *nodev1.ListNodesRe
}
return s.NodeServiceClient.ListNodes(ctx, req, opts...)
}

func (s *customJDService) ListNodeChainConfigs(ctx context.Context, req *nodev1.ListNodeChainConfigsRequest, opts ...grpc.CallOption) (*nodev1.ListNodeChainConfigsResponse, error) {
for _, id := range req.GetFilter().GetNodeIds() {
if cfgs, ok := s.chainConfigs[id]; ok {
return &nodev1.ListNodeChainConfigsResponse{ChainConfigs: cfgs}, nil
}
}
return s.NodeServiceClient.ListNodeChainConfigs(ctx, req, opts...)
}

// malformedEVMChainConfig mimics a node exporting its chain ID combined with the chain name.
func malformedEVMChainConfig(peerID string) *nodev1.ChainConfig {
return &nodev1.ChainConfig{
Chain: &nodev1.Chain{Id: "11155111 ethereum-testnet-sepolia", Type: nodev1.ChainType_CHAIN_TYPE_EVM},
Ocr2Config: &nodev1.OCR2Config{
P2PKeyBundle: &nodev1.OCR2Config_P2PKeyBundle{PeerId: peerID},
OcrKeyBundle: &nodev1.OCR2Config_OCRKeyBundle{},
},
}
}
Loading