DependencyTrack / DependencyTrack/dependency-track
Snyk Config does not inform user of default SCANNER_SNYK_API_VERSION
- Dominant language
- Java
- Stars
- 4.2k
- Forks
- 811
- Avg merge
- 8h 39m
- Merged PRs (30d)
- 237
Description
### Current Behavior
The API used for Snyk Integration in DT v4.7.0 is versioned and fast-evolving. The `SCANNER_SNYK_API_VERSION` has updated twice even during the development of 4.7.0.
The config screen warns that "Changing the default version may break the integration!"
Snyk integration only uses SCANNER_SNYK_API_VERSION to set things up for a new DT install. Thus, an existing install will start to drift from default (which is what is recommended because it has been tested).
This will impact real-world users once they upgrade to 4.7.0 when it is released (which would currently give them 2022-11-14) and then v4.8,0 uses something like 2023-01-01 (or whaetever)
### Steps to Reproduce
1. Download a version of DT v4.7.0 SNAPSHOT from 1st December 2022 and install fresh.
2. Observe API version.. it will be 2022-10-06 or earlier
3. Update to latest snapshot
4. Observe API version. It will still be 2022-10-06.
5. Check the code. SCANNER_SNYK_API_VERSION (defined in `ConfigPropertyConstants.java`) will be 2022-11-14 or later
### Expected Behavior
It should be obvious when a mismatch exists. Implementing upgrade intelligence might be a pain. I would suggest simply changing the warning on the config screen to display the value of the default.
### Dependency-Track Version
4.7.0-SNAPSHOT
### Dependency-Track Distribution
Container Image
### Database Server
PostgreSQL
### Database Server Version
_No response_
### Browser
Mozilla Firefox
### Checklist
- [X] I have read and understand the [contributing guidelines](https://github.com/DependencyTrack/dependency-track/blob/master/CONTRIBUTING.md#filing-issues)
- [X] I have checked the [existing issues](https://github.com/DependencyTrack/dependency-track/issues) for whether this defect was already reported
Contributor guide
Assessment
This issue has not been assessed yet.