buenaflor/kflogger

Experimental Google's Flogger port to Kotlin Multiplatform

Hi there 👋, I am Giancarlo.

Check out my portfolio here

Work

Google Summer of Code

• ☀️ Google Summer of Code 2023 @ Kotlin Foundation
• 🪵 Worked on KFlogger, the Kotlin Multiplatform version of Google's logging tool Flogger. Read about it here.
• 📚 Read about my proposal here

sentry.io

• 🔭 Core maintainer of the Sentry Kotlin Multiplatform SDK
• 📦 Maintaining the Sentry Dart/Flutter SDK

Education

• 🎓 Vienna University of Technology BSc

Email

• 📫 How to reach me: [email protected]

kflogger's Issues

FluentLogger.java migration to Kotlin JVM leads to exception when used in Kotlin

Migrating FluentLogger.java to Kotlin JVM is simple and straightforward, however using FluentLogger.forEnclosingClass() in Kotlin modules leads to Exception in thread "main" java.lang.IllegalStateException: no caller found on the stack for: com.buenaflor.kflogger.FluentLogger where as in Java modules it works as intended.

However, the unmodified Java version: FluentLogger.java works in both Kotlin and Java modules.

The cause of this would be this function inside forEnclosingClass():

Platform.getCallerFinder().findLoggingClass(FluentLogger::class.java)

After investigation, it would use this function to retrieve the logging class: https://github.com/google/flogger/blob/13e8ba1a08641c8e0561e0eda6edb2bf5b658d8c/api/src/main/java/com/google/common/flogger/util/JavaLangAccessStackGetter.java#L34C28-L34C36

Additional Info

Kotlin version:

@JvmStatic
public actual fun forEnclosingClass(): FluentLogger {
    val loggingClass = Platform.getCallerFinder().findLoggingClass(
        FluentLogger::class.java
    )
    return FluentLogger(Platform.getBackend(loggingClass))
}

Java version:

  public static FluentLogger forEnclosingClass() {
    String loggingClass = Platform.getCallerFinder().findLoggingClass(FluentLogger.class);
    return new FluentLogger(Platform.getBackend(loggingClass));
  }

Add common tests to make sure that JVM doesn't crash

Currently only the original JVM Flogger tests are run but it doesn't test if the common code compiles and doesn't crash.

Especially since we have to suppress a lot of the typealiases, we have to make sure that nothing crashes unexpectedly.

Flogger Kotlin JVM migrations tracker

List of Flogger files that are available in commonMain:

• LogData
• LoggerBackend
• Metadata
• AbstractLogger
• FluentLogger
• LoggingApi
• LoggingScope (missing expects)
• LoggingScopeProvider
• LogPerBucketingStrategy
• LogSite
• LogSiteKey
• MetadataKey (missing expects)
• StackSize
• LogContext
• MessageParser
• PrintfMessageParser and DefaultPrintfMessageParser
• Parameter
• AbstractBackend
• BackendFactory
• Platform

Add comments to suppressed errors in the JVM actuals

It should be clear what exactly is being suppressed and why