Merge pull request #366 from reo7sp/fix-tg-exception

Parse Telegram error response parameters

Author: reo7sp

include/tgbot/TgException.h

@@ -1,5 +1,6 @@
 #pragma once
 
+#include "tgbot/Types.h"
 #include "tgbot/export.h"
 
 #include <stdexcept>
@@ -30,9 +31,15 @@ class TGBOT_API TgException : public std::runtime_error {
         InvalidJson = 101
     };
 
-    TgException(std::string_view description, ErrorCode errorCode);
+    TgException(std::string_view description, ErrorCode errorCode,
+                std::shared_ptr<ResponseParameters> parameters = nullptr);
 
     const ErrorCode errorCode;
+
+    /**
+     * @brief Additional details about the error returned by Telegram, if any.
+     */
+    const std::shared_ptr<ResponseParameters> parameters;
 };
 
 } // namespace TgBot

src/Api.cpp

@@ -39,8 +39,12 @@ nlohmann::json Api::sendRequest(std::string_view method, const std::vector<HttpF
         throw TgException(exception.what(), TgException::ErrorCode::InvalidJson);
     }
     if (!response.value("ok", false)) {
+        std::shared_ptr<ResponseParameters> parameters;
+        if (const auto iterator = response.find("parameters"); iterator != response.end()) {
+            parameters = std::make_shared<ResponseParameters>(iterator->get<ResponseParameters>());
+        }
         throw TgException(response.value("description", "Telegram Bot API request failed"),
-                          static_cast<TgException::ErrorCode>(response.value("error_code", 0)));
+                          static_cast<TgException::ErrorCode>(response.value("error_code", 0)), std::move(parameters));
     }
 
     return response.at("result");

src/TgException.cpp

@@ -1,10 +1,14 @@
 #include "tgbot/TgException.h"
 
+#include <utility>
+
 namespace TgBot {
 
-TgException::TgException(std::string_view description, ErrorCode errorCode)
+TgException::TgException(std::string_view description, ErrorCode errorCode,
+                         std::shared_ptr<ResponseParameters> parameters)
     : runtime_error(std::string(description))
-    , errorCode(errorCode) {
+    , errorCode(errorCode)
+    , parameters(std::move(parameters)) {
 }
 
 } // namespace TgBot

tests/tgbot/Api.cpp

@@ -60,6 +60,25 @@ TEST(Api, GeneratedMethodMapsTelegramErrors) {
     EXPECT_TRUE(requestThrows(ErrorCode::InvalidJson, "error_code:101"));
 }
 
+TEST(Api, GeneratedMethodPreservesTelegramErrorParameters) {
+    HttpClientMock httpClient;
+    httpClient.response
+        = R"({"ok":false,"error_code":400,"description":"migrated","parameters":{"migrate_to_chat_id":-1001234567890,"retry_after":42}})";
+    TgBot::Api api("token", httpClient, "url");
+
+    try {
+        api.getMe();
+        FAIL() << "Expected TgException";
+    } catch (const TgBot::TgException& exception) {
+        EXPECT_EQ(exception.errorCode, TgBot::TgException::ErrorCode::BadRequest);
+        ASSERT_TRUE(exception.parameters);
+        ASSERT_TRUE(exception.parameters->migrateToChatId);
+        EXPECT_EQ(*exception.parameters->migrateToChatId, -1001234567890);
+        ASSERT_TRUE(exception.parameters->retryAfter);
+        EXPECT_EQ(*exception.parameters->retryAfter, 42);
+    }
+}
+
 TEST(Api, PassesCompleteUrlToHttpClient) {
     HttpClientMock httpClient;
     httpClient.response = R"({"ok":true,"result":{"id":1,"is_bot":true,"first_name":"bot"}})";