Upgrading GitHub from Ruby 2.6 to 2.7

Transcript

1. UPGRADING GITHUB
   from Ruby 2.6 to 2.7
   a
   Eileen M. Uchitelle | @eileencodes
   

   View Slide

2. Hello! I’m
   Eileen M. Uchitelle
   Principal Engineer at GitHub
   Rails Core Team
   Find me: @eileencodes
   

   View Slide

3. UPGRADING GITHUB
   from Ruby 2.6 to 2.7
   Eileen M Uchitelle | @eileencodes
   a
   

   View Slide

4. GitHub
   is born
   2007 2008 2009
   Forked
   Rails
   & Ruby
   Public
   launch
   

   View Slide

5. a
   

   View Slide

6. a
   Why was this Ruby
   upgrade hard?
   

   View Slide

7. a Running GitHub
   Deprecation Free
   

   View Slide

8. a
   

   View Slide

9. a Over 11k deprecation
   warnings!
   

   View Slide

10. DEPRECATION:
    Separation of
    positional and
    keyword arguments
    

    View Slide

11. class MyClass
    def initialize(part_1:, part_2:)
    puts "#{part_1} #{part_2}"
    end
    end
    DEPRECATION: Separation of arguments
    

    View Slide

12. MyClass.new({
    part_1: "I work fine", part_2: "in Ruby 2.6"
    })
    => "I work fine in Ruby 2.6"
    DEPRECATION: Separation of arguments
    

    View Slide

13. MyClass.new({
    part_1: "I throw warnings", part_2: "in 2.7"
    })
    => "I throw warnings in 2.7"
    example.rb:13: warning: Using the last argument
    as keyword parameters is deprecated; maybe **
    should be added to the call
    example.rb:2: warning: The called method
    `initialize' is defined here
    DEPRECATION: Separation of arguments
    

    View Slide

14. DEPRECATION: Separation of arguments
    MyClass.new({
    part_1: "I throw warnings", part_2: "in 2.7"
    })
    => "I throw warnings in 2.7"
    example.rb:13: warning: Using the last argument
    as keyword parameters is deprecated; maybe **
    should be added to the call
    example.rb:2: warning: The called method
    `initialize' is defined here
    The Caller
    

    View Slide

15. DEPRECATION: Separation of arguments
    MyClass.new({
    part_1: "I throw warnings", part_2: "in 2.7"
    })
    => "I throw warnings in 2.7"
    example.rb:13: warning: Using the last argument
    as keyword parameters is deprecated; maybe **
    should be added to the call
    example.rb:2: warning: The called method
    `initialize' is defined here
    The Definition
    

    View Slide

16. MyClass.new({
    part_1: "I throw warnings", part_2: "in 2.7"
    })
    MyClass.new(
    part_1: "I don't throw warnings",
    part_2: "in 2.7"
    )
    => "I don't throw warnings in 2.7"
    DEPRECATION: Separation of arguments
    

    View Slide

17. MyClass.new({
    part_1: "I throw warnings", part_2: "in 2.7"
    })
    MyClass.new(**{
    part_1: "I don't throw warnings",
    part_2: "in 2.7"
    })
    => "I don't throw warnings in 2.7"
    DEPRECATION: Separation of arguments
    

    View Slide

18. class MyClass
    def initialize(part_1:, part_2:)
    puts "#{part_1} #{part_2}"
    end
    end
    class AbstractClass
    def initialize(*args)
    MyClass.new(*args)
    end
    end
    DEPRECATION: Separation of arguments
    

    View Slide

19. AbstractClass.new(
    part_1: "I throw warnings", part_2: "in 2.7"
    )
    DEPRECATION: Separation of arguments
    

    View Slide

20. AbstractClass.new(
    part_1: "I throw warnings", part_2: "in 2.7"
    )
    example.rb:9: warning: Using the last argument as
    keyword parameters is deprecated; maybe ** should
    be added to the call
    example.rb:2: warning: The called method
    `initialize' is defined here
    DEPRECATION: Separation of arguments
    

    View Slide

