Logging module name clash in Vapor 3

[tanner0101 (Tanner)]

@IanPartridge

I'm very sorry that this breakage has occurred. It did not occur to us that adding a dependency in SemVer minor could break people like this

No worries, not IBM’s fault at all. We predicted this issue when apple/swift-log was in the proposal stage. It’s vapor’s fault for picking an overly generic module name for the logging module.

@Max_Howell1

Solving it at the build-system layer is the only necessary bit IMO. Like ideally you could namespace imports in your sources, but that’s nice-to-have, this is a real problem.

I guess this would require driver changes, since you’d have to map swift source module names to some kind of prefixed module name to allow overlap. Not a trivial task. But in pursuit of stable graphs, it seems important .

Yeah I agree, this is something that needs to be handled by Swift / SPM. It will take some time to get proper name spacing though. Until then, it’s up to the SSWG to try and prevent this as much as possible going forward. And we are working really hard to do that, especially @johannesweiss who has written a lot about this.

The only unfortunate part is that fixing past mistakes is difficult. Vapor 3 should not have used the overly general name Logging. Hindsight is 20/20 of course. In the next major version of Vapor, we’ve dropped our Logging module altogether in favor of the Apple one.

We should continue the more broad discussion of namespacing here:

Namespacing of packages/modules, especially regarding SwiftNIO

First of all, I apologise for bringing this up only now but I believe this is very important for the long-term health ecosystem and it's not too late yet. What's the issue? In a given Swift(PM) application, 3 things about a package need to be unique across the whole application: it's package basename (for example swift-nio-http2) it's package name (let package = Package(name: "swift-nio", ...) in Package.swift) all module names Arguably, that can lead to tricky issues when combining multipl…

Or in a new thread.

This thread should be dedicated specifically to the Logging module clash between Vapor 3 and apple/swift-log, and known workarounds / solutions.