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

Constant Summary collapse

DEFAULT_INSPECTION_VARS = 
i[@attributes @tkey @fingerprint @tags @level]
DEFAULT_INSPECTION_VALUE_PROC = 
Proc.new{|val| val.inspect}

Class Attribute Summary collapse

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.



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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/coaster/core_ext/standard_error.rb', line 61

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

  case message
  when StandardError
    @fingerprint = [message.fingerprint, @fingerprint].flatten.compact.uniq
    @tags = @tags.merge(message.tags || {})
    @level = message.level
    @tkey = message.tkey
    @attributes = @attributes.merge(message.attributes || {})
    msg = message
  when Exception
    msg = message
  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{#{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)
  set_backtrace(msg.backtrace) if msg.is_a?(Exception)
  @fingerprint << digest_message
  @fingerprint << digest_backtrace
  @fingerprint.compact!
  self
end

Class Attribute Details

.inspection_value_proc ⇒ Object 



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

def inspection_value_proc; @inspection_value_proc ||= superclass.respond_to?(:inspection_value_proc) ? superclass.inspection_value_proc : DEFAULT_INSPECTION_VALUE_PROC end

Instance Attribute Details

#fingerprint ⇒ Object

Returns the value of attribute fingerprint.



59
60
61
 
# File 'lib/coaster/core_ext/standard_error.rb', line 59

def fingerprint
  @fingerprint
end

#level ⇒ Object

Returns the value of attribute level.



59
60
61
 
# File 'lib/coaster/core_ext/standard_error.rb', line 59

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.



59
60
61
 
# File 'lib/coaster/core_ext/standard_error.rb', line 59

def tags
  @tags
end

#tkey ⇒ Object

Returns the value of attribute tkey.



59
60
61
 
# File 'lib/coaster/core_ext/standard_error.rb', line 59

def tkey
  @tkey
end

Class Method Details

.after_logging(name, &block) ⇒ Object 



49
50
51
52
 
# File 'lib/coaster/core_ext/standard_error.rb', line 49

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

.after_logging_blocks ⇒ Object 



53
54
55
56
 
# File 'lib/coaster/core_ext/standard_error.rb', line 53

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 



40
41
42
43
 
# File 'lib/coaster/core_ext/standard_error.rb', line 40

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

.before_logging_blocks ⇒ Object 



44
45
46
47
 
# File 'lib/coaster/core_ext/standard_error.rb', line 44

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

.code ⇒ Object

Unknown



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

def status; 999999 end

.http_status ⇒ Object 



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

def http_status;  500 end

.inspection_value_simple(val) ⇒ Object 



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

def inspection_value_simple(val)
  case val
  when Array then val.map{|v| inspection_value_simple(v)}
  when Hash then Hash[val.map{|k,v| [k, inspection_value_simple(v)]}]
  when String, Numeric, TrueClass, FalseClass then val
  else val.class.name
  end
end

.inspection_vars ⇒ Object 



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

def inspection_vars; @inspection_vars ||= DEFAULT_INSPECTION_VARS.dup end

.intentional? ⇒ Boolean

Returns:

  • (Boolean) 


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

def intentional?; false end

.report? ⇒ Boolean

Returns:

  • (Boolean) 


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

def report?;      true end

.status ⇒ Object

Unknown



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

def status; 999999 end

.title ⇒ Object 



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

def title; _translate('.title') end

.user_digests_with!(&block) ⇒ Object 



32
33
34
 
# File 'lib/coaster/core_ext/standard_error.rb', line 32

def user_digests_with!(&block)
  define_method(:user_digests, &block)
end

.user_digests_with_default! ⇒ Object 



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

def user_digests_with_default!
  define_method(:user_digests) { _user_digests }
end

Instance Method Details

#_translate(*args) ⇒ Object 



174
175
176
177
 
# File 'lib/coaster/core_ext/standard_error.rb', line 174

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

#_translate_params ⇒ Object 



179
180
181
 
# File 'lib/coaster/core_ext/standard_error.rb', line 179

def _translate_params
  attributes
end

#_user_digests ⇒ Object Also known as: user_digests 



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

def _user_digests; "#{[digest_message, digest_backtrace].compact.join(' ')}" end

#after_logging_blocks ⇒ Object 



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

def after_logging_blocks; self.class.after_logging_blocks end

#attributes ⇒ Object Also known as: attr 



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

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 



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

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

#cleaned_backtrace(options = {}) ⇒ Object 



308
309
310
311
312
313
314
315
 
# File 'lib/coaster/core_ext/standard_error.rb', line 308

def cleaned_backtrace(options = {})
  return unless backtrace
  cl = options[:cleaner] || cleaner
  return backtrace unless cl
  bt = cl.clean(backtrace)
  bt = bt[0..2] if intentional?
  bt
end

#code ⇒ Object 



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

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

#code=(value) ⇒ Object 



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

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.



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

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

#descriptions ⇒ Object

another user friendly messages



193
194
195
196
197
 
# File 'lib/coaster/core_ext/standard_error.rb', line 193

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

#detail ⇒ Object 



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

def detail;       attributes[:detail] end

#digest_backtrace ⇒ Object 



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

def digest_backtrace; @digest_backtrace ||= backtrace ? Digest::MD5.hexdigest(cleaned_backtrace.join("\n"))[0...8] : nil end

#digest_message ⇒ Object 



123
124
125
126
127
128
129
 
# File 'lib/coaster/core_ext/standard_error.rb', line 123

def digest_message
  m = message.to_s.dup
  mat = m.match(/#<.*0x(?<object_id>\S+)>/)
  m = message.gsub(/#{mat[:object_id]}/, 'XXXXXXX') if mat
  m = "#{self.class.name} #{m}"
  @digest_message ||= Digest::MD5.hexdigest(m)[0...6]
end

#http_status ⇒ Object 



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

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

#http_status=(value) ⇒ Object 



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

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
55
56
57
58
59
60
61
62
63
 
# 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
  @tkey = nil
  if cause && cause.is_a?(StandardError)
    @fingerprint = cause.fingerprint.dup
    @tags = cause.tags.dup
    @level = cause.level
    @tkey = cause.tkey
    @attributes = cause.attributes.dup
  end

  case message
  when StandardError
    @fingerprint = [message.fingerprint, @fingerprint].flatten.compact.uniq
    @tags = @tags.merge(message.tags || {})
    @level = message.level
    @tkey = message.tkey
    @attributes = @attributes.merge(message.attributes || {})
    msg = message
  when Exception
    msg = message
  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{#{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)
  set_backtrace(msg.backtrace) if msg.is_a?(Exception)
  @fingerprint << digest_message
  @fingerprint << digest_backtrace
  @fingerprint.compact!
  self
end

#inspection_value_proc ⇒ Object 



223
224
225
 
# File 'lib/coaster/core_ext/standard_error.rb', line 223

def inspection_value_proc
  attributes[:inspection_value_proc] || self.class.inspection_value_proc
end

#inspection_vars ⇒ Object 



219
220
221
 
# File 'lib/coaster/core_ext/standard_error.rb', line 219

def inspection_vars
  (self.class.inspection_vars + (attributes[:inspection_vars] || [])).map(&:to_sym).compact.uniq
end

#intentional? ⇒ Boolean

not logging in test

Returns:

  • (Boolean) 


161
162
163
164
165
 
# File 'lib/coaster/core_ext/standard_error.rb', line 161

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) 


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

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

#it_should_not_happen? ⇒ Boolean

Returns:

  • (Boolean) 


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

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
 
# 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

  msg = to_inspection_s(options: options)

  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 



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/coaster/core_ext/standard_error.rb', line 317

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

  msg = to_inspection_s(options: options)

  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 



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

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

#rails_tag ⇒ Object 



296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/coaster/core_ext/standard_error.rb', line 296

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) 


156
157
158
159
160
 
# File 'lib/coaster/core_ext/standard_error.rb', line 156

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

#root_cause ⇒ Object 



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

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

#safe_message ⇒ Object 



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

def safe_message; message || '' end

#status ⇒ Object 



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

def status;       self.class.status end

#title ⇒ Object 



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

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

#to_hash(_h: {}.with_indifferent_access, _depth: 0) ⇒ Object 



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

def to_hash(_h: {}.with_indifferent_access, _depth: 0)
  _h.merge!(attributes)
  _h.merge!(
    type: self.class.name, status: status,
    http_status: http_status, message: message
  )
  if _depth < 4 && cause
    if cause.respond_to?(:to_hash)
      _h[:cause] = cause.to_hash(_depth: _depth + 1)
    else
      _h[:cause_object] = cause
    end
  end
  _h
end

#to_inspection_hash(options: {}, _h: {}.with_indifferent_access, _depth: 0) ⇒ Object 



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/coaster/core_ext/standard_error.rb', line 227

def to_inspection_hash(options: {}, _h: {}.with_indifferent_access, _depth: 0)
  _h.merge!(
    type: self.class.name, status: status,
    http_status: http_status, message: message,
    instance_variables: {}.with_indifferent_access
  )
  instance_variables.sort.each do |var|
    if inspection_vars.include?(var)
      val = instance_variable_get(var)
      val = inspection_value_proc.call(val) rescue val.to_s
      _h[:instance_variables][var] = val
    elsif var.to_s.start_with?('@__')
      next
    else
      val = instance_variable_get(var)
      _h[:instance_variables][var] = self.class.inspection_value_simple(val)
    end
  end
  if backtrace.present?
    if respond_to?(:cleaned_backtrace)
      if (bt = cleaned_backtrace(options))
        _h[:backtrace] = bt
      else
        _h[:backtrace] = backtrace[0...ActiveSupport::BacktraceCleaner.minimum_first]
      end
    else
      _h[:backtrace] = backtrace[0...ActiveSupport::BacktraceCleaner.minimum_first]
    end
  end
  if cause
    if _depth < 4
      if cause.respond_to?(:to_inspection_hash)
        _h[:cause] = cause.to_inspection_hash(options: options, _depth: _depth + 1)
      else
        cause_h = {
          type: self.class.name, status: status,
          http_status: http_status, message: message,
        }
        cause_h.merge!(backtrace: cause.backtrace[0...ActiveSupport::BacktraceCleaner.minimum_first])
        _h[:cause] = cause_h
      end
    else
      _h[:cause] = 'and more causes...'
    end
  end
  _h
end

#to_inspection_s(options: {}, _dh: nil) ⇒ Object Also known as: to_detail 



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/coaster/core_ext/standard_error.rb', line 275

def to_inspection_s(options: {}, _dh: nil)
  dh = _dh || to_inspection_hash(options: options, _h: {}.with_indifferent_access, _depth: 0)
  lg = "[#{dh[:type]}] status:#{dh[:status]}"
  lg += "\n  MESSAGE: #{dh[:message]&.gsub(/\n/, "\n    ")}"
  dh[:instance_variables].each do |var, val|
    lg += "\n  #{var}: #{val}"
  end
  if (bt = dh[:backtrace] || [])
    lg += "\n  BACKTRACE:\n    "
    lg += bt.join("\n    ")
  end
  if dh[:cause].is_a?(Hash)
    lg += "\n  CAUSE: "
    lg += to_inspection_s(options: options, _dh: dh[:cause]).strip.gsub(/\n/, "\n  ")
  elsif dh[:cause].is_a?(String)
    lg += dh[:cause]
  end
  lg << "\n"
end

#to_json ⇒ Object 



215
216
217
 
# File 'lib/coaster/core_ext/standard_error.rb', line 215

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

#user_message ⇒ Object

user friendly message, for overid



184
185
186
187
188
189
190
 
# File 'lib/coaster/core_ext/standard_error.rb', line 184

def user_message
  return _translate if description.present? || tkey.present?
  return "#{_translate} (#{user_digests})" unless defined?(@coaster)
  message
rescue => e
  "#{message} (user_message_error - #{e.class.name} #{e.message})"
end