feat: Add command-line option to control developper information output in diagnostic messages

src/coreComponents/common/logger/ErrorHandling.cpp

@@ -18,6 +18,7 @@
  */
 
 #include "ErrorHandling.hpp"
+#include "LvArray/src/system.hpp"
 #include "common/DataTypes.hpp"
 #include "common/logger/Logger.hpp"
 #include "common/format/StringUtilities.hpp"
@@ -45,6 +46,11 @@ ErrorLogger g_errorLogger{};
 ErrorLogger & ErrorLogger::global()
 { return g_errorLogger; }
 
+ErrorLogger::ErrorLogger()
+{
+  setDiagnosticInfoLevel( DiagnosticInfoLevel::Basic );
+}
+
 std::string ErrorContext::attributeToString( ErrorContext::Attribute attribute )
 {
   switch( attribute )
@@ -277,7 +283,29 @@ void ErrorLogger::createFile()
   }
 }
 
-std::string ErrorLogger::toString( MsgType const type )
+void ErrorLogger::setDiagnosticInfoLevel( DiagnosticInfoLevel const level )
+{
+  switch( level )
+  {
+    case DiagnosticInfoLevel::Basic:
+      m_msgTypeSourceInfoEnabled.fill( false );
+      break;
+    case DiagnosticInfoLevel::ErrorSources:
+      m_msgTypeSourceInfoEnabled.fill( true );
+      m_msgTypeSourceInfoEnabled[integer( MsgType::Warning )] = false;
+      break;
+    case DiagnosticInfoLevel::WarningSources:
+      m_msgTypeSourceInfoEnabled.fill( true );
+      break;
+    default:
+      // if option has a wrong value, we output every details for any messages
+      m_msgTypeSourceInfoEnabled.fill( true );
+      break;
+  }
+}
+
+
+std::string ErrorLogger::typeToString( MsgType const type )
 {
   switch( type )
   {
@@ -289,12 +317,26 @@ std::string ErrorLogger::toString( MsgType const type )
   }
 }
 
