From 5b1e969c232431845b25e5f4c92aa52203510e48 Mon Sep 17 00:00:00 2001
From: Marc Durdin <marc@durdin.net>
Date: Mon, 12 May 2025 06:28:42 +0200
Subject: [PATCH] maint(common): report builder errors to stderr

Sometimes a builder script can be redirected internally and then error
messages are lost in the redirect if the script fails. This sidesteps
that problem by reporting errors to stderr instead of stdout.
---
 resources/builder.inc.sh | 28 ++++++++++++++++++++--------
 1 file changed, 20 insertions(+), 8 deletions(-)

diff --git a/resources/builder.inc.sh b/resources/builder.inc.sh
index bf2235b97d..d9a6c1bbbf 100755
--- a/resources/builder.inc.sh
+++ b/resources/builder.inc.sh
@@ -143,16 +143,27 @@ function builder_term() {
 }
 
 function builder_die() {
-  echo
+  _builder_error_echo
   if [[ $# -eq 0 ]]; then
     builder_echo error "Unspecified error, aborting script"
   else
     builder_echo error "$*"
   fi
-  echo
+  _builder_error_echo
   exit 1
 }
 
+# Emit message to stderr instead of stdout
+function _builder_error_echo() {
+  # we only need to support -e flag
+  if [[ $# -gt 0 ]] && [[ $1 == -e ]]; then
+    shift
+    2>&1 echo -e "$*"
+  else
+    2>&1 echo "$*"
+  fi
+}
+
 function builder_warn() {
   builder_echo warning "$*"
 }
@@ -171,6 +182,7 @@ function builder_heading() {
 
 builder_echo() {
   local color=white message= mark= block= action= do_output=true
+  local echo_target=echo
 
   if [[ $# -gt 1 ]]; then
     if [[ $1 =~ ^(white|grey|green|success|blue|heading|yellow|warning|red|error|purple|brightwhite|teal|debug|setmark)$ ]]; then
@@ -199,7 +211,7 @@ builder_echo() {
   message="$*"
 
   if [[ "${action}" == "start" ]] && builder_is_running_on_teamcity; then
-    echo -e "##teamcity[blockOpened name='|[${THIS_SCRIPT_IDENTIFIER}|] ${block}']"
+    $echo_target -e "##teamcity[blockOpened name='|[${THIS_SCRIPT_IDENTIFIER}|] ${block}']"
   fi
 
   if ${do_output}; then
@@ -210,7 +222,7 @@ builder_echo() {
         green|success) color="$COLOR_GREEN" ;;
         blue|heading) color="$COLOR_BLUE" ;;
         yellow|warning) color="$COLOR_YELLOW" ;;
-        red|error) color="$COLOR_RED" ;;
+        red|error) color="$COLOR_RED"; echo_target=_builder_error_echo ;;
         purple) color="$COLOR_PURPLE" ;;
         brightwhite) color="$COLOR_BRIGHTWHITE" ;;
         teal|debug) color="$COLOR_TEAL" ;;
@@ -218,18 +230,18 @@ builder_echo() {
       esac
 
       if builder_is_dep_build; then
-        echo -e "$mark$COLOR_GREY[$THIS_SCRIPT_IDENTIFIER]$COLOR_RESET $color$message$COLOR_RESET"
+        $echo_target -e "$mark$COLOR_GREY[$THIS_SCRIPT_IDENTIFIER]$COLOR_RESET $color$message$COLOR_RESET"
       else
-        echo -e "$mark$BUILDER_BOLD$COLOR_BRIGHT_WHITE[$THIS_SCRIPT_IDENTIFIER]$COLOR_RESET $color$message$COLOR_RESET"
+        $echo_target -e "$mark$BUILDER_BOLD$COLOR_BRIGHT_WHITE[$THIS_SCRIPT_IDENTIFIER]$COLOR_RESET $color$message$COLOR_RESET"
       fi
     else
       # Cope with the case of pre-init message and just emit plain text
-      echo -e "$message"
+      $echo_target -e "$message"
     fi
   fi
 
   if [[ "${action}" == "end" ]] && builder_is_running_on_teamcity; then
-    echo -e "##teamcity[blockClosed name='|[${THIS_SCRIPT_IDENTIFIER}|] ${block}']"
+    $echo_target -e "##teamcity[blockClosed name='|[${THIS_SCRIPT_IDENTIFIER}|] ${block}']"
   fi
 }