-
Notifications
You must be signed in to change notification settings - Fork 245
Pre-validate workflow names in MCP logs tool #15221
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
51b6274
Initial plan
Copilot 78fd918
Add workflow name validation to MCP logs tool
Copilot d20a5d5
Add test case for fuzzy match suggestions in workflow validation
Copilot 78ac30b
Update error message to suggest status tool instead of CLI command
Copilot 882a8ce
Merge branch 'main' into copilot/improve-error-messaging-logs
pelikhan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -14,6 +14,7 @@ import ( | |||||||||||
|
|
||||||||||||
| "github.com/github/gh-aw/pkg/console" | ||||||||||||
| "github.com/github/gh-aw/pkg/logger" | ||||||||||||
| "github.com/github/gh-aw/pkg/sliceutil" | ||||||||||||
| "github.com/github/gh-aw/pkg/workflow" | ||||||||||||
| "github.com/modelcontextprotocol/go-sdk/jsonrpc" | ||||||||||||
| "github.com/modelcontextprotocol/go-sdk/mcp" | ||||||||||||
|
|
@@ -162,6 +163,49 @@ func hasWriteAccess(permission string) bool { | |||||||||||
| } | ||||||||||||
| } | ||||||||||||
|
|
||||||||||||
| // validateWorkflowName validates that a workflow name exists. | ||||||||||||
| // Returns nil if the workflow exists, or an error with suggestions if not. | ||||||||||||
| // Empty workflow names are considered valid (means all workflows). | ||||||||||||
| func validateWorkflowName(workflowName string) error { | ||||||||||||
| // Empty workflow name means "all workflows" - this is valid | ||||||||||||
| if workflowName == "" { | ||||||||||||
| return nil | ||||||||||||
| } | ||||||||||||
|
|
||||||||||||
| mcpLog.Printf("Validating workflow name: %s", workflowName) | ||||||||||||
|
|
||||||||||||
| // Try to resolve as workflow ID first | ||||||||||||
| resolvedName, err := workflow.ResolveWorkflowName(workflowName) | ||||||||||||
| if err == nil { | ||||||||||||
| mcpLog.Printf("Workflow name resolved successfully: %s -> %s", workflowName, resolvedName) | ||||||||||||
|
Comment on lines
+178
to
+180
|
||||||||||||
| resolvedName, err := workflow.ResolveWorkflowName(workflowName) | |
| if err == nil { | |
| mcpLog.Printf("Workflow name resolved successfully: %s -> %s", workflowName, resolvedName) | |
| if _, err := workflow.ResolveWorkflowName(workflowName); err == nil { | |
| mcpLog.Printf("Workflow name resolved successfully: %s", workflowName) |
pelikhan marked this conversation as resolved.
Show resolved
Hide resolved
pelikhan marked this conversation as resolved.
Show resolved
Hide resolved
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| //go:build !integration | ||
|
|
||
| package cli | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestMCPValidateWorkflowName(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| workflowName string | ||
| shouldSucceed bool | ||
| errorContains string | ||
| }{ | ||
| { | ||
| name: "empty workflow name is valid (all workflows)", | ||
| workflowName: "", | ||
| shouldSucceed: true, | ||
| }, | ||
| { | ||
| name: "non-existent workflow returns error", | ||
| workflowName: "nonexistent-workflow-xyz-12345", | ||
| shouldSucceed: false, | ||
| errorContains: "workflow 'nonexistent-workflow-xyz-12345' not found", | ||
| }, | ||
| { | ||
| name: "error includes suggestions", | ||
| workflowName: "invalid-name", | ||
| shouldSucceed: false, | ||
| errorContains: "Use the 'status' tool to see all available workflows", | ||
| }, | ||
| { | ||
| name: "error includes fuzzy matched suggestions for similar names", | ||
| workflowName: "brave-test", // Similar to "brave" workflow | ||
| shouldSucceed: false, | ||
| errorContains: "workflow 'brave-test' not found", | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| err := validateWorkflowName(tt.workflowName) | ||
|
|
||
| if tt.shouldSucceed { | ||
| assert.NoError(t, err, "Validation should succeed for workflow: %s", tt.workflowName) | ||
| } else { | ||
| assert.Error(t, err, "Validation should fail for workflow: %s", tt.workflowName) | ||
| if tt.errorContains != "" { | ||
| assert.Contains(t, err.Error(), tt.errorContains, "Error message should contain expected text") | ||
| } | ||
| } | ||
| }) | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider using a debug-level log or removing this log statement. This validation is called for every logs tool invocation and will create noise in production logs.