Class: Singed::CLI

Inherits:
Object
  • Object
show all
Defined in:
lib/singed/cli.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(argv) ⇒ CLI

Returns a new instance of CLI.



11
12
13
14
15
16
 
# File 'lib/singed/cli.rb', line 11

def initialize(argv)
  @argv = argv
  @opts = OptionParser.new

  parse_argv!
end

Instance Attribute Details

#argv ⇒ Object

Returns the value of attribute argv.



9
10
11
 
# File 'lib/singed/cli.rb', line 9

def argv
  @argv
end

#filename ⇒ Object

Returns the value of attribute filename.



9
10
11
 
# File 'lib/singed/cli.rb', line 9

def filename
  @filename
end

#opts ⇒ Object

Returns the value of attribute opts.



9
10
11
 
# File 'lib/singed/cli.rb', line 9

def opts
  @opts
end

Class Method Details

.chdir_rails_root ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/singed/cli.rb', line 150

def self.chdir_rails_root
  original_cwd = Dir.pwd

  loop do
    if File.file?('config/environment.rb')
      return Dir.pwd
    end

    if Pathname.new(Dir.pwd).root?
      Dir.chdir(original_cwd)
      return
    end

    # Otherwise keep moving upwards in search of an executable.
    Dir.chdir('..')
  end
end

Instance Method Details

#adjust_ownership! ⇒ Object 



123
124
125
 
# File 'lib/singed/cli.rb', line 123

def adjust_ownership!
  sudo ['chown', ENV['USER'], filename], reason: "Adjusting ownership of #{filename}, but need root."
end

#parse_argv! ⇒ Object 



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
 
# File 'lib/singed/cli.rb', line 18

def parse_argv!
  opts.banner = 'Usage: singed [options] <command>'

  opts.on('-h', '--help', 'Show this message') do
    @show_help = true
  end

  opts.on('-o', '--output-directory DIRECTORY', 'Directory to write flamegraph to') do |directory|
    @output_directory = directory
  end

  opts.order(@argv) do |arg|
    opts.terminate if arg == '--'
    break
  end

  if @argv.empty?
    @show_help = true
    @error_message = 'missing command to profile'
    return
  end

  return if @show_help

  begin
    @opts.parse!(argv)
  rescue OptionParser::InvalidOption => e
    @show_help = true
    @error_message = e
  end
end

#password_needed? ⇒ Boolean

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/singed/cli.rb', line 115

def password_needed?
  !system('sudo --non-interactive true >/dev/null 2>&1')
end

#prompt_password ⇒ Object 



119
120
121
 
# File 'lib/singed/cli.rb', line 119

def prompt_password
  system('sudo true')
end

#run ⇒ Object 



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
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
 
# File 'lib/singed/cli.rb', line 50

def run
  require 'singed'

  if @error_message
    puts @error_message
    puts
    puts @opts.help
    exit 1
  end

  if show_help?
    puts @opts.help
    exit 0
  end

  Singed.output_directory = @output_directory if @output_directory
  Singed.output_directory ||= Dir.tmpdir
  @filename = Singed::Flamegraph.generate_filename(label: 'cli')

  options = {
    format: 'speedscope',
    file: filename.to_s,
    silent: nil,
  }

  rbspy_args = [
    'record',
    *options.map { |k, v| ["--#{k}", v].compact }.flatten,
    '--',
    *argv,
  ]

  loop do
    break unless password_needed?

    puts '🔥📈 Singed needs to run as root, but will drop permissions back to your user. Prompting with sudo now...'
    prompt_password
  end

  Bundler.with_unbundled_env do
    # don't run things with spring, because it forks and rbspy won't see it
    sudo ['rbspy', *rbspy_args], reason: 'Singed needs to run as root, but will drop permissions back to your user.', env: { 'DISABLE_SPRING' => '1' }
  end

  unless filename.exist?
    puts "#{filename} doesn't exist. Maybe rbspy had a failure capturing it? Check the scrollback."
    exit 1
  end

  unless adjust_ownership!
    puts "#{filename} isn't writable!"
    exit 1
  end

  # clean the report, similar to how Singed::Report does
  json = JSON.parse(filename.read).with_indifferent_access
  json['shared']['frames'].each do |frame|
    frame[:file] = Singed.filter_line(frame[:file])
  end
  filename.write(JSON.dump(json))

  flamegraph = Singed::Flamegraph.new(filename: filename)
  flamegraph.open
end

#show_help? ⇒ Boolean

Returns:

  • (Boolean) 


127
128
129
 
# File 'lib/singed/cli.rb', line 127

def show_help?
  @show_help
end

#sudo(system_args, reason:, env: {}) ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/singed/cli.rb', line 131

def sudo(system_args, reason:, env: {})
  loop do
    break unless password_needed?

    puts "🔥📈 #{reason} Prompting with sudo now..."
    prompt_password
  end

  sudo_args = [
    'sudo',
    '--preserve-env',
    *system_args.map(&:to_s),
  ]

  puts "$ #{Shellwords.join(sudo_args)}"

  system(env, *sudo_args, exception: true)
end