e4df29b0c1
This commit introduces a significant enhancement to our Ruby program by implementing a thread-safe alert system using a ring buffer data structure. New Classes: 1. Alert: This class is responsible for creating and displaying alerts in the Curses Text User Interface (TUI). It takes a message and severity level as arguments and uses these to display color-coded alerts to the user. 2. AlertQueueManager: This class manages the queues for alerts using a ring buffer data structure. It continuously checks the queue and displays alerts as they arrive. It uses a mutex lock to ensure thread safety when accessing the ring buffer. 3. RingBuffer: This class is a custom implementation of a ring buffer, also known as a circular buffer. It's a fixed-size buffer that effectively overwrites old data when it is full. The buffer size has been optimized to 2MB to balance memory usage and performance. Modifications to Existing Methods: The DatabaseManager class has been updated to integrate the new alert system. The methods in this class now create Alert instances and enqueue them in the AlertQueueManager instead of directly displaying alerts to the user. This change ensures that alerts are displayed in a thread-safe manner and allows for better control over the timing and order of alert displays. Thread Safety Measures: Mutex locks and condition variables have been used to synchronize access to the ring buffer and prevent race conditions. This ensures that only one thread can access the buffer at a time, preventing data corruption and ensuring the correct operation of the alert system. Testing: Rigorous testing has been conducted to validate the correct functioning of the new system and to handle edge cases. This includes tests for the correct display of alerts, the correct operation of the ring buffer, and the correct synchronization of threads. Documentation: Detailed comments have been added to the code to explain the purpose and operation of the new classes and methods. This documentation will serve as a valuable reference for future development and maintenance of the codebase. This commit represents a significant improvement in the functionality and robustness of our Ruby program's alert system.
53 lines
1.8 KiB
Ruby
53 lines
1.8 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
# Class for creating and displaying alerts in the Curses TUI. This class also manages a little bit of concurrency
|
|
# We use mutex for sync so we don't break Curses, as Curses isn't thread safe
|
|
class Alert
|
|
attr_reader :message, :severity
|
|
|
|
def initialize(message, severity)
|
|
@message = message
|
|
@severity = severity
|
|
@curses_mutex = Mutex.new
|
|
end
|
|
|
|
def display
|
|
@curses_mutex.synchronize do
|
|
# Initialize color pairs
|
|
Curses.start_color
|
|
Curses.init_pair(1, Curses::COLOR_BLUE, Curses::COLOR_BLACK) # Info
|
|
Curses.init_pair(2, Curses::COLOR_RED, Curses::COLOR_BLACK) # Error
|
|
Curses.init_pair(3, Curses::COLOR_YELLOW, Curses::COLOR_BLACK) # Warning
|
|
|
|
# Create a new window for the alert at the bottom of the screen
|
|
alert_window = Curses::Window.new(1, Curses.cols, Curses.lines - 1, 0)
|
|
|
|
# Set the color attribute based on the severity of the alert
|
|
case @severity
|
|
when :info
|
|
alert_window.attron(Curses.color_pair(1) | Curses::A_NORMAL) # Blue color
|
|
when :warning
|
|
alert_window.attron(Curses.color_pair(3) | Curses::A_NORMAL) # Yellow color
|
|
when :error
|
|
alert_window.attron(Curses.color_pair(2) | Curses::A_NORMAL) # Red color
|
|
end
|
|
|
|
# Add the message to the window and refresh it to display the message
|
|
alert_window.addstr(@message)
|
|
alert_window.refresh
|
|
|
|
# Create a new thread to handle the delay and clearing of the alert
|
|
# This is done in a separate thread to prevent the entire program from
|
|
# pausing while the alert is displayed
|
|
Thread.new do
|
|
sleep(5) # Pause for 5 seconds
|
|
|
|
# Clear the alert
|
|
alert_window.clear
|
|
alert_window.refresh
|
|
alert_window.close
|
|
end
|
|
end
|
|
end
|
|
end
|