Skip to content

Set timeout for remote calendar #147024

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: dev
Choose a base branch
from

Conversation

Thomas55555
Copy link
Contributor

Breaking change

Proposed change

Set a longer timeout for large files.

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)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

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
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format 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.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hey there @allenporter, mind taking a look at this pull request as it has been labeled with an integration (remote_calendar) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of remote_calendar can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign remote_calendar Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

Copy link
Contributor

@allenporter allenporter left a comment

Choose a reason for hiding this comment

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

how about also handling the TimeoutException error message properly? (e.g. either with a fixed error string to the user or log message)

@home-assistant home-assistant bot marked this pull request as draft June 17, 2025 13:31
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@Thomas55555
Copy link
Contributor Author

Okay, I decided to remove the error log messages from the UI, as they are not translatable.

@Thomas55555 Thomas55555 marked this pull request as ready for review June 17, 2025 14:36
@home-assistant home-assistant bot requested a review from allenporter June 17, 2025 14:36
@@ -18,14 +21,14 @@
"already_configured": "[%key:common::config_flow::abort::already_configured_service%]"
},
"error": {
"cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
"cannot_connect": "[%key:component::remote_calendar::common::unable_to_fetch%]",
Copy link
Contributor

Choose a reason for hiding this comment

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

I kind of liked the old friendly/standard error. Can we make it use timeout for timeout errors?

Copy link
Contributor

Choose a reason for hiding this comment

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

or the existing timeout_connect is probably fine while "Timeout establishing connection" may be technically not necessarily accurate, it seems to be mostly correct.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, I also wondered, if this would be good. But there is a hint missing, to check the logs for more details. I wouldn't check the logs if I just get this message in the UI.

Copy link
Contributor

Choose a reason for hiding this comment

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

eh, i think its kinda the same for nearly every integration though so not sure its worth changing. i think going with the specific messages would be the way to go.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay

@@ -18,14 +21,14 @@
"already_configured": "[%key:common::config_flow::abort::already_configured_service%]"
},
"error": {
"cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
"cannot_connect": "[%key:common::config_flow::error::timeout_connect%]",
Copy link
Contributor

Choose a reason for hiding this comment

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

To clarify, what I meant was to the existing case alone., then add a separate except block for TimeoutException and another timeout_connect entry here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

okay, this was done here: 21a6d54.
I don't understand your philosophy. Should this also be done like that in the coordinator?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, seems fine to do in coordinator also.

I guess the rationale here is following the pattern I see in most places, to map exceptions to strings based on some granularity. Making them all have a timeout error didn't seem accurate. So having different errors for the different cases seems hepful.

@home-assistant home-assistant bot marked this pull request as draft June 21, 2025 21:31
@Thomas55555 Thomas55555 marked this pull request as ready for review June 23, 2025 18:34
@home-assistant home-assistant bot requested a review from allenporter June 23, 2025 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fail to fetch large (1M+) remote calendar from Office 365
2 participants