feat(entities) Adds speculation tree store interface and mysql implementation

Author: manjari25

extension/storage/BUILD.bazel

@@ -8,6 +8,7 @@ go_library(
         "build_store.go",
         "change_provider_store.go",
         "request_store.go",
+        "speculation_tree_store.go",
         "storage.go",
     ],
     importpath = "github.com/uber/submitqueue/extension/storage",

extension/storage/mysql/BUILD.bazel

@@ -8,6 +8,7 @@ go_library(
         "build_store.go",
         "change_provider_store.go",
         "request_store.go",
+        "speculation_tree_store.go",
         "storage.go",
     ],
     importpath = "github.com/uber/submitqueue/extension/storage/mysql",

extension/storage/mysql/speculation_tree_store.go

@@ -0,0 +1,96 @@
+package mysql
+
+import (
+	"context"
+	"database/sql"
+	"encoding/json"
+	"errors"
+	"fmt"
+
+	"github.com/go-sql-driver/mysql"
+
+	"github.com/uber/submitqueue/entity"
+	"github.com/uber/submitqueue/extension/storage"
+)
+
+type speculationTreeStore struct {
+	db *sql.DB
+}
+
+// NewSpeculationTreeStore creates a new MySQL-backed SpeculationTreeStore.
+func NewSpeculationTreeStore(db *sql.DB) storage.SpeculationTreeStore {
+	return &speculationTreeStore{db: db}
+}
+
+// Get retrieves the speculation tree by batch ID. Returns ErrNotFound if the speculation tree is not found.
+func (s *speculationTreeStore) Get(ctx context.Context, batchID string) (entity.SpeculationTree, error) {
+	var st entity.SpeculationTree
+	var speculationsJSON []byte
+
+	err := s.db.QueryRowContext(ctx,
+		"SELECT batch_id, queue, speculations FROM speculation_tree WHERE batch_id = ?",
+		batchID,
+	).Scan(&st.BatchID, &st.Queue, &speculationsJSON)
+
+	if errors.Is(err, sql.ErrNoRows) {
+		return entity.SpeculationTree{}, storage.WrapNotFound(err)
+	}
+	if err != nil {
+		return entity.SpeculationTree{}, fmt.Errorf("failed to get speculation tree entity batchID=%s from the database: %w", batchID, err)
+	}
+
+	if err := json.Unmarshal(speculationsJSON, &st.Speculations); err != nil {
+		return entity.SpeculationTree{}, fmt.Errorf("failed to unmarshal speculations for speculation tree entity batchID=%s from the database: %w", batchID, err)
+	}
+
+	return st, nil
+}
+
+// Create creates a new speculation tree. Returns ErrAlreadyExists if the entry already exists.
+func (s *speculationTreeStore) Create(ctx context.Context, speculationTree entity.SpeculationTree) error {
+	speculationsJSON, err := json.Marshal(speculationTree.Speculations)
+	if err != nil {
+		return fmt.Errorf("failed to marshal speculations batchID=%s for Create speculation tree entity: %w", speculationTree.BatchID, err)
+	}
+
+	_, err = s.db.ExecContext(ctx,
+		"INSERT INTO speculation_tree (batch_id, queue, speculations) VALUES (?, ?, ?)",
+		speculationTree.BatchID, speculationTree.Queue, speculationsJSON,
+	)
+	if err != nil {
+		var mysqlErr *mysql.MySQLError
+		if errors.As(err, &mysqlErr) && mysqlErr.Number == 1062 {
+			return fmt.Errorf("speculation tree entity batchID=%s: %w", speculationTree.BatchID, storage.ErrAlreadyExists)
+		}
+		return fmt.Errorf("failed to insert speculation tree entity batchID=%s: %w", speculationTree.BatchID, err)
+	}
+
+	return nil
+}
+
+// UpdateSpeculations updates the speculations of a speculation tree. Returns ErrNotFound if the speculation tree is not found.
+func (s *speculationTreeStore) UpdateSpeculations(ctx context.Context, batchID string, speculations []map[string]string) error {
+	speculationsJSON, err := json.Marshal(speculations)
+	if err != nil {
+		return fmt.Errorf("failed to marshal speculations batchID=%s for UpdateSpeculations: %w", batchID, err)
+	}
+
+	result, err := s.db.ExecContext(ctx,
+		"UPDATE speculation_tree SET speculations = ? WHERE batch_id = ?",
+		speculationsJSON, batchID,
+	)
+	if err != nil {
+		return fmt.Errorf("failed to update speculations for batchID=%q: %w", batchID, err)
+	}
+
+	rowsAffected, err := result.RowsAffected()
+	if err != nil {
+		return fmt.Errorf("failed to get rows affected from update for batchID=%q: %w", batchID, err)
+	}
+
+	if rowsAffected != 1 {
+		return storage.WrapNotFound(fmt.Errorf("speculation tree entity batchID=%s", batchID))
+	}
+
+	return nil
+}

