feat: Get/Put/Delete tags on searches (#9934)

Co-authored-by: Jesse Amano <jesse.amano@hpe.com>

master/internal/api_experiment.go

@@ -3025,8 +3025,7 @@ func (a *apiServer) DeleteExperimentLabel(ctx context.Context,
  ModelTableExpr("experiments as e").
  Model(exp).
  Apply(getExperimentColumns).
- Where("e.id = ?", req.ExperimentId).
- For("UPDATE")
+ Where("e.id = ?", req.ExperimentId)
  if err = query.Scan(ctx); err != nil {
  return nil, err
  }

master/internal/api_search.go

@@ -13,6 +13,7 @@ import (
  "github.com/determined-ai/determined/master/internal/rm"
  "github.com/determined-ai/determined/master/internal/sproto"
  "github.com/determined-ai/determined/master/pkg/model"
+ "github.com/determined-ai/determined/proto/pkg/apiv1"
  "github.com/determined-ai/determined/proto/pkg/apiv2"
  "github.com/determined-ai/determined/proto/pkg/experimentv1"
  "github.com/determined-ai/determined/proto/pkg/jobv1"
@@ -118,3 +119,53 @@ func (a *apiServer) GetSearch(
 
  return &resp, nil
 }
+
+func (a *apiServer) GetSearchTags(
+ ctx context.Context, req *apiv2.GetSearchTagsRequest,
+) (*apiv2.GetSearchTagsResponse, error) {
+ expReq := apiv1.GetExperimentLabelsRequest{
+ ProjectId: req.ProjectId,
+ }
+ expRes, err := a.GetExperimentLabels(ctx, &expReq)
+ if err != nil {
+ return nil, err
+ }
+ res := apiv2.GetSearchTagsResponse{
+ Tags: expRes.Labels,
+ }
+ return &res, nil
+}
+
+func (a *apiServer) PutSearchTag(
+ ctx context.Context, req *apiv2.PutSearchTagRequest,
+) (*apiv2.PutSearchTagResponse, error) {
+ expReq := apiv1.PutExperimentLabelRequest{
+ ExperimentId: req.SearchId,
+ Label: req.Tag,
+ }
+ expRes, err := a.PutExperimentLabel(ctx, &expReq)
+ if err != nil {
+ return nil, err
+ }
+ res := apiv2.PutSearchTagResponse{
+ Tags: expRes.Labels,
+ }
+ return &res, nil
+}
+
+func (a *apiServer) DeleteSearchTag(
+ ctx context.Context, req *apiv2.DeleteSearchTagRequest,
+) (*apiv2.DeleteSearchTagResponse, error) {
+ expReq := apiv1.DeleteExperimentLabelRequest{
+ ExperimentId: req.SearchId,
+ Label: req.Tag,
+ }
+ expRes, err := a.DeleteExperimentLabel(ctx, &expReq)
+ if err != nil {
+ return nil, err
+ }
+ res := apiv2.DeleteSearchTagResponse{
+ Tags: expRes.Labels,
+ }
+ return &res, nil
+}

master/internal/api_search_intg_test.go

@@ -6,11 +6,15 @@ package internal
 import (
  "encoding/json"
  "testing"
+ "time"
 
+ "github.com/google/uuid"
  "github.com/stretchr/testify/require"
  "google.golang.org/protobuf/types/known/structpb"
 
  "github.com/determined-ai/determined/master/internal/db"
+ "github.com/determined-ai/determined/master/pkg/model"
+ "github.com/determined-ai/determined/master/pkg/schemas"
  "github.com/determined-ai/determined/proto/pkg/apiv2"
 )
 
@@ -41,3 +45,68 @@ func TestGetSearchConfig(t *testing.T) {
  })
  }
 }
+
+func TestGetPutDeleteSearchTags(t *testing.T) {
+ api, curUser, ctx := setupAPITest(t, nil)
+ _, projectIDInt := createProjectAndWorkspace(ctx, t, api)
+ projectID := int32(projectIDInt)
+
+ activeConfig := schemas.WithDefaults(minExpConfig)
+ exp := &model.Experiment{
+ JobID: model.JobID(uuid.New().String()),
+ State: model.CompletedState,
+ OwnerID: &curUser.ID,
+ ProjectID: projectIDInt,
+ StartTime: time.Now(),
+ Config: activeConfig.AsLegacy(),
+ }
+ require.NoError(t, api.m.db.AddExperiment(exp, []byte{10, 11, 12}, activeConfig))
+
+ // Runs are required for delete tags to work
+ task := &model.Task{TaskType: model.TaskTypeTrial, TaskID: model.NewTaskID()}
+ require.NoError(t, db.AddTask(ctx, task))
+ require.NoError(t, db.AddTrial(ctx, &model.Trial{
+ State: model.PausedState,
+ ExperimentID: exp.ID,
+ StartTime: time.Now(),
+ }, task.TaskID))
+
+ // No tags initially
+ getResp, err := api.GetSearchTags(ctx, &apiv2.GetSearchTagsRequest{
+ ProjectId: projectID,
+ })
+ require.NoError(t, err)
+ require.Empty(t, getResp.Tags)
+
+ // Put new tag
+ testTag := "testTag"
+ putResp, err := api.PutSearchTag(ctx, &apiv2.PutSearchTagRequest{
+ SearchId: int32(exp.ID),
+ Tag: testTag,
+ })
+ require.NoError(t, err)
+ require.Len(t, putResp.Tags, 1)
+ require.Equal(t, putResp.Tags[0], testTag)
+
+ // Tags should be present
+ getResp, err = api.GetSearchTags(ctx, &apiv2.GetSearchTagsRequest{
+ ProjectId: projectID,
+ })
+ require.NoError(t, err)
+ require.Len(t, getResp.Tags, 1)
+
+ // Delete tag
+ deleteResp, err := api.DeleteSearchTag(ctx, &apiv2.DeleteSearchTagRequest{
+ SearchId: int32(exp.ID),
+ Tag: testTag,
+ })
+ require.NoError(t, err)
+ require.Empty(t, deleteResp.Tags)
+
+ // No more tags in project
+ getResp, err = api.GetSearchTags(ctx, &apiv2.GetSearchTagsRequest{
+ ProjectId: projectID,
+ })
+ require.NoError(t, err)
+ require.Empty(t, getResp.Tags)
+}