Skip to content

fix: simplify logger, fix prompts, and restore clean interactive release (refs #67 #71 #72) #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fxstein merged 2 commits into from
Jun 30, 2025
+185 −328
Merged

fix: simplify logger, fix prompts, and restore clean interactive release (refs #67 #71 #72) #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10107df
fix: simplify logger and fix interactive prompts (refs #67 #71 #72)
fxstein Jun 30, 2025
d4d0928
fix: restore logger formatting and ensure all logging uses logger fun…
fxstein Jun 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
217 changes: 61 additions & 156 deletions scripts/core/logger.zsh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,93 +1,79 @@
#!/bin/zsh
# logger.zsh: Centralized logging module for GoProX scripts
#
# Usage:
# export LOGFILE=relative/or/absolute/path/to/logfile.log # Optional
# export LOGFILE_OLD=relative/or/absolute/path/to/logfile.log.old # Optional
# export LOG_MAX_SIZE=16384 # Optional, bytes
# source "$(dirname $0)/logger.zsh"
# log_info "Message"
# log_error "Error message"
# log_debug "Debug message"
# log_json "INFO" "Message" # JSON log format
# Simple, reliable logger for GoProX
# All output goes to stderr to avoid interfering with interactive prompts
#
# If LOGFILE and LOGFILE_OLD are not set, defaults are output/goprox.log and output/goprox.log.old

# --- Configurable Variables ---
: "${LOGFILE:=output/goprox.log}"
: "${LOGFILE_OLD:=output/goprox.log.old}"
: "${LOG_MAX_SIZE:=1048576}"
mkdir -p "$(dirname "$LOGFILE")"
: > "$LOGFILE"

# --- Internal Helpers ---
function _log_rotate_if_needed() {
if [[ -f "$LOGFILE" ]]; then
local file_size=0
# Try to get file size with fallback to 0
if command -v stat >/dev/null 2>&1; then
file_size=$(stat -f %z "$LOGFILE" 2>/dev/null || stat -c %s "$LOGFILE" 2>/dev/null || echo "0")
fi
# Ensure file_size is numeric
if [[ "$file_size" =~ ^[0-9]+$ ]] && [[ "$file_size" -ge $LOG_MAX_SIZE ]]; then
mv "$LOGFILE" "$LOGFILE_OLD"
: > "$LOGFILE"
# Function to get current branch with hash display
get_branch_display() {
local current_branch=$(git branch --show-current 2>/dev/null || echo "unknown")
local branch_hash=$(echo "$current_branch" | sha1sum | cut -c1-8 2>/dev/null || echo "unknown")

# For short branches (≤15 chars), show full name
# For longer branches, show type prefix + hash
if [[ ${#current_branch} -le 15 ]]; then
echo "$current_branch"
else
# Extract branch type prefix
local branch_type=""
if [[ "$current_branch" =~ ^fix/ ]]; then
branch_type="fix"
elif [[ "$current_branch" =~ ^feat/ ]]; then
branch_type="feat"
elif [[ "$current_branch" =~ ^feature/ ]]; then
branch_type="feat"
elif [[ "$current_branch" =~ ^release/ ]]; then
branch_type="rel"
elif [[ "$current_branch" =~ ^hotfix/ ]]; then
branch_type="hot"
elif [[ "$current_branch" == "develop" ]]; then
branch_type="dev"
elif [[ "$current_branch" == "main" ]]; then
branch_type="main"
else
branch_type="other"
fi
echo "${branch_type}/${branch_hash}"
fi
fi
}

function _log_write() {
local level="$1"
local msg="$2"
local ts
ts="$(date '+%Y-%m-%d %H:%M:%S')"
local branch_display=$(get_branch_display)
_log_rotate_if_needed
echo "[$ts] [$branch_display] [$level] $msg" | tee -a "$LOGFILE" >&2
# Function to get formatted timestamp
get_timestamp() {
date '+%Y-%m-%d %H:%M:%S'
}

function log_info() { _log_write "INFO" "$*"; }
function log_success() { _log_write "SUCCESS" "$*"; }
function log_warning() { _log_write "WARNING" "$*"; }
function log_error() { _log_write "ERROR" "$*"; }
function log_debug() { [[ "$LOG_VERBOSE" == 1 ]] && _log_write "DEBUG" "$*"; }
function log_warn() { _log_write "WARN" "$*"; }
function log_json() {
local level="$1"; shift
local msg="$*"
local ts
ts="$(date '+%Y-%m-%dT%H:%M:%S')"
local branch_display=$(get_branch_display)
_log_rotate_if_needed
echo "{\"timestamp\":\"$ts\",\"level\":\"$level\",\"message\":\"$msg\",\"branch\":\"$branch_display\"}" | tee -a "$LOGFILE"
# Simple logging functions with formatting
log_info() {
local ts=$(get_timestamp)
local branch=$(get_branch_display)
echo "[$ts] [$branch] [INFO] $*" >&2
}

function log_time_start() {
export LOG_TIME_START=$(date +%s)
log_success() {
local ts=$(get_timestamp)
local branch=$(get_branch_display)
echo "[$ts] [$branch] [SUCCESS] $*" >&2
}
function log_time_end() {
local end=$(date +%s)
local duration=$((end - LOG_TIME_START))
log_info "Elapsed time: ${duration}s"

log_warning() {
local ts=$(get_timestamp)
local branch=$(get_branch_display)
echo "[$ts] [$branch] [WARNING] $*" >&2
}

# Set up error trap for debugging (only in interactive mode or when explicitly enabled)
# More robust error trap that only triggers on actual script errors
if [[ "${INTERACTIVE:-}" == "true" || "${ENABLE_ERROR_TRAP:-}" == "true" ]]; then
# Only trap errors from the main script, not from expected command failures
# Use a more specific condition to avoid false positives
trap 'if [[ $? -ne 0 && $BASH_SUBSHELL -eq 0 && -n "${SCRIPT_NAME:-}" ]]; then log_error "Error on line $LINENO (exit code: $?)"; fi' ERR
fi
log_error() {
local ts=$(get_timestamp)
local branch=$(get_branch_display)
echo "[$ts] [$branch] [ERROR] $*" >&2
}

# --- Usage Example ---
# source scripts/core/logger.zsh
# log_info "Starting script"
# log_debug "Debug info"
# log_json "INFO" "Structured log message"
# log_time_start
# ... your code ...
# log_time_end
# log_trap_errors
log_debug() {
if [[ "${DEBUG:-}" == "1" || "${DEBUG:-}" == "true" ]]; then
local ts=$(get_timestamp)
local branch=$(get_branch_display)
echo "[$ts] [$branch] [DEBUG] $*" >&2
fi
}

# Function to prominently display current branch information
display_branch_info() {
Expand Down Expand Up @@ -116,84 +102,3 @@ display_branch_info() {
echo "===================="
echo ""
}

# Function to display branch info before critical operations
display_branch_warning() {
local operation="$1"
local target_branch="$2"
local current_branch=$(git branch --show-current 2>/dev/null || echo "unknown")

if [[ "$current_branch" != "$target_branch" ]]; then
echo ""
echo "⚠️ BRANCH MISMATCH WARNING"
echo "=========================="
echo "📍 CURRENT BRANCH: $current_branch"
echo "📍 EXPECTED BRANCH: $target_branch"
echo "📍 OPERATION: $operation"
echo "=========================="
echo ""
echo "❓ Do you want to continue anyway? (y/N)"
read -r response
if [[ ! "$response" =~ ^[Yy]$ ]]; then
log_error "Operation cancelled due to branch mismatch"
exit 1
fi
fi
}

# Function to generate short branch hash (Git-style)
get_branch_hash() {
local branch="$1"
echo "$branch" | sha1sum | cut -c1-8
}

# Function to get current branch with hash display
get_branch_display() {
local current_branch=$(git branch --show-current 2>/dev/null || echo "unknown")
local branch_hash=$(get_branch_hash "$current_branch")

# For short branches (≤15 chars), show full name
# For longer branches, show type prefix + hash
if [[ ${#current_branch} -le 15 ]]; then
echo "$current_branch"
else
# Extract branch type prefix
local branch_type=""
if [[ "$current_branch" =~ ^fix/ ]]; then
branch_type="fix"
elif [[ "$current_branch" =~ ^feat/ ]]; then
branch_type="feat"
elif [[ "$current_branch" =~ ^feature/ ]]; then
branch_type="feat"
elif [[ "$current_branch" =~ ^release/ ]]; then
branch_type="rel"
elif [[ "$current_branch" =~ ^hotfix/ ]]; then
branch_type="hot"
elif [[ "$current_branch" == "develop" ]]; then
branch_type="dev"
elif [[ "$current_branch" == "main" ]]; then
branch_type="main"
else
branch_type="br"
fi

echo "${branch_type}/${branch_hash}"
fi
}

# Function to get full branch name from hash (for debugging)
get_full_branch_name() {
local hash="$1"
local current_branch=$(git branch --show-current 2>/dev/null || echo "unknown")
local current_hash=$(get_branch_hash "$current_branch")

if [[ "$current_hash" == "$hash" ]]; then
echo "$current_branch"
else
echo "unknown"
fi
}

# Enhanced logging functions with branch awareness
# NOTE: These functions are now consolidated with the original ones above
# to avoid duplicate definitions and ensure rotation works properly
Loading
Loading