Exception: StandardError

Inherits:
Exception
  • Object
show all
Defined in:
lib/coaster/core_ext/standard_error.rb,
lib/coaster/core_ext/standard_error/raven.rb,
lib/coaster/core_ext/standard_error/sentry.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(message = nil, cause = $!) ⇒ StandardError

Returns a new instance of StandardError.



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/coaster/core_ext/standard_error.rb', line 37

def initialize(message = nil, cause = $!)
  @fingerprint = Coaster.default_fingerprint.dup
  @tags = {}
  @level = 'error'
  @attributes = HashWithIndifferentAccess.new
  @attributes.merge!(cause.attributes || {}) if cause && cause.respond_to?(:attributes)
  @tkey = nil

  case message
  when Exception
    msg = message
    set_backtrace(message.backtrace)
  when StandardError
    @fingerprint = message.fingerprint
    @tags = message.tags
    @level = message.level
    @tkey = message.tkey
    @attributes = message.attributes
    msg = message
    set_backtrace(message.backtrace)
  when Hash then
    @coaster = true # coaster 확장을 사용한 에러임을 확인할 수 있음.
    hash = message.with_indifferent_access rescue message
    msg = hash.delete(:m)
    msg = hash.delete(:msg) || msg
    msg = hash.delete(:message) || msg
    hash[:description] ||= hash.delete(:desc) if hash[:desc].present?
    @fingerprint = hash.delete(:fingerprint) || hash.delete(:fingerprints)
    @tags = hash.delete(:tags) || hash.delete(:tag)
    @level = hash.delete(:level) || hash.delete(:severity) || @level
    @tkey = hash.delete(:tkey)
    @attributes.merge!(hash)
    if @attributes[:description] == :translate
      @attributes.delete(:description)
      @attributes[:description] = _translate
    end
    msg = "#{_translate} (#{msg || self.class.name})"
    msg = "#{msg} {#{cause.message}}" if cause
  when String then
    msg = message
  when FalseClass, NilClass then
    msg = nil
  else
    msg = message
  end

  @fingerprint = [] unless @fingerprint.is_a?(Array)
  @tags = {} unless @tags.is_a?(Hash)
  msg = "{#{cause.message}}" if msg.blank? && cause
  super(msg)
end

Instance Attribute Details

#fingerprint ⇒ Object

Returns the value of attribute fingerprint.



35
36
37
 
# File 'lib/coaster/core_ext/standard_error.rb', line 35

def fingerprint
  @fingerprint
end

#level ⇒ Object

Returns the value of attribute level.



35
36
37
 
# File 'lib/coaster/core_ext/standard_error.rb', line 35

def level
  @level
end

#raven ⇒ Object 



10
11
12
 
# File 'lib/coaster/core_ext/standard_error/raven.rb', line 10

def raven
  @raven ||= {}.with_indifferent_access
end

#tags ⇒ Object

Returns the value of attribute tags.



35
36
37
 
# File 'lib/coaster/core_ext/standard_error.rb', line 35

def tags
  @tags
end

#tkey ⇒ Object

Returns the value of attribute tkey.



35
36
37
 
# File 'lib/coaster/core_ext/standard_error.rb', line 35

def tkey
  @tkey
end

Class Method Details

.after_logging(name, &block) ⇒ Object 



25
26
27
28
 
# File 'lib/coaster/core_ext/standard_error.rb', line 25

def after_logging(name, &block)
  @after_logging_blocks ||= {}
  @after_logging_blocks[name] = block
end

.after_logging_blocks ⇒ Object 



29
30
31
32
 
# File 'lib/coaster/core_ext/standard_error.rb', line 29

def after_logging_blocks
  @after_logging_blocks ||= {}
  superclass <= StandardError ? superclass.after_logging_blocks.merge(@after_logging_blocks) : @after_logging_blocks
end

.before_logging(name, &block) ⇒ Object 



16
17
18
19
 
# File 'lib/coaster/core_ext/standard_error.rb', line 16

def before_logging(name, &block)
  @before_logging_blocks ||= {}
  @before_logging_blocks[name] = block
end

.before_logging_blocks ⇒ Object 



20
21
22
23
 
# File 'lib/coaster/core_ext/standard_error.rb', line 20

def before_logging_blocks
  @before_logging_blocks ||= {}
  superclass <= StandardError ? superclass.before_logging_blocks.merge(@before_logging_blocks) : @before_logging_blocks