-void ErrorLogger::formatMsgForLog( DiagnosticMsg const & errMsg, std::ostream & os )
+bool ErrorLogger::isSourceInfoEnabled( MsgType const type ) const
+{
+  switch( type )
+  {
+    case MsgType::Error: return m_msgTypeSourceInfoEnabled[integer( MsgType::Error )];
+    case MsgType::Warning: return m_msgTypeSourceInfoEnabled[integer( MsgType::Warning )];
+    case MsgType::Exception: return m_msgTypeSourceInfoEnabled[integer( MsgType::Exception )];
+    case MsgType::ExternalError: return m_msgTypeSourceInfoEnabled[integer( MsgType::ExternalError )];
+    default: return m_msgTypeSourceInfoEnabled[integer( MsgType::Undefined )];
+  }
+}
+
+void ErrorLogger::formatMsgForLog( DiagnosticMsg const & errMsg,
+                                   std::ostream & os,
+                                   bool enableSourceInfo )
 {
   static constexpr string_view PREFIX = "***** ";
   // --- HEADER ---
-  os << PREFIX << ErrorLogger::toString( errMsg.m_type ) << "\n";
-  if( !errMsg.m_file.empty())
+  os << PREFIX << typeToString( errMsg.m_type ) << "\n";
+  if( enableSourceInfo && !errMsg.m_file.empty() )
   {
     os << PREFIX<< "LOCATION: " << errMsg.m_file;
     if( errMsg.m_line > 0 )
@@ -332,7 +374,7 @@ void ErrorLogger::formatMsgForLog( DiagnosticMsg const & errMsg, std::ostream &
     }
   }
   // --- STACKTRACE ---
-  if( !errMsg.m_sourceCallStack.empty() )
+  if( enableSourceInfo && !errMsg.m_sourceCallStack.empty() )
   {
     os << "\n***** StackTrace of "<< errMsg.m_sourceCallStack.size() << " frames\n";
     for( size_t i = 0; i < errMsg.m_sourceCallStack.size(); i++ )
@@ -353,7 +395,9 @@ void ErrorLogger::formatMsgForLog( DiagnosticMsg const & errMsg, std::ostream &
 void ErrorLogger::writeToLogStream( DiagnosticMsg & errMsg )
 {
   std::lock_guard< std::mutex > guard( m_errorHandlerAsciiMutex );
-  formatMsgForLog( errMsg, m_stream );
+  formatMsgForLog( errMsg,
+                   m_stream,
+                   isSourceInfoEnabled( errMsg.m_type ) );
   m_stream.flush();
 }
 
@@ -364,7 +408,7 @@ void ErrorLogger::writeToYamlStream( DiagnosticMsg & errMsg )
   if( yamlFile.is_open() )
   {
     // General errors info (type, rank on which the error occured)
-    yamlFile << g_level1Start << "type: " << ErrorLogger::toString( errMsg.m_type ) << "\n";
+    yamlFile << g_level1Start << "type: " << typeToString( errMsg.m_type ) << "\n";
     yamlFile << g_level1Next << "rank: " << stringutilities::join( errMsg.m_ranksInfo, "," );
     yamlFile << "\n";
 

src/coreComponents/common/logger/ErrorHandling.hpp

@@ -23,6 +23,7 @@
 #include "common/DataTypes.hpp"
 #include "common/format/Format.hpp"
 #include "common/format/StringUtilities.hpp"
+
 #include <mutex>
 
 namespace geos
@@ -111,13 +112,28 @@ struct ErrorContext
  * @enum MsgType
  * Enum listing the different types of possible diagnostics
  */
-enum class MsgType
+enum class MsgType : integer
 {
+  Undefined,
   Error,
   ExternalError,
   Warning,
   Exception,
-  Undefined
+  Count // internal use, keep at last
+};
+
+/**
+ * @enum DiagnosticInfoLevel
+ * Enum listing the different types of possible diagnostic information levels
+ */
+enum class DiagnosticInfoLevel : integer
+{
+  /// basic information (default)
+  Basic = 0,
+  /// errors source-code information
+  ErrorSources= 1,
+  /// warnings & errors source-code information
+  WarningSources = 2,
 };
 
 /**
@@ -295,6 +311,8 @@ class ErrorLogger
    */
   GEOS_HOST static ErrorLogger & global();
 
+  ErrorLogger();
+
   /**
    * @brief Create the YAML file or overwrite the contents if a YAML file of the same name already exists
    * And write its header when the command line option is enabled
@@ -322,6 +340,14 @@ class ErrorLogger
   void setOutputFilename( std::string_view filename )
   { m_filename = filename; }
 
+  /**
+   * @brief Set the diagnostic messages information level. The higher, the more verbose and
+   *        developper-oriented the messages will be.
+   * @param level the desired information level. If level is not an DiagnosticInfoLevel enum label,
+   *              the behaviour of DiagnosticInfoLevel::Basic.
+   */
+  void setDiagnosticInfoLevel( DiagnosticInfoLevel level );
+
   /**
    * @return The file name of the output error file
    */
@@ -333,7 +359,13 @@ class ErrorLogger
    * @param type the message type label
    * @return the string representation of the message type
    */
-  static std::string toString( MsgType type );
+  static std::string typeToString( MsgType type );
+
+  /**
+   * @param type the message type label
+   * @return true if the message type source information output is enabled
+   */
+  bool isSourceInfoEnabled( MsgType type ) const;
 
   /**
    * @return Return the const general log stream
@@ -384,8 +416,11 @@ class ErrorLogger
    * @brief Format all information in ErrorMsg and write it to the specified output stream
    * @param errMsg The struct containing the error/warning object
    * @param os The output stream
+   * @param enableSourceInfo if true, information on source code is included in the message
    */
-  static void formatMsgForLog( DiagnosticMsg const & errMsg, std::ostream & os );
+  static void formatMsgForLog( DiagnosticMsg const & errMsg,
+                               std::ostream & os,
+                               bool enableSourceInfo );
 
   /**
    * @brief Write the ErrorMsg into the log stream output stream
@@ -407,6 +442,8 @@ class ErrorLogger
   std::mutex m_errorHandlerAsciiMutex;
   /// Avoid concurrent access between threads for yaml outputs
   std::mutex m_errorHandlerYamlMutex;
+  /// Indicated if the source file information output is enabled for a given message type
+  stdArray< bool, size_t( MsgType::Count ) > m_msgTypeSourceInfoEnabled;
 
   /**
    * @brief Write all the information retrieved about the error/warning message into the YAML stream

src/coreComponents/common/logger/GeosExceptions.cpp

@@ -25,12 +25,14 @@ namespace geos
 
 thread_local std::ostringstream Exception::m_formattingOSS;
 
-void Exception::prepareWhat( DiagnosticMsg & msg ) noexcept
+void Exception::prepareWhat( ErrorLogger const & logger, DiagnosticMsg & msg ) noexcept
 {
   m_formattingOSS.str( "" );
   m_formattingOSS.clear();
 
-  ErrorLogger::formatMsgForLog( msg, m_formattingOSS );
+  ErrorLogger::formatMsgForLog( msg,
+                                m_formattingOSS,
+                                logger.isSourceInfoEnabled( msg.m_type ) );
   m_cachedWhat = m_formattingOSS.bad() ? "Exception formatting error!" : m_formattingOSS.str();
 }
 

src/coreComponents/common/logger/GeosExceptions.hpp

@@ -50,9 +50,10 @@ struct Exception : public std::exception
 
   /**
    * @brief Prepare and cache the formatted exception message
+   * @param logger Logger instance that will keep track of the exception message (through `*CurrentExceptionMessage()` methods)
    * @param msg Error message logger for structured error reporting
    */
-  void prepareWhat( DiagnosticMsg & msg ) noexcept;
+  void prepareWhat( ErrorLogger const & logger, DiagnosticMsg & msg ) noexcept;
 
 private:
   /// Formatted exception message for what() method

src/coreComponents/common/logger/Logger.hpp

@@ -252,7 +252,7 @@
                                      .addContextInfo( GEOS_DETAIL_REST_ARGS( __VA_ARGS__ )) \
                                      .getDiagnosticMsg(); \
       auto ex = GEOS_DETAIL_FIRST_ARG( __VA_ARGS__ )(); \
-      ex.prepareWhat( exceptionMsg ); \
+      ex.prepareWhat( GEOS_GLOBAL_LOGGER, exceptionMsg ); \
       throw ex; \
     } \
   }while( false )

src/coreComponents/dataRepository/unitTests/testErrorHandling.cpp

@@ -56,6 +56,7 @@ DataFileContext const importantAdditionalContext = DataFileContext( "Important A
 void beginLocalLoggerTest( ErrorLogger & errorLogger, string_view filename )
 {
   errorLogger.enableFileOutput( true );
+  errorLogger.setDiagnosticInfoLevel( DiagnosticInfoLevel::WarningSources );
   errorLogger.setOutputFilename( filename );
   errorLogger.createFile();
 }
@@ -181,11 +182,7 @@ TEST( ErrorHandling, testYamlFileExceptionOutput )
   }
   catch( geos::DomainError const & ex )
   {
-    string const errorMsg = "Table input error.\n";
-    testErrorLogger.modifyCurrentExceptionMessage()
-      .addToMsg( errorMsg )
-      .addContextInfo( additionalContext.getContextInfo() )
-      .addContextInfo( importantAdditionalContext.getContextInfo().setPriority( 2 ) );
+    // Verify generated exception text (which could be output by the system in the worst case.
     string const whatExpected = GEOS_FMT( "***** Exception\n"
                                           "***** LOCATION: {}:{}\n"
                                           "***** Error cause: testValue == 5\n"
@@ -194,12 +191,17 @@ TEST( ErrorHandling, testYamlFileExceptionOutput )
                                           "Empty Group",
                                           testErrorLogger.getCurrentExceptionMsg().m_file, line1,
                                           testErrorLogger.getCurrentExceptionMsg().m_contextsInfo.front().m_formattedContext );
-    GEOS_ERROR_IF_EQ_MSG( string( ex.what()).find( whatExpected ), string::npos,
-                          GEOS_FMT( "The error message was not containing the expected sequence.\n"
-                                    "  Error message :\n{}"
-                                    "  expected sequence :\n{}",
-                                    ex.what(),
-                                    whatExpected ) );
+    EXPECT_TRUE( string( ex.what()).find( whatExpected ) != string::npos ) << GEOS_FMT( "The error message was not containing the expected sequence:\n"
+                                                                                        "  Error message :\n{}"
+                                                                                        "  expected sequence :\n{}",
+                                                                                        ex.what(),
+                                                                                        whatExpected );
+
+    // add more context for final exception output
+    testErrorLogger.modifyCurrentExceptionMessage()
+      .addToMsg( "Table input error.\n" )
+      .addContextInfo( additionalContext.getContextInfo() )
+      .addContextInfo( importantAdditionalContext.getContextInfo().setPriority( 2 ) );
   }
 
   testErrorLogger.flushCurrentExceptionMessage();
@@ -324,10 +326,9 @@ TEST( ErrorHandling, testLogFileExceptionOutput )
       additionalContext.toString(),
       testErrorLogger.getCurrentExceptionMsg().m_sourceCallStack );
     std::ostringstream oss;
-    ErrorLogger::formatMsgForLog( testErrorLogger.getCurrentExceptionMsg(), oss );
+    ErrorLogger::formatMsgForLog( testErrorLogger.getCurrentExceptionMsg(), oss, true );
     GEOS_ERROR_IF_EQ_MSG( oss.str().find( streamExpected ), string::npos,
-                          GEOS_FMT( "The error message was not containing the expected sequence.\n"
-                                    "The error message was not containing the expected sequence.\n"
+                          GEOS_FMT( "The error message was not containing the expected sequence:\n"
                                     "  Error message :\n{}"
                                     "  expected sequence :\n{}",
                                     oss.str(),
@@ -352,16 +353,15 @@ TEST( ErrorHandling, testStdException )
       .addCallStackInfo( LvArray::system::stackTrace( true ) );
 
     std::ostringstream oss;
-    ErrorLogger::formatMsgForLog( testErrorLogger.getCurrentExceptionMsg(), oss );
+    ErrorLogger::formatMsgForLog( testErrorLogger.getCurrentExceptionMsg(), oss, true );
     string const streamExpected = GEOS_FMT(
       "***** Exception\n"
       "***** Rank 0\n"
       "***** Message :\n"
       "{}\n",
       testErrorLogger.getCurrentExceptionMsg().m_msg );
     GEOS_ERROR_IF_EQ_MSG( oss.str().find( streamExpected ), string::npos,
-                          GEOS_FMT( "The error message was not containing the expected sequence.\n"
-                                    "The error message was not containing the expected sequence.\n"
+                          GEOS_FMT( "The error message was not containing the expected sequence:\n"
                                     "  Error message :\n{}"
                                     "  expected sequence :\n{}",
                                     oss.str(),

src/coreComponents/mainInterface/initialization.cpp

@@ -14,6 +14,7 @@
  */
 
 #include "initialization.hpp"
+#include "common/logger/ErrorHandling.hpp"
 #include "version.hpp"
 
 #include "common/DataTypes.hpp"
@@ -97,6 +98,7 @@ std::unique_ptr< CommandLineOptions > parseCommandLineOptions( int argc, char *
     ZPAR,
     SCHEMA,
     VALIDATE_INPUT,
+    DIAGNOSTIC_INFO_LEVEL,
     NONBLOCKING_MPI,
     SUPPRESS_PINNED,
     PROBLEMNAME,
@@ -121,6 +123,10 @@ std::unique_ptr< CommandLineOptions > parseCommandLineOptions( int argc, char *
     { ZPAR, 0, "z", "zpartitions", Arg::numeric, "\t-z, --z-partitions, \t Number of partitions in the z-direction" },
     { SCHEMA, 0, "s", "schema", Arg::nonEmpty, "\t-s, --schema, \t Name of the output schema" },
     { VALIDATE_INPUT, 0, "v", "validate-input", Arg::None, "\t-v, --validate-input, \t Only do the loading phase, and not actual simulation. Useful to validate 'input'." },
+    { DIAGNOSTIC_INFO_LEVEL, 0, "d", "diagnostic-info-level", Arg::numeric, "\t-d, --diagnostic-info-level, \t Diagnostic message information level:\n"
+                                                                            "\t                             \t   0 = basic information (default),\n"
+                                                                            "\t                             \t   1 = errors source-code information,\n"
+                                                                            "\t                             \t   2 = warnings & errors source-code information." },
     { NONBLOCKING_MPI, 0, "b", "use-nonblocking", Arg::None, "\t-b, --use-nonblocking, \t Use non-blocking MPI communication" },
     { PROBLEMNAME, 0, "n", "name", Arg::nonEmpty, "\t-n, --name, \t Name of the problem, used for output" },
     { SUPPRESS_PINNED, 0, "s", "suppress-pinned", Arg::None, "\t-s, --suppress-pinned, \t Suppress usage of pinned memory for MPI communication buffers" },
@@ -222,6 +228,12 @@ std::unique_ptr< CommandLineOptions > parseCommandLineOptions( int argc, char *
         commandLineOptions->onlyValidateInput = true;
       }
       break;
+      case DIAGNOSTIC_INFO_LEVEL:
+      {
+        DiagnosticInfoLevel infoLevel = DiagnosticInfoLevel( std::stoi( opt.arg ) );
+        ErrorLogger::global().setDiagnosticInfoLevel( infoLevel );
+      }
+      break;
       case PROBLEMNAME:
       {
         commandLineOptions->problemName = opt.arg;