Hint user to upgrade every 7 days for HINT_ACTIVITY_NAME

src/promptflow/promptflow/_constants.py

@@ -38,3 +38,12 @@ class AvailableIDE:
 
 USER_AGENT = "USER_AGENT"
 PF_USER_AGENT = "PF_USER_AGENT"
+
+CLI_PACKAGE_NAME = 'promptflow'
+CURRENT_VERSION = 'current_version'
+LATEST_VERSION = 'latest_version'
+LAST_HINT_TIME = 'last_hint_time'
+LAST_CHECK_TIME = 'last_check_time'
+PF_VERSION_CHECK = "pf_version_check.json"
+HINT_INTERVAL_DAY = 7
+GET_PYPI_INTERVAL_DAY = 7

src/promptflow/promptflow/_sdk/_telemetry/activity.py

@@ -6,9 +6,11 @@
 import uuid
 from contextvars import ContextVar
 from datetime import datetime
+from concurrent.futures import ThreadPoolExecutor
 
 from promptflow._sdk._telemetry.telemetry import TelemetryMixin
 from promptflow._sdk._utils import ClientUserAgentUtil
+from promptflow._utils.version_hint_utils import hint_for_update, check_latest_version, HINT_ACTIVITY_NAME
 
 
 class ActivityType(object):
@@ -170,8 +172,11 @@ def wrapper(self, *args, **kwargs):
             # update activity name according to kwargs.
             _activity_name = update_activity_name(activity_name, kwargs=kwargs)
             with log_activity(logger, _activity_name, activity_type, custom_dimensions):
+                if _activity_name in HINT_ACTIVITY_NAME:
+                    hint_for_update()
+                    with ThreadPoolExecutor() as pool:
+                        pool.submit(check_latest_version)
                 return f(self, *args, **kwargs)
-
         return wrapper
 
     return monitor

src/promptflow/promptflow/_utils/version_hint_utils.py

@@ -0,0 +1,87 @@
+# ---------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# ---------------------------------------------------------
+import datetime
+import json
+import logging
+
+from promptflow._constants import (LAST_HINT_TIME, LAST_CHECK_TIME, PF_VERSION_CHECK, CLI_PACKAGE_NAME,
+                                   HINT_INTERVAL_DAY, GET_PYPI_INTERVAL_DAY, LATEST_VERSION, CURRENT_VERSION)
+from promptflow._sdk._constants import HOME_PROMPT_FLOW_DIR
+
+
+HINT_ACTIVITY_NAME = ["pf.flows.test", "pf.runs.create_or_update", "pfazure.flows.create_or_update",
+                      "pfazure.runs.create_or_update"]
+logger = logging.getLogger(__name__)
+
+
+def get_cached_versions():
+    from promptflow._sdk._utils import read_write_by_user
+    (HOME_PROMPT_FLOW_DIR / PF_VERSION_CHECK).touch(mode=read_write_by_user(), exist_ok=True)
+    with open(HOME_PROMPT_FLOW_DIR / PF_VERSION_CHECK, "r") as f:
+        try:
+            cached_versions = json.load(f)
+        except json.decoder.JSONDecodeError:
+            cached_versions = {}
+    return cached_versions
+
+
+def dump_cached_versions(cached_versions):
+    with open(HOME_PROMPT_FLOW_DIR / PF_VERSION_CHECK, "w") as f:
+        json.dump(cached_versions, f)
+
+
+def get_latest_version_from_pypi(package_name):
+    pypi_url = f"https://pypi.org/pypi/{package_name}/json"
+    try:
+        import requests
+        response = requests.get(pypi_url, timeout=3)
+        if response.status_code == 200:
+            data = response.json()
+            latest_version = data["info"]["version"]
+            return latest_version
+        else:
+            return None
+    except Exception as ex:  # pylint: disable=broad-except
+        logger.debug(f"Failed to get the latest version from '{pypi_url}'. {str(ex)}")
+        return None
+
+
+def check_latest_version():
+    """ Get the latest versions from a cached file"""
+    cached_versions = get_cached_versions()
+    last_check_time = datetime.datetime.strptime(cached_versions[LAST_CHECK_TIME], '%Y-%m-%d %H:%M:%S.%f') \
+        if LAST_CHECK_TIME in cached_versions else None
+
+    if last_check_time is None or (datetime.datetime.now() >
+                                   last_check_time + datetime.timedelta(days=GET_PYPI_INTERVAL_DAY)):
+        version = get_latest_version_from_pypi(CLI_PACKAGE_NAME)
+        if version is not None:
+            cached_versions[LATEST_VERSION] = version
+            cached_versions[LAST_CHECK_TIME] = str(datetime.datetime.now())
+            dump_cached_versions(cached_versions)
+
+
+def hint_for_update():
+    """
+    Check if there is a new version of prompt flow available every 7 days. IF yes, log debug info to hint
+    customer to upgrade package.
+    """
+
+    cached_versions = get_cached_versions()
+    last_hint_time = datetime.datetime.strptime(
+        cached_versions[LAST_HINT_TIME],
+        '%Y-%m-%d %H:%M:%S.%f'
+    ) if LAST_HINT_TIME in cached_versions else None
+    if last_hint_time is None or (datetime.datetime.now() >
+                                  last_hint_time + datetime.timedelta(days=HINT_INTERVAL_DAY)):
+        from promptflow import __version__ as local_version
+        cached_versions[CURRENT_VERSION] = local_version
+        if LATEST_VERSION in cached_versions:
+            from packaging.version import parse
+            if parse(cached_versions[CURRENT_VERSION]) < parse(cached_versions[LATEST_VERSION]):
+                cached_versions[LAST_HINT_TIME] = str(datetime.datetime.now())
+                message = (f"New prompt flow version available: promptflow-{cached_versions[LATEST_VERSION]}. Running "
+                           f"'pip install --upgrade promptflow' to update.")
+                logger.debug(message)
+        dump_cached_versions(cached_versions)

