Cross-Plattform Crash Reporting

.github/workflows/functional_tests.yaml

@@ -23,13 +23,8 @@ jobs:
     steps:
       - name: Clone repository
         uses: actions/checkout@v3
-
-      - name: Checkout submodules
-        shell: bash
-        run: |
-          auth_header="$(git config --local --get http.https://github.com/.extraheader)"
-          git submodule sync --recursive
-          git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
+        with: 
+          submodules: 'true'
       - name: Install dependecies
         if: steps.cache-build.outputs.cache-hit != 'true'
         run: |

.github/workflows/gh_pages.yaml

@@ -81,13 +81,8 @@ jobs:
     steps:
       - name: Clone repository
         uses: actions/checkout@v3
-
-      - name: Checkout submodules
-        shell: bash
-        run: |
-          auth_header="$(git config --local --get http.https://github.com/.extraheader)"
-          git submodule sync --recursive
-          git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
+        with: 
+          submodules: 'true'
 
       - name: Install Qt
         shell: bash

.github/workflows/linters.yaml

@@ -22,13 +22,8 @@ jobs:
 
       - name: Clone repository
         uses: actions/checkout@v3
-
-      - name: Checkout submodules
-        shell: bash
-        run: |
-          auth_header="$(git config --local --get http.https://github.com/.extraheader)"
-          git submodule sync --recursive
-          git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
+        with: 
+          submodules: 'true'
 
       - name: Set up Python 3
         uses: actions/setup-python@v3

.github/workflows/test_unit.yaml

@@ -23,6 +23,8 @@ jobs:
     steps:
       - name: Clone repository
         uses: actions/checkout@v3
+        with: 
+          submodules: 'true'
 
       - name: Install dependences
         run: |
@@ -32,13 +34,6 @@ jobs:
           python3 -m pip install aqtinstall
           aqt install-qt --outputdir /opt linux desktop $QTVERSION gcc_64 -m all
 
-      - name: Checkout submodules
-        shell: bash
-        run: |
-          auth_header="$(git config --local --get http.https://github.com/.extraheader)"
-          git submodule sync --recursive
-          git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
-
       - name: Cache grcov
         id: cache-grcov
         uses: actions/cache@v3
@@ -96,14 +91,8 @@ jobs:
     steps:
       - name: Clone repository
         uses: actions/checkout@v3
-
-      - name: Checkout submodules
-        shell: bash
-        run: |
-          auth_header="$(git config --local --get http.https://github.com/.extraheader)"
-          git submodule sync --recursive
-          git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
-
+        with: 
+          submodules: 'true'
       - name: Install python dependencies
         shell: bash
         run: |
@@ -177,13 +166,8 @@ jobs:
     steps:
       - name: Clone repository
         uses: actions/checkout@v3
-
-      - name: Checkout submodules
-        shell: bash
-        run: |
-          auth_header="$(git config --local --get http.https://github.com/.extraheader)"
-          git submodule sync --recursive
-          git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
+        with: 
+          submodules: 'true'
 
       - name: Install Qt
         shell: bash

.github/workflows/wasm.yaml

@@ -26,13 +26,8 @@ jobs:
     steps:
       - name: Clone repository
         uses: actions/checkout@v3
-
-      - name: Checkout submodules
-        shell: bash
-        run: |
-          auth_header="$(git config --local --get http.https://github.com/.extraheader)"
-          git submodule sync --recursive
-          git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
+        with: 
+            submodules: 'true'
 
       - name: Install Qt
         shell: bash

.gitignore

