feat(GODT-2356): unify sentry release description and add more context to it.

internal/frontend/bridge-gui/bridge-gui/BuildConfig.h.in

@@ -25,5 +25,6 @@
 #define PROJECT_REVISION    "@BRIDGE_REVISION@"
 #define PROJECT_BUILD_TIME  "@BRIDGE_BUILD_TIME@"
 #define PROJECT_DSN_SENTRY  "@BRIDGE_DSN_SENTRY@"
+#define PROJECT_BUILD_ENV   "@BRIDGE_BUILD_ENV@"
 
 #endif // BRIDGE_GUI_VERSION_H

internal/frontend/bridge-gui/bridge-gui/SentryUtils.cpp

@@ -31,13 +31,39 @@ QByteArray getProtectedHostname() {
     return hostname.toHex();
 }
 
+QString getApiOS() {
+#if defined(Q_OS_DARWIN)
+    return "macos";
+#elif defined(Q_OS_WINDOWS)
+    return "windows";
+#else
+    return "linux";
+#endif
+}
+
+QString appVersion(const QString& version) {
+    return QString("%1-bridge@%2").arg(getApiOS()).arg(version);
+}
+
 void setSentryReportScope() {
     sentry_set_tag("OS", bridgepp::goos().toUtf8());
     sentry_set_tag("Client", PROJECT_FULL_NAME);
-    sentry_set_tag("Version",   PROJECT_VER);
-    sentry_set_tag("UserAgent", QString("/ (%1)").arg(bridgepp::goos()).toUtf8());
-    sentry_set_tag("HostArch",  QSysInfo::currentCpuArchitecture().toUtf8());
-    sentry_set_tag("server_name",  getProtectedHostname());
+    sentry_set_tag("Version", QByteArray(PROJECT_REVISION).toHex());
+    sentry_set_tag("HostArch", QSysInfo::currentCpuArchitecture().toUtf8());
+    sentry_set_tag("server_name", getProtectedHostname());
+}
+
+sentry_options_t* newSentryOptions(const char *sentryDNS, const char *cacheDir) {
+    sentry_options_t *sentryOptions = sentry_options_new();
+    sentry_options_set_dsn(sentryOptions, sentryDNS);
+    sentry_options_set_database_path(sentryOptions, cacheDir);
+    sentry_options_set_release(sentryOptions, appVersion(PROJECT_VER).toUtf8());
+    sentry_options_set_max_breadcrumbs(sentryOptions, 50);
+    sentry_options_set_environment(sentryOptions, PROJECT_BUILD_ENV);
+    // Enable this for debugging sentry.
+    // sentry_options_set_debug(sentryOptions, 1);
+
+    return sentryOptions;
 }
 
 sentry_uuid_t reportSentryEvent(sentry_level_t level, const char *message) {
@@ -51,3 +77,5 @@ sentry_uuid_t reportSentryException(sentry_level_t level, const char *message, c
     sentry_event_add_exception(event, sentry_value_new_exception(exceptionType, exception));
     return sentry_capture_event(event);
 }
+
+

internal/frontend/bridge-gui/bridge-gui/SentryUtils.h

@@ -22,6 +22,7 @@
 #include <sentry.h>
 
 void setSentryReportScope();
+sentry_options_t* newSentryOptions(const char * sentryDNS, const char * cacheDir);
 sentry_uuid_t reportSentryEvent(sentry_level_t level, const char *message);
 sentry_uuid_t reportSentryException(sentry_level_t level, const char *message, const char *exceptionType, const char *exception);
 

internal/frontend/bridge-gui/bridge-gui/build.ps1

@@ -79,6 +79,12 @@ $REVISION_HASH = git rev-parse --short=10 HEAD
 $bridgeDsnSentry = ($env:BRIDGE_DSN_SENTRY)
 $bridgeBuidTime = ($env:BRIDGE_BUILD_TIME)
 
+$bridgeBuildEnv = ($env:BRIDGE_BUILD_ENV)
+if ($null -eq $bridgeBuildEnv)
+{
+    $bridgeBuildEnv =  "dev"
+}
+
 git submodule update --init --recursive $vcpkgRoot
 . $vcpkgBootstrap -disableMetrics
 . $vcpkgExe install sentry-native:x64-windows grpc:x64-windows --clean-after-build
@@ -90,6 +96,7 @@ git submodule update --init --recursive $vcpkgRoot
                                        -DBRIDGE_APP_VERSION="$bridgeVersion" `
                                        -DBRIDGE_BUILD_TIME="$bridgeBuidTime" `
                                        -DBRIDGE_DSN_SENTRY="$bridgeDsnSentry" `
+                                       -DBRIDGE_BUILD_ENV="$bridgeBuildEnv" `
                                        -S . -B $buildDir
 
 check_exit "CMake failed"

internal/frontend/bridge-gui/bridge-gui/build.sh

@@ -58,6 +58,7 @@ VCPKG_ROOT="${BRIDGE_REPO_ROOT}/extern/vcpkg"
 BRIDGE_REVISION=$(git rev-parse --short=10 HEAD)
 BRIDGE_DSN_SENTRY=${BRIDGE_DSN_SENTRY}
 BRIDGE_BUILD_TIME=${BRIDGE_BUILD_TIME}
+BRIDGE_BUILD_ENV= ${BRIDGE_BUILD_ENV:-"dev"}
 git submodule update --init --recursive ${VCPKG_ROOT}
 check_exit "Failed to initialize vcpkg as a submodule."
 
@@ -98,6 +99,7 @@ cmake  \
     -DBRIDGE_REVISION="${BRIDGE_REVISION}" \
     -DBRIDGE_DSN_SENTRY="${BRIDGE_DSN_SENTRY}" \
     -DBRIDGE_BRIDGE_TIME="${BRIDGE_BRIDGE_TIME}" \
+    -DBRIDGE_BUILD_ENV="${BRIDGE_BUILD_ENV}" \
     -DBRIDGE_APP_VERSION="${BRIDGE_APP_VERSION}" "${BRIDGE_CMAKE_MACOS_OPTS}" \
     -G Ninja \
     -S . \

internal/frontend/bridge-gui/bridge-gui/main.cpp

@@ -291,15 +291,8 @@ void closeBridgeApp() {
 //****************************************************************************************************************************************************
 int main(int argc, char *argv[]) {
     // Init sentry.
-    sentry_options_t *sentryOptions = sentry_options_new();
-    sentry_options_set_dsn(sentryOptions, PROJECT_DSN_SENTRY);
-    {
-        const QString sentryCachePath = sentryCacheDir();
-        sentry_options_set_database_path(sentryOptions, sentryCachePath.toStdString().c_str());
-    }
-    sentry_options_set_release(sentryOptions, QByteArray(PROJECT_REVISION).toHex());
-    // Enable this for debugging sentry.
-    // sentry_options_set_debug(sentryOptions, 1);
+    sentry_options_t *sentryOptions = newSentryOptions(PROJECT_DSN_SENTRY, sentryCacheDir().toStdString().c_str());
+
     if (sentry_init(sentryOptions) != 0) {
         std::cerr << "Failed to initialize sentry" << std::endl;
     }