Read the recorder database name with the SQLAlchemy URL parser - #178760
Open
soldier2008 wants to merge 1 commit into
Open
Read the recorder database name with the SQLAlchemy URL parser#178760soldier2008 wants to merge 1 commit into
soldier2008 wants to merge 1 commit into
Conversation
urlparse treats a # or a ? in the password as structure, which leaves the database name empty and makes the system health size query fail with "database does not exist". make_url is the parser SQLAlchemy already uses to open the connection, so it agrees with the connection in every case.
home-assistant
Bot
added
bugfix
cla-signed
core
has-tests
integration: recorder
small-pr
Contributor
|
Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes recorder system-health database-size queries when credentials contain URL-special characters.
Changes:
- Uses SQLAlchemy’s URL parser to obtain the database name.
- Adds PostgreSQL regression coverage for special-character passwords.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
homeassistant/components/recorder/system_health/__init__.py |
Parses the database name with SQLAlchemy. |
tests/components/recorder/test_system_health.py |
Tests database-name extraction with special characters. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| recorder_runs_manager = instance.recorder_runs_manager | ||
| database_name = urlparse(instance.db_url).path.lstrip("/") | ||
| database_name = make_url(instance.db_url).database or "" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed change
system_healthbuilds the database name withurlparse(instance.db_url).path. A generic URL parser treats#and?in the password as structure, so the path — and with it the database name — comes out empty, andpg_database_size('''')fails withdatabase "" does not exist. A/in the password corrupts it instead.make_urlis the parser SQLAlchemy already uses to open the connection, so the name now agrees with the connection in every case. Only the MySQL and PostgreSQL helpers use the value; the SQLite one ignores it and reads the size frompragma_page_count().Type of change
Additional information
Checklist
ruff format homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all.To help with the load of incoming pull requests: