`No target named 'swift-openapi-generator-arm64-apple-macosx15.0-debug-tool.exe' in build description` when doing `--experimental-prepare-for-indexing`

[ahoppen]

Running swift build --target HelloWorldHummingbirdServer --experimental-prepare-for-indexing on the attached project fails with

error: No target named 'swift-openapi-generator-arm64-apple-macosx15.0-debug-tool.exe' in build description

testpackage.zip

[plemarquand]

I started digging in to this issue, and while I don't know if I've got enough context to fix it completely I can state my findings.

Building with --experimental-prepare-for-indexing triggers a LLBuildManifestBuilder.generatePrepareManifest(at:), which generates a stripped down manifest. This manifest generates compile commands and only creates .macro and .plugin product commands.

swift-package-manager/Sources/Build/BuildManifest/LLBuildManifestBuilder.swift

Lines 151 to 159 in 1d637b3

	for description in self.plan.productMap {
	// Need to generate macro products
	switch description.product.type {
	case .macro, .plugin:
	try self.createProductCommand(description)
	default:
	break
	}
	}

Because swift-openapi-generator-arm64-apple-macosx15.0-debug-tool is an executable that is depended on by the OpenAPIGenerator plugin target, the product command for the plugin is added to the manifest but the executable that it depends on is not. If I comment out the switch and simply do a createProductCommand for all descriptions in the self.plan.productMap the build succeeds.

Obviously its not ideal, but I'm not sure the best approach to pair down the products while still building what is required.

The other, much more minor thing is the .exe in the target name on all platforms (i.e. macOS). It doesn't really break anything but is pretty confusing. That looks like a simple omission in the function that generates the executable product name:

swift-package-manager/Sources/Build/BuildManifest/LLBuildManifestBuilder+Product.swift

Lines 149 to 154 in 1d637b3

	fileprivate func executableName(
	for product: String,
	buildParameters: BuildParameters
	) -> String {
	"\(llbuildNameWithoutExtension(for: product, buildParameters: buildParameters)).exe"
	}

Needs to take in to account the platform, i.e:

fileprivate func executableName(
    for product: String,
    buildParameters: BuildParameters
) -> String {
    if buildParameters.triple.isWindows() {
        "\(llbuildNameWithoutExtension(for: product, buildParameters: buildParameters)).exe"
    } else {
        "\(llbuildNameWithoutExtension(for: product, buildParameters: buildParameters))"
    }
}

[dschaefer2]

Yup, I was adding in the plugins but not the plugin tools that they invoke. I'll look for a way to do that. I assume we'll want to run them so they can generate code for proper indexing.