Refactor OTA update manager

include/Common.h

@@ -3,11 +3,11 @@
 #include <cstdint>
 #include <string_view>
 
-#define DISABLE_COPY(TypeName)             \
-  TypeName(const TypeName&) = delete;      \
+#define DISABLE_COPY(TypeName)              \
+  TypeName(const TypeName&)       = delete; \
   void operator=(const TypeName&) = delete
-#define DISABLE_MOVE(TypeName)             \
-  TypeName(TypeName&&) = delete;           \
+#define DISABLE_MOVE(TypeName)         \
+  TypeName(TypeName&&)       = delete; \
   void operator=(TypeName&&) = delete
 
 #ifndef OPENSHOCK_API_DOMAIN
@@ -20,7 +20,17 @@
 #error "OPENSHOCK_FW_VERSION must be defined"
 #endif
 
-#define OPENSHOCK_FW_CDN_URL(path) "https://" OPENSHOCK_FW_CDN_DOMAIN path
+#define OPENSHOCK_FW_CDN_URL(path)                "https://" OPENSHOCK_FW_CDN_DOMAIN path
+#define OPENSHOCK_FW_CDN_CHANNEL_URL(ch)          OPENSHOCK_FW_CDN_URL("/version-" ch ".txt")
+#define OPENSHOCK_FW_CDN_STABLE_URL               OPENSHOCK_FW_CDN_CHANNEL_URL("stable")
+#define OPENSHOCK_FW_CDN_BETA_URL                 OPENSHOCK_FW_CDN_CHANNEL_URL("beta")
+#define OPENSHOCK_FW_CDN_DEVELOP_URL              OPENSHOCK_FW_CDN_CHANNEL_URL("develop")
+#define OPENSHOCK_FW_CDN_BOARDS_BASE_URL_FORMAT   OPENSHOCK_FW_CDN_URL("/%s")
+#define OPENSHOCK_FW_CDN_BOARDS_INDEX_URL_FORMAT  OPENSHOCK_FW_CDN_BOARDS_BASE_URL_FORMAT "/boards.txt"
+#define OPENSHOCK_FW_CDN_VERSION_BASE_URL_FORMAT  OPENSHOCK_FW_CDN_BOARDS_BASE_URL_FORMAT "/" OPENSHOCK_FW_BOARD
+#define OPENSHOCK_FW_CDN_APP_URL_FORMAT           OPENSHOCK_FW_CDN_VERSION_BASE_URL_FORMAT "/app.bin"
+#define OPENSHOCK_FW_CDN_FILESYSTEM_URL_FORMAT    OPENSHOCK_FW_CDN_VERSION_BASE_URL_FORMAT "/staticfs.bin"
+#define OPENSHOCK_FW_CDN_SHA256_HASHES_URL_FORMAT OPENSHOCK_FW_CDN_VERSION_BASE_URL_FORMAT "/hashes.sha256.txt"
 
 #define OPENSHOCK_GPIO_INVALID -1
 
@@ -40,7 +50,8 @@
 
 // Check if Arduino.h exists, if not instruct the developer to remove "arduino-esp32" from the useragent and replace it with "ESP-IDF", after which the developer may remove this warning.
 #if defined(__has_include) && !__has_include("Arduino.h")
-#warning "Let it be known that Arduino hath finally been cast aside in favor of the noble ESP-IDF! I beseech thee, kind sir or madam, wouldst thou kindly partake in the honors of expunging 'arduino-esp32' from yonder useragent aloft, and in its stead, bestow the illustrious 'ESP-IDF'?"
+#warning \
+  "Let it be known that Arduino hath finally been cast aside in favor of the noble ESP-IDF! I beseech thee, kind sir or madam, wouldst thou kindly partake in the honors of expunging 'arduino-esp32' from yonder useragent aloft, and in its stead, bestow the illustrious 'ESP-IDF'?"
 #endif
 
 #if __cplusplus >= 202'302L

include/config/OtaUpdateConfig.h

@@ -2,25 +2,16 @@
 
 #include "config/ConfigBase.h"
 #include "FirmwareBootType.h"
