Skip to content

Fix Graal initialization #21444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Nadahar wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Fix Graal initialization #21444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions bundles/org.openhab.automation.jsscripting/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@
</properties>

<dependencies>
<dependency>
<groupId>org.openhab.core.bundles</groupId>
<artifactId>org.openhab.core.graal</artifactId>
<version>${project.version}</version>
</dependency>
<!-- Graal Polyglot Framework -->
<dependency>
<groupId>org.openhab.osgiify</groupId>
Expand Down
20 changes: 4 additions & 16 deletions bundles/org.openhab.automation.jsscripting/src/main/feature/feature.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,10 @@

<feature name="openhab-automation-jsscripting" description="JavaScript Scripting" version="${project.version}">
<feature>openhab-runtime-base</feature>
<bundle dependency="true" start-level="78">mvn:org.openhab.osgiify/org.graalvm.js.js-language/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.js.js-scriptengine/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.polyglot.polyglot/${graalvm.version}</bundle>
<bundle dependency="true" start-level="78">mvn:org.openhab.osgiify/org.graalvm.regex.regex/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.sdk.collections/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.sdk.jniutils/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.sdk.nativeimage/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.sdk.word/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.shadowed.icu4j/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.shadowed.json/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.shadowed.xz/${graalvm.version}</bundle>
<bundle dependency="true" start-level="78">mvn:org.openhab.osgiify/org.graalvm.tools.chromeinspector-tool/${graalvm.version}</bundle>
<bundle dependency="true" start-level="78">mvn:org.openhab.osgiify/org.graalvm.tools.profiler-tool/${graalvm.version}</bundle>
<bundle dependency="true" start-level="79">mvn:org.openhab.osgiify/org.graalvm.truffle.truffle-api/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.truffle.truffle-compiler/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.truffle.truffle-runtime/${graalvm.version}</bundle>

<requirement>openhab.tp;filter:="(feature=graal-javascript)"</requirement>
<feature dependency="true">openhab.tp-graal-javascript</feature>

