Add blockchain endpoint filtering to remove outdated endpoints (#2978)

Filter out RPC and WS endpoints that reference old blockchain IDs
when adding default blockchain RPCs to sidecar. This prevents stale
endpoints from accumulating in the sidecar when blockchains are
redeployed with new IDs.

Author: felipemadero

pkg/application/app.go

@@ -653,6 +653,50 @@ func (app *Avalanche) UpdateSidecarNetworks(
 	return nil
 }
 
+// extractBlockchainIDFromEndpoint extracts the blockchain ID from an RPC or WS endpoint URL.
+// Expected format: {scheme}://{host}/ext/bc/{blockchainID}/{rpc|ws}
+// Returns empty string if the blockchain ID cannot be extracted.
+func extractBlockchainIDFromEndpoint(endpoint string) string {
+	// Look for /ext/bc/ pattern followed by the blockchain ID
+	const bcPrefix = "/ext/bc/"
+	bcIndex := strings.Index(endpoint, bcPrefix)
+	if bcIndex == -1 {
+		return ""
+	}
+
+	// Extract the part after /ext/bc/
+	afterBC := endpoint[bcIndex+len(bcPrefix):]
+
+	// The blockchain ID is everything before the next /
+	slashIndex := strings.Index(afterBC, "/")
+	if slashIndex == -1 {
+		return ""
+	}
+
+	return afterBC[:slashIndex]
+}
+
+// filterOutdatedBlockchainEndpoints removes endpoints that contain a blockchain ID
+// that doesn't match the current blockchain ID. Endpoints without a blockchain ID
+// in the URL are preserved.
+func filterOutdatedBlockchainEndpoints(endpoints []string, currentBlockchainID string) []string {
+	if currentBlockchainID == "" {
+		return endpoints
+	}
+
+	filtered := []string{}
+	for _, endpoint := range endpoints {
+		extractedID := extractBlockchainIDFromEndpoint(endpoint)
+		// Keep endpoint if:
+		// 1. It doesn't contain a blockchain ID pattern (extractedID == "")
+		// 2. It contains the current blockchain ID
+		if extractedID == "" || extractedID == currentBlockchainID {
+			filtered = append(filtered, endpoint)
+		}
+	}
+	return filtered
+}
+
 // AddDefaultBlockchainRPCsToSidecar, given a list of (public) node URIs, it generates
 // the default blockchain RPC and WS endpoints for those URIs, and adds them
 // to the blockchain's sidecar as blockchain URLs
@@ -669,11 +713,17 @@ func (app *Avalanche) AddDefaultBlockchainRPCsToSidecar(
 	if networkInfo.BlockchainID == ids.Empty {
 		return sc, fmt.Errorf("blockchain %s has not been deployed to %s", blockchainName, networkModel.Name())
 	}
-	rpcEndpoints := set.Of(networkInfo.RPCEndpoints...)
-	wsEndpoints := set.Of(networkInfo.WSEndpoints...)
+
+	// Filter out endpoints that reference old blockchain IDs
+	currentBlockchainID := networkInfo.BlockchainID.String()
+	filteredRPCEndpoints := filterOutdatedBlockchainEndpoints(networkInfo.RPCEndpoints, currentBlockchainID)
+	filteredWSEndpoints := filterOutdatedBlockchainEndpoints(networkInfo.WSEndpoints, currentBlockchainID)
+
+	rpcEndpoints := set.Of(filteredRPCEndpoints...)
+	wsEndpoints := set.Of(filteredWSEndpoints...)
 	for _, nodeURI := range nodeURIs {
-		rpcEndpoints.Add(models.GetRPCEndpoint(nodeURI, networkInfo.BlockchainID.String()))
-		wsEndpoints.Add(models.GetWSEndpoint(nodeURI, networkInfo.BlockchainID.String()))
+		rpcEndpoints.Add(models.GetRPCEndpoint(nodeURI, currentBlockchainID))
+		wsEndpoints.Add(models.GetWSEndpoint(nodeURI, currentBlockchainID))
 	}
 	networkInfo.RPCEndpoints = rpcEndpoints.List()
 	networkInfo.WSEndpoints = wsEndpoints.List()

pkg/application/app_test.go

@@ -283,3 +283,134 @@ func newTestApp(t *testing.T) *Avalanche {
 		Log:     logging.NoLog{},
 	}
 }
+
+func TestExtractBlockchainIDFromEndpoint(t *testing.T) {
+	tests := []struct {
+		name     string
+		endpoint string
+		expected string
+	}{
+		{
+			name:     "valid RPC endpoint",
+			endpoint: "http://127.0.0.1:55067/ext/bc/2ATnxvq9GwPrEPHyULDJqpanFNJecvzSGZ3w5jMzfZAWSmXC6u/rpc",
+			expected: "2ATnxvq9GwPrEPHyULDJqpanFNJecvzSGZ3w5jMzfZAWSmXC6u",
+		},
+		{
+			name:     "valid WS endpoint",
+			endpoint: "ws://127.0.0.1:55067/ext/bc/X2oDj86zGjCRCy6vd8Cca4FDStMeFAHWc7SUUygPCCfYf9sHh/ws",
+			expected: "X2oDj86zGjCRCy6vd8Cca4FDStMeFAHWc7SUUygPCCfYf9sHh",
+		},
+		{
+			name:     "endpoint without blockchain ID",
+			endpoint: "http://127.0.0.1:9650/ext/info",
+			expected: "",
+		},
+		{
+			name:     "endpoint with no path after blockchain ID",
+			endpoint: "http://127.0.0.1:9650/ext/bc/someblockchainid",
+			expected: "",
+		},
+		{
+			name:     "empty endpoint",
+			endpoint: "",
+			expected: "",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			require := require.New(t)
+			result := extractBlockchainIDFromEndpoint(tt.endpoint)
+			require.Equal(tt.expected, result)
+		})
+	}
+}
+
+func TestFilterOutdatedBlockchainEndpoints(t *testing.T) {
+	currentBlockchainID := "X2oDj86zGjCRCy6vd8Cca4FDStMeFAHWc7SUUygPCCfYf9sHh"
+	oldBlockchainID := "2ATnxvq9GwPrEPHyULDJqpanFNJecvzSGZ3w5jMzfZAWSmXC6u"
+
+	tests := []struct {
+		name                string
+		endpoints           []string
+		currentBlockchainID string
+		expected            []string
+	}{
+		{
+			name: "filter out old blockchain ID endpoints",
+			endpoints: []string{
+				"http://127.0.0.1:55067/ext/bc/" + oldBlockchainID + "/rpc",
+				"http://127.0.0.1:60645/ext/bc/" + currentBlockchainID + "/rpc",
+			},
+			currentBlockchainID: currentBlockchainID,
+			expected: []string{
+				"http://127.0.0.1:60645/ext/bc/" + currentBlockchainID + "/rpc",
+			},
+		},
+		{
+			name: "preserve endpoints without blockchain ID",
+			endpoints: []string{
+				"http://127.0.0.1:55067/ext/bc/" + oldBlockchainID + "/rpc",
+				"http://127.0.0.1:9650/ext/info",
+				"http://127.0.0.1:60645/ext/bc/" + currentBlockchainID + "/rpc",
+			},
+			currentBlockchainID: currentBlockchainID,
+			expected: []string{
+				"http://127.0.0.1:9650/ext/info",
+				"http://127.0.0.1:60645/ext/bc/" + currentBlockchainID + "/rpc",
+			},
+		},
+		{
+			name: "keep all current blockchain endpoints",
+			endpoints: []string{
+				"http://127.0.0.1:60645/ext/bc/" + currentBlockchainID + "/rpc",
+				"http://127.0.0.1:60646/ext/bc/" + currentBlockchainID + "/rpc",
+			},
+			currentBlockchainID: currentBlockchainID,
+			expected: []string{
+				"http://127.0.0.1:60645/ext/bc/" + currentBlockchainID + "/rpc",
+				"http://127.0.0.1:60646/ext/bc/" + currentBlockchainID + "/rpc",
+			},
+		},
+		{
+			name: "empty current blockchain ID returns all endpoints",
+			endpoints: []string{
+				"http://127.0.0.1:55067/ext/bc/" + oldBlockchainID + "/rpc",
+				"http://127.0.0.1:60645/ext/bc/" + currentBlockchainID + "/rpc",
+			},
+			currentBlockchainID: "",
+			expected: []string{
+				"http://127.0.0.1:55067/ext/bc/" + oldBlockchainID + "/rpc",
+				"http://127.0.0.1:60645/ext/bc/" + currentBlockchainID + "/rpc",
+			},
+		},
+		{
+			name:                "empty endpoints list",
+			endpoints:           []string{},
+			currentBlockchainID: currentBlockchainID,
+			expected:            []string{},
+		},
+		{
+			name: "mixed WS and RPC endpoints",
+			endpoints: []string{
+				"ws://127.0.0.1:55067/ext/bc/" + oldBlockchainID + "/ws",
+				"http://127.0.0.1:55067/ext/bc/" + oldBlockchainID + "/rpc",
+				"ws://127.0.0.1:60645/ext/bc/" + currentBlockchainID + "/ws",
+				"http://127.0.0.1:60645/ext/bc/" + currentBlockchainID + "/rpc",
+			},
+			currentBlockchainID: currentBlockchainID,
+			expected: []string{
+				"ws://127.0.0.1:60645/ext/bc/" + currentBlockchainID + "/ws",
+				"http://127.0.0.1:60645/ext/bc/" + currentBlockchainID + "/rpc",
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			require := require.New(t)
+			result := filterOutdatedBlockchainEndpoints(tt.endpoints, tt.currentBlockchainID)
+			require.ElementsMatch(tt.expected, result)
+		})
+	}
+}