[esp32][core] Restore ESP-IDF version on logs/upload fast path and clean build on framework change (#16770)

esphome/storage_json.py

@@ -16,7 +16,7 @@ from esphome.const import (
     KEY_TARGET_PLATFORM,
     Toolchain,
 )
-from esphome.core import CORE
+from esphome.core import CORE, EsphomeError
 from esphome.helpers import write_file_if_changed
 from esphome.types import CoreType
 
@@ -101,6 +101,7 @@ class StorageJSON:
         core_platform: str | None = None,
         toolchain: str | None = None,
         area: str | None = None,
+        framework_version: str | None = None,
     ) -> None:
         # Version of the storage JSON schema
         assert storage_version is None or isinstance(storage_version, int)
@@ -141,6 +142,8 @@ class StorageJSON:
         self.toolchain = toolchain
         # The area of the node
         self.area = area
+        # The framework version the build used (for esp32, the resolved ESP-IDF version)
+        self.framework_version = framework_version
 
     def as_dict(self):
         return {
@@ -162,6 +165,7 @@ class StorageJSON:
             "core_platform": self.core_platform,
             "toolchain": self.toolchain,
             "area": self.area,
+            "framework_version": self.framework_version,
         }
 
     def to_json(self):
@@ -173,10 +177,12 @@ class StorageJSON:
     @staticmethod
     def from_esphome_core(esph: CoreType, old: StorageJSON | None) -> StorageJSON:
         hardware = esph.target_platform.upper()
+        framework_version: str | None = None
         if esph.is_esp32:
             from esphome.components import esp32
 
             hardware = esp32.get_esp32_variant(esph)
+            framework_version = str(esp32.idf_version())
         return StorageJSON(
             storage_version=1,
             name=esph.name,
@@ -200,6 +206,7 @@ class StorageJSON:
             core_platform=esph.target_platform,
             toolchain=esph.toolchain.value if esph.toolchain is not None else None,
             area=esph.area,
+            framework_version=framework_version,
         )
 
     @staticmethod
@@ -249,6 +256,7 @@ class StorageJSON:
         core_platform = storage.get("core_platform")
         toolchain = storage.get("toolchain")
         area = storage.get("area")
+        framework_version = storage.get("framework_version")
         return StorageJSON(
             storage_version,
             name,
@@ -268,6 +276,7 @@ class StorageJSON:
             core_platform,
             toolchain,
             area,
+            framework_version,
         )
 
     @staticmethod
@@ -311,10 +320,24 @@ class StorageJSON:
         # esp32.get_esp32_variant(). target_platform on disk is the variant
         # (e.g. "ESP32S3"); core_platform is the family (e.g. "esp32").
         if target_platform == const.PLATFORM_ESP32:
-            from esphome.components.esp32.const import KEY_ESP32
+            from esphome.components.esp32.const import KEY_ESP32, KEY_IDF_VERSION
             from esphome.const import KEY_VARIANT
 
-            CORE.data[KEY_ESP32] = {KEY_VARIANT: self.target_platform}
+            esp32_data = {KEY_VARIANT: self.target_platform}
+            if self.framework_version:
+                import esphome.config_validation as cv
+
+                try:
+                    esp32_data[KEY_IDF_VERSION] = cv.Version.parse(
+                        self.framework_version
+                    )
+                except ValueError as err:
+                    raise EsphomeError(
+                        f"Could not parse the framework version "
+                        f"{self.framework_version!r} from {storage_path()}. "
+                        f"Please clean the build files and recompile."
+                    ) from err
+            CORE.data[KEY_ESP32] = esp32_data
 
     def __eq__(self, o) -> bool:
         return isinstance(o, StorageJSON) and self.as_dict() == o.as_dict()