[boschindego] Rewrite to avoid external dependencies #12905

jlaur · 2022-06-07T21:42:27Z

This is an overhaul of the Bosch Indego binding in order to get rid of the dependency towards bosch-indego-controller-lib, which seems abandoned and is no longer working after Bosch made some service requirement changes. The library has been reimplemented within the binding using Jetty HTTP client for communication and GSON for JSON serialization/deserialization.

Session handling:

Session is now persisted in memory to avoid reauthentication every few minutes and for each command.
Session is handled by receiving a Set-Cookie HTTP header when authenticating. The context is then set in a Cookie HTTP header in requests belonging to that session. This is automatically handled by Jetty.
As a fallback solution, additionally the HTTP header x-im-context-id is used for sending the session context.
If the session would expire before anticipated (max age in cookie), the controller will automatically reauthenticate and retry the failed request.
Because additional authentication request is eliminated, commands are now executed a tiny bit faster.

Additional changes:

Device command handling has been reworked for improved reliability.
REFRESH command is now supported.
Serial number has been added as a property.
New status code supported: Docked from app/API.
Configuration validation.
README cleaned up.

Besides these changes under the hood, no functional or breaking changes has been made.

IndegoController contains some currently unused methods (with corresponding DTO's). They were part of the library reimplementation and will most likely be used for new features in subsequent pull requests.

Fixes #7438
Fixes #12720

JAR available for testing: org.openhab.binding.boschindego-3.3.0-SNAPSHOT.jar

openhab-bot · 2022-06-08T16:17:31Z

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

https://community.openhab.org/t/boschindego-bosch-indego-binding-not-working-any-more/135825/7

Fixes openhab#12720 Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

Avoid reauthorization for each command/poll Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

jlaur · 2022-06-11T10:20:30Z

@lolodomo, @fwolter, @Hilbrand - can one of you review this PR?

I would like it to be ready for 3.3 since the binding is currently not working due to a small change in the service being used. This needed to be fixed in a library used, but unfortunately that library seems abandoned. Therefore I have replaced this by a custom implementation in the binding.

Primary classes to be reviewed are BoschIndegoHandler and IndegoController. Currently most of the DTO classes are unused and untested, so they will be fixed and tested when being adopted later. Used DTO's for supporting existing functionality are:

AuthenticationRequest (for authentication)
AuthenticationResponse (for retrieving session information)
DeviceStateResponse (for retrieving state)
SetStateRequest (for sending commands)

I have tested getting state and sending commands myself, and currently the binding doesn't provide any other functionality than that.

After this PR I plan to add new channels providing new functionality, so this PR is to be considered a baseline and bringing the binding back to a working state.

lolodomo

Review part 1

...binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/DeviceStatus.java

bundles/org.openhab.binding.boschindego/src/main/resources/OH-INF/i18n/boschindego.properties

lolodomo · 2022-06-12T06:55:21Z

Note for myself: remains to review README and classes BoschIndegoHandler and IndegoController.

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

lolodomo

Review part 2

...ndego/src/main/java/org/openhab/binding/boschindego/internal/handler/BoschIndegoHandler.java

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

lolodomo

Review last part

...ing.boschindego/src/main/java/org/openhab/binding/boschindego/internal/IndegoController.java

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

lolodomo

LGTM, thank you

henrydiesner · 2022-06-25T11:20:45Z

Great! Now it works!
I've installed the JAR file from https://github.com/jlaur in the 3.2.0 release built and for me it works fine. Better as all years before!
Many many thanks!!!

jlaur · 2022-06-25T14:57:17Z

@henrydiesner - good to hear, thanks. You can also try out https://drive.google.com/file/d/17xy2JwRGDcoxcDlIawjx9IDk2hzz_L8A/view?usp=sharing. It includes #12938 (partially) and #12986.

henrydiesner · 2022-06-27T09:20:39Z

@jlaur - now i've used the new jar file. Unfortunately I'm not able to use GET requests with my knowledge ;-(
For me it would be great, to have more channels in the binding - in the future!
Thousand thanks in advance for your effort!!!

jlaur · 2022-06-27T10:15:00Z

now i've used the new jar file. Unfortunately I'm not able to use GET requests with my knowledge ;-(

I'm sorry, but I don't understand what you mean - you can't use GET requests? What happens when you use the binding - can you send some debug/trace logs? This PR is now included in openHAB 3.3 released today, so if you have problems, please create an issue, and I'll look into it.

* Rewrite to avoid external dependencies Fixes openhab#12720 * Improve session handling * Avoid reauthorization for each command/poll * Further improve session handling * Refactor SSO cookie handling * Optimize getting DeviceStatus for unknown status code Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

* Rewrite to avoid external dependencies Fixes openhab#12720 * Improve session handling * Avoid reauthorization for each command/poll * Further improve session handling * Refactor SSO cookie handling * Optimize getting DeviceStatus for unknown status code Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk> Signed-off-by: Andras Uhrin <andras.uhrin@gmail.com>

* Rewrite to avoid external dependencies Fixes openhab#12720 * Improve session handling * Avoid reauthorization for each command/poll * Further improve session handling * Refactor SSO cookie handling * Optimize getting DeviceStatus for unknown status code Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

jlaur added the enhancement An enhancement or new feature for an existing add-on label Jun 7, 2022

jlaur force-pushed the 12720-boschindego-rewrite branch 6 times, most recently from f691991 to f67dac7 Compare June 8, 2022 14:37

jlaur marked this pull request as ready for review June 8, 2022 17:18

jlaur requested a review from jofleck as a code owner June 8, 2022 17:18

jlaur requested a review from a team June 8, 2022 17:18

jlaur force-pushed the 12720-boschindego-rewrite branch 3 times, most recently from a622be9 to e8ffb29 Compare June 10, 2022 15:02

jlaur added 3 commits June 10, 2022 20:33

Rewrite to avoid external dependencies

b4eaf9f

Fixes openhab#12720 Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

Improve session handling

40e1876

Avoid reauthorization for each command/poll Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

Fix SAT findings

25a11b5

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

jlaur force-pushed the 12720-boschindego-rewrite branch from 4a717c2 to 25a11b5 Compare June 10, 2022 18:34

Further improve session handling

592cea7

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

jlaur force-pushed the 12720-boschindego-rewrite branch from 7393433 to 592cea7 Compare June 10, 2022 21:17

Refactor SSO cookie handling

4b5977a

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

lolodomo requested changes Jun 12, 2022

View reviewed changes

...binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/DeviceStatus.java Outdated Show resolved Hide resolved

bundles/org.openhab.binding.boschindego/src/main/resources/OH-INF/i18n/boschindego.properties Show resolved Hide resolved

jlaur added 2 commits June 12, 2022 13:01

Optimize getting DeviceStatus for unknown status code

d42a851

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

Update default translations

71b45e8

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

lolodomo requested changes Jun 14, 2022

View reviewed changes

...ndego/src/main/java/org/openhab/binding/boschindego/internal/handler/BoschIndegoHandler.java Outdated Show resolved Hide resolved

jlaur requested a review from lolodomo June 14, 2022 10:43

Drop private methods for job scheduling/cancelling

370949d

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

lolodomo requested changes Jun 14, 2022

View reviewed changes

jlaur added 2 commits June 14, 2022 22:10

Provide Javadoc consistency

18f4c64

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

Fix wrong exception message

c68ecb7

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>

lolodomo approved these changes Jun 14, 2022

View reviewed changes

lolodomo merged commit 960be6b into openhab:main Jun 14, 2022

lolodomo added this to the 3.3 milestone Jun 14, 2022

jlaur mentioned this pull request Jun 21, 2022

[boschindego] Problem after starting the mower #7438

Closed

jlaur mentioned this pull request Jul 22, 2022

Add myself as code owner for Bosch Indego binding #13161

Merged

jlaur mentioned this pull request Apr 23, 2023

Remove bosch-indego-controller-lib openhab/openhab-osgiify#40

Merged

jlaur mentioned this pull request Jan 21, 2024

[boschindego] Update third party licenses #16311

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[boschindego] Rewrite to avoid external dependencies #12905

[boschindego] Rewrite to avoid external dependencies #12905

jlaur commented Jun 7, 2022 •

edited

Loading

openhab-bot commented Jun 8, 2022

jlaur commented Jun 11, 2022

lolodomo left a comment

lolodomo commented Jun 12, 2022

lolodomo left a comment

lolodomo left a comment

lolodomo left a comment

henrydiesner commented Jun 25, 2022

jlaur commented Jun 25, 2022

henrydiesner commented Jun 27, 2022

jlaur commented Jun 27, 2022

[boschindego] Rewrite to avoid external dependencies #12905

[boschindego] Rewrite to avoid external dependencies #12905

Conversation

jlaur commented Jun 7, 2022 • edited Loading

openhab-bot commented Jun 8, 2022

jlaur commented Jun 11, 2022

lolodomo left a comment

Choose a reason for hiding this comment

lolodomo commented Jun 12, 2022

lolodomo left a comment

Choose a reason for hiding this comment

lolodomo left a comment

Choose a reason for hiding this comment

lolodomo left a comment

Choose a reason for hiding this comment

henrydiesner commented Jun 25, 2022

jlaur commented Jun 25, 2022

henrydiesner commented Jun 27, 2022

jlaur commented Jun 27, 2022

jlaur commented Jun 7, 2022 •

edited

Loading