From a08ee8a3fef6861b2c088f2a587a50c6abe27e7f Mon Sep 17 00:00:00 2001
From: "Zhang, Chaojun" <chaojun.zhang@intel.com>
Date: Sat, 25 Feb 2023 15:25:01 +0800
Subject: [PATCH] fix(Exception): Substrait exceptions should note the code
 location of the caller

---
 include/substrait/common/Exceptions.h | 30 ++++++++++++++++++++-------
 src/substrait/common/Exceptions.cpp   | 13 +++++++-----
 2 files changed, 30 insertions(+), 13 deletions(-)

diff --git a/include/substrait/common/Exceptions.h b/include/substrait/common/Exceptions.h
index 23b97f1f..d05b92f4 100644
--- a/include/substrait/common/Exceptions.h
+++ b/include/substrait/common/Exceptions.h
@@ -2,9 +2,9 @@
 
 #pragma once
 
-#include <fmt/format.h>
 #include <memory>
 #include <utility>
+#include <fmt/format.h>
 
 namespace io::substrait::common {
 namespace error_code {
@@ -39,12 +39,14 @@ class SubstraitException : public std::exception {
     // objects.
     kUser = 0,
 
-    // Errors where the root cause of the problem is some unreliable aspect of the
-    // system are classified with SYSTEM.
+    // Errors where the root cause of the problem is some unreliable aspect of
+    // the system are classified with SYSTEM.
     kSystem = 1
   };
-
   SubstraitException(
+      const char* file,
+      size_t line,
+      const char* function,
       const std::string& exceptionCode,
       const std::string& exceptionMessage,
       Type exceptionType = Type::kSystem,
@@ -62,10 +64,16 @@ class SubstraitException : public std::exception {
 class SubstraitUserError : public SubstraitException {
  public:
   SubstraitUserError(
+      const char* file,
+      size_t line,
+      const char* function,
       const std::string& exceptionCode,
       const std::string& exceptionMessage,
       const std::string& exceptionName = "SubstraitUserError")
       : SubstraitException(
+            file,
+            line,
+            function,
             exceptionCode,
             exceptionMessage,
             Type::kUser,
@@ -75,10 +83,16 @@ class SubstraitUserError : public SubstraitException {
 class SubstraitRuntimeError final : public SubstraitException {
  public:
   SubstraitRuntimeError(
+      const char* file,
+      size_t line,
+      const char* function,
       const std::string& exceptionCode,
       const std::string& exceptionMessage,
       const std::string& exceptionName = "SubstraitRuntimeError")
       : SubstraitException(
+            file,
+            line,
+            function,
             exceptionCode,
             exceptionMessage,
             Type::kSystem,
@@ -90,10 +104,10 @@ std::string errorMessage(fmt::string_view fmt, const Args&... args) {
   return fmt::vformat(fmt, fmt::make_format_args(args...));
 }
 
-#define SUBSTRAIT_THROW(exception, errorCode, ...)                     \
-  {                                                                    \
-    auto message = ::io::substrait::common::errorMessage(__VA_ARGS__); \
-    throw exception(errorCode, message);                               \
+#define SUBSTRAIT_THROW(exception, errorCode, ...)                         \
+  {                                                                        \
+    auto message = ::io::substrait::common::errorMessage(__VA_ARGS__);     \
+    throw exception(__FILE__, __LINE__, __FUNCTION__, errorCode, message); \
   }
 
 #define SUBSTRAIT_UNSUPPORTED(...)                       \
diff --git a/src/substrait/common/Exceptions.cpp b/src/substrait/common/Exceptions.cpp
index 15537cf4..6c86f788 100644
--- a/src/substrait/common/Exceptions.cpp
+++ b/src/substrait/common/Exceptions.cpp
@@ -6,19 +6,22 @@
 namespace io::substrait::common {
 
 SubstraitException::SubstraitException(
+    const char* file,
+    size_t line,
+    const char* function,
     const std::string& exceptionCode,
     const std::string& exceptionMessage,
     Type exceptionType,
     const std::string& exceptionName)
     : msg_(fmt::format(
-          "Exception: {}\nError Code: {}\nType: {}\nReason: {}\n"
-          "Function: {}\nFile: {}\n:Line: {}\n",
+          "Exception: {}\nError Code: {}\nError Type: {}\nReason: {}\n"
+          "Function: {}\nLocation: {}(Line:{})\n",
           exceptionName,
           exceptionCode,
           exceptionType == Type::kSystem ? "system" : "user",
           exceptionMessage,
-          __FUNCTION__,
-          __FILE__,
-          std::to_string(__LINE__))) {}
+          function,
+          file,
+          std::to_string(line))) {}
 
 } // namespace io::substrait::common