demus/openhab-addons
1
0
Fork 0
mirror of https://github.com/openhab/openhab-addons.git synced 2025-01-27 07:41:39 +01:00
Code Issues Packages Projects Releases Wiki Activity

[hydrawise] Handle API auth changes (#16221)

Browse Source 
* Handles a new condition where the service rejects a request as unauthorized, but really we just need to refresh our token after 60 seconds.

Signed-off-by: Dan Cunningham <dan@digitaldan.com>
This commit is contained in:
Dan Cunningham 2024-01-07 05:39:38 -08:00 committed by GitHub
parent 90480d0a10
commit c8d2d4b171
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 36 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
bundles/org.openhab.binding.hydrawise/src/main/java/org/openhab/binding/hydrawise/internal/api/graphql/HydrawiseGraphQLClient.java
View File

@ -324,6 +324,8 @@ public class HydrawiseGraphQLClient {
} catch (ExecutionException e) { } catch (ExecutionException e) {
// Hydrawise returns back a 40x status, but without a valid Realm , so jetty throws an exception, // Hydrawise returns back a 40x status, but without a valid Realm , so jetty throws an exception,
// this allows us to catch this in a callback and handle accordingly // this allows us to catch this in a callback and handle accordingly
logger.debug("ExecutionException", e);
logger.debug("ExecutionException {} {}", responseCode.get(), responseMessage);
switch (responseCode.get()) { switch (responseCode.get()) {
case 401: case 401:
case 403: case 403:

43
bundles/org.openhab.binding.hydrawise/src/main/java/org/openhab/binding/hydrawise/internal/handler/HydrawiseAccountHandler.java
View File

@ -62,6 +62,7 @@ public class HydrawiseAccountHandler extends BaseBridgeHandler implements Access
* Minimum amount of time we can poll for updates * Minimum amount of time we can poll for updates
*/ */
private static final int MIN_REFRESH_SECONDS = 30; private static final int MIN_REFRESH_SECONDS = 30;
private static final int TOKEN_REFRESH_SECONDS = 60;
private static final String BASE_URL = "https://app.hydrawise.com/api/v2/"; private static final String BASE_URL = "https://app.hydrawise.com/api/v2/";
private static final String AUTH_URL = BASE_URL + "oauth/access-token"; private static final String AUTH_URL = BASE_URL + "oauth/access-token";
private static final String CLIENT_SECRET = "zn3CrjglwNV1"; private static final String CLIENT_SECRET = "zn3CrjglwNV1";
@ -74,6 +75,7 @@ public class HydrawiseAccountHandler extends BaseBridgeHandler implements Access
private @Nullable OAuthClientService oAuthService; private @Nullable OAuthClientService oAuthService;
private @Nullable HydrawiseGraphQLClient apiClient; private @Nullable HydrawiseGraphQLClient apiClient;
private @Nullable ScheduledFuture<?> pollFuture; private @Nullable ScheduledFuture<?> pollFuture;
private @Nullable ScheduledFuture<?> tokenFuture;
private @Nullable Customer lastData; private @Nullable Customer lastData;
private int refresh; private int refresh;
@ -102,6 +104,7 @@ public class HydrawiseAccountHandler extends BaseBridgeHandler implements Access
public void dispose() { public void dispose() {
logger.debug("Handler disposed."); logger.debug("Handler disposed.");
clearPolling(); clearPolling();
clearTokenRefresh();
OAuthClientService oAuthService = this.oAuthService; OAuthClientService oAuthService = this.oAuthService;
if (oAuthService != null) { if (oAuthService != null) {
oAuthService.removeAccessTokenRefreshListener(this); oAuthService.removeAccessTokenRefreshListener(this);
@ -184,20 +187,40 @@ public class HydrawiseAccountHandler extends BaseBridgeHandler implements Access
pollFuture = scheduler.scheduleWithFixedDelay(this::poll, initalDelay, refresh, TimeUnit.SECONDS); pollFuture = scheduler.scheduleWithFixedDelay(this::poll, initalDelay, refresh, TimeUnit.SECONDS);
} }
/**
* The API will randomly reject a request with a 401 not authorized, waiting a min and refreshing the token usually
* fixes it
*/
private synchronized void retryToken() {
clearTokenRefresh();
tokenFuture = scheduler.schedule(() -> {
try {
OAuthClientService oAuthService = this.oAuthService;
if (oAuthService != null) {
oAuthService.refreshToken();
initPolling(0, MIN_REFRESH_SECONDS);
}
} catch (OAuthException | IOException | OAuthResponseException e) {
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, e.getMessage());
}
}, TOKEN_REFRESH_SECONDS, TimeUnit.SECONDS);
}
/** /**
* Stops/clears this thing's polling future * Stops/clears this thing's polling future
*/ */
private void clearPolling() { private void clearPolling() {
ScheduledFuture<?> localFuture = pollFuture; clearFuture(pollFuture);
if (isFutureValid(localFuture)) {
if (localFuture != null) {
localFuture.cancel(false);
}
}
} }
private boolean isFutureValid(@Nullable ScheduledFuture<?> future) { private void clearTokenRefresh() {
return future != null && !future.isCancelled(); clearFuture(tokenFuture);
}
private void clearFuture(@Nullable final ScheduledFuture<?> future) {
if (future != null) {
future.cancel(true);
}
} }
private void poll() { private void poll() {
@ -232,8 +255,10 @@ public class HydrawiseAccountHandler extends BaseBridgeHandler implements Access
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, e.getMessage()); updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, e.getMessage());
} }
} catch (HydrawiseAuthenticationException e) { } catch (HydrawiseAuthenticationException e) {
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, e.getMessage()); logger.debug("Token has been rejected, will try to refresh token in {} secs: {}", TOKEN_REFRESH_SECONDS,
e.getLocalizedMessage());
clearPolling(); clearPolling();
retryToken();
} }
} }
} }