feat(loadtestservice): Added runName feature (Azure#51425)

* feat(loadtestservice): Added runName feature

* UPDATE

* Ran script after updating public API

---------

Co-authored-by: guptakashish <[email protected]>

Author: kashish2508

sdk/loadtestservice/Azure.Developer.Playwright/api/Azure.Developer.Playwright.net8.0.cs

@@ -26,6 +26,7 @@ public PlaywrightServiceBrowserClientOptions(Azure.Developer.Playwright.Playwrig
         public Microsoft.Extensions.Logging.ILogger? Logger { get { throw null; } set { } }
         public System.Runtime.InteropServices.OSPlatform OS { get { throw null; } set { } }
         public string RunId { get { throw null; } set { } }
+        public string RunName { get { throw null; } set { } }
         public Azure.Developer.Playwright.ServiceAuthType ServiceAuth { get { throw null; } set { } }
         public string? ServiceEndpoint { get { throw null; } set { } }
         public bool UseCloudHostedBrowsers { get { throw null; } set { } }

sdk/loadtestservice/Azure.Developer.Playwright/api/Azure.Developer.Playwright.netstandard2.0.cs

@@ -26,6 +26,7 @@ public PlaywrightServiceBrowserClientOptions(Azure.Developer.Playwright.Playwrig
         public Microsoft.Extensions.Logging.ILogger? Logger { get { throw null; } set { } }
         public System.Runtime.InteropServices.OSPlatform OS { get { throw null; } set { } }
         public string RunId { get { throw null; } set { } }
+        public string RunName { get { throw null; } set { } }
         public Azure.Developer.Playwright.ServiceAuthType ServiceAuth { get { throw null; } set { } }
         public string? ServiceEndpoint { get { throw null; } set { } }
         public bool UseCloudHostedBrowsers { get { throw null; } set { } }

sdk/loadtestservice/Azure.Developer.Playwright/src/Constants.cs

@@ -151,7 +151,7 @@ internal class Constants
     internal static readonly string s_invalid_os_error = "Invalid operating system, supported values are 'linux' and 'windows'.";
     internal static readonly string s_workspace_mismatch_error = "The provided access token does not match the specified workspace URL. Please verify that both values are correct.";
     internal static readonly string s_invalid_service_endpoint_error_message = "The service endpoint provided is invalid. Please verify the endpoint URL and try again.";
-    internal static readonly string s_playwright_service_runId_length_exceeded_error_message = "Error: The Run Id you provided exceeds 200 characters. Please provide a shorter Run ID.";
+    internal static readonly string s_playwright_service_runId_not_guid_error_message = "Error: The Run ID must be a valid GUID format. Please provide a valid GUID for the Run ID.";
     internal static readonly string s_playwright_service_runName_truncated_warning = "WARNING: Run name exceeds the maximum limit of 200 characters and will be truncated.";
     internal static readonly string s_playwright_Version_not_supported_error_message = "The Playwright version you are using does not support playwright workspaces. Please update to Playwright version 1.50.0 or higher.";
     internal static readonly string s_playwright_Invalid_version = "The Playwright version you are using is not supported. See the list of supported versions at https://aka.ms/mpt/supported-versions.";
@@ -162,6 +162,7 @@ internal class Constants
     internal static readonly string s_playwright_service_expose_network_environment_variable = "PLAYWRIGHT_SERVICE_EXPOSE_NETWORK";
     internal static readonly string s_playwright_service_os_environment_variable = "PLAYWRIGHT_SERVICE_OS";
     internal static readonly string s_playwright_service_run_id_environment_variable = "PLAYWRIGHT_SERVICE_RUN_ID";
+    internal static readonly string s_playwright_service_run_name_environment_variable = "PLAYWRIGHT_SERVICE_RUN_NAME";
 }
 
 internal class OSConstants

sdk/loadtestservice/Azure.Developer.Playwright/src/PlaywrightServiceBrowserClient.cs

@@ -93,6 +93,7 @@ internal PlaywrightServiceBrowserClient(IEnvironment? environment = null, IEntra
         // Call getters to set default environment variables if not already set before
         _ = _options.OS;
         _ = _options.RunId;
+        _ = _options.RunName;
         _ = _options.ExposeNetwork;
         _ = _options.ServiceAuth;
         _ = _options.UseCloudHostedBrowsers;

sdk/loadtestservice/Azure.Developer.Playwright/src/PlaywrightServiceBrowserClientOptions.cs

@@ -57,9 +57,22 @@ public OSPlatform OS
         /// </summary>
         public string RunId
         {
-            get => _runId ?? _environment.GetEnvironmentVariable(Constants.s_playwright_service_run_id_environment_variable) ?? _clientUtility.GetDefaultRunId();
+            get
+            {
+                // If runId is not set, try to get it from the environment variable if not present in environment variable then set default value
+                if (string.IsNullOrEmpty(_runId))
+                {
+                    var envRunId = _environment.GetEnvironmentVariable(Constants.s_playwright_service_run_id_environment_variable);
+                    _runId = !string.IsNullOrEmpty(envRunId) ? envRunId : _clientUtility.GetDefaultRunId();
+                }
+                return _runId!;
+            }
             set
             {
+                if (!string.IsNullOrEmpty(value) && !Guid.TryParse(value, out _))
+                {
+                    throw new ArgumentException(Constants.s_playwright_service_runId_not_guid_error_message);
+                }
                 _runId = value;
                 // Set run id if not already set in the environment
                 if (string.IsNullOrEmpty(_environment.GetEnvironmentVariable(Constants.s_playwright_service_run_id_environment_variable)))
@@ -69,6 +82,41 @@ public string RunId
             }
         }
 
+        private string? _runName;
+
+        /// <summary>
+        /// Gets or sets the run name.
+        /// </summary>
+        public string RunName
+        {
+            get
+            {
+                // If runName is not set, try to get it from the environment variable if not present in environment variable then set default value
+                if (string.IsNullOrEmpty(_runName))
+                {
+                    var envRunName = _environment.GetEnvironmentVariable(Constants.s_playwright_service_run_name_environment_variable);
+                    _runName = !string.IsNullOrEmpty(envRunName) ? envRunName : _clientUtility.GetDefaultRunName(RunId);
+                }
+                return _runName!;
+            }
+            set
+            {
+                if (!string.IsNullOrEmpty(value) && value.Length > 200)
+                {
+                    _runName = value.Substring(0, 200);
+                }
+                else
+                {
+                    _runName = value;
+                }
+                // Set run name if not already set in the environment
+                if (string.IsNullOrEmpty(_environment.GetEnvironmentVariable(Constants.s_playwright_service_run_name_environment_variable)))
+                {
+                    _environment.SetEnvironmentVariable(Constants.s_playwright_service_run_name_environment_variable, _runName);
+                }
+            }
+        }
+
         private string? _exposeNetwork;
         /// <summary>
         /// Gets or sets the expose network field for remote browsers.
@@ -211,7 +259,7 @@ public PlaywrightServiceBrowserClientOptions(ServiceVersion serviceVersion = Lat
             // no-op
         }
 
-        internal PlaywrightServiceBrowserClientOptions(ServiceVersion serviceVersion, IEnvironment? environment = null, ClientUtilities? clientUtility = null)
+        internal PlaywrightServiceBrowserClientOptions(ServiceVersion serviceVersion, IEnvironment? environment = null, ILogger? logger = null, ClientUtilities? clientUtility = null)
         {
             _environment = environment ?? new EnvironmentHandler();
             _clientUtility = clientUtility ?? new ClientUtilities(_environment);

sdk/loadtestservice/Azure.Developer.Playwright/src/Utility/ClientUtilities.cs

@@ -55,6 +55,15 @@ internal string GetDefaultRunId()
             return runId;
         }
 
+        internal string GetDefaultRunName(string runId)
+        {
+            var runNameFromEnvironmentVariable = _environment.GetEnvironmentVariable(Constants.s_playwright_service_run_name_environment_variable);
+            if (!string.IsNullOrEmpty(runNameFromEnvironmentVariable))
+                return runNameFromEnvironmentVariable!;
+            _environment.SetEnvironmentVariable(Constants.s_playwright_service_run_name_environment_variable, runId);
+            return runId;
+        }
+
         internal void ValidateMptPAT(string? authToken, string serviceEndpoint)
         {
             if (string.IsNullOrEmpty(authToken))

sdk/loadtestservice/Azure.Developer.Playwright/tests/PlaywrightServiceBrowserClientOptionsTests.cs

@@ -68,7 +68,7 @@ public void RunId_WhenSetAndEnvironmentNotSet_SetsEnvironmentVariable()
                 environment: environment,
                 serviceVersion: PlaywrightServiceBrowserClientOptions.ServiceVersion.V2025_07_01_Preview);
 
-            var expectedRunId = "new-run-id";
+            var expectedRunId = "f3a0f9c8-1b4b-4f44-9a77-062d8d4188e4";
             options.RunId = expectedRunId;
 
             Assert.That(environment.GetEnvironmentVariable(Constants.s_playwright_service_run_id_environment_variable),
@@ -276,14 +276,14 @@ public void OS_WhenEnvironmentVariableNotSet_ReturnsLinux()
         public void RunId_WhenSetAndEnvironmentAlreadySet_DoesNotUpdateEnvironment()
         {
             var environment = new TestEnvironment();
-            var existingRunId = "existing-run-id";
+            var existingRunId = "f3a0f9c8-1b4b-4f44-9a77-062d8d4188e4";
             environment.SetEnvironmentVariable(Constants.s_playwright_service_run_id_environment_variable, existingRunId);
 
             _ = new PlaywrightServiceBrowserClientOptions(
                 environment: environment,
                 serviceVersion: PlaywrightServiceBrowserClientOptions.ServiceVersion.V2025_07_01_Preview)
             {
-                RunId = "new-run-id"
+                RunId = "f3a0f9c8-1b4b-4f44-9a77-062d8d418878"
             };
 
             Assert.That(environment.GetEnvironmentVariable(Constants.s_playwright_service_run_id_environment_variable),

sdk/loadtestservice/Azure.Developer.Playwright/tests/PlaywrightServiceBrowserClientTests.cs

@@ -41,10 +41,62 @@ public void Constructor_NoServiceParams_SetsDefaultValues()
             Assert.AreEqual(client._options.OS, OSPlatform.Linux);
             Assert.AreEqual(client._options.ExposeNetwork, Constants.s_default_expose_network);
             Assert.That(Guid.TryParse(client._options.RunId, out _), Is.True);
+            Assert.That(client._options.RunName, Is.EqualTo(client._options.RunId)); // RunName defaults to RunId
 
             Assert.That(environment.GetEnvironmentVariable(Constants.s_playwright_service_os_environment_variable.ToString()), Is.EqualTo(Constants.s_default_os));
             Assert.That(environment.GetEnvironmentVariable(Constants.s_playwright_service_expose_network_environment_variable.ToString()), Is.EqualTo(Constants.s_default_expose_network));
             Assert.That(environment.GetEnvironmentVariable(Constants.s_playwright_service_run_id_environment_variable.ToString().ToString()), Is.Not.Null);
+            Assert.That(environment.GetEnvironmentVariable(Constants.s_playwright_service_run_name_environment_variable), Is.EqualTo(client._options.RunId));
+        });
+    }
+
+    [Test]
+    public void Constructor_CustomRunName_SetsCustomRunNameValue()
+    {
+        var environment = new TestEnvironment();
+        var playwrightVersion = new PlaywrightVersion();
+        var customRunName = "Custom Run Name";
+        var clientOptions = new PlaywrightServiceBrowserClientOptions(environment: environment, serviceVersion: PlaywrightServiceBrowserClientOptions.ServiceVersion.V2025_07_01_Preview)
+        {
+            RunName = customRunName
+        };
+        PlaywrightServiceBrowserClient client = new(environment, options: clientOptions, playwrightVersion: playwrightVersion);
+        Assert.Multiple(() =>
+        {
+            Assert.That(client._options.RunName, Is.EqualTo(customRunName));
+            Assert.That(environment.GetEnvironmentVariable(Constants.s_playwright_service_run_name_environment_variable), Is.EqualTo(customRunName));
+        });
+    }
+
+    [Test]
+    public void Constructor_RunNameExceedsMaxLength_TruncatesRunName()
+    {
+        var environment = new TestEnvironment();
+        var playwrightVersion = new PlaywrightVersion();
+        var longRunName = new string('a', 250);
+        var clientOptions = new PlaywrightServiceBrowserClientOptions(environment: environment, serviceVersion: PlaywrightServiceBrowserClientOptions.ServiceVersion.V2025_07_01_Preview)
+        {
+            RunName = longRunName
+        };
+        PlaywrightServiceBrowserClient client = new(environment, options: clientOptions, playwrightVersion: playwrightVersion);
+        Assert.Multiple(() =>
+        {
+            Assert.That(client._options.RunName.Length, Is.EqualTo(200));
+            Assert.That(client._options.RunName, Is.EqualTo(longRunName.Substring(0, 200)));
+        });
+    }
+
+    [Test]
+    public void Constructor_RunNameSetFromEnvironment_UsesEnvironmentValue()
+    {
+        var environment = new TestEnvironment();
+        var playwrightVersion = new PlaywrightVersion();
+        var environmentRunName = "Environment Run Name";
+        environment.SetEnvironmentVariable(Constants.s_playwright_service_run_name_environment_variable, environmentRunName);
+        PlaywrightServiceBrowserClient client = new(environment, playwrightVersion: playwrightVersion);
+        Assert.Multiple(() =>
+        {
+            Assert.That(client._options.RunName, Is.EqualTo(environmentRunName));
         });
     }
 
@@ -636,6 +688,18 @@ public void RotationHandler_WhenEntraIdAccessTokenDoesNotRequireRotation_NoOp()
         defaultAzureCredentialMock.Verify(x => x.GetTokenAsync(It.IsAny<TokenRequestContext>(), It.IsAny<CancellationToken>()), Times.Never);
     }
 
+    [Test]
+    public void SetOptions_WhenRunIdExceedsMaxLength_ThrowsArgumentException()
+    {
+        var environment = new TestEnvironment();
+        var playwrightVersion = new PlaywrightVersion();
+        var notGuidRunId = new string('a', 201);
+        var clientOptions = new PlaywrightServiceBrowserClientOptions(environment: environment, serviceVersion: PlaywrightServiceBrowserClientOptions.ServiceVersion.V2025_07_01_Preview);
+        ArgumentException? exception = Assert.Throws<ArgumentException>(() => clientOptions.RunId = notGuidRunId);
+        Assert.That(exception, Is.Not.Null);
+        Assert.That(exception!.Message, Is.EqualTo(Constants.s_playwright_service_runId_not_guid_error_message));
+    }
+
     [Test]
     public void GetConnectOptionsAsync_WhenServiceEndpointIsNotSet_ThrowsException()
     {
@@ -849,10 +913,12 @@ public async Task GetConnectOptionsAsync_WhenParametersAreSetViaEnvironmentButAl
     public async Task GetConnectOptionsAsync_WhenServiceParametersAreSetViaEnvironment_SetsServiceParameters()
     {
         var runId = "run-id";
+        var runName = "run-name";
         var environment = new TestEnvironment();
         var playwrightVersion = new PlaywrightVersion();
         environment.SetEnvironmentVariable(ServiceEnvironmentVariable.PlaywrightServiceUri.ToString(), "https://playwright.microsoft.com");
         environment.SetEnvironmentVariable(Constants.s_playwright_service_run_id_environment_variable, runId);
+        environment.SetEnvironmentVariable(Constants.s_playwright_service_run_name_environment_variable, runName);
         var defaultAzureCredentialMock = new Mock<DefaultAzureCredential>();
         var jsonWebTokenHandlerMock = new Mock<JsonWebTokenHandler>();
         environment.SetEnvironmentVariable(ServiceEnvironmentVariable.PlaywrightServiceAccessToken.ToString(), "valid_token");
@@ -871,6 +937,7 @@ public async Task GetConnectOptionsAsync_WhenServiceParametersAreSetViaEnvironme
         {
             Assert.That(connectOptions.WsEndpoint, Is.EqualTo($"https://playwright.microsoft.com?os={OSConstants.s_wINDOWS}&runId={runId}&api-version=2025-07-01-preview"));
             Assert.That(connectOptions.Options!.ExposeNetwork, Is.EqualTo("localhost"));
+            Assert.That(client._options.RunName, Is.EqualTo(runName));
         });
     }