Skip to content

Comments

[jsscripting] Wrapper: Always enable for actions, configurable for conditions#19443

Merged
jlaur merged 7 commits intoopenhab:mainfrom
florian-h05:jsscripting-wrapper
Oct 9, 2025
Merged

[jsscripting] Wrapper: Always enable for actions, configurable for conditions#19443
jlaur merged 7 commits intoopenhab:mainfrom
florian-h05:jsscripting-wrapper

Conversation

@florian-h05
Copy link
Contributor

@florian-h05 florian-h05 commented Oct 5, 2025 •
edited
Loading

Follow up for #19019.
Discussion in https://community.openhab.org/t/rules-and-return-codes/166438.

  • This enables the wrapper that allows the use of let, const, class, function, return etc. always for script actions.
  • The wrapper is only configurable for conditions anymore, and the option defaults to false to avoid breaking existing conditions.
  • To allow disabling/enabling the script condition wrapper per action or condition, a directive is introduced: "use wrapper"
    • "use wrapper" & "use wrapper=true" enables the wrapper
    • "use wrapper=false" disables the wrapper

@florian-h05
[jsscripting] Always enable wrapper for actions & Make it configurabl…
0427968 
…e for conditions with default disabled

See https://community.openhab.org/t/rules-and-return-codes/166438 for discussion.

Signed-off-by: Florian Hotze <dev@florianhotze.com>
@florian-h05
[jsscripting] Add "use wrapper" directive
1eb5bfa 
Signed-off-by: Florian Hotze <dev@florianhotze.com>
@florian-h05
[jsscripting] Disable script condition wrapper by default
c5a1a71 
Signed-off-by: Florian Hotze <dev@florianhotze.com>
@florian-h05 florian-h05 added the enhancement An enhancement or new feature for an existing add-on label Oct 5, 2025
@openhab-bot
Copy link
Collaborator

openhab-bot commented Oct 5, 2025

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/rules-and-return-codes/166438/60

@openhab-bot
Copy link
Collaborator

openhab-bot commented Oct 5, 2025

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/rules-and-return-codes/166438/65

@florian-h05 florian-h05 mentioned this pull request Oct 5, 2025
Closed
@florian-h05
Address review
c1a849f 
Signed-off-by: Florian Hotze <dev@florianhotze.com>
@florian-h05
Futher renaming of methods for technical correctness
7fb691b 
Signed-off-by: Florian Hotze <dev@florianhotze.com>
@florian-h05 florian-h05 requested review from Nadahar and jimtng October 6, 2025 22:38
Nadahar
Nadahar approved these changes Oct 7, 2025
View reviewed changes
Copy link
Contributor

@Nadahar Nadahar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@florian-h05
Enable the directive for script actions as well
49e82b9 
Signed-off-by: Florian Hotze <dev@florianhotze.com>
@florian-h05 florian-h05 requested a review from Copilot October 7, 2025 22:21
Copilot AI reviewed Oct 7, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates JavaScript scripting behavior: the wrapper is now always intended to be enabled for script actions, while being configurable (and defaulting to disabled) for script conditions via a new directive ("use wrapper") and a renamed configuration parameter. Key changes include replacing the legacy wrapperEnabled config with scriptConditionWrapperEnabled, refining script environment detection, and introducing directive-based wrapper control in scripts.

  • Introduces directive-based wrapper selection ("use wrapper[=true|false]") for conditions; actions are meant to always be wrapped.
  • Refactors environment detection from "UI-based" to explicit script module/action/condition classification.
  • Renames and adjusts configuration and i18n keys to reflect the new behavior.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.

File Description
jsscripting.properties Renames wrapper configuration keys and updates description text for script condition wrapper behavior.
config.xml Replaces wrapperEnabled parameter with scriptConditionWrapperEnabled and changes its default to false.
OpenhabGraalJSScriptEngine.java Adds environment classification, wrapper directive parsing, and refactors injection logic.
GraalJSScriptEngineConfiguration.java Renames config fields/methods and adds scriptConditionWrapperEnabled handling.

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@florian-h05
Address Copilot review
192d550 
Signed-off-by: Florian Hotze <dev@florianhotze.com>
@florian-h05 florian-h05 requested a review from Copilot October 7, 2025 23:26
Copilot AI reviewed Oct 7, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@florian-h05 florian-h05 requested a review from jlaur October 8, 2025 12:53
@stefan-hoehn stefan-hoehn mentioned this pull request Oct 8, 2025
Merged
jlaur
jlaur approved these changes Oct 9, 2025
View reviewed changes
Copy link
Contributor

@jlaur jlaur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, LGTM.

@jlaur jlaur merged commit 6bacd8e into openhab:main Oct 9, 2025
2 checks passed
@jlaur jlaur added this to the 5.1 milestone Oct 9, 2025
@florian-h05 florian-h05 deleted the jsscripting-wrapper branch October 9, 2025 21:33
florian-h05 pushed a commit to openhab/openhab-webui that referenced this pull request Oct 28, 2025
@stefan-hoehn
[blockly] change event attributes, add return block (#3376)
20db04f 
Depends on: openhab/openhab-addons#19443

The event object/attributes in script actions and conditions is now the
same as in JSRule and Rule Builder.
Backwards compatibility will be retained for some time, though it is
advised to adjust, which is done in this PR according to:

https://github.com/openhab/openhab-js/blob/51f164dc9f11a29e6223e24268848aa8f0be168f/src/rules/rules.js#L471

Additionally **a new return block** was added to the "Run & Process" category with return parameter.

1) The block without a return parameter is a nice improvement to easily
leave a script without using non-elegant if/else statements. Bei adding
the return statement the script is immediately ended. In this case the
return parameter is not important.
2) By adding a return parameter (in particular true or false) this can be used for script conditions

---------

Signed-off-by: Stefan Höhn <mail@stefanhoehn.com>
@florian-h05 florian-h05 mentioned this pull request Oct 30, 2025
Merged
florian-h05 added a commit to openhab/openhab-js that referenced this pull request Oct 30, 2025
@florian-h05
Add docs for Script Condition wrapper (#492)
1cbf37a 
- Adds docs for openhab/openhab-addons#19443.
- Consistently spells UI-based and file-based with a hypen.
- Minor docs improvements wrt to `dedicatedContext` rules.

---------

Signed-off-by: Florian Hotze <dev@florianhotze.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@Nadahar Nadahar Nadahar approved these changes

@jlaur jlaur jlaur approved these changes

@jimtng jimtng Awaiting requested review from jimtng

Assignees

No one assigned

Labels

enhancement An enhancement or new feature for an existing add-on

Projects

None yet

Milestone

5.1

Development

Successfully merging this pull request may close these issues.

5 participants

@florian-h05 @openhab-bot @jimtng @Nadahar @jlaur