-
Notifications
You must be signed in to change notification settings - Fork 18
/
service.go
391 lines (338 loc) · 12.6 KB
/
service.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
package experiment
import (
"context"
"database/sql"
"encoding/base64"
"encoding/json"
"fmt"
"net/url"
"regexp"
"strconv"
"strings"
"time"
"gorm.io/gorm/clause"
"github.com/G-Research/fasttrackml/pkg/api/mlflow/api"
"github.com/G-Research/fasttrackml/pkg/api/mlflow/api/request"
"github.com/G-Research/fasttrackml/pkg/api/mlflow/config"
"github.com/G-Research/fasttrackml/pkg/api/mlflow/dao/convertors"
"github.com/G-Research/fasttrackml/pkg/api/mlflow/dao/models"
"github.com/G-Research/fasttrackml/pkg/api/mlflow/dao/repositories"
"github.com/G-Research/fasttrackml/pkg/database"
)
var (
experimentOrder = regexp.MustCompile(`^(?:attr(?:ibutes?)?\.)?(\w+)(?i:\s+(ASC|DESC))?$`)
filterAnd = regexp.MustCompile(`(?i)\s+AND\s+`)
filterCond = regexp.MustCompile(`^(?:(\w+)\.)?("[^"]+"|` + "`[^`]+`" + `|[\w\.]+)\s+(<|<=|>|>=|=|!=|(?i:I?LIKE)|(?i:(?:NOT )?IN))\s+(\((?:'[^']+'(?:,\s*)?)+\)|"[^"]+"|'[^']+'|[\w\.]+)$`)
)
// Service provides service layer to work with `metric` business logic.
type Service struct {
config *config.ServiceConfig
tagRepository repositories.TagRepositoryProvider
experimentRepository repositories.ExperimentRepositoryProvider
}
// NewService creates new Service instance.
func NewService(
config *config.ServiceConfig,
tagRepository repositories.TagRepositoryProvider,
experimentRepository repositories.ExperimentRepositoryProvider,
) *Service {
return &Service{
config: config,
tagRepository: tagRepository,
experimentRepository: experimentRepository,
}
}
func (s Service) CreateExperiment(
ctx context.Context, req *request.CreateExperimentRequest,
) (*models.Experiment, error) {
if err := ValidateCreateExperimentRequest(req); err != nil {
return nil, err
}
experiment, err := s.experimentRepository.GetByName(ctx, req.Name)
if err != nil {
return nil, api.NewInternalError("error getting experiment with name: '%s', error: %s", req.Name, err)
}
if experiment != nil {
return nil, api.NewResourceAlreadyExistsError("experiment(name=%s) already exists", req.Name)
}
experiment, err = convertors.ConvertCreateExperimentToDBModel(req)
if err != nil {
return nil, api.NewInvalidParameterValueError("Invalid value for parameter 'artifact_location': %s", err)
}
if err := s.experimentRepository.Create(ctx, experiment); err != nil {
return nil, api.NewInternalError("error inserting experiment '%s': %s", req.Name, err)
}
if experiment.ArtifactLocation == "" {
path, err := url.JoinPath(s.config.DefaultArtifactRoot, fmt.Sprintf("%d", *experiment.ID))
if err != nil {
return nil, api.NewInternalError(
"error creating artifact_location for experiment'%s': %s", experiment.Name, err,
)
}
experiment.ArtifactLocation = path
if err := s.experimentRepository.Update(ctx, experiment); err != nil {
return nil, api.NewInternalError(
"error updating artifact_location for experiment '%s': %s", experiment.Name, err,
)
}
}
return experiment, nil
}
func (s Service) UpdateExperiment(ctx context.Context, req *request.UpdateExperimentRequest) error {
if err := ValidateUpdateExperimentRequest(req); err != nil {
return err
}
parsedID, err := strconv.ParseInt(req.ID, 10, 32)
if err != nil {
return api.NewBadRequestError("unable to parse experiment id '%s': %s", req.ID, err)
}
experiment, err := s.experimentRepository.GetByID(ctx, int32(parsedID))
if err != nil {
return api.NewResourceDoesNotExistError("unable to find experiment '%d': %s", parsedID, err)
}
experiment = convertors.ConvertUpdateExperimentToDBModel(experiment, req)
if err := s.experimentRepository.Update(ctx, experiment); err != nil {
return api.NewInternalError("unable to update experiment '%d': %s", *experiment.ID, err)
}
return nil
}
func (s Service) GetExperiment(ctx context.Context, req *request.GetExperimentRequest) (*models.Experiment, error) {
if err := ValidateGetExperimentByIDRequest(req); err != nil {
return nil, err
}
// TODO:DSuhinin not sure about this conversion. Maybe we can just use string everywhere?
parsedID, err := strconv.ParseInt(req.ID, 10, 32)
if err != nil {
return nil, api.NewBadRequestError(`unable to parse experiment id '%s': %s`, req.ID, err)
}
experiment, err := s.experimentRepository.GetByID(ctx, int32(parsedID))
if err != nil {
return nil, api.NewResourceDoesNotExistError(`unable to find experiment '%d': %s`, parsedID, err)
}
return experiment, nil
}
func (s Service) GetExperimentByName(
ctx context.Context, req *request.GetExperimentRequest,
) (*models.Experiment, error) {
if err := ValidateGetExperimentByNameRequest(req); err != nil {
return nil, err
}
experiment, err := s.experimentRepository.GetByName(ctx, req.Name)
if err != nil {
return nil, api.NewInternalError("unable to get experiment by name '%s': %v", req.Name, err)
}
if experiment == nil {
return nil, api.NewResourceDoesNotExistError(`unable to find experiment '%s'`, req.Name)
}
return experiment, nil
}
func (s Service) DeleteExperiment(ctx context.Context, req *request.DeleteExperimentRequest) error {
if err := ValidateDeleteExperimentRequest(req); err != nil {
return err
}
parsedID, err := strconv.ParseInt(req.ID, 10, 32)
if err != nil {
return api.NewBadRequestError("unable to parse experiment id '%s': %s", req.ID, err)
}
experiment, err := s.experimentRepository.GetByID(ctx, int32(parsedID))
if err != nil {
return api.NewResourceDoesNotExistError(`unable to find experiment '%d': %s`, parsedID, err)
}
experiment.LifecycleStage = models.LifecycleStageDeleted
experiment.LastUpdateTime = sql.NullInt64{
Int64: time.Now().UTC().UnixMilli(),
Valid: true,
}
if err := s.experimentRepository.Update(ctx, experiment); err != nil {
return api.NewInternalError("unable to delete experiment '%d': %s", *experiment.ID, err)
}
return nil
}
func (s Service) RestoreExperiment(ctx context.Context, req *request.RestoreExperimentRequest) error {
if err := ValidateRestoreExperimentRequest(req); err != nil {
return err
}
parsedID, err := strconv.ParseInt(req.ID, 10, 32)
if err != nil {
return api.NewBadRequestError("Unable to parse experiment id '%s': %s", req.ID, err)
}
experiment, err := s.experimentRepository.GetByID(ctx, int32(parsedID))
if err != nil {
return api.NewResourceDoesNotExistError(`unable to find experiment '%d': %s`, parsedID, err)
}
experiment.LifecycleStage = models.LifecycleStageActive
experiment.LastUpdateTime = sql.NullInt64{
Int64: time.Now().UTC().UnixMilli(),
Valid: true,
}
if err := s.experimentRepository.Update(ctx, experiment); err != nil {
return api.NewInternalError("Unable to restore experiment '%d': %s", *experiment.ID, err)
}
return nil
}
func (s Service) SetExperimentTag(ctx context.Context, req *request.SetExperimentTagRequest) error {
if err := ValidateSetExperimentTagRequest(req); err != nil {
return err
}
parsedID, err := strconv.ParseInt(req.ID, 10, 32)
if err != nil {
return api.NewBadRequestError("Unable to parse experiment id '%s': %s", req.ID, err)
}
experiment, err := s.experimentRepository.GetByID(ctx, int32(parsedID))
if err != nil {
return api.NewResourceDoesNotExistError(`unable to find experiment '%d': %s`, parsedID, err)
}
experimentTag := convertors.ConvertSetExperimentTagRequestToDBModel(*experiment.ID, req)
if err := s.tagRepository.CreateExperimentTag(ctx, experimentTag); err != nil {
return api.NewInternalError("Unable to set tag for experiment '%d': %s", *experiment.ID, err)
}
return nil
}
func (s Service) SearchExperiments(
ctx context.Context, req *request.SearchExperimentsRequest,
) ([]models.Experiment, int, int, error) {
if err := ValidateSearchExperimentsRequest(req); err != nil {
return nil, 0, 0, err
}
// ViewType
var lifecyleStages []database.LifecycleStage
switch req.ViewType {
case request.ViewTypeActiveOnly, "":
lifecyleStages = []database.LifecycleStage{
database.LifecycleStageActive,
}
case request.ViewTypeDeletedOnly:
lifecyleStages = []database.LifecycleStage{
database.LifecycleStageDeleted,
}
case request.ViewTypeAll:
lifecyleStages = []database.LifecycleStage{
database.LifecycleStageActive,
database.LifecycleStageDeleted,
}
}
tx := database.DB.Where("lifecycle_stage IN ?", lifecyleStages)
// MaxResults
limit := int(req.MaxResults)
if limit == 0 {
limit = 1000
}
tx.Limit(limit + 1)
// PageToken
var offset int
if req.PageToken != "" {
var token request.PageToken
if err := json.NewDecoder(
base64.NewDecoder(
base64.StdEncoding,
strings.NewReader(req.PageToken),
),
).Decode(&token); err != nil {
return nil, 0, 0, api.NewInvalidParameterValueError("invalid page_token '%s': %s", req.PageToken, err)
}
offset = int(token.Offset)
}
tx.Offset(offset)
// Filter
if req.Filter != "" {
for n, f := range filterAnd.Split(req.Filter, -1) {
components := filterCond.FindStringSubmatch(f)
if len(components) != 5 {
return nil, 0, 0, api.NewInvalidParameterValueError("malformed filter '%s'", f)
}
entity := components[1]
key := strings.Trim(components[2], "\"`")
comparison := components[3]
var value any = components[4]
switch entity {
case "", "attribute", "attributes", "attr":
switch key {
case "creation_time", "last_update_time":
switch comparison {
case ">", ">=", "!=", "=", "<", "<=":
v, err := strconv.Atoi(value.(string))
if err != nil {
return nil, 0, 0, api.NewInvalidParameterValueError("invalid numeric value '%s'", value)
}
value = v
default:
return nil, 0, 0, api.NewInvalidParameterValueError("invalid numeric attribute comparison operator '%s'", comparison)
}
case "name":
switch strings.ToUpper(comparison) {
case "!=", "=", "LIKE", "ILIKE":
if strings.HasPrefix(value.(string), "(") {
return nil, 0, 0, api.NewInvalidParameterValueError("invalid string value '%s'", value)
}
value = strings.Trim(value.(string), `"'`)
if database.DB.Dialector.Name() == "sqlite" && strings.ToUpper(comparison) == "ILIKE" {
key = fmt.Sprintf("LOWER(%s)", key)
comparison = "LIKE"
value = strings.ToLower(value.(string))
}
default:
return nil, 0, 0, api.NewInvalidParameterValueError("invalid string attribute comparison operator '%s'", comparison)
}
default:
return nil, 0, 0, api.NewInvalidParameterValueError("invalid attribute '%s'. Valid values are ['name', 'creation_time', 'last_update_time']", key)
}
tx.Where(fmt.Sprintf("%s %s ?", key, comparison), value)
case "tag", "tags":
switch strings.ToUpper(comparison) {
case "!=", "=", "LIKE", "ILIKE":
if strings.HasPrefix(value.(string), "(") {
return nil, 0, 0, api.NewInvalidParameterValueError("invalid string value '%s'", value)
}
value = strings.Trim(value.(string), `"'`)
default:
return nil, 0, 0, api.NewInvalidParameterValueError("invalid tag comparison operator '%s'", comparison)
}
table := fmt.Sprintf("filter_%d", n)
where := fmt.Sprintf("value %s ?", comparison)
if database.DB.Dialector.Name() == "sqlite" && strings.ToUpper(comparison) == "ILIKE" {
where = "LOWER(value) LIKE ?"
value = strings.ToLower(value.(string))
}
tx.Joins(
fmt.Sprintf("JOIN (?) AS %s ON experiments.experiment_id = %s.experiment_id", table, table),
database.DB.Select("experiment_id", "value").Where("key = ?", key).Where(where, value).Model(&database.ExperimentTag{}),
)
default:
return nil, 0, 0, api.NewInvalidParameterValueError("invalid entity type '%s'. Valid values are ['tag', 'attribute']", entity)
}
}
}
// OrderBy
expOrder := false
for _, o := range req.OrderBy {
components := experimentOrder.FindStringSubmatch(o)
if len(components) == 0 {
return nil, 0, 0, api.NewInvalidParameterValueError("invalid order_by clause '%s'", o)
}
column := components[1]
switch column {
case "experiment_id":
expOrder = true
fallthrough
case "name", "creation_time", "last_update_time":
default:
return nil, 0, 0, api.NewInvalidParameterValueError("invalid attribute '%s'. Valid values are ['name', 'experiment_id', 'creation_time', 'last_update_time']", column)
}
tx.Order(clause.OrderByColumn{
Column: clause.Column{Name: column},
Desc: len(components) == 3 && strings.ToUpper(components[2]) == "DESC",
})
}
if len(req.OrderBy) == 0 {
tx.Order("experiments.creation_time DESC")
}
if !expOrder {
tx.Order("experiments.experiment_id ASC")
}
// Actual query
var exps []models.Experiment
if tx.Preload("Tags").Find(&exps).Error != nil {
return nil, 0, 0, api.NewInternalError("unable to search runs: %s", tx.Error)
}
return exps, limit, offset, nil
}