Merge pull request #987 from Geode-solutions/fix/stack-trace

fix(Exception): add stack trace at exception construction

Author: MelchiorSchuh

bindings/python/requirements.txt

@@ -2,5 +2,5 @@
 # This file is autogenerated by pip-compile with Python 3.10
 # by the following command:
 #
-#    pip-compile bindings/python/requirements.in
+#    pip-compile --pre bindings/python/requirements.in
 #

bindings/python/src/model/mixin/core/vertex_identifier.cpp

@@ -33,9 +33,7 @@ namespace geode
             .def( pybind11::init<>() )
             .def( "nb_unique_vertices", &VertexIdentifier::nb_unique_vertices )
             .def( "component_mesh_vertices",
-                static_cast< const std::vector< ComponentMeshVertex >& (
-                    VertexIdentifier::*) ( index_t ) const >(
-                    &VertexIdentifier::component_mesh_vertices ) )
+                &VertexIdentifier::component_mesh_vertices )
             .def( "unique_vertex", &VertexIdentifier::unique_vertex );
 
         pybind11::class_< ComponentMeshVertex >( module, "ComponentMeshVertex" )

include/geode/basic/assert.hpp

@@ -23,11 +23,14 @@
 
 #pragma once
 
+#include <array>
 #include <sstream>
 #include <stdexcept>
 #include <string>
 
 #include <absl/base/optimization.h>
+#include <absl/debugging/stacktrace.h>
+#include <absl/debugging/symbolize.h>
 #include <absl/strings/str_cat.h>
 
 #include <geode/basic/opengeode_basic_export.hpp>
@@ -49,13 +52,44 @@ namespace geode
      */
     class OpenGeodeException : public std::runtime_error
     {
+        static constexpr int MAX_STACK_DEPTH = 10;
+        static constexpr int NB_SKIPPED_STACKS = 1;
+        static constexpr int SYMBOL_SIZE = 1024;
+
     public:
         template < typename... Args >
         explicit OpenGeodeException( const Args&... message )
-            : std::runtime_error{ absl::StrCat( message... ) }
+            : std::runtime_error{ absl::StrCat( message... ) },
+              stack_size_{ absl::GetStackTrace(
+                  stack_.data(), MAX_STACK_DEPTH, NB_SKIPPED_STACKS ) }
+        {
+        }
+
+        ~OpenGeodeException() noexcept override = default;
+
+        std::string stack_trace() const
         {
+            std::string stack_string;
+            for( auto frame = 0; frame < stack_size_; ++frame )
+            {
+                absl::StrAppend( &stack_string, "  ", frame, ": " );
+                if( std::array< char, SYMBOL_SIZE > symbol; absl::Symbolize(
+                        stack_[frame], symbol.data(), sizeof( symbol ) ) )
+                {
+                    absl::StrAppend( &stack_string, symbol.data() );
+                }
+                else
+                {
+                    absl::StrAppend( &stack_string, "Unknown" );
+                }
+                absl::StrAppend( &stack_string, "\n" );
+            }
+            return stack_string;
         }
-        virtual ~OpenGeodeException() noexcept {}
+
+    private:
+        std::array< void*, MAX_STACK_DEPTH > stack_;
+        int stack_size_;
     };
 
     void opengeode_basic_api geode_assertion_failed( std::string_view condition,

src/geode/basic/CMakeLists.txt

@@ -97,6 +97,8 @@ add_geode_library(
     PUBLIC_DEPENDENCIES
         absl::flat_hash_map
         absl::strings
+        absl::stacktrace
+        absl::symbolize
         Bitsery::bitsery
     PRIVATE_DEPENDENCIES
         Async++

src/geode/basic/assert.cpp

@@ -48,7 +48,8 @@ namespace geode
         }
         catch( const OpenGeodeException& e )
         {
-            Logger::critical( "OpenGeodeException: ", e.what() );
+            Logger::critical(
+                "OpenGeodeException: ", e.what(), "\n", e.stack_trace() );
         }
         catch( const std::exception& e )
         {