Upgrade to Pro — share decks privately, control downloads, hide ads and more …

RubyDay 2015: Deep Diving: How to Explore a New...

RubyDay 2015: Deep Diving: How to Explore a New Code Base

As a developer, diving in a new code base is not uncommon: you've just been hired, you change of project, you want to help an open source project, the open source library your project depends on is buggy, etc. It's like entering in a underwater cave, you don't know the treasures or the monsters you'll find there, neither if the path is treacherous or if it's a true labyrinth where you'll get lost. You can prepare yourself, you can plan your visit, you can equip yourself, you can survive and find the gem you're looking for...

Christophe Philemotte

November 13, 2015
Tweet

More Decks by Christophe Philemotte

Other Decks in Programming

Transcript

  1. • 300 dev days • 14633 LOC • 634595 Changed

    lines • → 634595 / 14633 ~ 43 changed LOC / LOC
  2. Plan 1. Goal 2. Map 3. Equipment & Dive 4.

    Next? Peter Southwood © 20011
  3. ➔ fix a bug ➔ implement a feature ➔ write

    some doc ➔ style the code ➔ refactor a small piece of code ➔ simply use it
  4. ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/net/http.rb:878:in `initialize': Connection refused - connect(2) (Errno::ECONNREFUSED) from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/net/http.rb:878:in `open'

    from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/net/http.rb:878:in `block in connect' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/timeout.rb:52:in `timeout' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/net/http.rb:877:in `connect' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/net/http.rb:862:in `do_start' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/net/http.rb:851:in `start' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/open-uri.rb:313:in `open_http' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/open-uri.rb:708:in `buffer_open' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/open-uri.rb:210:in `block in open_loo from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/open-uri.rb:208:in `catch' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/open-uri.rb:208:in `open_loop' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/open-uri.rb:149:in `open_uri' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/open-uri.rb:688:in `open' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/open-uri.rb:34:in `open' from -e:1:in `<main>'
  5. Find the Legend ➔ CONTRIBUTING Guideline ➔ Directory Structure ➔

    Talk to other contributors, maintainers ➔ Participate to the dev meeting
  6. Get a Toolbelt ➔ ST3 ➔ Apply a Patch &

    Use it ➔ MRI WIKI DeveloperHowto ➔ Sign up to Ruby Redmine
  7. $ wc -l *.rb 1001 common.rb 257 ftp.rb 1676 generic.rb

    106 http.rb 22 https.rb 260 ldap.rb 20 ldaps.rb 280 mailto.rb 3622 total open-uri
  8. ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/net/http.rb:878:in `initialize': Connection refused - connect(2) (Errno::ECONNREFUSED) from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/net/http.rb:878:in `open'

    from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/net/http.rb:878:in `block in connect' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/timeout.rb:52:in `timeout' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/net/http.rb:877:in `connect' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/net/http.rb:862:in `do_start' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/net/http.rb:851:in `start' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/open-uri.rb:313:in `open_http' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/open-uri.rb:708:in `buffer_open' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/open-uri.rb:210:in `block in open_loo from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/open-uri.rb:208:in `catch' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/open-uri.rb:208:in `open_loop' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/open-uri.rb:149:in `open_uri' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/open-uri.rb:688:in `open' from ~/.rvm/rubies/ruby-2.0.0-p247/lib/ruby/2.0.0/open-uri.rb:34:in `open' from -e:1:in `<main>'
  9. def get_call_graph_on scope = {} trace = TracePoint.new(:call, :line) do

    |tp| case tp.event when :call then puts "#{tp.path}:#{tp.lineno} #{tp.defined_class}::#{tp.method_id} called from " \ "#{scope[:path]}:#{scope[:lineno]} #{scope[:class]}::#{scope[:method_id]}" when :line then scope = { event: :line, lineno: tp.lineno, path: tp.path, class: tp.defined_class, method_id: tp.method_id } end end trace.enable yield trace.disable end
  10. trace = TracePoint.new(:call, :line) do |tp| case tp.event when :call

    then puts "#{tp.path}:#{tp.lineno} ..." \ "#{scope[:path]}:#{scope[:lineno]} ..." # ... end end
  11. # ... when :line then scope = { event: :line,

    lineno: tp.lineno, path: tp.path, class: tp.defined_class, method_id: tp.method_id }
  12. +-Kernel::open +-#<Class:URI>::parse called from Kernel::open at 33 | \-URI::Parser::parse called

    from #<Class:URI>::parse at 747 | | +-URI::Parser::split called from URI::Parser::parse at 211 | | +-#<Class:URI>::scheme_list called from URI::Parser::parse at 213 | | +-#<Class:URI>::scheme_list called from URI::Parser::parse at 214 | | \-URI::HTTP::initialize called from URI::Parser::parse at 660 | | | \-URI::Generic::initialize called from URI::HTTP::initialize at 84 | | | | +-URI::Generic::set_scheme called from URI::Generic::initialize at 203 | | | | +-URI::Generic::set_userinfo called from URI::Generic::initialize at 204 | | | | | \-URI::Generic::split_userinfo called from URI::Generic::set_userinfo at 525 | | | | +-URI::Generic::set_host called from URI::Generic::initialize at 205 | | | | +-URI::Generic::set_port called from URI::Generic::initialize at 206 | | | | +-URI::Generic::set_path called from URI::Generic::initialize at 207 | | | | +-URI::Generic::set_query called from URI::Generic::initialize at 208 | | | | +-URI::Generic::set_opaque called from URI::Generic::initialize at 209 | | | | +-URI::Generic::set_registry called from URI::Generic::initialize at 210 | | | | +-URI::Generic::set_fragment called from URI::Generic::initialize at 211 | | | | +-URI::Generic::default_port called from URI::Generic::initialize at 220 | | | | | \-#<Class:URI::Generic>::default_port called from URI::Generic::default_port at | | | | +-URI::Generic::default_port called from URI::Generic::initialize at 220 | | | | | \-#<Class:URI::Generic>::default_port called from URI::Generic::default_port at | | | | \-URI::Generic::set_port called from URI::Generic::initialize at 30
  13. +-Kernel::open +-#<Class:URI>::parse called from Kernel::open at 33 | \-URI::Parser::parse called

    from #<Class:URI>::parse at 747 | | +-URI::Parser::split called from URI::Parser::parse at 211 | | +-#<Class:URI>::scheme_list called from URI::Parser::parse at 213 | | +-#<Class:URI>::scheme_list called from URI::Parser::parse at 214 | | \-URI::HTTP::initialize called from URI::Parser::parse at 660 | | | \-URI::Generic::initialize called from URI::HTTP::initialize at 84 | | | | +-URI::Generic::set_scheme called from URI::Generic::initialize at 203 | | | | +-URI::Generic::set_userinfo called from URI::Generic::initialize at 204 | | | | | \-URI::Generic::split_userinfo called from URI::Generic::set_userinfo at 525 | | | | +-URI::Generic::set_host called from URI::Generic::initialize at 205 | | | | +-URI::Generic::set_port called from URI::Generic::initialize at 206 | | | | +-URI::Generic::set_path called from URI::Generic::initialize at 207 | | | | +-URI::Generic::set_query called from URI::Generic::initialize at 208 | | | | +-URI::Generic::set_opaque called from URI::Generic::initialize at 209 | | | | +-URI::Generic::set_registry called from URI::Generic::initialize at 210 | | | | +-URI::Generic::set_fragment called from URI::Generic::initialize at 211 | | | | +-URI::Generic::default_port called from URI::Generic::initialize at 220 | | | | | \-#<Class:URI::Generic>::default_port called from URI::Generic::default_port at | | | | +-URI::Generic::default_port called from URI::Generic::initialize at 220 | | | | | \-#<Class:URI::Generic>::default_port called from URI::Generic::default_port at | | | | \-URI::Generic::set_port called from URI::Generic::initialize at 30
  14. +-Kernel::open +-#<Class:URI>::parse called from Kernel::open at 33 | \-URI::Parser::parse called

    from #<Class:URI>::parse at 747 | | +-URI::Parser::split called from URI::Parser::parse at 211 | | +-#<Class:URI>::scheme_list called from URI::Parser::parse at 213 | | +-#<Class:URI>::scheme_list called from URI::Parser::parse at 214 | | \-URI::HTTP::initialize called from URI::Parser::parse at 660 | | | \-URI::Generic::initialize called from URI::HTTP::initialize at 84 | | | | +-URI::Generic::set_scheme called from URI::Generic::initialize at 203 | | | | +-URI::Generic::set_userinfo called from URI::Generic::initialize at 204 | | | | | \-URI::Generic::split_userinfo called from URI::Generic::set_userinfo at 525 | | | | +-URI::Generic::set_host called from URI::Generic::initialize at 205 | | | | +-URI::Generic::set_port called from URI::Generic::initialize at 206 | | | | +-URI::Generic::set_path called from URI::Generic::initialize at 207 | | | | +-URI::Generic::set_query called from URI::Generic::initialize at 208 | | | | +-URI::Generic::set_opaque called from URI::Generic::initialize at 209 | | | | +-URI::Generic::set_registry called from URI::Generic::initialize at 210 | | | | +-URI::Generic::set_fragment called from URI::Generic::initialize at 211 | | | | +-URI::Generic::default_port called from URI::Generic::initialize at 220 | | | | | \-#<Class:URI::Generic>::default_port called from URI::Generic::default_port at | | | | +-URI::Generic::default_port called from URI::Generic::initialize at 220 | | | | | \-#<Class:URI::Generic>::default_port called from URI::Generic::default_port at | | | | \-URI::Generic::set_port called from URI::Generic::initialize at 30
  15. \-OpenURI::OpenRead::open called from Kernel::open at 34 | \-#<Class:OpenURI>::open_uri called from

    OpenURI::OpenRead::open at 688 | | +-#<Class:OpenURI>::scan_open_optional_arguments called from #<Class:OpenURI>::open_ur | | +-#<Class:OpenURI>::check_options called from #<Class:OpenURI>::open_uri at 136 | | \-#<Class:OpenURI>::open_loop called from #<Class:OpenURI>::open_uri at 149 | | | +-OpenURI::Buffer::initialize called from #<Class:OpenURI>::open_loop at 209 | | | +-URI::HTTP::buffer_open called from #<Class:OpenURI>::open_loop at 195 | | | | \-#<Class:OpenURI>::open_http called from URI::HTTP::buffer_open at 708 | | | | | +-URI::Generic::userinfo called from #<Class:OpenURI>::open_http at 259 | | | | | +-Kernel::require called from #<Class:OpenURI>::open_http at 267 | | | | | | +-MonitorMixin::mon_enter called from Kernel::require at 39 | | | | | | +-#<Class:Gem>::find_unresolved_default_spec called from Kernel::require at 43 | | | | | | | \-#<Class:Gem>::suffixes called from #<Class:Gem>::find_unresolved_default_s | | | | | | +-#<Class:Gem::Specification>::unresolved_deps called from Kernel::require at | | | | | | +-#<Class:Gem::Specification>::stubs called from Kernel::require at 63 | | | | | | +-Gem::StubSpecification::activated? called from Kernel::require at 64 | | | | | | | \-Gem::StubSpecification::name called from Gem::StubSpecification::activated | | | | | | +-Gem::StubSpecification::activated? called from Kernel::require at 64 | | | | | | | \-Gem::StubSpecification::name called from Gem::StubSpecification::activated | | | | | | +-Gem::StubSpecification::activated? called from Kernel::require at 64 | | | | | | | \-Gem::StubSpecification::name called from Gem::StubSpecification::activated | | | | | | +-Gem::StubSpecification::activated? called from Kernel::require at 64
  16. \-OpenURI::OpenRead::open called from Kernel::open at 34 | \-#<Class:OpenURI>::open_uri called from

    OpenURI::OpenRead::open at 688 | | +-#<Class:OpenURI>::scan_open_optional_arguments called from #<Class:OpenURI>::open_ur | | +-#<Class:OpenURI>::check_options called from #<Class:OpenURI>::open_uri at 136 | | \-#<Class:OpenURI>::open_loop called from #<Class:OpenURI>::open_uri at 149 | | | +-OpenURI::Buffer::initialize called from #<Class:OpenURI>::open_loop at 209 | | | +-URI::HTTP::buffer_open called from #<Class:OpenURI>::open_loop at 195 | | | | \-#<Class:OpenURI>::open_http called from URI::HTTP::buffer_open at 708 | | | | | +-URI::Generic::userinfo called from #<Class:OpenURI>::open_http at 259 | | | | | +-Kernel::require called from #<Class:OpenURI>::open_http at 267 | | | | | | +-MonitorMixin::mon_enter called from Kernel::require at 39 | | | | | | +-#<Class:Gem>::find_unresolved_default_spec called from Kernel::require at 43 | | | | | | | \-#<Class:Gem>::suffixes called from #<Class:Gem>::find_unresolved_default_s | | | | | | +-#<Class:Gem::Specification>::unresolved_deps called from Kernel::require at | | | | | | +-#<Class:Gem::Specification>::stubs called from Kernel::require at 63 | | | | | | +-Gem::StubSpecification::activated? called from Kernel::require at 64 | | | | | | | \-Gem::StubSpecification::name called from Gem::StubSpecification::activated | | | | | | +-Gem::StubSpecification::activated? called from Kernel::require at 64 | | | | | | | \-Gem::StubSpecification::name called from Gem::StubSpecification::activated | | | | | | +-Gem::StubSpecification::activated? called from Kernel::require at 64 | | | | | | | \-Gem::StubSpecification::name called from Gem::StubSpecification::activated | | | | | | +-Gem::StubSpecification::activated? called from Kernel::require at 64
  17. \-OpenURI::OpenRead::open called from Kernel::open at 34 | \-#<Class:OpenURI>::open_uri called from

    OpenURI::OpenRead::open at 688 | | +-#<Class:OpenURI>::scan_open_optional_arguments called from #<Class:OpenURI>::open_ur | | +-#<Class:OpenURI>::check_options called from #<Class:OpenURI>::open_uri at 136 | | \-#<Class:OpenURI>::open_loop called from #<Class:OpenURI>::open_uri at 149 | | | +-OpenURI::Buffer::initialize called from #<Class:OpenURI>::open_loop at 209 | | | +-URI::HTTP::buffer_open called from #<Class:OpenURI>::open_loop at 195 | | | | \-#<Class:OpenURI>::open_http called from URI::HTTP::buffer_open at 708 | | | | | +-URI::Generic::userinfo called from #<Class:OpenURI>::open_http at 259 | | | | | +-Kernel::require called from #<Class:OpenURI>::open_http at 267 | | | | | | +-MonitorMixin::mon_enter called from Kernel::require at 39 | | | | | | +-#<Class:Gem>::find_unresolved_default_spec called from Kernel::require at 43 | | | | | | | \-#<Class:Gem>::suffixes called from #<Class:Gem>::find_unresolved_default_s | | | | | | +-#<Class:Gem::Specification>::unresolved_deps called from Kernel::require at | | | | | | +-#<Class:Gem::Specification>::stubs called from Kernel::require at 63 | | | | | | +-Gem::StubSpecification::activated? called from Kernel::require at 64 | | | | | | | \-Gem::StubSpecification::name called from Gem::StubSpecification::activated | | | | | | +-Gem::StubSpecification::activated? called from Kernel::require at 64 | | | | | | | \-Gem::StubSpecification::name called from Gem::StubSpecification::activated | | | | | | +-Gem::StubSpecification::activated? called from Kernel::require at 64 | | | | | | | \-Gem::StubSpecification::name called from Gem::StubSpecification::activated | | | | | | +-Gem::StubSpecification::activated? called from Kernel::require at 64
  18. | | | | | +-URI::Generic::hostname called from #<Class:OpenURI>::open_http at

    278 | | | | | +-URI::HTTP::request_uri called from #<Class:OpenURI>::open_http at 280 | | | | | | \-URI::Generic::path_query called from URI::HTTP::request_uri at 96 | | | | | +-#<Class:Net::HTTP>::new called from #<Class:OpenURI>::open_http at 291 | | | | | | +-Net::HTTP::initialize called from #<Class:Net::HTTP>::new at 609 | | | | | | \-#<Class:Net::HTTP>::proxy_class? called from #<Class:Net::HTTP>::new at 611 | | | | | +-Net::HTTP::start called from #<Class:OpenURI>::open_http at 313 | | | | | | +-Net::HTTP::do_start called from Net::HTTP::start at 851 | | | | | | | \-Net::HTTP::connect called from Net::HTTP::do_start at 862 | | | | | | | | +-Net::HTTP::proxy? called from Net::HTTP::connect at 868 | | | | | | | | | \-Net::HTTP::proxy_uri called from Net::HTTP::proxy? at 1014 | | | | | | | | | | +-Kernel::URI called from Net::HTTP::proxy_uri at 1027 | | | | | | | | | | | \-#<Class:URI>::parse called from Kernel::URI at 994 | | | | | | | | | | | | \-URI::Parser::parse called from #<Class:URI>::parse at 747 | | | | | | | | | | | | | +-URI::Parser::split called from URI::Parser::parse at 211 | | | | | | | | | | | | | +-#<Class:URI>::scheme_list called from URI::Parser::parse at 21 | | | | | | | | | | | | | +-#<Class:URI>::scheme_list called from URI::Parser::parse at 21 | | | | | | | | | | | | | \-URI::HTTP::initialize called from URI::Parser::parse at 660 | | | | | | | | | | | | | | \-URI::Generic::initialize called from URI::HTTP::initialize a | | | | | | | | | | | | | | | +-URI::Generic::set_scheme called from URI::Generic::initial | | | | | | | | | | | | | | | +-URI::Generic::set_userinfo called from URI::Generic::initi
  19. Search the Source $ grep -nr "open_http". ./open-uri.rb:253: def OpenURI.open_http(buf,

    target, proxy, option ./open-uri.rb:708: OpenURI.open_http(buf, self, proxy, options) ./open-uri.rb:717: OpenURI.open_http(buf, self, proxy, option
  20. Search the Source $ grep -rn "class HTTP " .

    ./net/http.rb:384: class HTTP < Protocol ./uri/http.rb:22: class HTTP < Generic
  21. ➔ Trace the Calls ➔ Search the Source ➔ Get

    Context with a Test Dive into URI
  22. Get Context with a Test context "without params['markdown_img']" do it

    "returns an error" do TraceCalls::on do post :upload_image, id: project.to_param, format: :json end puts TraceCalls::root expect(response.status).to eq(422) end end
  23. Use your Toolbelt ➔ Run the App & Use it

    ➔ Read the Code ➔ Edit the Code
  24. Use your Toolbelt ➔ Run the App & Use it

    ➔ Read & Edit the Code ➔ Report a bug ➔ Submit a contribution
  25. Find Next Goal ➔ Fix a bug ➔ Develop a

    feature ➔ Run Static Analysis Tools ➔ Review a PullRequest