From 43a2164ccd7e483318213d585dc907914762c3f1 Mon Sep 17 00:00:00 2001
From: Huon Wilson <huon@exoflare.io>
Date: Wed, 23 Aug 2023 13:50:52 +1000
Subject: [PATCH] Require scie-pants 0.9.2 or newer, for new distribution model
 (#19654)

This updates Pants to require and check for the scie-pants launcher
binary version: we need version 0.9 or earlier, to have support for the
new distribution model. This syncs with
https://github.com/pantsbuild/scie-pants/pull/246 (which will become
scie-pants 0.9.2 / 0.9.3), which sets the `SCIE_PANTS_VERSION`
environment variable when running pants.

This will be cherry-picked back as far as we support, to help users
upgrade their launcher earlier.

Fixes #19600
---
 src/python/pants/bin/pants_runner.py | 34 +++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/src/python/pants/bin/pants_runner.py b/src/python/pants/bin/pants_runner.py
index 55615589405..e898a1be442 100644
--- a/src/python/pants/bin/pants_runner.py
+++ b/src/python/pants/bin/pants_runner.py
@@ -8,6 +8,9 @@
 from dataclasses import dataclass
 from typing import List, Mapping
 
+from packaging.version import Version
+
+from pants.base.deprecated import warn_or_error
 from pants.base.exception_sink import ExceptionSink
 from pants.base.exiter import ExitCode
 from pants.engine.env_vars import CompleteEnvironmentVars
@@ -20,6 +23,10 @@
 
 logger = logging.getLogger(__name__)
 
+# Pants 2.18 is using a new distribution model, that's only supported in 0.9.0 (this is 0.9.2,
+# because _detecting_ the version is only supported from 0.9.2), so people should upgrade
+MINIMUM_SCIE_PANTS_VERSION = Version("0.9.2")
+
 
 @dataclass(frozen=True)
 class PantsRunner:
@@ -80,7 +87,11 @@ def run(self, start_time: float) -> ExitCode:
             stdout_fileno=stdout_fileno,
             stderr_fileno=stderr_fileno,
         ):
-            if "SCIE" not in os.environ and "NO_SCIE_WARNING" not in os.environ:
+            run_via_scie = "SCIE" in os.environ
+            enable_scie_warning = "NO_SCIE_WARNING" not in os.environ
+            scie_pants_version = os.environ.get("SCIE_PANTS_VERSION")
+
+            if not run_via_scie and enable_scie_warning:
                 raise RuntimeError(
                     softwrap(
                         f"""
@@ -90,6 +101,27 @@ def run(self, start_time: float) -> ExitCode:
                     ),
                 )
 
+            if run_via_scie and (
+                # either scie-pants is too old to communicate its version:
+                scie_pants_version is None
+                # or the version itself is too old:
+                or Version(scie_pants_version) < MINIMUM_SCIE_PANTS_VERSION
+            ):
+                current_version_text = (
+                    f"The current version of the `pants` launcher binary is {scie_pants_version}"
+                    if scie_pants_version
+                    else "Run `PANTS_BOOTSTRAP_VERSION=report pants` to see the current version of the `pants` launcher binary"
+                )
+                warn_or_error(
+                    "2.18.0.dev6",
+                    f"using a `pants` launcher binary older than {MINIMUM_SCIE_PANTS_VERSION}",
+                    softwrap(
+                        f"""
+                        {current_version_text}, and see {doc_url("installation")} for how to upgrade.
+                        """
+                    ),
+                )
+
             # N.B. We inline imports to speed up the python thin client run, and avoids importing
             # engine types until after the runner has had a chance to set __PANTS_BIN_NAME.
             if self._should_run_with_pantsd(global_bootstrap_options):