Skip to content

Return no-op instead of SQL error when ObservationLog has no valid entries #2706

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pujitha24 wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Return no-op instead of SQL error when ObservationLog has no valid entries #2706

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
088ac1f
Return no-op instead of SQL error when ObservationLog has no valid en…
pujitha24 Aug 25, 2026
9ad4c57
Add empty-MetricLogs test case and clarify no-op comment
pujitha24 Aug 25, 2026
d12296d
Guard RegisterObservationLog against a nil ObservationLog
pujitha24 Aug 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions pkg/db/v1beta1/mysql/mysql.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@ func NewDBInterface(connectTimeout time.Duration) (common.KatibDBInterface, erro
}

func (d *dbConn) RegisterObservationLog(trialName string, observationLog *v1beta1.ObservationLog) error {
if observationLog == nil {
return nil
}
sqlQuery := "INSERT INTO observation_logs (trial_name, time, metric_name, value) VALUES "
values := []interface{}{}

Expand All @@ -81,6 +84,10 @@ func (d *dbConn) RegisterObservationLog(trialName string, observationLog *v1beta
sqlQuery += "(?, ?, ?, ?),"
values = append(values, trialName, sqlTimeStr, mlog.Metric.Name, mlog.Metric.Value)
}
if len(values) == 0 {
// No valid metric logs to insert, skip Prepare/Exec.
return nil
}
sqlQuery = sqlQuery[0 : len(sqlQuery)-1]

// Prepare the statement
Expand Down
37 changes: 37 additions & 0 deletions pkg/db/v1beta1/mysql/mysql_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,43 @@ func TestRegisterObservationLog(t *testing.T) {

}

func TestRegisterObservationLogNoValidEntries(t *testing.T) {
obsLog := &api_pb.ObservationLog{
MetricLogs: []*api_pb.MetricLog{
{
TimeStamp: "",
Metric: &api_pb.Metric{
Name: "f1_score",
Value: "88.95",
},
},
},
}

err := dbInterface.RegisterObservationLog("test1_trial1", obsLog)
if err != nil {
t.Errorf("RegisterObservationLog failed: %v", err)
}
}

func TestRegisterObservationLogEmptyMetricLogs(t *testing.T) {
obsLog := &api_pb.ObservationLog{
MetricLogs: []*api_pb.MetricLog{},
}

err := dbInterface.RegisterObservationLog("test1_trial1", obsLog)
if err != nil {
t.Errorf("RegisterObservationLog failed: %v", err)
}
}

func TestRegisterObservationLogNilObservationLog(t *testing.T) {
err := dbInterface.RegisterObservationLog("test1_trial1", nil)
if err != nil {
t.Errorf("RegisterObservationLog failed: %v", err)
}
}

func TestGetObservationLog(t *testing.T) {
mock.ExpectQuery("SELECT").WillReturnRows(
sqlmock.NewRows([]string{"time", "metric_name", "value"}).AddRow(
Expand Down
8 changes: 8 additions & 0 deletions pkg/db/v1beta1/postgres/postgres.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,9 @@ func NewDBInterface(connectTimeout time.Duration) (common.KatibDBInterface, erro
}

func (d *dbConn) RegisterObservationLog(trialName string, observationLog *v1beta1.ObservationLog) error {
if observationLog == nil {
return nil
}
statement := "INSERT INTO observation_logs (trial_name, time, metric_name, value) VALUES "
values := []interface{}{}

Expand All @@ -88,6 +91,11 @@ func (d *dbConn) RegisterObservationLog(trialName string, observationLog *v1beta
index_of_qparam += 4
}

if len(values) == 0 {
// No valid metric logs to insert, skip Prepare/Exec.
return nil
}

statement = statement[:len(statement)-1]

// Prepare the statement
Expand Down
37 changes: 37 additions & 0 deletions pkg/db/v1beta1/postgres/postgres_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,43 @@ func TestRegisterObservationLog(t *testing.T) {

}

func TestRegisterObservationLogNoValidEntries(t *testing.T) {
obsLog := &api_pb.ObservationLog{
MetricLogs: []*api_pb.MetricLog{
{
TimeStamp: "",
Metric: &api_pb.Metric{
Name: "f1_score",
Value: "88.95",
},
},
},
}

err := dbInterface.RegisterObservationLog("test1_trial1", obsLog)
if err != nil {
t.Errorf("RegisterObservationLog failed: %v", err)
}
}

func TestRegisterObservationLogEmptyMetricLogs(t *testing.T) {
obsLog := &api_pb.ObservationLog{
MetricLogs: []*api_pb.MetricLog{},
}

err := dbInterface.RegisterObservationLog("test1_trial1", obsLog)
if err != nil {
t.Errorf("RegisterObservationLog failed: %v", err)
}
}

func TestRegisterObservationLogNilObservationLog(t *testing.T) {
err := dbInterface.RegisterObservationLog("test1_trial1", nil)
if err != nil {
t.Errorf("RegisterObservationLog failed: %v", err)
}
}

func TestGetObservationLog(t *testing.T) {
mock.ExpectQuery("SELECT").WillReturnRows(
sqlmock.NewRows([]string{"time", "metric_name", "value"}).AddRow(
Expand Down