JSScripting in v3.2 loads node_modules on startup?

csowada · December 20, 2021, 6:29pm

Hello,

I’m playing around to with jsscripting in 3.2 to replace my custom stuff from 3.1. It’s really cool to see the javascript development in 3.2. I’m a bit surprised that all files from the js\node_modules directories are loaded at startup. This leads to a lot of errors at startup. The files should be loaded only by a require(). As it looks they are the import statements of @js-joda.

Here is an example:

19:15:24.886 [INFO ] [.rulesupport.loader.ScriptFileWatcher] - Loading script '/C:/openhab/OPENHA~2.0/conf/automation/js/node_modules/@js-joda/core/src/format/DateTimeBuilder.js'
19:15:24.915 [ERROR] [ab.automation.script.javascript.stack] - Failed to execute script:
org.graalvm.polyglot.PolyglotException: SyntaxError: DateTimeBuilder.js:7:0 Expected an operand but found import import
import { requireNonNull } from '../assert';
^
DateTimeBuilder.js:7:32 Expected ; but found ../assert
import { requireNonNull } from '../assert';

For my test I installed the openhab module via npm install openhab and selected the option “Do Not Use Built-in Variables”.

Am I doing something wrong here?

csowada · December 21, 2021, 8:29am

So I’ve checked the option “Do Not Use Built-in Variables” and it makes no difference if used or not. It loads all file in nodes_modules.

Hello @jpg0 maybe you can identify this as bug or feature ? Or should I report it on GitHub?

jpg0 · December 21, 2021, 10:10am

@csowada that sounds like a bug - could you file one please?

jpg0 · December 21, 2021, 10:24am

I’ve opened a PR to fix this: [jsscripting] JS script engine no longer watches subdirs for scripts by jpg0 · Pull Request #11830 · openhab/openhab-addons · GitHub

csowada · December 21, 2021, 2:12pm

Wow, you are really fast. Thank you very much.

csowada · January 13, 2022, 8:37pm

I’ve worked an a solution for the node_modules directory issue. At the same time I’ve changed the behaviour to allow loading of relative files from the root folder.

github.com/openhab/openhab-addons

[jsscripting] Allow loading files relative from root folder automation/js

opened 09:11PM - 10 Jan 22 UTC

csowada

enhancement

I miss the option to load relative files within the ``automation/js folder``. So… I can't separate my small helper functions from my rules without own modules in node_modules folder. I've used a custom version of the automation in the past. But I've changed the path for ``js.commonjs-require-cwd`` to the root folder instead of the node_modules folder. This allows us to load files from the folder ``automation/js`` **and** ``node_modules``. So it is not required to create own node modules in the ``node_modules`` folder. I've already build custom snapshot and it works as expected but I'm not sure if there is more to check. I only changed two lines to change the root directory for CommonJS loading. But we have still one disadvantage, the FileWatcher will load all files in the folder except the ``node_modules`` folder. So the config.js in my example would also be loaded on startup. But in that case I just want to load the file via a ``require`` call in my rule. So we still need a solution not only for the ``node_module`` folder. My suggestion is to provide an optional file similar to a ``.gitignore`` file to skip all folder and files defined in that file. I think it's more a minor bug in the current implementation instead of a feature, but this is a question for @jpg0 and @digitaldan . If you agree with me I could create a PR. In ``OpenhabGraalJSScriptEngine.java`` ```java .allowHostAccess(hostAccess).option("js.commonjs-require-cwd", JSDependencyTracker.LIB_PATH2) ``` and in ``JSDependencyTracker.java`` ```java public static final String LIB_PATH2 = String.join(File.separator, OpenHAB.getConfigFolder(), "automation", "js"); ``` ``` <folder> automation -<folder> js - myrule.js - <folder>config - myconfig.js - <folder> node_modules - <folder> mylib - ... ``` ```javascript const mylib= require("mylib"); const config = require("./config/myconfig"); ... ``` ## Your Environment * Version used: openHAB 3.2 release

You can download my build jar from github and create an .ohignore file in the automation/js directory

Use it like a .gitignore file and add following content as example.

node_modules/**
.git/**
do-not-load-me.js

This should skip all files within the node_modules directory and .git directory (if you use git). And the file do-not-load-me.js in the automation/js directory.