Better capability matching errors

aristotelos · aristotelos · commit d0d426d574a4 · 2024-05-15T11:55:35.000+02:00
Use very specific error messages to indicate capability mismatches.
diff --git a/src/FlaUI.WebDriver.UITests/SessionTests.cs b/src/FlaUI.WebDriver.UITests/SessionTests.cs
@@ -17,30 +17,30 @@ public void NewSession_PlatformNameMissing_ReturnsError()
 
             var newSession = () => new RemoteWebDriver(WebDriverFixture.WebDriverUrl, emptyOptions);
 
-            Assert.That(newSession, Throws.TypeOf<InvalidOperationException>().With.Message.EqualTo("Required capabilities did not match. Capability `platformName` with value `windows` is required, capability 'appium:automationName' with value `FlaUI` is required, and one of appium:app, appium:appTopLevelWindow or appium:appTopLevelWindowTitleMatch must be passed as a capability (SessionNotCreated)"));
+            Assert.That(newSession, Throws.TypeOf<InvalidOperationException>().With.Message.EqualTo("Missing capability 'platformName' with value 'windows' (SessionNotCreated)"));
         }
 
         [Test]
         public void NewSession_AutomationNameMissing_ReturnsError()
         {
             var emptyOptions = FlaUIDriverOptions.Empty();
-            emptyOptions.AddAdditionalOption("appium:platformName", "windows");
+            emptyOptions.PlatformName = "Windows";
 
             var newSession = () => new RemoteWebDriver(WebDriverFixture.WebDriverUrl, emptyOptions);
 
-            Assert.That(newSession, Throws.TypeOf<InvalidOperationException>().With.Message.EqualTo("Required capabilities did not match. Capability `platformName` with value `windows` is required, capability 'appium:automationName' with value `FlaUI` is required, and one of appium:app, appium:appTopLevelWindow or appium:appTopLevelWindowTitleMatch must be passed as a capability (SessionNotCreated)"));
+            Assert.That(newSession, Throws.TypeOf<InvalidOperationException>().With.Message.EqualTo("Missing capability 'appium:automationName' with value 'flaui' (SessionNotCreated)"));
         }
 
         [Test]
         public void NewSession_AllAppCapabilitiesMissing_ReturnsError()
         {
             var emptyOptions = FlaUIDriverOptions.Empty();
-            emptyOptions.AddAdditionalOption("appium:platformName", "windows");
+            emptyOptions.PlatformName = "Windows";
             emptyOptions.AddAdditionalOption("appium:automationName", "windows");
 
             var newSession = () => new RemoteWebDriver(WebDriverFixture.WebDriverUrl, emptyOptions);
 
-            Assert.That(newSession, Throws.TypeOf<InvalidOperationException>().With.Message.EqualTo("Required capabilities did not match. Capability `platformName` with value `windows` is required, capability 'appium:automationName' with value `FlaUI` is required, and one of appium:app, appium:appTopLevelWindow or appium:appTopLevelWindowTitleMatch must be passed as a capability (SessionNotCreated)"));
+            Assert.That(newSession, Throws.TypeOf<InvalidOperationException>().With.Message.EqualTo("Missing capability 'appium:automationName' with value 'flaui' (SessionNotCreated)"));
         }
 
         [Test]
@@ -115,7 +115,7 @@ public void NewSession_NotSupportedCapability_Throws()
             driverOptions.AddAdditionalOption("unknown:unknown", "value");
 
             Assert.That(() => new RemoteWebDriver(WebDriverFixture.WebDriverUrl, driverOptions),
-                Throws.TypeOf<InvalidOperationException>().With.Message.EqualTo("Required capabilities did not match. Capability `platformName` with value `windows` is required, capability 'appium:automationName' with value `FlaUI` is required, and one of appium:app, appium:appTopLevelWindow or appium:appTopLevelWindowTitleMatch must be passed as a capability (SessionNotCreated)"));
+                Throws.TypeOf<InvalidOperationException>().With.Message.EqualTo("The following capabilities could not be matched: 'unknown:unknown' (SessionNotCreated)"));
         }
 
         [Test]
@@ -158,7 +158,7 @@ public void NewSession_AppTopLevelWindowZero_ReturnsError()
             Assert.That(newSession, Throws.TypeOf<WebDriverArgumentException>().With.Message.EqualTo("Capability appium:appTopLevelWindow '0x0' should not be zero"));
         }
 
-        [Ignore("Sometimes multiple processes are left open")]
+        [Explicit("Sometimes multiple processes are left open")]
         [TestCase("FlaUI WPF Test App")]
         [TestCase("FlaUI WPF .*")]
         public void NewSession_AppTopLevelWindowTitleMatch_IsSupported(string match)
@@ -176,7 +176,7 @@ public void NewSession_AppTopLevelWindowTitleMatch_IsSupported(string match)
             Assert.That(testAppProcess.Process.HasExited, Is.False);
         }
 
