Support database queries on arbitrary labels

pkg/cache/sql/db/client.go

@@ -228,7 +228,7 @@ func (c *Client) ReadInt(rows Rows) (int, error) {
 // If forWriting is true, this method blocks until all other concurrent forWriting
 // transactions have either committed or rolled back.
 // If forWriting is false, it is assumed the returned transaction will exclusively
-// be used for DQL (eg. SELECT) queries.
+// be used for DQL (e.g. SELECT) queries.
 // Not respecting the above rule might result in transactions failing with unexpected
 // SQLITE_BUSY (5) errors (aka "Runtime error: database is locked").
 // See discussion in https://github.com/rancher/lasso/pull/98 for details

pkg/cache/sql/db/transaction/transaction.go

@@ -7,6 +7,7 @@ package transaction
 import (
 	"context"
 	"database/sql"
+	"github.com/sirupsen/logrus"
 
 	"github.com/pkg/errors"
 )
@@ -64,6 +65,7 @@ func (c *Client) Stmt(stmt *sql.Stmt) Stmt {
 func (c *Client) StmtExec(stmt Stmt, args ...any) error {
 	_, err := stmt.Exec(args...)
 	if err != nil {
+		logrus.Debugf("StmtExec failed: query %s, args: %s, err: %s", stmt, args, err)
 		return c.rollback(c.sqlTx, err)
 	}
 	return nil

pkg/cache/sql/informer/factory/informer_factory.go

@@ -68,6 +68,7 @@ var defaultEncryptedResourceTypes = map[schema.GroupVersionKind]struct{}{
 }
 
 // NewCacheFactory returns an informer factory instance
+// This is currently called from steve via initial calls to `s.cacheFactory.CacheFor(...)`
 func NewCacheFactory() (*CacheFactory, error) {
 	m, err := encryption.NewManager()
 	if err != nil {

pkg/cache/sql/informer/indexer.go

@@ -89,12 +89,13 @@ func NewIndexer(indexers cache.Indexers, s Store) (*Indexer, error) {
 	if err != nil {
 		return nil, err
 	}
-	createTableQuery := fmt.Sprintf(createTableFmt, db.Sanitize(s.GetName()))
+	dbName := db.Sanitize(s.GetName())
+	createTableQuery := fmt.Sprintf(createTableFmt, dbName)
 	err = tx.Exec(createTableQuery)
 	if err != nil {
 		return nil, &db.QueryError{QueryString: createTableQuery, Err: err}
 	}
-	createIndexQuery := fmt.Sprintf(createIndexFmt, db.Sanitize(s.GetName()))
+	createIndexQuery := fmt.Sprintf(createIndexFmt, dbName)
 	err = tx.Exec(createIndexQuery)
 	if err != nil {
 		return nil, &db.QueryError{QueryString: createIndexQuery, Err: err}
@@ -135,7 +136,7 @@ func (i *Indexer) AfterUpsert(key string, obj any, tx db.TXClient) error {
 		return &db.QueryError{QueryString: i.deleteIndicesQuery, Err: err}
 	}
 
-	// re-insert all
+	// re-insert all values
 	i.indexersLock.RLock()
 	defer i.indexersLock.RUnlock()
 	for indexName, indexFunc := range i.indexers {
@@ -181,7 +182,7 @@ func (i *Indexer) Index(indexName string, obj any) ([]any, error) {
 
 	// atypical case - more than one value to lookup
 	// HACK: sql.Statement.Query does not allow to pass slices in as of go 1.19 - create an ad-hoc statement
-	query := fmt.Sprintf(fmt.Sprintf(selectQueryFmt, db.Sanitize(i.GetName()), strings.Repeat(", ?", len(values)-1)))
+	query := fmt.Sprintf(selectQueryFmt, db.Sanitize(i.GetName()), strings.Repeat(", ?", len(values)-1))
 	stmt := i.Prepare(query)
 	defer i.CloseStmt(stmt)
 	// HACK: Query will accept []any but not []string

pkg/cache/sql/informer/informer.go

@@ -29,7 +29,7 @@ type ByOptionsLister interface {
 	ListByOptions(ctx context.Context, lo ListOptions, partitions []partition.Partition, namespace string) (*unstructured.UnstructuredList, int, string, error)
 }
 
-// this is set to a var so that it can be overriden by test code for mocking purposes
+// this is set to a var so that it can be overridden by test code for mocking purposes
 var newInformer = cache.NewSharedIndexInformer
 
 // NewInformer returns a new SQLite-backed Informer for the type specified by schema in unstructured.Unstructured form

pkg/cache/sql/informer/informer_test.go

@@ -41,25 +41,27 @@ func TestNewInformer(t *testing.T) {
 		// NewStore() from store package logic. This package is only concerned with whether it returns err or not as NewStore
 		// is tested in depth in its own package.
 		dbClient.EXPECT().BeginTx(gomock.Any(), true).Return(txClient, nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
 		txClient.EXPECT().Commit().Return(nil)
 		dbClient.EXPECT().Prepare(gomock.Any()).Return(&sql.Stmt{}).AnyTimes()
 
 		// NewIndexer() logic (within NewListOptionIndexer(). This test is only concerned with whether it returns err or not as NewIndexer
 		// is tested in depth in its own indexer_test.go
 		dbClient.EXPECT().BeginTx(gomock.Any(), true).Return(txClient, nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
 		txClient.EXPECT().Commit().Return(nil)
 
 		// NewListOptionIndexer() logic. This test is only concerned with whether it returns err or not as NewIndexer
 		// is tested in depth in its own indexer_test.go
 		dbClient.EXPECT().BeginTx(context.Background(), true).Return(txClient, nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
 		txClient.EXPECT().Commit().Return(nil)
 
 		informer, err := NewInformer(dynamicClient, fields, nil, gvk, dbClient, false, true)
@@ -78,7 +80,7 @@ func TestNewInformer(t *testing.T) {
 		// NewStore() from store package logic. This package is only concerned with whether it returns err or not as NewStore
 		// is tested in depth in its own package.
 		dbClient.EXPECT().BeginTx(gomock.Any(), true).Return(txClient, nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
 		txClient.EXPECT().Commit().Return(fmt.Errorf("error"))
 
 		_, err := NewInformer(dynamicClient, fields, nil, gvk, dbClient, false, true)
@@ -95,15 +97,15 @@ func TestNewInformer(t *testing.T) {
 		// NewStore() from store package logic. This package is only concerned with whether it returns err or not as NewStore
 		// is tested in depth in its own package.
 		dbClient.EXPECT().BeginTx(gomock.Any(), true).Return(txClient, nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
 		txClient.EXPECT().Commit().Return(nil)
 		dbClient.EXPECT().Prepare(gomock.Any()).Return(&sql.Stmt{}).AnyTimes()
 
 		// NewIndexer() logic (within NewListOptionIndexer(). This test is only concerned with whether it returns err or not as NewIndexer
 		// is tested in depth in its own indexer_test.go
 		dbClient.EXPECT().BeginTx(gomock.Any(), true).Return(txClient, nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
 		txClient.EXPECT().Commit().Return(fmt.Errorf("error"))
 
 		_, err := NewInformer(dynamicClient, fields, nil, gvk, dbClient, false, true)
@@ -120,25 +122,27 @@ func TestNewInformer(t *testing.T) {
 		// NewStore() from store package logic. This package is only concerned with whether it returns err or not as NewStore
 		// is tested in depth in its own package.
 		dbClient.EXPECT().BeginTx(gomock.Any(), true).Return(txClient, nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
 		txClient.EXPECT().Commit().Return(nil)
 		dbClient.EXPECT().Prepare(gomock.Any()).Return(&sql.Stmt{}).AnyTimes()
 
 		// NewIndexer() logic (within NewListOptionIndexer(). This test is only concerned with whether it returns err or not as NewIndexer
 		// is tested in depth in its own indexer_test.go
 		dbClient.EXPECT().BeginTx(gomock.Any(), true).Return(txClient, nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
 		txClient.EXPECT().Commit().Return(nil)
 
 		// NewListOptionIndexer() logic. This test is only concerned with whether it returns err or not as NewIndexer
 		// is tested in depth in its own indexer_test.go
 		dbClient.EXPECT().BeginTx(gomock.Any(), true).Return(txClient, nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
 		txClient.EXPECT().Commit().Return(fmt.Errorf("error"))
 
 		_, err := NewInformer(dynamicClient, fields, nil, gvk, dbClient, false, true)
@@ -163,25 +167,27 @@ func TestNewInformer(t *testing.T) {
 		// NewStore() from store package logic. This package is only concerned with whether it returns err or not as NewStore
 		// is tested in depth in its own package.
 		dbClient.EXPECT().BeginTx(gomock.Any(), true).Return(txClient, nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
 		txClient.EXPECT().Commit().Return(nil)
 		dbClient.EXPECT().Prepare(gomock.Any()).Return(&sql.Stmt{}).AnyTimes()
 
 		// NewIndexer() logic (within NewListOptionIndexer(). This test is only concerned with whether it returns err or not as NewIndexer
 		// is tested in depth in its own indexer_test.go
 		dbClient.EXPECT().BeginTx(gomock.Any(), true).Return(txClient, nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
 		txClient.EXPECT().Commit().Return(nil)
 
 		// NewListOptionIndexer() logic. This test is only concerned with whether it returns err or not as NewIndexer
 		// is tested in depth in its own indexer_test.go
 		dbClient.EXPECT().BeginTx(gomock.Any(), true).Return(txClient, nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
-		txClient.EXPECT().Exec(gomock.Any(), gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
+		txClient.EXPECT().Exec(gomock.Any()).Return(nil)
 		txClient.EXPECT().Commit().Return(nil)
 
 		transformFunc := func(input interface{}) (interface{}, error) {