end

.code ⇒ Object

Unknown



10
 
# File 'lib/coaster/core_ext/standard_error.rb', line 10

def status; 999999 end

.http_status ⇒ Object 



11
 
# File 'lib/coaster/core_ext/standard_error.rb', line 11

def http_status;  500 end

.intentional? ⇒ Boolean

Returns:

  • (Boolean) 


13
 
# File 'lib/coaster/core_ext/standard_error.rb', line 13

def intentional?; false end

.report? ⇒ Boolean

Returns:

  • (Boolean) 


12
 
# File 'lib/coaster/core_ext/standard_error.rb', line 12

def report?;      true end

.status ⇒ Object

Unknown



9
 
# File 'lib/coaster/core_ext/standard_error.rb', line 9

def status; 999999 end

.title ⇒ Object 



14
 
# File 'lib/coaster/core_ext/standard_error.rb', line 14

def title; _translate('.title') end

Instance Method Details

#_translate(*args) ⇒ Object 



130
131
132
133
 
# File 'lib/coaster/core_ext/standard_error.rb', line 130

def _translate(*args)
  return description if description.present?
  super
end

#_translate_params ⇒ Object 



135
136
137
 
# File 'lib/coaster/core_ext/standard_error.rb', line 135

def _translate_params
  attributes
end

#after_logging_blocks ⇒ Object 



92
 
# File 'lib/coaster/core_ext/standard_error.rb', line 92

def after_logging_blocks; self.class.after_logging_blocks end

#attributes ⇒ Object Also known as: attr 



95
96
97
98
99
100
101
102
 
# File 'lib/coaster/core_ext/standard_error.rb', line 95

def attributes
  return @attributes if defined?(@attributes)
  @attributes = HashWithIndifferentAccess.new
  if cause && cause.respond_to?(:attributes) && cause.attributes.is_a?(Hash)
    @attributes = @attributes.merge(cause.attributes)
  end
  @attributes
end

#before_logging_blocks ⇒ Object 



91
 
# File 'lib/coaster/core_ext/standard_error.rb', line 91

def before_logging_blocks; self.class.before_logging_blocks end

#capture(options = {}) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/coaster/core_ext/standard_error/raven.rb', line 39

def capture(options = {})
  return if options.key?(:report) && !options[:report]
  return unless report?
  nt = notes(options)
  Raven.capture_exception(self, level: nt[:level]) do |event|
    event.user.merge!(nt[:user] || {})
    event.tags.merge!(nt[:tags])
    event.extra.merge!(nt[:extra])
    event.fingerprint = raven_fingerprint
  end
rescue => e
  msg = "#{e.class.name}: #{e.message}"
  msg += "\n\t" + e.backtrace.join("\n\t")
  Raven.logger.error(msg)
end

#code ⇒ Object 



107
 
# File 'lib/coaster/core_ext/standard_error.rb', line 107

def code;         attributes[:code] || status end

#code=(value) ⇒ Object 



108
 
# File 'lib/coaster/core_ext/standard_error.rb', line 108

def code=(value); attributes[:code] = value end

#description ⇒ Object Also known as: desc

description is user friendly message as a attribute, do not use error’s message error message is not user friendly in many cases.



127
 
# File 'lib/coaster/core_ext/standard_error.rb', line 127

def description; attributes[:description] || attributes[:desc] end

#descriptions ⇒ Object

another user friendly messages



147
148
149
150
151
 
# File 'lib/coaster/core_ext/standard_error.rb', line 147

def descriptions
  return attributes[:descriptions] if attributes[:descriptions]
  attributes[:descriptions] = {}
  attributes[:descriptions]
end

#http_status ⇒ Object 



105
 
# File 'lib/coaster/core_ext/standard_error.rb', line 105

def http_status;         attributes[:http_status] || self.class.http_status end

#http_status=(value) ⇒ Object 



106
 
# File 'lib/coaster/core_ext/standard_error.rb', line 106

def http_status=(value); attributes[:http_status] = value end

#initialize_original ⇒ StandardError

Returns a new instance of StandardError.

Returns:



4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/coaster/core_ext/standard_error/raven.rb', line 4

