Module: AppMap::Util

Defined in:
lib/appmap/util.rb

Constant Summary collapse

CLEAR =

https://wynnnetherland.com/journal/a-stylesheet-author-s-guide-to-terminal-colors/ Embed in a String to clear all previous ANSI sequences.

"\e[0m"
BOLD = 
"\e[1m"
BLACK =

Colors

"\e[30m"
RED = 
"\e[31m"
GREEN = 
"\e[32m"
YELLOW = 
"\e[33m"
BLUE = 
"\e[34m"
MAGENTA = 
"\e[35m"
CYAN = 
"\e[36m"
WHITE = 
"\e[37m"

Class Method Summary collapse

Class Method Details

.blank?(obj) ⇒ Boolean

Returns:

  • (Boolean) 


222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/appmap/util.rb', line 222

def blank?(obj)
  return true if obj.nil?
  
  return true if obj.is_a?(String) && obj == ''

  return true if obj.respond_to?(:length) && obj.length == 0

  return true if obj.respond_to?(:size) && obj.size == 0

  false
end

.classify(word) ⇒ Object 



201
202
203
 
# File 'lib/appmap/util.rb', line 201

def classify(word)
  word.split(/[\-_]/).map(&:capitalize).join
end

.color(text, color, bold: false) ⇒ Object 



195
196
197
198
199
 
# File 'lib/appmap/util.rb', line 195

def color(text, color, bold: false)
  color = Util.const_get(color.to_s.upcase) if color.is_a?(Symbol)
  bold  = bold ? BOLD : ""
  "#{bold}#{color}#{text}#{CLEAR}"
end

.deep_dup(hash) ⇒ Object 



217
218
219
220
 
# File 'lib/appmap/util.rb', line 217

def deep_dup(hash)
  require 'active_support/core_ext'
  hash.deep_dup
end

.extract_test_failure(exception) ⇒ Object 



160
161
162
163
164
165
166
167
 
# File 'lib/appmap/util.rb', line 160

def extract_test_failure(exception)
  return unless exception

  { message: exception.message }.tap do |test_failure|
    first_location = exception.backtrace_locations&.find { |location| !Pathname.new(normalize_path(location.absolute_path)).absolute? }
    test_failure[:location] = [ normalize_path(first_location.path), first_location.lineno ].join(':') if first_location
  end
end

.format_exception(exception) ⇒ Object 



153
154
155
156
157
158
 
# File 'lib/appmap/util.rb', line 153

def format_exception(exception)
  {
    class: exception.class.name,
    message: AppMap::Event::MethodEvent.display_string(exception.to_s),
  }
end

.gettime ⇒ Object 



257
258
259
 
# File 'lib/appmap/util.rb', line 257

def gettime
  Process.clock_gettime Process::CLOCK_MONOTONIC
end

.normalize_path(path) ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/appmap/util.rb', line 141

def normalize_path(path)
  is_local_path    = -> { path.index(Dir.pwd) == 0 }
  is_bundled_path  = -> { path.index(Bundler.bundle_path.to_s) == 0 }
  is_vendored_path = -> { path.index(File.join(Dir.pwd, 'vendor/bundle')) == 0 }

  if is_local_path.() && !is_bundled_path.() && !is_vendored_path.()
    path[Dir.pwd.length + 1..-1]
  else
    path
  end
end

.parse_function_name(name) ⇒ Object 



24
25
26
27
28
29
30
31
32
 
# File 'lib/appmap/util.rb', line 24

def parse_function_name(name)
  package_tokens = name.split('/')

  class_and_name = package_tokens.pop
  class_name, function_name, static = class_and_name.include?('.') ? class_and_name.split('.', 2) + [ true ] : class_and_name.split('#', 2) + [ false ]

  raise "Malformed fully-qualified function name #{name}" unless function_name
  [ package_tokens.empty? ? 'ruby' : package_tokens.join('/'), class_name, static, function_name ]
end

.ruby_minor_version ⇒ Object 



253
254
255
 
# File 'lib/appmap/util.rb', line 253

def ruby_minor_version
  @ruby_minor_version ||= RUBY_VERSION.split('.')[0..1].join('.').to_f
end

.sanitize_event(event, &block) ⇒ Object

sanitize_event removes ephemeral values from an event, making events easier to compare across runs.



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
 
# File 'lib/appmap/util.rb', line 86

def sanitize_event(event, &block)
  event.delete(:thread_id)
  event.delete(:elapsed)
  event.delete(:elapsed_instrumentation)
  delete_object_id = ->(obj) { (obj || {}).delete(:object_id) }
  delete_object_id.call(event[:receiver])
  delete_object_id.call(event[:return_value])
  i[parameters exceptions message].each do |field|
    (event[field] || []).each(&delete_object_id)
  end
  i[http_client_request http_client_response http_server_request http_server_response].each do |field|
    headers = event.dig(field, :headers)
    next unless headers

    headers['Date'] = '<instanceof date>' if headers['Date']
    headers['Server'] = headers['Server'].match(/^(\w+)/)[0] if headers['Server']
  end

  case event[:event]
  when :call
    sanitize_paths(event)
  end

  event
end

.sanitize_paths(h) ⇒ Object

sanitize_paths removes ephemeral values from objects with embedded paths (e.g. an event or a classmap), making events easier to compare across runs.



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/appmap/util.rb', line 70

def sanitize_paths(h)
  require 'hashie'
  h.extend(Hashie::Extensions::DeepLocate)
  keys = i(path location)
  h.deep_locate ->(k,v,o) {
    next unless keys.include?(k)
    
    fix = ->(v) {v.gsub(%r{#{Gem.dir}/gems/.*(?=lib)}, '')}
    keys.each {|k| o[k] = fix.(o[k]) if o[k] }
  }

  h
end

.scenario_filename(name, max_length: 255, separator: '_', extension: '.appmap.json') ⇒ Object

scenario_filename builds a suitable file name from a scenario name. Special characters are removed, and the file name is truncated to fit within shell limitations.



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
 
# File 'lib/appmap/util.rb', line 37

def scenario_filename(name, max_length: 255, separator: '_', extension: '.appmap.json')
  # Cribbed from v5 version of ActiveSupport:Inflector#parameterize:
  # https://github.com/rails/rails/blob/v5.2.4/activesupport/lib/active_support/inflector/transliterate.rb#L92
  # Replace accented chars with their ASCII equivalents.

  fname = name.encode('utf-8', invalid: :replace, undef: :replace, replace: '_')

  # Turn unwanted chars into the separator.
  fname.gsub!(/[^a-z0-9\-_]+/i, separator)

  re_sep = Regexp.escape(separator)
  re_duplicate_separator        = /#{re_sep}{2,}/
  re_leading_trailing_separator = /^#{re_sep}|#{re_sep}$/i

  # No more than one of the separator in a row.
  fname.gsub!(re_duplicate_separator, separator)

  # Finally, Remove leading/trailing separator.
  fname.gsub!(re_leading_trailing_separator, '')

  if (fname.length + extension.length) > max_length
    require 'base64'
    require 'digest'
    fname_digest = Base64.urlsafe_encode64 Digest::MD5.digest(fname), padding: false
    fname[max_length - fname_digest.length - extension.length - 1..-1] = [ '-', fname_digest ].join
  end

  [ fname, extension ].join
end

.select_rack_headers(env) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/appmap/util.rb', line 112

def select_rack_headers(env)
  finalize_headers = lambda do |headers|
    blank?(headers) ? nil : headers
  end

  if !env['rack.version']
    warn "Request headers does not contain rack.version. HTTP_ prefix is not expected."
    return finalize_headers.call(env.dup)
  end

  # Rack prepends HTTP_ to all client-sent headers (except Content-Type and Content-Length?).
  # Apparently, it's following the CGI spec in doing so.
  # https://datatracker.ietf.org/doc/html/rfc3875#section-4.1.18
  matching_headers = env
    .select { |k,v| k.to_s.start_with? 'HTTP_' }
    .merge(
      'CONTENT_TYPE' => env['CONTENT_TYPE'],
      'CONTENT_LENGTH' => env['CONTENT_LENGTH'],
      'AUTHORIZATION' => env['AUTHORIZATION']
    )
    .reject { |k,v| blank?(v) }
    .each_with_object({}) do |kv, memo|
      key = kv[0].sub(/^HTTP_/, '').split('_').map(&:capitalize).join('-')
      value = kv[1]
      memo[key] = value
    end
  finalize_headers.call(matching_headers)
end

.startup_message(msg) ⇒ Object 



243
244
245
246
247
248
249
250
251
 
# File 'lib/appmap/util.rb', line 243

def startup_message(msg)
  if defined?(::Rails) && defined?(::Rails.logger) && ::Rails.logger
    ::Rails.logger.info msg
  elsif ENV['DEBUG'] == 'true'
    warn msg
  end

  nil
end

.swaggerize_path(path) ⇒ Object

Convert a Rails-style path from /org/:org_id(.:format) to Swagger-style paths like /org/org_id



171
172
173
174
175
176
177
178
 
# File 'lib/appmap/util.rb', line 171

def swaggerize_path(path)
  path = path.split('(.')[0]
  tokens = path.split('/')
  tokens.map do |token|
    # stop matching if an ending ) is found
    token.gsub(/^:(.*[^\)])/, '{\1}')
  end.join('/')
end

.try(obj, *methods) ⇒ Object

https://github.com/rails/rails/blob/8cd143900978902ed9bbba10b34099a3140de5c6/activesupport/lib/active_support/core_ext/object/try.rb



235
236
237
238
239
240
241
 
# File 'lib/appmap/util.rb', line 235

def try(obj, *methods)
  return nil if methods.empty?

  return nil unless obj.respond_to?(methods.first)

  obj.public_send(*methods)
end

.underscore(camel_cased_word) ⇒ Object

https://api.rubyonrails.org/v6.1.3.2/classes/ActiveSupport/Inflector.html#method-i-underscore



206
207
208
209
210
211
212
213
214
215
 
# File 'lib/appmap/util.rb', line 206

def underscore(camel_cased_word)
  return camel_cased_word unless /[A-Z-]|::/.match?(camel_cased_word)
  word = camel_cased_word.to_s.gsub("::", "/")
  # word.gsub!(inflections.acronyms_underscore_regex) { "#{$1 && '_' }#{$2.downcase}" }
  word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
  word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
  word.tr!("-", "_")
  word.downcase!
  word
end

.write_appmap(filename, appmap) ⇒ Object

Atomically writes AppMap data to filename.



181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/appmap/util.rb', line 181

def write_appmap(filename, appmap)
  require 'tmpdir'

  # This is what Ruby Tempfile does; but we don't want the file to be unlinked.
  mode = File::RDWR | File::CREAT | File::EXCL
  ::Dir::Tmpname.create([ 'appmap_', '.json' ]) do |tmpname|
    tempfile = File.open(tmpname, mode)
    tempfile.write(JSON.generate(appmap))
    tempfile.close
    # Atomically move the tempfile into place.
    FileUtils.mv tempfile.path, filename
  end
end