PersistenceExtensions: Support state as string for persist method

[florian-h05]

This is a very useful addition for scripts & rules, e.g. for JS Scripting because in JS Scripting no native (Java) types are used (nearly everything is converted to JS tyes).

[mherwege]

LGTM

[J-N-K]

Thanks! useful addition.

[jlaur]

@florian-h05 - I'm not sure if related, but will this fix the following issue?

With this rule snippet (where spotPrice is a PersistedItem and spotPrice is a Quantity):

items.Energi_Data_Service_Total_Price.persistence.persist(spotPrice.timestamp, totalPrice);

I get this (with JDBC fixed by openhab/openhab-addons#16845):

openhab> SLF4J: Failed toString() invocation on an object of type [jdk.proxy11.$Proxy188]
Reported exception:
java.lang.IllegalStateException: Multi threaded access requested by thread Thread[OH-jdbc-1,5,main] but is not allowed for language(s) js.
        at com.oracle.truffle.polyglot.PolyglotEngineException.illegalState(PolyglotEngineException.java:129)
        at com.oracle.truffle.polyglot.PolyglotContextImpl.throwDeniedThreadAccess(PolyglotContextImpl.java:1034)
        at com.oracle.truffle.polyglot.PolyglotContextImpl.checkAllThreadAccesses(PolyglotContextImpl.java:893)
        at com.oracle.truffle.polyglot.PolyglotContextImpl.enterThreadChanged(PolyglotContextImpl.java:723)
        at com.oracle.truffle.polyglot.PolyglotEngineImpl.enterCached(PolyglotEngineImpl.java:1991)
        at com.oracle.truffle.polyglot.HostToGuestRootNode.execute(HostToGuestRootNode.java:110)
        at com.oracle.truffle.api.impl.DefaultCallTarget.callDirectOrIndirect(DefaultCallTarget.java:85)
        at com.oracle.truffle.api.impl.DefaultCallTarget.call(DefaultCallTarget.java:102)
        at com.oracle.truffle.polyglot.PolyglotObjectProxyHandler.invoke(PolyglotObjectProxyHandler.java:103)
        at jdk.proxy11/jdk.proxy11.$Proxy188.toString(Unknown Source)
        at org.slf4j.helpers.MessageFormatter.safeObjectAppend(MessageFormatter.java:291)
        at org.slf4j.helpers.MessageFormatter.deeplyAppendParameter(MessageFormatter.java:263)
        at org.slf4j.helpers.MessageFormatter.arrayFormat(MessageFormatter.java:225)
        at org.slf4j.helpers.MessageFormatter.arrayFormat(MessageFormatter.java:160)
        at org.ops4j.pax.logging.slf4j.Slf4jLogger.debug(Slf4jLogger.java:412)
        at org.openhab.persistence.jdbc.internal.JdbcMapper.storeItemValue(JdbcMapper.java:216)
        at org.openhab.persistence.jdbc.internal.JdbcPersistenceService.internalStore(JdbcPersistenceService.java:174)
        at org.openhab.persistence.jdbc.internal.JdbcPersistenceService.lambda$3(JdbcPersistenceService.java:157)
        at java.base/java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:539)
        at java.base/java.util.concurrent.FutureTask.run(FutureTask.java:264)
        at java.base/java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.run(ScheduledThreadPoolExecutor.java:304)
        at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1136)
        at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:635)
        at java.base/java.lang.Thread.run(Thread.java:833)
Caused by: Attached Guest Language Frames (1)

Whereas the following works:

var { QuantityType } = require("@runtime");
const ZonedDateTime = Java.type('java.time.ZonedDateTime');

var state = new QuantityType(totalPrice.toString());
var timestamp = ZonedDateTime.parse(spotPrice.timestamp.toString());
items.Energi_Data_Service_Total_Price.persistence.persist(timestamp, state);

[jlaur]

@florian-h05 - I just repeated the test with a newly built org.openhab.core.persistence-4.2.0-SNAPSHOT.jar including your enhancement, and the problem persists. If I change the line (recap: totalPrice is Quantity):

items.Energi_Data_Service_Total_Price.persistence.persist(spotPrice.timestamp, totalPrice);

to:

items.Energi_Data_Service_Total_Price.persistence.persist(spotPrice.timestamp, totalPrice.toString());

it works as expected.

So I'm guessing this will be fixed when openhab-js is refactored to use the new overload taking state as string?

[florian-h05]

I get this (with JDBC fixed by openhab/openhab-addons#16845):

The problem is (as the message indicates), that the persistence service persist asynchronously and attempts to access the passed in Quantity, which itself is owned by the GraalJS ScriptEngine - this then causes the thrown exception because GraalJS doesn’t allow multi-threaded access (for good reasons) and still runs in the script thread.
Most entry points to the script (timers, rule callback execution) are synchronised by the add-on, but in this case this is not possible that way.

So I'm guessing this will be fixed when openhab-js is refactored to use the new overload taking state as string?

Exactly. As primitives aren’t passed by reference, we can fix the multi-threading issue by converting the Quantity to string, pass that to core, which then creates a new QuantityType from it and passes that one to the persistence service.

openhab-js already contains the code for the to string conversion (already done for postUpdate and sendCommand), I just need to use it as well for the persist call.

[florian-h05]

@jlaur See openhab/openhab-js#339.