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.io.InputStreamReader;
  20 import java.io.Reader;
  21 import java.nio.channels.SeekableByteChannel;
  22 import java.nio.file.AccessMode;
  23 import java.nio.file.FileSystems;
  24 import java.nio.file.LinkOption;
  25 import java.nio.file.NoSuchFileException;
  26 import java.nio.file.OpenOption;
  27 import java.nio.file.Path;
  28 import java.nio.file.Paths;
  29 import java.nio.file.attribute.FileAttribute;
  30 import java.time.Duration;
  31 import java.time.ZonedDateTime;
  32 import java.util.Collections;
  33 import java.util.Map;
  34 import java.util.Set;
  35 import java.util.concurrent.locks.Lock;
  36 import java.util.concurrent.locks.ReentrantLock;
  37 import java.util.function.Consumer;
  38 import java.util.function.Function;
  39
  40 import javax.script.ScriptContext;
  41 import javax.script.ScriptException;
  42
  43 import org.eclipse.jdt.annotation.Nullable;
  44 import org.graalvm.polyglot.Context;
  45 import org.graalvm.polyglot.Engine;
  46 import org.graalvm.polyglot.HostAccess;
  47 import org.graalvm.polyglot.Source;
  48 import org.graalvm.polyglot.Value;
  49 import org.openhab.automation.jsscripting.internal.fs.DelegatingFileSystem;
  50 import org.openhab.automation.jsscripting.internal.fs.PrefixedSeekableByteChannel;
  51 import org.openhab.automation.jsscripting.internal.fs.ReadOnlySeekableByteArrayChannel;
  52 import org.openhab.automation.jsscripting.internal.fs.watch.JSDependencyTracker;
  53 import org.openhab.automation.jsscripting.internal.scriptengine.InvocationInterceptingScriptEngineWithInvocableAndAutoCloseable;
  54 import org.openhab.core.automation.module.script.ScriptExtensionAccessor;
  55 import org.slf4j.Logger;
  56 import org.slf4j.LoggerFactory;
  57
  58 import com.oracle.truffle.js.scriptengine.GraalJSScriptEngine;
  59
  60 /**
  61  * GraalJS ScriptEngine implementation
  62  *
  63  * @author Jonathan Gilbert - Initial contribution
  64  * @author Dan Cunningham - Script injections
  65  * @author Florian Hotze - Create lock object for multi-thread synchronization; Inject the {@link JSRuntimeFeatures}
  66  *         into the JS context; Fix memory leak caused by HostObject by making HostAccess reference static; Switch to
  67  *         {@link Lock} for multi-thread synchronization; globals & openhab-js injection code caching
  68  */
  69 public class OpenhabGraalJSScriptEngine
  70         extends InvocationInterceptingScriptEngineWithInvocableAndAutoCloseable<GraalJSScriptEngine> {
  71
  72     private static final Logger LOGGER = LoggerFactory.getLogger(OpenhabGraalJSScriptEngine.class);
  73     private static Source GLOBAL_SOURCE;
  74
  75     static {
  76         try {
  77             GLOBAL_SOURCE = Source.newBuilder("js", getFileAsReader("node_modules/@jsscripting-globals.js"),
  78                     "@jsscripting-globals.js").cached(true).build();
  79         } catch (IOException e) {
  80             throw new RuntimeException("Failed to load @jsscripting-globals.js", e);
  81         }
  82     }
  83
  84     private static Source OPENHAB_JS_SOURCE;
  85
  86     static {
  87         try {
  88             OPENHAB_JS_SOURCE = Source
  89                     .newBuilder("js", getFileAsReader("node_modules/@openhab-globals.js"), "@openhab-globals.js")
  90                     .cached(true).build();
  91         } catch (IOException e) {
  92             throw new RuntimeException("Failed to load @openhab-globals.js", e);
  93         }
  94     }
  95     private static String OPENHAB_JS_INJECTION_CODE = "Object.assign(this, require('openhab'));";
  96
  97     private static final String REQUIRE_WRAPPER_NAME = "__wraprequire__";
  98     /** Final CommonJS search path for our library */
  99     private static final Path NODE_DIR = Paths.get("node_modules");
 100     /** Shared Polyglot {@link Engine} across all instances of {@link OpenhabGraalJSScriptEngine} */
 101     private static final Engine ENGINE = Engine.newBuilder().allowExperimentalOptions(true)
 102             .option("engine.WarnInterpreterOnly", "false").build();
 103     /** Provides unlimited host access as well as custom translations from JS to Java Objects */
 104     private static final HostAccess HOST_ACCESS = HostAccess.newBuilder(HostAccess.ALL)
 105             // Translate JS-Joda ZonedDateTime to java.time.ZonedDateTime
 106             .targetTypeMapping(Value.class, ZonedDateTime.class, (v) -> v.hasMember("withFixedOffsetZone"), v -> {
 107                 return ZonedDateTime.parse(v.invokeMember("withFixedOffsetZone").invokeMember("toString").asString());
 108             }, HostAccess.TargetMappingPrecedence.LOW)
 109
 110             // Translate JS-Joda Duration to java.time.Duration
 111             .targetTypeMapping(Value.class, Duration.class,
 112                     // picking two members to check as Duration has many common function names
 113                     (v) -> v.hasMember("minusDuration") && v.hasMember("toNanos"), v -> {
 114                         return Duration.ofNanos(v.invokeMember("toNanos").asLong());
 115                     }, HostAccess.TargetMappingPrecedence.LOW)
 116             .build();
 117
 118     /** {@link Lock} synchronization of multi-thread access */
 119     private final Lock lock = new ReentrantLock();
 120     private final JSRuntimeFeatures jsRuntimeFeatures;
 121
 122     // these fields start as null because they are populated on first use
 123     private String engineIdentifier;
 124     private @Nullable Consumer<String> scriptDependencyListener;
 125
 126     private boolean initialized = false;
 127     private final boolean injectionEnabled;
 128     private final boolean useIncludedLibrary;
 129
 130     /**
 131      * Creates an implementation of ScriptEngine (& Invocable), wrapping the contained engine, that tracks the script
 132      * lifecycle and provides hooks for scripts to do so too.
 133      */
 134     public OpenhabGraalJSScriptEngine(boolean injectionEnabled, boolean useIncludedLibrary,
 135             JSScriptServiceUtil jsScriptServiceUtil) {
 136         super(null); // delegate depends on fields not yet initialised, so we cannot set it immediately
 137         this.injectionEnabled = injectionEnabled;
 138         this.useIncludedLibrary = useIncludedLibrary;
 139         this.jsRuntimeFeatures = jsScriptServiceUtil.getJSRuntimeFeatures(lock);
 140
 141         LOGGER.debug("Initializing GraalJS script engine...");
 142
 143         delegate = GraalJSScriptEngine.create(ENGINE,
 144                 Context.newBuilder("js").allowExperimentalOptions(true).allowAllAccess(true)
 145                         .allowHostAccess(HOST_ACCESS).option("js.commonjs-require-cwd", JSDependencyTracker.LIB_PATH)
 146                         .option("js.nashorn-compat", "true") // Enable Nashorn compat mode as openhab-js relies on
 147                                                              // accessors, see
 148                                                              // https://github.com/oracle/graaljs/blob/master/docs/user/NashornMigrationGuide.md#accessors
 149                         .option("js.ecmascript-version", "2022") // If Nashorn compat is enabled, it will enforce ES5
 150                                                                  // compatibility, we want ECMA2022
 151                         .option("js.commonjs-require", "true") // Enable CommonJS module support
 152                         .hostClassLoader(getClass().getClassLoader())
 153                         .fileSystem(new DelegatingFileSystem(FileSystems.getDefault().provider()) {
 154                             @Override
 155                             public SeekableByteChannel newByteChannel(Path path, Set<? extends OpenOption> options,
 156                                     FileAttribute<?>... attrs) throws IOException {
 157                                 Consumer<String> localScriptDependencyListener = scriptDependencyListener;
 158                                 if (localScriptDependencyListener != null) {
 159                                     localScriptDependencyListener.accept(path.toString());
 160                                 }
 161
 162                                 if (path.toString().endsWith(".js")) {
 163                                     SeekableByteChannel sbc = null;
 164                                     if (isRootNodePath(path)) {
 165                                         InputStream is = getClass().getResourceAsStream(nodeFileToResource(path));
 166                                         if (is == null) {
 167                                             throw new IOException("Could not read " + path.toString());
 168                                         }
 169                                         sbc = new ReadOnlySeekableByteArrayChannel(is.readAllBytes());
 170                                     } else {
 171                                         sbc = super.newByteChannel(path, options, attrs);
 172                                     }
 173                                     return new PrefixedSeekableByteChannel(
 174                                             ("require=" + REQUIRE_WRAPPER_NAME + "(require);").getBytes(), sbc);
 175                                 } else {
 176                                     return super.newByteChannel(path, options, attrs);
 177                                 }
 178                             }
 179
 180                             @Override
 181                             public void checkAccess(Path path, Set<? extends AccessMode> modes,
 182                                     LinkOption... linkOptions) throws IOException {
 183                                 if (isRootNodePath(path)) {
 184                                     if (getClass().getResource(nodeFileToResource(path)) == null) {
 185                                         throw new NoSuchFileException(path.toString());
 186                                     }
 187                                 } else {
 188                                     super.checkAccess(path, modes, linkOptions);
 189                                 }
 190                             }
 191
 192                             @Override
 193                             public Map<String, Object> readAttributes(Path path, String attributes,
 194                                     LinkOption... options) throws IOException {
 195                                 if (isRootNodePath(path)) {
 196                                     return Collections.singletonMap("isRegularFile", true);
 197                                 }
 198                                 return super.readAttributes(path, attributes, options);
 199                             }
 200
 201                             @Override
 202                             public Path toRealPath(Path path, LinkOption... linkOptions) throws IOException {
 203                                 if (isRootNodePath(path)) {
 204                                     return path;
 205                                 }
 206                                 return super.toRealPath(path, linkOptions);
 207                             }
 208                         }));
 209     }
 210
 211     @Override
 212     protected void beforeInvocation() {
 213         super.beforeInvocation();
 214
 215         lock.lock();
 216
 217         if (initialized) {
 218             return;
 219         }
 220
 221         ScriptContext ctx = delegate.getContext();
 222         if (ctx == null) {
 223             throw new IllegalStateException("Failed to retrieve script context");
 224         }
 225
 226         // these are added post-construction, so we need to fetch them late
 227         this.engineIdentifier = (String) ctx.getAttribute(CONTEXT_KEY_ENGINE_IDENTIFIER);
 228         if (this.engineIdentifier == null) {
 229             throw new IllegalStateException("Failed to retrieve engine identifier from engine bindings");
 230         }
 231
 232         ScriptExtensionAccessor scriptExtensionAccessor = (ScriptExtensionAccessor) ctx
 233                 .getAttribute(CONTEXT_KEY_EXTENSION_ACCESSOR);
 234         if (scriptExtensionAccessor == null) {
 235             throw new IllegalStateException("Failed to retrieve script extension accessor from engine bindings");
 236         }
 237
 238         scriptDependencyListener = (Consumer<String>) ctx
 239                 .getAttribute("oh.dependency-listener"/* CONTEXT_KEY_DEPENDENCY_LISTENER */);
 240         if (scriptDependencyListener == null) {
 241             LOGGER.warn(
 242                     "Failed to retrieve script script dependency listener from engine bindings. Script dependency tracking will be disabled.");
 243         }
 244
 245         ScriptExtensionModuleProvider scriptExtensionModuleProvider = new ScriptExtensionModuleProvider(
 246                 scriptExtensionAccessor, lock);
 247
 248         // Wrap the "require" function to also allow loading modules from the ScriptExtensionModuleProvider
 249         Function<Function<Object[], Object>, Function<String, Object>> wrapRequireFn = originalRequireFn -> moduleName -> scriptExtensionModuleProvider
 250                 .locatorFor(delegate.getPolyglotContext(), engineIdentifier).locateModule(moduleName)
 251                 .map(m -> (Object) m).orElseGet(() -> originalRequireFn.apply(new Object[] { moduleName }));
 252         delegate.getBindings(ScriptContext.ENGINE_SCOPE).put(REQUIRE_WRAPPER_NAME, wrapRequireFn);
 253         delegate.put("require", wrapRequireFn.apply((Function<Object[], Object>) delegate.get("require")));
 254
 255         // Injections into the JS runtime
 256         jsRuntimeFeatures.getFeatures().forEach((key, obj) -> {
 257             LOGGER.debug("Injecting {} into the JS runtime...", key);
 258             delegate.put(key, obj);
 259         });
 260
 261         initialized = true;
 262
 263         try {
 264             LOGGER.debug("Evaluating cached global script...");
 265             delegate.getPolyglotContext().eval(GLOBAL_SOURCE);
 266             if (this.injectionEnabled) {
 267                 if (this.useIncludedLibrary) {
 268                     LOGGER.debug("Evaluating cached openhab-js injection...");
 269                     delegate.getPolyglotContext().eval(OPENHAB_JS_SOURCE);
 270                 } else {
 271                     LOGGER.debug("Evaluating openhab-js injection from the file system...");
 272                     eval(OPENHAB_JS_INJECTION_CODE);
 273                 }
 274             }
 275             LOGGER.debug("Successfully initialized GraalJS script engine.");
 276         } catch (ScriptException e) {
 277             LOGGER.error("Could not inject global script", e);
 278         }
 279     }
 280
 281     @Override
 282     protected Object afterInvocation(Object obj) {
 283         lock.unlock();
 284         return super.afterInvocation(obj);
 285     }
 286
 287     @Override
 288     protected Exception afterThrowsInvocation(Exception e) {
 289         lock.unlock();
 290         return super.afterThrowsInvocation(e);
 291     }
 292
 293     @Override
 294     public void close() {
 295         jsRuntimeFeatures.close();
 296     }
 297
 298     /**
 299      * Tests if this is a root node directory, `/node_modules`, `C:\node_modules`, etc...
 300      *
 301      * @param path a root path
 302      * @return whether the given path is a node root directory
 303      */
 304     private boolean isRootNodePath(Path path) {
 305         return path.startsWith(path.getRoot().resolve(NODE_DIR));
 306     }
 307
 308     /**
 309      * Converts a root node path to a class resource path for loading local modules
 310      * Ex: C:\node_modules\foo.js -> /node_modules/foo.js
 311      *
 312      * @param path a root path, e.g. C:\node_modules\foo.js
 313      * @return the class resource path for loading local modules
 314      */
 315     private String nodeFileToResource(Path path) {
 316         return "/" + path.subpath(0, path.getNameCount()).toString().replace('\\', '/');
 317     }
 318
 319     /**
 320      * @param fileName filename relative to the resources folder
 321      * @return file as {@link InputStreamReader}
 322      */
 323     private static Reader getFileAsReader(String fileName) throws IOException {
 324         InputStream ioStream = OpenhabGraalJSScriptEngine.class.getClassLoader().getResourceAsStream(fileName);
 325
 326         if (ioStream == null) {
 327             throw new IOException(fileName + " not found");
 328         }
 329
 330         return new InputStreamReader(ioStream);
 331     }
 332 }