Oakrey.Applications.ReportIssue 7.0.0

Oakrey.Applications.ReportIssue

A .NET 10 WPF library for submitting in-application issue reports to Azure DevOps by using Microsoft Entra ID and the Azure DevOps REST API 7.1.

Features

• Custom WPF issue dialog with optional application-log attachment.
• Interactive Microsoft Entra authentication without storing a PAT in the desktop application.
• Silent token reuse through the MSAL in-memory token cache.
• Headless issue submission for applications that provide their own UI.
• Configurable request timeout and maximum log attachment size.
• Structured Oakrey logging without logging access tokens or report contents.

Requirements

• .NET 10 for Windows and WPF.
• An Azure DevOps organization and project.
• A Microsoft Entra public-client application registration with delegated Azure DevOps permissions sufficient to create work items and attachments.
• The application registration must allow public-client flows and use the desktop redirect URI.

Registration

Register the service and configure the Azure DevOps destination during application startup:

services.AddReportIssue(options =>
{
    options.OrganizationUri = new Uri("https://dev.azure.com/your-organization");
    options.Project = "your-project";
    options.ClientId = "your-entra-application-client-id";
    options.TenantId = "your-tenant-id";
    options.WorkItemType = "Bug";
    options.IncludeLogByDefault = true;
});

IApplicationInfo must also be registered. Its application name, version, and current log-file path are used to enrich the report.

Show the built-in dialog

ReportIssueResult result = await reportIssueService.ReportIssueAsync(cancellationToken);
if (result.Submitted)
{
    // result.WorkItemId and result.WorkItemUrl identify the created item.
}

Submit from a custom UI

ReportIssueRequest request = new(
    "Export fails for a large file",
    "Open a large file and select Export.",
    IncludeLog: true);

ReportIssueResult result = await reportIssueService.SubmitIssueAsync(request, cancellationToken);

ReportIssueResult distinguishes a successful submission, user cancellation, a complete failure, and a successful work-item creation with a warning when the optional log could not be attached.

Authentication

The default EntraReportIssueAccessTokenProvider first attempts silent token acquisition and falls back to interactive MSAL authentication. Applications with an existing identity layer can replace IReportIssueAccessTokenProvider in dependency injection.

No client secret or personal access token should be distributed with a desktop application.

Version 8 migration

Version 8 replaces the nonfunctional void ReportIssue() API with:

• ReportIssueAsync(CancellationToken) for the built-in dialog.
• SubmitIssueAsync(ReportIssueRequest, CancellationToken) for custom interfaces and automated workflows.

License

MIT. Copyright (c) Oakrey 2016-present.