def initialize(message = nil, cause = $!)
  @fingerprint = Coaster.default_fingerprint.dup
  @tags = {}
  @level = 'error'
  @attributes = HashWithIndifferentAccess.new
  @attributes.merge!(cause.attributes || {}) if cause && cause.respond_to?(:attributes)
  @tkey = nil

  case message
  when Exception
    msg = message
    set_backtrace(message.backtrace)
  when StandardError
    @fingerprint = message.fingerprint
    @tags = message.tags
    @level = message.level
    @tkey = message.tkey
    @attributes = message.attributes
    msg = message
    set_backtrace(message.backtrace)
  when Hash then
    @coaster = true # coaster 확장을 사용한 에러임을 확인할 수 있음.
    hash = message.with_indifferent_access rescue message
    msg = hash.delete(:m)
    msg = hash.delete(:msg) || msg
    msg = hash.delete(:message) || msg
    hash[:description] ||= hash.delete(:desc) if hash[:desc].present?
    @fingerprint = hash.delete(:fingerprint) || hash.delete(:fingerprints)
    @tags = hash.delete(:tags) || hash.delete(:tag)
    @level = hash.delete(:level) || hash.delete(:severity) || @level
    @tkey = hash.delete(:tkey)
    @attributes.merge!(hash)
    if @attributes[:description] == :translate
      @attributes.delete(:description)
      @attributes[:description] = _translate
    end
    msg = "#{_translate} (#{msg || self.class.name})"
    msg = "#{msg} {#{cause.message}}" if cause
  when String then
    msg = message
  when FalseClass, NilClass then
    msg = nil
  else
    msg = message
  end

  @fingerprint = [] unless @fingerprint.is_a?(Array)
  @tags = {} unless @tags.is_a?(Hash)
  msg = "{#{cause.message}}" if msg.blank? && cause
  super(msg)
end

#intentional? ⇒ Boolean

not logging in test

Returns:

  • (Boolean) 


117
118
119
120
121
 
# File 'lib/coaster/core_ext/standard_error.rb', line 117

def intentional? # not logging in test
  return attributes[:intentional] if attributes.key?(:intentional)
  return true if it_should_not_happen?
  self.class.intentional?
end

#it_might_happen? ⇒ Boolean

Returns:

  • (Boolean) 


110
 
# File 'lib/coaster/core_ext/standard_error.rb', line 110

def it_might_happen?;      attributes[:it] == :might_happen      end

#it_should_not_happen? ⇒ Boolean

Returns:

  • (Boolean) 


111
 
# File 'lib/coaster/core_ext/standard_error.rb', line 111

def it_should_not_happen?; attributes[:it] == :should_not_happen end

#just_logging ⇒ Object

options

:logger
:cleaner
:fingerprint
:tags
:level
:extra
:report
and others are merged to extra



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/coaster/core_ext/standard_error/raven.rb', line 64

def logging(options = {})
  before_logging_blocks.values.each { |blk| instance_exec &blk }

  if !report? || intentional?
    if defined?(Rails)
      return if Rails.env.test?
    else
      return
    end
  end

  logger = options[:logger] || Coaster.logger
  return unless logger

  cl = options[:cleaner] || cleaner
  msg = to_detail

  if cl && backtrace
    bt = cl.clean(backtrace)
    bt = bt[0..2] if intentional?
    msg += "\tBACKTRACE:\n\t"
    msg += bt.join("\n\t")
  end

  if level && logger.respond_to?(level)
    logger.send(level, msg)
  else
    logger.error(msg)
  end
  msg
ensure
  after_logging_blocks.values.each { |blk| instance_exec &blk }
end

#logging(options = {}) ⇒ Object 



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/coaster/core_ext/standard_error.rb', line 212

def logging(options = {})
  before_logging_blocks.values.each { |blk| instance_exec &blk }

  if !report? || intentional?
    if defined?(Rails)
      return if Rails.env.test?
    else
      return
    end
  end

  logger = options[:logger] || Coaster.logger
  return unless logger

  cl = options[:cleaner] || cleaner
  msg = to_detail

  if cl && backtrace
    bt = cl.clean(backtrace)
    bt = bt[0..2] if intentional?
    msg += "\tBACKTRACE:\n\t"
    msg += bt.join("\n\t")
  end

  if level && logger.respond_to?(level)
    logger.send(level, msg)
  else
    logger.error(msg)
  end
  msg
ensure
  after_logging_blocks.values.each { |blk| instance_exec &blk }
end

#notes(options = {}) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/coaster/core_ext/standard_error/raven.rb', line 26

