Fix(PypiMetaAnalyzer): Compliant with the Simple Repository API (PEP 503|691) [DependencyTrack#5735]#5778
Open
ch8matt wants to merge 2 commits intoDependencyTrack:masterfrom
Open
Fix(PypiMetaAnalyzer): Compliant with the Simple Repository API (PEP 503|691) [DependencyTrack#5735]#5778ch8matt wants to merge 2 commits intoDependencyTrack:masterfrom
ch8matt wants to merge 2 commits intoDependencyTrack:masterfrom
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferences |
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
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
Refactor
PypiMetaAnalyzerto comply with the Python Simple Repository API (PEP 503 & PEP 691) instead of relying on the legacy/pypi/<project>/jsonendpoint.The analyzer now retrieves metadata from
/simple/<normalized-project-name>/using HTTP content negotiation and supports both:application/vnd.pypi.simple.v1+json, PEP 691)latestVersionis derived from standardized Simple API data, preferring non-yanked releases unless all releases are yanked.publishedTimestampis extracted from JSONupload-timefields when available.This change enables compatibility with PyPI-compatible registries (e.g., GitLab PyPI Registry) that do not implement the legacy PyPI JSON endpoint.
Addressed Issue
Fixes #5735
Additional Details
Previous Behavior
PypiMetaAnalyzerqueried:/pypi/<project>/jsonThis endpoint is specific to PyPI and not part of the official Python packaging specification.
As a result, Dependency-Track failed to resolve metadata when using PyPI-compatible registries that only implement the Simple Repository API.
New Behavior
The analyzer now:
/simple/<normalized-name>/Acceptheader to prefer JSON (PEP 691) while falling back to HTML (PEP 503)Content-TypelatestVersionfrom available versions (preferring non-yanked releases)publishedTimestampfrom JSONupload-timewhen availableAdditional Changes
jsoupAbstractMetaAnalyzerto support configurableAcceptheadersChecklist