Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
seleniumhq
GitHub Repository: seleniumhq/selenium
Path: blob/trunk/dotnet/src/webdriver/DevTools/v138/V138Log.cs
2885 views
// <copyright file="V138Log.cs" company="Selenium Committers">
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.
// </copyright>

using OpenQA.Selenium.DevTools.V138.Log;
using System;
using System.Threading.Tasks;

namespace OpenQA.Selenium.DevTools.V138;

/// <summary>
/// Class containing the browser's log as referenced by version 138 of the DevTools Protocol.
/// </summary>
public class V138Log : DevTools.Log
{
    private LogAdapter adapter;

    /// <summary>
    /// Initializes a new instance of the <see cref="V138Log"/> class.
    /// </summary>
    /// <param name="adapter">The adapter for the Log domain.</param>
    /// <exception cref="ArgumentNullException">If <paramref name="adapter"/> is <see langword="null"/>.</exception>
    public V138Log(LogAdapter adapter)
    {
        this.adapter = adapter ?? throw new ArgumentNullException(nameof(adapter));
        this.adapter.EntryAdded += OnAdapterEntryAdded;
    }

    /// <summary>
    /// Asynchronously enables manipulation of the browser's log.
    /// </summary>
    /// <returns>A task that represents the asynchronous operation.</returns>
    public override async Task Enable()
    {
        await adapter.Enable().ConfigureAwait(false);
    }

    /// <summary>
    /// Asynchronously disables manipulation of the browser's log.
    /// </summary>
    /// <returns>A task that represents the asynchronous operation.</returns>
    public override async Task Disable()
    {
        await adapter.Disable().ConfigureAwait(false);
    }

    /// <summary>
    /// Asynchronously clears the browser's log.
    /// </summary>
    /// <returns>A task that represents the asynchronous operation.</returns>
    public override async Task Clear()
    {
        await adapter.Clear().ConfigureAwait(false);
    }

    private void OnAdapterEntryAdded(object? sender, Log.EntryAddedEventArgs e)
    {
        var entry = new LogEntry(
            kind: e.Entry.Source.ToString(),
            message: e.Entry.Text
        );

        this.OnEntryAdded(new EntryAddedEventArgs(entry));
    }
}