ctags: allow binary to be anything with validation #652
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
Previously we enforced the binary was called universal-ctags. However, we let users override the name of the binary, so if they override it we should use it. To prevent footguns, we now validate the binary was built with the interactive feature. In the case of scip-ctags we use the old validation of just checking the name. Additionally we fix a bug that was introduced where if symbols are optional we continue if parsing fails. Test Plan: indexed with and without universal-ctags. Ctags on my mbp points to something from xcode which wouldn't work $ CTAGS_COMMAND=ctags go run ./cmd/zoekt-git-index -require_ctags . 2023/10/04 17:08:12 indexGitRepo(/Users/keegan/src/github.com/sourcegraph/zoekt, delta=false): build.NewBuilder: ctags.NewParserMap: ctags binary is not universal-ctags or is not compiled with +interactive feature: bin=ctags exit status 1 $ CTAGS_COMMAND=universal-ctags go run ./cmd/zoekt-git-index -require_ctags . 2023/10/04 17:08:29 finished github.com%2Fsourcegraph%2Fzoekt_v16.00000.zoekt: 8657338 index bytes (overhead 2.9) $ CTAGS_COMMAND=ctags go run ./cmd/zoekt-git-index . 2023/10/04 17:08:40 finished github.com%2Fsourcegraph%2Fzoekt_v16.00000.zoekt: 8538246 index bytes (overhead 2.9)
eseliger
reviewed
Oct 4, 2023
Comment on lines
+124
to
+126
| func NewParser(parserType CTagsParserType, bin string) (Parser, error) { | ||
| if err := checkBinary(parserType, bin); err != nil { | ||
| return nil, err |
There was a problem hiding this comment.
is this code path run often? ie. would this spawn a ton of processes?
There was a problem hiding this comment.
once per index job, so acceptable. IE before this change we would do one long running subprocess to universal-ctags (and communicate over stdio), now before we start the long lived process we run this first. Long lived == time it takes to index a repo.
eseliger
approved these changes
Oct 4, 2023
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.
Previously we enforced the binary was called universal-ctags. However, we let users override the name of the binary, so if they override it we should use it. To prevent footguns, we now validate the binary was built with the interactive feature.
In the case of scip-ctags we use the old validation of just checking the name.
Additionally we fix a bug that was introduced where if symbols are optional we continue if parsing fails.
Test Plan: indexed with and without universal-ctags. Ctags on my mbp points to something from xcode which wouldn't work
Fixes https://github.com/sourcegraph/sourcegraph/issues/57336