Wait for document to be saved before running query#947
Merged
shati-patel merged 2 commits intomainfrom Sep 7, 2021
Merged
Conversation
This prevents a race condition where the query runs before the editor has saved the file.
shati-patel
approved these changes
Sep 7, 2021
Contributor
shati-patel
left a comment
shati-patel
left a comment
There was a problem hiding this comment.
Thanks for the PR, @hmac! This looks good 🎉
It's technically a user-facing change, so you could add an entry to the CHANGELOG (just under the "unreleased" header). Maybe something like
- Fix bug where a query is sometimes run before the file is saved. [#947](https://github.com/github/vscode-codeql/pull/947)
Contributor
Author
|
@shati-patel done - thanks for the quick review! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
If
AUTOSAVE_SETTINGistrueand I trigger theRun Querycommand, I occasionally see race conditions where the query is run before the file is saved, and I see results corresponding to the previous version of the query. I'm not sure how to test this and I haven't been able to reliably reproduce the problem (though it occurs often).Intuitively, it seems like this change should fix it, since
editor.document.savereturns aThenable, which I think means it returns a promise or the function is async.My javascript is very rusty, sorry if this is inaccurate!
Checklist
@github/docs-content-codeqlhas been cc'd in all issues for UI or other user-facing changes made by this pull request.