├── settings.gradle.kts ├── .gitignore ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── .circleci └── config.yml ├── CHANGELOG.md ├── src ├── main │ └── kotlin │ │ └── ru │ │ └── gildor │ │ └── coroutines │ │ └── okhttp │ │ ├── CallStackRecorder.kt │ │ └── CallAwait.kt └── test │ └── kotlin │ └── ru │ └── gildor │ └── coroutines │ └── okhttp │ └── CallAwaitTest.kt ├── gradlew.bat ├── publish.gradle ├── gradlew ├── README.md └── LICENSE.txt /settings.gradle.kts: -------------------------------------------------------------------------------- 1 | rootProject.name = "kotlin-coroutines-okhttp" 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | .gradle 3 | /local.properties 4 | build/ 5 | .DS_Store 6 | *iml 7 | out/ -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gildor/kotlin-coroutines-okhttp/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | version: 2.0 2 | jobs: 3 | build: 4 | docker: 5 | - image: circleci/openjdk:8u181-jdk 6 | steps: 7 | - checkout 8 | - run: 9 | command: ./gradlew build 10 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-bin.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # CHANGELOG 2 | 3 | ## Version 1.0.0 (2019-03-16) 4 | 5 | First version published on Bintray and Maven Central 6 | 7 | - Stable (non-experimental) coroutines 8 | - [OkHttp 3.14.0](https://github.com/square/okhttp/blob/master/CHANGELOG.md#version-3140) 9 | - [kotlinx.coroutines 1.1.1](https://github.com/Kotlin/kotlinx.coroutines/releases/tag/1.1.1) 10 | - Compiled against Kotlin 1.3.21 11 | -------------------------------------------------------------------------------- /src/main/kotlin/ru/gildor/coroutines/okhttp/CallStackRecorder.kt: -------------------------------------------------------------------------------- 1 | @file:Suppress("RedundantVisibilityModifier") 2 | 3 | package ru.gildor.coroutines.okhttp 4 | 5 | 6 | public const val OKHTTP_STACK_RECORDER_PROPERTY = "ru.gildor.coroutines.okhttp.stackrecorder" 7 | 8 | /** 9 | * Debug turned on value for [DEBUG_PROPERTY_NAME]. See [newCoroutineContext][CoroutineScope.newCoroutineContext]. 10 | */ 11 | public const val OKHTTP_STACK_RECORDER_ON = "on" 12 | 13 | /** 14 | * Debug turned on value for [DEBUG_PROPERTY_NAME]. See [newCoroutineContext][CoroutineScope.newCoroutineContext]. 15 | */ 16 | public const val OKHTTP_STACK_RECORDER_OFF = "off" 17 | 18 | @JvmField 19 | val isRecordStack = when (System.getProperty(OKHTTP_STACK_RECORDER_PROPERTY)) { 20 | OKHTTP_STACK_RECORDER_ON -> true 21 | OKHTTP_STACK_RECORDER_OFF, null, "" -> false 22 | else -> error("System property '$OKHTTP_STACK_RECORDER_PROPERTY' has unrecognized value '${System.getProperty(OKHTTP_STACK_RECORDER_PROPERTY)}'") 23 | } 24 | -------------------------------------------------------------------------------- /src/test/kotlin/ru/gildor/coroutines/okhttp/CallAwaitTest.kt: -------------------------------------------------------------------------------- 1 | package ru.gildor.coroutines.okhttp 2 | 3 | import kotlinx.coroutines.* 4 | import okhttp3.* 5 | import org.junit.Assert.assertFalse 6 | import org.junit.Assert.assertTrue 7 | import org.junit.Test 8 | import java.io.IOException 9 | 10 | @ExperimentalCoroutinesApi 11 | class CallAwaitTest { 12 | @Test 13 | fun await() = runBlocking { 14 | assertTrue(call("http://localhost/ok").await().isSuccessful) 15 | assertFalse(call("http://localhost/error").await().isSuccessful) 16 | } 17 | 18 | @Test(expected = IOException::class) 19 | fun `throw exception on coroutine`() = testBlocking { 20 | call("http://localhost/exception").await() 21 | } 22 | 23 | @Test 24 | fun `cancel call on coroutine cancellation`() = testBlocking { 25 | val call = call("http://localhost/wait") 26 | val job = async(Dispatchers.Unconfined) { 27 | call.await() 28 | } 29 | assertFalse(call.isCanceled) 30 | job.cancel() 31 | assertTrue(call.isCanceled) 32 | } 33 | 34 | private val client: OkHttpClient = OkHttpClient.Builder() 35 | .addInterceptor { chain -> 36 | val request = chain.request() 37 | val command = request.url().pathSegments()[0] 38 | val builder = Response.Builder() 39 | .request(request) 40 | .protocol(Protocol.HTTP_1_1) 41 | val body = ResponseBody.create(MediaType.parse("plain/text"), "Body") 42 | when (command) { 43 | "error" -> builder.code(401).message("Error") 44 | "wait" -> { 45 | Thread.sleep(100) 46 | builder.code(200).message("Ok after wait") 47 | } 48 | "ok" -> builder.code(200).message("Ok") 49 | else -> throw IOException() 50 | }.body(body).build() 51 | } 52 | .build() 53 | 54 | private fun call(url: String): Call { 55 | return client.newCall(Request.Builder().url(url).build()) 56 | } 57 | 58 | } 59 | 60 | private fun testBlocking(block: suspend CoroutineScope.() -> Unit) { 61 | runBlocking(block = block) 62 | } -------------------------------------------------------------------------------- /src/main/kotlin/ru/gildor/coroutines/okhttp/CallAwait.kt: -------------------------------------------------------------------------------- 1 | @file:Suppress("RedundantVisibilityModifier") 2 | 3 | package ru.gildor.coroutines.okhttp 4 | 5 | import kotlinx.coroutines.suspendCancellableCoroutine 6 | import okhttp3.Call 7 | import okhttp3.Callback 8 | import okhttp3.Response 9 | import java.io.IOException 10 | import kotlin.coroutines.resume 11 | import kotlin.coroutines.resumeWithException 12 | 13 | /** 14 | * Suspend extension that allows suspend [Call] inside coroutine. 15 | * 16 | * [recordStack] enables track recording, so in case of exception stacktrace will contain call stacktrace, may be useful for debugging 17 | * Not free! Creates exception on each request so disabled by default, but may be enabled using system properties: 18 | * 19 | * ``` 20 | * System.setProperty(OKHTTP_STACK_RECORDER_PROPERTY, OKHTTP_STACK_RECORDER_ON) 21 | * ``` 22 | * see [README.md](https://github.com/gildor/kotlin-coroutines-okhttp/blob/master/README.md#Debugging) with details about debugging using this feature 23 | * 24 | * @return Result of request or throw exception 25 | */ 26 | public suspend fun Call.await(recordStack: Boolean = isRecordStack): Response { 27 | val callStack = if (recordStack) { 28 | IOException().apply { 29 | // Remove unnecessary lines from stacktrace 30 | // This doesn't remove await$default, but better than nothing 31 | stackTrace = stackTrace.copyOfRange(1, stackTrace.size) 32 | } 33 | } else { 34 | null 35 | } 36 | return suspendCancellableCoroutine { continuation -> 37 | enqueue(object : Callback { 38 | override fun onResponse(call: Call, response: Response) { 39 | continuation.resume(response) 40 | } 41 | 42 | override fun onFailure(call: Call, e: IOException) { 43 | // Don't bother with resuming the continuation if it is already cancelled. 44 | if (continuation.isCancelled) return 45 | callStack?.initCause(e) 46 | continuation.resumeWithException(callStack ?: e) 47 | } 48 | }) 49 | 50 | continuation.invokeOnCancellation { 51 | try { 52 | cancel() 53 | } catch (ex: Throwable) { 54 | //Ignore cancel exception 55 | } 56 | } 57 | } 58 | } 59 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /publish.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'maven-publish' 2 | apply plugin: 'com.jfrog.bintray' 3 | 4 | def description = "Provides Kotlin Coroutines suspendable await() extensions for okhttp3.Call" 5 | def githubId = "gildor/kotlin-coroutines-okhttp" 6 | def repoWeb = "https://github.com/${githubId}" 7 | def repoVcs = "${repoWeb}.git" 8 | def issueTracker = "${repoWeb}/issues" 9 | def tags = ['okhttp', 'kotlin', 'coroutines'] 10 | def licenseId = "Apache-2.0" 11 | def licenseName = "The Apache Software License, Version 2.0" 12 | def licenseUrl = "http://www.apache.org/licenses/LICENSE-2.0.txt" 13 | def releaseTag = "v${project.version}" 14 | 15 | // Create the pom configuration: 16 | def pomConfig = { 17 | developers { 18 | developer { 19 | name "Andrey Mischenko" 20 | email "git@gildor.ru" 21 | organizationUrl "https://github.com/gildor" 22 | } 23 | } 24 | scm { 25 | url repoWeb 26 | connection "scm:git:${repoVcs}" 27 | developerConnection "scm:git:${repoVcs}" 28 | tag releaseTag 29 | } 30 | issueManagement { 31 | system "GitHub Issues" 32 | url issueTracker 33 | } 34 | licenses { 35 | license { 36 | name licenseName 37 | url licenseUrl 38 | } 39 | } 40 | } 41 | 42 | task sourcesJar(type: Jar, dependsOn: classes) { 43 | classifier = 'sources' 44 | from sourceSets.main.allSource 45 | } 46 | 47 | task javadocJar(type: Jar, dependsOn: javadoc) { 48 | classifier = 'javadoc' 49 | from javadoc.destinationDir 50 | } 51 | 52 | publishing { 53 | publications { 54 | Publication(MavenPublication) { 55 | from components.java 56 | artifact sourcesJar 57 | artifact javadocJar 58 | pom.withXml { 59 | def root = asNode() 60 | root.appendNode('name', project.name) 61 | root.appendNode('description', description) 62 | root.appendNode('url', repoWeb) 63 | root.children().last() + pomConfig 64 | } 65 | } 66 | } 67 | } 68 | 69 | bintray { 70 | user = project.properties['bintray.user'] 71 | key = project.properties['bintray.key'] 72 | publications = ['Publication'] 73 | pkg { 74 | repo = project.properties['bintray.repo'] ?: 'maven' 75 | name = project.name 76 | desc = description 77 | githubRepo = githubId 78 | githubReleaseNotesFile = 'CHANGELOG.md' 79 | websiteUrl = repoWeb 80 | issueTrackerUrl = "${repoWeb}/issues" 81 | vcsUrl = repoVcs 82 | licenses = [licenseId] 83 | labels = tags 84 | version { 85 | name = project.version 86 | vcsTag = releaseTag 87 | } 88 | } 89 | } 90 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Kotlin coroutines await extension for OkHttp3 2 | 3 | This is small library that provides `await()` extension for [okhttp3.Call](https://square.github.io/okhttp/3.x/okhttp/okhttp3/Call.html) for integration with Kotlin coroutines 4 | 5 | Based on [kotlinx.coroutines](https://github.com/Kotlin/kotlinx.coroutines) implementation. 6 | 7 | Requires Kotlin 1.3+ 8 | 9 | Depends on [OkHttp3 3.8.0](https://github.com/square/okhttp/blob/master/CHANGELOG.md#version-380) so don't require updates to [newest version of OkHttp](https://github.com/square/okhttp/blob/master/CHANGELOG.md#version-3130) that require Java 8+ or Android 5+ 10 | 11 | ## Usage 12 | 13 | ```kotlin 14 | // Create OkHttp client 15 | val client = OkHttpClient.Builder().build() 16 | // Create request 17 | val request = Request.Builder().url("https://example.org/").build() 18 | 19 | suspend fun main() { 20 | // Do call and await() for result from any suspend function 21 | val result = client.newCall(request).await() 22 | println("${result.code()}: ${result.message()}") 23 | } 24 | ``` 25 | 26 | This library doesn't provide any facilities for non-blocking read of response body, 27 | if you need a way to do that consider to use `withContext(Dispatchers.IO)` and wrap blocking calls. 28 | 29 | See this issue about support of non-blocking API for Okio - https://github.com/square/okio/issues/501 30 | 31 | ## Download 32 | 33 | Download the [JAR](https://bintray.com/gildor/maven/kotlin-coroutines-okhttp#files/ru/gildor/coroutines/kotlin-coroutines-okhttp): 34 | 35 | Artifacts are available on [JCenter](https://bintray.com/gildor/maven/kotlin-coroutines-okhttp) and [Maven Central](https://search.maven.org/search?q=a:kotlin-coroutines-okhttp) 36 | 37 | Gradle: 38 | 39 | ```kotlin 40 | implementation("ru.gildor.coroutines:kotlin-coroutines-okhttp:1.0") 41 | ``` 42 | 43 | Maven: 44 | 45 | ```xml 46 | 47 | ru.gildor.coroutines 48 | kotlin-coroutines-okhttp 49 | 1.0 50 | 51 | ``` 52 | 53 | ## Debugging 54 | 55 | Because this coroutines adapter uses async API of OkHttp by default 56 | stacktrace doesn't contain link on code that called it. 57 | 58 | For example you have code from Usage section code that throws SocketTimeoutException 59 | 60 | If you run it you will get stacktrace similar to this: 61 | 62 | ``` 63 | Exception in thread "main" java.net.SocketTimeoutException: Read timed out 64 | at java.base/java.net.SocketInputStream.socketRead0(Native Method) 65 | at java.base/java.net.SocketInputStream.socketRead(SocketInputStream.java:116) 66 | ... 67 | ``` 68 | 69 | As you can see, there is no way to understand from which line or class this request was started. 70 | 71 | You should understand, this is not something unique for Kotlin coroutines or this adapter, 72 | you would have the same stacktrace with `okhttp3.Callback` if would throw an exception on failure 73 | To make this stacktrace more useful you can do a few things 74 | 75 | ### Wrap exception manually: 76 | ```kotlin 77 | suspend fun main() { 78 | try { 79 | client.newCall(request).await() 80 | } catch (e: IOException) { 81 | // Catch original exception 82 | // Use some logger that will write line number to logs, so you can find the source of exception 83 | someLogger.error(e) 84 | // or just wrap exception and throw it to get stacktrace 85 | throw IOException("Some additional debug info: ${e.message}", e) 86 | } 87 | } 88 | ``` 89 | 90 | This will give you stacktrace that shows line where exception was rethrown or logged: 91 | ```kotlin 92 | Exception in thread "main" java.io.IOException: java.net.SocketTimeoutException: Read timed out 93 | at ru.gildor.coroutines.okhttp.MainKt.main(main.kt:20) 94 | at ru.gildor.coroutines.okhttp.MainKt$main$1.invokeSuspend(main.kt) 95 | ... 96 | Caused by: java.net.SocketTimeoutException: Read timed out 97 | at java.base/java.net.SocketInputStream.socketRead0(Native Method) 98 | at java.base/java.net.SocketInputStream.socketRead(SocketInputStream.java:116) 99 | ... 100 | ``` 101 | 102 | ### Enable debug mode of kotlinx.coroutines: 103 | 104 | ```kotlin 105 | // Set it before first usage of coroutines in your project 106 | System.setProperty(DEBUG_PROPERTY_NAME, DEBUG_PROPERTY_VALUE_ON) 107 | ``` 108 | 109 | This will allow you to see line where request is started: 110 | 111 | ``` 112 | Exception in thread "main" java.net.SocketTimeoutException 113 | (Coroutine boundary) 114 | at ru.gildor.coroutines.okhttp.MainKt.main(main.kt:15) 115 | Caused by: java.net.SocketTimeoutException: timeout 116 | at okio.Okio$4.newTimeoutException(Okio.java:230) 117 | at okio.AsyncTimeout.exit(AsyncTimeout.java:285) 118 | ... 119 | ``` 120 | 121 | This will give you coroutines stack so you can debug it in most cases 122 | 123 | ### Enable stack recording 124 | 125 | To help debug some complicated cases, 126 | when you want to know which code started coroutine, 127 | `await()` provides argument recordStack: 128 | 129 | ```kotin 130 | suspend fun main() { 131 | client.newCall(request).await(recordStack = true) 132 | } 133 | ``` 134 | 135 | Instead of recovering coroutine stacktrace this call will create exception on method call to save stack 136 | and will throw it on error, so you will get detailed stack 137 | 138 | ``` 139 | Exception in thread "main" java.io.IOException 140 | at ru.gildor.coroutines.okhttp.MainKt.main(main.kt:15) 141 | ... 142 | Caused by: java.net.SocketTimeoutException: timeout 143 | at okio.Okio$4.newTimeoutException(Okio.java:230) 144 | ... 145 | ``` 146 | 147 | By default stack recording is disabled, but you can enable it using system properties 148 | (should set it before first usage of the adapter): 149 | 150 | ```kotlin 151 | System.setProperty(OKHTTP_STACK_RECORDER_PROPERTY, OKHTTP_STACK_RECORDER_ON) 152 | ``` 153 | 154 | But this method is relatively heavyweight because creates exception on each request 155 | (even successful, because we have to record stacktrace before invocation) 156 | and resulting stacktrace is full of coroutines internal calls, 157 | 158 | So I recommend to use it only if you have hard times to understand what is caused the problem and you need all information 159 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------