[jsscripting] openhab-js integration #11656

digitaldan · 2021-11-28T22:06:44Z

This PR integrates @jpg0 excellent OHJ helper library, which is now part of https://github.com/openhab/openhab-js and provides an out of the box environment for users to write Javascript based rules without needing to access raw Java types. Scripts can now be written like

items.getItem("KitchenLight").sendCommand("ON");

without any other imports or logic

This pr also enables node.js style console logging (console.log, console.debug...) as well as common javascript setTimeout support .

Todo

Update documentation
Update common logging name for user scripts and add to openhab-core default log config (script.js right now)
Add a simpler path for user scripts (deprecate the jsr223 path)

Fixes openhab#11222 Signed-off-by: Dan Cunningham <dan@digitaldan.com>

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

.../main/java/org/openhab/binding/venstarthermostat/internal/dto/VenstarAwayModeSerializer.java

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

simonihmig · 2021-11-29T22:30:22Z

...s/org.openhab.automation.jsscripting/src/main/resources/node_modules/@jsscripting-globals.js

+    }
+};
+
+function setTimeout(cb, delay) {


Ideally we probably should also have a polyfill for setInterval!?

Just added this in, also i changed both types of timers to support arguments to better confirm with standards.

simonihmig · 2021-11-29T22:42:07Z

...s/org.openhab.automation.jsscripting/src/main/resources/node_modules/@jsscripting-globals.js

+globalThis.setTimeout = setTimeout;
+globalThis.clearTimeout = clearTimeout;
+globalThis.global = globalThis;
+globalThis.process = { env: { NODE_ENV: '' } };


When I added this in my scripts, this was to prevent npm libraries from crashing when they access process.env.NODE_ENV. For which this is enough. But most often this is used to check if it equals 'production', in which case libraries often emit less/no debug logging, type checks, or do other shortcuts to optimize performance.

So there is a tradeoff here basically between DX and performance. I would tend to favor DX in our case, but should we want to prioritize perf, then this could be changed to:

Suggested change

globalThis.process = { env: { NODE_ENV: '' } };

globalThis.process = { env: { NODE_ENV: 'production' } };

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

… bit. This also includes an upcoming PR for cache support, which i will remove from here after it gets merged. Signed-off-by: Dan Cunningham <dan@digitaldan.com>

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

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

.../src/main/java/org/openhab/automation/jsscripting/internal/scope/binding/BindingSupport.java

...penhab/automation/jsscripting/internal/scope/binding/BindingItemProviderDelegateFactory.java

...a/org/openhab/automation/jsscripting/internal/scope/binding/BindingItemProviderDelegate.java

...penhab/automation/jsscripting/internal/scope/ScriptDisposalAwareScriptExtensionProvider.java

...n.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/scope/Lifecycle.java

.../java/org/openhab/automation/jsscripting/internal/scope/AbstractScriptExtensionProvider.java

...a/org/openhab/automation/jsscripting/internal/scope/binding/BindingItemProviderDelegate.java

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

digitaldan · 2021-12-13T00:35:10Z

Hello everyone, this is no longer a WIP and is ready for review. All required core changes have been made.

There is still openhab/openhab-core#2595 that should be merged as well (but this PR does not depend on it).

kaikreuzer

lgtm, thank you!

kaikreuzer · 2021-12-13T07:07:32Z

...ng/src/main/java/org/openhab/automation/jsscripting/internal/GraalJSScriptEngineFactory.java

 */
-@Component(service = ScriptEngineFactory.class)
+@Component(service = ScriptEngineFactory.class, configurationPid = "org.openhab.automation.jsscripting", property = Constants.SERVICE_PID


Our configuration pids follow the pattern org.openhab.<serviceid>.

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

…penhab/automation/jsscripting/internal/OpenhabGraalJSScriptEngine.java

Fixes openhab#11222 Signed-off-by: Dan Cunningham <dan@digitaldan.com> Signed-off-by: Nick Waterton <n.waterton@outlook.com>

Fixes openhab#11222 Signed-off-by: Dan Cunningham <dan@digitaldan.com> Signed-off-by: Michael Schmidt <mi.schmidt.83@gmail.com>

Fixes openhab#11222 Signed-off-by: Dan Cunningham <dan@digitaldan.com>

Fixes openhab#11222 Signed-off-by: Dan Cunningham <dan@digitaldan.com> Signed-off-by: Andras Uhrin <andras.uhrin@gmail.com>

digitaldan added 13 commits October 17, 2021 10:04

Tell the script context to use the classloader of the current class.

377251a

Fixes openhab#11222 Signed-off-by: Dan Cunningham <dan@digitaldan.com>

Protoype of merging OHJ with jsscripting

394de63

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

Load OH JS file directly from resource, use @oh namespace

18237a1

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

Remove debug statement

74be917

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

add allItems

57d4c80

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

JS changes

ed51c5d

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

Adds injection code and makes this a configurable service

1a14a3d

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

revert small typor

831bb7f

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

Merge branch 'main' into jsscripting-ohj

2e0152d

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

adds global vars, cleans up local library loading

91e1033

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

Typo

f99e8af

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

Use npm supplied openhab scripting library

003f650

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

Update author headers

ba9c5a9

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

digitaldan mentioned this pull request Nov 28, 2021

GraalVM JavaScript replaces Nashorn, breaking Blockly and existing Nashorn rules openhab/openhab-core#2433

Closed

wborn reviewed Nov 28, 2021

View reviewed changes

.../main/java/org/openhab/binding/venstarthermostat/internal/dto/VenstarAwayModeSerializer.java Outdated Show resolved Hide resolved

Revert unattended change

fce7efc

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

digitaldan added the work in progress A PR that is not yet ready to be merged label Nov 28, 2021

simonihmig reviewed Nov 29, 2021

View reviewed changes

digitaldan mentioned this pull request Dec 1, 2021

log not working consistently in UI rules openhab/openhab-js#16

Closed

digitaldan added 3 commits December 3, 2021 16:27

adds setInterval and supports arguments for timers

b622b44

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

change console logging to "org.openhab.automation.script'

f299e2b

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

Wrap logic in function for safety, apply callback in safer way

7073421

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

digitaldan mentioned this pull request Dec 5, 2021

This adds a new logger to our default log configuration that can be utilized by user provided scripts. openhab/openhab-distro#1340

Merged

Change scripting logger name

2465d92

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

wborn added the enhancement An enhancement or new feature for an existing add-on label Dec 5, 2021

digitaldan added 3 commits December 5, 2021 14:16

Add lifecyle and bundle context support, cleans up global scripting a…

d149195

… bit. This also includes an upcoming PR for cache support, which i will remove from here after it gets merged. Signed-off-by: Dan Cunningham <dan@digitaldan.com>

Bump openhab-js version

52dcb72

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

spotless

d60e071

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

digitaldan force-pushed the jsscripting-ohj branch from 554626e to d60e071 Compare December 5, 2021 22:58

Merge branch 'main' into jsscripting-ohj

e268143

florian-h05 mentioned this pull request Dec 12, 2021

Bring modules/libs to GraalJS florian-h05/openhab-conf#23

Closed

3 tasks

kaikreuzer reviewed Dec 12, 2021

View reviewed changes

bundles/org.openhab.automation.jsscripting/src/main/resources/OH-INF/config/config.xml Outdated Show resolved Hide resolved

kaikreuzer requested changes Dec 12, 2021

View reviewed changes

digitaldan added 3 commits December 12, 2021 16:06

Merge branch 'main' into HEAD

5d0ff0a

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

remove unessesary binding provider classes, updated class docs

88a712c

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

Bump openhab NPM version

4afd5c9

Signed-off-by: Dan Cunningham <dan@digitaldan.com>

digitaldan removed the work in progress A PR that is not yet ready to be merged label Dec 13, 2021

kaikreuzer approved these changes Dec 13, 2021

View reviewed changes

Update bundles/org.openhab.automation.jsscripting/src/main/java/org/o…

2054bca

…penhab/automation/jsscripting/internal/OpenhabGraalJSScriptEngine.java

kaikreuzer merged commit 4481ecf into openhab:main Dec 13, 2021

kaikreuzer added this to the 3.2 milestone Dec 13, 2021

wborn mentioned this pull request Dec 16, 2021

[jsscripting] Add default translations #11798

Merged

NickWaterton pushed a commit to NickWaterton/openhab-addons that referenced this pull request Dec 30, 2021

[jsscripting] openhab-js integration (openhab#11656)

6578a58

Fixes openhab#11222 Signed-off-by: Dan Cunningham <dan@digitaldan.com> Signed-off-by: Nick Waterton <n.waterton@outlook.com>

mischmidt83 pushed a commit to mischmidt83/openhab-addons that referenced this pull request Jan 9, 2022

[jsscripting] openhab-js integration (openhab#11656)

dac3358

Fixes openhab#11222 Signed-off-by: Dan Cunningham <dan@digitaldan.com> Signed-off-by: Michael Schmidt <mi.schmidt.83@gmail.com>

nemerdaud pushed a commit to nemerdaud/openhab-addons that referenced this pull request Jan 28, 2022

[jsscripting] openhab-js integration (openhab#11656)

cd2cd87

Fixes openhab#11222 Signed-off-by: Dan Cunningham <dan@digitaldan.com>

volkmarnissen pushed a commit to volkmarnissen/openhab-addons that referenced this pull request Mar 3, 2022

[jsscripting] openhab-js integration (openhab#11656)

4ee6eda

Fixes openhab#11222 Signed-off-by: Dan Cunningham <dan@digitaldan.com>

marcfischerboschio pushed a commit to bosch-io/openhab-addons that referenced this pull request May 5, 2022

[jsscripting] openhab-js integration (openhab#11656)

b7917a0

Fixes openhab#11222 Signed-off-by: Dan Cunningham <dan@digitaldan.com>

andan67 pushed a commit to andan67/openhab-addons that referenced this pull request Nov 6, 2022

[jsscripting] openhab-js integration (openhab#11656)

3ae13a0

Fixes openhab#11222 Signed-off-by: Dan Cunningham <dan@digitaldan.com>

andrasU pushed a commit to andrasU/openhab-addons that referenced this pull request Nov 12, 2022

[jsscripting] openhab-js integration (openhab#11656)

db6434b

Fixes openhab#11222 Signed-off-by: Dan Cunningham <dan@digitaldan.com> Signed-off-by: Andras Uhrin <andras.uhrin@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[jsscripting] openhab-js integration #11656

[jsscripting] openhab-js integration #11656

digitaldan commented Nov 28, 2021 •

edited

Loading

simonihmig Nov 29, 2021

digitaldan Nov 30, 2021

digitaldan Dec 4, 2021

simonihmig Nov 29, 2021

digitaldan commented Dec 13, 2021

kaikreuzer left a comment

kaikreuzer Dec 13, 2021

	globalThis.process = { env: { NODE_ENV: '' } };
	globalThis.process = { env: { NODE_ENV: 'production' } };

[jsscripting] openhab-js integration #11656

[jsscripting] openhab-js integration #11656

Conversation

digitaldan commented Nov 28, 2021 • edited Loading

simonihmig Nov 29, 2021

Choose a reason for hiding this comment

digitaldan Nov 30, 2021

Choose a reason for hiding this comment

digitaldan Dec 4, 2021

Choose a reason for hiding this comment

simonihmig Nov 29, 2021

Choose a reason for hiding this comment

digitaldan commented Dec 13, 2021

kaikreuzer left a comment

Choose a reason for hiding this comment

kaikreuzer Dec 13, 2021

Choose a reason for hiding this comment

digitaldan commented Nov 28, 2021 •

edited

Loading