feat: trigger name limit

api/config.go

@@ -38,6 +38,7 @@ type Config struct {
  MetricsTTL map[moira.ClusterKey]time.Duration
  Flags FeatureFlags
  Authorization Authorization
+ Limits LimitsConfig
 }
 
 // WebConfig is container for web ui configuration parameters.
@@ -60,3 +61,24 @@ type MetricSourceCluster struct {
 func (WebConfig) Render(w http.ResponseWriter, r *http.Request) error {
  return nil
 }
+
+// LimitsConfig contains limits for some entities.
+type LimitsConfig struct {
+ // Trigger contains limits for triggers.
+ Trigger TriggerLimits
+}
+
+// TriggerLimits contains all limits applied for triggers.
+type TriggerLimits struct {
+ // MaxNameSize is the amount of characters allowed in trigger name.
+ MaxNameSize int
+}
+
+// GetTestLimitsConfig is used for testing.
+func GetTestLimitsConfig() LimitsConfig {
+ return LimitsConfig{
+ Trigger: TriggerLimits{
+ MaxNameSize: 200,
+ },
+ }
+}

api/dto/triggers.go

@@ -7,6 +7,7 @@ import (
  "regexp"
  "strconv"
  "time"
+ "unicode/utf8"
 
  "github.com/moira-alert/moira/templating"
 
@@ -19,8 +20,19 @@ import (
 
 var targetNameRegex = regexp.MustCompile("^t\\d+$")
 
-// ErrBadAloneMetricName is used when any key in map TriggerModel.AloneMetric doesn't match targetNameRegex.
-var ErrBadAloneMetricName = fmt.Errorf("alone metrics' target name must match the pattern: ^t\\d+$, for example: 't1'")
+var (
+ // errBadAloneMetricName is used when any key in map TriggerModel.AloneMetric doesn't match targetNameRegex.
+ errBadAloneMetricName = fmt.Errorf("alone metrics' target name must match the pattern: ^t\\d+$, for example: 't1'")
+
+ // errTargetsRequired is returned when there is no targets in Trigger.
+ errTargetsRequired = fmt.Errorf("targets are required")
+
+ // errTagsRequired is returned when there is no tags in Trigger.
+ errTagsRequired = fmt.Errorf("tags are required")
+
+ // errTriggerNameRequired is returned when there is empty Name in Trigger.
+ errTriggerNameRequired = fmt.Errorf("trigger name is required")
+)
 
 // TODO(litleleprikon): Remove after https:/moira-alert/moira/issues/550 will be resolved.
 var asteriskPattern = "*"
@@ -152,15 +164,22 @@ func CreateTriggerModel(trigger *moira.Trigger) TriggerModel {
 func (trigger *Trigger) Bind(request *http.Request) error {
  trigger.Tags = normalizeTags(trigger.Tags)
  if len(trigger.Targets) == 0 {
- return api.ErrInvalidRequestContent{ValidationError: fmt.Errorf("targets is required")}
+ return api.ErrInvalidRequestContent{ValidationError: errTargetsRequired}
  }
 
  if len(trigger.Tags) == 0 {
- return api.ErrInvalidRequestContent{ValidationError: fmt.Errorf("tags is required")}
+ return api.ErrInvalidRequestContent{ValidationError: errTagsRequired}
  }
 
  if trigger.Name == "" {
- return api.ErrInvalidRequestContent{ValidationError: fmt.Errorf("trigger name is required")}
+ return api.ErrInvalidRequestContent{ValidationError: errTriggerNameRequired}
+ }
+
+ limits := middleware.GetLimits(request)
+ if utf8.RuneCountInString(trigger.Name) > limits.Trigger.MaxNameSize {
+ return api.ErrInvalidRequestContent{
+ ValidationError: fmt.Errorf("trigger name too long, should not be greater than %d symbols", limits.Trigger.MaxNameSize),
+ }
  }
 
  if err := checkWarnErrorExpression(trigger); err != nil {
@@ -173,7 +192,7 @@ func (trigger *Trigger) Bind(request *http.Request) error {
 
  for targetName := range trigger.AloneMetrics {
  if !targetNameRegex.MatchString(targetName) {
- return api.ErrInvalidRequestContent{ValidationError: ErrBadAloneMetricName}
+ return api.ErrInvalidRequestContent{ValidationError: errBadAloneMetricName}
  }
 
  targetIndexStr := targetName[1:]

api/dto/triggers_test.go

@@ -4,6 +4,7 @@ import (
  "context"
  "fmt"
  "net/http"
+ "strings"
  "testing"
  "time"
 
@@ -18,6 +19,52 @@ import (
 )
 
 func TestTriggerValidation(t *testing.T) {
+ Convey("Test trigger name and tags", t, func() {
+ trigger := Trigger{
+ TriggerModel: TriggerModel{},
+ }
+
+ limit := api.GetTestLimitsConfig()
+
+ request, _ := http.NewRequest("PUT", "/api/trigger", nil)
+ request.Header.Set("Content-Type", "application/json")
+ request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "limits", limit))
+
+ Convey("with empty targets", func() {
+ err := trigger.Bind(request)
+
+ So(err, ShouldResemble, api.ErrInvalidRequestContent{ValidationError: errTargetsRequired})
+ })
+
+ trigger.Targets = []string{"foo.bar"}
+
+ Convey("with empty tag in tag list", func() {
+ trigger.Tags = []string{""}
+
+ err := trigger.Bind(request)
+
+ So(err, ShouldResemble, api.ErrInvalidRequestContent{ValidationError: errTagsRequired})
+ })
+
+ trigger.Tags = append(trigger.Tags, "tag1")
+
+ Convey("with empty Name", func() {
+ err := trigger.Bind(request)
+
+ So(err, ShouldResemble, api.ErrInvalidRequestContent{ValidationError: errTriggerNameRequired})
+ })
+
+ Convey("with too long Name", func() {
+ trigger.Name = strings.Repeat("ё", limit.Trigger.MaxNameSize+1)
+
+ err := trigger.Bind(request)
+
+ So(err, ShouldResemble, api.ErrInvalidRequestContent{
+ ValidationError: fmt.Errorf("trigger name too long, should not be greater than %d symbols", limit.Trigger.MaxNameSize),
+ })
+ })
+ })
+
  Convey("Tests targets, values and expression validation", t, func() {
  mockCtrl := gomock.NewController(t)
  defer mockCtrl.Finish()
@@ -31,6 +78,7 @@ func TestTriggerValidation(t *testing.T) {
  request.Header.Set("Content-Type", "application/json")
  ctx := request.Context()
  ctx = context.WithValue(ctx, middleware.ContextKey("metricSourceProvider"), sourceProvider)
+ ctx = context.WithValue(ctx, middleware.ContextKey("limits"), api.GetTestLimitsConfig())
  request = request.WithContext(ctx)
 
  desc := "Graphite ClickHouse"
@@ -203,13 +251,13 @@ func TestTriggerValidation(t *testing.T) {
  trigger.AloneMetrics = map[string]bool{"ttt": true}
  tr := Trigger{trigger, throttling}
  err := tr.Bind(request)
- So(err, ShouldResemble, api.ErrInvalidRequestContent{ValidationError: ErrBadAloneMetricName})
+ So(err, ShouldResemble, api.ErrInvalidRequestContent{ValidationError: errBadAloneMetricName})
  })
  Convey("have more than 1 metric name but only 1 need", func() {
  trigger.AloneMetrics = map[string]bool{"t1 t2": true}
  tr := Trigger{trigger, throttling}
  err := tr.Bind(request)
- So(err, ShouldResemble, api.ErrInvalidRequestContent{ValidationError: ErrBadAloneMetricName})
+ So(err, ShouldResemble, api.ErrInvalidRequestContent{ValidationError: errBadAloneMetricName})
  })
  Convey("have target higher than total amount of targets", func() {
  trigger.AloneMetrics = map[string]bool{"t3": true}

api/handler/handler.go

@@ -43,6 +43,7 @@ func NewHandler(
  router.Use(moiramiddle.UserContext)
  router.Use(moiramiddle.RequestLogger(log))
  router.Use(middleware.NoCache)
+ router.Use(moiramiddle.LimitsContext(apiConfig.Limits))
 
  router.NotFound(notFoundHandler)
  router.MethodNotAllowed(methodNotAllowedHandler)

api/handler/trigger_test.go

@@ -10,6 +10,8 @@ import (
  "testing"
  "time"
 
+ "github.com/moira-alert/moira/api"
+
  "github.com/moira-alert/moira"
  "github.com/moira-alert/moira/api/dto"
  "github.com/moira-alert/moira/api/middleware"
@@ -165,8 +167,8 @@ func TestUpdateTrigger(t *testing.T) {
  testRequest.Header.Add("content-type", "application/json")
  testRequest = testRequest.WithContext(middleware.SetContextValueForTest(testRequest.Context(), "metricSourceProvider", sourceProvider))
  testRequest = testRequest.WithContext(middleware.SetContextValueForTest(testRequest.Context(), "clustersMetricTTL", MakeTestTTLs()))
-
  testRequest = testRequest.WithContext(middleware.SetContextValueForTest(testRequest.Context(), triggerIDKey, triggerID))
+ testRequest = testRequest.WithContext(middleware.SetContextValueForTest(testRequest.Context(), "limits", api.GetTestLimitsConfig()))
 
  responseWriter := httptest.NewRecorder()
  updateTrigger(responseWriter, testRequest)
@@ -208,6 +210,7 @@ func TestUpdateTrigger(t *testing.T) {
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "metricSourceProvider", sourceProvider))
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "clustersMetricTTL", MakeTestTTLs()))
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), triggerIDKey, triggerID))
+ request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "limits", api.GetTestLimitsConfig()))
 
  responseWriter := httptest.NewRecorder()
  updateTrigger(responseWriter, request)
@@ -247,6 +250,7 @@ func TestUpdateTrigger(t *testing.T) {
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "metricSourceProvider", sourceProvider))
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "clustersMetricTTL", MakeTestTTLs()))
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), triggerIDKey, triggerID))
+ request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "limits", api.GetTestLimitsConfig()))
 
  responseWriter := httptest.NewRecorder()
  updateTrigger(responseWriter, request)
