Merge branch 'blocoio-dispatcher' into develop

Author: friedger

CHANGELOG.md

@@ -6,6 +6,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unrelease
 ### Added
+- dynamic context in the main suspend methods
 - error code for missing read url
 
 ## [0.6.0] - 2020-10-13

blockstack-sdk/src/main/java/org/blockstack/android/sdk/Blockstack.kt

@@ -4,6 +4,7 @@ import android.util.Base64
 import android.util.Log
 import com.colendi.ecies.EncryptedResultForm
 import com.colendi.ecies.Encryption
+import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.withContext
 import kotlinx.serialization.json.Json
@@ -44,7 +45,8 @@ import java.security.InvalidParameterException
 import java.text.SimpleDateFormat
 import java.util.*
 
-class Blockstack(private val callFactory: Call.Factory = OkHttpClient()) {
+class Blockstack(private val callFactory: Call.Factory = OkHttpClient(),
+                 val dispatcher: CoroutineDispatcher = Dispatchers.IO) {
 
     private var btcAddrResolver: BitAddrResolver
 
@@ -78,7 +80,7 @@ class Blockstack(private val callFactory: Call.Factory = OkHttpClient()) {
         return makeAuthResponseToken(account, privateKeyPayload, scopes)
     }
 
-    private suspend fun makeAuthResponseToken(account: BlockstackAccount, privateKeyPayload: String?, scopes: Array<Scope>): String {
+    private suspend fun makeAuthResponseToken(account: BlockstackAccount, privateKeyPayload: String?, scopes: Array<Scope>): String = withContext(dispatcher) {
         val username = account.username
         val profile = if (username != null) {
             lookupProfile(username, null)
@@ -114,7 +116,7 @@ class Blockstack(private val callFactory: Call.Factory = OkHttpClient()) {
                 "did:btc-addr:${account.keys.keyPair.toBtcAddress()}"
 
         val jwt = JWTTools()
-        return jwt.createJWT(payload, issuerDID, signer, algorithm = JwtHeader.ES256K)
+        return@withContext jwt.createJWT(payload, issuerDID, signer, algorithm = JwtHeader.ES256K)
     }
 
     /**
@@ -126,16 +128,15 @@ class Blockstack(private val callFactory: Call.Factory = OkHttpClient()) {
      * blockstack.js [[getNameInfo]] function.
      * @returns {Promise} that resolves to a profile object
      */
-    suspend fun lookupProfile(username: String, zoneFileLookupURL: URL?): Profile {
+    suspend fun lookupProfile(username: String, zoneFileLookupURL: URL?): Profile = withContext(dispatcher){
 
         val request = buildLookupNameInfoRequest(username, zoneFileLookupURL?.toString())
-        val response = withContext(Dispatchers.IO) {
-            callFactory.newCall(request).execute()
-        }
+        val response = callFactory.newCall(request).execute()
+
         if (response.isSuccessful) {
             val nameInfo = JSONObject(response.body!!.string())
             if (nameInfo.has("address") && nameInfo.has("zonefile")) {
-                return resolveZoneFileToProfile(nameInfo) ?: return Profile(JSONObject())
+                return@withContext resolveZoneFileToProfile(nameInfo) ?: return@withContext Profile(JSONObject())
 
             } else {
                 throw InvalidParameterException("name info does not contain address or zonefile property")
@@ -435,16 +436,16 @@ class Blockstack(private val callFactory: Call.Factory = OkHttpClient()) {
      * @param appPrivateKey (String) the app private key used to generate the app address
      * @result the URL of the app index file or null if it fails
      */
-    suspend fun getAppBucketUrl(gaiaHubUrl: String, privateKey: String): String? {
+    suspend fun getAppBucketUrl(gaiaHubUrl: String, privateKey: String): String? = withContext(dispatcher){
         val challengeSigner = PrivateKey(HexString(privateKey)).toECKeyPair()
         val response = fetchPrivate("${gaiaHubUrl}/hub_info")
         val responseJSON = response.json()
         if (responseJSON != null) {
             val readURL = responseJSON.getString("read_url_prefix")
             val address = challengeSigner.toBtcAddress()
-            return "${readURL}${address}/"
+            return@withContext "${readURL}${address}/"
         } else {
-            return null
+            return@withContext null
         }
     }
 
@@ -457,7 +458,7 @@ class Blockstack(private val callFactory: Call.Factory = OkHttpClient()) {
      *@param zoneFileLookupURL The URL to use for zonefile lookup. If false, this will use the blockstack.js's getNameInfo function instead.
      *@result the public read URL of the file or null on error
      */
-    suspend fun getUserAppFileUrl(path: String, username: String, appOrigin: String, zoneFileLookupURL: String?): String {
+    suspend fun getUserAppFileUrl(path: String, username: String, appOrigin: String, zoneFileLookupURL: String?): String = withContext(dispatcher){
         val profile = lookupProfile(username, zoneFileLookupURL?.let { URL(it) })
         var bucketUrl = NO_URL
         if (profile.json.has("apps")) {
@@ -468,16 +469,14 @@ class Blockstack(private val callFactory: Call.Factory = OkHttpClient()) {
                 bucketUrl = "${bucket}${path}"
             }
         }
-        return bucketUrl
+        return@withContext bucketUrl
     }
 
-    private suspend fun fetchPrivate(url: String): Response {
+    private suspend fun fetchPrivate(url: String): Response = withContext(dispatcher) {
         val request = Request.Builder().url(url)
                 .addHeader("Referrer-Policy", "no-referrer")
                 .build()
-        return withContext(Dispatchers.IO) {
-            callFactory.newCall(request).execute()
-        }
+        return@withContext callFactory.newCall(request).execute()
     }
 
     fun wrapProfileToken(token: String): ProfileTokenPair {
@@ -560,7 +559,7 @@ class Blockstack(private val callFactory: Call.Factory = OkHttpClient()) {
      * @param expiresAt the time of expiration of the token, defaults to next year
      * @return the signed profile token
      */
-    suspend fun signProfileToken(profile: Profile, privateKey: String, subject: Entity, issuer: Entity, issuedAt: Date = Date(), expiresAt: Date = nextYear()): ProfileTokenPair {
+    suspend fun signProfileToken(profile: Profile, privateKey: String, subject: Entity, issuer: Entity, issuedAt: Date = Date(), expiresAt: Date = nextYear()): ProfileTokenPair = withContext(dispatcher) {
 
 
         val payload = mapOf(
@@ -584,7 +583,7 @@ class Blockstack(private val callFactory: Call.Factory = OkHttpClient()) {
         val signature: String = jwtSigner.sign(signingInput, KPSigner(privateKey))
         val token = listOf(signingInput, signature).joinToString(".")
         Log.d(TAG, token)
-        return wrapProfileToken(token)
+        return@withContext wrapProfileToken(token)
     }
 
     companion object {

blockstack-sdk/src/main/java/org/blockstack/android/sdk/BlockstackConnect.kt

@@ -5,10 +5,7 @@ import android.content.Intent
 import android.util.Log
 import androidx.annotation.StyleRes
 import androidx.appcompat.app.AppCompatActivity
-import kotlinx.coroutines.Dispatchers
-import kotlinx.coroutines.ExperimentalCoroutinesApi
-import kotlinx.coroutines.FlowPreview
-import kotlinx.coroutines.withContext
+import kotlinx.coroutines.*
 import org.blockstack.android.sdk.model.BlockstackConfig
 import org.blockstack.android.sdk.model.UserData
 import org.blockstack.android.sdk.ui.BlockstackConnectActivity
@@ -20,11 +17,13 @@ object BlockstackConnect {
 
     private var blockstackSession: BlockstackSession? = null
     private var blockstackSignIn: BlockstackSignIn? = null
+    private var dispatcher: CoroutineDispatcher = Dispatchers.IO
 
     @JvmOverloads
-    fun config(blockstackConfig: BlockstackConfig, sessionStore: ISessionStore, appDetails: AppDetails? = null): BlockstackConnect {
-        blockstackSession = BlockstackSession(sessionStore, blockstackConfig)
-        blockstackSignIn = BlockstackSignIn(sessionStore, blockstackConfig, appDetails)
+    fun config(blockstackConfig: BlockstackConfig, sessionStore: ISessionStore, appDetails: AppDetails? = null, dispatcher: CoroutineDispatcher = Dispatchers.IO): BlockstackConnect {
+        blockstackSession = BlockstackSession(sessionStore, blockstackConfig, dispatcher = dispatcher)
+        blockstackSignIn = BlockstackSignIn(sessionStore, blockstackConfig, appDetails, dispatcher = dispatcher)
+        this.dispatcher = dispatcher
         return this
     }
 
@@ -63,7 +62,7 @@ object BlockstackConnect {
             if (authResponseTokens.size > 1) {
                 val authResponse = authResponseTokens[1]
                 Log.d(TAG, "AuthResponse token: $authResponse")
-                withContext(Dispatchers.IO) {
+                withContext(dispatcher) {
                     val userDataResult = blockstackSession?.handlePendingSignIn(authResponse)
                             ?: errorResult
                     result = if (userDataResult.hasValue) {

blockstack-sdk/src/main/java/org/blockstack/android/sdk/BlockstackSession.kt

@@ -3,6 +3,7 @@ package org.blockstack.android.sdk
 import android.util.Log
 import com.colendi.ecies.EncryptedResultForm
 import com.colendi.ecies.Encryption
+import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.withContext
 import me.uport.sdk.core.hexToByteArray
@@ -34,7 +35,8 @@ const val SIGNATURE_FILE_EXTENSION = ".sig"
 class BlockstackSession(private val sessionStore: ISessionStore, private val appConfig: BlockstackConfig? = null,
                         private val callFactory: Call.Factory = OkHttpClient(),
                         val blockstack: Blockstack = Blockstack(),
-                        val hub: Hub = Hub(callFactory)) {
+                        val hub: Hub = Hub(callFactory),
+                        val dispatcher: CoroutineDispatcher = Dispatchers.IO) {
 
     private var appPrivateKey: String?
     var gaiaHubConfig: GaiaHubConfig? = null
@@ -53,37 +55,37 @@ class BlockstackSession(private val sessionStore: ISessionStore, private val app
      * @return result object with the user data after sign-in or with an error
      *
      */
-    suspend fun handlePendingSignIn(authResponse: String): Result<UserData> {
+    suspend fun handlePendingSignIn(authResponse: String): Result<out UserData> = withContext(dispatcher) {
         val transitKey = sessionStore.getTransitPrivateKey()
         val nameLookupUrl = sessionStore.sessionData.json.optString("core-node", "https://core.blockstack.org")
 
         val tokenTriple = try {
             blockstack.decodeToken(authResponse)
         } catch (e: IllegalArgumentException) {
-            return Result(null, ResultError(ErrorCode.LoginFailedError, "The authResponse parameter is an invalid base64 encoded token\n" +
+            return@withContext Result(null, ResultError(ErrorCode.LoginFailedError, "The authResponse parameter is an invalid base64 encoded token\n" +
                     "2 dots requires\n" +
                     "Auth response: $authResponse"))
         }
         val tokenPayload = tokenTriple.second
         val isValidToken = blockstack.verifyToken(authResponse)
 
         if (!isValidToken) {
-            return Result(null, ResultError(ErrorCode.LoginFailedError, "invalid auth response"))
+            return@withContext Result(null, ResultError(ErrorCode.LoginFailedError, "invalid auth response"))
         }
         val appPrivateKey = decrypt(tokenPayload.getString("private_key"), transitKey)
 
         if (appPrivateKey == null) {
-            return Result(null, ResultError(ErrorCode.LoginFailedError, "auth response used different transient key"))
+            return@withContext Result(null, ResultError(ErrorCode.LoginFailedError, "auth response used different transient key"))
         }
 
         val coreSessionToken = decrypt(tokenPayload.optString("core_token"), transitKey)
 
         val userData = authResponseToUserData(tokenPayload, nameLookupUrl, appPrivateKey, coreSessionToken, authResponse)
 
-        this.appPrivateKey = appPrivateKey
+        this@BlockstackSession.appPrivateKey  = appPrivateKey
         sessionStore.updateUserData(userData)
 
-        return Result(userData)
+        return@withContext Result(userData)
     }
 
     suspend fun handleUnencryptedSignIn(authResponse: String): Result<UserData> {
@@ -130,7 +132,7 @@ class BlockstackSession(private val sessionStore: ISessionStore, private val app
     private suspend fun extractProfile(tokenPayload: JSONObject, nameLookupUrl: String): JSONObject {
         val profileUrl = tokenPayload.optStringOrNull("profile_url")
         if (profileUrl != null && profileUrl.isNotBlank()) {
-            return withContext(Dispatchers.IO) {
+            return withContext(dispatcher) {
                 val request = Request.Builder().url(profileUrl)
                         .build()
                 val response = callFactory.newCall(request).execute()
@@ -222,7 +224,7 @@ class BlockstackSession(private val sessionStore: ISessionStore, private val app
      */
     suspend fun getFile(path: String, options: GetFileOptions): Result<out Any> {
         Log.d(TAG, "getFile: path: $path options: $options")
-        return withContext(Dispatchers.IO) {
+        return withContext(dispatcher) {
             val urlResult = getFileUrl(path, options)
             if (urlResult.hasErrors) {
                 return@withContext urlResult
@@ -313,12 +315,10 @@ class BlockstackSession(private val sessionStore: ISessionStore, private val app
     }
 
     suspend fun getGaiaAddress(appDomain: String, username: String): String {
-        val fileUrl = blockstack.getUserAppFileUrl("/", username, appDomain, null)
-        val address = Regex("([13][a-km-zA-HJ-NP-Z0-9]{26,35})").find(fileUrl)?.value
-        if (address != null) {
-            return address
-        } else {
-            return ""
+        return withContext(dispatcher) {
+            val fileUrl = blockstack.getUserAppFileUrl("/", username, appDomain, null)
+            val address = Regex("([13][a-km-zA-HJ-NP-Z0-9]{26,35})").find(fileUrl)?.value
+            return@withContext address ?: ""
         }
     }
 
@@ -333,7 +333,7 @@ class BlockstackSession(private val sessionStore: ISessionStore, private val app
      * @property a result object wiht a `String` representation of a url from
      * which you can read the file that was just put.
      */
-    suspend fun putFile(path: String, content: Any, options: PutFileOptions): Result<out String> {
+    suspend fun putFile(path: String, content: Any, options: PutFileOptions): Result<out String> = withContext(dispatcher){
         Log.d(TAG, "putFile: path: ${path} options: ${options}")
         val gaiaHubConfiguration = getOrSetLocalGaiaHubConnection()
         val valid = content is String || content is ByteArray
@@ -378,7 +378,7 @@ class BlockstackSession(private val sessionStore: ISessionStore, private val app
             }
         }
 
-        return withContext(Dispatchers.IO) {
+
             try {
                 val response = hub.uploadToGaiaHub(path, requestContent, gaiaHubConfiguration, contentType)
                 if (!response.isSuccessful) {
@@ -409,7 +409,7 @@ class BlockstackSession(private val sessionStore: ISessionStore, private val app
                         ?: e.toString()))
             }
 
-        }
+
     }
 
     private fun getSignKey(options: PutFileOptions): String {
@@ -440,21 +440,21 @@ class BlockstackSession(private val sessionStore: ISessionStore, private val app
     }
 
 
-    suspend fun deleteFile(path: String, options: DeleteFileOptions = DeleteFileOptions()): Result<out Unit> {
+    suspend fun deleteFile(path: String, options: DeleteFileOptions = DeleteFileOptions()): Result<out Unit> = withContext(dispatcher){
         try {
             val response = hub.deleteFromGaiaHub(path, options.gaiaHubConfig ?: gaiaHubConfig!!)
             if (response != null) {
                 if (response.isSuccessful) {
-                    return Result(Unit)
+                    return@withContext Result(Unit)
                 } else {
-                    return Result(null, ResultError(ErrorCode.NetworkError,
+                    return@withContext Result(null, ResultError(ErrorCode.NetworkError,
                             "failed to delete $path", response.code.toString()))
                 }
             } else {
-                return Result(null, ResultError(ErrorCode.UnknownError, "failed to delete $path"))
+                return@withContext Result(null, ResultError(ErrorCode.UnknownError, "failed to delete $path"))
             }
         } catch (e: Exception) {
-            return Result(null, ResultError(ErrorCode.UnknownError,
+            return@withContext Result(null, ResultError(ErrorCode.UnknownError,
                     "failed to delete $path: ${e.message ?: e.toString()}"))
         }
     }
@@ -487,7 +487,6 @@ class BlockstackSession(private val sessionStore: ISessionStore, private val app
             blockstack.getUserAppFileUrl(path, options.username,
                     options.app ?: appConfig!!.appDomain.getOrigin(),
                     options.zoneFileLookupURL?.toString())
-
         } else {
             val gaiaHubConfig = getOrSetLocalGaiaHubConnection()
             hub.getFullReadUrl(path, gaiaHubConfig)
@@ -506,7 +505,7 @@ class BlockstackSession(private val sessionStore: ISessionStore, private val app
         }
 
         val request = buildListFilesRequest(page, gaiaHubConfig ?: getHubConfig())
-        val response = withContext(Dispatchers.IO) {
+        val response = withContext(dispatcher) {
             callFactory.newCall(request).execute()
         }
         if (!response.isSuccessful) {