Merge branch 'openhab:main' into worlfown-markdownlinter

Author: lsiepel

.github/scripts/maven-build

@@ -18,7 +18,7 @@ function mvnp() {
     set -o pipefail # exit build with error when pipes fail
     local reactor_size=$(find -name "pom.xml" | grep -vE '/src/|/target/' | wc -l)
     local padding=$(bc -l <<< "scale=0;2*(l($reactor_size)/l(10)+1)")
-    local command=(mvn $@)
+    local command=(./mvnw $@)
     exec "${command[@]}" 2>&1 | # execute, redirect stderr to stdout
         tee "$BUILD_LOG" | # write output to log
         stdbuf -oL grep -aE '^\[INFO\] Building .+ \[.+\]$' | # filter progress
@@ -30,7 +30,7 @@ function build_all() {
     echo
     echo "Building all projects"
     echo
-    echo "+ mvn $ARGUMENTS"
+    echo "+ ./mvnw $ARGUMENTS"
     echo
 
     mvnp $ARGUMENTS
@@ -79,16 +79,16 @@ function addon_projects() {
 
 function build_addon() {
     local addon="$1"
-    local mvn_command="mvn $ARGUMENTS -am -amd -pl $(addon_projects $addon)"
+    local command="./mvnw $ARGUMENTS -am -amd -pl $(addon_projects $addon)"
 
     echo
     echo "Building add-on: $addon"
     echo
-    echo "+ $mvn_command"
+    echo "+ $command"
     echo
 
     set -o pipefail # exit build with error when pipes fail
-    $mvn_command 2>&1 | tee "$BUILD_LOG"
+    $command 2>&1 | tee "$BUILD_LOG"
     exit $?
 }
 
@@ -104,5 +104,5 @@ function build_based_on_changes() {
     fi
 }
 
-mvn -v
+./mvnw -v
 build_based_on_changes

.github/workflows/ci-build.yml

@@ -19,7 +19,6 @@ jobs:
       fail-fast: false
       matrix:
         java: [ '21' ]
-        maven: [ '3.9.10' ]
         os: [ 'ubuntu-24.04' ]
     name: Build (Java ${{ matrix.java }}, ${{ matrix.os }})
     runs-on: ${{ matrix.os }}
@@ -52,12 +51,6 @@ jobs:
           distribution: 'temurin'
           java-version: ${{ matrix.java }}
 
-      # pinning to SHA to mitigate possible supply chain attacks
-      - name: Set up Maven ${{ matrix.maven }}
-        uses: stCarolas/setup-maven@d6af6abeda15e98926a57b5aa970a96bb37f97d1 # v5
-        with:
-          maven-version: ${{ matrix.maven }}
-
       - name: Register Problem Matchers
         if: ${{ matrix.java == '21' }}
         id: problem_matchers

.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,20 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+wrapperVersion=3.3.2
+distributionType=only-script
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.11/apache-maven-3.9.11-bin.zip
+distributionSha256Sum=0d7125e8c91097b36edb990ea5934e6c68b4440eef4ea96510a0f6815e7eeadb

bundles/org.openhab.automation.groovyscripting/README.md

@@ -1,6 +1,6 @@
 # Groovy Scripting
 
-This add-on provides support for [Groovy](https://groovy-lang.org/) 4.0.27 that can be used as a scripting language within automation rules and which eliminates the need to manually install Groovy.
+This add-on provides support for [Groovy](https://groovy-lang.org/) 4.0.28 that can be used as a scripting language within automation rules.
 
 ## Creating Groovy Scripts
 

bundles/org.openhab.automation.groovyscripting/pom.xml

@@ -16,7 +16,7 @@
 
   <properties>
     <bnd.importpackage>com.ibm.icu.*;resolution:=optional,groovy.runtime.metaclass;resolution:=optional,groovyjarjarantlr4.stringtemplate;resolution:=optional,org.abego.treelayout.*;resolution:=optional,org.apache.ivy.*;resolution:=optional,org.fusesource.jansi.*;resolution:=optional,org.stringtemplate.v4.*;resolution:=optional</bnd.importpackage>
-    <groovy.version>4.0.27</groovy.version>
+    <groovy.version>4.0.28</groovy.version>
   </properties>
 
   <dependencies>

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

@@ -73,14 +73,22 @@ public Exception afterThrowsInvocation(Exception e) {
         // OPS4J Pax Logging holds a reference to the exception, which causes the OpenhabGraalJSScriptEngine to not be
         // removed from heap by garbage collection and causing a memory leak.
         // Therefore, don't pass the exceptions itself to the logger, but only their message!
-        if (cause instanceof IllegalArgumentException) {
-            logger.error("Failed to execute script: {}", stringifyThrowable(cause));
-        } else if (cause instanceof PolyglotException) {
-            logger.error("Failed to execute script: {}", stringifyThrowable(cause));
+        if (cause instanceof IllegalArgumentException || cause instanceof PolyglotException) {
+            String strT = stringifyThrowable(cause);
+            logger.error("Failed to execute script: {}", strT);
         }
         return e;
     }
 
+    @Override
+    public void close() {
+        try {
+            super.close();
+        } catch (Exception e) {
+            logger.warn("Ignorable exception during close: {}", stringifyThrowable(e));
+        }
+    }
+
     private String stringifyThrowable(Throwable throwable) {
         String message = throwable.getMessage();
         StackTraceElement[] stackTraceElements = throwable.getStackTrace();
@@ -106,10 +114,9 @@ private void initializeLogger() {
             identifier = fileName.toString().replaceAll("^.*[/\\\\]", "");
         } else if (ruleUID != null) {
             identifier = ruleUID.toString();
-        } else if (ohEngineIdentifier != null) {
-            if (ohEngineIdentifier.toString().startsWith(OPENHAB_TRANSFORMATION_SCRIPT)) {
-                identifier = ohEngineIdentifier.toString().replaceAll(OPENHAB_TRANSFORMATION_SCRIPT, "transformation.");
-            }
+        } else if (ohEngineIdentifier != null
+                && ohEngineIdentifier.toString().startsWith(OPENHAB_TRANSFORMATION_SCRIPT)) {
+            identifier = ohEngineIdentifier.toString().replaceAll(OPENHAB_TRANSFORMATION_SCRIPT, "transformation.");
         }
 
         logger = LoggerFactory.getLogger("org.openhab.automation.script.javascript." + identifier);

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

@@ -54,6 +54,7 @@
 import org.openhab.automation.jsscripting.internal.fs.ReadOnlySeekableByteArrayChannel;
 import org.openhab.automation.jsscripting.internal.fs.watch.JSDependencyTracker;
 import org.openhab.automation.jsscripting.internal.scriptengine.InvocationInterceptingScriptEngineWithInvocableAndCompilableAndAutoCloseable;
+import org.openhab.automation.jsscripting.internal.scriptengine.helper.LifecycleTracker;
 import org.openhab.core.automation.module.script.ScriptExtensionAccessor;
 import org.openhab.core.items.Item;
 import org.openhab.core.library.types.QuantityType;
@@ -138,13 +139,15 @@ public class OpenhabGraalJSScriptEngine
     /** {@link Lock} synchronization of multi-thread access */
     private final Lock lock = new ReentrantLock();
     private final JSRuntimeFeatures jsRuntimeFeatures;
+    private final LifecycleTracker lifecycleTracker = new LifecycleTracker();
     private final GraalJSScriptEngineConfiguration configuration;
 
     // these fields start as null because they are populated on first use
     private @Nullable Consumer<String> scriptDependencyListener;
     private String engineIdentifier = "<uninitialized>";
 
     private boolean initialized = false;
+    private boolean closed = false;
 
     /**
      * Creates an implementation of ScriptEngine {@code (& Invocable)}, wrapping the contained engine,
@@ -283,7 +286,7 @@ protected void beforeInvocation() {
         scriptDependencyListener = localScriptDependencyListener;
 
         ScriptExtensionModuleProvider scriptExtensionModuleProvider = new ScriptExtensionModuleProvider(
-                scriptExtensionAccessor, lock);
+                scriptExtensionAccessor, lock, lifecycleTracker);
 
         // Wrap the "require" function to also allow loading modules from the ScriptExtensionModuleProvider
         Function<Function<Object[], Object>, Function<String, Object>> wrapRequireFn = originalRequireFn -> moduleName -> scriptExtensionModuleProvider
@@ -326,7 +329,7 @@ protected void beforeInvocation() {
     protected String onScript(String script) {
         if (isUiBasedScript() && configuration.isWrapperEnabled()) {
             logger.debug("Wrapping script for engine '{}' ...", engineIdentifier);
-            return "(function() {" + script + "})()";
+            return "(function() {" + System.lineSeparator() + script + System.lineSeparator() + "})()";
         }
         return super.onScript(script);
     }
@@ -345,8 +348,26 @@ protected Exception afterThrowsInvocation(Exception e) {
     }
 
     @Override
-    public void close() {
-        jsRuntimeFeatures.close();
+    public void close() throws Exception {
+        if (closed) {
+            logger.debug("Engine '{}' is already disposed and closed.", engineIdentifier);
+            return;
+        }
+
+        lock.lock();
+        try {
+            try {
+                jsRuntimeFeatures.close();
+                this.lifecycleTracker.dispose();
+            } finally {
+                logger.debug("Engine '{}' disposed.", engineIdentifier);
+                super.close();
+                logger.debug("Engine '{}' closed.", engineIdentifier);
+            }
+        } finally {
+            closed = true;
+            lock.unlock();
+        }
     }
 
     /**

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

@@ -22,6 +22,7 @@
 import org.graalvm.polyglot.Context;
 import org.graalvm.polyglot.Source;
 import org.graalvm.polyglot.Value;
+import org.openhab.automation.jsscripting.internal.scriptengine.helper.LifecycleTracker;
 import org.openhab.automation.jsscripting.internal.threading.ThreadsafeWrappingScriptedAutomationManagerDelegate;
 import org.openhab.core.automation.module.script.ScriptExtensionAccessor;
 import org.openhab.core.automation.module.script.rulesupport.shared.ScriptedAutomationManager;
@@ -30,22 +31,25 @@
  * Class providing script extensions via CommonJS modules (with module name `@runtime`).
  *
  * @author Jonathan Gilbert - Initial contribution
- * @author Florian Hotze - Pass in lock object for multi-thread synchronization; Switch to {@link Lock} for multi-thread
- *         synchronization
+ * @author Florian Hotze - Pass in a lock object for multi-thread synchronisation
+ * @author Florian Hotze - Switch to {@link Lock} for multi-thread synchronisation
+ * @author Florian Hotze - Overwrite lifecycleTracker with our own implementation
  */
-
 @NonNullByDefault
 public class ScriptExtensionModuleProvider {
 
     private static final String RUNTIME_MODULE_PREFIX = "@runtime";
     private static final String DEFAULT_MODULE_NAME = "Defaults";
     private final Lock lock;
+    private final LifecycleTracker lifecycleTracker;
 
     private final ScriptExtensionAccessor scriptExtensionAccessor;
 
-    public ScriptExtensionModuleProvider(ScriptExtensionAccessor scriptExtensionAccessor, Lock lock) {
+    public ScriptExtensionModuleProvider(ScriptExtensionAccessor scriptExtensionAccessor, Lock lock,
+            LifecycleTracker lifecycleTracker) {
         this.scriptExtensionAccessor = scriptExtensionAccessor;
         this.lock = lock;
+        this.lifecycleTracker = lifecycleTracker;
     }
 
     public ModuleLocator locatorFor(Context ctx, String engineIdentifier) {
@@ -68,6 +72,7 @@ private Optional<Value> runtimeModule(String name, String scriptIdentifier, Cont
 
         if (DEFAULT_MODULE_NAME.equals(name)) {
             symbols = scriptExtensionAccessor.findDefaultPresets(scriptIdentifier);
+            symbols.put("lifecycleTracker", lifecycleTracker);
         } else {
             symbols = scriptExtensionAccessor.findPreset(name, scriptIdentifier);
         }
@@ -102,9 +107,9 @@ private Map<String, Object> processValues(Map<String, Object> values) {
         Map<String, Object> rv = new HashMap<>(values);
 
         for (Map.Entry<String, Object> entry : rv.entrySet()) {
-            if (entry.getValue() instanceof ScriptedAutomationManager) {
-                entry.setValue(new ThreadsafeWrappingScriptedAutomationManagerDelegate(
-                        (ScriptedAutomationManager) entry.getValue(), lock));
+            if (entry.getValue() instanceof ScriptedAutomationManager scriptedAutomationManager) {
+                entry.setValue(
+                        new ThreadsafeWrappingScriptedAutomationManagerDelegate(scriptedAutomationManager, lock));
             }
         }
 

bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/scriptengine/helper/LifecycleTracker.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2010-2025 Contributors to the openHAB project
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package org.openhab.automation.jsscripting.internal.scriptengine.helper;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+
+/**
+ * LifecycleTracker implementation
+ *
+ * <p>
+ * We can't use core's lifecycle tracker for JS Scripting, because its dispose hooks are called after the engine has
+ * been closed (which will not work).
+ *
+ * @author Florian Hotze - Initial contribution
+ */
+@NonNullByDefault
+public class LifecycleTracker {
+    private List<Runnable> disposables = new ArrayList<>();
+
+    public void addDisposeHook(Runnable disposable) {
+        disposables.add(disposable);
+    }
+
+    public void dispose() {
+        for (Runnable disposable : disposables) {
+            disposable.run();
+        }
+    }
+}

bundles/org.openhab.automation.jsscriptingnashorn/pom.xml

@@ -16,7 +16,7 @@
 
   <properties>
     <bnd.importpackage>jdk.dynalink.*;resolution:=optional</bnd.importpackage>
-    <asm.version>9.7.1</asm.version>
+    <asm.version>9.8</asm.version>
   </properties>
 
   <dependencies>