[oauth] Token expiration is calculated from local time

[jlaur]

When looking at openhab/openhab-addons#13274 I noticed a flaw in AccessTokenResponse: It uses LocalDateTime for calculating token expiration. This means that the token creation time is dependent on system time-zone for being represented as an instant on the time-line.

This has the potential to cause problems if system time-zone is changed or if the LocalDateTime provided for isExpired is generated differently than how OAuthConnector generates it.

It would be less error-prone to use Instant for setCreatedOn, getCreatedOn and isExpired.

I would propose to change this in five steps to avoid breaking addons:

1. In AccessTokenResponse change createdOn internally to Instant. Add overload for isExpired taking Instant and deprecate current method. Deprecate getCreatedOn and add new getCreatedOnAsInstant (temporary, for migration). Change setCreatedOn to take Instant and adapt OAuthConnector accordingly (currently no addons use this method).
2. Adapt addons to use getCreatedOnAsInstant and new isExpired taking Instant.
3. Change implementation of getCreatedOn to the same as getCreatedOnAsInstant and deprecate the latter. Remove isExpired taking LocalDateTime.
4. Rename usages of getCreatedOnAsInstant to getCreatedOn in addons.
5. Remove getCreatedOnAsInstant.

See also #2898.

[jlaur]

I am preparing a draft pull request with first step of this proposal.

[J-N-K]

Do you know how many add-ons use this? I think we can do it on one step.

[jlaur]

@J-N-K - it would be simpler, yes, although temporarily breaking. I could prepare PR for addons so it would be ready. Addons affected:

• getCreatedOn: homeconnect
• isExpired: automower, ecobee, homeconnect

[J-N-K]

Since this is not user facing, I would consider it acceptable. I can review here and if the PR here and in addons are approved I can merge first. That‘ll at most break one snapshot if addons is not merged the same day.

[jlaur]

@J-N-K - I have now adapted the PR to change the API at once, and also created a PR towards addons (mentioned above).

[openhab-bot]

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

https://community.openhab.org/t/automower-husqvarna/137401/9