Kpg/emoji writer (#185)

* Emoji Xcode log

* Fix cinterop for Xcode 13

* Clean up Xcode logging

* bump api

gradle.properties

@@ -14,7 +14,7 @@ android.useAndroidX=true
 org.gradle.jvmargs=-Xmx2g
 
 GROUP=co.touchlab
-VERSION_NAME=1.0.0-rc4
+VERSION_NAME=1.0.0-SNAPSHOT
 KOTLIN_VERSION=1.5.31
 
 STATELY_VERSION=1.2.0-nmm

gradle/configure-crash-logger.gradle

@@ -40,6 +40,7 @@ kotlin {
     ].forEach { target ->
         target.compilations.main.cinterops.create(project.name) {
             includeDirs("$projectDir/src/include")
+            compilerOpts("-DNS_FORMAT_ARGUMENT(A)=")
             if (printCInteropKotlin) {
                 extraOpts = listOf("-mode", "sourcecode")
             }

kermit-bugsnag/src/include/Bugsnag.h

@@ -105,7 +105,8 @@ typedef NS_ENUM(NSUInteger, BSGBreadcrumbType) {
  * a type.
  *
  * @param message The log message to leave.
- * @param metadata Additional metadata included with the breadcrumb.
+ * @param metadata Diagnostic data relating to the breadcrumb.
+ *                 Values should be serializable to JSON with NSJSONSerialization.
  * @param type A BSGBreadcrumbTypeValue denoting the type of breadcrumb.
  */
 + (void)leaveBreadcrumbWithMessage:(NSString *_Nonnull)message

kermit/api/android/kermit.api

@@ -5,8 +5,9 @@ public final class co/touchlab/kermit/BuildConfig {
 	public fun <init> ()V
 }
 
-public final class co/touchlab/kermit/CommonWriter : co/touchlab/kermit/LogWriter {
+public class co/touchlab/kermit/CommonWriter : co/touchlab/kermit/LogWriter {
 	public fun <init> ()V
+	public fun formatMessage (Lco/touchlab/kermit/Severity;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Throwable;)Ljava/lang/String;
 	public fun log (Lco/touchlab/kermit/Severity;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Throwable;)V
 }
 

kermit/api/jvm/kermit.api

@@ -1,5 +1,6 @@
-public final class co/touchlab/kermit/CommonWriter : co/touchlab/kermit/LogWriter {
+public class co/touchlab/kermit/CommonWriter : co/touchlab/kermit/LogWriter {
 	public fun <init> ()V
+	public fun formatMessage (Lco/touchlab/kermit/Severity;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Throwable;)Ljava/lang/String;
 	public fun log (Lco/touchlab/kermit/Severity;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Throwable;)V
 }
 

kermit/src/commonMain/kotlin/co/touchlab/kermit/CommonWriter.kt

@@ -13,9 +13,11 @@
 
 package co.touchlab.kermit
 
-class CommonWriter : LogWriter() {
+open class CommonWriter : LogWriter() {
     override fun log(severity: Severity, message: String, tag: String, throwable: Throwable?) {
-        println("$severity: ($tag) $message")
+        println(formatMessage(severity, message, tag, throwable))
         throwable?.printStackTrace()
     }
+
+    open fun formatMessage(severity: Severity, message: String, tag: String, throwable: Throwable?): String = "$severity: ($tag) $message"
 }

kermit/src/darwinMain/kotlin/co/touchlab/kermit/XcodeSeverityWriter.kt

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2021 Touchlab
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+
+package co.touchlab.kermit
+
+import platform.Foundation.*
+
+open class XcodeSeverityWriter : CommonWriter() {
+    private val df:NSDateFormatter = NSDateFormatter().apply {
+        dateFormat = "HH:mm:ss.SSS"
+    }
+
+    override fun formatMessage(severity: Severity, message: String, tag: String, throwable: Throwable?): String =
+        "${df.stringFromDate(NSDate.now)} ${emojiPrefix(severity)} $severity: ($tag) $message"
+
+    //If this looks familiar, yes, it came directly from Napier :) https://github.com/AAkira/Napier#darwinios-macos-watchos-tvosintelapple-silicon
+    open fun emojiPrefix(severity: Severity): String = when (severity) {
+        Severity.Verbose -> "⚪️"
+        Severity.Debug -> "🔵"
+        Severity.Info -> "🟢"
+        Severity.Warn -> "🟡"
+        Severity.Error -> "🔴"
+        Severity.Assert -> "🟤️"
+    }
+}

kermit/src/darwinMain/kotlin/co/touchlab/kermit/platformLogWriter.kt

@@ -10,6 +10,6 @@
 
 package co.touchlab.kermit
 
-//Using CommonWriter instead of NSLogWriter because NSLog truncates stack trace prints: https://stackoverflow.com/a/39538500/227313
+//Using EmojiSeverityWriter (base CommonWriter) instead of NSLogWriter because NSLog truncates stack trace prints: https://stackoverflow.com/a/39538500/227313
 //Cutting off the stack trace makes local dev difficult when you get a Kotlin exception.
-actual fun platformLogWriter(): LogWriter = CommonWriter()
+actual fun platformLogWriter(): LogWriter = XcodeSeverityWriter()

samples/sample/KermitSampleIOS/KermitSampleIOS/AppDelegate.swift

@@ -16,7 +16,7 @@ import shared
 @UIApplicationMain
 class AppDelegate: UIResponder, UIApplicationDelegate {
 
-    let kermit:Logger = Logger(config: StaticConfig(minSeverity: .verbose, logWriterList: [NSLogWriter(), OSLogWriter()]), tag: "iosTag")
+    let kermit:Logger = Logger.companion
 
 
     func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

samples/sample/KermitSampleIOS/KermitSampleIOS/ContentView.swift

@@ -29,9 +29,49 @@ struct ContentView: View {
     var body: some View {
         VStack(spacing: 50){
             Button(action: {
-                self.common.onClick()
+                self.common.onClickV()
             }){
-                Text("Click Count").padding()
+                Text("Click Count V").padding()
+                .background(Color.blue)
+                .foregroundColor(.white)
+                .font(.title)
+            }
+            Button(action: {
+                self.common.onClickD()
+            }){
+                Text("Click Count D").padding()
+                .background(Color.blue)
+                .foregroundColor(.white)
+                .font(.title)
+            }
+            Button(action: {
+                self.common.onClickI()
+            }){
+                Text("Click Count I").padding()
+                .background(Color.blue)
+                .foregroundColor(.white)
+                .font(.title)
+            }
+            Button(action: {
+                self.common.onClickW()
+            }){
+                Text("Click Count W").padding()
+                .background(Color.blue)
+                .foregroundColor(.white)
+                .font(.title)
+            }
+            Button(action: {
+                self.common.onClickE()
+            }){
+                Text("Click Count E").padding()
+                .background(Color.blue)
+                .foregroundColor(.white)
+                .font(.title)
+            }
+            Button(action: {
+                self.common.onClickA()
+            }){
+                Text("Click Count A").padding()
                 .background(Color.blue)
                 .foregroundColor(.white)
                 .font(.title)

samples/sample/KermitSampleIOS/Podfile.lock

@@ -13,4 +13,4 @@ SPEC CHECKSUMS:
 
 PODFILE CHECKSUM: eb18a5a396ff91b77d2f3b607dba9c4cf5f57893
 
-COCOAPODS: 1.10.1
+COCOAPODS: 1.11.2

samples/sample/build.gradle.kts

@@ -11,6 +11,7 @@ buildscript {
     repositories {
         google()
         mavenCentral()
+        maven(url = "https://oss.sonatype.org/content/repositories/snapshots")
     }
     extra.apply {
         val parentKermit = java.util.Properties().apply { load(java.io.StringReader(File("${projectDir.path}/../../gradle.properties").readText())) }.get("VERSION_NAME") as String
@@ -27,6 +28,7 @@ allprojects {
     repositories {
         mavenLocal()
         mavenCentral()
+        maven(url = "https://oss.sonatype.org/content/repositories/snapshots")
         google()
     }
 }

samples/sample/shared/src/commonMain/kotlin/co/touchlab/kermitsample/SampleCommon.kt

@@ -14,11 +14,35 @@ import co.touchlab.kermit.Logger
 
 class SampleCommon(private val logger: Logger) {
     private var count = 0
-    fun onClick() {
+    fun onClickI() {
         count++
         logger.i { "Common click count: $count" }
     }
 
+    fun onClickW() {
+        count++
+        logger.w { "Common click count: $count" }
+    }
+
+    fun onClickE() {
+        count++
+        logger.e { "Common click count: $count" }
+    }
+
+    fun onClickA() {
+        count++
+        logger.a { "Common click count: $count" }
+    }
+
+    fun onClickD() {
+        count++
+        logger.d { "Common click count: $count" }
+    }
+    fun onClickV() {
+        count++
+        logger.v { "Common click count: $count" }
+    }
+
     fun logException(){
         logger.w(throwable = Exception("Handled")) { "Common click count: $count" }
     }