Name collisions caused by the module name being Datadog + having a class named Datadog + having a class named Logger

[bsrz]

The issue

Apple introduced a new Logger class in iOS 14, and most project have some kind of Logger class as a layer of abstraction.

import Datadog

let logger: Logger // ❗ ambiguous class name

import Datadog

let logger: Datadog.Logger // ❗ the compile thinks we're talking about the class, which doesn't have a nested class named `Logger` therefore cannot find class `Datadog.Logger`

import class Datadog.Logger 

let logger: Datadog.Logger // ✅
let config: Datadog.Configuration // ❗ import statement only imports the Logger class, unknown `Datadog.Configuration` class
let context: Datadog.AppContext // ❗ import statement only imports the Logger class, unknown `Datadog.Configuration` class

This is just an annoying import dance cause solely by the fact that the module contains a class of the same name.

---

Datadog SDK version:

_Which version of the Datadog SDK causes this problem?
1.3.1

Last working Datadog SDK version:

_What is the last Datadog SDK version where this problem didn't occur?
n/a

Dependency Manager:

_Which dependency manager do you use?
Cocoapods

Xcode version:

Xcode 11.7 (11E801a)

Swift version:

5.2.4

The Solution

Rename the module to DatadogSDK or any other name than the Datadog class.
Or rename the Datadog class to something like DatadogClient.

[ncreated]

Hey @bsarrazin 👋. Thanks for using Datadog 🙂! To avoid the name collision and compiler ambiguity we provide the DDLogger typealias:

dd-sdk-ios/Sources/Datadog/Logger.swift

Lines 79 to 89 in cbb9342

	/// Usage:
	///
	/// import Datadog
	///
	/// // logger reference
	/// var logger: DDLogger!
	///
	/// // instantiate Datadog logger
	/// logger = DDLogger.builder.build()
	///
	public typealias DDLogger = Logger

which may be used as a workaround.

But the argument on Apple's Logger is totally valid and we may want to consider tackling it in some other way. Let me know if it fixes the issue for now 🙌.

[bsrz]

@ncreated thanks for that, I definitely missed that alias.
That fixed it as a workaround, thank you 👍

[ncreated]

Thanks for the update @bsarrazin 👌. Because this is a 3rd GH Issue on this topic (1st, 2nd) I have bumped the priority of this enhancement in our backlog. No exact ETA, but this should be addressed soon. Feel free to close this issue if you consider it solved.

[simonpierreroy]

Renaming the Datadog class would also remove the need to add global typealias (For Global and LogLevel) since Datadog.XYZ could be used instead. My team copied the repository internally and renamed the class...

[maxep]

Fixed in 2.0.