Fix resolve failing when package from registry is referenced by name

[fortmarek]

Fix resolve failing when package from registry is referenced by name

Motivation:

When running swift package --replace-scm-with-registry --default-registry-url {our-registry-url} resolve, the command fails when depending on packages that reference their transitive dependencies by name.

I created a demo where you can reproduce the issue by running swift package --replace-scm-with-registry --default-registry-url {our-registry-url} resolve. You should see the following error:

error: 'cpisciotta.xcbeautify': unknown dependency 'Colorizer' in target 'XcbeautifyLib'; valid dependencies are: 'swift-argument-parser' (from 'https://github.com/apple/swift-argument-parser.git'), 'getGuaka.Colorizer', 'MaxDesiatov.XMLCoder'
error: 'cpisciotta.xcbeautify': unknown dependency 'XMLCoder' in target 'XcbeautifyLib'; valid dependencies are: 'swift-argument-parser' (from 'https://github.com/apple/swift-argument-parser.git'), 'getGuaka.Colorizer', 'MaxDesiatov.XMLCoder'

The issue boils down to:

// Root Package.swift
import PackageDescription

let package = Package(
    name: "package-test",
    dependencies: [
        // We're depending on `xcbeautify` from our root `Package.swift`
        .package(url: "https://github.com/cpisciotta/xcbeautify", exact: "2.13.0")
    ],
    targets: [
        .target(name: "package-test"),
    ]
)

// Package.swift at https://github.com/cpisciotta/xcbeautify/blob/main/Package.swift
import PackageDescription

let package = Package(
    name: "xcbeautify",
    products: [
        .library(name: "XcbeautifyLib", targets: ["XcbeautifyLib"]),
    ],
    dependencies: [
        .package(
            url: "https://github.com/getGuaka/Colorizer.git",
            .upToNextMinor(from: "0.2.1")
        ),
        .package(
            url: "https://github.com/MaxDesiatov/XMLCoder.git",
            .upToNextMinor(from: "0.17.1")
        ),
    ],
    targets: [
        .target(
            name: "XcbeautifyLib",
            dependencies: [
                // Transitive package products referenced by name
                "Colorizer",
                "XMLCoder",
            ]
        ),
    ]
)

The issue is that when swizzling the package product names to their identity counterparts, only dependencies referenced via .product(...) are swizzled. Indeed, when we change the XcbeautifyLib's dependencies to:

.product(name: "Colorizer", package: "Colorizer"),
.product(name: "XMLCoder", package: "XMLCoder"),

the resolution succeeds.

Modifications:

To fix the above issue, we swizzle also dependencies referenced by name iff the product name is the same as the package name the root depends on. This aligns with how byName is treated in other parts of the codebase, such as here.

Result:

swift package --replace-scm-with-registry --default-registry-url {our-registry-url} resolve succeeds when run in the repro sample.

[MaxDesiatov]

nit: formatting seems off by one whitespace here

Suggested change

	// makes sure we use the updated package name for target based dependencies
	let modifiedPackageName = targetDependencyPackageNameTransformations[packageName] {
	// makes sure we use the updated package name for target based dependencies
	let modifiedPackageName = targetDependencyPackageNameTransformations[packageName] {

[fortmarek]

This is indented with Xcode's Editor > Structure > Re-indent. Are you sure you'd prefer it to be re-indented as you suggested instead?

[MaxDesiatov]

Per CONTRIBUTING.md we prefer SwiftFormat instead of Xcode or swift-format in this repository. It's also very surprising that Xcode suggests 3-spaces formatting even if for a few lines. Regardless, I don't insist applying SwiftFormat here unless you can easily avoid mass reformatting the whole file to keep the diff of this PR manageable.

[MaxDesiatov]

LGTM modulo some formatting nits. Thanks!

[MaxDesiatov]

@swift-ci test

[fortmarek]

Thanks @MaxDesiatov for the speedy review (I don't think I've ever had my PR reviewed faster in an open source repository 😅). I applied the SwiftFormat changes, let's see what the CI has to say about this PR 👀

[MaxDesiatov]

@swift-ci test

[fortmarek]

Hey @MaxDesiatov 👋

Are we waiting for some additional reviews or is there anything else that needs to be done before this PR can be merged?

[MaxDesiatov]

@swift-ci test windows

[MaxDesiatov]

This can't be merged currently due to https://forums.swift.org/t/holiday-schedule-2024/75954

[fortmarek]

This can't be merged currently due to https://forums.swift.org/t/holiday-schedule-2024/75954

Got it, thanks for the quick response. Happy holidays 🎄