Output filtering

internal/analytics/noop_reporter.go

@@ -25,7 +25,7 @@ func (n NoopReporter) RegisterCurrentIdentity(_ context.Context, _ kubernetes.In
 }
 
 // ReportCommand reports a new executed command. The command should be anonymized before using this method.
-func (n NoopReporter) ReportCommand(_ config.CommPlatformIntegration, _ string, _ command.Origin) error {
+func (n NoopReporter) ReportCommand(_ config.CommPlatformIntegration, _ string, _ command.Origin, _ bool) error {
 	return nil
 }
 

internal/analytics/reporter.go

@@ -15,7 +15,7 @@ type Reporter interface {
 	RegisterCurrentIdentity(ctx context.Context, k8sCli kubernetes.Interface) error
 
 	// ReportCommand reports a new executed command. The command should be anonymized before using this method.
-	ReportCommand(platform config.CommPlatformIntegration, command string, origin command.Origin) error
+	ReportCommand(platform config.CommPlatformIntegration, command string, origin command.Origin, withFilter bool) error
 
 	// ReportBotEnabled reports an enabled bot.
 	ReportBotEnabled(platform config.CommPlatformIntegration) error

internal/analytics/segment_reporter.go

@@ -60,11 +60,12 @@ func (r *SegmentReporter) RegisterCurrentIdentity(ctx context.Context, k8sCli ku
 
 // ReportCommand reports a new executed command. The command should be anonymized before using this method.
 // The RegisterCurrentIdentity needs to be called first.
-func (r *SegmentReporter) ReportCommand(platform config.CommPlatformIntegration, command string, origin command.Origin) error {
+func (r *SegmentReporter) ReportCommand(platform config.CommPlatformIntegration, command string, origin command.Origin, withFilter bool) error {
 	return r.reportEvent("Command executed", map[string]interface{}{
 		"platform": platform,
 		"command":  command,
 		"origin":   origin,
+		"filtered": withFilter,
 	})
 }
 

internal/analytics/segment_reporter_test.go

@@ -66,13 +66,13 @@ func TestSegmentReporter_ReportCommand(t *testing.T) {
 	segmentReporter, segmentCli := fakeSegmentReporterWithIdentity(identity)
 
 	// when
-	err := segmentReporter.ReportCommand(config.DiscordCommPlatformIntegration, "notifier stop", command.TypedOrigin)
+	err := segmentReporter.ReportCommand(config.DiscordCommPlatformIntegration, "notifier stop", command.TypedOrigin, false)
 	require.NoError(t, err)
 
-	err = segmentReporter.ReportCommand(config.SlackCommPlatformIntegration, "get", command.ButtonClickOrigin)
+	err = segmentReporter.ReportCommand(config.SlackCommPlatformIntegration, "get", command.ButtonClickOrigin, false)
 	require.NoError(t, err)
 
-	err = segmentReporter.ReportCommand(config.TeamsCommPlatformIntegration, "notifier start", command.SelectValueChangeOrigin)
+	err = segmentReporter.ReportCommand(config.TeamsCommPlatformIntegration, "notifier start", command.SelectValueChangeOrigin, false)
 	require.NoError(t, err)
 
 	// then

internal/analytics/testdata/TestSegmentReporter_ReportCommand.json

@@ -7,6 +7,7 @@
 		"timestamp": "2009-11-17T20:34:58.651387237Z",
 		"properties": {
 			"command": "notifier stop",
+			"filtered": false,
 			"origin": "typed",
 			"platform": "discord"
 		}
@@ -19,6 +20,7 @@
 		"timestamp": "2009-11-17T20:34:58.651387237Z",
 		"properties": {
 			"command": "get",
+			"filtered": false,
 			"origin": "buttonClick",
 			"platform": "slack"
 		}
@@ -31,6 +33,7 @@
 		"timestamp": "2009-11-17T20:34:58.651387237Z",
 		"properties": {
 			"command": "notifier start",
+			"filtered": false,
 			"origin": "selectValueChange",
 			"platform": "teams"
 		}

pkg/bot/discord.go

@@ -103,7 +103,7 @@ func (b *Discord) Start(ctx context.Context) error {
 		msg := discordMessage{
 			Event: m,
 		}
-		if err := b.handleMessage(msg); err != nil {
+		if err := b.handleMessage(ctx, msg); err != nil {
 			b.log.Errorf("Message handling error: %s", err.Error())
 		}
 	})
@@ -227,7 +227,7 @@ func (b *Discord) SetNotificationsEnabled(channelID string, enabled bool) error
 }
 
 // HandleMessage handles the incoming messages.
-func (b *Discord) handleMessage(dm discordMessage) error {
+func (b *Discord) handleMessage(ctx context.Context, dm discordMessage) error {
 	// Handle message only if starts with mention
 	req, found := b.findAndTrimBotMention(dm.Event.Content)
 	if !found {
@@ -252,7 +252,7 @@ func (b *Discord) handleMessage(dm discordMessage) error {
 		User:    fmt.Sprintf("<@%s>", dm.Event.Author.ID),
 	})
 
-	response := e.Execute()
+	response := e.Execute(ctx)
 	err := b.send(dm.Event, req, response)
 	if err != nil {
 		return fmt.Errorf("while sending message: %w", err)

pkg/bot/mattermost.go

@@ -207,7 +207,7 @@ func (b *Mattermost) SetNotificationsEnabled(channelID string, enabled bool) err
 }
 
 // Check incoming message and take action
-func (mm *mattermostMessage) handleMessage(b *Mattermost) {
+func (mm *mattermostMessage) handleMessage(ctx context.Context, b *Mattermost) {
 	post, err := postFromEvent(mm.Event)
 	if err != nil {
 		b.log.Error(err)
@@ -239,7 +239,7 @@ func (mm *mattermostMessage) handleMessage(b *Mattermost) {
 		},
 		Message: mm.Request,
 	})
-	response := e.Execute()
+	response := e.Execute(ctx)
 	mm.sendMessage(b, response)
 }
 
@@ -364,7 +364,7 @@ func (b *Mattermost) listen(ctx context.Context) {
 				IsAuthChannel:   false,
 				APIClient:       b.apiClient,
 			}
-			mm.handleMessage(b)
+			mm.handleMessage(ctx, b)
 		}
 	}
 }

pkg/bot/slack.go

@@ -145,7 +145,7 @@ func (b *Slack) Start(ctx context.Context) error {
 					ThreadTimeStamp: ev.ThreadTimestamp,
 					User:            ev.User,
 				}
-				err := b.handleMessage(sm)
+				err := b.handleMessage(ctx, sm)
 				if err != nil {
 					wrappedErr := fmt.Errorf("while handling message: %w", err)
 					b.log.Errorf(wrappedErr.Error())
@@ -215,7 +215,7 @@ func (b *Slack) SetNotificationsEnabled(channelName string, enabled bool) error
 	return nil
 }
 
-func (b *Slack) handleMessage(msg slackMessage) error {
+func (b *Slack) handleMessage(ctx context.Context, msg slackMessage) error {
 	// Handle message only if starts with mention
 	request, found := b.findAndTrimBotMention(msg.Text)
 	if !found {
@@ -248,7 +248,7 @@ func (b *Slack) handleMessage(msg slackMessage) error {
 		Message: request,
 		User:    fmt.Sprintf("<@%s>", msg.User),
 	})
-	response := e.Execute()
+	response := e.Execute(ctx)
 	err = b.send(msg, request, response, response.OnlyVisibleForYou)
 	if err != nil {
 		return fmt.Errorf("while sending message: %w", err)

pkg/bot/socketslack.go

@@ -68,7 +68,7 @@ type socketSlackMessage struct {
 // socketSlackAnalyticsReporter defines a reporter that collects analytics data.
 type socketSlackAnalyticsReporter interface {
 	FatalErrorAnalyticsReporter
-	ReportCommand(platform config.CommPlatformIntegration, command string, origin command.Origin) error
+	ReportCommand(platform config.CommPlatformIntegration, command string, origin command.Origin, withFilter bool) error
 }
 
 // NewSocketSlack creates a new SocketSlack instance.
@@ -158,7 +158,7 @@ func (b *SocketSlack) Start(ctx context.Context) error {
 							User:            ev.User,
 							CommandOrigin:   command.TypedOrigin,
 						}
-						if err := b.handleMessage(msg); err != nil {
+						if err := b.handleMessage(ctx, msg); err != nil {
 							b.log.Errorf("Message handling error: %s", err.Error())
 						}
 					}
@@ -183,7 +183,7 @@ func (b *SocketSlack) Start(ctx context.Context) error {
 
 					act := callback.ActionCallback.BlockActions[0]
 					if act == nil || strings.HasPrefix(act.ActionID, urlButtonActionIDPrefix) {
-						reportErr := b.reporter.ReportCommand(b.IntegrationName(), act.ActionID, command.ButtonClickOrigin)
+						reportErr := b.reporter.ReportCommand(b.IntegrationName(), act.ActionID, command.ButtonClickOrigin, false)
 						if reportErr != nil {
 							b.log.Errorf("while reporting URL command, error: %s", reportErr.Error())
 						}
@@ -217,7 +217,7 @@ func (b *SocketSlack) Start(ctx context.Context) error {
 						ResponseURL:     callback.ResponseURL,
 						BlockID:         act.BlockID,
 					}
-					if err := b.handleMessage(msg); err != nil {
+					if err := b.handleMessage(ctx, msg); err != nil {
 						b.log.Errorf("Message handling error: %s", err.Error())
 					}
 				case slack.InteractionTypeViewSubmission: // this event is received when modal is submitted
@@ -235,7 +235,7 @@ func (b *SocketSlack) Start(ctx context.Context) error {
 								CommandOrigin: cmdOrigin,
 							}
 
-							if err := b.handleMessage(msg); err != nil {
+							if err := b.handleMessage(ctx, msg); err != nil {
 								b.log.Errorf("Message handling error: %s", err.Error())
 							}
 						}
@@ -294,7 +294,7 @@ func (b *SocketSlack) SetNotificationsEnabled(channelName string, enabled bool)
 	return nil
 }
 
-func (b *SocketSlack) handleMessage(event socketSlackMessage) error {
+func (b *SocketSlack) handleMessage(ctx context.Context, event socketSlackMessage) error {
 	// Handle message only if starts with mention
 	request, found := b.findAndTrimBotMention(event.Text)
 	if !found {
@@ -328,7 +328,7 @@ func (b *SocketSlack) handleMessage(event socketSlackMessage) error {
 		Message: request,
 		User:    fmt.Sprintf("<@%s>", event.User),
 	})
-	response := e.Execute()
+	response := e.Execute(ctx)
 	err = b.send(event, request, response)
 	if err != nil {
 		return fmt.Errorf("while sending message: %w", err)

pkg/bot/teams.go

@@ -180,7 +180,7 @@ func (b *Teams) processActivity(w http.ResponseWriter, req *http.Request) {
 
 	err = b.Adapter.ProcessActivity(ctx, activity, coreActivity.HandlerFuncs{
 		OnMessageFunc: func(turn *coreActivity.TurnContext) (schema.Activity, error) {
-			n, resp := b.processMessage(turn.Activity)
+			n, resp := b.processMessage(ctx, turn.Activity)
 			if n >= teamsMaxMessageSize {
 				if turn.Activity.Conversation.ConversationType == convTypePersonal {
 					// send file upload request
@@ -242,7 +242,7 @@ func (b *Teams) processActivity(w http.ResponseWriter, req *http.Request) {
 			}
 
 			activity.Text = consentCtx.Command
-			_, resp := b.processMessage(activity)
+			_, resp := b.processMessage(ctx, activity)
 
 			actJSON, err := json.MarshalIndent(turn.Activity, "", "  ")
 			if err != nil {
@@ -276,7 +276,7 @@ func (b *Teams) processActivity(w http.ResponseWriter, req *http.Request) {
 	}
 }
 
-func (b *Teams) processMessage(activity schema.Activity) (int, string) {
+func (b *Teams) processMessage(ctx context.Context, activity schema.Activity) (int, string) {
 	trimmedMsg := b.trimBotMention(activity.Text)
 
 	// Multicluster is not supported for Teams
@@ -300,7 +300,7 @@ func (b *Teams) processMessage(activity schema.Activity) (int, string) {
 		},
 		Message: trimmedMsg,
 	})
-	return b.convertInteractiveMessage(e.Execute(), false)
+	return b.convertInteractiveMessage(e.Execute(ctx), false)
 }
 
 func (b *Teams) convertInteractiveMessage(in interactive.Message, forceMarkdown bool) (int, string) {

pkg/execute/edit.go

@@ -85,7 +85,7 @@ func (e *EditExecutor) Do(args []string, commGroupName string, platform config.C
 
 	defer func() {
 		cmdToReport := fmt.Sprintf("%s %s", cmdName, cmdVerb)
-		err := e.analyticsReporter.ReportCommand(platform, cmdToReport, conversation.CommandOrigin)
+		err := e.analyticsReporter.ReportCommand(platform, cmdToReport, conversation.CommandOrigin, false)
 		if err != nil {
 			e.log.Errorf("while reporting edit command: %s", err.Error())
 		}