Merge pull request #8905 from hercules-ci/no-unknown-location

Don't print unknown locations unless requested for dev purposes

(cherry picked from commit 3dd4475826dff8052fef42d4600b61e6b91950ac)
Change-Id: I04a91277d1d9d09f5c1bf4a28fc99f0702b161e5

2 files changed, 39 insertions, 23 deletions

diff --git a/src/libutil/error.cc b/src/libutil/error.cc
index 4a1b346ef..dd9612471 100644
--- a/src/libutil/error.cc
+++ b/src/libutil/error.cc
@@ -155,6 +155,36 @@ static std::string indent(std::string_view indentFirst, std::string_view indentR
     return res;
 }
 
+/**
+ * A development aid for finding missing positions, to improve error messages. Example use:
+ *
+ *     NIX_DEVELOPER_SHOW_UNKNOWN_LOCATIONS=1 _NIX_TEST_ACCEPT=1 make tests/lang.sh.test
+ *     git diff -U20 tests
+ *
+ */
+static bool printUnknownLocations = getEnv("_NIX_DEVELOPER_SHOW_UNKNOWN_LOCATIONS").has_value();
+
+/**
+ * Print a position, if it is known.
+ *
+ * @return true if a position was printed.
+ */
+static bool printPosMaybe(std::ostream & oss, std::string_view indent, const std::shared_ptr<AbstractPos> & pos) {
+    bool hasPos = pos && *pos;
+    if (hasPos) {
+        oss << "\n" << indent << ANSI_BLUE << "at " ANSI_WARNING << *pos << ANSI_NORMAL << ":";
+
+        if (auto loc = pos->getCodeLines()) {
+            oss << "\n";
+            printCodeLines(oss, "", *pos, *loc);
+            oss << "\n";
+        }
+    } else if (printUnknownLocations) {
+        oss << "\n" << indent << ANSI_BLUE << "at " ANSI_RED << "UNKNOWN LOCATION" << ANSI_NORMAL << "\n";
+    }
+    return hasPos;
+}
+
 std::ostream & showErrorInfo(std::ostream & out, const ErrorInfo & einfo, bool showTrace)
 {
     std::string prefix;
@@ -203,8 +233,6 @@ std::ostream & showErrorInfo(std::ostream & out, const ErrorInfo & einfo, bool s
 
     std::ostringstream oss;
 
-    auto noSource = ANSI_ITALIC " (source not available)" ANSI_NORMAL "\n";
-
     /*
      * Traces
      * ------
@@ -320,34 +348,15 @@ std::ostream & showErrorInfo(std::ostream & out, const ErrorInfo & einfo, bool s
 
             oss << "\n" << "… " << trace.hint.str() << "\n";
 
-            if (trace.pos) {
+            if (printPosMaybe(oss, ellipsisIndent, trace.pos))
                 count++;
-
-                oss << "\n" << ellipsisIndent << ANSI_BLUE << "at " ANSI_WARNING << *trace.pos << ANSI_NORMAL << ":";
-
-                if (auto loc = trace.pos->getCodeLines()) {
-                    oss << "\n";
-                    printCodeLines(oss, "", *trace.pos, *loc);
-                    oss << "\n";
-                } else
-                    oss << noSource;
-            }
         }
         oss << "\n" << prefix;
     }
 
     oss << einfo.msg << "\n";
 
-    if (einfo.errPos) {
-        oss << "\n" << ANSI_BLUE << "at " ANSI_WARNING << *einfo.errPos << ANSI_NORMAL << ":";
-
-        if (auto loc = einfo.errPos->getCodeLines()) {
-            oss << "\n";
-            printCodeLines(oss, "", *einfo.errPos, *loc);
-            oss << "\n";
-        } else
-            oss << noSource;
-    }
+    printPosMaybe(oss, "", einfo.errPos);
 
     auto suggestions = einfo.suggestions.trim();
     if (!suggestions.suggestions.empty()) {
diff --git a/src/libutil/error.hh b/src/libutil/error.hh
index be5c5e252..c04dcbd77 100644
--- a/src/libutil/error.hh
+++ b/src/libutil/error.hh
@@ -71,6 +71,13 @@ struct AbstractPos
     uint32_t column = 0;
 
     /**
+     * An AbstractPos may be a "null object", representing an unknown position.
+     *
+     * Return true if this position is known.
+     */
+    inline operator bool() const { return line != 0; };
+
+    /**
      * Return the contents of the source file.
      */
     virtual std::optional<std::string> getSource() const