Skip to content

Fix/update to chrome 118 #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Fix/update to chrome 118 #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0d56428
fix: Fixes OpenSessionConnection at times not waiting until socket is…
xPeyotii Nov 22, 2023
8bf4d64
feat: Add support for FilterEntry.
xPeyotii Nov 22, 2023
5023d08
feat!: Switch to using flattened mode instead of the deprecated (and …
xPeyotii Nov 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions src/BaristaLabs.ChromeDevTools.RemoteInterface/CodeGen/ProtocolGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,11 @@ private Dictionary<string, TypeInfo> GetTypesInDomain(ICollection<DomainDefiniti
};
break;
case "array":
if ((type.Items == null || String.IsNullOrWhiteSpace(type.Items.Type)) && type.Items.TypeReference != "StringIndex")
if ((type.Items == null || String.IsNullOrWhiteSpace(type.Items.Type))
&& type.Items.TypeReference != "StringIndex"
&& type.Items.TypeReference != "FilterEntry")
{
throw new NotImplementedException("Did not expect a top-level domain array type to specify a TypeReference");
throw new NotImplementedException($"Did not expect array type {type.ToString()} of top-level domain {domain.ToString()} to specify a TypeReference");
}

string itemType;
Expand All @@ -154,6 +156,9 @@ private Dictionary<string, TypeInfo> GetTypesInDomain(ICollection<DomainDefiniti
case "StringIndex":
itemType = "string";
break;
case "FilterEntry":
itemType = "FilterEntry";
break;
default:
throw new NotImplementedException($"Did not expect a top-level domain array type to specify a type reference of {type.Items.TypeReference}");
}
Expand Down
52 changes: 38 additions & 14 deletions src/ChromeDevToolsGeneratorCLI/Templates/ChromeSession.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
{
private readonly string m_endpointAddress;
private readonly ILogger<ChromeSession> m_logger;
private readonly ConcurrentDictionary<string, ConcurrentBag<Action<object>>> m_eventHandlers = new ConcurrentDictionary<string, ConcurrentBag<Action<object>>>();
private readonly ConcurrentDictionary<object, ConcurrentBag<Action<object>>> m_eventHandlers = new ConcurrentDictionary<object, ConcurrentBag<Action<object>>>();
private readonly ConcurrentDictionary<Type, string> m_eventTypeMap = new ConcurrentDictionary<Type, string>();

private ActionBlock<string> m_messageQueue;
Expand Down Expand Up @@ -94,13 +94,13 @@
/// <param name="millisecondsTimeout"></param>
/// <param name="throwExceptionIfResponseNotReceived"></param>
/// <returns></returns>
public async Task<ICommandResponse<TCommand>> SendCommand<TCommand>(TCommand command, CancellationToken cancellationToken = default(CancellationToken), int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)
public async Task<ICommandResponse<TCommand>> SendCommand<TCommand>(TCommand command, string sessionId = "", CancellationToken cancellationToken = default(CancellationToken), int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)
where TCommand : ICommand
{
if (command == null)
throw new ArgumentNullException(nameof(command));

var result = await SendCommand(command.CommandName, JToken.FromObject(command), cancellationToken, millisecondsTimeout, throwExceptionIfResponseNotReceived);
var result = await SendCommand(command.CommandName, JToken.FromObject(command), sessionId, cancellationToken, millisecondsTimeout, throwExceptionIfResponseNotReceived);

if (result == null)
return null;
Expand All @@ -121,14 +121,14 @@
/// <param name="millisecondsTimeout"></param>
/// <param name="throwExceptionIfResponseNotReceived"></param>
/// <returns></returns>
public async Task<TCommandResponse> SendCommand<TCommand, TCommandResponse>(TCommand command, CancellationToken cancellationToken = default(CancellationToken), int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)
public async Task<TCommandResponse> SendCommand<TCommand, TCommandResponse>(TCommand command, string sessionId = "", CancellationToken cancellationToken = default(CancellationToken), int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)
where TCommand : ICommand
where TCommandResponse : ICommandResponse<TCommand>
{
if (command == null)
throw new ArgumentNullException(nameof(command));

var result = await SendCommand(command.CommandName, JToken.FromObject(command), cancellationToken, millisecondsTimeout, throwExceptionIfResponseNotReceived);
var result = await SendCommand(command.CommandName, JToken.FromObject(command), sessionId, cancellationToken, millisecondsTimeout, throwExceptionIfResponseNotReceived);

if (result == null)
return default(TCommandResponse);
Expand All @@ -146,10 +146,13 @@
/// <param name="throwExceptionIfResponseNotReceived"></param>
/// <returns></returns>
[DebuggerStepThrough]
public async Task<JToken> SendCommand(string commandName, JToken @params, CancellationToken cancellationToken = default(CancellationToken), int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)
public async Task<JToken> SendCommand(string commandName, JToken @params, string sessionId = "", CancellationToken cancellationToken = default(CancellationToken), int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)
{
sessionId = sessionId ?? "";

var message = new
{
sessionId,
id = Interlocked.Increment(ref m_currentCommandId),
method = commandName,
@params = @params
Expand All @@ -160,7 +163,7 @@

await OpenSessionConnection(cancellationToken);

LogTrace("Sending {id} {method}: {params}", message.id, message.method, @params.ToString());
LogTrace("Sending: \nSessionId: {sessionId} \nID: {id} \nCommand Name: {method} \nCommand Params: {params}", sessionId, message.id, message.method, @params.ToString());

var contents = JsonConvert.SerializeObject(message);

Expand All @@ -181,7 +184,7 @@
if (!String.IsNullOrWhiteSpace(errorData))
exceptionMessage = $"{exceptionMessage} - {errorData}";

LogTrace("Recieved Error Response {id}: {message} {data}", message.id, message, errorData);
LogTrace("Recieved Error Response: \nID: {id} \nRequest Message: {message} \nError Data: {data} \nException Message: {exceptionMessage}", message.id, message, errorData, exceptionMessage);
throw new CommandResponseException(exceptionMessage)
{
Code = m_lastResponse.Result.Value<long>("code")
Expand All @@ -195,9 +198,11 @@
/// </summary>
/// <typeparam name="TEvent">Event to subscribe to</typeparam>
/// <param name="eventCallback"></param>
public void Subscribe<TEvent>(Action<TEvent> eventCallback)
public void Subscribe<TEvent>(Action<TEvent> eventCallback, string sessionId = "")
where TEvent : IEvent
{
sessionId = sessionId ?? "";

if (eventCallback == null)
throw new ArgumentNullException(nameof(eventCallback));

Expand All @@ -212,7 +217,14 @@
});

var callbackWrapper = new Action<object>(obj => eventCallback((TEvent)obj));
m_eventHandlers.AddOrUpdate(eventName,

var keyObj = new
{
SessionId = sessionId,
EventName = eventName
};

m_eventHandlers.AddOrUpdate(keyObj,
(m) => new ConcurrentBag<Action<object>>(new[] { callbackWrapper }),
(m, currentBag) =>
{
Expand All @@ -225,15 +237,24 @@
{
if (m_sessionSocket.State != WebSocketState.Open)
{
m_openEvent.Reset();
m_sessionSocket.Open();

await Task.Run(() => m_openEvent.Wait(cancellationToken));
}
}

private void RaiseEvent(string methodName, JToken eventData)
private void RaiseEvent(string methodName, JToken eventData, string sessionId = "")
{
if (m_eventHandlers.TryGetValue(methodName, out ConcurrentBag<Action<Object>> bag))
sessionId = sessionId ?? "";

var keyObj = new
{
SessionId = sessionId,
EventName = methodName
};

if (m_eventHandlers.TryGetValue(keyObj, out ConcurrentBag<Action<Object>> bag))
{
if (!EventTypeMap.TryGetTypeForMethodName(methodName, out Type eventType))
throw new InvalidOperationException($"Unknown {methodName} does not correspond to a known event type.");
Expand Down Expand Up @@ -279,8 +300,11 @@
{
var method = methodProperty.Value<string>();
var eventData = messageObject["params"];
LogTrace("Recieved Event {method}: {params}", method, eventData.ToString());
RaiseEvent(method, eventData);
var sessionId = messageObject.TryGetValue("sessionId", out JToken sessionIdProperty)
? sessionIdProperty.Value<string>()
: "";
LogTrace("Recieved Event: \nEvent Name: {method} \nParams: {params} \nSessionId: {sessionId}", method, eventData.ToString(), sessionId);
RaiseEvent(method, eventData, sessionId);
return;
}

Expand Down
8 changes: 4 additions & 4 deletions src/ChromeDevToolsGeneratorCLI/Templates/domain.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,19 @@
/// <summary>
/// {{xml-code-comment Description 2}}
/// </summary>
public async Task<{{dehumanize Name}}CommandResponse> {{dehumanize Name}}({{dehumanize Name}}Command command{{#if NoParameters}} = null{{/if}}, CancellationToken cancellationToken = default(CancellationToken), int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)
public async Task<{{dehumanize Name}}CommandResponse> {{dehumanize Name}}({{dehumanize Name}}Command command{{#if NoParameters}} = null{{/if}}, string sessionId = null, CancellationToken cancellationToken = default(CancellationToken), int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)
{
return await m_session.SendCommand<{{dehumanize Name}}Command, {{dehumanize Name}}CommandResponse>(command{{#if NoParameters}} ?? new {{dehumanize Name}}Command(){{/if}}, cancellationToken, millisecondsTimeout, throwExceptionIfResponseNotReceived);
return await m_session.SendCommand<{{dehumanize Name}}Command, {{dehumanize Name}}CommandResponse>(command{{#if NoParameters}} ?? new {{dehumanize Name}}Command(){{/if}}, sessionId, cancellationToken, millisecondsTimeout, throwExceptionIfResponseNotReceived);
}
{{/each}}

{{#each domain.Events}}
/// <summary>
/// {{xml-code-comment Description 2}}
/// </summary>
public void SubscribeTo{{dehumanize Name}}Event(Action<{{dehumanize Name}}Event> eventCallback)
public void SubscribeTo{{dehumanize Name}}Event(Action<{{dehumanize Name}}Event> eventCallback, string sessionId = "")
{
m_session.Subscribe(eventCallback);
m_session.Subscribe(eventCallback, sessionId);
}
{{/each}}
}
Expand Down