def notes(options = {})
  opts = options ? options.dup : {}
  extra_opts = opts.slice!(:fingerprint, :tags, :level, :extra)
  opts[:extra] = extra_opts.merge(opts[:extra] || {})
  nt = raven.merge(opts)

  nt[:tags] ||= (tags && tags.merge(nt[:tags] || {})) || {}
  nt[:tags] = nt[:tags].merge(environment: Rails.env) if defined?(Rails)
  nt[:level] ||= self.level
  nt[:extra] = attributes.merge(nt[:extra])
  nt
end

#object ⇒ Object Also known as: obj 



122
 
# File 'lib/coaster/core_ext/standard_error.rb', line 122

def object;       attributes[:object] || attributes[:obj] end

#rails_tag ⇒ Object 



200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/coaster/core_ext/standard_error.rb', line 200

def rails_tag
  (fingerprint || Coaster.default_fingerprint).flatten.map do |fp|
    if fp == true || fp == :class
      self.class.name
    elsif fp == :default || fp == '{{ default }}'
      nil
    else
      fp
    end
  end.compact
end

#raven_fingerprint ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/coaster/core_ext/standard_error/raven.rb', line 14

def raven_fingerprint
  (fingerprint || Coaster.default_fingerprint).flatten.map do |fp|
    if fp == true || fp == :class
      self.class.name
    elsif fp == :default
      '{{ default }}'
    else
      fp
    end
  end.flatten
end

#report? ⇒ Boolean

Returns:

  • (Boolean) 


112
113
114
115
116
 
# File 'lib/coaster/core_ext/standard_error.rb', line 112

def report?
  return attributes[:report] if attributes.key?(:report)
  return false if it_might_happen?
  self.class.report?
end

#root_cause ⇒ Object 



93
 
# File 'lib/coaster/core_ext/standard_error.rb', line 93

def root_cause;   cause.respond_to?(:root_cause) ? cause.root_cause : self end

#safe_message ⇒ Object 



89
 
# File 'lib/coaster/core_ext/standard_error.rb', line 89

def safe_message; message || '' end

#status ⇒ Object 



90
 
# File 'lib/coaster/core_ext/standard_error.rb', line 90

def status;       self.class.status end

#title ⇒ Object 



109
 
# File 'lib/coaster/core_ext/standard_error.rb', line 109

def title;        attributes[:title] || self.class.title end

#to_detail ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/coaster/core_ext/standard_error.rb', line 172

def to_detail
  lg = "[#{self.class.name}] status:#{status}"
  lg += "\n\tMESSAGE: #{safe_message.gsub(/\n/, "\n\t\t")}"
  instance_variables.each do |var|
    if var.to_s.start_with?('@_') || var.to_s == '@coaster'
      next
    elsif var.to_s == '@spell_checker'
      next
    else
      val = instance_variable_get(var)
      val = to_log_detail_value.call(val) rescue val.to_s
      lg += "\n\t#{var}: #{val}"
    end
  end
  if cause
    if cause.respond_to?(:to_detail)
      lg += "\n\tCAUSE: "
      lg += cause.to_detail.strip.gsub(/\n/, "\n\t")
    else
      lg += "\n\tCAUSE: #{cause.class.name}: #{cause.message.gsub(/\n/, "\n\t\t")}"
    end
    if cause_cleaner && cause.backtrace
      lg += cause_cleaner.clean(cause.backtrace).join("\n\t\t")
    end
  end
  lg << "\n"
end

#to_hash ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/coaster/core_ext/standard_error.rb', line 153

def to_hash
  hash = attributes.merge(
    type: self.class.name, status: status,
    http_status: http_status, message: message
  )
  if cause
    if cause.respond_to?(:to_hash)
      hash[:cause] = cause.to_hash
    else
      hash[:cause] = cause
    end
  end
  hash
end

#to_json ⇒ Object 



168
169
170
 
# File 'lib/coaster/core_ext/standard_error.rb', line 168

def to_json
  Oj.dump(to_hash.with_indifferent_access, mode: :compat)
end

#user_message ⇒ Object

user friendly message, for overid



140
141
142
143
144
 
# File 'lib/coaster/core_ext/standard_error.rb', line 140

def user_message
  return _translate if description.present? || tkey.present?
  return "#{_translate} (#{message})" unless defined?(@coaster)
  message
end