feat: add configuration allowing scm-engine to ignore specific users activity when calculating inactivity on a MR/PR

Author: jippi

cmd/shared.go

@@ -28,6 +28,9 @@ func getClient(ctx context.Context) (scm.Client, error) {
 }
 
 func ProcessMR(ctx context.Context, client scm.Client, cfg *config.Config, event any) (err error) {
+	// Write the config to context so we can pull it out later
+	ctx = config.WithConfig(ctx, cfg)
+
 	// Stop the pipeline when we leave this func
 	defer func() {
 		if stopErr := client.Stop(ctx, err); stopErr != nil {
@@ -61,6 +64,9 @@ func ProcessMR(ctx context.Context, client scm.Client, cfg *config.Config, event
 	}
 
 	evalContext.SetWebhookEvent(event)
+	// Add our "ctx" to evalContext so Expr-Lang functions can reference them
+	// when they need to read our "cfg"
+	evalContext.SetContext(ctx)
 
 	slogctx.Info(ctx, "Evaluating context")
 

docs/configuration.md

@@ -4,6 +4,30 @@ The default configuration filename is `.scm-engine.yml`, either in current worki
 
 The file path can be changed via `--config` CLI flag and `#!css $SCM_ENGINE_CONFIG_FILE` environment variable.
 
+## `ignore_activity_from` {#actions data-toc-label="ignore_activity_from"}
+
+!!! question "What are activity?"
+
+  SCM-Engine defines activity as comments, reviews, commits, adding/removing labels and similar.
+
+  *Generally*, `activity` is what you see in the Merge/Pull Request `timeline` in the browser UI.
+
+Configure what users that should be ignored when considering activity on a Merge Request
+
+### `ignore_activity_from.bots` {#actions data-toc-label="bots"}
+
+Should `bot` users be ignored when considering activity? Default: `false`
+
+### `ignore_activity_from.usernames[]` {#actions data-toc-label="usernames"}
+
+A list of usernames that should be ignored when considering user activity. Default: `[]`
+
+### `ignore_activity_from.emails[]` {#actions data-toc-label="emails"}
+
+A list of emails that should be ignored when considering user activity. Default: `[]`
+
+**NOTE:** If a user do not have a public email configured on their profile, that users activity will never match this rule.
+
 ## `actions[]` {#actions data-toc-label="actions"}
 
 !!! question "What are actions?"

pkg/config/action.go

@@ -2,6 +2,7 @@ package config
 
 import (
 	"github.com/expr-lang/expr"
+	"github.com/expr-lang/expr/patcher"
 	"github.com/expr-lang/expr/vm"
 	"github.com/jippi/scm-engine/pkg/scm"
 	"github.com/jippi/scm-engine/pkg/stdlib"
@@ -47,6 +48,7 @@ func (p *Action) initialize(evalContext scm.EvalContext) (*vm.Program, error) {
 	opts = append(opts, expr.Env(evalContext))
 	opts = append(opts, stdlib.FunctionRenamer)
 	opts = append(opts, stdlib.Functions...)
+	opts = append(opts, expr.Patch(patcher.WithContext{Name: "ctx"}))
 
 	return expr.Compile(p.If, opts...)
 }

pkg/config/config.go

@@ -9,14 +9,15 @@ import (
 )
 
 type Config struct {
-	Labels  Labels  `yaml:"label"`
-	Actions Actions `yaml:"actions"`
+	Labels             Labels             `yaml:"label"`
+	Actions            Actions            `yaml:"actions"`
+	IgnoreActivityFrom IgnoreActivityFrom `yaml:"ignore_activity_from"`
 }
 
 func (c Config) Evaluate(ctx context.Context, evalContext scm.EvalContext) ([]scm.EvaluationResult, []Action, error) {
 	slogctx.Info(ctx, "Evaluating labels")
 
-	labels, err := c.Labels.Evaluate(evalContext)
+	labels, err := c.Labels.Evaluate(ctx, evalContext)
 	if err != nil {
 		return nil, nil, fmt.Errorf("evaluation failed: %w", err)
 	}

pkg/config/context.go

@@ -0,0 +1,19 @@
+package config
+
+import (
+	"context"
+)
+
+type contextKey uint
+
+const (
+	configKey contextKey = iota
+)
+
+func WithConfig(ctx context.Context, config *Config) context.Context {
+	return context.WithValue(ctx, configKey, config)
+}
+
+func FromContext(ctx context.Context) *Config {
+	return ctx.Value(configKey).(*Config) //nolint:forcetypeassert
+}

pkg/config/ignore_activity_from.go

@@ -0,0 +1,42 @@
+package config
+
+type ActorMatcher struct {
+	Username string
+	Email    *string
+	IsBot    bool
+}
+
+type IgnoreActivityFrom struct {
+	IsBot     bool     `yaml:"bots"`
+	Usernames []string `yaml:"usernames"`
+	Emails    []string `yaml:"emails"`
+}
+
+func (i IgnoreActivityFrom) Matches(actor ActorMatcher) bool {
+	// If actor is bot and we ignore bot activity
+	if actor.IsBot && i.IsBot {
+		return true
+	}
+
+	// Check if the actor username is in the ignore list
+	for _, username := range i.Usernames {
+		if username == actor.Username {
+			return true
+		}
+	}
+
+	// If the actor don't have an email, we did not find a match, since
+	// our last check is on emails
+	if actor.Email == nil {
+		return false
+	}
+
+	// Check if the actor email matches any of the ignored ones
+	for _, email := range i.Emails {
+		if email == *actor.Email {
+			return true
+		}
+	}
+
+	return false
+}

pkg/config/label.go

@@ -1,11 +1,13 @@
 package config
 
 import (
+	"context"
 	"errors"
 	"fmt"
 	"reflect"
 
 	"github.com/expr-lang/expr"
+	"github.com/expr-lang/expr/patcher"
 	"github.com/expr-lang/expr/vm"
 	"github.com/jippi/scm-engine/pkg/scm"
 	"github.com/jippi/scm-engine/pkg/stdlib"
@@ -23,7 +25,7 @@ const (
 
 type Labels []*Label
 
-func (labels Labels) Evaluate(evalContext scm.EvalContext) ([]scm.EvaluationResult, error) {
+func (labels Labels) Evaluate(ctx context.Context, evalContext scm.EvalContext) ([]scm.EvaluationResult, error) {
 	var results []scm.EvaluationResult
 
 	// Evaluate labels
@@ -155,6 +157,7 @@ func (p *Label) initialize(evalContext scm.EvalContext) error {
 		opts = append(opts, expr.Env(evalContext))
 		opts = append(opts, stdlib.FunctionRenamer)
 		opts = append(opts, stdlib.Functions...)
+		opts = append(opts, expr.Patch(patcher.WithContext{Name: "ctx"}))
 
 		p.scriptCompiled, err = expr.Compile(p.Script, opts...)
 		if err != nil {
@@ -170,6 +173,7 @@ func (p *Label) initialize(evalContext scm.EvalContext) error {
 		opts = append(opts, expr.Env(evalContext))
 		opts = append(opts, stdlib.FunctionRenamer)
 		opts = append(opts, stdlib.Functions...)
+		opts = append(opts, expr.Patch(patcher.WithContext{Name: "ctx"}))
 
 		p.skipIfCompiled, err = expr.Compile(p.SkipIf, opts...)
 		if err != nil {

pkg/scm/github/context.go

@@ -85,6 +85,10 @@ func (c *Context) SetWebhookEvent(in any) {
 	c.WebhookEvent = in
 }
 
+func (c *Context) SetContext(ctx context.Context) {
+	c.Context = ctx
+}
+
 func (c *Context) GetDescription() string {
 	return c.PullRequest.Body
 }

pkg/scm/gitlab/client_actioner.go

@@ -9,6 +9,7 @@ import (
 	"strings"
 
 	"github.com/expr-lang/expr"
+	"github.com/expr-lang/expr/patcher"
 	"github.com/jippi/scm-engine/pkg/scm"
 	"github.com/jippi/scm-engine/pkg/state"
 	"github.com/jippi/scm-engine/pkg/stdlib"
@@ -64,6 +65,7 @@ func (c *Client) ApplyStep(ctx context.Context, evalContext scm.EvalContext, upd
 			opts = append(opts, expr.Env(evalContext))
 			opts = append(opts, stdlib.FunctionRenamer)
 			opts = append(opts, stdlib.Functions...)
+			opts = append(opts, expr.Patch(patcher.WithContext{Name: "ctx"}))
 
 			program, err := expr.Compile(fmt.Sprintf("%s", script), opts...)
 			if err != nil {

pkg/scm/gitlab/context.go

@@ -94,6 +94,10 @@ func (c *Context) SetWebhookEvent(in any) {
 	c.WebhookEvent = in
 }
 
+func (c *Context) SetContext(ctx context.Context) {
+	c.Context = ctx
+}
+
 func (c *Context) GetDescription() string {
 	if c.MergeRequest.Description == nil {
 		return ""

pkg/scm/gitlab/context_merge_request.go

@@ -1,9 +1,11 @@
 package gitlab
 
 import (
+	"context"
 	"fmt"
 	"time"
 
+	"github.com/jippi/scm-engine/pkg/config"
 	"github.com/jippi/scm-engine/pkg/scm"
 	"github.com/jippi/scm-engine/pkg/stdlib"
 )
@@ -51,48 +53,51 @@ func (e ContextMergeRequest) StateIsNot(anyOf ...string) bool {
 }
 
 // has_no_activity_within
-func (e ContextMergeRequest) HasNoActivityWithin(input any) bool {
-	return !e.HasAnyActivityWithin(input)
+func (e ContextMergeRequest) HasNoActivityWithin(ctx context.Context, input any) bool {
+	return !e.HasAnyActivityWithin(ctx, input)
 }
 
 // has_any_activity_within
-func (e ContextMergeRequest) HasAnyActivityWithin(input any) bool {
+func (e ContextMergeRequest) HasAnyActivityWithin(ctx context.Context, input any) bool {
 	dur := stdlib.ToDuration(input)
 	now := time.Now()
+	cfg := config.FromContext(ctx)
 
 	for _, note := range e.Notes {
-		if now.Sub(note.UpdatedAt) < dur {
-			return true
+		// Check if we should ignore the actor (user) activity
+		if cfg.IgnoreActivityFrom.Matches(note.Author.ToActorMatcher()) {
+			continue
 		}
-	}
 
-	if e.LastCommit != nil {
-		if now.Sub(*e.LastCommit.CommittedDate) < dur {
+		// Check is within the configured duration
+		if now.Sub(note.UpdatedAt) < dur {
 			return true
 		}
 	}
 
-	return false
+	// If we have a recent commit, check if its within the duration
+	return e.LastCommit != nil && now.Sub(*e.LastCommit.CommittedDate) < dur
 }
 
 // has_no_user_activity_within
-func (e ContextMergeRequest) HasNoUserActivityWithin(input any) bool {
-	return !e.HasUserActivityWithin(input)
+func (e ContextMergeRequest) HasNoUserActivityWithin(ctx context.Context, input any) bool {
+	return !e.HasUserActivityWithin(ctx, input)
 }
 
 // has_user_activity_within
-func (e ContextMergeRequest) HasUserActivityWithin(input any) bool {
+func (e ContextMergeRequest) HasUserActivityWithin(ctx context.Context, input any) bool {
 	dur := stdlib.ToDuration(input)
 	now := time.Now()
+	cfg := config.FromContext(ctx)
 
 	for _, note := range e.Notes {
-		// Ignore "my" activity
-		if e.CurrentUser.Username == note.Author.Username {
+		// Check if we should ignore the actor (user) activity
+		if cfg.IgnoreActivityFrom.Matches(note.Author.ToActorMatcher()) {
 			continue
 		}
 
-		// Ignore bots
-		if e.Author.Bot {
+		// Ignore "scm-engine" activity since we shouldn't consider ourself a user
+		if e.CurrentUser.Username == note.Author.Username {
 			continue
 		}
 
@@ -101,13 +106,8 @@ func (e ContextMergeRequest) HasUserActivityWithin(input any) bool {
 		}
 	}
 
-	if e.LastCommit != nil {
-		if now.Sub(*e.LastCommit.CommittedDate) < dur {
-			return true
-		}
-	}
-
-	return false
+	// If we have a recent commit, check if its within the duration
+	return e.LastCommit != nil && now.Sub(*e.LastCommit.CommittedDate) < dur
 }
 
 func (e ContextMergeRequest) ModifiedFilesList(patterns ...string) []string {

pkg/scm/gitlab/context_user.go

@@ -0,0 +1,11 @@
+package gitlab
+
+import "github.com/jippi/scm-engine/pkg/config"
+
+func (u ContextUser) ToActorMatcher() config.ActorMatcher {
+	return config.ActorMatcher{
+		Username: u.Username,
+		IsBot:    u.Bot,
+		Email:    u.PublicEmail,
+	}
+}

pkg/scm/interfaces.go

@@ -29,6 +29,7 @@ type MergeRequestClient interface {
 type EvalContext interface {
 	IsValid() bool
 	SetWebhookEvent(in any)
+	SetContext(ctx context.Context)
 	GetDescription() string
 }
 

schema/gitlab.schema.graphqls

@@ -16,12 +16,15 @@ directive @expr(key: String!) on INPUT_FIELD_DEFINITION | FIELD_DEFINITION
 directive @graphql(key: String!) on INPUT_FIELD_DEFINITION | FIELD_DEFINITION
 
 # Add time.Time support
+# See: https://gqlgen.com/reference/scalars/#time
 scalar Time
 
 # Add time.Duration support
+# See: https://gqlgen.com/reference/scalars/#duration
 scalar Duration
 
 # Add 'any' type for Event
+# See: https://gqlgen.com/reference/scalars/#any
 scalar Any
 
 type Context {

schema/main.go

@@ -6,6 +6,7 @@ import (
 	"cmp"
 	_ "embed"
 	"fmt"
+	"go/types"
 	"os"
 	"os/exec"
 	"path/filepath"
@@ -244,6 +245,17 @@ func mutateHook(b *modelgen.ModelBuild) *modelgen.ModelBuild {
 			field.Tag = tags.String()
 		} // end fields loop
 
+		// Manually inject certain "expr env" fields that we can't reasonable create in graphql schema
+		if model.Name == "Context" {
+			model.Fields = append(model.Fields, &modelgen.Field{
+				Name:        "Context",
+				Description: "Go context used to pass around configuration (do not use directly!)",
+				GoName:      "Context",
+				Type:        types.NewNamed(types.NewTypeName(0, types.NewPackage("context", "context"), "Context", nil), nil, nil),
+				Tag:         `expr:"ctx" graphql:"-"`,
+			})
+		}
+
 		if strings.HasSuffix(model.Name, "Node") || model.Name == "Query" {
 			continue
 		}