Oakrey.Applications.ReportIssue 6.0.0

Oakrey.Applications.ReportIssue

A .NET library for reporting issues within applications. It provides a simple service abstraction that integrates with application metadata (IApplicationInfo) and Oakrey.Log for structured logging during issue submission.

Main features

• IReportIssueService abstraction for triggering issue reports from any application layer.
• ReportIssueService implementation that reads application metadata (name, version, log path) to enrich reports.
• DummyAppInfo fallback for use without a configured IApplicationInfo.
• ReportConfigurationExtension for one-line dependency injection registration.
• Integrated tracing and error logging via Oakrey.Log.

Project structure

ReportIssue/
  IReportIssueService.cs          # Service abstraction
  ReportIssueService.cs           # Default implementation
  ReportConfigurationExtension.cs # DI registration extension

Requirements

• .NET 10 or higher
• Oakrey.Applications (Application metadata, IApplicationInfo)

Installation

NuGet Package Manager

1. Open your project in Visual Studio.
2. Navigate to Tools > NuGet Package Manager > Manage NuGet Packages for Solution.
3. Search for Oakrey.Applications.ReportIssue and click Install.

.NET CLI

dotnet add package Oakrey.Applications.ReportIssue

Package Manager Console

Install-Package Oakrey.Applications.ReportIssue

Configuration

Register the service in your DI container using the provided extension method:

services.ConfigureReportIssueService();

This registers IReportIssueService as a transient service backed by ReportIssueService.

ReportIssueService requires IApplicationInfo to be registered in the container. If it is not available, the parameterless constructor falls back to DummyAppInfo.

Example usage

public class SomeViewModel
{
    private readonly IReportIssueService reportIssueService;

    public SomeViewModel(IReportIssueService reportIssueService)
    {
        this.reportIssueService = reportIssueService;
    }

    public void OnReportIssueClicked()
    {
        reportIssueService.ReportIssue();
    }
}

Development notes

The actual issue submission logic inside ReportIssueService.ReportIssue() is currently stubbed out (commented). The intended integration targets an Azure DevOps reporter dialog using IApplicationInfo.DevOpsUrl, IApplicationInfo.DevOpsPAT, and IApplicationInfo.DevOpsProjectName. These members are not yet part of the public IApplicationInfo interface and will need to be added before the reporter can be activated.

License

MIT. See the LICENSE file for details.