-#include "OtaUpdateChannel.h"
-#include "OtaUpdateStep.h"
+#include "ota/OtaUpdateChannel.h"
+#include "ota/OtaUpdateStep.h"
 
 #include <string>
 
 namespace OpenShock::Config {
   struct OtaUpdateConfig : public ConfigBase<Serialization::Configuration::OtaUpdateConfig> {
     OtaUpdateConfig();
     OtaUpdateConfig(
-      bool isEnabled,
-      std::string cdnDomain,
-      OtaUpdateChannel updateChannel,
-      bool checkOnStartup,
-      bool checkPeriodically,
-      uint16_t checkInterval,
-      bool allowBackendManagement,
-      bool requireManualApproval,
-      int32_t updateId,
-      OtaUpdateStep updateStep
+      bool isEnabled, std::string cdnDomain, OtaUpdateChannel updateChannel, bool checkOnStartup, bool checkPeriodically, uint16_t checkInterval, bool allowBackendManagement, bool requireManualApproval, int32_t updateId, OtaUpdateStep updateStep
     );
 
     bool isEnabled;

include/http/FirmwareCDN.h

@@ -0,0 +1,35 @@
+#pragma once
+
+#include "http/HTTPRequestManager.h"
+#include "ota/FirmwareBinaryHash.h"
+#include "ota/FirmwareReleaseInfo.h"
+#include "ota/OtaUpdateChannel.h"
+#include "SemVer.h"
+
+#include <string_view>
+
+namespace OpenShock::HTTP::FirmwareCDN {
+  /// @brief Fetches the firmware version for the given channel from the firmware CDN.
+  /// Valid response codes: 200, 304
+  /// @param channel The channel to fetch the firmware version for.
+  /// @return The firmware version or an error response.
+  HTTP::Response<OpenShock::SemVer> GetFirmwareVersion(OtaUpdateChannel channel);
+
+  /// @brief Fetches the list of available boards for the given firmware version from the firmware CDN.
+  /// Valid response codes: 200, 304
+  /// @param version The firmware version to fetch the boards for.
+  /// @return The list of available boards or an error response.
+  HTTP::Response<std::vector<std::string>> GetFirmwareBoards(const OpenShock::SemVer& version);
+
+  /// @brief Fetches the binary hashes for the given firmware version from the firmware CDN.
+  /// Valid response codes: 200, 304
+  /// @param version The firmware version to fetch the binary hashes for.
+  /// @return The binary hashes or an error response.
+  HTTP::Response<std::vector<FirmwareBinaryHash>> GetFirmwareBinaryHashes(const OpenShock::SemVer& version);
+
+  /// @brief Fetches the firmware release information for the given firmware version from the firmware CDN.
+  /// Valid response codes: 200, 304
+  /// @param version The firmware version to fetch the release information for.
+  /// @return The firmware release information or an error response.
+  HTTP::Response<FirmwareReleaseInfo> GetFirmwareReleaseInfo(const OpenShock::SemVer& version);
+}  // namespace OpenShock::HTTP::FirmwareCDN

include/ota/FirmwareBinaryHash.h

@@ -0,0 +1,11 @@
+#pragma once
+
+#include <cstdint>
+#include <string>
+
+namespace OpenShock {
+  struct FirmwareBinaryHash {
+    std::string name;
+    uint8_t hash[32];
+  };
+}  // namespace OpenShock

include/ota/FirmwareReleaseInfo.h

@@ -0,0 +1,13 @@
+#pragma once
+
+#include <cstdint>
+#include <string>
+
+namespace OpenShock {
+  struct FirmwareReleaseInfo {
+    std::string appBinaryUrl;
+    uint8_t appBinaryHash[32];
+    std::string filesystemBinaryUrl;
+    uint8_t filesystemBinaryHash[32];
+  };
+}  // namespace OpenShock

include/OtaUpdateChannel.h → include/ota/OtaUpdateChannel.h

@@ -2,13 +2,14 @@
 
 #include "serialization/_fbs/HubConfig_generated.h"
 
-#include <cstring>
 #include <cstdint>
+#include <cstring>
 
 namespace OpenShock {
   typedef OpenShock::Serialization::Configuration::OtaUpdateChannel OtaUpdateChannel;
 
-  inline bool TryParseOtaUpdateChannel(OtaUpdateChannel& channel, const char* str) {
+  inline bool TryParseOtaUpdateChannel(OtaUpdateChannel& channel, const char* str)
+  {
     if (strcasecmp(str, "stable") == 0) {
       channel = OtaUpdateChannel::Stable;
       return true;

include/ota/OtaUpdateClient.h

@@ -0,0 +1,21 @@
+#pragma once
+
+#include "SemVer.h"
+
+#include <freertos/task.h>
+
+namespace OpenShock {
+  class OtaUpdateClient {
+  public:
+    OtaUpdateClient(const OpenShock::SemVer& version);
+    ~OtaUpdateClient();
+
+    bool Start();
+
+  private:
+    void _task();
+
+    OpenShock::SemVer m_version;
+    TaskHandle_t m_taskHandle;
+  };
+}  // namespace OpenShock

include/OtaUpdateManager.h → include/ota/OtaUpdateManager.h

@@ -1,6 +1,7 @@
 #pragma once
 
 #include "FirmwareBootType.h"
+#include "FirmwareReleaseInfo.h"
 #include "OtaUpdateChannel.h"
 #include "SemVer.h"
 
@@ -12,17 +13,6 @@
 namespace OpenShock::OtaUpdateManager {
   [[nodiscard]] bool Init();
 
-  struct FirmwareRelease {
-    std::string appBinaryUrl;
-    uint8_t appBinaryHash[32];
-    std::string filesystemBinaryUrl;
-    uint8_t filesystemBinaryHash[32];
-  };
-
-  bool TryGetFirmwareVersion(OtaUpdateChannel channel, OpenShock::SemVer& version);
-  bool TryGetFirmwareBoards(const OpenShock::SemVer& version, std::vector<std::string>& boards);
-  bool TryGetFirmwareRelease(const OpenShock::SemVer& version, FirmwareRelease& release);
-
   bool TryStartFirmwareUpdate(const OpenShock::SemVer& version);
 
   FirmwareBootType GetFirmwareBootType();

include/OtaUpdateStep.h → include/ota/OtaUpdateStep.h

@@ -8,7 +8,8 @@
 namespace OpenShock {
   typedef OpenShock::Serialization::Configuration::OtaUpdateStep OtaUpdateStep;
 
-  inline bool TryParseOtaUpdateStep(OtaUpdateStep& channel, const char* str) {
+  inline bool TryParseOtaUpdateStep(OtaUpdateStep& channel, const char* str)
+  {
     if (strcasecmp(str, "none") == 0) {
       channel = OtaUpdateStep::None;
       return true;

src/GatewayClient.cpp

@@ -7,7 +7,7 @@ const char* const TAG = "GatewayClient";
 #include "events/Events.h"
 #include "Logging.h"
 #include "message_handlers/WebSocket.h"
-#include "OtaUpdateManager.h"
+#include "ota/OtaUpdateManager.h"
 #include "serialization/WSGateway.h"
 #include "Time.h"
 #include "util/CertificateUtils.h"