@@ -272,6 +276,7 @@ func TestUpdateTrigger(t *testing.T) {
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "metricSourceProvider", sourceProvider))
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "clustersMetricTTL", MakeTestTTLs()))
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), triggerIDKey, triggerID))
+ request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "limits", api.GetTestLimitsConfig()))
 
  responseWriter := httptest.NewRecorder()
  updateTrigger(responseWriter, request)
@@ -335,6 +340,7 @@ func TestUpdateTrigger(t *testing.T) {
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "metricSourceProvider", sourceProvider))
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "clustersMetricTTL", MakeTestTTLs()))
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), triggerIDKey, triggerID))
+ request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "limits", api.GetTestLimitsConfig()))
 
  responseWriter := httptest.NewRecorder()
  updateTrigger(responseWriter, request)
@@ -353,6 +359,7 @@ func TestUpdateTrigger(t *testing.T) {
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "metricSourceProvider", sourceProvider))
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "clustersMetricTTL", MakeTestTTLs()))
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), triggerIDKey, triggerID))
+ request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "limits", api.GetTestLimitsConfig()))
 
  responseWriter := httptest.NewRecorder()
  updateTrigger(responseWriter, request)

api/handler/triggers_test.go

@@ -95,6 +95,7 @@ func TestGetTriggerFromRequest(t *testing.T) {
  request := httptest.NewRequest(http.MethodPut, "/trigger", bytes.NewReader(body))
  request.Header.Add("content-type", "application/json")
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "metricSourceProvider", sourceProvider))
+ request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "limits", api.GetTestLimitsConfig()))
 
  Convey("It should be parsed successfully", func() {
  triggerDTO.TTL = moira.DefaultTTL
@@ -133,6 +134,7 @@ func TestGetTriggerFromRequest(t *testing.T) {
  request := httptest.NewRequest(http.MethodPut, "/trigger", strings.NewReader(body))
  request.Header.Add("content-type", "application/json")
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "metricSourceProvider", sourceProvider))
+ request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "limits", api.GetTestLimitsConfig()))
 
  Convey("Parser should return en error", func() {
  _, err := getTriggerFromRequest(request)
@@ -251,6 +253,7 @@ func TestTriggerCheckHandler(t *testing.T) {
  testRequest.Header.Add("content-type", "application/json")
  testRequest = testRequest.WithContext(middleware.SetContextValueForTest(testRequest.Context(), "metricSourceProvider", sourceProvider))
  testRequest = testRequest.WithContext(middleware.SetContextValueForTest(testRequest.Context(), "clustersMetricTTL", MakeTestTTLs()))
+ testRequest = testRequest.WithContext(middleware.SetContextValueForTest(testRequest.Context(), "limits", api.GetTestLimitsConfig()))
 
  triggerCheck(responseWriter, testRequest)
 
@@ -315,6 +318,7 @@ func TestCreateTriggerHandler(t *testing.T) {
  testRequest.Header.Add("content-type", "application/json")
  testRequest = testRequest.WithContext(middleware.SetContextValueForTest(testRequest.Context(), "metricSourceProvider", sourceProvider))
  testRequest = testRequest.WithContext(middleware.SetContextValueForTest(testRequest.Context(), "clustersMetricTTL", MakeTestTTLs()))
+ testRequest = testRequest.WithContext(middleware.SetContextValueForTest(testRequest.Context(), "limits", api.GetTestLimitsConfig()))
 
  responseWriter := httptest.NewRecorder()
  createTrigger(responseWriter, testRequest)
@@ -352,6 +356,7 @@ func TestCreateTriggerHandler(t *testing.T) {
  request.Header.Add("content-type", "application/json")
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "metricSourceProvider", sourceProvider))
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "clustersMetricTTL", MakeTestTTLs()))
+ request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "limits", api.GetTestLimitsConfig()))
 
  responseWriter := httptest.NewRecorder()
  createTrigger(responseWriter, request)
