http_request_update.cpp

Go to the documentation of this file.

#include "http_request_update.h"
 
#include "esphome/core/application.h"
#include "esphome/core/version.h"
 
#include "esphome/components/json/json_util.h"
#include "esphome/components/network/util.h"
 
namespace esphome {
namespace http_request {
 
// The update function runs in a task only on ESP32s.
#ifdef USE_ESP32
// vTaskDelete doesn't return, but clang-tidy doesn't know that
#define UPDATE_RETURN \
  do { \
    vTaskDelete(nullptr); \
    __builtin_unreachable(); \
  } while (0)
#else
#define UPDATE_RETURN return
#endif
 
static const char *const TAG = "http_request.update";
 
static const size_t MAX_READ_SIZE = 256;
static constexpr uint32_t INITIAL_CHECK_INTERVAL_ID = 0;
static constexpr uint32_t INITIAL_CHECK_INTERVAL_MS = 10000;
static constexpr uint8_t INITIAL_CHECK_MAX_ATTEMPTS = 6;
 
void HttpRequestUpdate::setup() {
  this->ota_parent_->add_state_listener(this);
 
  // Check periodically until network is ready
  // Only if update interval is > total retry window to avoid redundant checks
  if (this->get_update_interval() != SCHEDULER_DONT_RUN &&
      this->get_update_interval() > INITIAL_CHECK_INTERVAL_MS * INITIAL_CHECK_MAX_ATTEMPTS) {
    this->initial_check_remaining_ = INITIAL_CHECK_MAX_ATTEMPTS;
    this->set_interval(INITIAL_CHECK_INTERVAL_ID, INITIAL_CHECK_INTERVAL_MS, [this]() {
      bool connected = network::is_connected();
      if (--this->initial_check_remaining_ == 0 || connected) {
        this->cancel_interval(INITIAL_CHECK_INTERVAL_ID);
        if (connected) {
          this->update();
        }
      }
    });
  }
}
 
void HttpRequestUpdate::on_ota_state(ota::OTAState state, float progress, uint8_t error) {
  if (state == ota::OTAState::OTA_IN_PROGRESS) {
    this->state_ = update::UPDATE_STATE_INSTALLING;
    this->update_info_.has_progress = true;
    this->update_info_.progress = progress;
    this->publish_state();
  } else if (state == ota::OTAState::OTA_ABORT || state == ota::OTAState::OTA_ERROR) {
    this->state_ = update::UPDATE_STATE_AVAILABLE;
    this->status_set_error(LOG_STR("Failed to install firmware"));
    this->publish_state();
  }
}
 
void HttpRequestUpdate::update() {
  if (!network::is_connected()) {
    ESP_LOGD(TAG, "Network not connected, skipping update check");
    return;
  }
  this->cancel_interval(INITIAL_CHECK_INTERVAL_ID);
#ifdef USE_ESP32
  xTaskCreate(HttpRequestUpdate::update_task, "update_task", 8192, (void *) this, 1, &this->update_task_handle_);
#else
  this->update_task(this);
#endif
}
 
void HttpRequestUpdate::update_task(void *params) {
  HttpRequestUpdate *this_update = (HttpRequestUpdate *) params;
 
  auto container = this_update->request_parent_->get(this_update->source_url_);
 
  if (container == nullptr || container->status_code != HTTP_STATUS_OK) {
    ESP_LOGE(TAG, "Failed to fetch manifest from %s", this_update->source_url_.c_str());
    // Defer to main loop to avoid race condition on component_state_ read-modify-write
    this_update->defer([this_update]() { this_update->status_set_error(LOG_STR("Failed to fetch manifest")); });
    UPDATE_RETURN;
  }
 
  RAMAllocator<uint8_t> allocator;
  uint8_t *data = allocator.allocate(container->content_length);
  if (data == nullptr) {
    ESP_LOGE(TAG, "Failed to allocate %zu bytes for manifest", container->content_length);
    // Defer to main loop to avoid race condition on component_state_ read-modify-write
    this_update->defer(
        [this_update]() { this_update->status_set_error(LOG_STR("Failed to allocate memory for manifest")); });
    container->end();
    UPDATE_RETURN;
  }
 
  auto read_result = http_read_fully(container.get(), data, container->content_length, MAX_READ_SIZE,
                                     this_update->request_parent_->get_timeout());
  if (read_result.status != HttpReadStatus::OK) {
    if (read_result.status == HttpReadStatus::TIMEOUT) {
      ESP_LOGE(TAG, "Timeout reading manifest");
    } else {
      ESP_LOGE(TAG, "Error reading manifest: %d", read_result.error_code);
    }
    // Defer to main loop to avoid race condition on component_state_ read-modify-write
    this_update->defer([this_update]() { this_update->status_set_error(LOG_STR("Failed to read manifest")); });
    allocator.deallocate(data, container->content_length);
    container->end();
    UPDATE_RETURN;
  }
  size_t read_index = container->get_bytes_read();
  size_t content_length = container->content_length;
 
  container->end();
  container.reset();  // Release ownership of the container's shared_ptr
 
  bool valid = false;
  {  // Scope to ensure JsonDocument is destroyed before deallocating buffer
    valid = json::parse_json(data, read_index, [this_update](JsonObject root) -> bool {
      if (!root[ESPHOME_F("name")].is<const char *>() || !root[ESPHOME_F("version")].is<const char *>() ||
          !root[ESPHOME_F("builds")].is<JsonArray>()) {
        ESP_LOGE(TAG, "Manifest does not contain required fields");
        return false;
      }
      this_update->update_info_.title = root[ESPHOME_F("name")].as<std::string>();
      this_update->update_info_.latest_version = root[ESPHOME_F("version")].as<std::string>();
 
      for (auto build : root[ESPHOME_F("builds")].as<JsonArray>()) {
        if (!build[ESPHOME_F("chipFamily")].is<const char *>()) {
          ESP_LOGE(TAG, "Manifest does not contain required fields");
          return false;
        }
        if (build[ESPHOME_F("chipFamily")] == ESPHOME_VARIANT) {
          if (!build[ESPHOME_F("ota")].is<JsonObject>()) {
            ESP_LOGE(TAG, "Manifest does not contain required fields");
            return false;
          }
          JsonObject ota = build[ESPHOME_F("ota")].as<JsonObject>();
          if (!ota[ESPHOME_F("path")].is<const char *>() || !ota[ESPHOME_F("md5")].is<const char *>()) {
            ESP_LOGE(TAG, "Manifest does not contain required fields");
            return false;
          }
          this_update->update_info_.firmware_url = ota[ESPHOME_F("path")].as<std::string>();
          this_update->update_info_.md5 = ota[ESPHOME_F("md5")].as<std::string>();
 
          if (ota[ESPHOME_F("summary")].is<const char *>())
            this_update->update_info_.summary = ota[ESPHOME_F("summary")].as<std::string>();
          if (ota[ESPHOME_F("release_url")].is<const char *>())
            this_update->update_info_.release_url = ota[ESPHOME_F("release_url")].as<std::string>();
 
          return true;
        }
      }
      return false;
    });
  }
  allocator.deallocate(data, content_length);
 
  if (!valid) {
    ESP_LOGE(TAG, "Failed to parse JSON from %s", this_update->source_url_.c_str());
    // Defer to main loop to avoid race condition on component_state_ read-modify-write
    this_update->defer([this_update]() { this_update->status_set_error(LOG_STR("Failed to parse manifest JSON")); });
    UPDATE_RETURN;
  }
 
  // Merge source_url_ and this_update->update_info_.firmware_url
  if (this_update->update_info_.firmware_url.find("http") == std::string::npos) {
    std::string path = this_update->update_info_.firmware_url;
    if (path[0] == '/') {
      std::string domain = this_update->source_url_.substr(0, this_update->source_url_.find('/', 8));
      this_update->update_info_.firmware_url = domain + path;
    } else {
      std::string domain = this_update->source_url_.substr(0, this_update->source_url_.rfind('/') + 1);
      this_update->update_info_.firmware_url = domain + path;
    }
  }
 
#ifdef ESPHOME_PROJECT_VERSION
  this_update->update_info_.current_version = ESPHOME_PROJECT_VERSION;
#else
  this_update->update_info_.current_version = ESPHOME_VERSION;
#endif
 
  bool trigger_update_available = false;
 
  if (this_update->update_info_.latest_version.empty() ||
      this_update->update_info_.latest_version == this_update->update_info_.current_version) {
    this_update->state_ = update::UPDATE_STATE_NO_UPDATE;
  } else {
    if (this_update->state_ != update::UPDATE_STATE_AVAILABLE) {
      trigger_update_available = true;
    }
    this_update->state_ = update::UPDATE_STATE_AVAILABLE;
  }
 
  // Defer to main loop to ensure thread-safe execution of:
  // - status_clear_error() performs non-atomic read-modify-write on component_state_
  // - publish_state() triggers API callbacks that write to the shared protobuf buffer
  //   which can be corrupted if accessed concurrently from task and main loop threads
  // - update_available trigger to ensure consistent state when the trigger fires
  this_update->defer([this_update, trigger_update_available]() {
    this_update->update_info_.has_progress = false;
    this_update->update_info_.progress = 0.0f;
 
    this_update->status_clear_error();
    this_update->publish_state();
 
    if (trigger_update_available) {
      this_update->get_update_available_trigger()->trigger(this_update->update_info_);
    }
  });
 
  UPDATE_RETURN;
}
 
void HttpRequestUpdate::perform(bool force) {
  if (this->state_ != update::UPDATE_STATE_AVAILABLE && !force) {
    return;
  }
 
  this->state_ = update::UPDATE_STATE_INSTALLING;
  this->publish_state();
 
  this->ota_parent_->set_md5(this->update_info.md5);
  this->ota_parent_->set_url(this->update_info.firmware_url);
  // Flash in the next loop
  this->defer([this]() { this->ota_parent_->flash(); });
}
 
}  // namespace http_request
}  // namespace esphome