UA-.NETStandard/tools/Opc.Ua.SourceGeneration/SourceGeneratorTelemetry.cs

/* ========================================================================
 * Copyright (c) 2005-2025 The OPC Foundation, Inc. All rights reserved.
 *
 * OPC Foundation MIT License 1.00
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * The complete license agreement can be found here:
 * http://opcfoundation.org/License/MIT/1.00/
 * ======================================================================*/

using System;
using System.Diagnostics;
using Microsoft.CodeAnalysis;
using Microsoft.Extensions.Logging;

namespace Opc.Ua.SourceGeneration
{
    /// <summary>
    /// Source generation telemetry context
    /// </summary>
    internal sealed class SourceGeneratorTelemetry : TelemetryContextBase, IDisposable
    {
        /// <summary>
        /// Private constructor
        /// </summary>
        private SourceGeneratorTelemetry(ILoggerFactory factory)
            : base(factory)
        {
            m_ownedFactory = factory;
        }

        /// <summary>
        /// Dispose the owned logger factory.
        /// </summary>
        public void Dispose()
        {
            m_ownedFactory?.Dispose();
        }

        /// <summary>
        /// Create telemetry context. Warnings and errors raised by the
        /// generator libraries surface as compiler diagnostics; anything
        /// below is dropped because a generator has no build output sink.
        /// </summary>
        public static SourceGeneratorTelemetry Create(SourceProductionContext context)
        {
            ILoggerFactory factory = null;
            try
            {
                factory = new LoggerFactoryAdapter(context);
                var result = new SourceGeneratorTelemetry(factory);
                factory = null;
                return result;
            }
            finally
            {
                factory?.Dispose();
            }
        }

        /// <summary>
        /// Logger provider and adapter for logger factory
        /// </summary>
        private sealed class LoggerFactoryAdapter : ILoggerFactory, ILoggerProvider
        {
            /// <summary>
            /// Create adapter
            /// </summary>
            /// <param name="context"></param>
            public LoggerFactoryAdapter(SourceProductionContext context)
            {
                m_context = context;
            }

            /// <inheritdoc/>
            public void AddProvider(ILoggerProvider provider)
            {
            }

            /// <inheritdoc/>
            public ILogger CreateLogger(string categoryName)
            {
                return new LoggerAdapter(categoryName, m_context);
            }

            /// <inheritdoc/>
            public void Dispose()
            {
            }

            private readonly SourceProductionContext m_context;
        }

        /// <summary>
        /// Logger adapter
        /// </summary>
        private sealed class LoggerAdapter : ILogger, IDisposable
        {
            /// <summary>
            /// Create logger adapter
            /// </summary>
            public LoggerAdapter(
                string categoryName,
                SourceProductionContext context)
            {
                m_categoryName = categoryName;
                m_context = context;
            }

            /// <inheritdoc/>
            public void Dispose()
            {
            }

            /// <inheritdoc/>
            public bool IsEnabled(LogLevel logLevel)
            {
                return logLevel > LogLevel.Information;
            }

            /// <inheritdoc/>
            public void Log<TState>(
                LogLevel logLevel,
                EventId eventId,
                TState state,
                Exception exception,
                Func<TState, Exception, string> formatter)
            {
                if (!IsEnabled(logLevel))
                {
                    return;
                }

                string message = formatter(state, exception);
                if (SourceGenerator.TryGetDiagnostic(
                    logLevel,
                    eventId,
                    out DiagnosticDescriptor descriptor))
                {
                    m_context.ReportDiagnostic(
                        SourceGenerator.CreateFormattedDiagnostic(descriptor, message));
                    return;
                }

                // Anything without a descriptor only reaches a debugger-attached
                // host, so keep the full exception rather than just its message.
                Debug.WriteLine(exception is null
                    ? $"[{m_categoryName}] {message}"
                    : $"[{m_categoryName}] {message}\n{exception}");
            }

            /// <inheritdoc/>
            public IDisposable BeginScope<TState>(TState state) where TState : notnull
            {
                return this;
            }

            private readonly string m_categoryName;
            private readonly SourceProductionContext m_context;
        }

        private readonly ILoggerFactory m_ownedFactory;
    }
}