Signer info store DB implementation

Signed-off-by: Alexandros Filios <alexandros.filios@ibm.com>

Author: alexandrosfilios

platform/common/driver/kvs.go

@@ -15,10 +15,9 @@ type SignerEntry struct {
 	DebugStack []byte
 }
 
-type SignerStore interface {
-	GetSigner(id view.Identity) (*SignerEntry, error)
+type SignerInfoStore interface {
 	FilterExistingSigners(ids ...view.Identity) ([]view.Identity, error)
-	PutSigner(id view.Identity, entry *SignerEntry) error
+	PutSigner(id view.Identity) error
 }
 
 type AuditInfoStore interface {

platform/common/services/sig/service.go

@@ -32,15 +32,15 @@ type SignerEntry = driver2.SignerEntry
 
 type Service struct {
 	deserializer Deserializer
-	signerKVS    driver2.SignerStore
+	signerKVS    driver2.SignerInfoStore
 	auditInfoKVS driver2.AuditInfoStore
 
 	mutex     sync.RWMutex
 	signers   map[string]SignerEntry
 	verifiers map[string]VerifierEntry
 }
 
-func NewService(deserializer Deserializer, auditInfoKVS driver2.AuditInfoStore, signerKVS driver2.SignerStore) *Service {
+func NewService(deserializer Deserializer, auditInfoKVS driver2.AuditInfoStore, signerKVS driver2.SignerInfoStore) *Service {
 	return &Service{
 		signerKVS:    signerKVS,
 		auditInfoKVS: auditInfoKVS,
@@ -84,7 +84,7 @@ func (o *Service) RegisterSigner(identity view.Identity, signer driver.Signer, v
 	o.mutex.Unlock()
 
 	if o.signerKVS != nil {
-		if err := o.signerKVS.PutSigner(identity, &entry); err != nil {
+		if err := o.signerKVS.PutSigner(identity); err != nil {
 			o.deleteSigner(idHash)
 			return errors.Wrap(err, "failed to store entry in kvs for the passed signer")
 		}

platform/fabric/core/generic/driver/provider.go

@@ -40,7 +40,7 @@ func NewProvider(
 	channelProvider generic.ChannelProvider,
 	idProvider vdriver.IdentityProvider,
 	identityLoaders []identity.NamedIdentityLoader,
-	signerKVS driver.SignerStore,
+	signerKVS driver.SignerInfoStore,
 	auditInfoKVS driver.AuditInfoStore,
 	kvss *kvs.KVS,
 ) *Provider {

platform/fabric/sdk/dig/generic/providers.go

@@ -56,7 +56,7 @@ func NewDriver(in struct {
 	IdProvider      vdriver.IdentityProvider
 	KVS             *kvs.KVS
 	AuditInfoKVS    driver2.AuditInfoStore
-	SignerKVS       driver2.SignerStore
+	SignerKVS       driver2.SignerInfoStore
 	ChannelProvider generic.ChannelProvider        `name:"generic-channel-provider"`
 	IdentityLoaders []identity.NamedIdentityLoader `group:"identity-loaders"`
 }) core.NamedDriver {

platform/view/sdk/dig/providers.go

@@ -0,0 +1,90 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package sdk
+
+import (
+	driver4 "github.com/hyperledger-labs/fabric-smart-client/platform/common/driver"
+	"github.com/hyperledger-labs/fabric-smart-client/platform/common/utils"
+	"github.com/hyperledger-labs/fabric-smart-client/platform/common/utils/collections"
+	"github.com/hyperledger-labs/fabric-smart-client/platform/fabric/driver"
+	driver2 "github.com/hyperledger-labs/fabric-smart-client/platform/view/services/db/driver"
+	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/db/driver/badger"
+	mem "github.com/hyperledger-labs/fabric-smart-client/platform/view/services/db/driver/memory"
+	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/kms"
+	driver3 "github.com/hyperledger-labs/fabric-smart-client/platform/view/services/kms/driver"
+	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/kvs"
+	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/storage/binding"
+	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/storage/signerinfo"
+	"github.com/pkg/errors"
+	"go.uber.org/dig"
+)
+
+func newKVS(in struct {
+	dig.In
+	Config  driver.ConfigService
+	Drivers []driver2.NamedDriver `group:"db-drivers"`
+}) (*kvs.KVS, error) {
+	driverName := utils.DefaultString(in.Config.GetString("fsc.kvs.persistence.type"), string(mem.MemoryPersistence))
+	for _, driver := range in.Drivers {
+		if string(driver.Name) == driverName {
+			return kvs.NewWithConfig(driver.Driver, "_default", in.Config)
+		}
+	}
+	return nil, errors.New("driver not found")
+}
+
+var unsupportedStores = collections.NewSet(badger.FilePersistence, badger.BadgerPersistence)
+
+func newBindingStore(in struct {
+	dig.In
+	KVS     *kvs.KVS
+	Config  driver.ConfigService
+	Drivers []driver2.NamedDriver `group:"db-drivers"`
+}) (driver4.BindingStore, error) {
+	driverName := driver4.PersistenceType(utils.DefaultString(in.Config.GetString("fsc.binding.persistence.type"), string(mem.MemoryPersistence)))
+	if unsupportedStores.Contains(driverName) {
+		return binding.NewKVSBased(in.KVS), nil
+	}
+	for _, d := range in.Drivers {
+		if d.Name == driverName {
+			return binding.NewWithConfig(d.Driver, "_default", in.Config)
+		}
+	}
+	return nil, errors.New("driver not found")
+}
+
+func newSignerInfoStore(in struct {
+	dig.In
+	KVS     *kvs.KVS
+	Config  driver.ConfigService
+	Drivers []driver2.NamedDriver `group:"db-drivers"`
+}) (driver4.SignerInfoStore, error) {
+	driverName := driver4.PersistenceType(utils.DefaultString(in.Config.GetString("fsc.signerinfo.persistence.type"), string(mem.MemoryPersistence)))
+	if unsupportedStores.Contains(driverName) {
+		return signerinfo.NewKVSBased(in.KVS), nil
+	}
+	for _, d := range in.Drivers {
+		if d.Name == driverName {
+			return signerinfo.NewWithConfig(d.Driver, "_default", in.Config)
+		}
+	}
+	return nil, errors.New("driver not found")
+}
+
+func newKMSDriver(in struct {
+	dig.In
+	Config  driver.ConfigService
+	Drivers []driver3.NamedDriver `group:"kms-drivers"`
+}) (*kms.KMS, error) {
+	driverName := utils.DefaultString(in.Config.GetString("fsc.identity.type"), "file")
+	for _, driver := range in.Drivers {
+		if string(driver.Name) == driverName {
+			return &kms.KMS{Driver: driver.Driver}, nil
+		}
+	}
+	return nil, errors.New("driver not found")
+}

platform/view/sdk/dig/sdk.go

@@ -16,7 +16,6 @@ import (
 	dig2 "github.com/hyperledger-labs/fabric-smart-client/platform/common/sdk/dig"
 	"github.com/hyperledger-labs/fabric-smart-client/platform/common/services/logging"
 	sig2 "github.com/hyperledger-labs/fabric-smart-client/platform/common/services/sig"
-	"github.com/hyperledger-labs/fabric-smart-client/platform/common/utils"
 	digutils "github.com/hyperledger-labs/fabric-smart-client/platform/common/utils/dig"
 	"github.com/hyperledger-labs/fabric-smart-client/platform/view"
 	"github.com/hyperledger-labs/fabric-smart-client/platform/view/core/endpoint"
@@ -30,25 +29,20 @@ import (
 	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/comm/host"
 	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/comm/provider"
 	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/crypto"
-	driver2 "github.com/hyperledger-labs/fabric-smart-client/platform/view/services/db/driver"
 	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/db/driver/badger"
 	mem "github.com/hyperledger-labs/fabric-smart-client/platform/view/services/db/driver/memory"
 	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/db/driver/sql"
 	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/events"
 	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/events/simple"
 	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/grpc"
 	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/hash"
-	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/kms"
-	driver3 "github.com/hyperledger-labs/fabric-smart-client/platform/view/services/kms/driver"
 	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/kms/driver/file"
 	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/kvs"
 	metrics2 "github.com/hyperledger-labs/fabric-smart-client/platform/view/services/metrics"
 	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/metrics/operations"
 	view3 "github.com/hyperledger-labs/fabric-smart-client/platform/view/services/server/view"
 	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/server/view/protos"
 	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/storage/auditinfo"
-	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/storage/binding"
-	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/storage/signerinfo"
 	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/tracing"
 	"go.opentelemetry.io/otel/trace"
 	"go.uber.org/dig"
@@ -107,7 +101,7 @@ func (p *SDK) Install() error {
 		p.C.Provide(sig2.NewService, dig.As(new(id.SigService), new(driver.SigService), new(driver.SigRegistry), new(driver.AuditRegistry))),
 		p.C.Provide(view.NewSigService, dig.As(new(view3.VerifierProvider), new(view3.SignerProvider))),
 		p.C.Provide(newBindingStore, dig.As(new(driver4.BindingStore))),
-		p.C.Provide(signerinfo.NewKVSBased, dig.As(new(driver4.SignerStore))),
+		p.C.Provide(newSignerInfoStore, dig.As(new(driver4.SignerInfoStore))),
 		p.C.Provide(auditinfo.NewKVSBased, dig.As(new(driver4.AuditInfoStore))),
 		p.C.Provide(endpoint.NewService),
 		p.C.Provide(digutils.Identity[*endpoint.Service](), dig.As(new(driver.EndpointService))),
@@ -200,45 +194,3 @@ func (p *SDK) Start(ctx context.Context) error {
 		return nil
 	})
 }
-
-func newKVS(in struct {
-	dig.In
-	Config  driver.ConfigService
-	Drivers []driver2.NamedDriver `group:"db-drivers"`
-}) (*kvs.KVS, error) {
-	driverName := utils.DefaultString(in.Config.GetString("fsc.kvs.persistence.type"), string(mem.MemoryPersistence))
-	for _, driver := range in.Drivers {
-		if string(driver.Name) == driverName {
-			return kvs.NewWithConfig(driver.Driver, "_default", in.Config)
-		}
-	}
-	return nil, errors.New("driver not found")
-}
-
-func newBindingStore(in struct {
-	dig.In
-	Config  driver.ConfigService
-	Drivers []driver2.NamedDriver `group:"db-drivers"`
-}) (driver4.BindingStore, error) {
-	driverName := utils.DefaultString(in.Config.GetString("fsc.binding.persistence.type"), string(mem.MemoryPersistence))
-	for _, driver := range in.Drivers {
-		if string(driver.Name) == driverName {
-			return binding.NewWithConfig(driver.Driver, "_default", in.Config)
-		}
-	}
-	return nil, errors.New("driver not found")
-}
-
-func newKMSDriver(in struct {
-	dig.In
-	Config  driver.ConfigService
-	Drivers []driver3.NamedDriver `group:"kms-drivers"`
-}) (*kms.KMS, error) {
-	driverName := utils.DefaultString(in.Config.GetString("fsc.identity.type"), "file")
-	for _, driver := range in.Drivers {
-		if string(driver.Name) == driverName {
-			return &kms.KMS{Driver: driver.Driver}, nil
-		}
-	}
-	return nil, errors.New("driver not found")
-}

platform/view/services/db/driver/badger/driver.go

@@ -68,3 +68,7 @@ func (d *Driver) NewTransactionalUnversioned(dataSourceName string, config drive
 func (d *Driver) NewBinding(string, driver.Config) (driver.BindingPersistence, error) {
 	panic("not implemented")
 }
+
+func (d *Driver) NewSignerInfo(string, driver.Config) (driver.SignerInfoPersistence, error) {
+	panic("not implemented")
+}

platform/view/services/db/driver/driver.go

@@ -47,6 +47,8 @@ type SQLErrorWrapper interface {
 
 type BindingPersistence = driver.BindingStore
 
+type SignerInfoPersistence = driver.SignerInfoStore
+
 type BasePersistence[V any, R any] interface {
 	// SetState sets the given value for the given namespace, key, and version
 	SetState(namespace driver.Namespace, key driver.PKey, value V) error
@@ -150,6 +152,8 @@ type Driver interface {
 	NewTransactionalUnversioned(dataSourceName string, config Config) (TransactionalUnversionedPersistence, error)
 	// NewBinding returns a new BindingPersistence for the passed data source and config
 	NewBinding(dataSourceName string, config Config) (BindingPersistence, error)
+	// NewSignerInfo returns a new SignerInfoPersistence for the passed data source and config
+	NewSignerInfo(string, Config) (SignerInfoPersistence, error)
 }
 
 type (

platform/view/services/db/driver/memory/driver.go

@@ -64,3 +64,7 @@ func (d *Driver) NewUnversioned(string, driver.Config) (driver.UnversionedPersis
 func (d *Driver) NewBinding(string, driver.Config) (driver.BindingPersistence, error) {
 	return sql.NewPersistenceWithOpts(utils.GenerateUUIDOnlyLetters(), opts, sql.BindingConstructors)
 }
+
+func (d *Driver) NewSignerInfo(string, driver.Config) (driver.SignerInfoPersistence, error) {
+	return sql.NewPersistenceWithOpts(utils.GenerateUUIDOnlyLetters(), opts, sql.SignerInfoConstructors)
+}

platform/view/services/db/driver/sql/common/signerinfo.go

@@ -0,0 +1,85 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package common
+
+import (
+	"database/sql"
+	"fmt"
+
+	"github.com/hyperledger-labs/fabric-smart-client/platform/view/services/db/driver"
+	"github.com/hyperledger-labs/fabric-smart-client/platform/view/view"
+	"github.com/pkg/errors"
+)
+
+func NewSignerInfoPersistence(writeDB *sql.DB, readDB *sql.DB, table string, errorWrapper driver.SQLErrorWrapper, ci Interpreter) *SignerInfoPersistence {
+	return &SignerInfoPersistence{
+		table:        table,
+		errorWrapper: errorWrapper,
+		readDB:       readDB,
+		writeDB:      writeDB,
+		ci:           ci,
+	}
+}
+
+type SignerInfoPersistence struct {
+	table        string
+	errorWrapper driver.SQLErrorWrapper
+	readDB       *sql.DB
+	writeDB      *sql.DB
+	ci           Interpreter
+}
+
+func (db *SignerInfoPersistence) FilterExistingSigners(ids ...view.Identity) ([]view.Identity, error) {
+	idHashes := make([]string, len(ids))
+	inverseMap := make(map[string]view.Identity, len(ids))
+	for i, id := range ids {
+		idHash := id.UniqueID()
+		idHashes[i] = idHash
+		inverseMap[idHash] = id
+	}
+	where, params := Where(db.ci.InStrings("id", idHashes))
+	query := fmt.Sprintf("SELECT id FROM %s %s", db.table, where)
+	logger.Debug(query, params)
+
+	rows, err := db.readDB.Query(query, params...)
+	if err != nil {
+		return nil, errors.Wrapf(err, "error querying db")
+	}
+
+	existingSigners := make([]view.Identity, 0)
+	for rows.Next() {
+		var idHash string
+		if err := rows.Scan(&idHash); err != nil {
+			return nil, errors.Wrapf(err, "failed scanning row")
+		}
+		existingSigners = append(existingSigners, inverseMap[idHash])
+	}
+	logger.Debugf("Found %d out of %d signers", len(existingSigners), len(ids))
+	return existingSigners, nil
+}
+
+func (db *SignerInfoPersistence) PutSigner(id view.Identity) error {
+	query := fmt.Sprintf("INSERT INTO %s (id) VALUES ($1)", db.table)
+	logger.Debugf(query, id)
+	_, err := db.writeDB.Exec(query, id.UniqueID())
+	if err != nil && errors.Is(db.errorWrapper.WrapError(err), driver.UniqueKeyViolation) {
+		logger.Warnf("Signer [%s] already in db. Skipping...", id)
+		return nil
+	}
+	if err != nil {
+		return errors.Wrapf(err, "failed executing query [%s]", query)
+	}
+	logger.Debugf("Signer [%s] registered", id)
+	return nil
+}
+
+func (db *SignerInfoPersistence) CreateSchema() error {
+	return InitSchema(db.writeDB, fmt.Sprintf(`
+	CREATE TABLE IF NOT EXISTS %s (
+		id TEXT NOT NULL PRIMARY KEY
+	);`, db.table))
+}