Merge pull request #359 from A1shK/debuggable-timeout

[Android] Allowing timeout to be configured through PlayerRuntimeConfig
player-ui · May 22, 2024 · 5eab9a8 · 5eab9a8
2 parents cef2a5f + 3e8b091
commit 5eab9a8
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 9 deletions.
diff --git a/android/player/src/main/java/com/intuit/playerui/android/AndroidPlayer.kt b/android/player/src/main/java/com/intuit/playerui/android/AndroidPlayer.kt
@@ -317,5 +317,6 @@ public class AndroidPlayer private constructor(
     public data class Config(
         override var debuggable: Boolean = false,
         override var coroutineExceptionHandler: CoroutineExceptionHandler? = null,
+        override var timeout: Long = if (debuggable) Int.MAX_VALUE.toLong() else 5000,
     ) : PlayerRuntimeConfig()
 }
diff --git a/docs/site/pages/getting-started.mdx b/docs/site/pages/getting-started.mdx
@@ -115,8 +115,19 @@ var body: some View {
 
 ```kotlin
 // create Android Player with reference assets plugin
-val player = AndroidPlayer(ReferenceAssetsPlugin())
+val player = AndroidPlayer(
+    listOf(
+        ReferenceAssetsPlugin(),
+        // Any other plugins
+    )
+)
 ```
+Apart from providing a list of plugins while setting up `AndroidPlayer`, you can also provide a `config` object that has the following options:
+ - `debuggable` - Indicates if the runtime is debuggable on android through chromium devtools, enabling this would let you set breakpoints in js code as you're running it on android.
+ - `coroutineExceptionHandler` - [CoroutineExceptionHandler](https://kotlinlang.org/docs/exception-handling.html#coroutineexceptionhandler) should handle all uncaught exceptions while using the runtime coroutine scope.
+ - `timeout` - Timeout for the JS thread. If none is provided then it is set as `if (debuggable) Int.MAX_VALUE.toLong() else 5000`.
+
+
   </android>
 </PlatformTabs>
 

diff --git a/jvm/core/src/main/kotlin/com/intuit/playerui/core/bridge/runtime/PlayerRuntimeConfig.kt b/jvm/core/src/main/kotlin/com/intuit/playerui/core/bridge/runtime/PlayerRuntimeConfig.kt
@@ -6,4 +6,5 @@ import kotlinx.coroutines.CoroutineExceptionHandler
 public open class PlayerRuntimeConfig {
     public open var debuggable: Boolean = false
     public open var coroutineExceptionHandler: CoroutineExceptionHandler? = null
+    public open var timeout: Long = if (debuggable) Int.MAX_VALUE.toLong() else 5000
 }
diff --git a/jvm/j2v8/src/main/kotlin/com/intuit/playerui/j2v8/bridge/runtime/V8Runtime.kt b/jvm/j2v8/src/main/kotlin/com/intuit/playerui/j2v8/bridge/runtime/V8Runtime.kt
@@ -204,6 +204,7 @@ public data class J2V8RuntimeConfig(
     private val explicitExecutorService: ExecutorService? = null,
     override var debuggable: Boolean = false,
     override var coroutineExceptionHandler: CoroutineExceptionHandler? = null,
+    override var timeout: Long = if (debuggable) Int.MAX_VALUE.toLong() else 5000,
 ) : PlayerRuntimeConfig() {
     public val executorService: ExecutorService by lazy {
         explicitExecutorService ?: Executors.newSingleThreadExecutor {

diff --git a/jvm/j2v8/src/main/kotlin/com/intuit/playerui/j2v8/extensions/Lock.kt b/jvm/j2v8/src/main/kotlin/com/intuit/playerui/j2v8/extensions/Lock.kt
@@ -10,9 +10,8 @@ import kotlinx.coroutines.withTimeout
 
 internal suspend fun <Context : V8Value, T> Context.evaluateInJSThread(
     runtime: Runtime<V8Value>,
-    timeout: Long = 5000,
     block: suspend Context.() -> T,
-): T = withTimeout(timeout) {
+): T = withTimeout(runtime.config.timeout) {
     if (runtime.isReleased()) throw PlayerRuntimeException(runtime, "Runtime object has been released!")
     withContext(runtime.dispatcher) {
         runtime.scope.ensureActive()
@@ -22,7 +21,6 @@ internal suspend fun <Context : V8Value, T> Context.evaluateInJSThread(
 
 internal fun <Context : V8Value, T> Context.evaluateInJSThreadBlocking(
     runtime: Runtime<V8Value>,
-    timeout: Long = 5000,
     block: Context.() -> T,
 ): T {
     if (runtime.isReleased()) throw PlayerRuntimeException(runtime, "Runtime object has been released!")
@@ -32,19 +30,17 @@ internal fun <Context : V8Value, T> Context.evaluateInJSThreadBlocking(
     } else {
         runtime.checkBlockingThread(Thread.currentThread())
         runBlocking {
-            evaluateInJSThread(runtime, timeout, block)
+            evaluateInJSThread(runtime, block)
         }
     }
 }
 
 internal suspend fun <Context : V8Value, T> Context.evaluateInJSThreadIfDefined(
     runtime: Runtime<V8Value>,
-    timeout: Long = 5000,
     block: suspend Context.() -> T,
-): T? = mapUndefinedToNull()?.let { evaluateInJSThread(runtime, timeout, block) }
+): T? = mapUndefinedToNull()?.let { evaluateInJSThread(runtime, block) }
 
 internal fun <Context : V8Value, T> Context.evaluateInJSThreadIfDefinedBlocking(
     runtime: Runtime<V8Value>,
-    timeout: Long = 5000,
     block: Context.() -> T,
-): T? = mapUndefinedToNull()?.let { evaluateInJSThreadBlocking(runtime, timeout, block) }
+): T? = mapUndefinedToNull()?.let { evaluateInJSThreadBlocking(runtime, block) }