jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-19 03:07:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Correct condition signalling non-live DB migration is in progress (#129464)

Browse Source
This commit is contained in:
Erik Montnemery 2024-10-29 23:26:52 +01:00 committed by GitHub
parent 963829712d
commit db5cb6233c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 82 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
homeassistant/components/recorder/core.py
View File

@ -964,6 +964,7 @@ class Recorder(threading.Thread):
new_schema_status = migration.SchemaValidationStatus(
current_version=SCHEMA_VERSION,
migration_needed=False,
non_live_data_migration_needed=False,
schema_errors=set(),
start_version=SCHEMA_VERSION,
)

17
homeassistant/components/recorder/migration.py
View File

@ -200,12 +200,13 @@ def get_schema_version(session_maker: Callable[[], Session]) -> int | None:
return None
@dataclass(frozen=True)
@dataclass(frozen=True, kw_only=True)
class SchemaValidationStatus:
"""Store schema validation status."""
current_version: int
migration_needed: bool
non_live_data_migration_needed: bool
schema_errors: set[str]
start_version: int
@ -235,12 +236,17 @@ def validate_db_schema(
# columns may otherwise not exist etc.
schema_errors = _find_schema_errors(hass, instance, session_maker)
migration_needed = not is_current or non_live_data_migration_needed(
schema_migration_needed = not is_current
_non_live_data_migration_needed = non_live_data_migration_needed(
instance, session_maker, current_version
)
return SchemaValidationStatus(
current_version, migration_needed, schema_errors, current_version
current_version=current_version,
non_live_data_migration_needed=_non_live_data_migration_needed,
migration_needed=schema_migration_needed or _non_live_data_migration_needed,
schema_errors=schema_errors,
start_version=current_version,
)
@ -257,7 +263,10 @@ def _find_schema_errors(
def live_migration(schema_status: SchemaValidationStatus) -> bool:
"""Check if live migration is possible."""
return schema_status.current_version >= LIVE_MIGRATION_MIN_SCHEMA_VERSION
return (
schema_status.current_version >= LIVE_MIGRATION_MIN_SCHEMA_VERSION
and not schema_status.non_live_data_migration_needed
)
def pre_migrate_schema(engine: Engine) -> None:

16
tests/components/recorder/test_migrate.py
View File

@ -95,7 +95,13 @@ async def test_schema_update_calls(
hass,
engine,
session_maker,
migration.SchemaValidationStatus(0, True, set(), 0),
migration.SchemaValidationStatus(
current_version=0,
migration_needed=True,
non_live_data_migration_needed=True,
schema_errors=set(),
start_version=0,
),
42,
),
call(
@ -103,7 +109,13 @@ async def test_schema_update_calls(
hass,
engine,
session_maker,
migration.SchemaValidationStatus(42, True, set(), 0),
migration.SchemaValidationStatus(
current_version=42,
migration_needed=True,
non_live_data_migration_needed=True,
schema_errors=set(),
start_version=0,
),
db_schema.SCHEMA_VERSION,
),
]

96
tests/components/recorder/test_migration_from_schema_32.py
View File

@ -49,6 +49,7 @@ from .common import (
async_recorder_block_till_done,
async_wait_recording_done,
)
from .conftest import instrument_migration
from tests.common import async_test_home_assistant
from tests.typing import RecorderInstanceGenerator
@ -266,33 +267,37 @@ async def test_migrate_events_context_ids(
return {event.event_type: _object_as_dict(event) for event in events}
# Run again with new schema, let migration run
with freeze_time(now):
async with (
async_test_home_assistant() as hass,
async_test_recorder(hass) as instance,
):
instance.recorder_and_worker_thread_ids.add(threading.get_ident())
async with async_test_home_assistant() as hass:
with freeze_time(now), instrument_migration(hass) as instrumented_migration:
async with async_test_recorder(
hass, wait_recorder=False, wait_recorder_setup=False
) as instance:
# Check the context ID migrator is considered non-live
assert recorder.util.async_migration_is_live(hass) is False
instrumented_migration.migration_stall.set()
instance.recorder_and_worker_thread_ids.add(threading.get_ident())
await hass.async_block_till_done()
await async_wait_recording_done(hass)
await async_wait_recording_done(hass)
await hass.async_block_till_done()
await async_wait_recording_done(hass)
await async_wait_recording_done(hass)
events_by_type = await instance.async_add_executor_job(
_fetch_migrated_events
)
migration_changes = await instance.async_add_executor_job(
_get_migration_id, hass
)
# Check the index which will be removed by the migrator no longer exists
with session_scope(hass=hass) as session:
assert (
get_index_by_name(session, "events", "ix_events_context_id") is None
events_by_type = await instance.async_add_executor_job(
_fetch_migrated_events
)
await hass.async_stop()
await hass.async_block_till_done()
migration_changes = await instance.async_add_executor_job(
_get_migration_id, hass
)
# Check the index which will be removed by the migrator no longer exists
with session_scope(hass=hass) as session:
assert (
get_index_by_name(session, "events", "ix_events_context_id")
is None
)
await hass.async_stop()
await hass.async_block_till_done()
old_uuid_context_id_event = events_by_type["old_uuid_context_id_event"]
assert old_uuid_context_id_event["context_id"] is None
@ -602,30 +607,37 @@ async def test_migrate_states_context_ids(
return {state.entity_id: _object_as_dict(state) for state in events}
# Run again with new schema, let migration run
async with (
async_test_home_assistant() as hass,
async_test_recorder(hass) as instance,
):
instance.recorder_and_worker_thread_ids.add(threading.get_ident())
async with async_test_home_assistant() as hass:
with instrument_migration(hass) as instrumented_migration:
async with async_test_recorder(
hass, wait_recorder=False, wait_recorder_setup=False
) as instance:
# Check the context ID migrator is considered non-live
assert recorder.util.async_migration_is_live(hass) is False
instrumented_migration.migration_stall.set()
instance.recorder_and_worker_thread_ids.add(threading.get_ident())
await hass.async_block_till_done()
await async_wait_recording_done(hass)
await async_wait_recording_done(hass)
await hass.async_block_till_done()
await async_wait_recording_done(hass)
await async_wait_recording_done(hass)
states_by_entity_id = await instance.async_add_executor_job(
_fetch_migrated_states
)
states_by_entity_id = await instance.async_add_executor_job(
_fetch_migrated_states
)
migration_changes = await instance.async_add_executor_job(
_get_migration_id, hass
)
migration_changes = await instance.async_add_executor_job(
_get_migration_id, hass
)
# Check the index which will be removed by the migrator no longer exists
with session_scope(hass=hass) as session:
assert get_index_by_name(session, "states", "ix_states_context_id") is None
# Check the index which will be removed by the migrator no longer exists
with session_scope(hass=hass) as session:
assert (
get_index_by_name(session, "states", "ix_states_context_id")
is None
)
await hass.async_stop()
await hass.async_block_till_done()
await hass.async_stop()
await hass.async_block_till_done()
old_uuid_context_id = states_by_entity_id["state.old_uuid_context_id"]
assert old_uuid_context_id["context_id"] is None