Module: GraphitiErrors

Defined in:
lib/graphiti/error_serializers/deprecated_constants.rb

Overview

The graphiti_errors gem was absorbed into graphiti in 2.0. Only its serializers survived, as Graphiti::ErrorSerializers. The rest of it (the GraphitiErrors controller mixin and its exception handlers) is replaced by rescue_registry rather than renamed, so there is deliberately nothing here to alias it to. A custom error renderer reaching for one of the serializers gets pointed at the new name instead of a bare NameError. Remove in 3.0.

Defined Under Namespace

Modules: ConflictRequest, InvalidRequest, Serializers, Validation

Class Method Summary collapse

Class Method Details

.disable! ⇒ Object 



33
34
35
36
 
# File 'lib/graphiti/error_serializers/deprecated_constants.rb', line 33

def disable!
  Graphiti::DEPRECATOR.deprecation_warning("GraphitiErrors.disable!", "wrap the request in Graphiti::Rails::TestHelpers#handle_request_exceptions instead")
  test_helpers.handle_request_exceptions(false)
end

.disabled? ⇒ Boolean

Returns:

  • (Boolean) 


38
39
40
 
# File 'lib/graphiti/error_serializers/deprecated_constants.rb', line 38

def disabled?
  !test_helpers.handle_request_exceptions?
end

.enable! ⇒ Object 



28
29
30
31
 
# File 'lib/graphiti/error_serializers/deprecated_constants.rb', line 28

def enable!
  Graphiti::DEPRECATOR.deprecation_warning("GraphitiErrors.enable!", "wrap the request in Graphiti::Rails::TestHelpers#handle_request_exceptions instead")
  test_helpers.handle_request_exceptions(true)
end

.included(klass) ⇒ Object

include GraphitiErrors in ApplicationController was this gem's headline usage. Including an empty module succeeds, so without this an upgraded app boots clean and then serves Rails' default HTML error pages instead of JSON:API ones, with nothing to indicate why.



12
13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/graphiti/error_serializers/deprecated_constants.rb', line 12

def self.included(klass)
  raise <<~MSG
    GraphitiErrors was merged into graphiti as of 2.0 and `include GraphitiErrors`
    no longer does anything.

    Exception handling now goes through rescue_registry. Replace it with:

      include Graphiti::Rails::Controller

    which registers Graphiti's own handlers. Your own go alongside them with
    `register_exception`, available on every controller.
  MSG
end