fix: reset user agent for each requests in local pfs

[elliotzh]

Description

This pull request primarily involves 2 changes:

1. specifying user agent for telemetry from local PFS without touching OperationContext, which behaves as a global context and will be shared among requests;
2. support using the same port file as msi by set up environment variable.

User Agent Handling:

• src/promptflow/promptflow/_core/operation_context.py: The append_user_agent method has been refactored to handle multiple user agents. It now splits the user agent string and appends new user agents if they are not already present.

Client Request Processing:

• Multiple files: The get_client_from_request method has been replaced with get_client_based_on_pfs_request across several files to improve client request processing. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18]

New Methods:

• src/promptflow/promptflow/_sdk/_utils.py: A new method pop_current_user_agent has been introduced to handle changes in the user agent.

Test Cases:

• src/promptflow/tests/sdk_pfs_test/e2etests/test_connection_apis.py: A new test case test_list_connections_with_different_user_agent has been added to verify the handling of different user agents.

Other Changes:

• src/promptflow/promptflow/_sdk/_service/entry.py: The condition for using the SDK API to start pfs has been modified to also include the args.debug case.

All Promptflow Contribution checklist:

• The pull request does not introduce [breaking changes].
• CHANGELOG is updated for new features, bug fixes or other significant changes.
• I have read the contribution guidelines.
• Create an issue and link to the pull request to get dedicated review from promptflow team. Learn more: suggested workflow.

General Guidelines and Best Practices

• Title of the pull request is clear and informative.
• There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

• Pull request includes test coverage for the included changes.

[github-actions]

SDK CLI Global Config Test Result zhangxingzhi/reset-user-agent-for-each-pfs-request

2 tests   2 ✅  51s ⏱️
1 suites  0 💤
1 files    0 ❌

Results for commit aa7588b.

♻️ This comment has been updated with latest results.

[github-actions]

promptflow-tracing unit test result zhangxingzhi/reset-user-agent-for-each-pfs-request

 4 files   4 suites   22s ⏱️
 4 tests  4 ✅ 0 💤 0 ❌
16 runs  16 ✅ 0 💤 0 ❌

Results for commit aa7588b.

♻️ This comment has been updated with latest results.

[github-actions]

promptflow-tracing e2e test result zhangxingzhi/reset-user-agent-for-each-pfs-request

 4 files   4 suites   1m 40s ⏱️
 8 tests  8 ✅ 0 💤 0 ❌
32 runs  32 ✅ 0 💤 0 ❌

Results for commit aa7588b.

♻️ This comment has been updated with latest results.

[github-actions]

Executor Unit Test Result zhangxingzhi/reset-user-agent-for-each-pfs-request

754 tests   754 ✅  3m 53s ⏱️
  1 suites    0 💤
  1 files      0 ❌

Results for commit aa7588b.

♻️ This comment has been updated with latest results.

[github-actions]

promptflow SDK CLI Azure E2E Test Result zhangxingzhi/reset-user-agent-for-each-pfs-request

  4 files    4 suites   3m 48s ⏱️
168 tests 149 ✅ 19 💤 0 ❌
672 runs  596 ✅ 76 💤 0 ❌

Results for commit aa7588b.

♻️ This comment has been updated with latest results.

[github-actions]

Executor E2E Test Result zhangxingzhi/reset-user-agent-for-each-pfs-request

210 tests   208 ✅  7m 25s ⏱️
  1 suites    2 💤
  1 files      0 ❌

Results for commit aa7588b.

♻️ This comment has been updated with latest results.

[github-actions]

SDK CLI Test Result zhangxingzhi/reset-user-agent-for-each-pfs-request

   12 files     12 suites   40m 25s ⏱️
  452 tests   434 ✅ 18 💤 0 ❌
1 808 runs  1 736 ✅ 72 💤 0 ❌

Results for commit aa7588b.

♻️ This comment has been updated with latest results.