dynamic reconfig utils

config/config.go

@@ -792,3 +792,26 @@ func (config *Configuration) CheckIfAssemblerNodeExistsInSharedConfig() error {
 	}
 	return fmt.Errorf("partyID %d is not present in the shared configuration's party list", localPartyID)
 }
+
+// BuildNewConfiguration builds a new configuration based on current configuration and block
+func (config *Configuration) BuildNewConfiguration(block *common.Block) (*Configuration, error) {
+	if config == nil {
+		return nil, errors.New("failed applying new config, current configuration is nil")
+	}
+
+	newConfig := &Configuration{
+		LocalConfig:  config.LocalConfig,
+		SharedConfig: &protos.SharedConfig{},
+	}
+
+	consensusMetadata, err := ReadConsensusMetadataFromConfigBlock(block)
+	if err != nil {
+		return nil, errors.Wrapf(err, "failed applying new config, failed to read consensusMetadata from last config block, block number is %d", block.Header.Number)
+	}
+
+	err = proto.Unmarshal(consensusMetadata, newConfig.SharedConfig)
+	if err != nil {
+		return nil, errors.Wrapf(err, "failed applying new config, failed to unmarshal consensusMetadata to a shared configuration")
+	}
+	return newConfig, nil
+}

config/reconfig.go

@@ -0,0 +1,90 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package config
+
+import (
+	"bytes"
+	"errors"
+	"net"
+	"strconv"
+
+	"github.com/hyperledger/fabric-x-orderer/common/types"
+	config_protos "github.com/hyperledger/fabric-x-orderer/config/protos"
+)
+
+type NodeConfig interface {
+	GetHost() string
+	GetPort() uint32
+	GetTlsCert() []byte
+}
+
+type NodeConfigWithSign interface {
+	NodeConfig
+	GetSignCert() []byte
+}
+
+// IsPartyEvicted returns true if the given party does not appear in the provided configuration.
+func IsPartyEvicted(partyID types.PartyID, newConfig *Configuration) (bool, error) {
+	newSharedPartyConfig, err := FindParty(partyID, newConfig)
+	if err != nil {
+		return false, err
+	}
+	return newSharedPartyConfig == nil, nil
+}
+
+// FindParty returns the PartyConfig associated with the given partyID from the shared configuration.
+// It returns nil if the party is not found and returns error if the provided configuration is nil or incomplete.
+func FindParty(partyID types.PartyID, config *Configuration) (*config_protos.PartyConfig, error) {
+	if config == nil {
+		return nil, errors.New("the provided configuration is nil")
+	}
+	if config.SharedConfig == nil {
+		return nil, errors.New("the provided configuration has nil shared config")
+	}
+	for _, party := range config.SharedConfig.PartiesConfig {
+		if types.PartyID(party.PartyID) == partyID {
+			return party, nil
+		}
+	}
+	return nil, nil
+}
+
+// IsNodeConfigChangeRestartRequired reports whether a restart is required due to configuration updates.
+// A restart is required if any of the following parts were updated:
+//   - host or port
+//   - TLS certificate
+//   - sign certificate (this is checked if both configs implement NodeConfigWithSign)
+//
+// Both arguments must represent the same node type and be non-nil.
+func IsNodeConfigChangeRestartRequired(currentConfig, newConfig NodeConfig) (bool, error) {
+	if currentConfig == nil {
+		return false, errors.New("current config is nil")
+	}
+
+	if newConfig == nil {
+		return false, errors.New("new config is nil")
+	}
+
+	extendedCurrConfig, currOK := currentConfig.(NodeConfigWithSign)
+	extendedNewConfig, newOK := newConfig.(NodeConfigWithSign)
+	if currOK != newOK {
+		return false, errors.New("type mismatch: current node config and new node config are not from the same type")
+	}
+
+	currAddr := net.JoinHostPort(currentConfig.GetHost(), strconv.Itoa(int(currentConfig.GetPort())))
+	newAddr := net.JoinHostPort(newConfig.GetHost(), strconv.Itoa(int(newConfig.GetPort())))
+
+	if currAddr != newAddr || !bytes.Equal(currentConfig.GetTlsCert(), newConfig.GetTlsCert()) {
+		return true, nil
+	}
+
+	if currOK && !bytes.Equal(extendedCurrConfig.GetSignCert(), extendedNewConfig.GetSignCert()) {
+		return true, nil
+	}
+
+	return false, nil
+}

