[🐛 Bug]: [dotnet] Remove logging API for non-Chromium browsers

[nvborisenko]

Description

Currently the method to get logs throws exception like it is not supported in Firefox. It will be better just to remove this unsupported method from FirefoxDriver, so users see only supported functionality at compilation time. Seems only Chromium based browsers only support it.

Context:

• [🐛 Bug]: C# Firefox driver get logs throws 'The getLog command returned an unexpected error. HTTP method not allowed' #14744
• [py] Remove logging API for non-Chromium browsers  #15641

Reproducible Code

var driver = new FirefoxDriver();

driver.Manage().Logs.GetLog(LogType.Driver);

[selenium-ci]

@nvborisenko, thank you for creating this issue. We will troubleshoot it as soon as we can.

Selenium Triage Team: remember to follow the Triage Guide

[nvborisenko]

Most interesting part that currently we have no way to fix it.

class FirefoxDriver : IWebDriver;

interface IWebDriver
{
  IOptions Manage();
}

interface IOptions
{
  ILogs Logs {get;}
}

IOptions opts = driver.Manage();
ILogs logs = opts.Logs; // user even should not be able to write this code for Firefox
logs.GetLog(...);

It will be possible after breaking the hierarchy #14065. If we will rework that to driver.Logs.GetLog(...) then we will be able to specify which functionality is supported per browser.

I feel .NET API is overcomplicated. The same in python looks very simple:

driver.get_log('browser')

Interesting that only python has simple API, all other follow driver.manage.logs.get() pattern. And in my opinion it would be better to driver.logs.get().

CC: @YevgeniyShunevych @RenderMichael

[RenderMichael]

This is currently governed by the marker interface ISupportsLogs.

We can move the Logs functionality into that interface so users will have to do something like this:

((ISupportsLogs)driver).GetLog(LogType.Driver);

This style would be an improvement (marker interfaces are not considered best practice) and is very compatible with an obsoletion process.

[titusfortner]

I believe the right way to do this for .NET is to make it like all the other Chromium specific features (e.g. ChromiumNetworkConditions), Add the applicable methods for this directly on the Chromium driver, then mark the method in the interface as Obsolete.

Add it to this - https://github.com/SeleniumHQ/selenium/blob/selenium-4.39.0/dotnet/src/webdriver/Chromium/ChromiumDriver.cs#L114

This should be able to be done in our typical backwards compatible fashion, right?

[RenderMichael]

The original code seems to have been written with the idea that non-chromium browsers might eventually get logging capabilities or be able to emulate them. I'm not sure if that's still the case.

mark the method in the interface as Obsolete.

Luckily that method exists only in my hypothetical proposal, and currently the ISupportsLogs interface has no members on it at all. I've written code that does something like:

if (Driver is ISupportsLogs)
{
    var logs = Driver.Manage().Logs.GetLog(...);
    ...
}

A method directly on ChromiumDriver would mean users should switch to something that'd look like this

if (Driver is ChromiumDriver cd)
{
    var logs = cd.Logs.GetLog(...);
    ...
}

Which seems more intuitive but less discoverable to me.

[titusfortner]

Pre-w3c days there were multiple implementations of logging. Since it wasn't part of w3c spec, Mozilla never implemented it in geckodriver. We namespaced it so Selenium Grid could support it, but then agreed that there were too many edge cases to manage it, so it was officially dropped. Google kept it (and updated the namespace), so at this point it is only ever going to be a Chromium-only solution, which is why I suggested the chromiumCustomCommands option. This is essentially how it is done in the other bindings at this point.

[github-actions]

This issue is stale because it has been open 180 days with no activity. Remove stale label or comment or this will be closed in 14 days.

[github-actions]

This issue was closed because it has been stalled for 14 days with no activity.