Ensure errors are useful message for security scan #355
Conversation
This file contains 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
awschristou
reviewed
Jun 27, 2024
| } | ||
| if (!params.arguments || params.arguments.length === 0) { | ||
| throw new Error(`Incorrect params provided. Params: ${params}`) | ||
| throw new Error(`Error: Incorrect parameters parameters provided`) |
There was a problem hiding this comment.
Since the error text becomes user-facing, lets log (with logging) this error message, along with ${params}. This will let us diagnose the problem and see what the input is.
Meanwhile, we can make this error text less "technical" by saying something like "Error: Invalid data"
| } | ||
| const [arg] = params.arguments | ||
| const { ActiveFilePath: activeFilePath, ProjectPath: projectPath } = parseJson(arg) | ||
| if (!activeFilePath || !projectPath) { | ||
| throw new Error(`Error: file path or project path not provided. Params: ${params}`) | ||
| if (!activeFilePath) { |
There was a problem hiding this comment.
In each of these failure cases, it would be good to log the params payload. As the client, we will want to diagnose by understanding what we did or didn't send over to the server.
ege0zcan
reviewed
Jun 28, 2024
| } | ||
| const [arg] = params.arguments | ||
|
|
||
| logging.log(`Arguments provided: ${JSON.stringify(arg)}`) |
There was a problem hiding this comment.
Could this lead to sensitive data being logged or is it just path information?
There was a problem hiding this comment.
This is just path information.
ege0zcan
approved these changes
Jun 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Problem
Security scan error messages were vague and did not provide enough information on what the error being returned from LSP was
Solution
Update wording on error messages to describe the issue rather than returning internal objects
License
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.