Merge pull request #2159 from bugsnag/release/v6.12.1

YYChen01988 · web-flow · commit 2546426f5bdb · 2025-03-03T10:14:50.000Z
release v6.12.1
diff --git a/.buildkite/pipeline.full.yml b/.buildkite/pipeline.full.yml
@@ -531,6 +531,7 @@ steps:
     concurrency_method: eager
 
   - label: ':browserstack: Android 10 NDK r21 end-to-end tests - ANRs'
+    skip: All ANR scenarios are skipped on Android 10
     depends_on: "fixture-r21"
     timeout_in_minutes: 30
     plugins:
diff --git a/.buildkite/pipeline.yml b/.buildkite/pipeline.yml
@@ -328,6 +328,7 @@ steps:
     concurrency_method: eager
 
   - label: ':browserstack: Android 10 NDK r21 ANR smoke tests'
+    skip: All ANR scenarios are skipped on Android 10
     depends_on: "fixture-r21"
     timeout_in_minutes: 30
     plugins:
diff --git a/.github/ISSUE_TEMPLATE/A.md b/.github/ISSUE_TEMPLATE/A.md
@@ -1,14 +1,14 @@
 ---
 name: Having trouble getting started?
-about: Please contact us at support@bugsnag.com for assistance with integrating Bugsnag
+about: Please contact us at support@bugsnag.com for assistance with integrating BugSnag
   into your application.
 title: ''
 labels: ''
 assignees: ''
 
 ---
