Merge branch 'main' into jj/crashlytics-sample

Author: kpgalligan

.github/workflows/deploy.yml

@@ -1,48 +1,77 @@
 name: deploy
 on: workflow_dispatch
-#on:
-#  pull_request:
-#    branches:
-#      - main
-#  push:
-#    branches:
-#      - main
 
 jobs:
-  build:
-    strategy:
-      matrix:
-        os: [macOS-latest]
-    runs-on: ${{matrix.os}}
+#  find-release:
+#    runs-on: ubuntu-latest
+#    steps:
+#      - name: Checkout the repo
+#        uses: actions/checkout@v2
+#      - name: Read version from gradle.properties
+#        id: read_version
+#        uses: christian-draeger/read-properties@1.0.1
+#        with:
+#          path: './gradle.properties'
+#          property: 'VERSION_NAME'
+
+  deploy:
+    runs-on: macOS-latest
     steps:
       - name: Checkout the repo
         uses: actions/checkout@v2
+
+      - name: Read gradle.properties
+        id: props
+        uses: juliangruber/read-file-action@v1
+        with:
+          path: ./gradle.properties
+
+      - uses: actions-ecosystem/action-regex-match@v2
+        id: version-match
+        with:
+          text: ${{ steps.props.outputs.content }}
+          regex: '^VERSION_NAME=(.*?)$'
+          flags: gm
+
+      - name: Echo Version
+        run: echo ${{ steps.version-match.outputs.group1 }}
+
       - uses: actions/setup-java@v2
         with:
           distribution: "adopt"
           java-version: "11"
+
       - name: Validate Gradle Wrapper
         uses: gradle/wrapper-validation-action@v1
+
       - name: Cache gradle
         uses: actions/cache@v2
         with:
           path: ~/.gradle/caches
           key: ${{ runner.os }}-gradle-${{ hashFiles('*.gradle.kts') }}
           restore-keys: |
             ${{ runner.os }}-gradle-
+
       - name: Cache konan
         uses: actions/cache@v2
         with:
           path: ~/.konan
           key: ${{ runner.os }}-gradle-${{ hashFiles('*.gradle.kts') }}
           restore-keys: |
             ${{ runner.os }}-gradle-
-      - name: Publish Mac Artifacts
-        if: matrix.os == 'macOS-latest'
-        run: ./gradlew publish --no-daemon --stacktrace
+
+      - name: Publish
+        run: ./gradlew publish --no-daemon --stacktrace --no-build-cache
         env:
-          ORG_GRADLE_PROJECT_SONATYPE_NEXUS_USERNAME: ${{ secrets.SONATYPE_NEXUS_USERNAME }}
-          ORG_GRADLE_PROJECT_SONATYPE_NEXUS_PASSWORD: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}
-          ORG_GRADLE_PROJECT_SIGNING_KEY: ${{ secrets.SIGNING_KEY }}
+          ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_NEXUS_USERNAME }}
+          ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}
+          ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_KEY }}
+
+      - name: Create Release
+        if: ${{ contains(steps.version-match.outputs.group1, 'SNAPSHOT') == false }}
+        uses: touchlab/release-action@v1.10.0
+        with:
+          tag: ${{ steps.version-match.outputs.group1 }}
+
 env:
   GRADLE_OPTS: -Dkotlin.incremental=false -Dorg.gradle.jvmargs="-Xmx3g -XX:MaxPermSize=2048m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8 -XX:MaxMetaspaceSize=512m"

README.md

