Module: Browserctl::Error::Codes

Defined in:
lib/browserctl/error/codes.rb

Overview

Canonical enum of stable error code strings emitted on the wire and in CLI stderr payloads. Codes are SCREAMING_SNAKE_CASE and must remain stable across releases — agents branch on these deterministically.

The full sweep that wires every raise site to one of these codes lands in PR #8 of the v0.12 “Solid” milestone. This module is the single source of truth those raises will reference.

Constant Summary collapse

AUTH_REQUIRED = 
"AUTH_REQUIRED"
SELECTOR_NOT_FOUND = 
"SELECTOR_NOT_FOUND"
STATE_EXPIRED = 
"STATE_EXPIRED"
SECRET_RESOLUTION_FAILED = 
"SECRET_RESOLUTION_FAILED"
DAEMON_UNREACHABLE = 
"DAEMON_UNREACHABLE"
PROTOCOL_MISMATCH = 
"PROTOCOL_MISMATCH"
DOMAIN_NOT_ALLOWED = 
"DOMAIN_NOT_ALLOWED"
KEY_NOT_FOUND = 
"KEY_NOT_FOUND"
VALIDATION_FAILED =

Validation family — introduced in v0.14 WS-1 to retire the remaining bare ArgumentError raises on public APIs and DSL guards. VALIDATION_FAILED is the parent code; the four INVALID_* members are specialisations that all share exit code 8. See docs/reference/errors.md for the per-code triggers.

"VALIDATION_FAILED"
INVALID_SELECTOR_REF = 
"INVALID_SELECTOR_REF"
INVALID_STATE_NAME = 
"INVALID_STATE_NAME"
INVALID_DSL_USAGE = 
"INVALID_DSL_USAGE"
INVALID_FORMAT_VERSION = 
"INVALID_FORMAT_VERSION"
INVALID_ARGUMENT = 
"INVALID_ARGUMENT"
PLUGIN_FAILED =

Plugin family — introduced in v0.15 WS-2 PR 5 to isolate the daemon from misbehaving third-party commands registered via ‘Browserctl.register_command`. PLUGIN_FAILED is the catch-all when an uncaught exception escapes the plugin block; PLUGIN_TIMED_OUT is emitted when the per-plugin timeout (default 30s, configurable via `timeout:` on `register_command`, opt-out via `timeout: nil`) elapses before the block returns. Both codes carry the plugin name in the response payload’s ‘context` so agents can branch on it.

"PLUGIN_FAILED"
PLUGIN_TIMED_OUT = 
"PLUGIN_TIMED_OUT"
GENERIC = 
"GENERIC"
ALL = 
[
  AUTH_REQUIRED,
  SELECTOR_NOT_FOUND,
  STATE_EXPIRED,
  SECRET_RESOLUTION_FAILED,
  DAEMON_UNREACHABLE,
  PROTOCOL_MISMATCH,
  DOMAIN_NOT_ALLOWED,
  KEY_NOT_FOUND,
  VALIDATION_FAILED,
  INVALID_SELECTOR_REF,
  INVALID_STATE_NAME,
  INVALID_DSL_USAGE,
  INVALID_FORMAT_VERSION,
  INVALID_ARGUMENT,
  PLUGIN_FAILED,
  PLUGIN_TIMED_OUT,
  GENERIC
].freeze

Class Method Summary collapse

Class Method Details

.all ⇒ Object 



67
68
69
 
# File 'lib/browserctl/error/codes.rb', line 67

def self.all
  ALL
end

.valid?(code) ⇒ Boolean

Returns:

  • (Boolean) 


71
72
73
 
# File 'lib/browserctl/error/codes.rb', line 71

def self.valid?(code)
  ALL.include?(code)
end