sapling: inreplace branch = "main" to improve reproducibility

Author: cho-m

Formula/s/sapling.rb

@@ -1,12 +1,21 @@
 class Sapling < Formula
   desc "Source control client"
   homepage "https://sapling-scm.com"
-  url "https://github.com/facebook/sapling/archive/refs/tags/0.2.20240718-145624+f4e9df48.tar.gz"
-  version "0.2.20240718-145624-f4e9df48"
-  sha256 "8081d405cddb9dc4eadd96f4c948b7686b0b61f641c068fc87b9c27518fb619e"
   license "GPL-2.0-or-later"
   head "https://github.com/facebook/sapling.git", branch: "main"
 
+  stable do
+    url "https://github.com/facebook/sapling/archive/refs/tags/0.2.20240718-145624+f4e9df48.tar.gz"
+    version "0.2.20240718-145624-f4e9df48"
+    sha256 "8081d405cddb9dc4eadd96f4c948b7686b0b61f641c068fc87b9c27518fb619e"
+
+    # Backport fix for Python 3.12
+    patch do
+      url "https://github.com/facebook/sapling/commit/65a7e9097fb9280aef7c50ecdf08b5755288490a.patch?full_index=1"
+      sha256 "ca59aebef870bad9887b927b68c1be76a01bb905f5eb76cf2f0d2499b3b0c306"
+    end
+  end
+
   livecheck do
     url :stable
     regex(/^v?(\d+(?:[.-]\d+)+[+-]\h+)$/i)
@@ -25,28 +34,67 @@ class Sapling < Formula
   end
 
   depends_on "cmake" => :build
+  depends_on "pkg-config" => :build
   depends_on "python-setuptools" => :build
   depends_on "rust" => :build
   depends_on "yarn" => :build
-  # The `cargo` crate requires http2, which `curl-config` from macOS reports to
-  # be missing despite its presence.
-  # Try switching to `uses_from_macos` when that's resolved.
-  depends_on "curl"
   depends_on "gh"
+  depends_on "libssh2"
   depends_on "node"
   depends_on "openssl@3"
   depends_on "[email protected]"
 
   uses_from_macos "bzip2"
+  uses_from_macos "curl"
   uses_from_macos "zlib"
 
-  on_linux do
-    depends_on "pkg-config" => :build # for `curl-sys` crate to find `curl`
-  end
-
   conflicts_with "sl", because: "both install `sl` binaries"
 
+  def watchman_rev
+    watchman_repo = "https://github.com/facebook/watchman.git"
+    max_date = version.patch.to_s.match(/^(\d{4})(\d{2})(\d{2})\b/).captures.join(".")
+    tags = Utils.safe_popen_read("git", "ls-remote", "--sort=-version:refname", "--tags", watchman_repo)
+    tags.scan(%r{^(\S+)\trefs/tags/v(\d{4}\.\d{2}\.\d{2})(?:\.\d+)+$}) do |rev, date|
+      return rev if date <= max_date
+    end
+    odie "Unable to pick watchman tag based on sapling patch version #{version.patch}!"
+  end
+
   def install
+    # Workaround to improve reproducibility as Cargo.toml uses branch for some dependencies.
+    # Actual reproducible builds won't be possible without a Cargo.lock.
+    #
+    # Related issue: https://github.com/facebook/sapling/issues/547
+    if build.stable?
+      github_hashes = buildpath.glob("build/deps/github_hashes/*/*-rev.txt").to_h do |revfile|
+        commit = revfile.read[/commit ([0-9a-f]+)$/i, 1]
+        odie "Unable to parse commit from #{revfile}!" if commit.nil?
+        ["#{revfile.dirname.basename}/#{revfile.basename("-rev.txt")}", commit]
+      end
+      odie "Unable to find any revision files in build/deps/github_hashes!" if github_hashes.empty?
+
+      # Watchman doesn't have a revision file. To avoid using HEAD, scan through tags
+      # and use revision from tag created on or before date in Sapling patch version
+      odie "Remove workaround for handling facebook/watchman!" if github_hashes.key?("facebook/watchman")
+      github_hashes["facebook/watchman"] = watchman_rev
+
+      no_modification = true
+      Dir.glob("**/Cargo.toml") do |manifest|
+        inreplace manifest do |s|
+          github_hashes.each do |repo, rev|
+            result = s.gsub! %r{(git = "https://github.com/#{repo}(?:\.git)?",) branch = "[^"]*"},
+                             "\\1 rev = \"#{rev}\"",
+                             audit_result: false
+            no_modification &&= result.nil?
+          end
+        end
+        if (git_branch = File.read(manifest)[/git = "[^"]*", branch = "[^"]*"/])
+          odie "#{manifest} tracks a branch for #{git_branch}!"
+        end
+      end
+      odie "Inreplace did not modify any branch usage in Cargo.toml manifests!" if no_modification
+    end
+
     if OS.mac?
       # Avoid vendored libcurl.
       inreplace %w[
@@ -59,8 +107,9 @@ def install
     end
 
     python3 = "python3.12"
+    ENV["LIBSSH2_SYS_USE_PKG_CONFIG"] = "1"
     ENV["OPENSSL_DIR"] = Formula["openssl@3"].opt_prefix
-    ENV["PYTHON"] = ENV["PYTHON3"] = python3
+    ENV["PYTHON_SYS_EXECUTABLE"] = which(python3)
     ENV["SAPLING_VERSION"] = if build.stable?
       version
     else
@@ -69,7 +118,7 @@ def install
 
     # Don't allow the build to break our shim configuration.
     inreplace "eden/scm/distutils_rust/__init__.py", '"HOMEBREW_CCCFG"', '"NONEXISTENT"'
-    system "make", "-C", "eden/scm", "install-oss", "PREFIX=#{prefix}"
+    system "make", "-C", "eden/scm", "install-oss", "PREFIX=#{prefix}", "PYTHON=#{python3}", "PYTHON3=#{python3}"
   end
 
   def check_binary_linkage(binary, library)
@@ -93,9 +142,19 @@ def check_binary_linkage(binary, library)
       assert_equal "first", shell_output("#{bin}/sl log -l 1 -T {desc}").chomp
     end
 
-    [
-      Formula["curl"].opt_lib/shared_library("libcurl"),
-    ].each do |library|
+    dylibs = [
+      Formula["libssh2"].opt_lib/shared_library("libssh2"),
+      Formula["openssl@3"].opt_lib/shared_library("libssl"),
+      Formula["openssl@3"].opt_lib/shared_library("libcrypto"),
+    ]
+    if OS.mac?
+      assert (bin/"sl").dynamically_linked_libraries.any? { |dll| dll.start_with?("/usr/lib/libcurl.") },
+             "No linkage with system curl! Cargo is likely using a vendored version."
+    else
+      dylibs << (Formula["curl"].opt_lib/shared_library("libcurl"))
+    end
+
+    dylibs.each do |library|
       assert check_binary_linkage(bin/"sl", library),
              "No linkage with #{library.basename}! Cargo is likely using a vendored version."
     end