Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make SimpliSafe integration more resilient to SimpliSafe cloud issues #31116

Merged
merged 6 commits into from Jan 25, 2020

Conversation

bachya
Copy link
Contributor

@bachya bachya commented Jan 23, 2020

Proposed change

This is a follow-up to #30456.

At times, SimpliSafe will do something in their cloud (producing a 500 or 502) and the integration can't recover without a HASS restart. Today, I noticed another such incident in my HASS logs:

2020-01-23 11:54:50 ERROR (MainThread) [simplipy.system] Error while getting latest settings values: Error requesting data from ss3/subscriptions/SID/settings/normal: 502, message='Bad Gateway', url='https://api.simplisafe.com/v1/ss3/subscriptions/SID/settings/normal?forceUpdate=false
2020-01-23 11:54:50 ERROR (MainThread) [custom_components.simplisafe] SimpliSafe error while updating "MY ADDRESS": Repeated 401s despite refreshing access token
2020-01-23 11:55:21 ERROR (MainThread) [simplipy.system] Error while getting latest system values: Repeated 401s despite refreshing access token
2020-01-23 11:55:21 ERROR (MainThread) [simplipy.system] Error while getting latest settings values: Repeated 401s despite refreshing access token

My supposition: at times, a 500 or 502 will seemingly harm simplisafe-python's existing access token and refresh token, thus preventing the integration from recovering. However, the refresh token stored in the config entry escapes unscathed (again, apparently); so, if we detect that we're in such a situation, we should try one last effort using that stored refresh token. This PR implements that.

By all accounts and because this is sporadic, this isn't an issue of how we're using the SimpliSafe's unpublished API.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example entry for configuration.yaml:

# Example configuration.yaml
simplisafe:
  accounts:
    username: !secret simplisafe_username
    password: !secret simplisafe_password

Additional information

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 馃 Silver
  • 馃 Gold
  • 馃弳 Platinum

@bachya bachya self-assigned this Jan 23, 2020
@probot-home-assistant probot-home-assistant bot added integration: simplisafe small-pr PRs with less than 30 lines. labels Jan 23, 2020
@project-bot project-bot bot added this to Needs review in Dev Jan 23, 2020
@project-bot project-bot bot moved this from Needs review to By Code Owner in Dev Jan 23, 2020
@MartinHjelmare MartinHjelmare moved this from By Code Owner to Review in progress in Dev Jan 24, 2020
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Dev automation moved this from Review in progress to Reviewer approved Jan 25, 2020
@bachya bachya merged commit cf165cc into home-assistant:dev Jan 25, 2020
Dev automation moved this from Reviewer approved to Done Jan 25, 2020
@bachya bachya deleted the ss-refresh-token branch January 25, 2020 04:19
@nguyer
Copy link

nguyer commented Jan 25, 2020

Thanks for this! I hope this helps the refresh token issues I鈥檝e been having. I鈥檇 really like to trust that my system will arm/disarm with my automations...

Do you know which HA release this will be included in? Thanks again!

@lock lock bot locked and limited conversation to collaborators Jan 26, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Dev
  
Done
Development

Successfully merging this pull request may close these issues.

Simplisafe integration starts getting 401 errors
4 participants