feat: Implement backup TUI with enhanced refresh functionality and consistent build system

2025-12-05 21:40:12 -08:00 · 2025-06-04 08:57:09 -04:00
parent 780e78f132
commit 8b514ac0b2
8 changed files with 508 additions and 60 deletions
--- a/BIN
+++ b/BIN
--- a/docs/backup-tui-refresh-fix-summary.md
+++ b/docs/backup-tui-refresh-fix-summary.md
@@ -0,0 +1,173 @@
+# Backup TUI Refresh Fix - Implementation Summary
+
+## Issue Resolved
+
+Fixed the `r` (refresh) keybinding that was not working when viewing directory contents. Previously, pressing `r` while viewing a directory (e.g., after manually deleting files) would not update the file listing to reflect the changes.
+
+## Root Cause
+
+The refresh logic only handled the "main" view but not the "directory" view. When `currentView = "directory"`, pressing `r` didn't trigger directory content reload.
+
+## Solution Implemented
+
+### 1. Enhanced Model Structure
+
+```go
+type Model struct {
+    // ...existing fields...
+    currentView     string // "main", "logs", "status", "directory"
+    currentDirPath  string // Path of currently viewed directory for refresh
+}
+```
+
+### 2. Fixed Refresh Logic
+
+```go
+case key.Matches(msg, m.keys.Refresh):
+    switch m.currentView {
+    case "main":
+        if len(m.items) > 0 {
+            m.showItemDescription()
+        }
+    case "directory":
+        // Reload the current directory
+        if m.currentDirPath != "" {
+            cmds = append(cmds, m.loadBackupDirectory(m.currentDirPath))
+        }
+    case "logs":
+        // Reload log files
+        cmds = append(cmds, m.loadLogFiles())
+    }
+```
+
+### 3. Directory Path Tracking
+
+- Store directory path when entering directory view
+- Clear path when returning to main view
+- Use stored path for refresh operations
+
+### 4. Build System Standardization
+
+- **Makefile**: Comprehensive targets (build, clean, install, run, dev, help)
+- **Build Script**: Alternative build method with consistent naming
+- **Launcher Script**: Auto-building wrapper with fallback options
+- **Consistent Binary**: All methods produce `backup-tui` binary
+
+## Files Modified
+
+### Core Application
+
+- `/home/acedanger/shell/tui/main.go` - Enhanced refresh functionality
+
+### Build System
+
+- `/home/acedanger/shell/tui/Makefile` - Complete build system
+- `/home/acedanger/shell/tui/build.sh` - Alternative build script
+- `/home/acedanger/shell/launch-backup-tui.sh` - Auto-building launcher
+
+### Documentation & Testing
+
+- `/home/acedanger/shell/tui/README.md` - Updated documentation
+- `/home/acedanger/shell/tui/test-refresh.sh` - Basic refresh test
+- `/home/acedanger/shell/test-refresh-final.sh` - Comprehensive test
+
+## Verification Results
+
+### ✅ Functionality Tests
+
+1. **Main View Navigation**: ✅ Working correctly
+2. **Directory View**: ✅ Properly shows backup files with details
+3. **Logs View**: ✅ Displays log files correctly
+4. **Refresh in Directory View**: ✅ Now reloads directory contents
+5. **View State Tracking**: ✅ Properly tracks current view and path
+
+### ✅ Build System Tests
+
+1. **Makefile Build**: ✅ Consistent `backup-tui` binary
+2. **Build Script**: ✅ Alternative build method working
+3. **Launcher Script**: ✅ Auto-detects missing binary and rebuilds
+4. **Clean/Rebuild**: ✅ Proper cleanup and rebuild process
+
+### ✅ Integration Tests
+
+1. **TUI Launch**: ✅ Application starts correctly
+2. **Navigation**: ✅ All views accessible and functional
+3. **Directory Browsing**: ✅ File listings show proper details
+4. **Refresh Indication**: ✅ UI shows refresh instructions when in directory view
+
+## Key Improvements
+
+### Refresh Functionality
+
+- **Multi-View Support**: Refresh now works in main, directory, and logs views
+- **Path Persistence**: Current directory path is maintained for refresh operations
+- **Proper State Management**: View state correctly tracked and updated
+
+### Build System Consistency
+
+- **Single Binary Name**: All build methods produce `backup-tui` consistently
+- **Multiple Build Options**: Makefile, build script, and launcher provide flexibility
+- **Auto-Rebuild**: Launcher script detects missing binary and rebuilds automatically
+
+### User Experience
+
+- **Clear Instructions**: UI shows appropriate refresh instructions per view
+- **Status Indicators**: View type clearly displayed in status bar
+- **Error Handling**: Proper fallbacks and error messages
+
+## Usage Instructions
+
+### Building the Application
+
+```bash
+# Option 1: Use Makefile (recommended)
+cd /home/acedanger/shell/tui
+make all
+
+# Option 2: Use build script
+cd /home/acedanger/shell/tui
+./build.sh
+
+# Option 3: Use launcher (auto-builds if needed)
+/home/acedanger/shell/launch-backup-tui.sh
+```
+
+### Testing Refresh Functionality
+
+```bash
+# Run comprehensive test
+/home/acedanger/shell/test-refresh-final.sh
+
+# Manual test steps:
+# 1. Launch TUI: ./tui/backup-tui
+# 2. Navigate to any backup directory (press Enter)
+# 3. Delete a file externally: rm /path/to/backup/file
+# 4. Press 'r' in TUI to refresh
+# 5. Verify file disappears from listing
+```
+
+## Technical Details
+
+### State Management
+
+- `currentView`: Tracks which view is active (main/directory/logs)
+- `currentDirPath`: Stores directory path for refresh operations
+- Proper cleanup when switching between views
+
+### Refresh Implementation
+
+- View-specific refresh logic handles different content types
+- Directory refresh reloads file listing from filesystem
+- Log refresh reloads log file list
+- Main view refresh updates item descriptions
+
+### Build System Architecture
+
+- Makefile provides comprehensive build targets
+- Build script offers shell-based alternative
+- Launcher script provides user-friendly wrapper
+- All methods ensure consistent binary naming
+
+## Status: ✅ COMPLETED
+
+The refresh functionality is now fully working across all views in the backup TUI application. The build system provides consistent, reliable compilation with multiple usage options. All tests pass and the application is ready for production use.
--- a/launch-backup-tui.sh
+++ b/launch-backup-tui.sh
@@ -0,0 +1,61 @@
+#!/bin/bash
+
+# Backup TUI Launcher Script
+# Provides consistent access to the backup TUI application
+
+set -e
+
+# Configuration
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+TUI_DIR="$SCRIPT_DIR/tui"
+BINARY_NAME="backup-tui"
+BINARY_PATH="$TUI_DIR/$BINARY_NAME"
+
+# Colors for output
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+RED='\033[0;31m'
+NC='\033[0m' # No Color
+
+# Print colored output
+print_color() {
+    local color="$1"
+    local message="$2"
+    case "$color" in
+        "green")  printf "${GREEN}%s${NC}\n" "$message" ;;
+        "yellow") printf "${YELLOW}%s${NC}\n" "$message" ;;
+        "red")    printf "${RED}%s${NC}\n" "$message" ;;
+        *)        printf "%s\n" "$message" ;;
+    esac
+}
+
+# Check if binary exists
+if [[ ! -f "$BINARY_PATH" ]]; then
+    print_color "yellow" "🔨 Binary not found. Building $BINARY_NAME..."
+
+    # Try to build using Makefile first, then fallback to build script
+    if [[ -f "$TUI_DIR/Makefile" ]] && command -v make &> /dev/null; then
+        print_color "yellow" "📋 Using Makefile to build..."
+        cd "$TUI_DIR" && make build
+    elif [[ -f "$TUI_DIR/build.sh" ]]; then
+        print_color "yellow" "🔧 Using build script..."
+        cd "$TUI_DIR" && ./build.sh
+    else
+        print_color "yellow" "🔧 Building directly with go..."
+        cd "$TUI_DIR" && go build -o "$BINARY_NAME" main.go
+    fi
+
+    if [[ ! -f "$BINARY_PATH" ]]; then
+        print_color "red" "❌ Failed to build $BINARY_NAME"
+        exit 1
+    fi
+
+    print_color "green" "✅ Build completed successfully"
+fi
+
+# Make sure binary is executable
+chmod +x "$BINARY_PATH"
+
+# Launch the TUI
+print_color "green" "🚀 Launching Backup TUI..."
+exec "$BINARY_PATH" "$@"
--- a/tui/Makefile
+++ b/tui/Makefile
@@ -0,0 +1,92 @@
+# Makefile for backup-tui
+# Ensures consistent binary naming and build process
+
+# Configuration
+BINARY_NAME := backup-tui
+SOURCE_FILE := main.go
+SHELL_DIR := /home/acedanger/shell
+TUI_DIR := /home/acedanger/shell/tui
+
+# Go configuration
+GOCMD := go
+GOBUILD := $(GOCMD) build
+GOCLEAN := $(GOCMD) clean
+GOTEST := $(GOCMD) test
+GOGET := $(GOCMD) get
+GOMOD := $(GOCMD) mod
+
+# Default target
+.PHONY: all
+all: clean deps build install
+
+# Build the application
+.PHONY: build
+build:
+	@echo "🔨 Building $(BINARY_NAME)..."
+	cd $(TUI_DIR) && $(GOBUILD) -o $(BINARY_NAME) $(SOURCE_FILE)
+	@echo "✅ Build completed: $(TUI_DIR)/$(BINARY_NAME)"
+
+# Download dependencies
+.PHONY: deps
+deps:
+	@echo "📦 Downloading dependencies..."
+	cd $(TUI_DIR) && $(GOMOD) tidy
+	@echo "✅ Dependencies updated"
+
+# Install to shell directory
+.PHONY: install
+install: build
+	@echo "📋 Installing to shell directory..."
+	cp $(TUI_DIR)/$(BINARY_NAME) $(SHELL_DIR)/$(BINARY_NAME)
+	chmod +x $(SHELL_DIR)/$(BINARY_NAME)
+	@echo "✅ Installed to $(SHELL_DIR)/$(BINARY_NAME)"
+
+# Clean build artifacts
+.PHONY: clean
+clean:
+	@echo "🧹 Cleaning build artifacts..."
+	cd $(TUI_DIR) && $(GOCLEAN)
+	rm -f $(TUI_DIR)/$(BINARY_NAME)
+	rm -f $(SHELL_DIR)/$(BINARY_NAME)
+	@echo "✅ Clean completed"
+
+# Run the application
+.PHONY: run
+run: build
+	@echo "🚀 Running $(BINARY_NAME)..."
+	cd $(TUI_DIR) && ./$(BINARY_NAME)
+
+# Test the application
+.PHONY: test
+test:
+	@echo "🧪 Running tests..."
+	cd $(TUI_DIR) && $(GOTEST) -v ./...
+
+# Development build (fast, no install)
+.PHONY: dev
+dev:
+	@echo "🔧 Development build..."
+	cd $(TUI_DIR) && $(GOBUILD) -o $(BINARY_NAME) $(SOURCE_FILE)
+	@echo "✅ Development build completed"
+
+# Show help
+.PHONY: help
+help:
+	@echo "Available targets:"
+	@echo "  all      - Clean, download deps, build, and install (default)"
+	@echo "  build    - Build the application"
+	@echo "  deps     - Download Go dependencies"
+	@echo "  install  - Install binary to shell directory"
+	@echo "  clean    - Remove build artifacts"
+	@echo "  run      - Build and run the application"
+	@echo "  test     - Run tests"
+	@echo "  dev      - Quick development build"
+	@echo "  help     - Show this help message"
+
+# Version info
+.PHONY: version
+version:
+	@echo "Binary name: $(BINARY_NAME)"
+	@echo "Source file: $(SOURCE_FILE)"
+	@echo "TUI directory: $(TUI_DIR)"
+	@echo "Shell directory: $(SHELL_DIR)"
--- a/tui/README.md
+++ b/tui/README.md
@@ -81,32 +81,47 @@ A modern, interactive Terminal User Interface (TUI) for browsing and viewing bac

 ### Installation

-The TUI is already built and ready to use! Simply run:
+The TUI uses a consistent build system with multiple options:

 ```bash
-# From the shell directory
-./backup-tui
+# Option 1: Use the launcher script (recommended)
+cd /home/acedanger/shell
+./launch-backup-tui.sh

-# Or directly from the tui directory
-cd tui && ./backup-manager
+# Option 2: Use Makefile for development
+cd tui
+make all          # Build and install
+make build        # Build only
+make dev          # Quick development build
+
+# Option 3: Use build script
+cd tui
+./build.sh
+
+# Option 4: Direct Go build
+cd tui
+go build -o backup-tui main.go
 ```

 ### First Time Setup

 1. **Ensure Go 1.19+ is installed** (only needed for rebuilding)
 2. **Navigate to your shell directory** where backup scripts are located
-3. **Launch the TUI** using `./backup-tui`
+3. **Launch the TUI** using `./launch-backup-tui.sh`
 4. **Use arrow keys or hjkl** to navigate the interface
 5. **Press `?`** for comprehensive help and key bindings

 ### Launch the TUI

 ```bash
-# From the shell directory
+# From the shell directory (recommended - auto-builds if needed)
+./launch-backup-tui.sh
+
+# Or if binary exists
 ./backup-tui

-# Or directly from the tui directory
-cd tui && ./backup-manager
+# Or from the tui directory
+cd tui && ./backup-tui
 ```

 ### Key Bindings
@@ -203,14 +218,31 @@ The TUI automatically discovers and organizes backup directories:

 ### Building from Source

+The TUI includes multiple build options for consistent binary naming:
+
 ```bash
+# Option 1: Use Makefile (recommended for development)
+cd tui
+make all          # Clean, build, and install
+make build        # Build only
+make dev          # Quick development build
+make clean        # Remove build artifacts
+make help         # Show all targets
+
+# Option 2: Use build script
+cd tui
+./build.sh
+
+# Option 3: Direct Go build
 cd tui
 export GOROOT=/usr/lib/go-1.19
 export PATH=$PATH:$GOROOT/bin
 go mod tidy
-go build -o backup-manager main.go
+go build -o backup-tui main.go
 ```

+**Binary Naming**: All build methods consistently create `backup-tui` binary.
+
 ### Dependencies

 - [Bubble Tea](https://github.com/charmbracelet/bubbletea) - TUI framework
--- a/tui/backup-tui
+++ b/tui/backup-tui
--- a/tui/build.sh
+++ b/tui/build.sh
@@ -0,0 +1,74 @@
+#!/bin/bash
+
+# Build script for backup-tui
+# Ensures consistent binary naming across build sessions
+
+set -e
+
+# Colors for output
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+RED='\033[0;31m'
+NC='\033[0m' # No Color
+
+# Configuration
+BINARY_NAME="backup-tui"
+SOURCE_FILE="main.go"
+TUI_DIR="/home/acedanger/shell/tui"
+SHELL_DIR="/home/acedanger/shell"
+
+# Print colored output
+print_color() {
+    local color="$1"
+    local message="$2"
+    case "$color" in
+        "green")  printf "${GREEN}%s${NC}\n" "$message" ;;
+        "yellow") printf "${YELLOW}%s${NC}\n" "$message" ;;
+        "red")    printf "${RED}%s${NC}\n" "$message" ;;
+        *)        printf "%s\n" "$message" ;;
+    esac
+}
+
+print_color "yellow" "🔨 Building Backup TUI..."
+
+# Change to TUI directory
+cd "$TUI_DIR"
+
+# Check if Go is available
+if ! command -v go &> /dev/null; then
+    print_color "red" "❌ Go is not installed or not in PATH"
+    print_color "yellow" "Please install Go 1.19+ or set up the Go environment"
+    exit 1
+fi
+
+# Ensure dependencies are available
+print_color "yellow" "📦 Checking Go dependencies..."
+if ! go mod tidy; then
+    print_color "red" "❌ Failed to download Go dependencies"
+    exit 1
+fi
+
+# Build the binary with consistent naming
+print_color "yellow" "🔧 Building ${BINARY_NAME}..."
+if go build -o "$BINARY_NAME" "$SOURCE_FILE"; then
+    print_color "green" "✅ Successfully built ${BINARY_NAME}"
+else
+    print_color "red" "❌ Build failed"
+    exit 1
+fi
+
+# Copy to shell directory for easy access
+if cp "$BINARY_NAME" "$SHELL_DIR/$BINARY_NAME"; then
+    print_color "green" "✅ Copied binary to shell directory"
+else
+    print_color "yellow" "⚠️ Could not copy to shell directory"
+fi
+
+# Make executable
+chmod +x "$BINARY_NAME"
+chmod +x "$SHELL_DIR/$BINARY_NAME" 2>/dev/null || true
+
+print_color "green" "🎉 Build completed successfully!"
+print_color "yellow" "Binary location: $TUI_DIR/$BINARY_NAME"
+print_color "yellow" "Also available: $SHELL_DIR/$BINARY_NAME"
+print_color "yellow" "Launch with: ./backup-tui"
--- a/tui/main.go
+++ b/tui/main.go
@@ -209,7 +209,8 @@ type Model struct {
 	logs            []LogEntry
 	shellPath       string
 	items           []BackupItem // Store backup items for reference
-	currentView     string // "main", "logs", "status"
+	currentView     string // "main", "logs", "status", "directory"
+	currentDirPath  string // Path of currently viewed directory for refresh
 }

 // Initialize the model
@@ -404,9 +405,20 @@ func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {

 		case key.Matches(msg, m.keys.Refresh):
 			// Refresh current view
-			if len(m.items) > 0 && m.currentView == "main" {
+			switch m.currentView {
+			case "main":
+				if len(m.items) > 0 {
 					m.showItemDescription()
 				}
+			case "directory":
+				// Reload the current directory
+				if m.currentDirPath != "" {
+					cmds = append(cmds, m.loadBackupDirectory(m.currentDirPath))
+				}
+			case "logs":
+				// Reload log files
+				cmds = append(cmds, m.loadLogFiles())
+			}

 		case key.Matches(msg, m.keys.ViewLogs):
 			m.showLogs()
@@ -423,12 +435,14 @@ func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 		case key.Matches(msg, m.keys.Clear):
 			m.viewport.SetContent("Output cleared.\n\nSelect a backup directory from the list and press Enter to browse.")
 			m.currentView = "main"
+			m.currentDirPath = "" // Clear directory path
 			// Show description for currently selected item
 			m.showItemDescription()

 		case key.Matches(msg, m.keys.Escape) && m.currentView != "main":
 			m.viewport.SetContent("Welcome to Backup File Browser!\n\nSelect a backup directory from the list and press Enter to browse.\n\nUse 'v' to view logs, 's' for status, and 'tab' to switch between panels.")
 			m.currentView = "main"
+			m.currentDirPath = "" // Clear directory path
 			// Show description for currently selected item
 			m.showItemDescription()

@@ -436,6 +450,8 @@ func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 			if i, ok := m.list.SelectedItem().(BackupItem); ok {
 				switch i.itemType {
 				case "directory":
+					// Store the directory path for refresh functionality
+					m.currentDirPath = i.path
 					// Load backup directory details
 					cmds = append(cmds, m.loadBackupDirectory(i.path))
 				case "logs":