|
| 1 | +/* |
| 2 | + * Copyright 2026 LiveKit, Inc. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +package io.livekit.android.util |
| 18 | + |
| 19 | +import android.os.Build |
| 20 | +import android.util.Log |
| 21 | +import java.io.PrintWriter |
| 22 | +import java.io.StringWriter |
| 23 | +import java.util.regex.Pattern |
| 24 | + |
| 25 | +/** |
| 26 | + * This is a modified version of DebugTree from JakeWharton/timber for LiveKit. |
| 27 | + * https://github.com/JakeWharton/timber |
| 28 | + */ |
| 29 | + |
| 30 | +/** |
| 31 | + * A tree for debug builds. Automatically infers the tag from the calling class. |
| 32 | + * @suppress |
| 33 | + * */ |
| 34 | +open class LKDebugTree { |
| 35 | + |
| 36 | + private val fqcnIgnore = |
| 37 | + listOf( |
| 38 | + LKDebugTree::class.java.name, |
| 39 | + LKLog.defaultLogger::class.java.name, |
| 40 | + ) |
| 41 | + |
| 42 | + val tag: String? |
| 43 | + get() = |
| 44 | + Throwable() |
| 45 | + .stackTrace |
| 46 | + .first { it.className !in fqcnIgnore } |
| 47 | + .let(::createStackElementTag) |
| 48 | + |
| 49 | + fun prepareLog(priority: Int, t: Throwable?, message: String?) { |
| 50 | + // Consume tag even when message is not loggable so that next message is correctly tagged. |
| 51 | + val tag = tag |
| 52 | + |
| 53 | + var message = message |
| 54 | + if (message.isNullOrEmpty()) { |
| 55 | + if (t == null) { |
| 56 | + return // Swallow message if it's null and there's no throwable. |
| 57 | + } |
| 58 | + message = getStackTraceString(t) |
| 59 | + } else { |
| 60 | + if (t != null) { |
| 61 | + message += "\n" + getStackTraceString(t) |
| 62 | + } |
| 63 | + } |
| 64 | + |
| 65 | + log(priority, tag, message, t) |
| 66 | + } |
| 67 | + |
| 68 | + private fun getStackTraceString(t: Throwable): String { |
| 69 | + // Don't replace this with Log.getStackTraceString() - it hides |
| 70 | + // UnknownHostException, which is not what we want. |
| 71 | + val sw = StringWriter(256) |
| 72 | + val pw = PrintWriter(sw, false) |
| 73 | + t.printStackTrace(pw) |
| 74 | + pw.flush() |
| 75 | + return sw.toString() |
| 76 | + } |
| 77 | + |
| 78 | + /** |
| 79 | + * Extract the tag which should be used for the message from the `element`. By default this will |
| 80 | + * use the class name without any anonymous class suffixes (e.g., `Foo$1` becomes `Foo`). |
| 81 | + * |
| 82 | + * Note: This will not be called if a [manual tag][.tag] was specified. |
| 83 | + */ |
| 84 | + private fun createStackElementTag(element: StackTraceElement): String? { |
| 85 | + var tag = element.className.substringAfterLast('.') |
| 86 | + val m = ANONYMOUS_CLASS.matcher(tag) |
| 87 | + if (m.find()) { |
| 88 | + tag = m.replaceAll("") |
| 89 | + } |
| 90 | + // Tag length limit was removed in API 26. |
| 91 | + return if (tag.length <= MAX_TAG_LENGTH || Build.VERSION.SDK_INT >= 26) { |
| 92 | + tag |
| 93 | + } else { |
| 94 | + tag.take(MAX_TAG_LENGTH) |
| 95 | + } |
| 96 | + } |
| 97 | + |
| 98 | + /** |
| 99 | + * Break up `message` into maximum-length chunks (if needed) and send to either |
| 100 | + * [Log.println()][Log.println] or [Log.wtf()][Log.wtf] for logging. |
| 101 | + * |
| 102 | + * {@inheritDoc} |
| 103 | + */ |
| 104 | + open fun log(priority: Int, tag: String?, message: String, t: Throwable?) { |
| 105 | + if (message.length < MAX_LOG_LENGTH) { |
| 106 | + if (priority == Log.ASSERT) { |
| 107 | + Log.wtf(tag, message) |
| 108 | + } else { |
| 109 | + Log.println(priority, tag, message) |
| 110 | + } |
| 111 | + return |
| 112 | + } |
| 113 | + |
| 114 | + // Split by line, then ensure each line can fit into Log's maximum length. |
| 115 | + var i = 0 |
| 116 | + val length = message.length |
| 117 | + while (i < length) { |
| 118 | + var newline = message.indexOf('\n', i) |
| 119 | + newline = if (newline != -1) newline else length |
| 120 | + do { |
| 121 | + val end = newline.coerceAtMost(i + MAX_LOG_LENGTH) |
| 122 | + val part = message.substring(i, end) |
| 123 | + if (priority == Log.ASSERT) { |
| 124 | + Log.wtf(tag, part) |
| 125 | + } else { |
| 126 | + Log.println(priority, tag, part) |
| 127 | + } |
| 128 | + i = end |
| 129 | + } while (i < newline) |
| 130 | + i++ |
| 131 | + } |
| 132 | + } |
| 133 | + |
| 134 | + companion object { |
| 135 | + private const val MAX_LOG_LENGTH = 4000 |
| 136 | + private const val MAX_TAG_LENGTH = 23 |
| 137 | + private val ANONYMOUS_CLASS = Pattern.compile("(\\$\\d+)+$") |
| 138 | + } |
| 139 | +} |
0 commit comments