chore: add detekt & dokka (#86)

* add detekt

* apply detekt changes

* add dokka

* add dokka action

* update dokka action

* depend generate-dokka on build

* update scope naming:

* update scope doc

* update ScopeDecorator docs

* add detekt make target

* Format code

* add detekt to .PHONY

* update Scope

* update API

* fix format

* update tests

* add changelog

* add separate workflow for generate dokka

* Remove Suppress annotations

* ignore forbidden comments and revert changelog

* exclude Attachment from unused private member

* Add baseline task

* Update generate-dokka.yml

* Update detekt.yml

---------

Co-authored-by: Sentry Github Bot <[email protected]>

Author: buenaflor

.github/workflows/generate-dokka.yml

@@ -0,0 +1,52 @@
+name: Generate Dokka
+
+on:
+  release:
+    types: [released]
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  generate-dokka:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          distribution: "adopt"
+          java-version: "11"
+
+      - name: Cache Gradle packages
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+
+      - name: Generate docs with dokka
+        run: make generateDokka
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: ${{ github.workspace }}/build/dokka/htmlMultiModule
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

Makefile

@@ -1,4 +1,4 @@
-.PHONY: all clean compile dryRelease checkFormat checkApi buildAppleSamples format stop
+.PHONY: all clean compile dryRelease checkFormat checkApi buildAppleSamples generateDokka detekt format stop
 
 all: stop clean compile
 
@@ -11,6 +11,14 @@ clean:
 dryRelease:
 	./gradlew publishToMavenLocal --no-daemon --no-parallel
 
+# Run detekt
+detekt:
+	./gradlew detekt
+
+# Generate Dokka
+generateDokka:
+	./gradlew dokkaHtmlMultiModule
+
 # Check API
 checkApi:
 	./gradlew apiCheck
@@ -40,7 +48,7 @@ buildAppleSamples:
 
 
 # Build all targets, run tests and checks api
-compile: checkApi buildProject buildAppleSamples
+compile: checkApi detekt buildProject buildAppleSamples
 
 # We stop gradle at the end to make sure the cache folders
 # don't contain any lock files and are free to be cached.

build.gradle.kts

@@ -1,10 +1,13 @@
 import com.diffplug.spotless.LineEnding
 import com.vanniktech.maven.publish.MavenPublishPlugin
 import com.vanniktech.maven.publish.MavenPublishPluginExtension
+import io.gitlab.arturbosch.detekt.Detekt
 
 plugins {
     id(Config.gradleMavenPublishPlugin).version(Config.gradleMavenPublishPluginVersion)
     id(Config.QualityPlugins.spotless).version(Config.QualityPlugins.spotlessVersion)
+    id(Config.QualityPlugins.detekt).version(Config.QualityPlugins.detektVersion)
+    id(Config.dokka).version(Config.dokkaVersion)
     kotlin(Config.multiplatform).version(Config.kotlinVersion).apply(false)
     kotlin(Config.cocoapods).version(Config.kotlinVersion).apply(false)
     id(Config.jetpackCompose).version(Config.composeVersion).apply(false)
@@ -52,6 +55,12 @@ subprojects {
     }
 }
 
+subprojects {
+    if (project.name.contains("sentry-kotlin-multiplatform")) {
+        apply(plugin = Config.dokka)
+    }
+}
+
 spotless {
     lineEndings = LineEnding.UNIX
 
@@ -64,3 +73,39 @@ spotless {
         ktlint()
     }
 }
+
+val detektConfigFilePath = "$rootDir/config/detekt/detekt.yml"
+val detektBaselineFilePath = "$rootDir/config/detekt/baseline.xml"
+
+detekt {
+    buildUponDefaultConfig = true
+    config = files(detektConfigFilePath)
+    baseline = file(detektBaselineFilePath)
+}
+
+fun SourceTask.detektExcludes() {
+    exclude("**/build/**")
+    exclude("**/*.kts")
+    exclude("**/buildSrc/**")
+    exclude("**/*Test*/**")
+    exclude("**/resources/**")
+    exclude("**/sentry-samples/**")
+}
+
+tasks.withType<Detekt>().configureEach {
+    reports {
+        html.required.set(true)
+    }
+    setSource(files(project.projectDir))
+    detektExcludes()
+}
+
+/** Task for generating a Detekt baseline.xml */
+val detektProjectBaseline by tasks.registering(io.gitlab.arturbosch.detekt.DetektCreateBaselineTask::class) {
+    buildUponDefaultConfig.set(true)
+    setSource(files(rootDir))
+    config.setFrom(files(detektConfigFilePath))
+    baseline.set(file(detektBaselineFilePath))
+    include("**/*.kt")
+    detektExcludes()
+}

buildSrc/src/main/java/Config.kt

@@ -10,6 +10,8 @@ object Config {
     val gradleMavenPublishPlugin = "com.vanniktech.maven.publish"
     val androidGradle = "com.android.library"
     val kotlinSerializationPlugin = "plugin.serialization"
+    val dokka = "org.jetbrains.dokka"
+    val dokkaVersion = "1.8.10"
 
     object BuildPlugins {
         val buildConfig = "com.codingfeline.buildkonfig"
@@ -19,6 +21,8 @@ object Config {
     object QualityPlugins {
         val spotless = "com.diffplug.spotless"
         val spotlessVersion = "6.11.0"
+        val detekt = "io.gitlab.arturbosch.detekt"
+        val detektVersion = "1.22.0"
         val binaryCompatibility = "org.jetbrains.kotlinx.binary-compatibility-validator"
         val binaryCompatibilityVersion = "0.13.1"
     }

config/detekt/baseline.xml

@@ -0,0 +1,11 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<SmellBaseline>
+  <ManuallySuppressedIssues/>
+  <CurrentIssues>
+    <ID>SwallowedException:CocoaScopeProvider.kt$CocoaScopeProvider$e: Throwable</ID>
+    <ID>SwallowedException:SentryLevel.kt$SentryLevel.Companion$throwable: Throwable</ID>
+    <ID>TooGenericExceptionCaught:CocoaScopeProvider.kt$CocoaScopeProvider$e: Throwable</ID>
+    <ID>TooGenericExceptionCaught:SentryLevel.kt$SentryLevel.Companion$throwable: Throwable</ID>
+    <ID>TooGenericExceptionThrown:SentryKMP.kt$Sentry$throw RuntimeException("Uncaught Exception from Kotlin Multiplatform.")</ID>
+  </CurrentIssues>
+</SmellBaseline>

config/detekt/detekt.yml

@@ -0,0 +1,26 @@
+comments:
+  UndocumentedPublicClass:
+    active: true
+    includes: "**/commonMain/**"
+  UndocumentedPublicProperty:
+    active: true
+    includes: "**/commonMain/**"
+style:
+  UnnecessaryAbstractClass:
+    active: false
+  ForbiddenComment:
+    active: false
+  UnusedPrivateMember:
+    excludes:
+      - "**/Attachment.kt"
+complexity:
+  TooManyFunctions:
+    excludes: [
+      "**/SentryKMP.kt",
+      "**/SentryBridge.kt",
+      "**/CocoaScopeProvider.kt",
+      "**/Scope.kt",
+      "**/JvmScopeProvider.kt",
+      "**/Breadcrumb.kt",
+    ]
+    

sentry-kotlin-multiplatform/api/android/sentry-kotlin-multiplatform.api

@@ -45,34 +45,7 @@ public final class io/sentry/kotlin/multiplatform/HttpStatusCodeRange {
 public final class io/sentry/kotlin/multiplatform/HttpStatusCodeRange$Companion {
 }
 
-public final class io/sentry/kotlin/multiplatform/Scope : io/sentry/kotlin/multiplatform/ScopeProvider {
-	public fun <init> (Lio/sentry/kotlin/multiplatform/ScopeProvider;)V
-	public fun addAttachment (Lio/sentry/kotlin/multiplatform/Attachment;)V
-	public fun addBreadcrumb (Lio/sentry/kotlin/multiplatform/protocol/Breadcrumb;)V
-	public fun clear ()V
-	public fun clearAttachments ()V
-	public fun clearBreadcrumbs ()V
-	public fun getContexts ()Ljava/util/Map;
-	public fun getLevel ()Lio/sentry/kotlin/multiplatform/SentryLevel;
-	public fun getTags ()Ljava/util/Map;
-	public fun getUser ()Lio/sentry/kotlin/multiplatform/protocol/User;
-	public fun removeContext (Ljava/lang/String;)V
-	public fun removeExtra (Ljava/lang/String;)V
-	public fun removeTag (Ljava/lang/String;)V
-	public fun setContext (Ljava/lang/String;C)V
-	public fun setContext (Ljava/lang/String;Ljava/lang/Number;)V
-	public fun setContext (Ljava/lang/String;Ljava/lang/Object;)V
-	public fun setContext (Ljava/lang/String;Ljava/lang/String;)V
-	public fun setContext (Ljava/lang/String;Ljava/util/Collection;)V
-	public fun setContext (Ljava/lang/String;Z)V
-	public fun setContext (Ljava/lang/String;[Ljava/lang/Object;)V
-	public fun setExtra (Ljava/lang/String;Ljava/lang/String;)V
-	public fun setLevel (Lio/sentry/kotlin/multiplatform/SentryLevel;)V
-	public fun setTag (Ljava/lang/String;Ljava/lang/String;)V
-	public fun setUser (Lio/sentry/kotlin/multiplatform/protocol/User;)V
-}
-
-public abstract interface class io/sentry/kotlin/multiplatform/ScopeProvider {
+public abstract interface class io/sentry/kotlin/multiplatform/Scope {
 	public abstract fun addAttachment (Lio/sentry/kotlin/multiplatform/Attachment;)V
 	public abstract fun addBreadcrumb (Lio/sentry/kotlin/multiplatform/protocol/Breadcrumb;)V
 	public abstract fun clear ()V

sentry-kotlin-multiplatform/api/jvm/sentry-kotlin-multiplatform.api

@@ -42,34 +42,7 @@ public final class io/sentry/kotlin/multiplatform/HttpStatusCodeRange {
 public final class io/sentry/kotlin/multiplatform/HttpStatusCodeRange$Companion {
 }
 
-public final class io/sentry/kotlin/multiplatform/Scope : io/sentry/kotlin/multiplatform/ScopeProvider {
-	public fun <init> (Lio/sentry/kotlin/multiplatform/ScopeProvider;)V
-	public fun addAttachment (Lio/sentry/kotlin/multiplatform/Attachment;)V
-	public fun addBreadcrumb (Lio/sentry/kotlin/multiplatform/protocol/Breadcrumb;)V
-	public fun clear ()V
-	public fun clearAttachments ()V
-	public fun clearBreadcrumbs ()V
-	public fun getContexts ()Ljava/util/Map;
-	public fun getLevel ()Lio/sentry/kotlin/multiplatform/SentryLevel;
-	public fun getTags ()Ljava/util/Map;
-	public fun getUser ()Lio/sentry/kotlin/multiplatform/protocol/User;
-	public fun removeContext (Ljava/lang/String;)V
-	public fun removeExtra (Ljava/lang/String;)V
-	public fun removeTag (Ljava/lang/String;)V
-	public fun setContext (Ljava/lang/String;C)V
-	public fun setContext (Ljava/lang/String;Ljava/lang/Number;)V
-	public fun setContext (Ljava/lang/String;Ljava/lang/Object;)V
-	public fun setContext (Ljava/lang/String;Ljava/lang/String;)V
-	public fun setContext (Ljava/lang/String;Ljava/util/Collection;)V
-	public fun setContext (Ljava/lang/String;Z)V
-	public fun setContext (Ljava/lang/String;[Ljava/lang/Object;)V
-	public fun setExtra (Ljava/lang/String;Ljava/lang/String;)V
-	public fun setLevel (Lio/sentry/kotlin/multiplatform/SentryLevel;)V
-	public fun setTag (Ljava/lang/String;Ljava/lang/String;)V
-	public fun setUser (Lio/sentry/kotlin/multiplatform/protocol/User;)V
-}
-
-public abstract interface class io/sentry/kotlin/multiplatform/ScopeProvider {
+public abstract interface class io/sentry/kotlin/multiplatform/Scope {
 	public abstract fun addAttachment (Lio/sentry/kotlin/multiplatform/Attachment;)V
 	public abstract fun addBreadcrumb (Lio/sentry/kotlin/multiplatform/protocol/Breadcrumb;)V
 	public abstract fun clear ()V

sentry-kotlin-multiplatform/src/commonAppleMain/kotlin/io/sentry/kotlin/multiplatform/CocoaScopeProvider.kt

@@ -10,7 +10,7 @@ import io.sentry.kotlin.multiplatform.protocol.Breadcrumb
 import io.sentry.kotlin.multiplatform.protocol.User
 import Scope.Sentry.SentryScope as PrivateCocoaScope
 
-internal class CocoaScopeProvider(private val scope: CocoaScope) : ScopeProvider {
+internal class CocoaScopeProvider(private val scope: CocoaScope) : Scope {
 
     /*
      This bridge exposes private Cocoa SDK API to fetch internal properties such as user, level, etc.

sentry-kotlin-multiplatform/src/commonAppleMain/kotlin/io/sentry/kotlin/multiplatform/SentryBridge.kt

@@ -42,7 +42,10 @@ internal actual object SentryBridge {
     }
 
     actual fun captureException(throwable: Throwable, scopeCallback: ScopeCallback): SentryId {
-        val cocoaSentryId = SentrySDK.captureException(throwable.asNSException(true), configureScopeCallback(scopeCallback))
+        val cocoaSentryId = SentrySDK.captureException(
+            throwable.asNSException(true),
+            configureScopeCallback(scopeCallback)
+        )
         return SentryId(cocoaSentryId.toString())
     }
 
@@ -72,8 +75,7 @@ internal actual object SentryBridge {
                 CocoaScopeProvider(it)
             }
             cocoaScopeProvider?.let {
-                val scope = Scope(it)
-                scopeCallback.invoke(scope)
+                scopeCallback.invoke(it)
             }
         }
     }