ScriptTransformationService: Handle engine removal through ScriptEngineManager #5063
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently, there are two issues: When a ScriptRecord is cleared from the cache, the ScriptTransformationService currently closes the ScriptEngine itself, without involving the ScriptEngineManager. If a transformation script is invoked again after it has been cleared from the scriptCache, the ScriptEngineManager::createScriptEngine call makes the ScriptEngineManager first remove the old engine from its internal "store", which includes invoking the scriptUnloaded hook. This invocation can cause an exception because the engine is already closed (by ScriptTransformationService) and hence function/method invocations inside the engine are not possible anymore. Ff the engine implement Compilable, it is even closed two times by ScriptTransformationService, possibly causing an exception if the ScriptEngine doesn't handle multiple close() calls gracefully. These issues are fixed by properly notifying the ScriptEngineManager when an engine should be removed and leaving the removal handling to the ScriptEngineManager. The issues were discovered while working on openhab#5062. Signed-off-by: Florian Hotze <[email protected]>
florian-h05
changed the title
Nadahar
reviewed
Oct 7, 2025
...ipt/src/main/java/org/openhab/core/automation/module/script/ScriptTransformationService.java
Outdated
Show resolved
Hide resolved
Nadahar
reviewed
Oct 7, 2025
...ipt/src/main/java/org/openhab/core/automation/module/script/ScriptTransformationService.java
Show resolved
Hide resolved
Nadahar
reviewed
Oct 8, 2025
...ipt/src/main/java/org/openhab/core/automation/module/script/ScriptTransformationService.java
Show resolved
Hide resolved
Signed-off-by: Florian Hotze <[email protected]>
florian-h05
force-pushed
the
script-transform-close
branch
from
8e1572b to
95ae1ba
Compare
kaikreuzer
approved these changes
Oct 10, 2025
kaikreuzer
added
the
bug
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, there are two issues:
When a ScriptRecord is cleared from the cache,
the ScriptTransformationService currently closes the ScriptEngine itself, without involving the ScriptEngineManager. If a transformation script is invoked again after it has been cleared from the scriptCache, the ScriptEngineManager::createScriptEngine call makes the ScriptEngineManager first remove the old engine from its internal "store", which includes invoking the scriptUnloaded hook. This invocation can cause an exception because the engine is already closed (by ScriptTransformationService) and hence function/method invocations inside the engine are not possible anymore.
Ff the engine implement Compilable, it is even closed two times by ScriptTransformationService, possibly causing an exception if the ScriptEngine doesn't handle multiple close() calls gracefully.
These issues are fixed by properly notifying the ScriptEngineManager when an engine should be removed and leaving the removal handling to the ScriptEngineManager.
The issues were discovered while working on #5062.