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

Already on GitHub? Sign in to your account

Fix resolving Matrix room aliases #101928

Merged
merged 9 commits into from Oct 23, 2023

Conversation

PaarthShah
Copy link
Contributor

@PaarthShah PaarthShah commented Oct 13, 2023

Proposed change

This PR fixes a regression in from before this integration's library was changed; users inadvertently lost the ability to configure the integration using Matrix room aliases.
The workaround of only using room ids works, but the proper fix as-implemented is to manually resolve room aliases into room ids, and cache them within MatrixBot._listening_rooms.
In addition to this, I wanted to ensure that aliases were usable as input for manual service commands as well, and to ensure that the aliases are logged if available, rather than the ID, to ensure the user sees the input they expect rather than an obfuscated id.
To facilitate this change, I also included extra tests and debug logs.

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 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.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@PaarthShah PaarthShah changed the title Matrix resolve room alias Bugfix: Resolve Matrix room aliases into room ids before calling client functions Oct 13, 2023
@PaarthShah PaarthShah marked this pull request as ready for review October 13, 2023 07:51
homeassistant/components/matrix/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/matrix/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/matrix/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/matrix/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/matrix/__init__.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft October 13, 2023 10:38
@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.

@PaarthShah PaarthShah marked this pull request as ready for review October 13, 2023 19:07
homeassistant/components/matrix/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/matrix/__init__.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft October 16, 2023 08:39
@MartinHjelmare MartinHjelmare changed the title Bugfix: Resolve Matrix room aliases into room ids before calling client functions Fix resolving Matrix room aliases into room ids before calling client functions Oct 16, 2023
@PaarthShah PaarthShah marked this pull request as ready for review October 16, 2023 09:13
Copy link
Contributor

@edenhaus edenhaus left a comment

Choose a reason for hiding this comment

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

Thanks @PaarthShah 👍

@edenhaus edenhaus changed the title Fix resolving Matrix room aliases into room ids before calling client functions Fix resolving Matrix room aliases Oct 23, 2023
@edenhaus edenhaus merged commit 30ba78c into home-assistant:dev Oct 23, 2023
23 checks passed
@PaarthShah PaarthShah deleted the matrix-resolve-room-alias branch October 23, 2023 08:47
@github-actions github-actions bot locked and limited conversation to collaborators Oct 24, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

matrix integration broken since 2023.10 update
2 participants