[automation] Added ScriptModuleTypeProvider for Jython and Groovy scripted Actions and Conditions #635

5iver · 2019-03-07T11:19:04Z

Fixes #521. This PR replaces #519. As discussed there, this PR will provide a dynamic list of script languages when using ScriptAction or ScriptCondition, based on the ScriptEngines in use on the system. It implements the ScriptModuleTypeProvider, which replaces the ScriptTypes ResourceBundle. I do not see anything that would make this a breaking change. The ParameterOption labels and values for the currently known working script languages are...

options
0
label	"ECMAScript (ECMA - 262 Edition 5.1)"
value	"application/javascript"
1
label	"Groovy (2.4.12)"
value	"application/x-groovy"
2
label	"Python (2.7)"
value	"application/python"

Things to be aware of:

The dropdown will not have Javascript as an option label, but ECMAScript (ECMA - 262 Edition 5.1).
When an engine is upgraded, the label will change to the upgraded version, but no change will be required by the user, as the value of the option should not have changed. I've tested this by upgrading/downgrading the package.
This PR removes the NashornScriptEngineFactory, as it was a duplicate of GenericScriptEngineFactory after this PR, except for how the scopeValues() method was implemented. I did not see any need for both files, so I added special handling of ECMAScripts in GenericScriptEngineFactory.scopeValues(). It's a little strange to put something specific in something names Generic, but this elimiated a file and a lot of duplicated code.
This provider is setup to use localization, but it is not yet implemented.

@kaikreuzer, you had suggested a ConfigOptionProvider, but I could not find a way to add one to a ResourceBundle. I based this provider off of your MediaActionTypeProvider, in which you state...

This is necessary since there is no other way to provide dynamic config param options for module types

ConfigOptionProvider had been around for about a year when you wrote this, so I figured you would have used one if it was possible. That is why I went this route.

@openhab/core-maintainers, please review. I've tested this, and everything seemed to function properly, but I don't think of myself as much of a Java developer. 😉

Signed-off-by: Scott Rushworth openhab@5iver.com (github: openhab-5iver)

openhab-bot · 2019-03-08T17:19:21Z

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

https://community.openhab.org/t/multi-zone-home-alarm-script-for-openhab/41425/37

maggu2810

This PR removes the NashornScriptEngineFactory, as it was a duplicate of GenericScriptEngineFactory after this PR, except for how the scopeValues() method was implemented. I did not see any need for both files, so I added special handling of ECMAScripts in GenericScriptEngineFactory.scopeValues(). It's a little strange to put something specific in something names Generic, but this elimiated a file and a lot of duplicated code.

If you would like to remove duplicate code, then we should improve the generic implementation to allow the specific child to modify / implement only the special scopeValues part without code duplication of all the remaining one.

Adding specific code to a generic class is IMHO nothing we should do ever in OOP.

...dule.script/src/main/java/org/openhab/core/automation/module/script/ScriptEngineFactory.java

...dule.script/src/main/java/org/openhab/core/automation/module/script/ScriptEngineManager.java

...rc/main/java/org/openhab/core/automation/module/script/internal/ScriptEngineManagerImpl.java

5iver · 2019-03-12T12:37:44Z

If you would like to remove duplicate code, then we should improve the generic implementation to allow the specific child to modify / implement only the special scopeValues part without code duplication of all the remaining one.

To expedite things, I'll add NashornScriptEngineFactory back in. That way it is no worse off than it was. Cleaning up the duplicated code can then be done in a separate PR.

openhab-bot · 2019-03-20T12:38:12Z

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

https://community.openhab.org/t/paperui-rule-bug-state-with-decimal/70627/8

5iver · 2019-03-24T17:42:10Z

@maggu2810, I've reworked this PR, so hopefully all of your comments have now been addressed. I'm not looking forward to wait a couple weeks for a review, so I'm hoping @wborn, @cweitkamp, or @kaikreuzer might take a look at it. Hope your vacation is going well! I have tested this PR for a while now, and am running it on my production system without issues.

Completely changed how the ParameterOptions were being generated in the previous commit
Added GenericScriptEngineFactory as a service. ESH #6284 only setup NashornSEF as a service.
Readded NashornSEF
Added an AbstractSEF for the others to inherit from, in order to remove duplication of code in the SEFs. This is the one change I questioned most, as I was uncertain if there might be issues with making services from both a parent and child class. If there are no issues, then the other factories can be extended from GenericSEF. I will keep looking at this.
Refactored ScriptEngineManagerImpl a bit, utilizing the fact that all factories are now services.
Moved the instantiation of the javax.script.ScriptEngineManagers from the factories to a static in the ScriptEngineFactory interface

