Track origin of Ruby version (heroku#1636)

* Track origin of Ruby version

Previously "default" was a boolean. In the future we will add other locations such as the `.ruby-version` file.

GUS-W-19310637

* Track unique version number

Both JRuby and MRI share the same `ruby.version` value. i.e. `3.4.2` to distinguish we are switching to the `version-for-download` which includes the information about the engine, this will make queries more clear whether they include jruby or not.

The prior value is moved to "spec" version as engines such as JRuby will implement to a spec such as `3.4.2`.

GUS-W-19310643

* Update key names

Brings key names closer to python's https://github.com/heroku/heroku-buildpack-python/blob/3c27de9acc7a7bbcaf27d281e1381cd81c793999/bin/report#L69-L72. Adds docs over each since the names alone might be confusing.

Author: schneems

lib/language_pack/installers/heroku_ruby_installer.rb

@@ -21,14 +21,36 @@ def initialize(stack: , multi_arch_stacks: , arch: , report: HerokuBuildReport::
 
   def install(ruby_version, install_dir)
     @report.capture(
-      "ruby.version" => ruby_version.ruby_version,
-      "ruby.engine" => ruby_version.engine,
-      "ruby.engine.version" => ruby_version.engine_version,
-      "ruby.major" => ruby_version.major,
-      "ruby.minor" => ruby_version.minor,
-      "ruby.patch" => ruby_version.patch,
-      "ruby.default" => ruby_version.default?,
+      # i.e. `jruby` or `ruby`
+      "ruby_version_engine" => ruby_version.engine,
+      # i.e. `ruby-3.4.2-jruby-10.0.2.0` or `ruby-3.4.2` or `ruby-3.5.0.pre1`
+      "ruby_version_unique" => ruby_version.version_for_download,
+      # i.e. `default` or `Gemfile.lock`
+      "ruby_version_origin" => ruby_version.default? ? "default" : "Gemfile.lock",
     )
+
+    case ruby_version.engine
+    when :ruby
+      @report.capture(
+        "ruby_version_major_minor" => "#{ruby_version.major}.#{ruby_version.minor}",
+        "ruby_version_full" => ruby_version.engine_version_full
+      )
+    when :jruby
+      @report.capture(
+        # i.e. `3.4.2` the target spec ruby version
+        "jruby_version_ruby_version" => ruby_version.ruby_version,
+        # i.e. `10.0.2.0` the version of jruby
+        "jruby_version_full" => ruby_version.engine_version_full,
+        # i.e. `9.4` or `10.0`
+        "jruby_version_major_minor" => [
+          ruby_version.engine_version.split(".")[0],
+          ruby_version.engine_version.split(".")[1]
+        ].join(".")
+      )
+    else
+      raise "Internal error: Unknown engine: #{ruby_version.engine}"
+    end
+
     fetch_unpack(ruby_version, install_dir)
     setup_binstubs(install_dir)
   end

lib/language_pack/ruby_version.rb

@@ -88,14 +88,26 @@ def initialize(
         @engine_version = engine_version
     end
 
+    # Also used as for metrics to track unique installs
     # i.e. `ruby-3.4.2`
     def version_for_download
       if @engine == :jruby
         "ruby-#{ruby_version}-jruby-#{engine_version}"
+      else
+        "ruby-#{engine_version_full}"
+      end
+    end
+
+    # Full qualifier for the version including pre-release information
+    # i.e. `3.5.0.preview1` or `3.5.0` or `3.5.0.rc1` for ruby
+    # i.e. `9.4.9.0` for jruby
+    def engine_version_full
+      if @engine == :jruby
+        engine_version
       elsif @pre
-        "ruby-#{ruby_version}.#{@pre}"
+        "#{engine_version}.#{@pre}"
       else
-        "ruby-#{ruby_version}"
+        "#{engine_version}"
       end
     end
 

spec/hatchet/ruby_spec.rb

@@ -189,7 +189,7 @@
             expect(report_match).to be_truthy
             yaml = report_match[:yaml].gsub(/remote: /, "")
             report = YAML.load(yaml)
-            expect(report.fetch("ruby.version")).to eq(expected)
+            expect(report.fetch("ruby_version_full")).to eq(expected)
           rescue Exception => e
             puts app.output
             puts yaml if yaml

spec/helpers/heroku_ruby_installer_spec.rb

@@ -10,6 +10,10 @@ def installer(report: HerokuBuildReport::GLOBAL)
     )
   end
 
+  def sort_hash(hash)
+    hash.sort_by { |k, _| k.to_s }.to_h
+  end
+
   def ruby_version
     LanguagePack::RubyVersion.bundle_platform_ruby(bundler_output: "ruby-3.1.7")
   end
@@ -26,7 +30,7 @@ def ruby_version
     end
   end
 
-  describe "#install" do
+  describe "ruby installation" do
     it "should install ruby and setup binstubs" do
       Dir.mktmpdir do |dir|
         Dir.chdir(dir) do
@@ -37,12 +41,41 @@ def ruby_version
           expect(File.symlink?("#{dir}/bin/ruby.exe")).to be true
           expect(File).to exist("#{dir}/vendor/ruby/bin/ruby")
 
-          expect(report.data["ruby.version"]).to eq("3.1.7")
-          expect(report.data["ruby.engine"]).to eq(:ruby)
-          expect(report.data["ruby.engine.version"]).to eq(report.data["ruby.version"])
-          expect(report.data["ruby.major"]).to eq(3)
-          expect(report.data["ruby.minor"]).to eq(1)
-          expect(report.data["ruby.patch"]).to eq(7)
+          expected = {
+            "ruby_version_engine" => :ruby,
+            "ruby_version_full" => "3.1.7",
+            "ruby_version_major_minor" => "3.1",
+            "ruby_version_origin" => "Gemfile.lock",
+            "ruby_version_unique" => "ruby-3.1.7"
+          }
+
+          expect(sort_hash(report.data)).to eq(sort_hash(expected))
+        end
+      end
+    end
+
+    it "should work with pre-release versions" do
+      Dir.mktmpdir do |dir|
+        Dir.chdir(dir) do
+          report = HerokuBuildReport.dev_null
+          installer(report: report).install(
+            LanguagePack::RubyVersion.bundle_platform_ruby(bundler_output: "ruby-3.5.0.preview1"),
+            "#{dir}/vendor/ruby"
+          )
+
+          expect(File.symlink?("#{dir}/bin/ruby")).to be true
+          expect(File.symlink?("#{dir}/bin/ruby.exe")).to be true
+          expect(File).to exist("#{dir}/vendor/ruby/bin/ruby")
+
+          expected = {
+            "ruby_version_engine" => :ruby,
+            "ruby_version_major_minor" => "3.5",
+            "ruby_version_full" => "3.5.0.preview1",
+            "ruby_version_origin" => "Gemfile.lock",
+            "ruby_version_unique" => "ruby-3.5.0.preview1"
+          }
+
+          expect(sort_hash(report.data)).to eq(sort_hash(expected))
         end
       end
     end
@@ -62,12 +95,16 @@ def ruby_version
             "#{dir}/vendor/ruby"
           )
 
-          expect(report.data["ruby.version"]).to eq("3.1.4")
-          expect(report.data["ruby.engine"]).to eq(:jruby)
-          expect(report.data["ruby.engine.version"]).to eq("9.4.9.0")
-          expect(report.data["ruby.major"]).to eq(3)
-          expect(report.data["ruby.minor"]).to eq(1)
-          expect(report.data["ruby.patch"]).to eq(4)
+          expected = {
+            "ruby_version_engine" => :jruby,
+            "jruby_version_full" => "9.4.9.0",
+            "jruby_version_major_minor" => "9.4",
+            "jruby_version_ruby_version" => "3.1.4",
+            "ruby_version_origin" => "Gemfile.lock",
+            "ruby_version_unique" => "ruby-3.1.4-jruby-9.4.9.0"
+          }
+
+          expect(sort_hash(report.data)).to eq(sort_hash(expected))
         end
       end
     end