git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2022 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.automation.jsscripting.internal;
  14
  15 import static org.openhab.core.automation.module.script.ScriptEngineFactory.*;
  16
  17 import java.io.IOException;
  18 import java.io.InputStream;
  19 import java.nio.channels.SeekableByteChannel;
  20 import java.nio.file.AccessMode;
  21 import java.nio.file.FileSystems;
  22 import java.nio.file.LinkOption;
  23 import java.nio.file.NoSuchFileException;
  24 import java.nio.file.OpenOption;
  25 import java.nio.file.Path;
  26 import java.nio.file.Paths;
  27 import java.nio.file.attribute.FileAttribute;
  28 import java.time.Duration;
  29 import java.time.ZonedDateTime;
  30 import java.util.Collections;
  31 import java.util.Map;
  32 import java.util.Set;
  33 import java.util.concurrent.locks.Lock;
  34 import java.util.concurrent.locks.ReentrantLock;
  35 import java.util.function.Consumer;
  36 import java.util.function.Function;
  37
  38 import javax.script.ScriptContext;
  39 import javax.script.ScriptException;
  40
  41 import org.eclipse.jdt.annotation.Nullable;
  42 import org.graalvm.polyglot.Context;
  43 import org.graalvm.polyglot.Engine;
  44 import org.graalvm.polyglot.HostAccess;
  45 import org.graalvm.polyglot.Value;
  46 import org.openhab.automation.jsscripting.internal.fs.DelegatingFileSystem;
  47 import org.openhab.automation.jsscripting.internal.fs.PrefixedSeekableByteChannel;
  48 import org.openhab.automation.jsscripting.internal.fs.ReadOnlySeekableByteArrayChannel;
  49 import org.openhab.automation.jsscripting.internal.fs.watch.JSDependencyTracker;
  50 import org.openhab.automation.jsscripting.internal.scriptengine.InvocationInterceptingScriptEngineWithInvocableAndAutoCloseable;
  51 import org.openhab.core.automation.module.script.ScriptExtensionAccessor;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54
  55 import com.oracle.truffle.js.scriptengine.GraalJSScriptEngine;
  56
  57 /**
  58  * GraalJS ScriptEngine implementation
  59  *
  60  * @author Jonathan Gilbert - Initial contribution
  61  * @author Dan Cunningham - Script injections
  62  * @author Florian Hotze - Create lock object for multi-thread synchronization; Inject the {@link JSRuntimeFeatures}
  63  *         into the JS context; Fix memory leak caused by HostObject by making HostAccess reference static; Switch to
  64  *         {@link Lock} for multi-thread synchronization
  65  */
  66 public class OpenhabGraalJSScriptEngine
  67         extends InvocationInterceptingScriptEngineWithInvocableAndAutoCloseable<GraalJSScriptEngine> {
  68
  69     private static final Logger LOGGER = LoggerFactory.getLogger(OpenhabGraalJSScriptEngine.class);
  70     private static final String GLOBAL_REQUIRE = "require(\"@jsscripting-globals\");";
  71     private static final String REQUIRE_WRAPPER_NAME = "__wraprequire__";
  72     /** Final CommonJS search path for our library */
  73     private static final Path NODE_DIR = Paths.get("node_modules");
  74     /** Provides unlimited host access as well as custom translations from JS to Java Objects */
  75     private static final HostAccess HOST_ACCESS = HostAccess.newBuilder(HostAccess.ALL)
  76             // Translate JS-Joda ZonedDateTime to java.time.ZonedDateTime
  77             .targetTypeMapping(Value.class, ZonedDateTime.class, (v) -> v.hasMember("withFixedOffsetZone"), v -> {
  78                 return ZonedDateTime.parse(v.invokeMember("withFixedOffsetZone").invokeMember("toString").asString());
  79             }, HostAccess.TargetMappingPrecedence.LOW)
  80
  81             // Translate JS-Joda Duration to java.time.Duration
  82             .targetTypeMapping(Value.class, Duration.class,
  83                     // picking two members to check as Duration has many common function names
  84                     (v) -> v.hasMember("minusDuration") && v.hasMember("toNanos"), v -> {
  85                         return Duration.ofNanos(v.invokeMember("toNanos").asLong());
  86                     }, HostAccess.TargetMappingPrecedence.LOW)
  87             .build();
  88
  89     /** {@link Lock} synchronization of multi-thread access */
  90     private final Lock lock = new ReentrantLock();
  91     private final JSRuntimeFeatures jsRuntimeFeatures;
  92
  93     // these fields start as null because they are populated on first use
  94     private String engineIdentifier;
  95     private @Nullable Consumer<String> scriptDependencyListener;
  96
  97     private boolean initialized = false;
  98     private final String globalScript;
  99
 100     /**
 101      * Creates an implementation of ScriptEngine (& Invocable), wrapping the contained engine, that tracks the script
 102      * lifecycle and provides hooks for scripts to do so too.
 103      */
 104     public OpenhabGraalJSScriptEngine(@Nullable String injectionCode, JSScriptServiceUtil jsScriptServiceUtil) {
 105         super(null); // delegate depends on fields not yet initialised, so we cannot set it immediately
 106         this.globalScript = GLOBAL_REQUIRE + (injectionCode != null ? injectionCode : "");
 107         this.jsRuntimeFeatures = jsScriptServiceUtil.getJSRuntimeFeatures(lock);
 108
 109         LOGGER.debug("Initializing GraalJS script engine...");
 110
 111         delegate = GraalJSScriptEngine.create(
 112                 Engine.newBuilder().allowExperimentalOptions(true).option("engine.WarnInterpreterOnly", "false")
 113                         .build(),
 114                 Context.newBuilder("js").allowExperimentalOptions(true).allowAllAccess(true)
 115                         .allowHostAccess(HOST_ACCESS).option("js.commonjs-require-cwd", JSDependencyTracker.LIB_PATH)
 116                         .option("js.nashorn-compat", "true") // to ease migration
 117                         .option("js.ecmascript-version", "2021") // nashorn compat will enforce es5 compatibility, we
 118                                                                  // want ecma2021
 119                         .option("js.commonjs-require", "true") // enable CommonJS module support
 120                         .hostClassLoader(getClass().getClassLoader())
 121                         .fileSystem(new DelegatingFileSystem(FileSystems.getDefault().provider()) {
 122                             @Override
 123                             public SeekableByteChannel newByteChannel(Path path, Set<? extends OpenOption> options,
 124                                     FileAttribute<?>... attrs) throws IOException {
 125                                 Consumer<String> localScriptDependencyListener = scriptDependencyListener;
 126                                 if (localScriptDependencyListener != null) {
 127                                     localScriptDependencyListener.accept(path.toString());
 128                                 }
 129
 130                                 if (path.toString().endsWith(".js")) {
 131                                     SeekableByteChannel sbc = null;
 132                                     if (isRootNodePath(path)) {
 133                                         InputStream is = getClass().getResourceAsStream(nodeFileToResource(path));
 134                                         if (is == null) {
 135                                             throw new IOException("Could not read " + path.toString());
 136                                         }
 137                                         sbc = new ReadOnlySeekableByteArrayChannel(is.readAllBytes());
 138                                     } else {
 139                                         sbc = super.newByteChannel(path, options, attrs);
 140                                     }
 141                                     return new PrefixedSeekableByteChannel(
 142                                             ("require=" + REQUIRE_WRAPPER_NAME + "(require);").getBytes(), sbc);
 143                                 } else {
 144                                     return super.newByteChannel(path, options, attrs);
 145                                 }
 146                             }
 147
 148                             @Override
 149                             public void checkAccess(Path path, Set<? extends AccessMode> modes,
 150                                     LinkOption... linkOptions) throws IOException {
 151                                 if (isRootNodePath(path)) {
 152                                     if (getClass().getResource(nodeFileToResource(path)) == null) {
 153                                         throw new NoSuchFileException(path.toString());
 154                                     }
 155                                 } else {
 156                                     super.checkAccess(path, modes, linkOptions);
 157                                 }
 158                             }
 159
 160                             @Override
 161                             public Map<String, Object> readAttributes(Path path, String attributes,
 162                                     LinkOption... options) throws IOException {
 163                                 if (isRootNodePath(path)) {
 164                                     return Collections.singletonMap("isRegularFile", true);
 165                                 }
 166                                 return super.readAttributes(path, attributes, options);
 167                             }
 168
 169                             @Override
 170                             public Path toRealPath(Path path, LinkOption... linkOptions) throws IOException {
 171                                 if (isRootNodePath(path)) {
 172                                     return path;
 173                                 }
 174                                 return super.toRealPath(path, linkOptions);
 175                             }
 176                         }));
 177     }
 178
 179     @Override
 180     protected void beforeInvocation() {
 181         lock.lock();
 182
 183         if (initialized) {
 184             return;
 185         }
 186
 187         ScriptContext ctx = delegate.getContext();
 188         if (ctx == null) {
 189             throw new IllegalStateException("Failed to retrieve script context");
 190         }
 191
 192         // these are added post-construction, so we need to fetch them late
 193         this.engineIdentifier = (String) ctx.getAttribute(CONTEXT_KEY_ENGINE_IDENTIFIER);
 194         if (this.engineIdentifier == null) {
 195             throw new IllegalStateException("Failed to retrieve engine identifier from engine bindings");
 196         }
 197
 198         ScriptExtensionAccessor scriptExtensionAccessor = (ScriptExtensionAccessor) ctx
 199                 .getAttribute(CONTEXT_KEY_EXTENSION_ACCESSOR);
 200         if (scriptExtensionAccessor == null) {
 201             throw new IllegalStateException("Failed to retrieve script extension accessor from engine bindings");
 202         }
 203
 204         scriptDependencyListener = (Consumer<String>) ctx
 205                 .getAttribute("oh.dependency-listener"/* CONTEXT_KEY_DEPENDENCY_LISTENER */);
 206         if (scriptDependencyListener == null) {
 207             LOGGER.warn(
 208                     "Failed to retrieve script script dependency listener from engine bindings. Script dependency tracking will be disabled.");
 209         }
 210
 211         ScriptExtensionModuleProvider scriptExtensionModuleProvider = new ScriptExtensionModuleProvider(
 212                 scriptExtensionAccessor, lock);
 213
 214         Function<Function<Object[], Object>, Function<String, Object>> wrapRequireFn = originalRequireFn -> moduleName -> scriptExtensionModuleProvider
 215                 .locatorFor(delegate.getPolyglotContext(), engineIdentifier).locateModule(moduleName)
 216                 .map(m -> (Object) m).orElseGet(() -> originalRequireFn.apply(new Object[] { moduleName }));
 217
 218         delegate.getBindings(ScriptContext.ENGINE_SCOPE).put(REQUIRE_WRAPPER_NAME, wrapRequireFn);
 219         // Injections into the JS runtime
 220         delegate.put("require", wrapRequireFn.apply((Function<Object[], Object>) delegate.get("require")));
 221         jsRuntimeFeatures.getFeatures().forEach((key, obj) -> {
 222             LOGGER.debug("Injecting {} into the JS runtime...", key);
 223             delegate.put(key, obj);
 224         });
 225
 226         initialized = true;
 227
 228         try {
 229             eval(globalScript);
 230         } catch (ScriptException e) {
 231             LOGGER.error("Could not inject global script", e);
 232         }
 233     }
 234
 235     @Override
 236     protected Object afterInvocation(Object obj) {
 237         lock.unlock();
 238         return obj;
 239     }
 240
 241     @Override
 242     protected Exception afterThrowsInvocation(Exception e) {
 243         lock.unlock();
 244         return e;
 245     }
 246
 247     @Override
 248     public void close() {
 249         jsRuntimeFeatures.close();
 250     }
 251
 252     /**
 253      * Tests if this is a root node directory, `/node_modules`, `C:\node_modules`, etc...
 254      *
 255      * @param path a root path
 256      * @return whether the given path is a node root directory
 257      */
 258     private boolean isRootNodePath(Path path) {
 259         return path.startsWith(path.getRoot().resolve(NODE_DIR));
 260     }
 261
 262     /**
 263      * Converts a root node path to a class resource path for loading local modules
 264      * Ex: C:\node_modules\foo.js -> /node_modules/foo.js
 265      *
 266      * @param path a root path, e.g. C:\node_modules\foo.js
 267      * @return the class resource path for loading local modules
 268      */
 269     private String nodeFileToResource(Path path) {
 270         return "/" + path.subpath(0, path.getNameCount()).toString().replace('\\', '/');
 271     }
 272 }