I have noticed something though, which also occurs in the current production code. When OH starts up, the SEFs, or the ScriptEningManagerImpl, are started twice. Every now and then, after clearing the cache, this does not happen. The code seems to handle this, but I'm not sure what's causing it yet. This is unrelated to this PR, but I thought I'd mention it in case someone noticed it or had an explanation for it.

maggu2810 · 2019-04-03T06:53:27Z

Thank you for all your work and effort.
This PR is still part of the things I need to do.
Just the usual "spare time problem".
Please give me some time.

maggu2810

A few comments left.

...dule.script/src/main/java/org/openhab/core/automation/module/script/ScriptEngineFactory.java

...main/java/org/openhab/core/automation/module/script/internal/NashornScriptEngineFactory.java

...rc/main/java/org/openhab/core/automation/module/script/internal/ScriptEngineManagerImpl.java

...va/org/openhab/core/automation/module/script/internal/provider/ScriptModuleTypeProvider.java

openhab-bot · 2019-04-08T18:18:11Z

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

https://community.openhab.org/t/user-enhancements/71953/12

maggu2810 · 2019-04-10T16:03:05Z

@openhab-5iver Please ping me if you think all is done and I should start another review round.

5iver · 2019-04-10T16:04:56Z

@maggu2810, will do! A few more tests and I'll commit the changes.

5iver · 2019-04-10T19:10:28Z

@maggu2810, it's ready... and thank you!

maggu2810

Some minor comments, after that ones it should be ready.

...va/org/openhab/core/automation/module/script/internal/provider/ScriptModuleTypeProvider.java

.../java/org/openhab/core/automation/module/script/internal/handler/ScriptConditionHandler.java

...dule.script/src/main/java/org/openhab/core/automation/module/script/ScriptEngineManager.java

...dule.script/src/main/java/org/openhab/core/automation/module/script/ScriptEngineFactory.java

...rc/main/java/org/openhab/core/automation/module/script/internal/ScriptEngineManagerImpl.java

Added ScriptModuleTypeProvider, which dynamically adds available script languages to the ParameterOptions used in Paper UI when configuring a ScriptAction or ScriptCondition. Signed-off-by: Scott Rushworth <openhab@5iver.com>

5iver · 2019-04-10T21:51:28Z

@maggu2810, thank you very much for your patience and the time you have spent working with me. I have learned a lot from this! I've pushed the latest changes.

maggu2810

I need to give it back to you: thank you very much for your patience and the time you have spent working with me. 😉

openhab-bot · 2019-05-02T03:05:25Z

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

https://community.openhab.org/t/wip-ngre-jsr223-documentation-refactoring/73569/6

openhab-bot · 2019-06-03T22:20:20Z

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

https://community.openhab.org/t/preparation-for-2-5m2/75738/1

openhab-bot · 2019-10-03T18:51:19Z

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

https://community.openhab.org/t/windows-all-oh-logs-stop-when-jython-is-in-the-classpath/79654/24

openhab-bot · 2019-12-11T17:59:36Z

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

https://community.openhab.org/t/namespaces-packaging-for-scripting-apis/86940/6

