Add logging when executing a command in not configured channel (#1061)

* Add logging when executing a command in not configured channel * Remove unused field from context
kubeshop · May 12, 2023 · e601056 · e601056
1 parent 788b4b1
commit e601056
Show file tree

Hide file tree

Showing 11 changed files with 209 additions and 213 deletions.
diff --git a/helm/botkube/README.md b/helm/botkube/README.md
diff --git a/helm/botkube/values.yaml b/helm/botkube/values.yaml
@@ -118,7 +118,6 @@ sources:
     # @default -- See the `values.yaml` file for full object.
     botkube/kubernetes:
       context: &default-plugin-context
-        defaultNamespace: "default"
         # -- RBAC configuration for this plugin.
         rbac:
           group:

diff --git a/pkg/action/provider.go b/pkg/action/provider.go
@@ -89,7 +89,7 @@ func (p *Provider) ExecuteAction(ctx context.Context, action Action) interactive
 	userName := fmt.Sprintf("Automation %q", action.DisplayName)
 	e := p.executorFactory.NewDefault(execute.NewDefaultInput{
 		Conversation: execute.Conversation{
-			IsAuthenticated:  true,
+			IsKnown:          true,
 			ExecutorBindings: action.ExecutorBindings,
 			CommandOrigin:    command.AutomationOrigin,
 			Alias:            unknownValue,

diff --git a/pkg/action/provider_test.go b/pkg/action/provider_test.go
@@ -103,7 +103,7 @@ func TestProvider_ExecuteEventAction(t *testing.T) {
 			Alias:            "n/a",
 			ID:               "n/a",
 			ExecutorBindings: executorBindings,
-			IsAuthenticated:  true,
+			IsKnown:          true,
 			CommandOrigin:    command.AutomationOrigin,
 		},
 		Message: "kubectl get po foo",

diff --git a/pkg/bot/discord.go b/pkg/bot/discord.go
@@ -228,7 +228,6 @@ func (b *Discord) handleMessage(ctx context.Context, dm discordMessage) error {
 			},
 		}
 	}
-	isAuthChannel := exists
 
 	e := b.executorFactory.NewDefault(execute.NewDefaultInput{
 		CommGroupName:   b.commGroupName,
@@ -240,7 +239,7 @@ func (b *Discord) handleMessage(ctx context.Context, dm discordMessage) error {
 			ID:               channel.Identifier(),
 			ExecutorBindings: channel.Bindings.Executors,
 			SourceBindings:   channel.Bindings.Sources,
-			IsAuthenticated:  isAuthChannel,
+			IsKnown:          exists,
 			CommandOrigin:    command.TypedOrigin,
 		},
 		Message: req,

diff --git a/pkg/bot/mattermost.go b/pkg/bot/mattermost.go
@@ -67,8 +67,7 @@ type Mattermost struct {
 
 // mattermostMessage contains message details to execute command and send back the result
 type mattermostMessage struct {
-	Event         *model.WebSocketEvent
-	IsAuthChannel bool
+	Event *model.WebSocketEvent
 }
 
 // NewMattermost creates a new Mattermost instance.
@@ -238,7 +237,6 @@ func (b *Mattermost) handleMessage(ctx context.Context, mm *mattermostMessage) e
 			},
 		}
 	}
-	mm.IsAuthChannel = exists
 
 	userName, err := b.getUserName(post.UserId)
 	if err != nil {
@@ -258,7 +256,7 @@ func (b *Mattermost) handleMessage(ctx context.Context, mm *mattermostMessage) e
 			ID:               channel.Identifier(),
 			ExecutorBindings: channel.Bindings.Executors,
 			SourceBindings:   channel.Bindings.Sources,
-			IsAuthenticated:  mm.IsAuthChannel,
+			IsKnown:          exists,
 			CommandOrigin:    command.TypedOrigin,
 		},
 		User: execute.UserInput{
@@ -384,8 +382,7 @@ func (b *Mattermost) listen(ctx context.Context) {
 			}
 
 			mm := &mattermostMessage{
-				Event:         event,
-				IsAuthChannel: false,
+				Event: event,
 			}
 			err := b.handleMessage(ctx, mm)
 			if err != nil {

diff --git a/pkg/bot/slack.go b/pkg/bot/slack.go
@@ -224,7 +224,7 @@ func (b *Slack) handleMessage(ctx context.Context, msg slackMessage) error {
 		return fmt.Errorf("while getting conversation info: %w", err)
 	}
 
-	channel, isAuthChannel := b.getChannels()[info.Name]
+	channel, exists := b.getChannels()[info.Name]
 
 	e := b.executorFactory.NewDefault(execute.NewDefaultInput{
 		CommGroupName:   b.commGroupName,
@@ -235,7 +235,7 @@ func (b *Slack) handleMessage(ctx context.Context, msg slackMessage) error {
 			ID:               channel.Identifier(),
 			DisplayName:      channel.Name,
 			ExecutorBindings: channel.Bindings.Executors,
-			IsAuthenticated:  isAuthChannel,
+			IsKnown:          exists,
 			CommandOrigin:    command.TypedOrigin,
 		},
 		Message: request,

diff --git a/pkg/bot/socketslack.go b/pkg/bot/socketslack.go
@@ -340,7 +340,7 @@ func (b *SocketSlack) handleMessage(ctx context.Context, event socketSlackMessag
 		return fmt.Errorf("while getting conversation info: %w", err)
 	}
 
-	channel, isAuthChannel := b.getChannels()[info.Name]
+	channel, exists := b.getChannels()[info.Name]
 
 	e := b.executorFactory.NewDefault(execute.NewDefaultInput{
 		CommGroupName:   b.commGroupName,
@@ -352,7 +352,7 @@ func (b *SocketSlack) handleMessage(ctx context.Context, event socketSlackMessag
 			DisplayName:      info.Name,
 			ExecutorBindings: channel.Bindings.Executors,
 			SourceBindings:   channel.Bindings.Sources,
-			IsAuthenticated:  isAuthChannel,
+			IsKnown:          exists,
 			CommandOrigin:    event.CommandOrigin,
 			SlackState:       event.State,
 		},

diff --git a/pkg/bot/teams.go b/pkg/bot/teams.go
@@ -285,7 +285,7 @@ func (b *Teams) processMessage(ctx context.Context, activity schema.Activity) (i
 		NotifierHandler: newTeamsNotifMgrForActivity(b, ref),
 		Conversation: execute.Conversation{
 			Alias:            "",
-			IsAuthenticated:  true,
+			IsKnown:          true,
 			ID:               ref.ChannelID,
 			ExecutorBindings: b.bindings.Executors,
 			SourceBindings:   b.bindings.Sources,

diff --git a/pkg/execute/executor.go b/pkg/execute/executor.go
@@ -99,7 +99,7 @@ func (e *DefaultExecutor) Execute(ctx context.Context) interactive.CoreMessage {
 	cmdCtx.ExecutorFilter = newExecutorTextFilter(flags.Filter)
 
 	if len(cmdCtx.Args) == 0 {
-		if e.conversation.IsAuthenticated {
+		if e.conversation.IsKnown {
 			msg, err := e.helpExecutor.Help(ctx, cmdCtx)
 			if err != nil {
 				e.log.Errorf("while getting help message: %s", err.Error())
@@ -118,8 +118,9 @@ func (e *DefaultExecutor) Execute(ctx context.Context) interactive.CoreMessage {
 		return empty // user specified different target cluster
 	}
 
-	// commands below are executed only if the channel is authorized
-	if !e.conversation.IsAuthenticated {
+	// commands below are executed only if the channel is configured
+	if !e.conversation.IsKnown {
+		e.log.Info("Unknown conversation. Returning empty message...")
 		return empty
 	}
 

diff --git a/pkg/execute/factory.go b/pkg/execute/factory.go
@@ -163,7 +163,7 @@ type Conversation struct {
 	ID               string
 	ExecutorBindings []string
 	SourceBindings   []string
-	IsAuthenticated  bool
+	IsKnown          bool
 	CommandOrigin    command.Origin
 	SlackState       *slack.BlockActionStates
 }