Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: move artifact types under artifact package to avoid import cycles #6652

Merged
merged 4 commits into from
May 9, 2024

Conversation

knqyf263
Copy link
Collaborator

@knqyf263 knqyf263 commented May 7, 2024

Description

Currently, ArtifactReference is defined in the types package under pkg/fanal/types, which holds a reference to core.BOM internally. Since PkgIdentifier is also defined in the types package under pkg/fanal/types, attempting to use PkgIdentifier from core.BOM results in a circular dependency. To work around this, a similar struct to PkgIdentifier is redefined in core.BOM now.

This is not ideal. This PR proposes moving ArtifactReference to the artifact package under pkg/fanal/artifact to resolve the circular dependency and enable the reuse of PkgIdentifier. Also, it refactors the growing number of package-related structs into a separate file (pkg/fanal/types/package.go) to improve code readability and maintainability. This PR doesn't change any logic.

Checklist

  • I've read the guidelines for contributing to this repository.
  • I've followed the conventions in the PR title.
  • I've added tests that prove my fix is effective or that my feature works.
  • I've updated the documentation with the relevant information (if needed).
  • I've added usage information (if the PR introduces new options)
  • I've included a "before" and "after" example to the description (if the PR is a user interface change).

Signed-off-by: knqyf263 <knqyf263@gmail.com>
@knqyf263 knqyf263 marked this pull request as ready for review May 8, 2024 10:58
@knqyf263 knqyf263 added this pull request to the merge queue May 9, 2024
Merged via the queue into aquasecurity:main with commit 6a72dd4 May 9, 2024
12 checks passed
@knqyf263 knqyf263 deleted the refactor/sbom branch May 9, 2024 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants