JSR223: Add lifecycle, media, provider presets & scriptLoaded, scriptUnloaded functions #2567

dilyanpalauzov · 2025-10-02T11:33:58Z

I add example only for Groovy, as I do know how to use it in the other automation add-ons. Besides, the other rule engines provide other ways for the same functionality: script_unloaded in JRuby, and for others I do not know if the functionality is from openhab-core, or from the add-on.

netlify · 2025-10-02T11:37:19Z

✅ Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`1c96144`
🔍 Latest deploy log	https://app.netlify.com/projects/openhab-docs-preview/deploys/68de632918037a0007e68fb8
😎 Deploy Preview	https://deploy-preview-2567--openhab-docs-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify · 2025-10-02T11:41:12Z

✅ Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`746786d`
🔍 Latest deploy log	https://app.netlify.com/projects/openhab-docs-preview/deploys/68de63e6806756000875d2f8
😎 Deploy Preview	https://deploy-preview-2567--openhab-docs-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify · 2025-10-02T11:42:42Z

✅ Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).

Name	Link
🔨 Latest commit	`c27dbdd`
🔍 Latest deploy log	https://app.netlify.com/projects/openhab-docs-preview/deploys/695aa2f34151f600081de2a5
😎 Deploy Preview	https://deploy-preview-2567--openhab-docs-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

dilyanpalauzov · 2025-10-03T11:38:14Z

Now includes Nashorn example.

dilyanpalauzov · 2025-10-04T09:55:02Z

The current proposed change is correct, but only part of the truth. My understanding is that if a class implements ScriptExtensionProvider and returns in getDefaultPresets() non-empty set, then it is loaded by default by org.openhab.core.automation.module.script.internal.ScriptExtensionManager:

    public List<String> getDefaultPresets() {
        List<String> defaultPresets = new ArrayList<>();
        for (ScriptExtensionProvider provider : scriptExtensionProviders) {
            defaultPresets.addAll(provider.getDefaultPresets());
        }
        return defaultPresets;
    }

That is, the MediaScriptScopeProvider, LifecycleScriptExtensionProvider and DefaultScriptScopeProvider script extensions, or in other words the default, media and lifecycle presets, do not require importPresent.

dilyanpalauzov · 2025-10-04T11:51:55Z

Besides, one of the presets, which is loaded without importPreset is called default, not “Defaut”: In https://github.com/openhab/openhab-core/blob/main/bundles/org.openhab.core.automation.module.script/src/main/java/org/openhab/core/automation/module/script/internal/defaultscope/DefaultScriptScopeProvider.java: private static final String PRESET_DEFAULT = "default";

dilyanpalauzov · 2025-10-04T13:09:08Z

I added also the media preset - variables org.openhab.core.audio.AudioManager audio and org.openhab.core.voice.VoiceManager video.

stefan-hoehn

@florian-h05 please check the content.

stefan-hoehn · 2025-10-04T16:05:29Z

configuration/jsr223.md


+#### `lifecycle` Preset (`importPreset` not required)
+
+It provides a mechanism to execute code, when the input file is deleted.  Modifying a file deletes it and creates it again.