…n page and added an explanation f… (openhab#635) * Clarified Misc on systems integration page and added an explanation for the different installation options. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Review improvements. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Changes due to second review Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Adressed review comments. Added feature command family to console part. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Again some review based changes. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Removed console part, Added addons.cfg part and added a warning to jar file part. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Image not needed without console section. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Again some small improvements for introduction and addons.cfg part. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Improvements to addons.cfg section. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Adressed review comments Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Pointed needed addon types for trailing 1 out. Signed-off-by: Jerome Luckenbach <github@luckenba.ch> * Adressed review comments and fixed one remaining typo Signed-off-by: Confectrician <github@luckenba.ch>

Added ScriptModuleTypeProvider, which dynamically adds available script languages to the ParameterOptions used in Paper UI when configuring a ScriptAction or ScriptCondition. Signed-off-by: Scott Rushworth <openhab@5iver.com> GitOrigin-RevId: 5f880e1

5iver mentioned this pull request Mar 7, 2019

Add Jython and Groovy ScriptEngineFactories #519

Closed

wborn added the automation label Mar 7, 2019

This was referenced Mar 8, 2019

Automation: [RFC] Add scriptlanguage context #627

Closed

[JSR223] Most Java classes are no longer available after ESH migration #610

Closed

maggu2810 reviewed Mar 12, 2019

View reviewed changes

5iver force-pushed the ScriptModuleTypeProvider branch 2 times, most recently from 2e52513 to d223e7f Compare March 24, 2019 16:25

5iver mentioned this pull request Apr 3, 2019

[Automation] Add DynamicImport-Package for scripted automation #663

Merged

maggu2810 reviewed Apr 4, 2019

View reviewed changes

5iver mentioned this pull request Apr 9, 2019

Migrate repo to OH-Jython-Scripters? lewie/openhab2-javascript#4

Closed

5iver force-pushed the ScriptModuleTypeProvider branch from d223e7f to 905f330 Compare April 10, 2019 19:09

maggu2810 reviewed Apr 10, 2019

View reviewed changes

Added ScriptModuleTypeProvider

8ed7c43

Added ScriptModuleTypeProvider, which dynamically adds available script languages to the ParameterOptions used in Paper UI when configuring a ScriptAction or ScriptCondition. Signed-off-by: Scott Rushworth <openhab@5iver.com>

5iver force-pushed the ScriptModuleTypeProvider branch from 905f330 to 8ed7c43 Compare April 10, 2019 21:46

maggu2810 approved these changes Apr 11, 2019

View reviewed changes

maggu2810 merged commit 5f880e1 into openhab:master Apr 11, 2019

5iver deleted the ScriptModuleTypeProvider branch April 11, 2019 10:09

5iver mentioned this pull request May 1, 2019

Tab-Style possible? openhab/website#183

Closed

wborn added this to the 2.5 milestone Jul 30, 2019

cweitkamp added the enhancement An enhancement or new feature of the Core label Dec 7, 2019

cweitkamp changed the title ~~Added ScriptModuleTypeProvider for Jython and Groovy scripted Actions and Conditions~~ [automation] Added ScriptModuleTypeProvider for Jython and Groovy scripted Actions and Conditions Dec 7, 2019

kaikreuzer removed the enhancement An enhancement or new feature of the Core label Dec 13, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[automation] Added ScriptModuleTypeProvider for Jython and Groovy scripted Actions and Conditions #635

[automation] Added ScriptModuleTypeProvider for Jython and Groovy scripted Actions and Conditions #635

5iver commented Mar 7, 2019 •

edited

Loading

openhab-bot commented Mar 8, 2019

maggu2810 left a comment

5iver commented Mar 12, 2019

openhab-bot commented Mar 20, 2019

5iver commented Mar 24, 2019

maggu2810 commented Apr 3, 2019

maggu2810 left a comment

openhab-bot commented Apr 8, 2019

maggu2810 commented Apr 10, 2019

5iver commented Apr 10, 2019

5iver commented Apr 10, 2019

maggu2810 left a comment

5iver commented Apr 10, 2019

maggu2810 left a comment

openhab-bot commented May 2, 2019

openhab-bot commented Jun 3, 2019

openhab-bot commented Oct 3, 2019

openhab-bot commented Dec 11, 2019

[automation] Added ScriptModuleTypeProvider for Jython and Groovy scripted Actions and Conditions #635

[automation] Added ScriptModuleTypeProvider for Jython and Groovy scripted Actions and Conditions #635

Conversation

5iver commented Mar 7, 2019 • edited Loading

openhab-bot commented Mar 8, 2019

maggu2810 left a comment

Choose a reason for hiding this comment

5iver commented Mar 12, 2019

openhab-bot commented Mar 20, 2019

5iver commented Mar 24, 2019

maggu2810 commented Apr 3, 2019

maggu2810 left a comment

Choose a reason for hiding this comment

openhab-bot commented Apr 8, 2019

maggu2810 commented Apr 10, 2019

5iver commented Apr 10, 2019

5iver commented Apr 10, 2019

maggu2810 left a comment

Choose a reason for hiding this comment

5iver commented Apr 10, 2019

maggu2810 left a comment

Choose a reason for hiding this comment

openhab-bot commented May 2, 2019

openhab-bot commented Jun 3, 2019

openhab-bot commented Oct 3, 2019

openhab-bot commented Dec 11, 2019

5iver commented Mar 7, 2019 •

edited

Loading