extension/storage/mysql/storage.go

@@ -15,6 +15,7 @@ type mysqlStorage struct {
 	batchStore            storage.BatchStore
 	batchDependentStore   storage.BatchDependentStore
 	buildStore            storage.BuildStore
+	speculationTreeStore  storage.SpeculationTreeStore
 }
 
 // NewStorage creates a new MySQL storage.
@@ -26,6 +27,7 @@ func NewStorage(db *sql.DB) (storage.Storage, error) {
 		batchStore:            NewBatchStore(db),
 		batchDependentStore:   NewBatchDependentStore(db),
 		buildStore:            NewBuildStore(db),
+		speculationTreeStore:  NewSpeculationTreeStore(db),
 	}, nil
 }
 
@@ -54,6 +56,11 @@ func (f *mysqlStorage) GetBuildStore() storage.BuildStore {
 	return f.buildStore
 }
 
+// GetSpeculationTreeStore returns the MySQL-backed SpeculationTreeStore.
+func (f *mysqlStorage) GetSpeculationTreeStore() storage.SpeculationTreeStore {
+	return f.speculationTreeStore
+}
+
 // Close closes the underlying database connection.
 func (f *mysqlStorage) Close() error {
 	return f.db.Close()

extension/storage/speculation_tree_store.go

@@ -0,0 +1,22 @@
+package storage
+
+import (
+	"context"
+
+	"github.com/uber/submitqueue/entity"
+)
+
+// SpeculationTreeStore is an interface that defines methods for managing speculation trees in the database.
+type SpeculationTreeStore interface {
+	// Get retrieves the speculation tree by batch ID.
+	// Returns ErrNotFound if the speculation tree is not found.
+	Get(ctx context.Context, batchID string) (entity.SpeculationTree, error)
+
+	// Create creates a new speculation tree.
+	// Returns ErrAlreadyExists if the entry already exists.
+	Create(ctx context.Context, speculationTree entity.SpeculationTree) error
+
+	// UpdateSpeculations updates the speculations of a speculation tree.
+	// Returns ErrNotFound if the speculation tree is not found.
+	UpdateSpeculations(ctx context.Context, batchID string, speculations []map[string]string) error
+}

extension/storage/storage.go

@@ -41,6 +41,9 @@ type Storage interface {
 	// GetBuildStore returns the BuildStore instance.
 	GetBuildStore() BuildStore
 
+	// GetSpeculationTreeStore returns the SpeculationTreeStore instance.
+	GetSpeculationTreeStore() SpeculationTreeStore
+
 	// Close closes the storage and all underlying connections. Should only be called once at the end of the program.
 	Close() error
 }

gateway/controller/land_test.go

@@ -124,12 +124,40 @@ func (m *mockBuildStore) UpdateStatus(ctx context.Context, id string, newStatus
 	return nil
 }
 
+type mockSpeculationTreeStore struct {
+	createFunc            func(ctx context.Context, speculationTree entity.SpeculationTree) error
+	getFunc               func(ctx context.Context, batchID string) (entity.SpeculationTree, error)
+	updateSpeculationsFunc func(ctx context.Context, batchID string, speculations []map[string]string) error
+}
+
+func (m *mockSpeculationTreeStore) Get(ctx context.Context, batchID string) (entity.SpeculationTree, error) {
+	if m.getFunc != nil {
+		return m.getFunc(ctx, batchID)
+	}
+	return entity.SpeculationTree{}, nil
+}
+
+func (m *mockSpeculationTreeStore) Create(ctx context.Context, speculationTree entity.SpeculationTree) error {
+	if m.createFunc != nil {
+		return m.createFunc(ctx, speculationTree)
+	}
+	return nil
+}
+
+func (m *mockSpeculationTreeStore) UpdateSpeculations(ctx context.Context, batchID string, speculations []map[string]string) error {
+	if m.updateSpeculationsFunc != nil {
+		return m.updateSpeculationsFunc(ctx, batchID, speculations)
+	}
+	return nil
+}
+
 type mockStorage struct {
 	requestStore          storage.RequestStore
 	changeProviderStore   storage.ChangeProviderStore
 	batchStore            storage.BatchStore
 	batchDependentStore   storage.BatchDependentStore
 	buildStore            storage.BuildStore
+	speculationTreeStore  storage.SpeculationTreeStore
 }
 
 func (m *mockStorage) GetRequestStore() storage.RequestStore {
@@ -152,6 +180,10 @@ func (m *mockStorage) GetBuildStore() storage.BuildStore {
 	return m.buildStore
 }
 
+func (m *mockStorage) GetSpeculationTreeStore() storage.SpeculationTreeStore {
+	return m.speculationTreeStore
+}
+
 func (m *mockStorage) Close() error {
 	return nil
 }