Parse the new error_report value from the user pro status endpoint

Author: Doy-lee

include/session/pro_backend.h

@@ -55,6 +55,13 @@ typedef enum SESSION_PRO_BACKEND_USER_PRO_STATUS {
     SESSION_PRO_BACKEND_USER_PRO_STATUS_COUNT,
 } SESSION_PRO_BACKEND_USER_PRO_STATUS;
 
+typedef enum SESSION_PRO_BACKEND_GET_PRO_STATUS_ERROR_REPORT {
+    SESSION_PRO_BACKEND_GET_PRO_STATUS_ERROR_REPORT_SUCCESS,
+    SESSION_PRO_BACKEND_GET_PRO_STATUS_ERROR_REPORT_GENERIC_ERROR,
+    SESSION_PRO_BACKEND_GET_PRO_STATUS_ERROR_REPORT_COUNT,
+} SESSION_PRO_BACKEND_GET_PRO_STATUS_ERROR_REPORT;
+
+
 /// Bundle of hard-coded URLs that an application may want to redirect users to in various
 /// scenarios.
 typedef struct session_pro_urls session_pro_urls;
@@ -277,6 +284,7 @@ struct session_pro_backend_get_pro_status_response {
     session_pro_backend_pro_payment_item* items;
     size_t items_count;
     SESSION_PRO_BACKEND_USER_PRO_STATUS status;
+    SESSION_PRO_BACKEND_GET_PRO_STATUS_ERROR_REPORT error_report;
     bool auto_renewing;
     uint64_t expiry_unix_ts_ms;
     uint64_t grace_period_duration_ms;

include/session/pro_backend.hpp

@@ -381,6 +381,11 @@ struct GetProStatusResponse : public ResponseHeader {
     /// Current Session Pro entitlement status for the master public key
     SESSION_PRO_BACKEND_USER_PRO_STATUS user_status;
 
+    /// Error code that indicates that the Session Pro Backend encountered an error book-keeping
+    /// Session Pro entitlement for the user. If this value is not `SUCCESS` implementing clients
+    /// can optionally prompt the user that they should contact support for investigation.
+    SESSION_PRO_BACKEND_GET_PRO_STATUS_ERROR_REPORT error_report;
+
     /// Flag to indicate if the user will automatically renew their subscription.
     bool auto_renewing;
 

src/pro_backend.cpp

@@ -455,6 +455,15 @@ GetProStatusResponse GetProStatusResponse::parse(std::string_view json) {
         return result;
     }
     result.user_status = static_cast<SESSION_PRO_BACKEND_USER_PRO_STATUS>(user_status);
+
+    uint32_t error_report = json_require<uint32_t>(result_obj, "error_report", result.errors);
+    if (error_report >= SESSION_PRO_BACKEND_GET_PRO_STATUS_ERROR_REPORT_COUNT) {
+        result.errors.push_back(
+                fmt::format("Error report value was out-of-bounds: {}", user_status));
+        return result;
+    }
+    result.error_report = static_cast<SESSION_PRO_BACKEND_GET_PRO_STATUS_ERROR_REPORT>(error_report);
+
     result.auto_renewing = json_require<bool>(result_obj, "auto_renewing", result.errors);
 
     uint64_t expiry_unix_ts_ms =
@@ -954,6 +963,7 @@ session_pro_backend_get_pro_status_response_parse(const char* json, size_t json_
     // Copy to C struct, this is guaranteed not to fail because we pre-allocated memory upfront.
     result.header.status = cpp.status;
     result.status = cpp.user_status;
+    result.error_report = cpp.error_report;
     result.items_count = cpp.items.size();
     result.items = (session_pro_backend_pro_payment_item*)arena_alloc(
             &arena, result.items_count * sizeof(*result.items));

tests/test_pro_backend.cpp

@@ -548,6 +548,7 @@ TEST_CASE("Session Pro Backend C API", "[session_pro_backend]") {
             j["status"] = SESSION_PRO_BACKEND_STATUS_SUCCESS;
             j["result"] = {
                     {"status", SESSION_PRO_BACKEND_USER_PRO_STATUS_EXPIRED},
+                    {"error_report", SESSION_PRO_BACKEND_GET_PRO_STATUS_ERROR_REPORT_GENERIC_ERROR},
                     {"auto_renewing", true},
                     {"expiry_unix_ts_ms", unix_ts_ms + 2},
                     {"grace_period_duration_ms", 1000},
@@ -582,6 +583,8 @@ TEST_CASE("Session Pro Backend C API", "[session_pro_backend]") {
                 REQUIRE(result.header.errors_count == 0);
                 REQUIRE(result.header.errors == nullptr);
                 REQUIRE(result.status == SESSION_PRO_BACKEND_USER_PRO_STATUS_EXPIRED);
+                REQUIRE(result.error_report ==
+                        SESSION_PRO_BACKEND_GET_PRO_STATUS_ERROR_REPORT_GENERIC_ERROR);
                 REQUIRE(result.items_count == 1);
                 REQUIRE(result.auto_renewing == true);
                 REQUIRE(result.grace_period_duration_ms == 1000);