Skip to content

Commit

Permalink
Dependency imports should always be fetched from upstream (#1027)
Browse files Browse the repository at this point in the history
There are two places that we call `mergeParents()`:
 - Merging data from parent pom.xml files
 - Importing dependency management from another project
 
In `mergeParents()`, we first check if `relativePath` is defined to know
if we can parse parent locally.
However, this only applies for the first case but not for importing
dependency management.
Also, once we start fetching parent pom.xml from upstream, we should no
longer parse locally.

This PR adds `allowLocal` to `mergeParents()` to specify if we allow
parsing local parent pom.xml, and once a parent is fetched from
upstream, `allowLocal` is set to false.

---------

Co-authored-by: Rex P <106129829+another-rex@users.noreply.github.com>
  • Loading branch information
cuixq and another-rex committed Jun 6, 2024
1 parent 8fd553a commit 02a802d
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions internal/resolution/manifest/maven.go
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ func (m MavenManifestIO) Read(df lockfile.DepFile) (Manifest, error) {
addAllRequirements(project, "")

// Merging parents data by parsing local parent pom.xml or fetching from upstream.
if err := m.MergeParents(ctx, &project, project.Parent, 1, df.Path(), addAllRequirements, OriginParent); err != nil {
if err := m.mergeParents(ctx, &project, project.Parent, 1, df.Path(), true, addAllRequirements, OriginParent); err != nil {
return Manifest{}, fmt.Errorf("failed to merge parents: %w", err)
}
// Interpolate to resolve properties.
Expand All @@ -160,12 +160,12 @@ func (m MavenManifestIO) Read(df lockfile.DepFile) (Manifest, error) {

// Process the dependencies:
// - dedupe dependencies and dependency management
// - import dependency management (not yet transitively)
// - import dependency management
// - fill in missing dependency version requirement
project.ProcessDependencies(func(groupID, artifactID, version maven.String) (maven.DependencyManagement, error) {
root := maven.Parent{ProjectKey: maven.ProjectKey{GroupID: groupID, ArtifactID: artifactID, Version: version}}
var result maven.Project
if err := m.MergeParents(ctx, &result, root, 0, df.Path(), addAllRequirements, OriginImport); err != nil {
if err := m.mergeParents(ctx, &result, root, 0, "", false, addAllRequirements, OriginImport); err != nil {
return maven.DependencyManagement{}, err
}
// Interpolate to resolve properties.
Expand Down Expand Up @@ -259,7 +259,7 @@ func (m MavenManifestIO) Read(df lockfile.DepFile) (Manifest, error) {
// set a limit on the number of parents.
const MaxParent = 100

func (m MavenManifestIO) MergeParents(ctx context.Context, result *maven.Project, current maven.Parent, start int, path string, addRequirements func(maven.Project, string), prefix string) error {
func (m MavenManifestIO) mergeParents(ctx context.Context, result *maven.Project, current maven.Parent, start int, path string, allowLocal bool, addRequirements func(maven.Project, string), prefix string) error {
currentPath := path
visited := make(map[maven.ProjectKey]bool, MaxParent)
for n := start; n < MaxParent; n++ {
Expand All @@ -273,7 +273,7 @@ func (m MavenManifestIO) MergeParents(ctx context.Context, result *maven.Project
visited[current.ProjectKey] = true

var proj maven.Project
if current.RelativePath != "" {
if allowLocal && current.RelativePath != "" {
currentPath = filepath.Join(filepath.Dir(currentPath), string(current.RelativePath))
if filepath.Base(currentPath) != "pom.xml" {
// If the base is not pom.xml, this path is a directory but not a file.
Expand All @@ -287,6 +287,10 @@ func (m MavenManifestIO) MergeParents(ctx context.Context, result *maven.Project
return fmt.Errorf("failed to unmarshal project: %w", err)
}
} else {
// Once we fetch a parent pom.xml from upstream, we should not allow
// parsing parent pom.xml locally anymore.
allowLocal = false

var err error
proj, err = m.MavenRegistryAPIClient.GetProject(ctx, string(current.GroupID), string(current.ArtifactID), string(current.Version))
if err != nil {
Expand Down

0 comments on commit 02a802d

Please sign in to comment.