Report Yarn v3/v4 patches as pedigree rather than components #784
+349
−100
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,7 +18,7 @@ | |
| from packageurl import PackageURL | ||
|
|
||
| from cachi2.core.errors import PackageManagerError, PackageRejected, UnsupportedFeature | ||
| from cachi2.core.models.sbom import Component, Patch, PatchDiff, Pedigree | ||
| from cachi2.core.package_managers.yarn.locators import ( | ||
| FileLocator, | ||
| HttpsLocator, | ||
|
|
@@ -165,8 +165,18 @@ def create_components( | |
| packages: list[Package], project: Project, output_dir: RootedPath | ||
| ) -> list[Component]: | ||
| """Create SBOM components for all the packages parsed from the 'yarn info' output.""" | ||
| package_mapping: dict[Locator, Package] = {} | ||
| patch_locators: list[PatchLocator] = [] | ||
|
|
||
| # Patches are not components themselves, but they are necessary to | ||
| # resolve pedigree for their non-patch parent package components | ||
| for package in packages: | ||
| if isinstance(package.parsed_locator, PatchLocator): | ||
| patch_locators.append(package.parsed_locator) | ||
| else: | ||
| package_mapping[package.parsed_locator] = package | ||
|
|
||
| component_resolver = _ComponentResolver(package_mapping, patch_locators, project, output_dir) | ||
| return [component_resolver.get_component(package) for package in package_mapping.values()] | ||
|
|
||
|
|
||
|
|
@@ -192,11 +202,41 @@ class _CouldNotResolve(ValueError): | |
|
|
||
| class _ComponentResolver: | ||
| def __init__( | ||
| self, | ||
| package_mapping: Mapping[Locator, Package], | ||
| patch_locators: list[PatchLocator], | ||
| project: Project, | ||
| output_dir: RootedPath, | ||
| ) -> None: | ||
| self._project = project | ||
| self._output_dir = output_dir | ||
| self._package_mapping = package_mapping | ||
| self._pedigree_mapping = self._get_pedigree_mapping(patch_locators) | ||
|
|
||
| def _get_pedigree_mapping(self, patch_locators: list[PatchLocator]) -> dict[Locator, Pedigree]: | ||
| """Map locators for dependencies that get patched to their Pedigree.""" | ||
| pedigree_mapping: dict[Locator, Pedigree] = {} | ||
| for patch_locator in patch_locators: | ||
| # Filter out builtin patches | ||
|
There was a problem hiding this comment. Builtin patches are applied by Yarn itself and tied to a specific version of Yarn. They are used to make certain features of the package manager work correctly: example. Do we want to report these? |
||
| patch_paths: list[Path] = [p for p in patch_locator.patches if isinstance(p, Path)] | ||
| if not patch_paths: | ||
| continue | ||
|
|
||
| patched_package = self._get_patched_package(patch_locator) | ||
| pedigree = pedigree_mapping.setdefault(patched_package, Pedigree(patches=[])) | ||
| for patch_path in patch_paths: | ||
| patch_url = self._get_patch_url(patch_locator, patch_path) | ||
| pedigree.patches.append(Patch(type="unofficial", diff=PatchDiff(url=patch_url))) | ||
|
|
||
| return pedigree_mapping | ||
|
|
||
| def _get_patched_package(self, patch_locator: PatchLocator) -> Locator: | ||
| """Return the non-patch parent package for a given patch locator.""" | ||
| patched_locator = patch_locator.package | ||
| while isinstance(patched_locator, PatchLocator): | ||
| patched_locator = patched_locator.package | ||
|
|
||
| return patched_locator | ||
|
|
||
| def get_component(self, package: Package) -> Component: | ||
| """Create an SBOM component for a yarn Package.""" | ||
|
|
@@ -217,6 +257,7 @@ def get_component(self, package: Package) -> Component: | |
| name=resolved_package.name, | ||
| version=resolved_package.version, | ||
| purl=purl, | ||
| pedigree=self._pedigree_mapping.get(package.parsed_locator), | ||
| ) | ||
|
|
||
| @staticmethod | ||
|
|
@@ -262,10 +303,7 @@ def _generate_purl_for_package(package: _ResolvedPackage, project: Project) -> s | |
| subpath = str(normalized.subpath_from_root) | ||
|
|
||
| elif isinstance(package.locator, PatchLocator): | ||
| raise _CouldNotResolve("Patches cannot be resolved into Components") | ||
| else: | ||
| assert_never(package.locator) | ||
|
|
||
|
|
@@ -329,23 +367,7 @@ def log_for_locator(msg: str, *args: Any, level: int = logging.DEBUG) -> None: | |
| ) | ||
| name, version = self._read_name_version_from_packjson(packjson) | ||
| elif isinstance(locator, PatchLocator): | ||
| raise _CouldNotResolve("Patches cannot be resolved into Components") | ||
| else: | ||
| # This line can never be reached assuming type-checker checks are passing | ||
| # https://typing.readthedocs.io/en/latest/source/unreachable.html#assert-never-and-exhaustiveness-checking | ||
|
|
@@ -412,3 +434,21 @@ def _cache_path_as_rooted(self, cache_path: str) -> RootedPath: | |
| return self._project_subpath(cache_path) | ||
| else: | ||
| return self._output_dir.join_within_root(cache_path) | ||
|
|
||
| def _get_patch_url(self, patch_locator: PatchLocator, patch_path: Path) -> str: | ||
| """Return a PURL-style VCS URL qualifier with subpath for a Patch.""" | ||
| if patch_locator.locator is None: | ||
| raise UnsupportedFeature( | ||
| ( | ||
| f"{patch_locator} is missing an associated workspace locator " | ||
| "and Cachi2 expects all non-builtin yarn patches to have one" | ||
| ) | ||
| ) | ||
|
|
||
| project_path = self._project.source_dir | ||
| workspace_path = patch_locator.locator.relpath | ||
| normalized = self._project.source_dir.join_within_root(workspace_path, patch_path) | ||
| repo_url = get_repo_id(project_path.root).as_vcs_url_qualifier() | ||
| subpath_from_root = str(normalized.subpath_from_root) | ||
|
|
||
| return f"{repo_url}#{subpath_from_root}" | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -314,18 +314,16 @@ | |
| }, | ||
| { | ||
| "name": "cachito-npm-without-deps", | ||
| "pedigree": { | ||
| "patches": [ | ||
| { | ||
| "diff": { | ||
| "url": "git+https://github.com/cachito-testing/cachi2-yarn-berry.git@70515793108df42547d3320c7ea4cd6b6e505c46#.yarn/patches/[email protected]" | ||
| }, | ||
| "type": "unofficial" | ||
| } | ||
| ] | ||
| }, | ||
| "properties": [ | ||
| { | ||
| "name": "cachi2:found_by", | ||
|
|
@@ -662,6 +660,16 @@ | |
| }, | ||
| { | ||
| "name": "fsevents", | ||
| "pedigree": { | ||
| "patches": [ | ||
| { | ||
| "diff": { | ||
| "url": "git+https://github.com/cachito-testing/cachi2-yarn-berry.git@70515793108df42547d3320c7ea4cd6b6e505c46#my-patches/fsevents.patch" | ||
| }, | ||
| "type": "unofficial" | ||
| } | ||
| ] | ||
| }, | ||
| "properties": [ | ||
| { | ||
| "name": "cachi2:found_by", | ||
|
|
@@ -961,6 +969,22 @@ | |
| }, | ||
| { | ||
| "name": "left-pad", | ||
| "pedigree": { | ||
| "patches": [ | ||
| { | ||
| "diff": { | ||
| "url": "git+https://github.com/cachito-testing/cachi2-yarn-berry.git@70515793108df42547d3320c7ea4cd6b6e505c46#my-patches/left-pad.patch" | ||
| }, | ||
| "type": "unofficial" | ||
| }, | ||
| { | ||
| "diff": { | ||
| "url": "git+https://github.com/cachito-testing/cachi2-yarn-berry.git@70515793108df42547d3320c7ea4cd6b6e505c46#my-patches/left-pad-2.patch" | ||
| }, | ||
| "type": "unofficial" | ||
| } | ||
| ] | ||
| }, | ||
| "properties": [ | ||
| { | ||
| "name": "cachi2:found_by", | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -314,18 +314,16 @@ | |
| }, | ||
| { | ||
| "name": "cachito-npm-without-deps", | ||
| "pedigree": { | ||
| "patches": [ | ||
| { | ||
| "diff": { | ||
| "url": "git+https://github.com/cachito-testing/cachi2-yarn-berry.git@53a2bfe8d5ee7ed9c2f752fe75831a881d54895f#.yarn/patches/[email protected]" | ||
| }, | ||
| "type": "unofficial" | ||
| } | ||
| ] | ||
| }, | ||
| "properties": [ | ||
| { | ||
| "name": "cachi2:found_by", | ||
|
|
@@ -662,6 +660,16 @@ | |
| }, | ||
| { | ||
| "name": "fsevents", | ||
| "pedigree": { | ||
| "patches": [ | ||
| { | ||
| "diff": { | ||
| "url": "git+https://github.com/cachito-testing/cachi2-yarn-berry.git@53a2bfe8d5ee7ed9c2f752fe75831a881d54895f#my-patches/fsevents.patch" | ||
| }, | ||
| "type": "unofficial" | ||
| } | ||
| ] | ||
| }, | ||
| "properties": [ | ||
| { | ||
| "name": "cachi2:found_by", | ||
|
|
@@ -961,6 +969,22 @@ | |
| }, | ||
| { | ||
| "name": "left-pad", | ||
| "pedigree": { | ||
| "patches": [ | ||
| { | ||
| "diff": { | ||
| "url": "git+https://github.com/cachito-testing/cachi2-yarn-berry.git@53a2bfe8d5ee7ed9c2f752fe75831a881d54895f#my-patches/left-pad.patch" | ||
| }, | ||
| "type": "unofficial" | ||
| }, | ||
| { | ||
| "diff": { | ||
| "url": "git+https://github.com/cachito-testing/cachi2-yarn-berry.git@53a2bfe8d5ee7ed9c2f752fe75831a881d54895f#my-patches/left-pad-2.patch" | ||
| }, | ||
| "type": "unofficial" | ||
| } | ||
| ] | ||
| }, | ||
| "properties": [ | ||
| { | ||
| "name": "cachi2:found_by", | ||
|
|
||
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The CycloneDX schema offers the option of a text diff for the patch, but it is not required. I opted not to include so as not to clutter the SBOM. Let me know if you disagree.