Added EvalSession way of controlling all coroutines started from a script

This commit is contained in:
sergeych committed 2026-04-02 02:05:14 +03:00
1 parent 446c8d9a6e
commit fc01016a74
13 files changed
+482 -94

No files matched your search

@@ -0,0 +1,129 @@
/*
* Copyright 2026 Sergey S. Chernov real.sergeych@gmail.com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package net.sergeych.lyng
import kotlinx.coroutines.*
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.filter
import kotlinx.coroutines.flow.first
import kotlinx.coroutines.flow.update
import kotlinx.coroutines.sync.Mutex
import kotlinx.coroutines.sync.withLock
import net.sergeych.lyng.obj.Obj
import kotlin.coroutines.AbstractCoroutineContextElement
import kotlin.coroutines.CoroutineContext
/**
* Host-managed lifetime owner for coroutines started from Lyng scripts.
*
* The session reuses a single [Scope] across eval calls and tracks async work launched by
* `launch { ... }` and active flow producers created from these evals.
*/
class EvalSession(initialScope: Scope? = null) {
private val ownerJob = SupervisorJob()
private val evalMutex = Mutex()
private val scopeMutex = Mutex()
private val activeJobs = MutableStateFlow(0)
private var _scope: Scope? = initialScope
val scope: Scope? get() = _scope
val isActive: Boolean get() = ownerJob.isActive
val isCancelled: Boolean get() = ownerJob.isCancelled
suspend fun getScope(): Scope = ensureScope()
suspend fun eval(code: String): Obj = eval(code.toSource())
suspend fun eval(source: Source): Obj = evalMutex.withLock {
throwIfCancelled()
val scope = ensureScope()
withEvalSession(this@EvalSession) {
scope.eval(source)
}
}
fun cancel(cause: String? = null) {
ownerJob.cancel(ScriptSessionCancelled(cause ?: "EvalSession cancelled"))
}
suspend fun join() {
activeJobs.filter { it == 0 }.first()
}
suspend fun cancelAndJoin() {
cancel()
join()
}
internal suspend fun <T> launchTrackedDeferred(block: suspend CoroutineScope.() -> T): Deferred<T> {
throwIfCancelled()
val deferred = CoroutineScope(currentTrackedCoroutineContext()).async(block = block)
track(deferred)
return deferred
}
internal suspend fun launchTrackedJob(block: suspend CoroutineScope.() -> Unit): Job {
throwIfCancelled()
val job = CoroutineScope(currentTrackedCoroutineContext()).launch(block = block)
track(job)
return job
}
private suspend fun currentTrackedCoroutineContext(): CoroutineContext {
val base = currentCoroutineContext()
return base.minusKey(Job) + ownerJob + EvalSessionElement(this)
}
private suspend fun ensureScope(): Scope {
_scope?.let { return it }
return scopeMutex.withLock {
_scope ?: Script.newScope().also { _scope = it }
}
}
private fun track(job: Job) {
activeJobs.update { it + 1 }
job.invokeOnCompletion {
activeJobs.update { count -> if (count > 0) count - 1 else 0 }
}
}
internal fun throwIfCancelled() {
if (ownerJob.isCancelled) {
throw ScriptSessionCancelled("EvalSession cancelled")
}
}
companion object {
suspend fun currentOrNull(): EvalSession? = currentCoroutineContext()[EvalSessionElement]?.session
}
}
internal class EvalSessionElement(val session: EvalSession) :
AbstractCoroutineContextElement(EvalSessionElement) {
companion object Key : CoroutineContext.Key<EvalSessionElement>
}
internal suspend fun <T> withEvalSession(session: EvalSession, block: suspend () -> T): T {
return kotlinx.coroutines.withContext(EvalSessionElement(session)) {
block()
}
}
class ScriptSessionCancelled(message: String) : CancellationException(message)
@@ -636,9 +636,17 @@ class Script(
addFn("launch") {
val callable = requireOnlyArg<Obj>()
val captured = this
ObjDeferred(globalDefer {
captured.call(callable)
})
val session = EvalSession.currentOrNull()
val deferred = if (session != null) {
session.launchTrackedDeferred {
captured.call(callable)
}
} else {
globalDefer {
captured.call(callable)
}
}
ObjDeferred(deferred)
}
addFn("yield") {
@@ -649,7 +657,7 @@ class Script(
addFn("flow", callSignature = CallSignature(tailBlockReceiverType = "FlowBuilder")) {
// important is: current context contains closure often used in call;
// we'll need it for the producer
ObjFlow(requireOnlyArg<Obj>(), requireScope())
ObjFlow(requireOnlyArg<Obj>(), requireScope(), EvalSession.currentOrNull())
}
val pi = ObjReal(PI)
@@ -17,6 +17,7 @@
package net.sergeych.lyng.obj
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.DelicateCoroutinesApi
import kotlinx.coroutines.channels.Channel
import kotlinx.coroutines.channels.ChannelResult
@@ -24,6 +25,7 @@ import kotlinx.coroutines.channels.ReceiveChannel
import kotlinx.coroutines.channels.SendChannel
import kotlinx.coroutines.sync.Mutex
import kotlinx.coroutines.sync.withLock
import net.sergeych.lyng.EvalSession
import net.sergeych.lyng.Scope
import net.sergeych.lyng.ScriptFlowIsNoMoreCollected
import net.sergeych.lyng.miniast.ParamDoc
@@ -72,25 +74,34 @@ class ObjFlowBuilder(val output: SendChannel<Obj>) : Obj() {
}
}
private fun createLyngFlowInput(scope: Scope, producer: Obj): ReceiveChannel<Obj> {
private suspend fun createLyngFlowInput(scope: Scope, producer: Obj, ownerSession: EvalSession?): ReceiveChannel<Obj> {
val channel = Channel<Obj>(Channel.RENDEZVOUS)
val builder = ObjFlowBuilder(channel)
val builderScope = scope.createChildScope(newThisObj = builder)
globalLaunch {
val runProducer: suspend CoroutineScope.() -> Unit = {
var failure: Throwable? = null
try {
producer.callOn(builderScope)
} catch (x: ScriptFlowIsNoMoreCollected) {
// premature flow closing, OK
} catch (x: Throwable) {
channel.close(x)
return@globalLaunch
failure = x
}
channel.close()
if (failure != null) {
channel.close(failure)
} else {
channel.close()
}
}
if (ownerSession != null) {
ownerSession.launchTrackedJob(runProducer)
} else {
globalLaunch(block = runProducer)
}
return channel
}
class ObjFlow(val producer: Obj, val scope: Scope) : Obj() {
class ObjFlow(val producer: Obj, val scope: Scope, val ownerSession: EvalSession? = null) : Obj() {
override val objClass get() = type
@@ -109,14 +120,14 @@ class ObjFlow(val producer: Obj, val scope: Scope) : Obj() {
val objFlow = thisAs<ObjFlow>()
ObjFlowIterator(ObjExternCallable.fromBridge {
call(objFlow.producer)
})
}, objFlow.ownerSession)
}
}
}
}
class ObjFlowIterator(val producer: Obj) : Obj() {
class ObjFlowIterator(val producer: Obj, val ownerSession: EvalSession? = null) : Obj() {
override val objClass: ObjClass get() = type
@@ -134,7 +145,7 @@ class ObjFlowIterator(val producer: Obj) : Obj() {
suspend fun hasNext(scope: Scope): ObjBool {
checkNotCancelled(scope)
// cold start:
if (channel == null) channel = createLyngFlowInput(scope, producer)
if (channel == null) channel = createLyngFlowInput(scope, producer, ownerSession)
if (nextItem == null) nextItem = channel!!.receiveCatching()
nextItem?.exceptionOrNull()?.let { throw it }
return ObjBool(nextItem!!.isSuccess)
@@ -0,0 +1,160 @@
/*
* Copyright 2026 Sergey S. Chernov real.sergeych@gmail.com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
import kotlinx.coroutines.async
import kotlinx.coroutines.launch
import kotlinx.coroutines.test.advanceTimeBy
import kotlinx.coroutines.test.runTest
import net.sergeych.lyng.EvalSession
import net.sergeych.lyng.Scope
import net.sergeych.lyng.obj.ObjBool
import net.sergeych.lyng.obj.ObjFlow
import net.sergeych.lyng.obj.ObjInt
import net.sergeych.lyng.obj.ObjList
import kotlin.test.*
class EvalSessionTest {
@Test
fun sessionCreatesAndReusesScope() = runTest {
val session = EvalSession()
assertEquals(null, session.scope)
assertEquals(10L, (session.eval("var x = 10; x") as ObjInt).value)
assertNotNull(session.scope)
assertEquals(session.scope, session.getScope())
assertEquals(15L, (session.eval("x += 5; x") as ObjInt).value)
}
@Test
fun sessionCancelStopsLaunchedCoroutines() = runTest {
val scope = Scope()
val session = EvalSession(scope)
session.eval(
"""
var touched = false
launch {
delay(100)
touched = true
}
"""
.trimIndent()
)
session.cancel()
session.join()
advanceTimeBy(150)
assertFalse((scope.eval("touched") as ObjBool).value)
}
@Test
fun joinObservesWorkStartedByLaterEval() = runTest {
val session = EvalSession(Scope())
session.eval("launch { delay(100) }")
var joined = false
val waiter = launch {
session.join()
joined = true
}
advanceTimeBy(50)
assertFalse(joined)
session.eval("launch { delay(100) }")
advanceTimeBy(60)
assertFalse(joined)
advanceTimeBy(50)
waiter.join()
assertTrue(joined)
}
@Test
fun concurrentEvalCallsAreSerialized() = runTest {
val session = EvalSession(Scope())
session.eval("var counter = 0")
val first = async {
session.eval(
"""
delay(100)
counter += 1
counter
"""
.trimIndent()
) as ObjInt
}
val second = async {
session.eval(
"""
counter += 10
counter
"""
.trimIndent()
) as ObjInt
}
advanceTimeBy(150)
assertEquals(1L, first.await().value)
assertEquals(11L, second.await().value)
assertEquals(11L, (session.eval("counter") as ObjInt).value)
}
@Test
fun joinWaitsForActiveFlowProducer() = runTest {
val scope = Scope()
val session = EvalSession(scope)
val flow = session.eval(
"""
flow {
delay(100)
emit(1)
delay(100)
emit(2)
}
"""
.trimIndent()
) as ObjFlow
var joined = false
var collected: ObjList? = null
val collector = launch {
collected = flow.callMethod(scope, "toList")
}
val waiter = launch {
session.join()
joined = true
}
advanceTimeBy(150)
assertFalse(joined)
advanceTimeBy(100)
collector.join()
waiter.join()
assertTrue(joined)
assertEquals(listOf(1L, 2L), collected!!.list.map { (it as ObjInt).value })
}
}