Add minor version support to storage.Store (home-assistant#59882)

homeassistant/components/onboarding/__init__.py

@@ -20,14 +20,14 @@
 class OnboadingStorage(Store):
     """Store onboarding data."""
 
-    async def _async_migrate_func(self, old_version, old_data):
+    async def _async_migrate_func(self, old_major_version, old_minor_version, old_data):
         """Migrate to the new version."""
         # From version 1 -> 2, we automatically mark the integration step done
-        if old_version < 2:
+        if old_major_version < 2:
             old_data["done"].append(STEP_INTEGRATION)
-        if old_version < 3:
+        if old_major_version < 3:
             old_data["done"].append(STEP_CORE_CONFIG)
-        if old_version < 4:
+        if old_major_version < 4:
             old_data["done"].append(STEP_ANALYTICS)
         return old_data
 

homeassistant/components/person/__init__.py

@@ -148,7 +148,7 @@ async def async_add_user_device_tracker(
 class PersonStore(Store):
     """Person storage."""
 
-    async def _async_migrate_func(self, old_version, old_data):
+    async def _async_migrate_func(self, old_major_version, old_minor_version, old_data):
         """Migrate to the new version.
 
         Migrate storage to use format of collection helper.

homeassistant/helpers/storage.py

@@ -4,6 +4,7 @@
 import asyncio
 from collections.abc import Callable
 from contextlib import suppress
+import inspect
 from json import JSONEncoder
 import logging
 import os
@@ -75,11 +76,13 @@ def __init__(
         key: str,
         private: bool = False,
         *,
-        encoder: type[JSONEncoder] | None = None,
         atomic_writes: bool = False,
+        encoder: type[JSONEncoder] | None = None,
+        minor_version: int = 1,
     ) -> None:
         """Initialize storage class."""
         self.version = version
+        self.minor_version = minor_version
         self.key = key
         self.hass = hass
         self._private = private
@@ -99,8 +102,8 @@ def path(self):
     async def async_load(self) -> dict | list | None:
         """Load data.
 
-        If the expected version does not match the given version, the migrate
-        function will be invoked with await migrate_func(version, config).
+        If the expected version and minor version do not match the given versions, the
+        migrate function will be invoked with migrate_func(version, minor_version, config).
 
         Will ensure that when a call comes in while another one is in progress,
         the second call will wait and return the result of the first call.
@@ -137,7 +140,15 @@ async def _async_load_data(self):
 
             if data == {}:
                 return None
-        if data["version"] == self.version:
+
+        # Add minor_version if not set
+        if "minor_version" not in data:
+            data["minor_version"] = 1
+
+        if (
+            data["version"] == self.version
+            and data["minor_version"] == self.minor_version
+        ):
             stored = data["data"]
         else:
             _LOGGER.info(
@@ -146,13 +157,29 @@ async def _async_load_data(self):
                 data["version"],
                 self.version,
             )
-            stored = await self._async_migrate_func(data["version"], data["data"])
+            if len(inspect.signature(self._async_migrate_func).parameters) == 2:
+                # pylint: disable-next=no-value-for-parameter
+                stored = await self._async_migrate_func(data["version"], data["data"])
+            else:
+                try:
+                    stored = await self._async_migrate_func(
+                        data["version"], data["minor_version"], data["data"]
+                    )
+                except NotImplementedError:
+                    if data["version"] != self.version:
+                        raise
+                    stored = data["data"]
 
         return stored
 
     async def async_save(self, data: dict | list) -> None:
         """Save data."""
-        self._data = {"version": self.version, "key": self.key, "data": data}
+        self._data = {
+            "version": self.version,
+            "minor_version": self.minor_version,
+            "key": self.key,
+            "data": data,
+        }
 
         if self.hass.state == CoreState.stopping:
             self._async_ensure_final_write_listener()
@@ -163,7 +190,12 @@ async def async_save(self, data: dict | list) -> None:
     @callback
     def async_delay_save(self, data_func: Callable[[], dict], delay: float = 0) -> None:
         """Save data with an optional delay."""
-        self._data = {"version": self.version, "key": self.key, "data_func": data_func}
+        self._data = {
+            "version": self.version,
+            "minor_version": self.minor_version,
+            "key": self.key,
+            "data_func": data_func,
+        }
 
         self._async_cleanup_delay_listener()
         self._async_ensure_final_write_listener()
@@ -248,7 +280,7 @@ def _write_data(self, path: str, data: dict) -> None:
             atomic_writes=self._atomic_writes,
         )
 
-    async def _async_migrate_func(self, old_version, old_data):
+    async def _async_migrate_func(self, old_major_version, old_minor_version, old_data):
         """Migrate to the new version."""
         raise NotImplementedError
 

tests/components/google_assistant/test_helpers.py

@@ -169,6 +169,7 @@ async def test_agent_user_id_storage(hass, hass_storage):
 
     hass_storage["google_assistant"] = {
         "version": 1,
+        "minor_version": 1,
         "key": "google_assistant",
         "data": {"agent_user_ids": {"agent_1": {}}},
     }
@@ -178,6 +179,7 @@ async def test_agent_user_id_storage(hass, hass_storage):
 
     assert hass_storage["google_assistant"] == {
         "version": 1,
+        "minor_version": 1,
         "key": "google_assistant",
         "data": {"agent_user_ids": {"agent_1": {}}},
     }
@@ -188,6 +190,7 @@ async def _check_after_delay(data):
 
         assert hass_storage["google_assistant"] == {
             "version": 1,
+            "minor_version": 1,
             "key": "google_assistant",
             "data": data,
         }