Kotlin Coroutines withContextを使ってもStackTraceを諦めたくない【株式会社ライトコード】

はじめに

本記事は、以前の記事
Kotlin Coroutines withContextを使っているとStackTraceを用いた不具合調査が辛いのをどうにかしたい
の解決提案編となります。

どんな問題だったか

Koltin CouroitnesのwithContextを利用してスレッド変更すると
StackTraceが途切れてしまい不具合発生時の処理履歴が追えなくなる
という問題でした。

詳しくは前回の記事を確認してください。

解決案1：withContextごとに、例外ラッパークラスにStackTrace情報を詰め込む（問題あり…）

↓まずは、例外ラッパークラスを作成。

/*

 * Exceptionをラップするためのクラス

 */

class WrappedException(

    message: String,

    cause: Exception

) : Exception(message, cause) {



    /**

     * 例外の根本的な原因を取得するプロパティ

     *

     * このプロパティは、WrappedExceptionがラップしている例外の根本的な原因を返す

     * もしWrappedExceptionがラップしている例外が別のWrappedExceptionであれば、その根本的な原因を再帰的に取得

     */

    val rootCause: Throwable?

        get() = cause?.let {

            if (it is WrappedException) {

                it.rootCause

            } else {

                it

            }

        }

}

↓次に、独自のwithContextを作成

/*

* withContextを使用して、例外をラップするための関数

 *

 * @param context CoroutineContext

 * @param block suspend CoroutineScope.() -> T

 * @return T

 *

 * 呼び出し元のメソッド名と行番号を取得し、例外が発生した場合にその情報を含む[WrappedException]を投げる。

 */

suspend fun  withContextWrapException(

    context: CoroutineContext,

    block: suspend CoroutineScope.() -> T,

): T {

    val throwable = Throwable()

    return withContext(context) {

        try {

            block()

        } catch (e: CancellationException) {

            // CancellationExceptionはそのまま投げる(suspend中断例外の伝播のため)

            throw e

        } catch (e: Exception) {

            val callerStackTraceElement = throwable.stackTrace[1] // withContextWrapExceptionを呼び出しているメソッド

            val callerOfCallerStackTraceElement = throwable.stackTrace[2] // 「withContextWrapExceptionを呼び出しているメソッド」を呼び出しているメソッド

            val callerInfo =

                "(${callerOfCallerStackTraceElement.fileName}:${callerOfCallerStackTraceElement.lineNumber}→${callerStackTraceElement.fileName}:${callerStackTraceElement.lineNumber})"

            throw WrappedException(callerInfo, e)

        }

    }

}

↓あとは、withContextの代わりに使うだけ。

 // 適当なRpository

class HogeRepository(

    private val dispatcherIO: CoroutineDispatcher = Dispatchers.IO

) {

    suspend fun getHoge(): String = withContextWrapException(dispatcherIO) {

        throw RuntimeException("適当な例外")

    }

}

↓ViewModelから呼び出すと

 // 適当なViewModelから呼び出す

class MainViewModel(

    private val repository: HogeRepository = HogeRepository()

) : ViewModel() {



    fun onClickButton() {

        viewModelScope.launch {

            try {

                hogeRepository.getHoge()

            } catch (e: CancellationException) {

                throw e // Jobキャンセル例外はキャッチしたらダメです

            } catch (e: Exception) {

                Log.e("hoge", "onClickButton", e)

                _errorMessage.update { e.stackTraceToString() }

            }

        }

    }

}