<bundle start-level="80">mvn:org.openhab.addons.bundles/org.openhab.automation.jsscripting/${project.version}</bundle>
</feature>
</features>
122 changes: 78 additions & 44 deletions ...src/main/java/org/openhab/automation/jsscripting/internal/GraalJSScriptEngineFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,15 @@
import org.openhab.core.automation.module.script.ScriptDependencyTracker;
import org.openhab.core.automation.module.script.ScriptEngineFactory;
import org.openhab.core.config.core.ConfigurableService;
import org.openhab.core.graal.GraalUtil;
import org.osgi.framework.Constants;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Deactivate;
import org.osgi.service.component.annotations.Modified;
import org.osgi.service.component.annotations.Reference;
import org.osgi.service.component.annotations.ReferenceCardinality;
import org.osgi.service.component.annotations.ReferencePolicy;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.event.Level;
Expand Down Expand Up @@ -70,53 +73,65 @@ public class GraalJSScriptEngineFactory implements ScriptEngineFactory {
/**
* Shared Polyglot {@link Engine} instance to be used by all instances of {@link OpenhabGraalJSScriptEngine}.
*/
private final Engine engine;
private final @Nullable Engine engine;

private final JSScriptServiceUtil jsScriptServiceUtil;
private final JSDependencyTracker jsDependencyTracker;
private volatile @Nullable JSDependencyTracker jsDependencyTracker;

@Activate
public GraalJSScriptEngineFactory(final @Reference JSScriptServiceUtil jsScriptServiceUtil, //
final @Reference JSDependencyTracker jsDependencyTracker, //
final @Reference OSGiScriptExtensionProvider osgiScriptExtensionProvider, // declare dependency on
// OSGiScriptExtensionProvider to
// fix a timing issue where
// openhab-js attempts to lookup
// OSGi services before
// OSGiScriptExtensionProvider is
// active
Map<String, Object> config) {
/*
* declare dependency on OSGiScriptExtensionProvider to fix a timing issue where openhab-js attempts to
* lookup OSGi services before OSGiScriptExtensionProvider is active
*/
final @Reference OSGiScriptExtensionProvider osgiScriptExtensionProvider, Map<String, Object> config) {
logger.debug("Loading GraalJSScriptEngineFactory");

this.jsDependencyTracker = jsDependencyTracker;
this.jsScriptServiceUtil = jsScriptServiceUtil;
this.configuration = new GraalJSScriptEngineConfiguration(config);

if (configuration.isDebuggerEnabled()) {
Engine.Builder engineBuilder = createEngineBuilder();
engineBuilder //
.option("inspect", "0.0.0.0:" + configuration.getDebuggerPort()) //
.option("inspect.Suspend", "false") // Don't pause at startup waiting for debugger to attach
.option("inspect.WaitAttached", "false") // Don't block code execution waiting for debugger to
// attach
.option("inspect.Secure", "false"); // Disable TLS
Engine engine;
try {
engine = engineBuilder.build();
} catch (RuntimeException e) {
logger.error(
"Failed to initialize Graal JavaScript engine with debugger support. Continuing without debugger support.",
e);
engine = createEngineBuilder().build();
}
logger.info("Debugger support is enabled for JavaScript Scripting.");
this.engine = engine;
} else {
this.engine = createEngineBuilder().build();
Engine engine;
try {
engine = createEngine();
logger.debug("GraalJS engine created; language resolution deferred to first use");
} catch (Exception e) {
logger.error("Failed to create GraalJS engine", e);
engine = null;
}
this.engine = engine;
}

if (getLanguage() == null) {
logger.error(LANG_NOT_INITIALIZED_MSG);
private Engine createEngine() {
Thread thread = Thread.currentThread();

// The classloader is swapped during creation to make sure the engine can "see" what it needs
ClassLoader original = thread.getContextClassLoader();
try {
thread.setContextClassLoader(GraalJSScriptEngineFactory.class.getClassLoader());
if (configuration.isDebuggerEnabled()) {
Engine.Builder engineBuilder = createEngineBuilder();
engineBuilder //
.option("inspect", "0.0.0.0:" + configuration.getDebuggerPort()) //
.option("inspect.Suspend", "false") // Don't pause at startup waiting for debugger to attach
.option("inspect.WaitAttached", "false") // Don't block code execution waiting for debugger to
// attach
.option("inspect.Secure", "false"); // Disable TLS
Engine engine;
try {
engine = engineBuilder.build();
} catch (RuntimeException e) {
logger.error(
"Failed to initialize Graal JavaScript engine with debugger support. Continuing without debugger support.",
e);
engine = createEngineBuilder().build();
}
logger.info("Debugger support is enabled for JavaScript Scripting.");
return engine;
} else {
return createEngineBuilder().build();
}
} finally {
thread.setContextClassLoader(original);
}
}

Expand All @@ -134,14 +149,29 @@ private Engine.Builder createEngineBuilder() {

@Deactivate
public void dispose() {
this.engine.close();
Engine engine = this.engine;
if (engine != null) {
engine.close();
}
GraalUtil.clearCache();
}

@Modified
protected void modified(Map<String, ?> config) {
configuration.modified(config);
}

@Reference(cardinality = ReferenceCardinality.OPTIONAL, policy = ReferencePolicy.DYNAMIC)
protected void setJsDependencyTracker(JSDependencyTracker tracker) {
this.jsDependencyTracker = tracker;
}

protected void unsetJsDependencyTracker(JSDependencyTracker tracker) {
if (this.jsDependencyTracker == tracker) {
this.jsDependencyTracker = null;
}
}

@Override
public List<String> getScriptTypes() {
return SCRIPT_TYPES;
Expand All @@ -157,7 +187,15 @@ public void scopeValues(ScriptEngine scriptEngine, Map<String, Object> scopeValu
if (!SCRIPT_TYPES.contains(scriptType)) {
return null;
}
if (getLanguage() == null) {

if (engine == null) {
logger.error("Graal engine not initialized");
return null;
}

// Use the common lock to safely get the language
Language language = GraalUtil.getLanguage(engine, OpenhabGraalJSScriptEngine.LANGUAGE_ID);
if (language == null) {
logger.error(LANG_NOT_INITIALIZED_MSG);
return null;
}
Expand All @@ -170,12 +208,8 @@ public void scopeValues(ScriptEngine scriptEngine, Map<String, Object> scopeValu
return jsDependencyTracker;
}

/**
* Gets the Graal language of {@link OpenhabGraalJSScriptEngine}.
*
* @return the Graal language of {@link OpenhabGraalJSScriptEngine} or {@code null} if not available
*/
private @Nullable Language getLanguage() {
return engine.getLanguages().get(OpenhabGraalJSScriptEngine.LANGUAGE_ID);
@Override
public boolean isReady() {
return GraalUtil.getLanguage(engine, OpenhabGraalJSScriptEngine.LANGUAGE_ID) != null;
}
}
5 changes: 5 additions & 0 deletions bundles/org.openhab.automation.pythonscripting/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@
</properties>

<dependencies>
<dependency>
<groupId>org.openhab.core.bundles</groupId>
<artifactId>org.openhab.core.graal</artifactId>
<version>${project.version}</version>
</dependency>
<!-- Graal Polyglot Framework -->
<dependency>
<groupId>org.openhab.osgiify</groupId>
Expand Down
23 changes: 4 additions & 19 deletions bundles/org.openhab.automation.pythonscripting/src/main/feature/feature.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,10 @@

<feature name="openhab-automation-pythonscripting" description="Python Scripting" version="${project.version}">
<feature>openhab-runtime-base</feature>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.sdk.collections/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.sdk.jniutils/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.sdk.nativeimage/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.sdk.word/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.shadowed.icu4j/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.llvm.llvm-api/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.shadowed.json/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.shadowed.xz/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.polyglot.polyglot/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.truffle.truffle-runtime/${graalvm.version}</bundle>
<bundle dependency="true">mvn:org.openhab.osgiify/org.graalvm.truffle.truffle-compiler/${graalvm.version}</bundle>
<bundle dependency="true" start-level="78">mvn:org.openhab.osgiify/org.graalvm.regex.regex/${graalvm.version}</bundle>
<bundle dependency="true" start-level="78">mvn:org.openhab.osgiify/org.graalvm.tools.chromeinspector-tool/${graalvm.version}</bundle>
<bundle dependency="true" start-level="78">mvn:org.openhab.osgiify/org.graalvm.tools.profiler-tool/${graalvm.version}</bundle>
<bundle dependency="true" start-level="78">mvn:org.openhab.osgiify/org.graalvm.python.python-resources/${graalvm.version}</bundle>
<bundle dependency="true" start-level="78">mvn:org.openhab.osgiify/org.graalvm.python.python-language/${graalvm.version}</bundle>
<bundle dependency="true" start-level="78">mvn:org.openhab.osgiify/org.graalvm.truffle.truffle-nfi/${graalvm.version}</bundle>
<bundle dependency="true" start-level="78">mvn:org.openhab.osgiify/org.graalvm.truffle.truffle-nfi-libffi/${graalvm.version}</bundle>
<bundle dependency="true" start-level="79">mvn:org.openhab.osgiify/org.graalvm.truffle.truffle-api/${graalvm.version}</bundle>

<requirement>openhab.tp;filter:="(feature=graal-python)"</requirement>
<feature dependency="true">openhab.tp-graal-python</feature>

<bundle start-level="80">mvn:org.openhab.addons.bundles/org.openhab.automation.pythonscripting/${project.version}</bundle>
</feature>
</features>
Loading
Loading