21. class MyClass
    def initialize(part_1:, part_2:)
    puts "#{part_1} #{part_2}"
    end
    end
    class AbstractClass
    def initialize(**kwargs)
    MyClass.new(**kwargs)
    end
    end
    DEPRECATION: Separation of arguments
    

    View Slide

22. class MyClassJob
    def perform(part_1:, part_2:)
    puts "#{part_1} #{part_2}"
    end
    end
    DEPRECATION: Separation of arguments
    

    View Slide

23. module ActiveJob
    module Enqueuing
    def perform_later(*args)
    job_or_instantiate(*args).enqueue
    end
    end
    end
    DEPRECATION: Separation of arguments
    

    View Slide

24. module ActiveJob
    module Enqueuing
    def perform_later(*args)
    job_or_instantiate(*args).enqueue
    end
    ruby2_keywords(:perform_later) if
    respond_to?(:ruby2_keywords, true)
    end
    end
    DEPRECATION: Separation of arguments
    

    View Slide

25. MyClassJob.perform_later({
    part_1: "I am a",
    part_2: "job with kwargs"
    })
    activejob/lib/active_job/execution.rb:48:
    warning: Using the last argument as keyword
    parameters is deprecated; maybe ** should be
    added to the call
    app/jobs/my_job_class_job.rb:2: warning: The
    called method `perform' is defined here
    DEPRECATION: Separation of arguments
    

    View Slide

26. DEPRECATION:
    URI method
    deprecations
    

    View Slide

27. DEPRECATION: URI Methods
    URI.encode
    URI.decode
    URI.escape
    URI.unescape
    

    View Slide

28. URI.escape("https://google.com?query_param=1")
    => "https://google.com?query_param=1"
    uri_example.rb:1: warning: URI.escape is obsolete
    DEPRECATION: URI Methods
    

    View Slide

29. URI.escape("https://google.com?query_param=1")
    Addressable::URI.escape("https://google.com?
    query_param=1")
    => "https://google.com?query_param=1"
    DEPRECATION: URI Methods
    

    View Slide

30. URI.escape("https://goog\nle.com?query_param=1")
    => "https://goog%0Ale.com?query_param=1"
    Addressable::URI.escape("https://goog\nle.com?
    query_param=1")
    => Addressable::URI::InvalidURIError (Invalid
    character in host: 'goog)
    le.com'
    DEPRECATION: URI Methods
    

    View Slide

31. URI.escape("https://goog\nle.com?query_param=1")
    => "https://goog%0Ale.com?query_param=1"
    CGI.escape("https://goog\nle.com?query_param=1")
    =>
    "https%3A%2F%2Fgoog%0Ale.com%3Fquery_param%3D1"
    DEPRECATION: URI Methods
    

    View Slide

32. a
    How to Fix More Than
    11k Deprecations
    

    View Slide

33. a UPGRADING:
    Dual-booting our
    application
    

    View Slide

34. # config/ruby-version
    RUBY_NEXT_SHA = "d1ba554"
    RUBY_SHA = "dcc231c"
    if ENV["RUBY_NEXT"]
    print RUBY_NEXT_SHA
    else
    print RUBY_SHA
    end
    UPGRADING: Dual-booting
    

    View Slide

35. RUBY_NEXT=1 bin/rails server
    RUBY_NEXT=1 bin/rails console
    RUBY_NEXT=1 bin/rails test path/to/test_file.rb
    UPGRADING: Dual-booting
    

    View Slide

36. UPGRADING: Dual-booting
    

    View Slide

37. UPGRADING: Dual-booting
    

    View Slide

38. a UPGRADING:
    Monkey patch
    Warning module
    

    View Slide

39. module Warning
    def self.warn(message)
    STDERR.print(message)
    if ENV["RAISE_ON_WARNINGS"]
    raise message
    end
    if ENV["DEBUG_WARNINGS"]
    STDERR.puts caller
    end
    end
    end
    UPGRADING: Warning monkey patch
    

    View Slide

40. module Warning
    def self.warn(message)
    STDERR.print(message)
    if ENV["RAISE_ON_WARNINGS"]
    raise message
    end
    if ENV["DEBUG_WARNINGS"]
    STDERR.puts caller
    end
    end
    end
    UPGRADING: Warning monkey patch
    

    View Slide

41. module Warning
    def self.warn(message)
    STDERR.print(message)
    if ENV["RAISE_ON_WARNINGS"]
    raise message
    end
    if ENV["DEBUG_WARNINGS"]
    STDERR.puts caller
    end
    end
    end
    UPGRADING: Warning monkey patch
    

    View Slide

42. module Warning
    def self.warn(message)
    STDERR.print(message)
    if ENV["RAISE_ON_WARNINGS"]
    raise message
    end
    if ENV["DEBUG_WARNINGS"]
    STDERR.puts caller
    end
    end
    end
    UPGRADING: Warning monkey patch
    

    View Slide

43. activejob/lib/active_job/execution.rb:48: warning: Using the last
    argument as keyword parameters is deprecated; maybe ** should be added
    to the call
    activejob/lib/active_job/execution.rb:48:in `block in perform_now'
    ...
    test/integration/a_test.rb:6:in `block in test_something'
    activesupport/lib/active_support/testing/assertions.rb:34:in
    `assert_nothing_raised'
    activejob/lib/active_job/test_helper.rb:591:in `perform_enqueued_jobs'
    test/integration/my_class_job_test.rb:5:in `test_my_class_job'
    ...
    app/jobs/my_job_class_job.rb:2: warning: The called method `perform' is
    defined here
    UPGRADING: Warning monkey patch
    

    View Slide

44. def test_my_class_job
    perform_enqueued_jobs do
    MyClassJob.perform_later({
    part_1: "I am a",
    part_2: "job with kwargs"
    })
    end
    ...
    end
    UPGRADING: Warning monkey patch
    

    View Slide

45. module Warning
    def self.warn(message)
    line = caller_locations.find do |location|
    location.path.end_with?("_test.rb")
    end
    WarningsCollector.instance <<
    [message.chomp, line.path]
    STDERR.print(message)
    ...
    UPGRADING: Warning monkey patch
    

    View Slide

46. class WarningsCollector < ParallelCollector
    def process
    path = File.join("/tmp", "warnings.txt")
    File.open(path, "a") do |f|
    @data.each do |message, origin|
    f.puts [message, origin].join("*^.^*")
    end
    end
    script = File.absolute_path(
    "../../../script/process-warnings", __FILE__)
    system(script, "/tmp")
    end
    end
    UPGRADING: Warning monkey patch
    

    View Slide

47. class WarningsCollector < ParallelCollector
    def process
    path = File.join("/tmp", "warnings.txt")
    File.open(path, "a") do |f|
    @data.each do |message, filepath|
    f.puts [message, filepath].join("*^.^*")
    end
    end
    script = File.absolute_path(
    "../../../script/process-warnings", __FILE__)
    system(script, "/tmp")
    end
    end
    UPGRADING: Warning monkey patch
    

    View Slide

48. class WarningsCollector < ParallelCollector
    def process
    path = File.join("/tmp", "warnings.txt")
    File.open(path, "a") do |f|
    @data.each do |message, filepath|
    f.puts [message, filepath].join("*^.^*")
    end
    end
    script = File.absolute_path(
    "../../../script/process-warnings", __FILE__)
    system(script, "/tmp")
    end
    end
    UPGRADING: Warning monkey patch
    

    View Slide

49. class WarningsCollector < ParallelCollector
    def process
    path = File.join("/tmp", "warnings.txt")
    File.open(path, "a") do |f|
    @data.each do |message, filepath|
    f.puts [message, filepath].join("*^.^*")
    end
    end
    script = File.absolute_path(
    "../../../script/process-warnings", __FILE__)
    system(script, "/tmp")
    end
    end
    UPGRADING: Warning monkey patch
    

    View Slide

50. warnings = {}
    Dir["tmp/warning*.txt"].each do |file|
    File.read(file).split("\n").each do |filepath|
    message, filepath = line.split("*^.^*")
    warnings[message] ||= Message.new(message)
    warnings[message].paths << filepath if filepath
    end
    end
    warnings.values.each do |warning|
    warning.owner ||= CODEOWNERS.for(source_file).keys.first.to_s
    end
    UPGRADING: Warning monkey patch
    

    View Slide

51. - [ ] `test/lib/platform/mutations/
    update_mobile_push_notification_schedules_test.rb`
    - **warnings**
    - Line 118: warning: Using the last argument as keyword parameters is
    deprecated; maybe ** should be added to the call
    - [ ] `test/test_helpers/newsies/deliver_notifications_job_test_helper.rb`
    - **warnings**
    - Line 1282: warning: Using the last argument as keyword parameters is
    deprecated; maybe ** should be added to the call
    - Line 1283: warning: Using the last argument as keyword parameters is
    deprecated; maybe ** should be added to the call
    - **test suites that trigger these warnings**
    UPGRADING: Warning File Generation
    

    View Slide

52. UPGRADING: Warning monkey patch
    

    View Slide

53. UPGRADING: Warning File Generation
    

    View Slide

54. a UPGRADING:
    Fixing warnings in
    gems
    

    View Slide

55. View Slide

56. a UPGRADING
    Replace abandoned
    gems
    

    View Slide

57. a UPGRADING
    Preventing
    regressions
    

    View Slide

58. a
    Our Deploy Process
    

    View Slide

59. a DEPLOYING:
    Make smaller
    change sets
    

    View Slide

60. a DEPLOYING:
    Testing on staging
    

    View Slide

61. a
    

    View Slide

62. a DEPLOYING:
    Slow & incremental
    rollout
    

    View Slide

63. 2%
    Incremental rollout
    

    View Slide

64. 2%
    Incremental rollout
    

    View Slide

65. 2% 0%
    Incremental rollout
    

    View Slide

66. 2% 0% 2%
    Incremental rollout
    

    View Slide

67. 2% 0% 2% 30%
    Incremental rollout
    

    View Slide

68. 2% 0% 2% 30% 60%
    Incremental rollout
    

    View Slide

69. 2% 0% 2% 30% 60% 30%
    Incremental rollout
    

    View Slide

70. 2% 0% 2% 30% 60% 30% 100%
    Incremental rollout
    

    View Slide

71. a DEPLOYING:
    Strive for boring
    deploys
    

    View Slide

72. a
    Features Worth
    Upgrading For
    

    View Slide

73. FEATURE:
    Performance
    improvements
    

    View Slide

74. FEATURES: Boot-time decrease
    

    View Slide

75. FEATURES: Boot-time decrease
    

    View Slide

76. FEATURES: Allocations decrease
    

    View Slide

77. FEATURE:
    Method#inspect
    improvements
    

    View Slide

78. class MyClass
    ...
    def my_method(arg, part_1:)
    end
    end
    obj = MyClass.new(part_1: "a", part_2: "b")
    obj.method(:my_method)
    => #
    FEATURE: Method#inspect improvements
    

    View Slide

79. class MyClass
    ...
    def my_method(arg, part_1:)
    end
    end
    obj = MyClass.new(part_1: "a", part_2: "b")
    obj.method(:my_method)
    => #(irb):19>
    FEATURE: Method#inspect improvements
    

    View Slide

80. FEATURE:
    IRB Improvements
    

    View Slide

81. FEATURE: REPL Improvements
    

    View Slide

82. FEATURE:
    Manual GC
    Compaction
    

    View Slide

83. GC.compact
    FEATURE: Method#inspect improvements
    

    View Slide

84. a
    Making Ruby (Even)
    Better
    

    View Slide

85. If you don't like how
    Ruby works,
    change it.
    

    View Slide

86. UPSTREAM FIX:
    Warning categories
    

    View Slide

87. Warning[:deprecated] = false
    UPSTREAM FIX: Warning categories
    

    View Slide

88. UPSTREAM FIX: Warning categories
    

    View Slide

89. module Warning
    def self.warn(message, category: nil)
    if category == :deprecated
    raise message
    else
    super
    end
    end
    end
    UPSTREAM FIX: Warning categories
    

    View Slide

90. a
    Why You Should
    Upgrade (like yesterday)
    

    View Slide

91. a
    Nothing makes an
    upgrade harder than
    waiting
    

    View Slide

92. Thank You!
    Eileen M. Uchitelle
    Principal Engineer at GitHub
    Rails Core Team
    Find me: @eileencodes
    

    View Slide