feat(windows-installer): add client telemetry opt out option (#210)

Signed-off-by: Jericho Tolentino <68654047+jericht@users.noreply.github.com>

src/deadline_worker_agent/installer/__init__.py

@@ -33,7 +33,7 @@ def install() -> None:
             farm_id=args.farm_id,
             fleet_id=args.fleet_id,
             region=args.region,
-            worker_agent_program=str(scripts_path),
+            worker_agent_program=scripts_path,
             no_install_service=not args.install_service,
             start=args.service_start,
             confirm=args.confirmed,
@@ -46,6 +46,8 @@ def install() -> None:
             installer_args.update(group_name=args.group)
         if args.password:
             installer_args.update(password=args.password)
+        if args.telemetry_opt_out:
+            installer_args.update(telemetry_opt_out=args.telemetry_opt_out)
 
         start_windows_installer(**installer_args)
     else:

src/deadline_worker_agent/installer/install.sh

@@ -247,7 +247,7 @@ echo "Worker agent user: ${wa_user}"
 echo "Worker job group: ${job_group}"
 echo "Scripts path: ${scripts_path}"
 echo "Worker agent program path: ${worker_agent_program}"
-echo "Worker agent program path: ${client_library_program}"
+echo "Deadline client program path: ${client_library_program}"
 echo "Allow worker agent shutdown: ${allow_shutdown}"
 echo "Start systemd service: ${start_service}"
 echo "Telemetry opt-out: ${telemetry_opt_out}"

src/deadline_worker_agent/installer/win_installer.py

@@ -17,6 +17,7 @@
     FileSystemPermissionEnum,
 )
 
+import deadline.client.config.config_file
 import pywintypes
 import win32api
 import win32net
@@ -31,6 +32,9 @@
 DEFAULT_JOB_GROUP = "deadline-job-users"
 DEFAULT_PASSWORD_LENGTH = 12
 
+# Environment variable that overrides the config path used by the Deadline client
+DEADLINE_CLIENT_CONFIG_PATH_OVERRIDE_ENV_VAR = "DEADLINE_CONFIG_FILE_PATH"
+
 
 class InstallerFailedException(Exception):
     """Exception raised when the installer fails"""
@@ -392,11 +396,50 @@ def provision_directories(agent_username: str) -> WorkerAgentDirectories:
     )
 
 
+def update_deadline_client_config(
+    user: str,
+    settings: dict[str, str],
+) -> None:
+    """
+    Updates the Deadline Client config for the specified user.
+
+    Args:
+        user (str): The user to update the Deadline Client config for.
+        settings (dict[str, str]]): The key-value pairs of settings to update.
+
+    Raises:
+        InstallerFailedException: _description_
+    """
+    # Build the Deadline client config path for the user
+    deadline_client_config_path = deadline.client.config.config_file.CONFIG_FILE_PATH
+    if not deadline_client_config_path.startswith("~"):
+        raise InstallerFailedException(
+            f"Cannot opt out of telemetry: Expected Deadline client config file path to start with a tilde (~), but got: {deadline_client_config_path}\n"
+            f"This is because the Deadline client program (version {deadline.client.version}) is not compatible with this version of the Worker agent installer\n"
+            f"To opt out of telemetry, please use a compatible version of the Deadline client program or run the following command as the worker user:\n\n"
+            "deadline config set telemetry.opt_out true\n"
+        )
+    user_deadline_client_config_path = f"~{user}" + deadline_client_config_path.removeprefix("~")
+
+    # Opt out of client telemetry for the agent user
+    old_environ = os.environ.copy()
+    try:
+        os.environ[DEADLINE_CLIENT_CONFIG_PATH_OVERRIDE_ENV_VAR] = user_deadline_client_config_path
+        for setting_key, setting_value in settings.items():
+            deadline.client.config.config_file.set_setting(setting_key, setting_value)
+    except Exception as e:
+        logging.error(f"Failed to update Deadline Client configuration for user '{user}': {e}")
+        raise
+    finally:
+        os.environ.clear()
+        os.environ.update(old_environ)
+
+
 def start_windows_installer(
     farm_id: str,
     fleet_id: str,
     region: str,
-    worker_agent_program: str,
+    worker_agent_program: Path,
     allow_shutdown: bool,
     parser: ArgumentParser,
     password: typing.Optional[str] = None,
@@ -405,6 +448,7 @@ def start_windows_installer(
     no_install_service: bool = False,
     start: bool = False,
     confirm: bool = False,
+    telemetry_opt_out: bool = False,
 ):
     logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
 
@@ -441,9 +485,10 @@ def print_helping_info_and_exit():
         f"Region: {region}\n"
         f"Worker agent user: {user_name}\n"
         f"Worker job group: {group_name}\n"
-        f"Worker agent program path: {worker_agent_program}\n"
+        f"Worker agent program path: {str(worker_agent_program)}\n"
         f"Allow worker agent shutdown: {allow_shutdown}\n"
-        f"Start service: {start}"
+        f"Start service: {start}\n"
+        f"Telemetry opt-out: {telemetry_opt_out}"
     )
 
     # Confirm installation