2nd sentence has be in the next line. (make sure the first sentence doesn't have a trailing space then.

dilyanpalauzov · 2025-10-11T13:23:59Z

I have described also the scriptLoaded(String) and scriptUnloaded() functions, and included examples in Groovy, JavaScript and Python.

…d scriptUnloaded functions

Signed-off-by: Florian Hotze <[email protected]>

florian-h05

Thanks!
I've reworded a few things during review.

Signed-off-by: Florian Hotze <[email protected]>

dilyanpalauzov · 2026-01-04T17:50:55Z

configuration/jsr223.md

+All instances from this preset have an `addPermanent(...)` method, in addition to `add(...)`.
+With the `add(...)` method, elements added over the above instances are removed, when the script, which inserted the elements, is deleted or changed.
+When `addPermanent(...)` is used, the inserted elements `...` are not removed.
+`itemRegistry.addPermanent(...)`/`metadataRegistry.addPermanent(...)`/`thingRegistry.addPermanent(...)` from this preset offer the same functionality as `itemRegistry.add(...)`/`metadataRegistry.add(...)`/`things.add(...)` from the `default` preset.


The default preset is implemented in https://github.com/openhab/openhab-core/blob/main/bundles/org.openhab.core.automation.module.script/src/main/java/org/openhab/core/automation/module/script/internal/defaultscope/DefaultScriptScopeProvider.java. It does not have metadataRegistry.

dilyanpalauzov · 2026-01-04T17:57:21Z

configuration/jsr223.md

+When a script file is loaded, the `scriptLoaded(String)` function is invoked if it is defined.
+The path of the script file will be passed as parameter.
+Similarly, when a script file is unloaded, the `scriptUnloaded()` function is invoked if it is defined.
+Note that `scriptLoaded(String)` and `scriptUnloaded()` are only executed for script files - not Script Actions and Script conditions of rules.


The original text suggests that for transformations (file in etc/openhab/transform) scriptUnloaded() is executed, but scriptLoaded(String) is not executed. After the changes this information is lost.

dilyanpalauzov · 2026-01-04T17:58:40Z

configuration/jsr223.md

+Similarly, when a script file is unloaded, the `scriptUnloaded()` function is invoked if it is defined.
+Note that `scriptLoaded(String)` and `scriptUnloaded()` are only executed for script files - not Script Actions and Script conditions of rules.
+
+[`lifecycleTracker`](#lifecycle-preset-importpreset-not-required)'s `addDisposeHook(Disposable)` and the `scriptUnloaded()` function serve similar purposes, but it is recommended to use `addDisposeHook(Disposable)` as it's functionality is not limited to script files only.


”it`s" → “its”.

Why was this removed:

When a script is executed several times, on each execution it adds a Disposable, and then the script is changed, its scriptUnloaded() is executed once and each added Disposable is also dispose()d.

This is not what I meant:

The lifecyleTracker also supports adding multiple dispose hooks, contrary to scriptUnloaded() that can only be defined once.

I meant that defining once scriptUnloaded() and one Disposable in a script, then executing the script several times, then modifying the script, will execute scriptUnloaded once, and the Disposable many times. (as many times as the script was executed, provided that each execution created unconditinonally a new Disposable - this can be tested in transformations)

How should a script be executed several times? A transformation can be, but a script not. Since scriptUnloaded is not available in transformations that information provides no benefit.

When I wrote that tests I believe I created transformations with scriptUnloaded(), scriptLoaded(String) and lifecycleTracker. scriptLoaded(String) was not executed, scriptUnloaded() and the Disposable were executed. I mean transformations with a file under etc/openhab/transform/. So an openHAB-Groovy-filebased-Transformation is a Groovy-Script and it can be executed several times.

dilyanpalauzov · 2026-01-04T18:08:49Z

configuration/jsr223.md

-`itemRegistry.addPermanent(…)`/`thingRegistry.addPermanent(…)` from this preset offer the same functionality as `itemRegistry.add(…)`/`things.add(…)` from the `default` preset.
+All instances from this preset have an `addPermanent(...)` method, in addition to `add(...)`.
+With the `add(...)` method, elements added over the above instances are removed, when the script, which inserted the elements, is deleted or changed.
+When `addPermanent(...)` is used, the inserted elements `...` are not removed.


The second ellipsis I used on that line was supposed to “mark a pause in speech” - as allowed by https://en.wikipedia.org/wiki/Ellipsis , not to cite the parameters introduced by the first ellipsis.

dilyanpalauzov · 2026-01-04T18:20:06Z

configuration/jsr223.md

 ::: tab Python

-When the setting “Use scope and import wrapper” is on, the `scope` module is enabled:
+When the setting "Use scope and import wrapper" is enabled, the `scope` module is enabled:


This repeats “enabled” twice in the same sentence.

dilyanpalauzov force-pushed the lifecycle_preset branch from 1c96144 to 746786d Compare October 2, 2025 11:37

dilyanpalauzov force-pushed the lifecycle_preset branch from 746786d to 92385ef Compare October 2, 2025 11:38

dilyanpalauzov marked this pull request as ready for review October 2, 2025 11:39

dilyanpalauzov force-pushed the lifecycle_preset branch 4 times, most recently from a09886c to b1f7fa7 Compare October 3, 2025 11:34

dilyanpalauzov mentioned this pull request Oct 4, 2025

configuration/jsr223: formatting of RuleSimple preset #2566

Merged

dilyanpalauzov force-pushed the lifecycle_preset branch 2 times, most recently from 5a27a98 to a13b13b Compare October 4, 2025 11:48

dilyanpalauzov force-pushed the lifecycle_preset branch 2 times, most recently from 7d1cde9 to 1923155 Compare October 4, 2025 13:08

dilyanpalauzov changed the title ~~JSR223 mention lifecycle preset~~ JSR223 mention lifecycle and media presets Oct 4, 2025

dilyanpalauzov force-pushed the lifecycle_preset branch from 1923155 to 3e8ae1f Compare October 4, 2025 13:10

dilyanpalauzov mentioned this pull request Oct 4, 2025

ScriptWrappingStrategy: add more imports from the OH-JSR223 implicit preset dalgwen/openhab-addons#19

Closed

stefan-hoehn requested changes Oct 4, 2025

View reviewed changes

dilyanpalauzov force-pushed the lifecycle_preset branch from a23e4f7 to cadce01 Compare October 11, 2025 12:56

dilyanpalauzov changed the title ~~JSR223 mention lifecycle and media presets~~ JSR223 mention lifecycle and media presets, scriptLoaded and scriptUnloaded functions Oct 11, 2025

dilyanpalauzov force-pushed the lifecycle_preset branch from cadce01 to bddb4cd Compare October 11, 2025 13:02

dilyanpalauzov mentioned this pull request Oct 11, 2025

What happens when the setting “Use scope and import wrapper” is off? openhab/openhab-python#6

Open

dilyanpalauzov force-pushed the lifecycle_preset branch 2 times, most recently from 88f694c to c2d6325 Compare October 11, 2025 13:38

dilyanpalauzov force-pushed the lifecycle_preset branch 6 times, most recently from bf4b509 to a9b1964 Compare October 11, 2025 19:50

dilyanpalauzov mentioned this pull request Oct 11, 2025

Rework Java223ScriptEngine.invokeFunction() dalgwen/openhab-addons#27

Merged

dilyanpalauzov force-pushed the lifecycle_preset branch 4 times, most recently from f27cdec to a5603b2 Compare October 13, 2025 11:41

dilyanpalauzov changed the title ~~JSR223 mention lifecycle and media presets, scriptLoaded and scriptUnloaded functions~~ JSR223 mention lifecycle, media and provider presets, scriptLoaded and scriptUnloaded functions Oct 13, 2025

JSR223 mention lifecycle, media and provider presets, scriptLoaded an…

d68ff70

…d scriptUnloaded functions

dilyanpalauzov force-pushed the lifecycle_preset branch from a5603b2 to d68ff70 Compare October 15, 2025 12:11

stefan-hoehn requested a review from florian-h05 October 21, 2025 16:20

Review changes

d217647

Signed-off-by: Florian Hotze <[email protected]>

florian-h05 approved these changes Jan 4, 2026

View reviewed changes

florian-h05 changed the title ~~JSR223 mention lifecycle, media and provider presets, scriptLoaded and scriptUnloaded functions~~ JSR223: Add lifecycle, media, provider presets & scriptLoaded, scriptUnloaded functions Jan 4, 2026

florian-h05 added 2 commits January 4, 2026 18:26

Review changes

1036bac

Signed-off-by: Florian Hotze <[email protected]>

Review changes

c27dbdd

Signed-off-by: Florian Hotze <[email protected]>

florian-h05 merged commit 571c984 into openhab:main Jan 4, 2026
4 of 5 checks passed

florian-h05 added this to the 5.2 milestone Jan 4, 2026

dilyanpalauzov commented Jan 4, 2026

View reviewed changes

dilyanpalauzov deleted the lifecycle_preset branch January 4, 2026 18:16

dilyanpalauzov commented Jan 4, 2026

View reviewed changes


		#### `lifecycle` Preset (`importPreset` not required)

		It provides a mechanism to execute code, when the input file is deleted. Modifying a file deletes it and creates it again.

Uh oh!

JSR223: Add lifecycle, media, provider presets & scriptLoaded, scriptUnloaded functions #2567

JSR223: Add lifecycle, media, provider presets & scriptLoaded, scriptUnloaded functions #2567

Uh oh!

Conversation

dilyanpalauzov commented Oct 2, 2025

Uh oh!

netlify bot commented Oct 2, 2025

✅ Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).

Uh oh!

netlify bot commented Oct 2, 2025

✅ Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).

Uh oh!

netlify bot commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).

Uh oh!

dilyanpalauzov commented Oct 3, 2025

Uh oh!

dilyanpalauzov commented Oct 4, 2025

Uh oh!

dilyanpalauzov commented Oct 4, 2025

Uh oh!

dilyanpalauzov commented Oct 4, 2025

Uh oh!

stefan-hoehn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dilyanpalauzov commented Oct 11, 2025

Uh oh!

florian-h05 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

netlify bot commented Oct 2, 2025 •

edited

Loading