feat(STAFF-121291): Edits to be compatible with Windows

.clang-format

@@ -4,4 +4,4 @@ IndentPPDirectives: AfterHash
 ColumnLimit: 80
 AlwaysBreakAfterDefinitionReturnType: All
 PointerAlignment: Right
-ForEachMacros: ['SENTRY_WITH_SCOPE', 'SENTRY_WITH_SCOPE_MUT', 'SENTRY_WITH_SCOPE_MUT_NO_FLUSH', 'SENTRY_WITH_OPTIONS']
+ForEachMacros: ['SENTRY_WITH_SCOPE', 'SENTRY_WITH_SCOPE_MUT', 'SENTRY_WITH_SCOPE_MUT_NO_FLUSH', 'SENTRY_WITH_OPTIONS', 'SENTRY_WITH_OPTIONS_MUT']

.craft.yml

@@ -1,29 +1,18 @@
-minVersion: "0.15.0"
-github:
-  owner: getsentry
-  repo: sentry-native
+minVersion: 0.23.1
 changelogPolicy: auto
-
-statusProvider:
-  name: github
-artifactProvider:
-  name: github
-
 targets:
   - name: github
   - name: registry
-    type: sdk
-    config:
-      canonical: "github:getsentry/sentry-native"
+    sdks:
+      github:getsentry/sentry-native:
   - name: gcs
     bucket: sentry-sdk-assets
     paths:
       - path: /sentry-native/{{version}}/
         metadata:
-          cacheControl: "public, max-age=2592000"
+          cacheControl: public, max-age=2592000
       - path: /sentry-native/latest/
         metadata:
-          cacheControl: "public, max-age=600"
-
+          cacheControl: public, max-age=600
 requireNames:
   - /^sentry-native.zip$/

.github/workflows/ci.yml

@@ -120,7 +120,7 @@ jobs:
         if: ${{ runner.os == 'macOS' }}
         uses: maxim-lobanov/setup-xcode@v1
         with:
-          xcode-version: '11.3.1'
+          xcode-version: '13.0.0'
 
       - name: Building (macOS)
         if: ${{ runner.os == 'macOS' }}

CHANGELOG.md

@@ -1,5 +1,98 @@
 # Changelog
 
