Method StartSession

dotnet/src/webdriver/WebDriver.cs:592–633

Starts a session with the driver Capabilities of the browser

(ICapabilities capabilities)

    /// </summary>
    /// <param name="capabilities">Capabilities of the browser</param>
    [MemberNotNull(nameof(SessionId))]
    [MemberNotNull(nameof(Capabilities))]
    protected void StartSession(ICapabilities capabilities)
    {
        Dictionary<string, object?> parameters = new Dictionary<string, object?>();

        // If the object passed into the RemoteWebDriver constructor is a
        // RemoteSessionSettings object, it is expected that all intermediate
        // and end nodes are compliant with the W3C WebDriver Specification,
        // and therefore will already contain all of the appropriate values
        // for establishing a session.
        if (capabilities is not RemoteSessionSettings remoteSettings)
        {
            Dictionary<string, object> matchCapabilities = this.GetCapabilitiesDictionary(capabilities);

            List<object> firstMatchCapabilitiesList = new List<object>();
            firstMatchCapabilitiesList.Add(matchCapabilities);

            Dictionary<string, object> specCompliantCapabilitiesDictionary = new Dictionary<string, object>();
            specCompliantCapabilitiesDictionary["firstMatch"] = firstMatchCapabilitiesList;

            parameters.Add("capabilities", specCompliantCapabilitiesDictionary);
        }
        else
        {
            parameters.Add("capabilities", remoteSettings.ToDictionary());
        }

        Response response = this.Execute(DriverCommand.NewSession, parameters);

        response.EnsureValueIsNotNull();
        if (response.Value is not Dictionary<string, object> rawCapabilities)
        {
            string errorMessage = string.Format(CultureInfo.InvariantCulture, "The new session command returned a value ('{0}') that is not a valid JSON object.", response.Value);
            throw new WebDriverException(errorMessage);
        }

        this.Capabilities = new ReturnedCapabilities(rawCapabilities);

        string sessionId = response.SessionId ?? throw new WebDriverException($"The remote end did not respond with ID of a session when it was required. {response.Value}");
        this.SessionId = new SessionId(sessionId);
    }

    /// <summary>
    /// Gets the capabilities as a dictionary.