Use proxy tester for better verification, and fix timeout support (#129)

.github/workflows/main.yml

@@ -44,6 +44,7 @@ jobs:
     env:
       ANACONDA_ANON_USAGE_DEBUG: 1
       ANACONDA_ANON_USAGE_RAISE: 1
+      PYTHONUNBUFFERED: 1
     defaults:
       run:
         # https://github.com/conda-incubator/setup-miniconda#use-a-default-shell

.pre-commit-config.yaml

@@ -20,7 +20,7 @@ repos:
     rev: v3.19.1
     hooks:
       - id: pyupgrade
-        args: [--py36-plus]
+        args: [--py36-plus, --keep-percent-format]
   - repo: https://github.com/PyCQA/isort
     rev: 6.0.0
     hooks:

anaconda_anon_usage/heartbeat.py

@@ -9,56 +9,64 @@
 import argparse
 import os
 import sys
+import time
 from threading import Thread
 from urllib.parse import urljoin
 
-from conda.base.context import context
+from conda.base.context import Context, context, locate_prefix_by_name
 from conda.gateways.connection.session import get_session
 from conda.models.channel import Channel
 
 from . import utils
 
 VERBOSE = False
 STANDALONE = False
-DRY_RUN = os.environ.get("ANACONDA_HEARTBEAT_DRY_RUN")
 
 CLD_REPO = "https://repo.anaconda.cloud/"
 ORG_REPO = "https://conda.anaconda.org/"
 COM_REPO = "https://repo.anaconda.com/pkgs/"
 REPOS = (CLD_REPO, COM_REPO, ORG_REPO)
 HEARTBEAT_PATH = "noarch/activate-0.0.0-0.conda"
 
+# How long to attempt the connection. When a connection to our
+# repository is blocked or slow, a long timeout would lead to
+# a slow activation and a poor user experience. This is a total
+# timeout value, inclusive of all retries.
+TIMEOUT = 0.75  # seconds
+ATTEMPTS = 3
 
-def _print(msg, *args, standalone=False, error=False):
+
+def _print(msg, *args, error=False):
     global VERBOSE
     global STANDALONE
     if not (VERBOSE or utils.DEBUG or error):
         return
-    if standalone and not STANDALONE:
-        return
     # It is very important that these messages are printed to stderr
     # when called from within the activate script. Otherwise they
     # will insert themselves into the activation command set
     ofile = sys.stdout if STANDALONE and not (error or utils.DEBUG) else sys.stderr
     print(msg % args, file=ofile)
 
 
-def _ping(session, url, wait):
+def _ping(session, url, timeout):
     try:
-        response = session.head(url, proxies=session.proxies)
-        _print("Status code (expect 404): %s", response.status_code)
+        # A short timeout is necessary here so that the activation
+        # is not unduly delayed by a blocked internet connection
+        start_time = time.perf_counter()
+        response = session.head(url, proxies=session.proxies, timeout=timeout)
+        delta = time.perf_counter() - start_time
+        _print(
+            "Success after %.3fs; code (expect 404): %d", delta, response.status_code
+        )
     except Exception as exc:
         if type(exc).__name__ != "ConnectionError":
-            _print("Heartbeat error: %s", exc, error=True)
+            _print("Unexpected heartbeat error: %s", exc, error=True)
+        elif "timeout=" in str(exc):
+            delta = time.perf_counter() - start_time
+            _print("NO heartbeat sent after %.3fs.", delta)
 
 
-def attempt_heartbeat(channel=None, path=None, wait=False):
-    global DRY_RUN
-    line = "------------------------"
-    _print(line, standalone=True)
-    _print("anaconda-anon-usage heartbeat", standalone=True)
-    _print(line, standalone=True)
-
+def attempt_heartbeat(prefix=None, dry_run=False, channel=None, path=None):
     if not hasattr(context, "_aau_initialized"):
         from . import patch
 
@@ -77,39 +85,99 @@ def attempt_heartbeat(channel=None, path=None, wait=False):
                 break
         else:
             _print("No valid heartbeat channel")
-            _print(line, standalone=True)
             return
         url = urljoin(base, channel or "main") + "/"
     url = urljoin(url, path or HEARTBEAT_PATH)
 
     _print("Heartbeat url: %s", url)
+    if prefix:
+        Context.checked_prefix = prefix
+        _print("Prefix: %s", prefix)
     _print("User agent: %s", context.user_agent)
-    if DRY_RUN:
+
+    if dry_run:
         _print("Dry run selected, not sending heartbeat.")
-    else:
-        session = get_session(url)
-        t = Thread(target=_ping, args=(session, url, wait), daemon=True)
-        t.start()
-        _print("%saiting for response", "W" if wait else "Not w")
-        t.join(timeout=None if wait else 0.1)
-    _print(line, standalone=True)
+        return
+
+    # Build and configure the session object
+    timeout = TIMEOUT / ATTEMPTS
+    context.remote_max_retries = ATTEMPTS - 1
+    # No backoff between attempts
+    context.remote_backoff_factor = 0
+    session = get_session(url)
+
+    # Run in the background so we can proceed with the rest of the
+    # activation tasks while the request fires. The process will wait
+    # to terminate until the thread is complete.
+    t = Thread(target=_ping, args=(session, url, timeout), daemon=False)
+    t.start()
+    if STANDALONE:
+        t.join()
 
 
 def main():
     global VERBOSE
-    global DRY_RUN
     global STANDALONE
-    p = argparse.ArgumentParser()
-    p.add_argument("-c", "--channel", default=None)
-    p.add_argument("-p", "--path", default=None)
-    p.add_argument("-d", "--dry-run", action="store_true")
-    p.add_argument("-q", "--quiet", action="store_true")
-    p.add_argument("-w", "--wait", action="store_true")
-    args = p.parse_args()
     STANDALONE = True
-    VERBOSE = not args.quiet
-    DRY_RUN = args.dry_run
-    attempt_heartbeat(args.channel, args.path, args.wait)
+    VERBOSE = "--quiet" not in sys.argv and "-q" not in sys.argv
+
+    line = "-----------------------------"
+    _print(line)
+    _print("anaconda-anon-usage heartbeat")
+    _print(line)
+
+    def environment_path(s):
+        assert os.path.isdir(s)
+        return s
+
+    def environment_name(s):
+        return locate_prefix_by_name(s)
+
+    p = argparse.ArgumentParser()
+    g = p.add_mutually_exclusive_group()
+    g.add_argument(
+        "-n",
+        "--name",
+        type=environment_name,
+        default=None,
+        help="Environment name; defaults to the current environment.",
+    )
+    g.add_argument(
+        "-p",
+        "--prefix",
+        type=environment_path,
+        default=None,
+        help="Environment prefix; defaults to the current environment.",
+    )
+    p.add_argument(
+        "-d",
+        "--dry-run",
+        action="store_true",
+        help="Do not send the heartbeat; just show the steps.",
+    )
+    p.add_argument("-q", "--quiet", action="store_true", help="Suppress console logs.")
+    p.add_argument(
+        "--channel",
+        default=None,
+        help="(advanced) The full URL to a custom repository channel. By default, an "
+        "Anaconda-hosted channel listed in the user's channel configuration is used.",
+    )
+    p.add_argument(
+        "--path",
+        default=None,
+        help="(advanced) A custom path to append to the channel URL.",
+    )
+
+    try:
+        args = p.parse_args()
+        attempt_heartbeat(
+            prefix=args.prefix or args.name,
+            dry_run=args.dry_run,
+            channel=args.channel,
+            path=args.path,
+        )
+    finally:
+        _print(line)
 
 
 if __name__ == "__main__":

anaconda_anon_usage/patch.py

@@ -55,8 +55,7 @@ def _new_activate(self):
         env = self.env_name_or_prefix
         if env and os.sep not in env:
             env = locate_prefix_by_name(env)
-        Context.checked_prefix = env or sys.prefix
-        attempt_heartbeat()
+        attempt_heartbeat(env or sys.prefix)
     except Exception as exc:
         _debug("Failed to attempt heartbeat: %s", exc, error=True)
     finally: