Skip to content

GlobalHandler

import "Engine-AntiGinx/App/GlobalHandler"

Index

type ErrorHandler

ErrorHandler serves as the global safety net and execution controller for the application. It is responsible for wrapping the main application logic within a panic-recovery boundary and formatting any resulting errors according to the selected output mode (CLI or JSON).

type ErrorHandler struct {
    cliMode bool
}

func InitializeErrorHandler

func InitializeErrorHandler(cliMode bool) *ErrorHandler

InitializeErrorHandler creates a new instance of the global error handler.

It configures the reporting mode based on the cliMode flag. This instance is intended to be used at the very top level of the application (typically in main.go) to ensure all unhandled panics are caught and reported gracefully.

Parameters:

  • cliMode: If true, errors are printed in a human-readable text block. If false, errors are printed as structured JSON objects for machine consumption.

Returns:

  • *ErrorHandler: A pointer to the configured handler instance ready to execute RunSafe().

func (*ErrorHandler) RunSafe

func (e *ErrorHandler) RunSafe()

RunSafe executes the main application flow within a protected scope. This is the entry point for the business logic, triggering argument parsing, parameter formatting, and job orchestration.

The function establishes a defer/recover block to intercept any panics that occur during execution. It acts as a "try-catch" mechanism for the entire process, ensuring that the application never crashes with a raw stack trace but instead exits with a controlled error message and status code.

Panic Recovery Strategy:

  • Errors.Error: Handled directly, preserving the original code and message.
  • HttpClient.HttpError: Converted to a generic Errors.Error with "Http Client" source.
  • default (runtime panics): Wrapped in a critical Errors.Error (code 999) with stack details.

Execution Flow:

  1. Sets up panic recovery via defer/recover.
  2. Creates and runs the CommandParser to process os.Args.
  3. Initializes the ScanFormatter to transform raw parameters into an ExecutionPlan.
  4. Creates and runs the JobRunner to orchestrate the security tests.
  5. If a panic occurs, it is caught, printed to Stderr, and the process exits with code 1.

Exit Behavior:

  • On Success: The function returns normally (exit code 0).
  • On Panic: The process terminates immediately with os.Exit(1).

Example:

handler := GlobalHandler.InitializeErrorHandler(true)
// Will run the app and print pretty errors to stderr if something explodes
handler.RunSafe()

func (*ErrorHandler) printError

func (e *ErrorHandler) printError(err Errors.Error)

printError writes the formatted error details to standard error (os.Stderr).

The format is determined by the cliMode flag set during initialization. This abstraction allows the application to be used both by humans in a terminal and by automated workers/wrappers expecting JSON.

Output Formats:

  • CLI Mode (true): A visual, ASCII-formatted block containing Source, Exit Code, Message, and Retryable status.
  • JSON Mode (false): A strict JSON object representing the Error struct.

Parameters:

  • err: The standardized Errors.Error object to display.

Generated by gomarkdoc