PubNub SDK v5.1.3 release.

Author: client-engineering-bot

.pubnub.yml

@@ -1,10 +1,17 @@
 name: kotlin
-version: 5.1.2
+version: 5.1.3
 schema: 1
 scm: github.com/pubnub/kotlin
 files:
-  - build/libs/pubnub-kotlin-5.1.2-all.jar
+  - build/libs/pubnub-kotlin-5.1.3-all.jar
 changelog:
+  -
+    version: v5.1.3
+    date: 2021-03-24
+    changes:
+      -
+        type: bug
+        text: "Properly canceling HTTP requests when OkHttp client 3.14.9 used."
   -
     version: v5.1.2
     date: 2021-03-09

CHANGELOG.md

@@ -1,9 +1,8 @@
-## [v5.1.2](https://github.com/pubnub/kotlin/releases/tag/v5.1.2)
-March 9 2021
+## [v5.1.3](https://github.com/pubnub/kotlin/releases/tag/v5.1.3)
+March 24 2021
 
-[Full Changelog](https://github.com/pubnub/kotlin/compare/v5.1.1...v5.1.2)
+[Full Changelog](https://github.com/pubnub/kotlin/compare/v5.1.2...v5.1.3)
 
-- In some specific timing conditions subscription loop could loose reference to one of the retrofit call and we would loose posibility to control it. In the meantime we'd start yet another subscription call. One of them is obviously not necessary Synchronization has been improved so it's no longer possible. 
-- It was not possible to properly cancel the OkHttp connection when Google Security Provider (ProviderInstaller) is being used. 
+- Properly canceling HTTP requests when OkHttp client 3.14.9 used. 
 
 

README.md

@@ -23,7 +23,7 @@ You will need the publish and subscribe keys to authenticate your app. Get your
      <dependency>
         <groupId>com.pubnub</groupId>
         <artifactId>pubnub-gson</artifactId>
-        <version>5.1.2</version>
+        <version>5.1.3</version>
      </dependency>
      ```
 

build.gradle

@@ -9,10 +9,11 @@ plugins {
     id "jacoco"
     id 'org.jetbrains.dokka' version '0.10.1'
     id 'org.unbroken-dome.test-sets' version '3.0.1'
+    id "com.github.ben-manes.versions" version '0.38.0'
 }
 
 group = 'com.pubnub'
-version = '5.1.2'
+version = '5.1.3'
 
 repositories {
     mavenCentral()

src/main/kotlin/com/pubnub/api/PubNub.kt

@@ -79,7 +79,7 @@ class PubNub(val configuration: PNConfiguration) {
 
     private companion object Constants {
         private const val TIMESTAMP_DIVIDER = 1000
-        private const val SDK_VERSION = "5.1.2"
+        private const val SDK_VERSION = "5.1.3"
         private const val MAX_SEQUENCE = 65535
     }
 

src/main/kotlin/com/pubnub/api/managers/RetrofitManager.kt

@@ -18,7 +18,7 @@ import com.pubnub.api.services.SubscribeService
 import com.pubnub.api.services.TimeService
 import okhttp3.Call
 import okhttp3.OkHttpClient
-import okhttp3.PNCallFactory
+import com.pubnub.okhttp3.PNCallFactory
 import okhttp3.logging.HttpLoggingInterceptor
 import retrofit2.Retrofit
 import java.util.concurrent.ExecutorService

src/main/kotlin/com/pubnub/okhttp3/PNCall.kt

@@ -0,0 +1,59 @@
+package com.pubnub.okhttp3
+
+import okhttp3.Call
+import okhttp3.Connection
+import org.slf4j.LoggerFactory
+import java.net.SocketException
+import kotlin.reflect.full.declaredMemberFunctions
+import kotlin.reflect.jvm.isAccessible
+
+internal class PNCall(
+    private val realCall: Call
+) : Call by realCall {
+    private val log = LoggerFactory.getLogger("PNCall")
+
+    override fun cancel() {
+        try {
+            realCall.getConnection()?.socket()?.shutdownInput()
+        } catch (se: SocketException) {
+            log.warn("Caught exception when canceling call", se)
+        } catch (uoe: UnsupportedOperationException) {
+            // silent catch
+        }
+        realCall.cancel()
+    }
+
+    private fun Call.getConnection(): Connection? =
+        when {
+            isTransmitterAvailable() -> accessField("transmitter")?.accessField("connection")
+            isStreamAllocationAvailable() -> callPrivateFunction("streamAllocation")?.accessField("connection")
+            else -> {
+                log.warn("Unrecognized version of OkHttp client. This may cause unexpected behavior when Security Provider updated on Android")
+                null
+            }
+        } as Connection?
+
+    private fun <T : Call> T.isTransmitterAvailable(): Boolean = this::class.java.hasField("transmitter")
+
+    private fun <T : Call> T.isStreamAllocationAvailable(): Boolean = this::class.java
+        .hasMethod("streamAllocation")
+
+    private fun <T : Any> T.accessField(fieldName: String): Any? {
+        return javaClass.getDeclaredField(fieldName).let { field ->
+            field.isAccessible = true
+            return@let field.get(this)
+        }
+    }
+
+    private fun <T : Any> T.callPrivateFunction(name: String, vararg args: Any?): Any? =
+        this::class
+            .declaredMemberFunctions
+            .firstOrNull { it.name == name }
+            ?.apply { isAccessible = true }
+            ?.call(this, *args)
+
+    private fun Class<*>.hasField(fieldName: String): Boolean =
+        try { getDeclaredField(fieldName) != null } catch (e: Exception) { false }
+
+    private fun Class<*>.hasMethod(methodName: String): Boolean = declaredMethods.any { it.name == methodName }
+}

src/main/kotlin/okhttp3/PNCallFactory.kt renamed to src/main/kotlin/com/pubnub/okhttp3/PNCallFactory.kt

@@ -1,7 +1,10 @@
-package okhttp3
+package com.pubnub.okhttp3
+
+import okhttp3.Call
+import okhttp3.Request
 
 internal class PNCallFactory(private val callFactory: Call.Factory) : Call.Factory {
     override fun newCall(request: Request): Call {
-        return PNCall(callFactory.newCall(request) as RealCall)
+        return PNCall(callFactory.newCall(request))
     }
 }

src/main/kotlin/okhttp3/PNCall.kt

@@ -67,7 +67,7 @@ class PubNubTest : BaseTest() {
     fun getVersionAndTimeStamp() {
         val version = pubnub.version
         val timeStamp = pubnub.timestamp()
-        assertEquals("5.1.2", version)
+        assertEquals("5.1.3", version)
         assertTrue(timeStamp > 0)
     }
 }