perf(cli): support compressing metadata#397
Merged
nhakmiller merged 1 commit intomainfrom Aug 14, 2025
Merged
Conversation
|
Backwards compatibility summary: |
nhakmiller
commented
Aug 14, 2025
| .PHONY: setup-PYTHON | ||
| setup-PYTHON: | ||
| pip install check-jsonschema | ||
| pip install mypy |
Contributor
Author
There was a problem hiding this comment.
Unrelated to my change, but mypy is a python requirement and make fails if it is not installed.
nhakmiller
changed the title
salolivares
approved these changes
Aug 14, 2025
3 tasks
nhakmiller
added a commit
that referenced
this pull request
Aug 20, 2025
### Description Reverting #397 because we have a better solution that does not need this parameter. I talked with @salolivares and we think this might be fine even though it's not backwards compatible because neither the server nor the CLI ever actually started using this parameter. But I'm actually not 100% on if it's ok to make a non backwards compatible change even if the parameter was never set or read by anyone so I'd be interested to hear from someone who could confirm that. - [x] I ran `make setup && make` to update the generated code after editing a `.atd` file (TODO: have a CI check) - [x] I made sure we're still backward compatible with old versions of the CLI. For example, the Semgrep backend need to still be able to *consume* data generated by Semgrep 1.50.0. See https://atd.readthedocs.io/en/latest/atdgen-tutorial.html#smooth-protocol-upgrades Note that the types related to the semgrep-core JSON output or the semgrep-core RPC do not need to be backward compatible! - [ ] Any accompanying changes in `semgrep-proprietary` are approved and ready to merge once this PR is merged - semgrep/semgrep-app#23008 - semgrep/semgrep-proprietary#4481
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.
Description
To reduce CLI scan startup times, we are going to compress the scan config before sending it from the backend to the CLI. In order to be backwards compatible, we are adding an optional
compress_configparameter so the CLI clients can opt in to response compression when they upgrade.Testing
Working on a local semgrep CLI -> local Semgrep app test for this change.
make setup && maketo update the generated code after editing a.atdfile (TODO: have a CI check)For example, the Semgrep backend need to still be able to consume data
generated by Semgrep 1.50.0.
See https://atd.readthedocs.io/en/latest/atdgen-tutorial.html#smooth-protocol-upgrades
Note that the types related to the semgrep-core JSON output or the
semgrep-core RPC do not need to be backward compatible!
semgrep-proprietaryare approved and ready to merge once this PR is merged