@@ -4,9 +4,10 @@ Thin library that provides symbolicated crash reports for Kotlin code on iOS. Su
 
 To use crash reporting with general logging support, check out [Kermit](https://github.com/touchlab/Kermit/).
 
-> ## **We're Hiring!**
+> ## Subscribe!
 >
-> Touchlab is looking for a Mobile Developer, with Android/Kotlin experience, who is eager to dive into Kotlin Multiplatform Mobile (KMM) development. Come join the remote-first team putting KMM in production. [More info here](https://go.touchlab.co/careers-gh).
+> We build solutions that get teams started smoothly with Kotlin Multiplatform Mobile and ensure their success in production. Join our community to learn how your peers are adopting KMM.
+ [Sign up here](https://go.touchlab.co/newsletter-gh)!
 
 ## The Problem
 
@@ -55,7 +56,7 @@ CrashlyticsKotlin.setCustomValue("someKey", "someValue")
 
 ### Testing
 
-You test code should not call `enableCrashlytics()`. Before calling `enableCrashlytics()`, calls to `CrashlyticsKotlin` are all no-ops. Also, on iOS, avoiding `enableCrashlytics()` means you don't need to worry about Crashlytics linker issues.
+Your test code should not call `enableCrashlytics()`. Before calling `enableCrashlytics()`, calls to `CrashlyticsKotlin` are all no-ops. Also, on iOS, avoiding `enableCrashlytics()` means you don't need to worry about Crashlytics linker issues.
 
 ### Linking
 
@@ -74,7 +75,13 @@ Undefined symbols for architecture x86_64:
 ld: symbol(s) not found for architecture x86_64
 ```
 
-To resolve this, you should tell the linker that Crashlytics will be added later. To do that, call `crashlyticsLinkerConfig()` in the `kotlin` section of your `build.gradle.kts`.
+To resolve this, you should tell the linker that Crashlytics will be added later. To do that, add a Gradle plugin that will configure your linker settings.
+
+```kotlin
+plugins {
+  id("co.touchlab.crashkios.crashlyticslink") version "x.y.z"
+}
+```
 
 ## Bugsnag Usage
 
@@ -161,4 +168,20 @@ Undefined symbols for architecture x86_64:
 ld: symbol(s) not found for architecture x86_64
 ```
 
-To resolve this, you should tell the linker that Bugsnag will be added later. To do that, call `bugsnagLinkerConfig()` in the `kotlin` section of your `build.gradle.kts`.
+To resolve this, you should tell the linker that Bugsnag will be added later. To do that, add a Gradle plugin that will configure your linker settings.
+
+```kotlin
+plugins {
+  id("co.touchlab.crashkios.bugsnaglink") version "x.y.z"
+}
+```
+
+## NSExceptionKt
+
+CrashKiOS and Kermit previously created 2 reports on a crash because none of the crash reporting clients had an obvious way to do one. [Rick Clephas](https://github.com/rickclephas) has done some excellent work figuring that out with [NSExceptionKt](https://github.com/rickclephas/NSExceptionKt). CrashKiOS now uses part of that library as a base and we've merged the cinterop from Kermit and NSExeptionKt to handle crashes as well as breadcrumb values and log statements.
+
+## Getting Help
+
+CrashKiOS support can be found in the Kotlin Community Slack, [request access here](http://slack.kotlinlang.org/). Post in the "[#touchlab-tools](https://kotlinlang.slack.com/archives/CTJB58X7X)" channel.
+
+For direct assistance, please [contact Touchlab](https://go.touchlab.co/contactus-gh) to discuss support options.

bugsnag-ios-link/build.gradle.kts

@@ -0,0 +1,72 @@
+/*
+ * Copyright (c) 2022 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.
+ */
+
+plugins {
+    `kotlin-dsl`
+    kotlin("jvm")
+    id("java-gradle-plugin")
+    id("com.vanniktech.maven.publish.base")
+    id("com.gradle.plugin-publish") version "1.0.0"
+}
+
+repositories {
+    gradlePluginPortal()
+    mavenCentral()
+}
+
+gradlePlugin {
+    plugins {
+        register("bugsnag-ios-link-plugin") {
+            id = "co.touchlab.crashkios.bugsnaglink"
+            implementationClass = "co.touchlab.crashkios.BugsnagLinkPlugin"
+            displayName = "Bugsnag iOS Link Plugin"
+        }
+    }
+}
+
+pluginBundle {
+    website = "https://github.com/touchlab/CrashKiOS"
+    vcsUrl = "https://github.com/touchlab/CrashKiOS.git"
+
+    description = "CrashKiOS linker params for Bugsnag on iOS"
+
+    tags = listOf("kmm", "kotlin", "multiplatform", "mobile", "ios")
+}
+
+dependencies {
+    implementation(kotlin("stdlib-jdk8"))
+    implementation(gradleApi())
+    implementation(kotlin("gradle-plugin"))
+    implementation(kotlin("compiler-embeddable"))
+
+    testImplementation(kotlin("test"))
+}
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = JavaVersion.VERSION_1_8
+}
+
+val GROUP: String by project
+val VERSION_NAME: String by project
+
+group = GROUP
+version = VERSION_NAME
+
+mavenPublishing {
+    publishToMavenCentral()
+    val releaseSigningEnabled =
+        project.properties["RELEASE_SIGNING_ENABLED"]?.toString()?.equals("false", ignoreCase = true) != true
+    if (releaseSigningEnabled) signAllPublications()
+    pomFromGradleProperties()
+}

bugsnag-ios-link/src/main/kotlin/co/touchlab/crashkios/BugsnagLinkPlugin.kt

@@ -0,0 +1,54 @@
+/*
+ * Copyright (c) 2022 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.crashkios
+
+import org.gradle.api.*
+import org.gradle.kotlin.dsl.*
+import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension
+import org.jetbrains.kotlin.gradle.plugin.mpp.Framework
+import java.io.*
+import java.util.*
+
+internal val Project.kotlinExtension: KotlinMultiplatformExtension get() = extensions.getByType()
+
+@Suppress("unused")
+class BugsnagLinkPlugin : Plugin<Project> {
+    override fun apply(project: Project): Unit = with(project) {
+        afterEvaluate {
+            project.kotlinExtension.crashLinkerConfig(
+                "-U _OBJC_CLASS_\$_Bugsnag " +
+                        "-U _OBJC_CLASS_\$_BugsnagStackframe " +
+                        "-U _OBJC_CLASS_\$_FIRStackFrame " +
+                        "-U _OBJC_CLASS_\$_BugsnagFeatureFlag " +
+                        "-U _OBJC_CLASS_\$_BugsnagError"
+            )
+        }
+    }
+}
+
+private fun KotlinMultiplatformExtension.crashLinkerConfig(linkerOpts: String) {
+    targets.withType(org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget::class.java)
+        .map { target ->
+            val mainCompilation = target.compilations.getByName("main")
+            val dynamicFrameworks =
+                target.binaries.filterIsInstance<Framework>().filter { framework -> !framework.isStatic }
+
+            Pair(mainCompilation, dynamicFrameworks)
+        }
+        .forEach { pair ->
+            if (!pair.second.isEmpty()) {
+                pair.first.kotlinOptions.freeCompilerArgs += listOf("-linker-options", linkerOpts)
+            }
+        }
+}

bugsnag/build.gradle.kts

@@ -68,7 +68,7 @@ kotlin {
     val androidMain by sourceSets.getting {
         dependencies {
             implementation("org.jetbrains.kotlin:kotlin-stdlib")
-            implementation("com.bugsnag:bugsnag-android:$BUGSNAG_ANDROID_VERSION")
+            compileOnly("com.bugsnag:bugsnag-android:$BUGSNAG_ANDROID_VERSION")
         }
     }
 

core/src/darwinMain/kotlin/co/touchlab/crashkios/core/ThreadSafeVar.kt

@@ -4,6 +4,7 @@ import kotlin.native.concurrent.AtomicReference
 import kotlin.native.concurrent.freeze
 import kotlin.reflect.KProperty
 
+@OptIn(FreezingIsDeprecated::class)
 actual class ThreadSafeVar<T> actual constructor(target: T) {
     private val atom = AtomicReference(target)
 

crashlytics-ios-link/build.gradle.kts

@@ -0,0 +1,72 @@
+/*
+ * Copyright (c) 2022 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.
+ */
+
+plugins {
+    `kotlin-dsl`
+    kotlin("jvm")
+    id("java-gradle-plugin")
+    id("com.vanniktech.maven.publish.base")
+    id("com.gradle.plugin-publish") version "1.0.0"
+}
+
+repositories {
+    gradlePluginPortal()
+    mavenCentral()
+}
+
+gradlePlugin {
+    plugins {
+        register("crashlytics-ios-link-plugin") {
+            id = "co.touchlab.crashkios.crashlyticslink"
+            implementationClass = "co.touchlab.crashkios.CrashlyticsLinkPlugin"
+            displayName = "Crashlytics iOS Link Plugin"
+        }
+    }
+}
+
+pluginBundle {
+    website = "https://github.com/touchlab/CrashKiOS"
+    vcsUrl = "https://github.com/touchlab/CrashKiOS.git"
+
+    description = "CrashKiOS linker params for Crashlytics on iOS"
+
+    tags = listOf("kmm", "kotlin", "multiplatform", "mobile", "ios")
+}
+
+dependencies {
+    implementation(kotlin("stdlib-jdk8"))
+    implementation(gradleApi())
+    implementation(kotlin("gradle-plugin"))
+    implementation(kotlin("compiler-embeddable"))
+
+    testImplementation(kotlin("test"))
+}
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = JavaVersion.VERSION_1_8
+}
+
+val GROUP: String by project
+val VERSION_NAME: String by project
+
+group = GROUP
+version = VERSION_NAME
+
+mavenPublishing {
+    publishToMavenCentral()
+    val releaseSigningEnabled =
+        project.properties["RELEASE_SIGNING_ENABLED"]?.toString()?.equals("false", ignoreCase = true) != true
+    if (releaseSigningEnabled) signAllPublications()
+    pomFromGradleProperties()
+}