@@ -104,6 +104,8 @@ vscode-cpptools/*
 *.xcodeproj/
 MozillaVPN.vcxproj*
 *.autosave
+# Visual Studio stuff.
+CMakeSettings.json
 
 # Qt Creator
 CMakeLists.txt.user

.gitmodules

@@ -29,3 +29,6 @@
 	path = 3rdparty/glean
 	url = https://github.com/mozilla/glean.git
 	branch = main
+[submodule "3rdparty/sentry"]
+	path = 3rdparty/sentry
+	url = https://github.com/getsentry/sentry-native/

LICENSE.md

@@ -56,6 +56,11 @@ the terms of the MIT Public License (*MIT*), a copy of which is available
 [available here](https://opensource.org/licenses/MIT) and a copy is provided
 below.
 
+The project relies on [sentry-native](https://github.com/getsentry/sentry-native), under
+the terms of the MIT Public License (*MIT*), a copy of which is available
+[available here](https://opensource.org/licenses/MIT) and a copy is provided
+below.
+
 Finally, this project uses EC25519 and CHACHA-POLY implementations from
 [HACL\*](https://hacl-star.github.io/), available under the terms of the MIT
 Public License (*MIT*) and copyright (c) 2016-2020 INRIA, CMU, and Microsoft
@@ -1437,3 +1442,28 @@ distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
+
+
+The MIT License (MIT) - sentry-native
+=================================
+
+Copyright (c) 2019 Sentry (https://sentry.io) and individual contributors.
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

scripts/android/cmake.sh

@@ -145,6 +145,8 @@ if [[ "$RELEASE" ]]; then
     -DANDROID_SDK_ROOT=$ANDROID_SDK_ROOT \
     -DCMAKE_BUILD_TYPE=Release \
     -DADJUST_TOKEN=$ADJUST_SDK_TOKEN \
+    -DSENTRY_DSN=$SENTRY_DSN \
+    -DSENTRY_ENVELOPE_ENDPOINT=$SENTRY_ENVELOPE_ENDPOINT \
     -S . -B .tmp/
 else
   printn Y "Use debug config \n"
@@ -154,6 +156,8 @@ else
     -DANDROID_NDK_ROOT=$ANDROID_NDK_ROOT \
     -DANDROID_SDK_ROOT=$ANDROID_SDK_ROOT \
     -DCMAKE_BUILD_TYPE=Debug \
+    -DSENTRY_DSN=$SENTRY_DSN \
+    -DSENTRY_ENVELOPE_ENDPOINT=$SENTRY_ENVELOPE_ENDPOINT \
     -S . -B .tmp/
 
 fi

src/CMakeLists.txt

@@ -32,6 +32,7 @@ target_link_libraries(mozillavpn PUBLIC ${CMAKE_DL_LIBS})
 target_link_libraries(mozillavpn PRIVATE glean lottie nebula translations)
 
 include(cmake/sources.cmake)
+include(cmake/sentry.cmake)
 
 if(${BUILD_DUMMY})
     set(MVPN_PLATFORM_NAME "dummy")
@@ -61,4 +62,4 @@ if(NOT ${CMAKE_SYSTEM_NAME} STREQUAL "Emscripten")
     endif()
 endif()
 
-qt_finalize_target(mozillavpn)
+qt_finalize_target(mozillavpn)

src/cmake/sentry.cmake

@@ -0,0 +1,107 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+
+# This CMAKE File will Integrate Sentry into MVPN
+
+
+# Defines which OS builds can include sentry. Check src/cmake Lists for all values of MVPN_PLATFORM_NAME
+set(SENTRY_SUPPORTED_OS  "Windows" "Darwin" "Android")
+set(EXTERNAL_INSTALL_LOCATION ${CMAKE_BINARY_DIR}/external)
+include(ExternalProject)
+
+
+
+LIST(FIND SENTRY_SUPPORTED_OS ${CMAKE_SYSTEM_NAME} _SUPPORTED)
+
+if(NOT SENTRY_DSN OR NOT SENTRY_ENVELOPE_ENDPOINT)
+message( "Disabling Sentry, as params are not given")
+set( _SUPPORTED -1)
+endif()
+
+
+
+## Remove support for android 32bit. 
+## It's  currently broken. see: VPN-3332
+if( CMAKE_ANDROID_ARCH STREQUAL "x86" )
+    set( _SUPPORTED -1)
+elseif( CMAKE_ANDROID_ARCH STREQUAL "arm" )
+    set( _SUPPORTED -1)
+endif()
+
+if( ${_SUPPORTED} GREATER -1 )
+    message("Building sentry for ${CMAKE_SYSTEM_NAME}")
+    target_compile_definitions(mozillavpn PRIVATE SENTRY_ENVELOPE_ENDPOINT="${SENTRY_ENVELOPE_ENDPOINT}")
+    target_compile_definitions(mozillavpn PRIVATE SENTRY_DSN="${SENTRY_DSN}")
+    target_compile_definitions(mozillavpn PRIVATE SENTRY_ENABLED)
+    # Sentry support is given
+    target_sources(mozillavpn PRIVATE
+        sentry/sentryadapter.cpp
+        sentry/sentryadapter.h     
+    )
+
+    # Configure Linking and Compile
+    if(APPLE)
+        include(cmake/osxtools.cmake)
+        # Let sentry.h know we are using a static build
+        target_compile_definitions(mozillavpn PRIVATE SENTRY_BUILD_STATIC)
+        # Let mozilla-vpn know we need to provide the upload client
+        target_compile_definitions(mozillavpn PRIVATE SENTRY_NONE_TRANSPORT)
+        # Compile Static for apple and link to libsentry.a
+        target_link_libraries(mozillavpn PUBLIC libsentry.a)
+        target_link_libraries(mozillavpn PUBLIC breakpad_client.a)
+        # We are using breakpad as a backend - in process stackwalking is never the best option ... however!
+        # this is super easy to link against and we do not need another binary shipped with the client.
+        SET(SENTRY_ARGS -DSENTRY_BACKEND=breakpad -DSENTRY_BUILD_SHARED_LIBS=false -DSENTRY_TRANSPORT=none -DSENTRY_BUILD_TESTS=off -DSENTRY_BUILD_EXAMPLES=off)
+    endif()
+    if(WIN32)
+        # Let sentry.h know we are using a static build
+        target_compile_definitions(mozillavpn PRIVATE SENTRY_BUILD_STATIC)
+        # Link against static sentry + breakpad + the stack unwind utils
+        target_link_libraries(mozillavpn PUBLIC sentry.lib)
+        target_link_libraries(mozillavpn PUBLIC breakpad_client.lib)
+        target_link_libraries(mozillavpn PUBLIC dbghelp.lib)
+        # Windows will use the winhttp transport btw
+        SET(SENTRY_ARGS -DSENTRY_BUILD_SHARED_LIBS=false -DSENTRY_BACKEND=breakpad -DCMAKE_BUILD_TYPE=Release)
+    endif()
+
+    if(ANDROID)
+        # Let mozilla-vpn know we need to provide the upload client
+        target_compile_definitions(mozillavpn PRIVATE SENTRY_NONE_TRANSPORT)
+
+        target_link_libraries(mozillavpn PUBLIC libsentry.a)
+        target_link_libraries(mozillavpn PUBLIC libunwindstack.a)
+        # We can only use inproc as crash backend.
+        SET(SENTRY_ARGS -DSENTRY_BUILD_SHARED_LIBS=false 
+                        -DANDROID_PLATFORM=21 
+                        -DCMAKE_SYSTEM_NAME=Android 
+                        -DANDROID_ABI=${ANDROID_ABI} 
+                        -DCMAKE_ANDROID_NDK=${ANDROID_NDK_ROOT} 
+                        -DCMAKE_TOOLCHAIN_FILE=${ANDROID_NDK_ROOT}/build/cmake/android.toolchain.cmake  
+                        -DSENTRY_BACKEND=inproc
+            )
+    endif()
+
+    include(ExternalProject)
+    ExternalProject_Add(sentry
+        SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}../../3rdparty/sentry
+        GIT_REPOSITORY https://github.com/getsentry/sentry-native/
+        GIT_TAG 0.5.0
+        CMAKE_ARGS -DCMAKE_INSTALL_PREFIX=${EXTERNAL_INSTALL_LOCATION} ${SENTRY_ARGS}
+    )
+
+    target_include_directories(mozillavpn PUBLIC ${EXTERNAL_INSTALL_LOCATION}/include)
+    target_link_directories( mozillavpn PUBLIC ${EXTERNAL_INSTALL_LOCATION}/lib)
+    add_dependencies(mozillavpn sentry)
+else()
+    # Sentry is not supported on this Plattform.
+    message("Sentry supported OS -> ${SENTRY_SUPPORTED_OS}")
+    message("Cannot build sentry for ${CMAKE_SYSTEM_NAME}")
+endif()
+
+# Add Sources that will be required anyway
+target_sources(mozillavpn PRIVATE
+    tasks/sentry/tasksentry.cpp
+    tasks/sentry/tasksentry.h
+)

src/commands/commandui.cpp

@@ -65,7 +65,6 @@
 #endif
 
 #ifdef MVPN_WINDOWS
-#  include "crashreporter/crashclient.h"
 #  include "eventlistener.h"
 #  include "platforms/windows/windowsstartatbootwatcher.h"
 #  include "platforms/windows/windowsappimageprovider.h"
@@ -179,9 +178,6 @@ int CommandUI::run(QStringList& tokens) {
       std::cerr.clear();
     }
 #  endif
-
-    CrashClient::instance().start(CommandLineParser::argc(),
-                                  CommandLineParser::argv());
 #endif
 
 #ifdef MVPN_DEBUG

src/constants.h

@@ -85,6 +85,14 @@ CONSTEXPR(uint32_t, controllerPeriodicStateRecorderMsec, 10800000, 60000, 0)
 #define PRODBETAEXPR(type, functionName, prod, beta) \
   inline type functionName() { return inProduction() ? prod : beta; }
 
+#ifdef SENTRY_ENABLED
+constexpr const char* SENTRY_DSN_ENDPOINT = SENTRY_DSN;
+constexpr const char* SENTRY_ENVELOPE_INGESTION = SENTRY_ENVELOPE_ENDPOINT;
+#else
+constexpr const char* SENTRY_DSN_ENDPOINT = "";
+constexpr const char* SENTRY_ENVELOPE_INGESTION = "";
+#endif
+
 constexpr const char* API_PRODUCTION_URL = "https://vpn.mozilla.org";
 constexpr const char* API_STAGING_URL =
     "https://stage-vpn.guardian.nonprod.cloudops.mozgcp.net";

src/featureslist.h

@@ -240,3 +240,11 @@ FEATURE_SIMPLE(gleanRust,             // Feature ID
                FeatureCallback_true,  // Can be flipped off
                QStringList(),         // feature dependencies
                FeatureCallback_false)
+
+FEATURE_SIMPLE(sentry,                     // Feature ID
+               "Sentry Crash Report SDK",  // Feature name
+               "2.12.0",                   // released
+               FeatureCallback_true,       // Can be flipped on
+               FeatureCallback_true,       // Can be flipped off
+               QStringList(),              // feature dependencies
+               FeatureCallback_inStaging)