src/promptflow/tests/sdk_cli_test/unittests/test_utils.py

@@ -11,6 +11,7 @@
 import threading
 from pathlib import Path
 from unittest.mock import patch
+import datetime
 
 import mock
 import pandas as pd
@@ -22,6 +23,7 @@
     _calculate_column_widths,
     list_of_dict_to_nested_dict,
 )
+from promptflow._constants import PF_VERSION_CHECK
 from promptflow._sdk._constants import HOME_PROMPT_FLOW_DIR, PROMPT_FLOW_HOME_DIR_ENV_VAR
 from promptflow._sdk._errors import GenerateFlowToolsJsonError
 from promptflow._sdk._telemetry.logging_handler import get_scrubbed_cloud_role
@@ -36,6 +38,7 @@
     snake_to_camel,
 )
 from promptflow._utils.load_data import load_data
+from promptflow._utils.version_hint_utils import hint_for_update, check_latest_version
 
 TEST_ROOT = Path(__file__).parent.parent.parent
 CONNECTION_ROOT = TEST_ROOT / "test_configs/connections"
@@ -199,6 +202,19 @@ def test_concurrent_execution_of_refresh_connections_dir(self, concurrent_count)
         for thread in threads:
             thread.join()
 
+    @pytest.mark.parametrize("concurrent_count", [1, 2, 4, 8])
+    def test_concurrent_hint_for_update(self, concurrent_count):
+        from concurrent.futures import ThreadPoolExecutor
+        with patch('promptflow._utils.version_hint_utils.datetime') as mock_datetime:
+            mock_datetime.datetime.now.return_value = datetime.datetime.now()
+            mock_datetime.datetime.strptime.return_value = datetime.datetime.now() - datetime.timedelta(days=8)
+            mock_datetime.timedelta.return_value = datetime.timedelta(days=7)
+            hint_for_update()
+            with ThreadPoolExecutor(max_workers=concurrent_count) as pool:
+                pool.submit(check_latest_version)
+
+            assert Path(HOME_PROMPT_FLOW_DIR / PF_VERSION_CHECK).exists()
+
     @pytest.mark.parametrize(
         "data_path",
         [