[jsscripting] Extend auto-injection configuration with transformations & Update default (openhab#19130)

* [jsscripting] Extend auto-injection configuration with transformations

Signed-off-by: Florian Hotze <dev@florianhotze.com>

Author: florian-h05

bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/GraalJSScriptEngineConfiguration.java

@@ -33,11 +33,11 @@ public class GraalJSScriptEngineConfiguration {
     private static final String CFG_WRAPPER_ENABLED = "wrapperEnabled";
     private static final String CFG_DEPENDENCY_TRACKING_ENABLED = "dependencyTrackingEnabled";
 
-    public static final int INJECTION_DISABLED = 0;
-    public static final int INJECTION_ENABLED_FOR_UI_BASED_SCRIPTS_ONLY = 2;
-    public static final int INJECTION_ENABLED_FOR_ALL_SCRIPTS = 1;
+    private static final int INJECTION_ENABLED_FOR_UI_BASED_SCRIPTS_ONLY = 1;
+    private static final int INJECTION_ENABLED_FOR_UI_BASED_SCRIPTS_AND_TRANSFORMATIONS = 2;
+    private static final int INJECTION_ENABLED_FOR_ALL_SCRIPTS = 3;
 
-    private int injectionEnabled = 2;
+    private int injectionEnabled = INJECTION_ENABLED_FOR_ALL_SCRIPTS;
     private boolean injectionCachingEnabled = true;
     private boolean wrapperEnabled = true;
     private boolean dependencyTrackingEnabled = true;
@@ -91,8 +91,16 @@ private void update(Map<String, ?> config) {
                 Boolean.class, true);
     }
 
-    public boolean isInjection(int type) {
-        return type == injectionEnabled;
+    public boolean isInjectionEnabledForUiBasedScript() {
+        return injectionEnabled >= INJECTION_ENABLED_FOR_UI_BASED_SCRIPTS_ONLY;
+    }
+
+    public boolean isInjectionEnabledForTransformations() {
+        return injectionEnabled >= INJECTION_ENABLED_FOR_UI_BASED_SCRIPTS_AND_TRANSFORMATIONS;
+    }
+
+    public boolean isInjectionEnabledForAllScripts() {
+        return injectionEnabled == INJECTION_ENABLED_FOR_ALL_SCRIPTS;
     }
 
     public boolean isInjectionCachingEnabled() {

bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/OpenhabGraalJSScriptEngine.java

@@ -307,9 +307,9 @@ protected void beforeInvocation() {
             logger.debug("Evaluating cached global script for engine '{}' ...", engineIdentifier);
             delegate.getPolyglotContext().eval(GLOBAL_SOURCE);
 
-            if (configuration.isInjection(GraalJSScriptEngineConfiguration.INJECTION_ENABLED_FOR_ALL_SCRIPTS)
-                    || (isUiBasedScript() && configuration.isInjection(
-                            GraalJSScriptEngineConfiguration.INJECTION_ENABLED_FOR_UI_BASED_SCRIPTS_ONLY))) {
+            if (configuration.isInjectionEnabledForAllScripts()
+                    || (isUiBasedScript() && configuration.isInjectionEnabledForUiBasedScript())
+                    || (isTransformationScript() && configuration.isInjectionEnabledForTransformations())) {
                 if (configuration.isInjectionCachingEnabled()) {
                     logger.debug("Evaluating cached openhab-js injection for engine '{}' ...", engineIdentifier);
                     delegate.getPolyglotContext().eval(OPENHAB_JS_SOURCE);
@@ -385,6 +385,21 @@ private boolean isUiBasedScript() {
                 && !engineIdentifier.startsWith(OPENHAB_TRANSFORMATION_SCRIPT);
     }
 
+    /**
+     * Tests if the current script is a transformation script, i.e. it is created from the script transformation
+     * service.
+     * 
+     * @return true if the script is a transformation script, false otherwise
+     */
+    private boolean isTransformationScript() {
+        ScriptContext ctx = delegate.getContext();
+        if (ctx == null) {
+            logger.warn("Failed to retrieve script context from engine '{}'.", engineIdentifier);
+            return false;
+        }
+        return engineIdentifier.startsWith(OPENHAB_TRANSFORMATION_SCRIPT);
+    }
+
     /**
      * Tests if this is a root node directory, `/node_modules`, `C:\node_modules`, etc...
      *

bundles/org.openhab.automation.jsscripting/src/main/resources/OH-INF/config/config.xml

@@ -19,14 +19,15 @@
 			<label>Inject Global Variables from Helper Library</label>
 			<description><![CDATA[
 			Import all variables from the openHAB JavaScript library for common services like items, things, actions, log, etc... <br>
-			If disabled, the openHAB JavaScript library can be imported manually using"<code>require('openhab')</code>.
+			If disabled, the openHAB JavaScript library can be imported manually using <code>require('openhab')</code>.
 			]]></description>
 			<options>
-				<option value="2">Auto injection enabled only for UI-based scripts (recommended)</option>
-				<option value="1">Auto injection enabled for all scripts, i.e. including file-based scripts</option>
+				<option value="3">Auto injection for all scripts, including file-based scripts and transformations</option>
+				<option value="2">Auto injection for UI-based scripts and transformations</option>
+				<option value="1">Auto injection only for UI-based scripts (recommended)</option>
 				<option value="0">Disable auto-injection and import manually instead</option>
 			</options>
-			<default>2</default>
+			<default>3</default>
 		</parameter>
 		<parameter name="wrapperEnabled" type="boolean" required="true" groupName="environment">
 			<label>Wrap UI-based scripts in Self-Executing Function</label>

bundles/org.openhab.automation.jsscripting/src/main/resources/OH-INF/i18n/jsscripting.properties

@@ -14,9 +14,10 @@ automation.config.jsscripting.group.system.description = This group defines Java
 automation.config.jsscripting.injectionCachingEnabled.label = Cache openHAB JavaScript Library Injection
 automation.config.jsscripting.injectionCachingEnabled.description = Cache the openHAB JavaScript library injection for optimal performance.<br> Disable this option to allow loading the library from the local user configuration directory "automation/js/node_modules". Disabling caching may increase script loading times, especially on less powerful systems.
 automation.config.jsscripting.injectionEnabledV2.label = Inject Global Variables from Helper Library
-automation.config.jsscripting.injectionEnabledV2.description = Import all variables from the openHAB JavaScript library for common services like items, things, actions, log, etc... <br> If disabled, the openHAB JavaScript library can be imported manually using"<code>require('openhab')</code>.
-automation.config.jsscripting.injectionEnabledV2.option.2 = Auto injection enabled only for UI-based scripts (recommended)
-automation.config.jsscripting.injectionEnabledV2.option.1 = Auto injection enabled for all scripts, i.e. including file-based scripts
+automation.config.jsscripting.injectionEnabledV2.description = Import all variables from the openHAB JavaScript library for common services like items, things, actions, log, etc... <br> If disabled, the openHAB JavaScript library can be imported manually using <code>require('openhab')</code>.
+automation.config.jsscripting.injectionEnabledV2.option.3 = Auto injection for all scripts, including file-based scripts and transformations
+automation.config.jsscripting.injectionEnabledV2.option.2 = Auto injection for UI-based scripts and transformations
+automation.config.jsscripting.injectionEnabledV2.option.1 = Auto injection only for UI-based scripts (recommended)
 automation.config.jsscripting.injectionEnabledV2.option.0 = Disable auto-injection and import manually instead
 automation.config.jsscripting.wrapperEnabled.label = Wrap UI-based scripts in Self-Executing Function
 automation.config.jsscripting.wrapperEnabled.description = Wrapping UI-based scripts in a self-executing function allows the use of the <code>let</code> and <code>const</code> variable declarations, as well as the use of <code>function</code> and <code>class</code> declarations.<br> With this option enabled, you can also use <code>return</code> statements in your scripts to abort execution at any point.