@@ -486,3 +531,11 @@ def print_helping_info_and_exit():
     if worker_user_rights:
         # Grant the worker user the necessary rights
         grant_account_rights(user_name, worker_user_rights)
+
+    if telemetry_opt_out:
+        logging.info("Opting out of client telemetry")
+        update_deadline_client_config(
+            user=user_name,
+            settings={"telemetry.opt_out": "true"},
+        )
+        logging.info("Opted out of client telemetry")

test/integ/installer/test_windows_installer.py

@@ -11,6 +11,7 @@
 import win32api
 import win32net
 
+import deadline.client.config.config_file
 import deadline_worker_agent.installer.win_installer as installer_mod
 from deadline_worker_agent.installer.win_installer import (
     add_user_to_group,
@@ -20,6 +21,7 @@
     ensure_local_queue_user_group_exists,
     generate_password,
     provision_directories,
+    update_deadline_client_config,
     WorkerAgentDirectories,
 )
 
@@ -226,3 +228,22 @@ def test_provision_directories(
     assert actual_dirs.deadline_log_subdir.exists()
     assert actual_dirs.deadline_persistence_subdir.exists()
     assert actual_dirs.deadline_config_subdir.exists()
+
+
+def test_update_deadline_client_config(tmp_path: pathlib.Path) -> None:
+    # GIVEN
+    deadline_client_config_path = tmp_path / "deadline_client_config"
+    deadline_client_config_path.touch(mode=0o644, exist_ok=False)
+
+    with patch(
+        "deadline.client.config.config_file.get_config_file_path",
+        return_value=deadline_client_config_path,
+    ):
+        # WHEN
+        update_deadline_client_config(
+            user="",  # Doesn't matter, config path is mocked out anyway
+            settings={"telemetry.opt_out": "true"},
+        )
+
+        # THEN
+        assert deadline.client.config.config_file.get_setting("telemetry.opt_out") == "true"

test/unit/install/test_windows_installer.py

@@ -43,7 +43,7 @@ def test_start_windows_installer(
                 farm_id=parsed_args.farm_id,
                 fleet_id=parsed_args.fleet_id,
                 region=parsed_args.region,
-                worker_agent_program=str(Path(sysconfig.get_path("scripts"))),
+                worker_agent_program=Path(sysconfig.get_path("scripts")),
                 no_install_service=not parsed_args.install_service,
                 start=parsed_args.service_start,
                 confirm=parsed_args.confirmed,
@@ -52,6 +52,7 @@ def test_start_windows_installer(
                 group_name=parsed_args.group,
                 password=parsed_args.password,
                 allow_shutdown=parsed_args.allow_shutdown,
+                telemetry_opt_out=parsed_args.telemetry_opt_out,
             )
 
 
@@ -69,7 +70,7 @@ def test_start_windows_installer_fails_when_run_as_non_admin_user(
                 farm_id=parsed_args.farm_id,
                 fleet_id=parsed_args.fleet_id,
                 region=parsed_args.region,
-                worker_agent_program=str(Path(sysconfig.get_path("scripts"))),
+                worker_agent_program=Path(sysconfig.get_path("scripts")),
                 no_install_service=not parsed_args.install_service,
                 start=parsed_args.service_start,
                 confirm=parsed_args.confirmed,