SentryReport.h

Go to the documentation of this file.

/*!********************************************************************
 
 Audacity: A Digital Audio Editor
 
 @file SentryReport.h
 @brief Declare a class to report errors to Sentry.
 
 Dmitry Vedenko
 **********************************************************************/
 
#pragma once
 
#include <string>
#include <utility>
#include <vector>
#include <memory>
#include <functional>
 
#include "AnonymizedMessage.h"
 
namespace audacity
{
namespace sentry
{
 
using ExceptionData = std::pair<std::string, AnonymizedMessage>;
 
struct SENTRY_REPORTING_API Exception final
{
   std::string Type;
   AnonymizedMessage Value;
   std::vector<ExceptionData> Data;
 
   static Exception Create(std::string type, AnonymizedMessage value);
   static Exception Create(AnonymizedMessage value);
   Exception& AddData(std::string key, AnonymizedMessage value);
};
 
struct SENTRY_REPORTING_API Message final
{
   AnonymizedMessage Value;
   std::vector<AnonymizedMessage> Params;
   static Message Create(AnonymizedMessage message);
   Message& AddParam(AnonymizedMessage value);
};
 
SENTRY_REPORTING_API void AddExceptionContext(
   std::string parameterName, AnonymizedMessage parameterValue);
 
class SENTRY_REPORTING_API Report final
{
public:
   using CompletionHandler = std::function<void (int httpCode, std::string responseBody)>;
 
   explicit Report(const Exception& exception);
 
   explicit Report(const Message& message);
 
   ~Report();
 
   void AddUserComment(const std::string& comment);
 
   std::string GetReportPreview() const;
 
   void Send(CompletionHandler completionHandler) const;
 
private:
   class ReportImpl;
 
   std::unique_ptr<ReportImpl> mImpl;
};
 
} // namespace sentry
} // namespace audacity