-Please checkout our [documentation](https://docs.bugsnag.com/platforms/android/) for guides, references and tutorials.
+Please check out our [documentation](https://docs.bugsnag.com/platforms/android/) for guides, references and tutorials.
 
-If you have questions about your integration please contact us at [support@bugsnag.com](mailto:support@bugsnag.com).
+If you have questions about your integration, please contact us at [support@bugsnag.com](mailto:support@bugsnag.com).
 
-Alternatively, view additional options at [support.md](../SUPPORT.md).
+Alternatively, view additional options at [SUPPORT.md](../SUPPORT.md).
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -7,7 +7,7 @@ assignees: ''
 
 ---
 
-<!-- Before raising, please check if somebody else has already reported your issue. -->
+<!-- Before raising, please check whether somebody else has already reported your issue. -->
 
 ### Describe the bug
 A clear and concise description of what the bug is.
@@ -20,7 +20,7 @@ A clear and concise description of what the bug is.
 
 ### Environment
 * Android version:
-* Bugsnag version:
+* BugSnag version:
 * Emulator or physical device:
 
 <!--
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -7,7 +7,7 @@ assignees: ''
 
 ---
 
-<!-- Before creating, please check if somebody else has already reported your feature request. -->
+<!-- Before creating, please check whether somebody else has already reported your feature request. -->
 
 ### Description
 <!-- Is your feature request related to a problem? Please describe.
diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md
@@ -0,0 +1,21 @@
+## Are you having trouble getting started?
+If you haven't already, please check out our [documentation](https://docs.bugsnag.com/platforms/android/) for guides, references and tutorials.
+
+Or, if you wish, you can [contact us directly](mailto:support@bugsnag.com) for assistance on integrating BugSnag into your application, troubleshooting an issue, or if you have a question about our supported features.
+
+When contacting support, please include as much information as necessary, including:
+
+- example code snippet
+- steps to reproduce
+- expected/actual behaviour 
+
+* Android version:
+* BugSnag version:
+* Emulator or physical device:
+
+## Bug or Feature Requests
+If you would like to raise a bug or feature request, please do so by creating a [New Issue](https://github.com/bugsnag/bugsnag-android/issues/new/choose) and selecting bug or feature.
+Please note: we cannot promise that we will fulfil all requests
+
+## Pull Requests
+If you have made a fix and would like to raise a pull request, please read our [CONTRIBUTING.md](../CONTRIBUTING.md) file before creating the pull request.
diff --git a/.github/support.md b/.github/support.md
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -64,7 +64,7 @@ jobs:
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@396bb3e45325a47dd9ef434068033c6d5bb0d11a #v3.27.3
+        uses: github/codeql-action/init@b56ba49b26e50535fa1e7f7db0f4f7b4bf65d80d #v3.28.10
         with:
           languages: ${{ matrix.language }}
           # If you wish to specify custom queries, you can do so here or in a config file.
@@ -83,6 +83,6 @@ jobs:
           ./gradlew --no-daemon assemble
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@396bb3e45325a47dd9ef434068033c6d5bb0d11a #v3.27.3
+        uses: github/codeql-action/analyze@b56ba49b26e50535fa1e7f7db0f4f7b4bf65d80d #v3.28.10
         with:
           category: "/language:${{matrix.language}}"
diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml
@@ -37,7 +37,7 @@ jobs:
           persist-credentials: false
 
       - name: "Run analysis"
-        uses: ossf/scorecard-action@62b2cac7ed8198b15735ed49ab1e5cf35480ba46 # v2.4.0
+        uses: ossf/scorecard-action@f49aabe0b5af0936a0987cfb85d86b75731b0186 # v2.4.1
         with:
           results_file: results.sarif
           results_format: sarif
@@ -59,7 +59,7 @@ jobs:
       # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
       # format to the repository Actions tab.
       - name: "Upload artifact"
-        uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
+        uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
         with:
           name: SARIF file
           path: results.sarif
@@ -68,6 +68,13 @@ jobs:
       # Upload the results to GitHub's code scanning dashboard (optional).
       # Commenting out will disable upload of results to your repo's Code Scanning dashboard
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@9e8d0789d4a0fa9ceb6b1738f7e269594bdd67f0 # v3.28.9
+        uses: github/codeql-action/upload-sarif@b56ba49b26e50535fa1e7f7db0f4f7b4bf65d80d # v3.28.10
         with:
           sarif_file: results.sarif
+
+  gradle-wrapper-validation:
+    name: "Checksum validation of Gradle Wrappers"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: gradle/actions/wrapper-validation@94baf225fe0a508e581a564467443d0e2379123b # v4.3.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Changelog
 
+## 6.12.1 (2025-03-03)
+
+### Bug fixes
+
+* Excess threads (over `Configuration.getMaxReportedThreads`) are trimmed more reliably when the payload is modified before sending (in an `OnSendCallback` for example) 
+  [#2148](https://github.com/bugsnag/bugsnag-android/pull/2148)
+
+* Fixed an error calculating the device time during NDK crashes
+  [#2158](https://github.com/bugsnag/bugsnag-android/pull/2158)
+
 ## 6.12.0 (2025-02-18)
 
 ### Enhancements
diff --git a/SECURITY.md b/SECURITY.md
@@ -9,4 +9,4 @@
 
 ## Reporting a Vulnerability
 
-If you find a vulnerability in this SDK, please report it to our [Support team](mailto:support@bugsnag.com) for review.
+If you find a vulnerability in this SDK, please report it to our [Support Team](mailto:support@bugsnag.com) for review.
diff --git a/bugsnag-android-core/src/main/java/com/bugsnag/android/EventPayload.kt b/bugsnag-android-core/src/main/java/com/bugsnag/android/EventPayload.kt
@@ -80,6 +80,29 @@ class EventPayload @JvmOverloads internal constructor(
             dataTrimmed
         )
 
+        val threadCount = event.threads.size
+        val maxReportedThreads = config.maxReportedThreads
+        if (threadCount > maxReportedThreads) {
+            event.threads.subList(maxReportedThreads, threadCount).clear()
+
+            event.threads.add(
+                Thread(
+                    "",
+                    "[${threadCount - maxReportedThreads} threads omitted as the " +
+                        "maxReportedThreads limit ($maxReportedThreads) was exceeded]",
+                    ErrorType.UNKNOWN,
+                    false,
+                    Thread.State.UNKNOWN,
+                    Stacktrace(
+                        arrayOf(StackTraceElement("", "", "-", 0)),
+                        config.projectPackages,
+                        logger
+                    ),
+                    logger
+                )
+            )
+        }
+
         json = rebuildPayloadCache()
         if (json.size <= maxSizeBytes) {
             return this
diff --git a/bugsnag-android-core/src/main/java/com/bugsnag/android/Notifier.kt b/bugsnag-android-core/src/main/java/com/bugsnag/android/Notifier.kt
@@ -7,7 +7,7 @@ import java.io.IOException
  */
 class Notifier @JvmOverloads constructor(
     var name: String = "Android Bugsnag Notifier",
-    var version: String = "6.12.0",
+    var version: String = "6.12.1",
     var url: String = "https://bugsnag.com"
 ) : JsonStream.Streamable {
 
diff --git a/bugsnag-android-core/src/test/java/com/bugsnag/android/EventPayloadTrimTest.kt b/bugsnag-android-core/src/test/java/com/bugsnag/android/EventPayloadTrimTest.kt
@@ -0,0 +1,64 @@
+package com.bugsnag.android
+
+import org.junit.Assert.assertEquals
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.mockito.Mock
+import org.mockito.junit.MockitoJUnitRunner
+
+private const val MAX_STRING_LENGTH = 256
+private const val BIG_STRING_LENGTH = MAX_STRING_LENGTH * 4
+
+@RunWith(MockitoJUnitRunner::class)
+class EventPayloadTrimTest {
+
+    @Mock
+    lateinit var client: Client
+
+    @Test
+    fun testTrimPayload() {
+        val event = BugsnagTestUtils.generateEvent()
+        event.addMetadata("trimming", "bigString", "*".repeat(BIG_STRING_LENGTH))
+
+        // remove any existing threads to keep this test simple
+        event.threads.clear()
+        repeat(times = 10) { threadIdx ->
+            event.addThread(threadIdx.toLong(), "test thread $threadIdx")
+        }
+
+        event.breadcrumbs.clear()
+        repeat(times = 10) { breadcrumbIdx ->
+            event.leaveBreadcrumb("breadcrumb $breadcrumbIdx")
+        }
+
+        val config = BugsnagTestUtils.generateImmutableConfig(
+            Configuration("abc123").apply {
+                maxBreadcrumbs = 2
+                maxReportedThreads = 2
+                maxStringValueLength = MAX_STRING_LENGTH
+            }
+        )
+
+        val notifier = Notifier(name = "Test Notifier", version = "9.9.9")
+        val payload = EventPayload(null, event, null, notifier, config)
+        val trimmed = requireNotNull(payload.trimToSize(BIG_STRING_LENGTH).event)
+
+        assertEquals(
+            "${"*".repeat(MAX_STRING_LENGTH)}***<${BIG_STRING_LENGTH - MAX_STRING_LENGTH}> CHARS TRUNCATED***",
+            trimmed.getMetadata("trimming")!!["bigString"]
+        )
+
+        val threads = trimmed.threads
+        assertEquals(3, threads.size)
+        assertEquals("test thread 0", threads[0].name)
+        assertEquals("test thread 1", threads[1].name)
+        assertEquals(
+            "[8 threads omitted as the maxReportedThreads limit (2) was exceeded]",
+            threads[2].name
+        )
+
+        val breadcrumbs = trimmed.breadcrumbs
+        assertEquals(1, breadcrumbs.size)
+        assertEquals("Removed, along with 9 older breadcrumbs, to reduce payload size", breadcrumbs[0].message)
+    }
+}
diff --git a/bugsnag-plugin-android-ndk/src/androidTest/java/com/bugsnag/android/ndk/NativeJsonSerializeTest.kt b/bugsnag-plugin-android-ndk/src/androidTest/java/com/bugsnag/android/ndk/NativeJsonSerializeTest.kt
@@ -3,8 +3,15 @@ package com.bugsnag.android.ndk
 import org.junit.After
 import org.junit.Assert.assertEquals
 import org.junit.Before
+import org.junit.Ignore
 import org.junit.Test
 import java.io.File
+import java.text.SimpleDateFormat
+import java.util.Calendar
+import java.util.Date
+import java.util.GregorianCalendar
+import java.util.Locale
+import java.util.TimeZone
 
 class NativeJsonSerializeTest {
 
@@ -16,6 +23,8 @@ class NativeJsonSerializeTest {
     }
 
     private val path = File(System.getProperty("java.io.tmpdir"), this::class.simpleName!!)
+    private val dateFormat = SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'", Locale.US)
+        .apply { timeZone = TimeZone.getTimeZone("UTC") }
 
     @Before
     fun setupTmpdir() {
@@ -27,13 +36,84 @@ class NativeJsonSerializeTest {
         path.deleteRecursively()
     }
 
-    external fun run(outputDir: String): Int
+    external fun run(outputDir: String, timestamp: Long): Int
 
     @Test
-    fun testPassesNativeSuite() {
-        verifyNativeRun(run(path.absolutePath))
+    fun testPassesNativeSuiteEpoch() {
+        verifyNativeRun(run(path.absolutePath, 7609))
         val jsonFile = path.listFiles()!!.maxByOrNull { it.lastModified() }!!
         val expected = loadJson("event_serialization.json")
         assertEquals(expected, jsonFile.readText())
     }
+
+    @Test
+    fun testRegression2024() {
+        val timestamp = GregorianCalendar(2024, 11, 30, 16, 0, 0).timeInMillis
+        val datestamp = dateFormat.format(Date(timestamp))
+
+        verifyNativeRun(run(path.absolutePath, timestamp / 1000L))
+        val jsonFile = path.listFiles()!!.maxByOrNull { it.lastModified() }!!
+        val expected = loadJson("event_serialization.json")
+            .replace("\"1970-01-01T02:06:49Z\"", "\"${datestamp}\"")
+        assertEquals(expected, jsonFile.readText())
+    }
+
+    @Test
+    fun testPassesNativeSuite2024() {
+        val timestamp = GregorianCalendar(2024, 0, 1).timeInMillis
+        val datestamp = dateFormat.format(Date(timestamp))
+
+        verifyNativeRun(run(path.absolutePath, timestamp / 1000L))
+        val jsonFile = path.listFiles()!!.maxByOrNull { it.lastModified() }!!
+        val expected = loadJson("event_serialization.json")
+            .replace("\"1970-01-01T02:06:49Z\"", "\"${datestamp}\"")
+        assertEquals(expected, jsonFile.readText())
+    }
+
+    @Test
+    fun testPassesNativeSuite2025() {
+        val timestamp = GregorianCalendar(2025, 1, 1).timeInMillis
+        val datestamp = dateFormat.format(Date(timestamp))
+
+        verifyNativeRun(run(path.absolutePath, timestamp / 1000L))
+        val jsonFile = path.listFiles()!!.maxByOrNull { it.lastModified() }!!
+        val expected = loadJson("event_serialization.json")
+            .replace("\"1970-01-01T02:06:49Z\"", "\"${datestamp}\"")
+        assertEquals(expected, jsonFile.readText())
+    }
+
+    @Test
+    fun testPassesNativeSuiteToday() {
+        val now = System.currentTimeMillis()
+        val datestamp = dateFormat.format(Date(now))
+
+        verifyNativeRun(run(path.absolutePath, now / 1000L))
+        val jsonFile = path.listFiles()!!.maxByOrNull { it.lastModified() }!!
+        val expected = loadJson("event_serialization.json")
+            .replace("\"1970-01-01T02:06:49Z\"", "\"${datestamp}\"")
+        assertEquals(expected, jsonFile.readText())
+    }
+
+    @Test
+    @Ignore("useful when working on the date formatting code")
+    fun testDecadesOfDates() {
+        val calendar = Calendar.getInstance().apply { add(Calendar.YEAR, -10) }
+        val end = Calendar.getInstance().apply { add(Calendar.YEAR, 10) }
+
+        while (calendar < end) {
+            val instant = calendar.timeInMillis
+            val datestamp = dateFormat.format(Date(instant))
+
+            verifyNativeRun(run(path.absolutePath, instant / 1000L))
+            val jsonFile = path.listFiles()!!.maxByOrNull { it.lastModified() }!!
+            val expected = loadJson("event_serialization.json")
+                .replace("\"1970-01-01T02:06:49Z\"", "\"${datestamp}\"")
+            assertEquals(expected, jsonFile.readText())
+
+            // move the date along 6 hours at a time
+            calendar.add(Calendar.HOUR, 6)
+
+            jsonFile.delete()
+        }
+    }
 }
diff --git a/bugsnag-plugin-android-ndk/src/main/jni/utils/serializer/BSG_KSCrashStringConversion.c b/bugsnag-plugin-android-ndk/src/main/jni/utils/serializer/BSG_KSCrashStringConversion.c
diff --git a/bugsnag-plugin-android-ndk/src/test/cpp/main.c b/bugsnag-plugin-android-ndk/src/test/cpp/main.c
diff --git a/examples/sdk-app-example/app/build.gradle b/examples/sdk-app-example/app/build.gradle
diff --git a/features/support/env.rb b/features/support/env.rb
diff --git a/gradle.properties b/gradle.properties
