mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-30 14:56:19 +00:00
Rodrigo ZhouandGitHub
fb6f584830
## What changed? <!-- Describe what has changed in this PR --> Validate ListSchedulesRequest query field. It's only allowed to filter on custom search attributes and `TemporalSchedulePaused`. ## Why? <!-- Tell your future self why have you made these changes --> Schedules is implemented as workflow at this moment, but we don't want to expose all the system search attributes available since the implmenetion might change, and those system search attributes might not exist anymore for the schedule. ## How did you test it? <!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> Added unit tests. ## Potential risks <!-- Assuming the worst case, what can be broken when deploying this change to production? --> ## Documentation <!-- Have you made sure this change doesn't falsify anything currently stated in `docs/`? If significant new behavior is added, have you described that in `docs/`? --> ## Is hotfix candidate? <!-- Is this PR a hotfix candidate or does it require a notification to be sent to the broader community? (Yes/No) --> No.
84 lines
2.7 KiB
Go
84 lines
2.7 KiB
Go
// The MIT License
|
|
//
|
|
// Copyright (c) 2024 Temporal Technologies Inc. All rights reserved.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
|
|
package scheduler
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
|
|
"go.temporal.io/api/serviceerror"
|
|
"golang.org/x/exp/maps"
|
|
|
|
"go.temporal.io/server/common/persistence/visibility/store/elasticsearch"
|
|
"go.temporal.io/server/common/persistence/visibility/store/query"
|
|
"go.temporal.io/server/common/searchattribute"
|
|
)
|
|
|
|
type (
|
|
fieldNameAggInterceptor struct {
|
|
names map[string]bool
|
|
}
|
|
)
|
|
|
|
var _ query.FieldNameInterceptor = (*fieldNameAggInterceptor)(nil)
|
|
|
|
func (i *fieldNameAggInterceptor) Name(name string, _ query.FieldNameUsage) (string, error) {
|
|
i.names[name] = true
|
|
return name, nil
|
|
}
|
|
|
|
func newFieldNameAggInterceptor() *fieldNameAggInterceptor {
|
|
return &fieldNameAggInterceptor{
|
|
names: make(map[string]bool),
|
|
}
|
|
}
|
|
|
|
func ValidateVisibilityQuery(queryString string) error {
|
|
fields, err := getQueryFields(queryString)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
for _, field := range fields {
|
|
if searchattribute.IsReserved(field) && field != searchattribute.TemporalSchedulePaused {
|
|
return serviceerror.NewInvalidArgument(
|
|
fmt.Sprintf("invalid query filter for schedules: cannot filter on %q", field),
|
|
)
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func getQueryFields(queryString string) ([]string, error) {
|
|
fnInterceptor := newFieldNameAggInterceptor()
|
|
queryConverter := elasticsearch.NewQueryConverter(fnInterceptor, nil)
|
|
_, err := queryConverter.ConvertWhereOrderBy(queryString)
|
|
if err != nil {
|
|
var converterErr *query.ConverterError
|
|
if errors.As(err, &converterErr) {
|
|
return nil, converterErr.ToInvalidArgument()
|
|
}
|
|
return nil, err
|
|
}
|
|
return maps.Keys(fnInterceptor.names), nil
|
|
}
|