-        [Test, Ignore("Sometimes multiple processes are left open")]
+        [Test, Explicit("Sometimes multiple processes are left open")]
         public void NewSession_AppTopLevelWindowTitleMatchMultipleMatching_ReturnsError()
         {
             using var testAppProcess = new TestAppProcess();
diff --git a/src/FlaUI.WebDriver/Controllers/SessionController.cs b/src/FlaUI.WebDriver/Controllers/SessionController.cs
@@ -23,32 +23,35 @@ public SessionController(ILogger<SessionController> logger, ISessionRepository s
         [HttpPost]
         public async Task<ActionResult> CreateNewSession([FromBody] CreateSessionRequest request)
         {
-            var possibleCapabilities = GetPossibleCapabilities(request);
-            IDictionary<string, JsonElement>? matchedCapabilities = null;
-            IEnumerable<IDictionary<string, JsonElement>> matchingCapabilities = possibleCapabilities
-                .Where(capabilities => IsMatchingCapabilitySet(capabilities, out matchedCapabilities))
+            var mergedCapabilities = GetMergedCapabilities(request);
+            MergedCapabilities? matchedCapabilities = null;
+            IEnumerable<MergedCapabilities> matchingCapabilities = mergedCapabilities
+                .Where(capabilities => TryMatchCapabilities(capabilities, out matchedCapabilities, out _))
                 .Select(capabillities => matchedCapabilities!);
 
             Core.Application? app;
             var isAppOwnedBySession = false;
             var capabilities = matchingCapabilities.FirstOrDefault();
             if (capabilities == null)
             {
+                var mismatchIndications = mergedCapabilities
+                    .Select(capabilities => GetMismatchIndication(capabilities));
+
                 return WebDriverResult.Error(new ErrorResponse
                 {
                     ErrorCode = "session not created",
-                    Message = "Required capabilities did not match. Capability `platformName` with value `windows` is required, capability 'appium:automationName' with value `FlaUI` is required, and one of appium:app, appium:appTopLevelWindow or appium:appTopLevelWindowTitleMatch must be passed as a capability"
+                    Message = string.Join("; ", mismatchIndications)
                 });
             }
-            if (TryGetStringCapability(capabilities, "appium:app", out var appPath))
+            if (capabilities.TryGetStringCapability("appium:app", out var appPath))
             {
                 if (appPath == "Root")
                 {
                     app = null;
                 }
                 else 
                 {
-                    TryGetStringCapability(capabilities, "appium:appArguments", out var appArguments);
+                    capabilities.TryGetStringCapability("appium:appArguments", out var appArguments);
                     try
                     {
                         if (appPath.EndsWith("!App"))
@@ -58,7 +61,7 @@ public async Task<ActionResult> CreateNewSession([FromBody] CreateSessionRequest
                         else
                         {
                             var processStartInfo = new ProcessStartInfo(appPath, appArguments ?? "");
-                            if(TryGetStringCapability(capabilities, "appium:appWorkingDir", out var appWorkingDir))
+                            if(capabilities.TryGetStringCapability("appium:appWorkingDir", out var appWorkingDir))
                             {
                                 processStartInfo.WorkingDirectory = appWorkingDir;
                             }
@@ -73,12 +76,12 @@ public async Task<ActionResult> CreateNewSession([FromBody] CreateSessionRequest
 
                 isAppOwnedBySession = true;
             }
-            else if (TryGetStringCapability(capabilities, "appium:appTopLevelWindow", out var appTopLevelWindowString))
+            else if (capabilities.TryGetStringCapability("appium:appTopLevelWindow", out var appTopLevelWindowString))
             {
                 Process process = GetProcessByMainWindowHandle(appTopLevelWindowString);
                 app = Core.Application.Attach(process);
             }
-            else if (TryGetStringCapability(capabilities, "appium:appTopLevelWindowTitleMatch", out var appTopLevelWindowTitleMatch))
+            else if (capabilities.TryGetStringCapability("appium:appTopLevelWindowTitleMatch", out var appTopLevelWindowTitleMatch))
             {
                 Process? process = GetProcessByMainWindowTitle(appTopLevelWindowTitleMatch);
                 app = Core.Application.Attach(process);
@@ -88,128 +91,106 @@ public async Task<ActionResult> CreateNewSession([FromBody] CreateSessionRequest
                 throw WebDriverResponseException.InvalidArgument("One of appium:app, appium:appTopLevelWindow or appium:appTopLevelWindowTitleMatch must be passed as a capability");
             }
             var session = new Session(app, isAppOwnedBySession);
-            if(TryGetNumberCapability(capabilities, "appium:newCommandTimeout", out var newCommandTimeout))
+            if(capabilities.TryGetNumberCapability("appium:newCommandTimeout", out var newCommandTimeout))
             {
                 session.NewCommandTimeout = TimeSpan.FromSeconds(newCommandTimeout);
             }
-            if (capabilities.TryGetValue("timeouts", out var valueJson))
+            if (capabilities.TryGetCapability<TimeoutsConfiguration>("timeouts", out var timeoutsConfiguration))
             {
-                var timeoutsConfiguration = JsonSerializer.Deserialize<TimeoutsConfiguration>(valueJson);
-                if (timeoutsConfiguration == null)
-                {
-                    throw WebDriverResponseException.InvalidArgument("Could not deserialize timeouts capability");
-                }
-                session.TimeoutsConfiguration = timeoutsConfiguration;
+                session.TimeoutsConfiguration = timeoutsConfiguration!;
             }
             _sessionRepository.Add(session);
             _logger.LogInformation("Created session with ID {SessionId} and capabilities {Capabilities}", session.SessionId, capabilities);
             return await Task.FromResult(WebDriverResult.Success(new CreateSessionResponse()
             {
                 SessionId = session.SessionId,
-                Capabilities = capabilities
+                Capabilities = capabilities.Capabilities
             }));
         }
 
-        private bool IsMatchingCapabilitySet(IDictionary<string, JsonElement> capabilities, out IDictionary<string, JsonElement> matchedCapabilities)
+        private string? GetMismatchIndication(MergedCapabilities capabilities)
+        {
+            TryMatchCapabilities(capabilities, out _, out var mismatchIndication);
+            return mismatchIndication;
+        }
+
+        private bool TryMatchCapabilities(MergedCapabilities capabilities, [MaybeNullWhen(false)] out MergedCapabilities matchedCapabilities, [MaybeNullWhen(true)] out string? mismatchIndication)
         {
-            matchedCapabilities = new Dictionary<string, JsonElement>();
-            if (TryGetStringCapability(capabilities, "platformName", out var platformName)
+            matchedCapabilities = new MergedCapabilities(new Dictionary<string, JsonElement>());
+            if (capabilities.TryGetStringCapability("platformName", out var platformName)
                 && platformName.ToLowerInvariant() == "windows")
             {
-                matchedCapabilities.Add("platformName", capabilities["platformName"]);
+                matchedCapabilities.Copy("platformName", capabilities);
             }
             else
             {
+                mismatchIndication = "Missing capability 'platformName' with value 'windows'";
                 return false;
             }
 
-            if (TryGetStringCapability(capabilities, "appium:automationName", out var automationName)
+            if (capabilities.TryGetStringCapability("appium:automationName", out var automationName)
                 && automationName.ToLowerInvariant() == "flaui")
             {
-                matchedCapabilities.Add("appium:automationName", capabilities["appium:automationName"]);
+                matchedCapabilities.Copy("appium:automationName", capabilities);
             }
             else
             {
+                mismatchIndication = "Missing capability 'appium:automationName' with value 'flaui'";
                 return false;
             }
 
-            if (TryGetStringCapability(capabilities, "appium:app", out var appPath))
+            if (capabilities.TryGetStringCapability("appium:app", out var appPath))
             {
-                matchedCapabilities.Add("appium:app", capabilities["appium:app"]);
+                matchedCapabilities.Copy("appium:app", capabilities);
 
                 if (appPath != "Root")
                 {
-                    if(capabilities.ContainsKey("appium:appArguments"))
+                    if (capabilities.Contains("appium:appArguments"))
                     {
-                        matchedCapabilities.Add("appium:appArguments", capabilities["appium:appArguments"]);
+                        matchedCapabilities.Copy("appium:appArguments", capabilities);
                     }
                     if (!appPath.EndsWith("!App"))
                     {
-                        if (capabilities.ContainsKey("appium:appWorkingDir"))
+                        if (capabilities.Contains("appium:appWorkingDir"))
                         {
-                            matchedCapabilities.Add("appium:appWorkingDir", capabilities["appium:appWorkingDir"]);
+                            matchedCapabilities.Copy("appium:appWorkingDir", capabilities);
                         }
                     }
                 }
             }
-            else if (capabilities.ContainsKey("appium:appTopLevelWindow"))
+            else if (capabilities.Contains("appium:appTopLevelWindow"))
             {
-                matchedCapabilities.Add("appium:appTopLevelWindow", capabilities["appium:appTopLevelWindow"]);
+                matchedCapabilities.Copy("appium:appTopLevelWindow", capabilities);
             }
-            else if (capabilities.ContainsKey("appium:appTopLevelWindowTitleMatch"))
-            {
-                matchedCapabilities.Add("appium:appTopLevelWindowTitleMatch", capabilities["appium:appTopLevelWindowTitleMatch"]);
+            else if (capabilities.Contains("appium:appTopLevelWindowTitleMatch"))
+            {   
+                matchedCapabilities.Copy("appium:appTopLevelWindowTitleMatch", capabilities);
             }
             else
             {
+                mismatchIndication = "One of 'appium:app', 'appium:appTopLevelWindow' or 'appium:appTopLevelWindowTitleMatch' should be specified";
                 return false;
             }
 
-            if (capabilities.ContainsKey("appium:newCommandTimeout"))
+            if (capabilities.Contains("appium:newCommandTimeout"))
             {
-                matchedCapabilities.Add("appium:newCommandTimeout", capabilities["appium:newCommandTimeout"]); ;
+                matchedCapabilities.Copy("appium:newCommandTimeout", capabilities); ;
             }
 
-            if (capabilities.ContainsKey("timeouts"))
+            if (capabilities.Contains("timeouts"))
             {
-                matchedCapabilities.Add("timeouts", capabilities["timeouts"]);
+                matchedCapabilities.Copy("timeouts", capabilities);
             }
 
-            return matchedCapabilities.Count == capabilities.Count;
-        }
-
-        private static bool TryGetStringCapability(IDictionary<string, JsonElement> capabilities, string key, [MaybeNullWhen(false)] out string value)
-        {
-            if(capabilities.TryGetValue(key, out var valueJson))
+            var notMatchedCapabilities = capabilities.Capabilities.Keys.Except(matchedCapabilities.Capabilities.Keys);
+            if (notMatchedCapabilities.Any())
             {
-                if(valueJson.ValueKind != JsonValueKind.String)
-                {
-                    throw WebDriverResponseException.InvalidArgument($"Capability {key} must be a string");
-                }
-
-                value = valueJson.GetString();
-                return value != null;
-            }
-
-            value = null;
-            return false;
-        }
-
-        private static bool TryGetNumberCapability(IDictionary<string, JsonElement> capabilities, string key, out double value)
-        {
-            if (capabilities.TryGetValue(key, out var valueJson))
-            {
-                if (valueJson.ValueKind != JsonValueKind.Number)
-                {
-                    throw WebDriverResponseException.InvalidArgument($"Capability {key} must be a number");
-                }
-
-                value = valueJson.GetDouble();
-                return true;
+                mismatchIndication = $"The following capabilities could not be matched: '{string.Join("', '", notMatchedCapabilities)}'";
+                return false;
             }
 
-            value = default;
-            return false;
+            mismatchIndication = null;
+            return true;
         }
 
         private static Process GetProcessByMainWindowTitle(string appTopLevelWindowTitleMatch)
@@ -258,23 +239,11 @@ private static Process GetProcessByMainWindowHandle(string appTopLevelWindowStri
             return process;
         }
 
-        private static IEnumerable<IDictionary<string, JsonElement>> GetPossibleCapabilities(CreateSessionRequest request)
+        private static IEnumerable<MergedCapabilities> GetMergedCapabilities(CreateSessionRequest request)
         {
             var requiredCapabilities = request.Capabilities.AlwaysMatch ?? new Dictionary<string, JsonElement>();
             var allFirstMatchCapabilities = request.Capabilities.FirstMatch ?? new List<Dictionary<string, JsonElement>>(new[] { new Dictionary<string, JsonElement>() });
-            return allFirstMatchCapabilities.Select(firstMatchCapabilities => MergeCapabilities(firstMatchCapabilities, requiredCapabilities));
-        }
-
-        private static IDictionary<string, JsonElement> MergeCapabilities(IDictionary<string, JsonElement> firstMatchCapabilities, IDictionary<string, JsonElement> requiredCapabilities)
-        {
-            var duplicateKeys = firstMatchCapabilities.Keys.Intersect(requiredCapabilities.Keys);
-            if (duplicateKeys.Any())
-            {
-                throw WebDriverResponseException.InvalidArgument($"Capabilities cannot be merged because there are duplicate capabilities: {string.Join(", ", duplicateKeys)}");
-            }
-
-            return firstMatchCapabilities.Concat(requiredCapabilities)
-                .ToDictionary(kvp => kvp.Key, kvp => kvp.Value);
+            return allFirstMatchCapabilities.Select(firstMatchCapabilities => new MergedCapabilities(firstMatchCapabilities, requiredCapabilities));
         }
 
         [HttpDelete("{sessionId}")]
diff --git a/src/FlaUI.WebDriver/MergedCapabilities.cs b/src/FlaUI.WebDriver/MergedCapabilities.cs

Original file line number	Diff line number	Diff line change
`@@ -17,30 +17,30 @@ public void NewSession_PlatformNameMissing_ReturnsError()`
`17`	`17`
`18`	`18`	`var newSession = () => new RemoteWebDriver(WebDriverFixture.WebDriverUrl, emptyOptions);`
`19`	`19`
`20`		- Assert.That(newSession, Throws.TypeOf<InvalidOperationException>().With.Message.EqualTo("Required capabilities did not match. Capability `platformName` with value `windows` is required, capability 'appium:automationName' with value `FlaUI` is required, and one of appium:app, appium:appTopLevelWindow or appium:appTopLevelWindowTitleMatch must be passed as a capability (SessionNotCreated)"));
	`20`	`+ Assert.That(newSession, Throws.TypeOf<InvalidOperationException>().With.Message.EqualTo("Missing capability 'platformName' with value 'windows' (SessionNotCreated)"));`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`[Test]`
`24`	`24`	`public void NewSession_AutomationNameMissing_ReturnsError()`
`25`	`25`	`{`
`26`	`26`	`var emptyOptions = FlaUIDriverOptions.Empty();`
`27`		`- emptyOptions.AddAdditionalOption("appium:platformName", "windows");`
	`27`	`+ emptyOptions.PlatformName = "Windows";`
`28`	`28`
`29`	`29`	`var newSession = () => new RemoteWebDriver(WebDriverFixture.WebDriverUrl, emptyOptions);`
`30`	`30`
`31`		- Assert.That(newSession, Throws.TypeOf<InvalidOperationException>().With.Message.EqualTo("Required capabilities did not match. Capability `platformName` with value `windows` is required, capability 'appium:automationName' with value `FlaUI` is required, and one of appium:app, appium:appTopLevelWindow or appium:appTopLevelWindowTitleMatch must be passed as a capability (SessionNotCreated)"));
	`31`	`+ Assert.That(newSession, Throws.TypeOf<InvalidOperationException>().With.Message.EqualTo("Missing capability 'appium:automationName' with value 'flaui' (SessionNotCreated)"));`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`[Test]`
`35`	`35`	`public void NewSession_AllAppCapabilitiesMissing_ReturnsError()`
`36`	`36`	`{`
`37`	`37`	`var emptyOptions = FlaUIDriverOptions.Empty();`
`38`		`- emptyOptions.AddAdditionalOption("appium:platformName", "windows");`
	`38`	`+ emptyOptions.PlatformName = "Windows";`
`39`	`39`	`emptyOptions.AddAdditionalOption("appium:automationName", "windows");`
`40`	`40`
`41`	`41`	`var newSession = () => new RemoteWebDriver(WebDriverFixture.WebDriverUrl, emptyOptions);`
`42`	`42`
`43`		- Assert.That(newSession, Throws.TypeOf<InvalidOperationException>().With.Message.EqualTo("Required capabilities did not match. Capability `platformName` with value `windows` is required, capability 'appium:automationName' with value `FlaUI` is required, and one of appium:app, appium:appTopLevelWindow or appium:appTopLevelWindowTitleMatch must be passed as a capability (SessionNotCreated)"));
	`43`	`+ Assert.That(newSession, Throws.TypeOf<InvalidOperationException>().With.Message.EqualTo("Missing capability 'appium:automationName' with value 'flaui' (SessionNotCreated)"));`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`[Test]`
`@@ -115,7 +115,7 @@ public void NewSession_NotSupportedCapability_Throws()`
`115`	`115`	`driverOptions.AddAdditionalOption("unknown:unknown", "value");`
`116`	`116`
`117`	`117`	`Assert.That(() => new RemoteWebDriver(WebDriverFixture.WebDriverUrl, driverOptions),`
`118`		- Throws.TypeOf<InvalidOperationException>().With.Message.EqualTo("Required capabilities did not match. Capability `platformName` with value `windows` is required, capability 'appium:automationName' with value `FlaUI` is required, and one of appium:app, appium:appTopLevelWindow or appium:appTopLevelWindowTitleMatch must be passed as a capability (SessionNotCreated)"));
	`118`	`+ Throws.TypeOf<InvalidOperationException>().With.Message.EqualTo("The following capabilities could not be matched: 'unknown:unknown' (SessionNotCreated)"));`
`119`	`119`	`}`
`120`	`120`
`121`	`121`	`[Test]`
`@@ -158,7 +158,7 @@ public void NewSession_AppTopLevelWindowZero_ReturnsError()`
`158`	`158`	`Assert.That(newSession, Throws.TypeOf<WebDriverArgumentException>().With.Message.EqualTo("Capability appium:appTopLevelWindow '0x0' should not be zero"));`
`159`	`159`	`}`
`160`	`160`
`161`		`- [Ignore("Sometimes multiple processes are left open")]`
	`161`	`+ [Explicit("Sometimes multiple processes are left open")]`
`162`	`162`	`[TestCase("FlaUI WPF Test App")]`
`163`	`163`	`[TestCase("FlaUI WPF .*")]`
`164`	`164`	`public void NewSession_AppTopLevelWindowTitleMatch_IsSupported(string match)`
`@@ -176,7 +176,7 @@ public void NewSession_AppTopLevelWindowTitleMatch_IsSupported(string match)`
`176`	`176`	`Assert.That(testAppProcess.Process.HasExited, Is.False);`
`177`	`177`	`}`
`178`	`178`
`179`		`- [Test, Ignore("Sometimes multiple processes are left open")]`
	`179`	`+ [Test, Explicit("Sometimes multiple processes are left open")]`
`180`	`180`	`public void NewSession_AppTopLevelWindowTitleMatchMultipleMatching_ReturnsError()`
`181`	`181`	`{`
`182`	`182`	`using var testAppProcess = new TestAppProcess();`
Original file line number	Diff line number	Diff line change
`@@ -23,32 +23,35 @@ public SessionController(ILogger<SessionController> logger, ISessionRepository s`
`23`	`23`	`[HttpPost]`
`24`	`24`	`public async Task<ActionResult> CreateNewSession([FromBody] CreateSessionRequest request)`
`25`	`25`	`{`
`26`		`- var possibleCapabilities = GetPossibleCapabilities(request);`
`27`		`- IDictionary<string, JsonElement>? matchedCapabilities = null;`
`28`		`- IEnumerable<IDictionary<string, JsonElement>> matchingCapabilities = possibleCapabilities`
`29`		`- .Where(capabilities => IsMatchingCapabilitySet(capabilities, out matchedCapabilities))`
	`26`	`+ var mergedCapabilities = GetMergedCapabilities(request);`
	`27`	`+ MergedCapabilities? matchedCapabilities = null;`
	`28`	`+ IEnumerable<MergedCapabilities> matchingCapabilities = mergedCapabilities`
	`29`	`+ .Where(capabilities => TryMatchCapabilities(capabilities, out matchedCapabilities, out _))`
`30`	`30`	`.Select(capabillities => matchedCapabilities!);`
`31`	`31`
`32`	`32`	`Core.Application? app;`
`33`	`33`	`var isAppOwnedBySession = false;`
`34`	`34`	`var capabilities = matchingCapabilities.FirstOrDefault();`
`35`	`35`	`if (capabilities == null)`
`36`	`36`	`{`
	`37`	`+ var mismatchIndications = mergedCapabilities`
	`38`	`+ .Select(capabilities => GetMismatchIndication(capabilities));`
	`39`	`+`
`37`	`40`	`return WebDriverResult.Error(new ErrorResponse`
`38`	`41`	`{`
`39`	`42`	`ErrorCode = "session not created",`
`40`		- Message = "Required capabilities did not match. Capability `platformName` with value `windows` is required, capability 'appium:automationName' with value `FlaUI` is required, and one of appium:app, appium:appTopLevelWindow or appium:appTopLevelWindowTitleMatch must be passed as a capability"
	`43`	`+ Message = string.Join("; ", mismatchIndications)`
`41`	`44`	`});`
`42`	`45`	`}`
`43`		`- if (TryGetStringCapability(capabilities, "appium:app", out var appPath))`
	`46`	`+ if (capabilities.TryGetStringCapability("appium:app", out var appPath))`
`44`	`47`	`{`
`45`	`48`	`if (appPath == "Root")`
`46`	`49`	`{`
`47`	`50`	`app = null;`
`48`	`51`	`}`
`49`	`52`	`else`
`50`	`53`	`{`
`51`		`- TryGetStringCapability(capabilities, "appium:appArguments", out var appArguments);`
	`54`	`+ capabilities.TryGetStringCapability("appium:appArguments", out var appArguments);`
`52`	`55`	`try`
`53`	`56`	`{`
`54`	`57`	`if (appPath.EndsWith("!App"))`
`@@ -58,7 +61,7 @@ public async Task<ActionResult> CreateNewSession([FromBody] CreateSessionRequest`
`58`	`61`	`else`
`59`	`62`	`{`
`60`	`63`	`var processStartInfo = new ProcessStartInfo(appPath, appArguments ?? "");`
`61`		`- if(TryGetStringCapability(capabilities, "appium:appWorkingDir", out var appWorkingDir))`
	`64`	`+ if(capabilities.TryGetStringCapability("appium:appWorkingDir", out var appWorkingDir))`
`62`	`65`	`{`
`63`	`66`	`processStartInfo.WorkingDirectory = appWorkingDir;`
`64`	`67`	`}`
`@@ -73,12 +76,12 @@ public async Task<ActionResult> CreateNewSession([FromBody] CreateSessionRequest`
`73`	`76`
`74`	`77`	`isAppOwnedBySession = true;`
`75`	`78`	`}`
`76`		`- else if (TryGetStringCapability(capabilities, "appium:appTopLevelWindow", out var appTopLevelWindowString))`
	`79`	`+ else if (capabilities.TryGetStringCapability("appium:appTopLevelWindow", out var appTopLevelWindowString))`
`77`	`80`	`{`
`78`	`81`	`Process process = GetProcessByMainWindowHandle(appTopLevelWindowString);`
`79`	`82`	`app = Core.Application.Attach(process);`
`80`	`83`	`}`
`81`		`- else if (TryGetStringCapability(capabilities, "appium:appTopLevelWindowTitleMatch", out var appTopLevelWindowTitleMatch))`
	`84`	`+ else if (capabilities.TryGetStringCapability("appium:appTopLevelWindowTitleMatch", out var appTopLevelWindowTitleMatch))`
`82`	`85`	`{`
`83`	`86`	`Process? process = GetProcessByMainWindowTitle(appTopLevelWindowTitleMatch);`
`84`	`87`	`app = Core.Application.Attach(process);`
`@@ -88,128 +91,106 @@ public async Task<ActionResult> CreateNewSession([FromBody] CreateSessionRequest`
`88`	`91`	`throw WebDriverResponseException.InvalidArgument("One of appium:app, appium:appTopLevelWindow or appium:appTopLevelWindowTitleMatch must be passed as a capability");`
`89`	`92`	`}`
`90`	`93`	`var session = new Session(app, isAppOwnedBySession);`
`91`		`- if(TryGetNumberCapability(capabilities, "appium:newCommandTimeout", out var newCommandTimeout))`
	`94`	`+ if(capabilities.TryGetNumberCapability("appium:newCommandTimeout", out var newCommandTimeout))`
`92`	`95`	`{`
`93`	`96`	`session.NewCommandTimeout = TimeSpan.FromSeconds(newCommandTimeout);`
`94`	`97`	`}`
`95`		`- if (capabilities.TryGetValue("timeouts", out var valueJson))`
	`98`	`+ if (capabilities.TryGetCapability<TimeoutsConfiguration>("timeouts", out var timeoutsConfiguration))`
`96`	`99`	`{`
`97`		`- var timeoutsConfiguration = JsonSerializer.Deserialize<TimeoutsConfiguration>(valueJson);`
`98`		`- if (timeoutsConfiguration == null)`
`99`		`- {`
`100`		`- throw WebDriverResponseException.InvalidArgument("Could not deserialize timeouts capability");`
`101`		`- }`
`102`		`- session.TimeoutsConfiguration = timeoutsConfiguration;`
	`100`	`+ session.TimeoutsConfiguration = timeoutsConfiguration!;`
`103`	`101`	`}`
`104`	`102`	`_sessionRepository.Add(session);`
`105`	`103`	`_logger.LogInformation("Created session with ID {SessionId} and capabilities {Capabilities}", session.SessionId, capabilities);`
`106`	`104`	`return await Task.FromResult(WebDriverResult.Success(new CreateSessionResponse()`
`107`	`105`	`{`
`108`	`106`	`SessionId = session.SessionId,`
`109`		`- Capabilities = capabilities`
	`107`	`+ Capabilities = capabilities.Capabilities`
`110`	`108`	`}));`
`111`	`109`	`}`
`112`	`110`
`113`		`- private bool IsMatchingCapabilitySet(IDictionary<string, JsonElement> capabilities, out IDictionary<string, JsonElement> matchedCapabilities)`
	`111`	`+ private string? GetMismatchIndication(MergedCapabilities capabilities)`
	`112`	`+ {`
	`113`	`+ TryMatchCapabilities(capabilities, out _, out var mismatchIndication);`
	`114`	`+ return mismatchIndication;`
	`115`	`+ }`
	`116`	`+`
	`117`	`+ private bool TryMatchCapabilities(MergedCapabilities capabilities, [MaybeNullWhen(false)] out MergedCapabilities matchedCapabilities, [MaybeNullWhen(true)] out string? mismatchIndication)`
`114`	`118`	`{`
`115`		`- matchedCapabilities = new Dictionary<string, JsonElement>();`
`116`		`- if (TryGetStringCapability(capabilities, "platformName", out var platformName)`
	`119`	`+ matchedCapabilities = new MergedCapabilities(new Dictionary<string, JsonElement>());`
	`120`	`+ if (capabilities.TryGetStringCapability("platformName", out var platformName)`
`117`	`121`	`&& platformName.ToLowerInvariant() == "windows")`
`118`	`122`	`{`
`119`		`- matchedCapabilities.Add("platformName", capabilities["platformName"]);`
	`123`	`+ matchedCapabilities.Copy("platformName", capabilities);`
`120`	`124`	`}`
`121`	`125`	`else`
`122`	`126`	`{`
	`127`	`+ mismatchIndication = "Missing capability 'platformName' with value 'windows'";`
`123`	`128`	`return false;`
`124`	`129`	`}`
`125`	`130`
`126`		`- if (TryGetStringCapability(capabilities, "appium:automationName", out var automationName)`
	`131`	`+ if (capabilities.TryGetStringCapability("appium:automationName", out var automationName)`
`127`	`132`	`&& automationName.ToLowerInvariant() == "flaui")`
`128`	`133`	`{`
`129`		`- matchedCapabilities.Add("appium:automationName", capabilities["appium:automationName"]);`
	`134`	`+ matchedCapabilities.Copy("appium:automationName", capabilities);`
`130`	`135`	`}`
`131`	`136`	`else`
`132`	`137`	`{`
	`138`	`+ mismatchIndication = "Missing capability 'appium:automationName' with value 'flaui'";`
`133`	`139`	`return false;`
`134`	`140`	`}`
`135`	`141`
`136`		`- if (TryGetStringCapability(capabilities, "appium:app", out var appPath))`
	`142`	`+ if (capabilities.TryGetStringCapability("appium:app", out var appPath))`
`137`	`143`	`{`
`138`		`- matchedCapabilities.Add("appium:app", capabilities["appium:app"]);`
	`144`	`+ matchedCapabilities.Copy("appium:app", capabilities);`
`139`	`145`
`140`	`146`	`if (appPath != "Root")`
`141`	`147`	`{`
`142`		`- if(capabilities.ContainsKey("appium:appArguments"))`
	`148`	`+ if (capabilities.Contains("appium:appArguments"))`
`143`	`149`	`{`
`144`		`- matchedCapabilities.Add("appium:appArguments", capabilities["appium:appArguments"]);`
	`150`	`+ matchedCapabilities.Copy("appium:appArguments", capabilities);`
`145`	`151`	`}`
`146`	`152`	`if (!appPath.EndsWith("!App"))`
`147`	`153`	`{`
`148`		`- if (capabilities.ContainsKey("appium:appWorkingDir"))`
	`154`	`+ if (capabilities.Contains("appium:appWorkingDir"))`
`149`	`155`	`{`
`150`		`- matchedCapabilities.Add("appium:appWorkingDir", capabilities["appium:appWorkingDir"]);`
	`156`	`+ matchedCapabilities.Copy("appium:appWorkingDir", capabilities);`
`151`	`157`	`}`
`152`	`158`	`}`
`153`	`159`	`}`
`154`	`160`	`}`
`155`		`- else if (capabilities.ContainsKey("appium:appTopLevelWindow"))`
	`161`	`+ else if (capabilities.Contains("appium:appTopLevelWindow"))`
`156`	`162`	`{`
`157`		`- matchedCapabilities.Add("appium:appTopLevelWindow", capabilities["appium:appTopLevelWindow"]);`
	`163`	`+ matchedCapabilities.Copy("appium:appTopLevelWindow", capabilities);`
`158`	`164`	`}`
`159`		`- else if (capabilities.ContainsKey("appium:appTopLevelWindowTitleMatch"))`
`160`		`- {`
`161`		`- matchedCapabilities.Add("appium:appTopLevelWindowTitleMatch", capabilities["appium:appTopLevelWindowTitleMatch"]);`
	`165`	`+ else if (capabilities.Contains("appium:appTopLevelWindowTitleMatch"))`
	`166`	`+ {`
	`167`	`+ matchedCapabilities.Copy("appium:appTopLevelWindowTitleMatch", capabilities);`
`162`	`168`	`}`
`163`	`169`	`else`
`164`	`170`	`{`
	`171`	`+ mismatchIndication = "One of 'appium:app', 'appium:appTopLevelWindow' or 'appium:appTopLevelWindowTitleMatch' should be specified";`
`165`	`172`	`return false;`
`166`	`173`	`}`
`167`	`174`
`168`		`- if (capabilities.ContainsKey("appium:newCommandTimeout"))`
	`175`	`+ if (capabilities.Contains("appium:newCommandTimeout"))`
`169`	`176`	`{`
`170`		`- matchedCapabilities.Add("appium:newCommandTimeout", capabilities["appium:newCommandTimeout"]); ;`
	`177`	`+ matchedCapabilities.Copy("appium:newCommandTimeout", capabilities); ;`
`171`	`178`	`}`
`172`	`179`
`173`		`- if (capabilities.ContainsKey("timeouts"))`
	`180`	`+ if (capabilities.Contains("timeouts"))`
`174`	`181`	`{`
`175`		`- matchedCapabilities.Add("timeouts", capabilities["timeouts"]);`
	`182`	`+ matchedCapabilities.Copy("timeouts", capabilities);`
`176`	`183`	`}`
`177`	`184`
`178`		`- return matchedCapabilities.Count == capabilities.Count;`
`179`		`- }`
`180`		`-`
`181`		`- private static bool TryGetStringCapability(IDictionary<string, JsonElement> capabilities, string key, [MaybeNullWhen(false)] out string value)`
`182`		`- {`
`183`		`- if(capabilities.TryGetValue(key, out var valueJson))`
	`185`	`+ var notMatchedCapabilities = capabilities.Capabilities.Keys.Except(matchedCapabilities.Capabilities.Keys);`
	`186`	`+ if (notMatchedCapabilities.Any())`
`184`	`187`	`{`
`185`		`- if(valueJson.ValueKind != JsonValueKind.String)`
`186`		`- {`
`187`		`- throw WebDriverResponseException.InvalidArgument($"Capability {key} must be a string");`
`188`		`- }`
`189`		`-`
`190`		`- value = valueJson.GetString();`
`191`		`- return value != null;`
`192`		`- }`
`193`		`-`
`194`		`- value = null;`
`195`		`- return false;`
`196`		`- }`
`197`		`-`
`198`		`- private static bool TryGetNumberCapability(IDictionary<string, JsonElement> capabilities, string key, out double value)`
`199`		`- {`
`200`		`- if (capabilities.TryGetValue(key, out var valueJson))`
`201`		`- {`
`202`		`- if (valueJson.ValueKind != JsonValueKind.Number)`
`203`		`- {`
`204`		`- throw WebDriverResponseException.InvalidArgument($"Capability {key} must be a number");`
`205`		`- }`
`206`		`-`
`207`		`- value = valueJson.GetDouble();`
`208`		`- return true;`
	`188`	`+ mismatchIndication = $"The following capabilities could not be matched: '{string.Join("', '", notMatchedCapabilities)}'";`
	`189`	`+ return false;`
`209`	`190`	`}`
`210`	`191`
`211`		`- value = default;`
`212`		`- return false;`
	`192`	`+ mismatchIndication = null;`
	`193`	`+ return true;`
`213`	`194`	`}`
`214`	`195`
`215`	`196`	`private static Process GetProcessByMainWindowTitle(string appTopLevelWindowTitleMatch)`
`@@ -258,23 +239,11 @@ private static Process GetProcessByMainWindowHandle(string appTopLevelWindowStri`
`258`	`239`	`return process;`
`259`	`240`	`}`
`260`	`241`
`261`		`- private static IEnumerable<IDictionary<string, JsonElement>> GetPossibleCapabilities(CreateSessionRequest request)`
	`242`	`+ private static IEnumerable<MergedCapabilities> GetMergedCapabilities(CreateSessionRequest request)`
`262`	`243`	`{`
`263`	`244`	`var requiredCapabilities = request.Capabilities.AlwaysMatch ?? new Dictionary<string, JsonElement>();`
`264`	`245`	`var allFirstMatchCapabilities = request.Capabilities.FirstMatch ?? new List<Dictionary<string, JsonElement>>(new[] { new Dictionary<string, JsonElement>() });`
`265`		`- return allFirstMatchCapabilities.Select(firstMatchCapabilities => MergeCapabilities(firstMatchCapabilities, requiredCapabilities));`
`266`		`- }`
`267`		`-`
`268`		`- private static IDictionary<string, JsonElement> MergeCapabilities(IDictionary<string, JsonElement> firstMatchCapabilities, IDictionary<string, JsonElement> requiredCapabilities)`
`269`		`- {`
`270`		`- var duplicateKeys = firstMatchCapabilities.Keys.Intersect(requiredCapabilities.Keys);`
`271`		`- if (duplicateKeys.Any())`
`272`		`- {`
`273`		`- throw WebDriverResponseException.InvalidArgument($"Capabilities cannot be merged because there are duplicate capabilities: {string.Join(", ", duplicateKeys)}");`
`274`		`- }`
`275`		`-`
`276`		`- return firstMatchCapabilities.Concat(requiredCapabilities)`
`277`		`- .ToDictionary(kvp => kvp.Key, kvp => kvp.Value);`
	`246`	`+ return allFirstMatchCapabilities.Select(firstMatchCapabilities => new MergedCapabilities(firstMatchCapabilities, requiredCapabilities));`
`278`	`247`	`}`
`279`	`248`
`280`	`249`	`[HttpDelete("{sessionId}")]`