+## 0.4.12
+
+**Features**:
+
+- Make the shutdown timeout configurable via `sentry_options_set_shutdown_timeout`.
+
+**Fixes**:
+
+- The crashpad backend compiles with mingw again.
+- Build System improvements.
+
+**Thank you**:
+
+Features, fixes and improvements in this release have been contributed by:
+
+- [@irov](https://github.com/irov)
+- [@past-due](https://github.com/past-due)
+- [@andrei-mu](https://github.com/andrei-mu)
+- [@rpadaki](https://github.com/rpadaki)
+
+## 0.4.11
+
+**Fixes**:
+
+- The crashpad backend now respects the `max_breadcrumbs` setting.
+- Hanging HTTP requests will now be canceled on shutdown in the WinHTTP transport.
+- The Modulefinder and Android unwinder now use safer memory access.
+- Possible races and deadlocks have been fixed in `init`/`close`, and in API related to sessions.
+
+**Thank you**:
+
+Features, fixes and improvements in this release have been contributed by:
+
+- [@smibe](https://github.com/smibe)
+
+## 0.4.10
+
+**Fixes**:
+
+- Fix a potential deadlock in macOS modulefinder.
+- Lower Stack usage, to lower change of stack overflows.
+- Avoid a double-free when parsing an invalid DSN.
+- Improvements to Unity Builds and 32-bit Builds.
+- Fix infinite recursion in signal handler by correctly cleaning up on shutdown.
+
+**Internal**:
+
+- Update Crashpad and Breakpad submodules to 2021-06-14.
+
+**Thank you**:
+
+Features, fixes and improvements in this release have been contributed by:
+
+- [@janisozaur](https://github.com/janisozaur)
+- [@bschatt](https://github.com/bschatt)
+- [@GenuineAster](https://github.com/GenuineAster)
+
+## 0.4.9
+
+**Features**:
+
+- Rewrote the Linux modulefinder which should now work correctly when encountering gaps in the memory mapping of loaded libraries, and supports libraries loaded from a file offset, such as libraries loaded directly from `.apk` files on Android.
+- Invoke the `before_send` hook at time of a hard crash when using the Windows or Linux Crashpad backend.
+- Added the following new convenience functions:
+  - `sentry_value_new_exception`
+  - `sentry_value_new_thread`
+  - `sentry_value_new_stacktrace`
+  - `sentry_event_add_exception`
+  - `sentry_event_add_thread`
+  - The `sentry_event_value_add_stacktrace` is deprecated.
+- Renamed `sentry_shutdown` to `sentry_close`, though the old function is still available.
+- Updated Qt integration to Qt 6.
+
+**Fixes**:
+
+- Optimized and fixed bugs in the JSON parser/serializer.
+- Build fixes for PPC and universal macOS.
+- Fixes to build using musl libc.
+- Correctness fixes around printf and strftime usage.
+- Allow building and running on older macOS versions.
+
+**Internal**:
+
+- Update Crashpad and Breakpad submodules to 2021-04-12
+
+**Thank you**:
+
+Features, fixes and improvements in this release have been contributed by:
+
+- [@mastertheknife](https://github.com/mastertheknife)
+- [@torarnv](https://github.com/torarnv)
+- [@encounter](https://github.com/encounter)
+
 ## 0.4.8
 
 **Features**:

CMakeLists.txt

@@ -39,7 +39,7 @@ if(NOT CMAKE_C_STANDARD)
 endif()
 
 if(NOT CMAKE_CXX_STANDARD)
-  set(CMAKE_CXX_STANDARD 11)
+  set(CMAKE_CXX_STANDARD 14)
 endif()
 
 include(GNUInstallDirs)
@@ -79,6 +79,7 @@ if(LINUX)
 	if(SENTRY_BUILD_FORCE32)
 		set(CMAKE_C_FLAGS    "${CMAKE_C_FLAGS} -m32 -D_FILE_OFFSET_BITS=64 -D_LARGEFILE64_SOURCE")
 		set(CMAKE_CXX_FLAGS  "${CMAKE_CXX_FLAGS} -m32 -D_FILE_OFFSET_BITS=64 -D_LARGEFILE64_SOURCE")
+		set(CMAKE_ASM_FLAGS  "${CMAKE_ASM_FLAGS} -m32 -D_FILE_OFFSET_BITS=64 -D_LARGEFILE64_SOURCE")
 		set_property(GLOBAL PROPERTY FIND_LIBRARY_USE_LIB64_PATHS OFF)
 	endif()
 endif()
@@ -258,15 +259,17 @@ target_compile_definitions(sentry PRIVATE SIZEOF_LONG=${CMAKE_SIZEOF_LONG})
 
 if(SENTRY_TRANSPORT_CURL)
 	find_package(CURL REQUIRED)
-	target_include_directories(sentry PRIVATE ${CURL_INCLUDE_DIR})
-	# The exported sentry target must not contain any path of the build machine, therefore use generator expressions
-	# FIXME: cmake 3.12 introduced the target CURL::libcurl
-	string(REPLACE ";" "$<SEMICOLON>" GENEX_CURL_LIBRARIES "${CURL_LIBRARIES}")
-	string(REPLACE ";" "$<SEMICOLON>" GENEX_CURL_COMPILE_DEFINITIONS "${CURL_COMPILE_DEFINITIONS}")
-	target_link_libraries(sentry PRIVATE $<BUILD_INTERFACE:${GENEX_CURL_LIBRARIES}>)
-	target_compile_definitions(sentry PRIVATE $<BUILD_INTERFACE:${GENEX_CURL_COMPILE_DEFINITIONS}>)
-elseif(SENTRY_TRANSPORT_WINHTTP)
-	target_link_libraries(sentry PRIVATE winhttp)
+	if(TARGET CURL::libcurl) # Only available in cmake 3.12+
+		target_link_libraries(sentry PRIVATE CURL::libcurl)
+	else()
+		# Needed for cmake < 3.12 support (cmake 3.12 introduced the target CURL::libcurl)
+		target_include_directories(sentry PRIVATE ${CURL_INCLUDE_DIR})
+		# The exported sentry target must not contain any path of the build machine, therefore use generator expressions
+		string(REPLACE ";" "$<SEMICOLON>" GENEX_CURL_LIBRARIES "${CURL_LIBRARIES}")
+		string(REPLACE ";" "$<SEMICOLON>" GENEX_CURL_COMPILE_DEFINITIONS "${CURL_COMPILE_DEFINITIONS}")
+		target_link_libraries(sentry PRIVATE $<BUILD_INTERFACE:${GENEX_CURL_LIBRARIES}>)
+		target_compile_definitions(sentry PRIVATE $<BUILD_INTERFACE:${GENEX_CURL_COMPILE_DEFINITIONS}>)
+	endif()
 endif()
 
 set_property(TARGET sentry PROPERTY C_VISIBILITY_PRESET hidden)
@@ -345,7 +348,6 @@ if(WIN32)
 		target_compile_definitions(sentry PRIVATE "_WIN32_WINNT=0x0501")
 	endif()
 
-	target_link_libraries(sentry PRIVATE shlwapi)
 	# crashpad does not support Windows XP toolset
 	if(MSVC AND CMAKE_GENERATOR_TOOLSET MATCHES "_xp$" AND SENTRY_BACKEND_CRASHPAD)
 		message(FATAL_ERROR "MSVC XP toolset does not support Crashpad")
@@ -358,7 +360,11 @@ if(ANDROID)
 elseif(LINUX)
     set(_SENTRY_PLATFORM_LIBS "dl" "rt")
 elseif(WIN32)
-    set(_SENTRY_PLATFORM_LIBS "dbghelp" "version")
+    set(_SENTRY_PLATFORM_LIBS "dbghelp" "shlwapi" "version")
+endif()
+
+if(SENTRY_TRANSPORT_WINHTTP)
+	list(APPEND _SENTRY_PLATFORM_LIBS "winhttp")
 endif()
 
 # handle platform threads library
@@ -413,7 +419,7 @@ if(SENTRY_BACKEND_CRASHPAD)
 		endif()
 		add_subdirectory(external/crashpad crashpad_build)
 
-		# set static runime if enabled
+		# set static runtime if enabled
 		if(SENTRY_BUILD_RUNTIMESTATIC AND MSVC)
 			set_property(TARGET crashpad_client PROPERTY MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
 			set_property(TARGET crashpad_compat PROPERTY MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
@@ -469,8 +475,17 @@ endif()
 
 option(SENTRY_INTEGRATION_QT "Build Qt integration")
 if(SENTRY_INTEGRATION_QT)
-	find_package(Qt5 COMPONENTS Core REQUIRED)
-	target_link_libraries(sentry PRIVATE Qt5::Core)
+	if(QT_DEFAULT_MAJOR_VERSION)
+		# Let user choose major version
+		set(Qt_VERSION_MAJOR ${QT_DEFAULT_MAJOR_VERSION})
+	else()
+		# Find best match, prioritizing Qt 6 if available
+		find_package(Qt NAMES Qt6 Qt5 COMPONENTS Core REQUIRED)
+	endif()
+	find_package(Qt${Qt_VERSION_MAJOR} COMPONENTS Core REQUIRED)
+	message(STATUS "Found Qt: ${Qt${Qt_VERSION_MAJOR}_DIR} "
+		"(found version \"${Qt${Qt_VERSION_MAJOR}_VERSION}\")")
+	target_link_libraries(sentry PRIVATE Qt${Qt_VERSION_MAJOR}::Core)
 endif()
 
 include(CMakePackageConfigHelpers)

Makefile

@@ -1,7 +1,7 @@
 all: test
 
 update-test-discovery:
-	@perl -ne 'print if s/SENTRY_TEST\(([^)]+)\)/XX(\1)/' tests/unit/*.c | sort | uniq > tests/unit/tests.inc
+	@perl -ne 'print if s/SENTRY_TEST\(([^)]+)\)/XX(\1)/' tests/unit/*.c | sort | grep -v define | uniq > tests/unit/tests.inc
 .PHONY: update-test-discovery
 
 build/Makefile: CMakeLists.txt
@@ -55,8 +55,7 @@ setup-venv: .venv/bin/python
 
 .venv/bin/python: Makefile tests/requirements.txt
 	@rm -rf .venv
-	@which virtualenv || sudo pip install virtualenv
-	virtualenv -p python3 .venv
+	python3 -m venv .venv
 	.venv/bin/pip install --upgrade --requirement tests/requirements.txt
 
 format: setup-venv

README.md

@@ -92,7 +92,6 @@ The SDK supports different features on the target platform:
   have the `curl` library available. On other platforms, library users need to
   implement their own transport, based on the `function transport` API.
 - **Crashpad Backend** is currently only supported on Linux, Windows and macOS.
-- **Breakpad Backend** is currently only supported on Linux and Windows.
 
 ## Building and Installation
 
@@ -195,6 +194,8 @@ using `cmake -D BUILD_SHARED_LIBS=OFF ..`.
   `OFF` will build `sentry` as a static library instead.
   If sentry is used as a subdirectory of another project, the value `BUILD_SHARED_LIBS` will be inherited by default.
 
+  When using `sentry` as a static library, make sure to `#define SENTRY_BUILD_STATIC 1` before including the sentry header.
+
 - `SENTRY_PIC` (Default: ON):
   By default, `sentry` is built as a position independent library.
 
@@ -299,7 +300,7 @@ sentry_init(options);
 
 // your application code …
 
-sentry_shutdown();
+sentry_close();
 ```
 
 Other important configuration options include:
@@ -311,7 +312,7 @@ Other important configuration options include:
 
 ## Known Limitations
 
-- The crashpad backend currently has no support for notifying the crashing
+- The crashpad backend on macOS currently has no support for notifying the crashing
   process, and can thus not properly terminate sessions or call the registered
   `before_send` hook. It will also lose any events that have been queued for
   sending at time of crash.

examples/example.c

@@ -9,11 +9,16 @@
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#ifdef NDEBUG
+#    undef NDEBUG
+#endif
+#include <assert.h>
 
 #ifdef SENTRY_PLATFORM_WINDOWS
 #    include <synchapi.h>
 #    define sleep_s(SECONDS) Sleep((SECONDS)*1000)
 #else
+#    include <signal.h>
 #    include <unistd.h>
 #    define sleep_s(SECONDS) sleep(SECONDS)
 #endif
@@ -149,13 +154,31 @@ main(int argc, char **argv)
         }
     }
 
+    if (has_arg(argc, argv, "reinstall")) {
+        sentry_reinstall_backend();
+    }
+
     if (has_arg(argc, argv, "sleep")) {
         sleep_s(10);
     }
 
     if (has_arg(argc, argv, "crash")) {
         trigger_crash();
     }
+    if (has_arg(argc, argv, "assert")) {
+        assert(0);
+    }
+    if (has_arg(argc, argv, "abort")) {
+        abort();
+    }
+#ifdef SENTRY_PLATFORM_UNIX
+    if (has_arg(argc, argv, "raise")) {
+        raise(SIGSEGV);
+    }
+    if (has_arg(argc, argv, "kill")) {
+        kill(getpid(), SIGSEGV);
+    }
+#endif
 
     if (has_arg(argc, argv, "capture-event")) {
         sentry_value_t event = sentry_value_new_message_event(
@@ -166,27 +189,21 @@ main(int argc, char **argv)
         sentry_capture_event(event);
     }
     if (has_arg(argc, argv, "capture-exception")) {
-        // TODO: Create a convenience API to create a new exception object,
-        // and to attach a stacktrace to the exception.
-        // See also https://github.com/getsentry/sentry-native/issues/235
+        sentry_value_t exc = sentry_value_new_exception(
+            "ParseIntError", "invalid digit found in string");
+        if (has_arg(argc, argv, "add-stacktrace")) {
+            sentry_value_t stacktrace = sentry_value_new_stacktrace(NULL, 0);
+            sentry_value_set_by_key(exc, "stacktrace", stacktrace);
+        }
         sentry_value_t event = sentry_value_new_event();
-        sentry_value_t exception = sentry_value_new_object();
-        // for example:
-        sentry_value_set_by_key(
-            exception, "type", sentry_value_new_string("ParseIntError"));
-        sentry_value_set_by_key(exception, "value",
-            sentry_value_new_string("invalid digit found in string"));
-        sentry_value_t exceptions = sentry_value_new_list();
-        sentry_value_append(exceptions, exception);
-        sentry_value_t values = sentry_value_new_object();
-        sentry_value_set_by_key(values, "values", exceptions);
-        sentry_value_set_by_key(event, "exception", values);
+        sentry_event_add_exception(event, exc);
 
         sentry_capture_event(event);
     }
 
     // make sure everything flushes
-    sentry_shutdown();
+    sentry_close();
+
     if (has_arg(argc, argv, "sleep-after-shutdown")) {
         sleep_s(1);
     }