Add support for diff-informed queries #2559
Conversation
src/actions-util.ts
Outdated
| /** | ||
| * Deepen the git history of the given ref by one level. Errors are ignored. | ||
| */ | ||
| export const deepenGitHistory = async function () { |
There was a problem hiding this comment.
Two comments about the additions to this file in general:
- Why completely ignore errors? Does it make sense to at least debug log them?
- Nit, optional: This PR adds a bunch of functionality that interacts with git — now might be a good time to pull this functionality out into its own file.
There was a problem hiding this comment.
The error is indeed logged centrally within runGitCommand(). By "Errors are ignored", I was trying to convey that errors are not reported back to the caller. I have update the function documentation to clarify the behavior.
Moving the git interactions to its own file sounds like a good idea, though trying to incorporate that into this PR is a bit messy. Can I defer that to a dedicated PR after this one merges?
| export const deepenGitHistory = async function () { | ||
| try { | ||
| await runGitCommand( | ||
| getOptionalInput("checkout_path"), |
There was a problem hiding this comment.
It might be worth noting that this function (and others) only work when called from analyze or upload-sarif.
There was a problem hiding this comment.
I added a note to the function documentation, here and for other git functions.
| "-c", | ||
| "core.quotePath=false", |
There was a problem hiding this comment.
Could you explain the difference between this approach and using the -z flag?
There was a problem hiding this comment.
The -z flag affects only specific modes: --raw, --numstat, --name-only and --name-status. Since we need the actual diff line ranges (as opposed to only the file-level information), we cannot use any of these modes, and as a result specifying -z here has no effect.
| const results = new Array<[string, number, number]>(); | ||
|
|
||
| let changedFile = ""; | ||
| for (const line of diffHunkHeaders) { |
There was a problem hiding this comment.
In general this seems to keep going when it sees certain kinds of unexpected items in the diff. It seems that there's a risk of missing changed files — should we be more robust here, or fail more eagerly, or is that not important for now?
There was a problem hiding this comment.
Can you tell me more about the risk you see, and how the code can be made more robust?
| @@ -161,6 +162,147 @@ export const determineBaseBranchHeadCommitOid = async function ( | |||
| } | |||
| }; | |||
|
|
|||
| /** | |||
There was a problem hiding this comment.
Nit: same comment about considering moving this bunch of self-contained functionality to a new file.
There was a problem hiding this comment.
Please see response to your earlier mention of the same suggestion.
cklin
force-pushed
the
cklin/diff-range-filtering
branch
from
d757098
to
38487cd
Compare
Thanks for the detailed comments and helpful suggestions! PTAL. |
Merge / deployment checklist