Add better logging to the run-development script

Author: MareStare

docker/app/Dockerfile

@@ -5,6 +5,7 @@ RUN (echo "https://github.com/philomena-dev/prebuilt-ffmpeg/raw/master"; cat /et
     && cp /tmp/repositories /etc/apk/repositories \
     && apk update --allow-untrusted \
     && apk add --allow-untrusted \
+      bash \
       inotify-tools \
       build-base \
       git \
@@ -39,10 +40,15 @@ RUN git clone --depth 1 https://github.com/philomena-dev/mediatools /tmp/mediato
     && cd /tmp/mediatools \
     && make -j$(nproc) install
 
-COPY docker/app/run-development /usr/local/bin/run-development
-COPY docker/app/run-test /usr/local/bin/run-test
-COPY docker/app/safe-rsvg-convert /usr/local/bin/safe-rsvg-convert
-COPY docker/app/purge-cache /usr/local/bin/purge-cache
-ENV PATH=$PATH:/root/.cargo/bin
+COPY scripts/lib.sh /var/philomena/scripts/
+
+COPY \
+  docker/app/run-development \
+  docker/app/run-test \
+  docker/app/safe-rsvg-convert \
+  docker/app/purge-cache \
+  /var/philomena/docker/app/
+
+ENV PATH=$PATH:/root/.cargo/bin:/var/philomena/docker/app
 EXPOSE 5173
 CMD run-development

docker/app/run-development

@@ -1,58 +1,70 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+. "$(dirname "${BASH_SOURCE[0]}")/../../scripts/lib.sh"
 
 # Create S3 dirs
-mkdir -p /srv/philomena/priv/static/system/images/thumbs
-mkdir -p /srv/philomena/priv/s3/philomena
-ln -sf /srv/philomena/priv/static/system/images/thumbs /srv/philomena/priv/s3/philomena/images
-ln -sf /srv/philomena/priv/static/system/images /srv/philomena/priv/s3/philomena/adverts
-ln -sf /srv/philomena/priv/static/system/images /srv/philomena/priv/s3/philomena/avatars
-ln -sf /srv/philomena/priv/static/system/images /srv/philomena/priv/s3/philomena/badges
-ln -sf /srv/philomena/priv/static/system/images /srv/philomena/priv/s3/philomena/tags
+step mkdir -p /srv/philomena/priv/static/system/images/thumbs
+step mkdir -p /srv/philomena/priv/s3/philomena
+step ln -sf /srv/philomena/priv/static/system/images/thumbs /srv/philomena/priv/s3/philomena/images
+step ln -sf /srv/philomena/priv/static/system/images /srv/philomena/priv/s3/philomena/adverts
+step ln -sf /srv/philomena/priv/static/system/images /srv/philomena/priv/s3/philomena/avatars
+step ln -sf /srv/philomena/priv/static/system/images /srv/philomena/priv/s3/philomena/badges
+step ln -sf /srv/philomena/priv/static/system/images /srv/philomena/priv/s3/philomena/tags
 
 # For compatibility with musl libc
 export CARGO_FEATURE_DISABLE_INITIAL_EXEC_TLS=1
 export CARGO_HOME=/srv/philomena/.cargo
 
 background() {
+  # Log the execution with (bg-jobs) prefix to differentiate it from the main process
+  export TASK="bg-jobs"
+
   while :; do
-    mix run -e 'Philomena.Release.update_channels()' > /dev/null
-    mix run -e 'Philomena.Release.verify_artist_links()' > /dev/null
-    mix run -e 'Philomena.Release.update_stats()' > /dev/null
-    mix run -e 'Philomena.Release.clean_moderation_logs()' > /dev/null
-    mix run -e 'Philomena.Release.generate_autocomplete()' > /dev/null
+    step mix run -e 'Philomena.Release.update_channels()' > /dev/null
+    step mix run -e 'Philomena.Release.verify_artist_links()' > /dev/null
+    step mix run -e 'Philomena.Release.update_stats()' > /dev/null
+    step mix run -e 'Philomena.Release.clean_moderation_logs()' > /dev/null
+    step mix run -e 'Philomena.Release.generate_autocomplete()' > /dev/null
 
     sleep 300
   done
 }
 
 # Always install assets
 (
-cd /srv/philomena/assets
-npm install
+  step cd /srv/philomena/assets
+  step npm install
 )
 
 # Always install mix dependencies
-(cd /srv/philomena && mix deps.get)
+(
+  step cd /srv/philomena
+  step mix deps.get
+)
 
 # Sleep to allow OpenSearch to finish initializing
 # if it's not done doing whatever it does yet
-echo -n "Waiting for OpenSearch"
+info "Waiting for OpenSearch"
 
-until wget --no-check-certificate -qO - http://opensearch:9200; do
-  echo -n "."
+until step wget --no-check-certificate -qO - http://opensearch:9200; do
   sleep 2
 done
 
-echo
-
 # Try to create the database if it doesn't exist yet
-createdb -h postgres -U postgres philomena_dev && mix ecto.setup_dev && mix reindex_all
+if step createdb -h postgres -U postgres philomena_dev; then
+  step mix ecto.setup_dev
+  step mix reindex_all
+fi
 
 # Explicitly compile deps to avoid racing
-mix compile
+step mix compile
 
 # Run background jobs
 background &
 
+info "Starting the server"
+
 # Run the application
 START_WORKER=true exec mix phx.server

scripts/lib.sh

@@ -0,0 +1,58 @@
+#!/usr/bin/env bash
+# This file is meant to be sourced by other scripts, not executed directly.
+# It contains a bunch of helper functions for writing bash scripts.
+
+# This output stream is used by subshells to send their output to the root process stdout.
+global_stdout=3
+eval "exec $global_stdout>&1"
+
+# Log a message at the info level
+function info {
+  local message=$1
+
+  echo -e "\033[32;1m[INFO]\033[0m \033[0;32m$message\033[0m" >&2
+}
+
+# Log the command and execute it
+function step {
+  local cmd="$1"
+  if [[ $cmd == exec ]]; then
+    cmd=("${@:2}")
+  else
+    cmd=("${@:1}")
+  fi
+
+  local task="${TASK:-}"
+
+  if [[ -n $task ]]; then
+    task="($task) "
+  fi
+
+  colorized_cmd=$(colorize_command "${cmd[@]}")
+
+  echo >&$global_stdout -e "\033[32;1m$task❱\033[0m $colorized_cmd" >&2
+
+  "$@"
+}
+
+# Returns a command with syntax highlighting
+function colorize_command {
+  local program=$1
+  shift
+
+  local args=()
+  for arg in "$@"; do
+    if [[ $arg =~ ^- ]]; then
+      args+=("\033[34;1m${arg}\033[0m")
+    else
+      args+=("\033[0;33m${arg}\033[0m")
+    fi
+  done
+
+  # On old versions of bash, for example 4.2.46 if the `args` array is empty,
+  # then an `unbound variable` is thrown.
+  #
+  # Luckily, we don't pass commands without positional arguments to this function,
+  # and we use bash >= v5. If this ever becomes a problem, you know the why.
+  echo -e "\033[1;32m${program}\033[0m ${args[*]}"
+}