Memfault Firmware SDK 1.2.2 (Build 3403)

Author: Memfault Inc

CHANGES.md

@@ -1,3 +1,14 @@
+# Memfault Firmware SDK Changelog
+
+## 1.2.2 - Sept 5, 2023
+
+### :chart_with_upwards_trend: Improvements
+
+- ESP-IDF:
+  - Correct the heartbeat metrics key definition include configuration to
+    generate a consistent key index across the application. This regressed in
+    version 1.0.1 of the SDK.
+
 ### Changes between Memfault SDK 1.2.0 and 1.2.1 - Sept 1, 2023
 
 #### :chart_with_upwards_trend: Improvements

VERSION

@@ -1,2 +1,2 @@
-BUILD ID: 3382
-GIT COMMIT: b1e62a17a
+BUILD ID: 3403
+GIT COMMIT: 6563e08b6

components/include/memfault/version.h

@@ -19,8 +19,8 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 2, .patch = 1 }
-#define MEMFAULT_SDK_VERSION_STR "1.2.1"
+#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 2, .patch = 2 }
+#define MEMFAULT_SDK_VERSION_STR "1.2.2"
 
 #ifdef __cplusplus
 }

ports/esp_idf/memfault/CMakeLists.txt

@@ -187,7 +187,16 @@ if (CONFIG_MEMFAULT_FREERTOS_TASK_RUNTIME_STATS)
 endif()
 
 component_compile_options(-DMEMFAULT_ESP_HTTP_CLIENT_ENABLE=$ENV{MEMFAULT_ESP_HTTP_CLIENT_ENABLE})
-component_compile_options(-DMEMFAULT_METRICS_USER_HEARTBEAT_DEFS_FILE="memfault_esp_metrics_heartbeat_config.def")
+# Set the heartbeat config file to use the ESP-IDF port file, which will bring
+# in the user's heartbeat config automatically. Set it as a global compiler
+# option so it properly affects both component compilation and when the metric
+# keys are used in the application.
+if (IDF_VERSION_MAJOR VERSION_EQUAL 3)
+  # On pre-v4 of ESP-IDF, insert the compiler flag to the global CMAKE_C_FLAGS
+  set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DMEMFAULT_METRICS_USER_HEARTBEAT_DEFS_FILE=\\\"memfault_esp_metrics_heartbeat_config.def\\\"" CACHE STRING "Global C Flags" FORCE)
+else()
+  idf_build_set_property(COMPILE_OPTIONS -DMEMFAULT_METRICS_USER_HEARTBEAT_DEFS_FILE="memfault_esp_metrics_heartbeat_config.def" APPEND)
+endif()
 
 # We will intercept the panic handlers enabled by CONFIG_ESP32_ENABLE_COREDUMP_TO_FLASH
 # and run the Memfault Fault Handler instead.

scripts/mflt-build-id/src/mflt_build_id/__init__.py

@@ -235,15 +235,16 @@ class BuildIdError(Exception):
 
 
 class BuildIdInspectorAndPatcher:
-    def __init__(self, elf_file, elf=None):
-        # type: (IO[bytes], Optional[ELFFile]) -> None
+    def __init__(self, elf_file, elf=None, elf_helper=None):
+        # type: (IO[bytes], Optional[ELFFile], Optional[ELFFileHelper]) -> None
         """
         :param elf_file: file object with the ELF to inspect and/or patch
         :param elf: optional, already instantiated ELFFile
+        :param elf_helper: optional, already instantiated ELFFileHelper
         """
         self.elf_file = elf_file
-        self.elf = elf or ELFFile(elf_file)
-        self._helper = ELFFileHelper(self.elf)
+        self.elf = (elf_helper.elf if elf_helper else elf) or ELFFile(elf_file)
+        self._helper = elf_helper or ELFFileHelper(self.elf)
 
     def _generate_build_id(self, sha1_symbol_section=None, sha1_symbol_section_offset=0):
         # type: (Optional[Section], int) -> hashlib._Hash