config/reconfig_test.go

@@ -0,0 +1,96 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package config_test
+
+import (
+	"testing"
+
+	"github.com/hyperledger/fabric-x-orderer/config"
+
+	"github.com/hyperledger/fabric-x-orderer/common/types"
+	"github.com/hyperledger/fabric-x-orderer/config/protos"
+	"github.com/stretchr/testify/require"
+)
+
+func TestIsPartyEvicted(t *testing.T) {
+	partyID := types.PartyID(1)
+	partyConfig := &protos.PartyConfig{
+		PartyID: 2,
+	}
+	conf := &config.Configuration{
+		SharedConfig: &protos.SharedConfig{
+			PartiesConfig: []*protos.PartyConfig{partyConfig},
+			MaxPartyID:    1,
+		},
+	}
+
+	isPartyEvicted, err := config.IsPartyEvicted(partyID, conf)
+	require.NoError(t, err)
+	require.True(t, isPartyEvicted)
+	partyID = types.PartyID(2)
+	isPartyEvicted, err = config.IsPartyEvicted(partyID, conf)
+	require.NoError(t, err)
+	require.False(t, isPartyEvicted)
+}
+
+func TestIsNodeConfigChangeRestartRequired(t *testing.T) {
+	// Test Router
+	currRouterConfig := &protos.RouterNodeConfig{
+		Host:    "127.0.0.1",
+		Port:    5060,
+		TlsCert: []byte("cert"),
+	}
+
+	newRouterConfig := &protos.RouterNodeConfig{
+		Host:    "127.0.0.1",
+		Port:    5060,
+		TlsCert: []byte("cert"),
+	}
+
+	isRestartRequired, err := config.IsNodeConfigChangeRestartRequired(currRouterConfig, newRouterConfig)
+	require.NoError(t, err)
+	require.False(t, isRestartRequired)
+
+	newRouterConfig.Port = 5070
+
+	isRestartRequired, err = config.IsNodeConfigChangeRestartRequired(currRouterConfig, newRouterConfig)
+	require.NoError(t, err)
+	require.True(t, isRestartRequired)
+
+	newRouterConfig.Port = 5060
+	newRouterConfig.TlsCert = []byte("TLSCert")
+
+	isRestartRequired, err = config.IsNodeConfigChangeRestartRequired(currRouterConfig, newRouterConfig)
+	require.NoError(t, err)
+	require.True(t, isRestartRequired)
+
+	// Test Batcher
+	currBatcherConfig := &protos.BatcherNodeConfig{
+		ShardID:  1,
+		Host:     "127.0.0.1",
+		Port:     5060,
+		SignCert: []byte("SignCert"),
+		TlsCert:  []byte("TLSCert"),
+	}
+
+	newBatcherConfig := &protos.BatcherNodeConfig{
+		ShardID:  1,
+		Host:     "127.0.0.1",
+		Port:     5060,
+		SignCert: []byte("SignCert"),
+		TlsCert:  []byte("TLSCert"),
+	}
+
+	isRestartRequired, err = config.IsNodeConfigChangeRestartRequired(currBatcherConfig, newBatcherConfig)
+	require.NoError(t, err)
+	require.False(t, isRestartRequired)
+
+	newBatcherConfig.SignCert = []byte("NewSignCert")
+	isRestartRequired, err = config.IsNodeConfigChangeRestartRequired(currBatcherConfig, newBatcherConfig)
+	require.NoError(t, err)
+	require.True(t, isRestartRequired)
+}