@@ -390,6 +395,7 @@ func TestCreateTriggerHandler(t *testing.T) {
  request.Header.Add("content-type", "application/json")
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "metricSourceProvider", sourceProvider))
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "clustersMetricTTL", MakeTestTTLs()))
+ request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "limits", api.GetTestLimitsConfig()))
 
  responseWriter := httptest.NewRecorder()
  createTrigger(responseWriter, request)
@@ -413,6 +419,7 @@ func TestCreateTriggerHandler(t *testing.T) {
  request.Header.Add("content-type", "application/json")
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "metricSourceProvider", sourceProvider))
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "clustersMetricTTL", MakeTestTTLs()))
+ request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "limits", api.GetTestLimitsConfig()))
 
  responseWriter := httptest.NewRecorder()
  createTrigger(responseWriter, request)
@@ -475,6 +482,7 @@ func TestCreateTriggerHandler(t *testing.T) {
  request.Header.Add("content-type", "application/json")
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "metricSourceProvider", sourceProvider))
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "clustersMetricTTL", MakeTestTTLs()))
+ request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "limits", api.GetTestLimitsConfig()))
 
  responseWriter := httptest.NewRecorder()
  createTrigger(responseWriter, request)
@@ -492,6 +500,7 @@ func TestCreateTriggerHandler(t *testing.T) {
  request.Header.Add("content-type", "application/json")
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "metricSourceProvider", sourceProvider))
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "clustersMetricTTL", MakeTestTTLs()))
+ request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "limits", api.GetTestLimitsConfig()))
 
  responseWriter := httptest.NewRecorder()
  createTrigger(responseWriter, request)
