Snow 1999047 fix binaries visible as pypi in telemetry (#2141)

Author: sfc-gh-pczajka

scripts/packaging/build_isolated_binary_with_hatch.py

@@ -22,6 +22,7 @@
 
 PROJECT_ROOT = Path(__file__).parent.parent.parent
 PYPROJECT_PATH = PROJECT_ROOT / "pyproject.toml"
+INSTALLATION_SOURCE_VARIABLE = "INSTALLATION_SOURCE"
 
 
 @contextlib.contextmanager
@@ -112,10 +113,28 @@ def hatch_install_python(python_tmp_dir: Path, python_version: str) -> bool:
     return not completed_proc.returncode
 
 
-def pip_install_project(python_exe: str, project_whl: Path) -> bool:
+@contextlib.contextmanager
+def override_is_installation_source_variable():
+    about_file = PROJECT_ROOT / "src" / "snowflake" / "cli" / "__about__.py"
+    contents = about_file.read_text()
+    if INSTALLATION_SOURCE_VARIABLE not in contents:
+        raise RuntimeError(
+            f"{INSTALLATION_SOURCE_VARIABLE} variable not defined in __about__.py"
+        )
+    about_file.write_text(
+        contents.replace(
+            f"{INSTALLATION_SOURCE_VARIABLE} = CLIInstallationSource.PYPI",
+            f"{INSTALLATION_SOURCE_VARIABLE} = CLIInstallationSource.BINARY",
+        )
+    )
+    yield
+    subprocess.run(["git", "checkout", str(about_file)])
+
+
+def pip_install_project(python_exe: str) -> bool:
     """Install the project into the Python distribution."""
     completed_proc = subprocess.run(
-        [python_exe, "-m", "pip", "install", "-U", str(project_whl)],
+        [python_exe, "-m", "pip", "install", "-U", str(PROJECT_ROOT)],
         capture_output=True,
     )
     return not completed_proc.returncode
@@ -145,7 +164,8 @@ def main():
     print("-> installed")
 
     print(f"Installing project into Python distribution...")
-    pip_install_project(str(settings.python_dist_exe), PROJECT_ROOT)
+    with override_is_installation_source_variable():
+        pip_install_project(str(settings.python_dist_exe))
     print("-> installed")
 
     print("Making distribution archive...")

src/snowflake/cli/__about__.py

@@ -14,4 +14,16 @@
 
 from __future__ import annotations
 
+from enum import Enum, unique
+
 VERSION = "3.7.0.dev0"
+
+
+@unique
+class CLIInstallationSource(Enum):
+    BINARY = "binary"
+    PYPI = "pypi"
+
+
+# This variable is changed in binary release script
+INSTALLATION_SOURCE = CLIInstallationSource.PYPI

src/snowflake/cli/_app/telemetry.py

@@ -40,12 +40,6 @@
 from snowflake.connector.time_util import get_time_millis
 
 
-@unique
-class CLIInstallationSource(Enum):
-    BINARY = "binary"
-    PYPI = "pypi"
-
-
 @unique
 class CLITelemetryField(Enum):
     # Basic information
@@ -172,12 +166,6 @@ def _get_definition_version() -> str | None:
     return None
 
 
-def _get_installation_source() -> CLIInstallationSource:
-    if getattr(sys, "frozen", False) and hasattr(sys, "_MEIPASS"):
-        return CLIInstallationSource.BINARY
-    return CLIInstallationSource.PYPI
-
-
 def _get_ci_environment_type() -> str:
     if "GITHUB_ACTIONS" in os.environ:
         return "GITHUB_ACTIONS"
@@ -214,7 +202,7 @@ def generate_telemetry_data_dict(
     ) -> Dict[str, Any]:
         data = {
             CLITelemetryField.SOURCE: PARAM_APPLICATION_NAME,
-            CLITelemetryField.INSTALLATION_SOURCE: _get_installation_source().value,
+            CLITelemetryField.INSTALLATION_SOURCE: __about__.INSTALLATION_SOURCE.value,
             CLITelemetryField.VERSION_CLI: __about__.VERSION,
             CLITelemetryField.VERSION_OS: platform.platform(),
             CLITelemetryField.VERSION_PYTHON: python_version(),