@@ -711,6 +720,7 @@ func newTriggerCreateRequest(
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "metricSourceProvider", sourceProvider))
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "clustersMetricTTL", MakeTestTTLs()))
  request = request.WithContext(middleware.SetContextValueForTest(request.Context(), triggerIDKey, triggerId))
+ request = request.WithContext(middleware.SetContextValueForTest(request.Context(), "limits", api.GetTestLimitsConfig()))
 
  return request
 }

api/middleware/context.go

@@ -331,3 +331,13 @@ func StatesContext() func(next http.Handler) http.Handler {
  })
  }
 }
+
+// LimitsContext places api.LimitsConfig to request context.
+func LimitsContext(limit api.LimitsConfig) func(next http.Handler) http.Handler {
+ return func(next http.Handler) http.Handler {
+ return http.HandlerFunc(func(writer http.ResponseWriter, request *http.Request) {
+ ctx := context.WithValue(request.Context(), limitsContextKey, limit)
+ next.ServeHTTP(writer, request.WithContext(ctx))
+ })
+ }
+}

api/middleware/middleware.go

@@ -41,6 +41,7 @@ var (
  authKey ContextKey = "auth"
  metricContextKey ContextKey = "metric"
  statesContextKey ContextKey = "states"
+ limitsContextKey ContextKey = "limits"
  anonymousUser = "anonymous"
 )
 
@@ -174,3 +175,8 @@ func GetMetric(request *http.Request) string {
 func GetStates(request *http.Request) map[string]struct{} {
  return request.Context().Value(statesContextKey).(map[string]struct{})
 }
+
+// GetLimits returns configured limits.
+func GetLimits(request *http.Request) api.LimitsConfig {
+ return request.Context().Value(limitsContextKey).(api.LimitsConfig)
+}